Controlling Yaml Serialization Order in Python

by

Took me a few hours of digging through PyYAML docs and tickets, but I eventually discovered this comment that lays out some proof-of-concept code for serializing an OrderedDict as a normal YAML map (but maintaining the order).

e.g. applied to my original code, the solution looks something like:

>>> import yaml
>>> from collections import OrderedDict
>>> def dump_anydict_as_map(anydict):
...     yaml.add_representer(anydict, _represent_dictorder)
... 
>>> def _represent_dictorder( self, data):
...     if isinstance(data, Document):
...         return self.represent_mapping('tag:yaml.org,2002:map', data.__getstate__().items())
...     else:
...         return self.represent_mapping('tag:yaml.org,2002:map', data.items())
... 
>>> class Document(object):
...     def __init__(self, name):
...         self.name = name
...         self.otherstuff="blah"
...     def __getstate__(self):
...         d = OrderedDict()
...         d['name'] = self.name
...         d['otherstuff'] = self.otherstuff
...         return d
... 
>>> dump_anydict_as_map(Document)
>>> doc = Document('obj-20111227')
>>> print yaml.dump(doc, indent=4)
!!python/object:__main__.Document
name: obj-20111227
otherstuff: blah

More Related Contents:

  1. How can I parse a YAML file in Python
  2. In Python, how can you load YAML mappings as OrderedDicts?
  3. What’s the best practice using a settings file in Python? [closed]
  4. How do I install the yaml package for Python?
  5. Can PyYAML dump dict items in non-alphabetical order?
  6. PyYAML dump format
  7. Parsing a YAML file in Python, and accessing the data?
  8. How can I control what scalar form PyYAML uses for my data?
  9. How to parse/read a YAML file into a Python object?
  10. Any yaml libraries in Python that support dumping of long strings as block literals or folded blocks?
  11. How can I update a .yml file, ignoring preexisting Jinja syntax, using Python?
  12. Validating a yaml document in python
  13. How to insert key-value pair into dictionary at a specified position?
  14. python yaml.dump bad indentation
  15. Ansible. override single dictionary key [duplicate]
  16. Configure Flask dev server to be visible across the network
  17. Install a Python package into a different directory using pip?
  18. hexadecimal string to byte array in python
  19. Printing all instances of a class
  20. How to equalize the scales of x-axis and y-axis in matplotlib
  21. cqlsh connection error: ‘ref() does not take keyword arguments’
  22. What do backticks mean to the Python interpreter? Example: `num`
  23. Summing elements in a list
  24. Python Script does not take sys.argv in Windows
  25. Understanding the difference between __getattr__ and __getattribute__
  26. How to hold a ‘key down’ in Pygame?
  27. IOError: [Errno 2] No such file or directory trying to open a file [duplicate]
  28. Plotting Pandas into subplots
  29. Pyspark 2.4.0, read avro from kafka with read stream – Python
  30. Converting matplotlib png to base64 for viewing in html template

Leave a Comment