Validating a yaml document in python

by

Given that JSON and YAML are pretty similar beasts, you could make use of JSON-Schema to validate a sizable subset of YAML. Here’s a code snippet (you’ll need PyYAML and jsonschema installed):

from jsonschema import validate
import yaml

schema = """
type: object
properties:
  testing:
    type: array
    items:
      enum:
        - this
        - is
        - a
        - test
"""

good_instance = """
testing: ['this', 'is', 'a', 'test']
"""

validate(yaml.load(good_instance), yaml.load(schema)) # passes

# Now let's try a bad instance...

bad_instance = """
testing: ['this', 'is', 'a', 'bad', 'test']
"""

validate(yaml.load(bad_instance), yaml.load(schema))

# Fails with:
# ValidationError: 'bad' is not one of ['this', 'is', 'a', 'test']
#
# Failed validating 'enum' in schema['properties']['testing']['items']:
#     {'enum': ['this', 'is', 'a', 'test']}
#
# On instance['testing'][3]:
#     'bad'

One problem with this is that if your schema spans multiple files and you use "$ref" to reference the other files then those other files will need to be JSON, I think. But there are probably ways around that. In my own project, I’m playing with specifying the schema using JSON files whilst the instances are YAML.

More Related Contents:

  1. Interactively validating Entry widget content in tkinter
  2. How can I parse a YAML file in Python
  3. How to validate IP address in Python? [duplicate]
  4. In Python, how can you load YAML mappings as OrderedDicts?
  5. What’s the best practice using a settings file in Python? [closed]
  6. Restricting the value in Tkinter Entry widget
  7. Validation of a Password – Python
  8. How do I install the yaml package for Python?
  9. Can PyYAML dump dict items in non-alphabetical order?
  10. PyYAML dump format
  11. Parsing a YAML file in Python, and accessing the data?
  12. How can I control what scalar form PyYAML uses for my data?
  13. How to parse/read a YAML file into a Python object?
  14. Validating with an XML schema in Python
  15. Any yaml libraries in Python that support dumping of long strings as block literals or folded blocks?
  16. In python, how to check if a date is valid?
  17. How can I update a .yml file, ignoring preexisting Jinja syntax, using Python?
  18. Order of Serializer Validation in Django REST Framework
  19. Flask-WTF – validate_on_submit() is never executed
  20. Using explicit (predefined) validation set for grid search with sklearn
  21. How to make a field conditionally optional in WTForms?
  22. How to validate more than one field of a Pydantic model?
  23. Validating user input strings in Python
  24. How to validate an Email address in Django? [duplicate]
  25. How to insert key-value pair into dictionary at a specified position?
  26. Controlling Yaml Serialization Order in Python
  27. python yaml.dump bad indentation
  28. Ansible. override single dictionary key [duplicate]
  29. How do lexical closures work?
  30. Can I get a return value from multiprocessing.Process?

Leave a Comment