PyYAML dump format

by

Below, ruamel.yaml is used instead.

ruamel.yaml is actively maintained. Unlike PyYAML, ruamel.yaml supports:

  • YAML <= 1.2. PyYAML only supports YAML <= 1.1. This is vital, as YAML 1.2 intentionally breaks backward compatibility with YAML 1.1 in several edge cases. This would usually be a bad thing. In this case, this renders YAML 1.2 a strict superset of JSON. Since YAML 1.1 is not a strict superset of JSON, this is a good thing.
  • Roundtrip preservation. When calling yaml.dump() to dump a dictionary loaded by a prior call to yaml.load():
    • PyYAML naively ignores all input formatting – including comments, ordering, quoting, and whitespace. Discarded like so much digital refuse into the nearest available bit bucket.
    • ruamel.yaml cleverly respects all input formatting. Everything. The whole stylistic enchilada. The entire literary shebang. All.

Library Migration

Switching from PyYAML to ruamel.yaml in existing applications is typically as simple as changing the library import to:

from ruamel import yaml

This works because ruamel.yaml is a PyYAML fork that conforms to the PyYAML API.

No other changes should be needed. The yaml.load() and yaml.dump() functions should continue to behave as expected.

Roundtrip Preservation and What It Can Do for You

For backward compatibility with PyYaml, the yaml.load() and yaml.dump() functions do not perform roundtrip preservation by default. To do so, explicitly pass:

  • The optional Loader=ruamel.yaml.RoundTripLoader keyword parameter to yaml.load().
  • The optional Dumper=ruamel.yaml.RoundTripDumper keyword parameter to yaml.dump().

An example kindly “borrowed” from ruamel.yaml documentation:

import ruamel.yaml

inp = """\
# example
name:
  # Yet another Great Duke of Hell. He's not so bad, really.
  family: TheMighty
  given: Ashtaroth
"""

code = ruamel.yaml.load(inp, Loader=ruamel.yaml.RoundTripLoader)
code['name']['given'] = 'Astarte'  # Oh no you didn't.

print(ruamel.yaml.dump(code, Dumper=ruamel.yaml.RoundTripDumper), end='')

It is done. Comments, ordering, quoting, and whitespace will now be preserved intact.

More Related Contents:

  1. In Python, how can you load YAML mappings as OrderedDicts?
  2. How do I install the yaml package for Python?
  3. Can PyYAML dump dict items in non-alphabetical order?
  4. How can I control what scalar form PyYAML uses for my data?
  5. Any yaml libraries in Python that support dumping of long strings as block literals or folded blocks?
  6. How to match a string to pattern “Foo-Bar”, where Bar can be any element of a list? [closed]
  7. Access multiple elements of list knowing their index
  8. I can’t install pyaudio on Windows? How to solve “error: Microsoft Visual C++ 14.0 is required.”?
  9. Nested arguments not compiling
  10. Two variables in Python have same id, but not lists or tuples
  11. Calculate average of every x rows in a table and create new table
  12. Getting only element from a single-element list in Python?
  13. How unique is Python’s id()?
  14. in selenium web driver how to choose the correct iframe
  15. Django model “doesn’t declare an explicit app_label”
  16. How do I change the string representation of a Python class? [duplicate]
  17. Add an element in each dictionary of a list (list comprehension)
  18. TypeError: only integer scalar arrays can be converted to a scalar index with 1D numpy indices array
  19. Accessing dictionary items by position in Python 3.6+ efficiently
  20. TypeError: cannot convert the series to
  21. Existence of mutable named tuple in Python?
  22. Parsing a YAML file in Python, and accessing the data?
  23. Backwards-compatible input calls in Python
  24. What does the “yield” keyword do in Python?
  25. Connect to serial from a PyQt GUI
  26. How to set Python3.5.2 as default Python version on CentOS?
  27. Unable to import path from django.urls
  28. Why isn’t isnumeric working?
  29. Why are str.count(”) and len(str) giving different outputs when used on an empty string?
  30. Convert binary string to bytearray in Python 3

Leave a Comment