Skip to main content

ruamel.yaml is a YAML parser/emitter that supports roundtrip preservation of comments, seq/map flow style, and map key order

Project description

ruamel.yaml

Starting with 0.10.7 the package has been reorganised and the command line utility is in its own package ruamel.yaml.cmd (so installing ruamel.yaml doesn’t pull in possibly irrelevant modules only used in the command line utility)

ruamel.yaml is a YAML package for Python. It is a derivative of Kirill Simonov’s PyYAML 3.11 which supports YAML1.1

Major differences with PyYAML 3.11:

  • integrated Python 2 and 3 sources, running on Python 2.6, 2.7 (CPython, PyPy), 3.3 and 3.4.

  • round trip mode that includes comments (block mode, key ordering kept)

  • support for simple lists as mapping keys by transforming these to tuples

  • !!omap generates ordereddict (C) on Python 2, collections.OrderedDict on Python 3, and !!omap is generated for these types.

  • some YAML 1.2 enhancements (0o octal prefix, \/ escape)

  • pep8 compliance

  • tox and py.test based testing

  • Tests whether the C yaml library is installed as well as the header files. That library doesn’t generate CommentTokens, so it cannot be used to do round trip editing on comments. It can be used to speed up normal processing (so you don’t need to install ruamel.yaml and PyYaml). See the section Optional requirements.

  • Basic support for multiline strings with preserved newlines and chomping ( ‘|’, ‘|+’, ‘|-’ ). As this subclasses the string type the information is lost on reassignment. (This might be changed in the future so that the preservation/folding/chomping is part of the parent container, like comments).

  • RoundTrip preservation of flow style sequences ( ‘a: b, c, d’) (based on request and test by Anthony Sottile)

  • anchors names that are hand-crafted (not of the form``idNNN``) are preserved

  • merges in dictionaries are preserved

  • adding/replacing comments on block-style sequences and mappings with smart column positioning

  • collection objects (when read in via RoundTripParser) have an lc property that contains line and column info lc.line and lc.col. Individual positions for mappings and sequences can also be retrieved (lc.key('a'), lc.value('a') resp. lc.item(3))

  • preservation of whitelines after block scalars. Contributed by Sam Thursfield.

Round trip including comments

The major motivation for this fork is the round-trip capability for comments. The integration of the sources was just an initial step to make this easier.

adding/replacing comments

Starting with version 0.8, you can add/replace comments on block style collections (mappings/sequences resuting in Python dict/list). The basic for for this is:

from __future__ import print_function

import ruamel.yaml

inp = """\
abc:
  - a     # comment 1
xyz:
  a: 1    # comment 2
  b: 2
  c: 3
  d: 4
  e: 5
  f: 6 # comment 3
"""

data = ruamel.yaml.load(inp, ruamel.yaml.RoundTripLoader)
data['abc'].append('b')
data['abc'].yaml_add_eol_comment('comment 4', 1)  # takes column of comment 1
data['xyz'].yaml_add_eol_comment('comment 5', 'c')  # takes column of comment 2
data['xyz'].yaml_add_eol_comment('comment 6', 'e')  # takes column of comment 3
data['xyz'].yaml_add_eol_comment('comment 7', 'd', column=20)

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

Resulting in:

abc:
- a       # comment 1
- b       # comment 4
xyz:
  a: 1    # comment 2
  b: 2
  c: 3    # comment 5
  d: 4              # comment 7
  e: 5 # comment 6
  f: 6 # comment 3

If the comment doesn’t start with ‘#’, this will be added. The key is the element index for list, the actual key for dictionaries. As can be seen from the example, the column to choose for a comment is derived from the previous, next or preceding comment column (picking the first one found).

Config file formats

There are only a few configuration file formats that are easily readable and editable: JSON, INI/ConfigParser, YAML (XML is to cluttered to be called easily readable).

Unfortunately JSON doesn’t support comments, and although there are some solutions with pre-processed filtering of comments, there are no libraries that support round trip updating of such commented files.

INI files support comments, and the excellent ConfigObj library by Foord and Larosa even supports round trip editing with comment preservation, nesting of sections and limited lists (within a value). Retrieval of particular value format is explicit (and extensible).

YAML has basic mapping and sequence structures as well as support for ordered mappings and sets. It supports scalars various types including dates and datetimes (missing in JSON). YAML has comments, but these are normally thrown away.

Block structured YAML is a clean and very human readable format. By extending the Python YAML parser to support round trip preservation of comments, it makes YAML a very good choice for configuration files that are human readable and editable while at the same time interpretable and modifiable by a program.

Extending

There are normally six files involved when extending the roundtrip capabilities: the reader, parser, composer and constructor to go from YAML to Python and the resolver, representer, serializer and emitter to go the other way.

Extending involves keeping extra data around for the next process step, eventuallly resulting in a different Python object (subclass or alternative), that should behave like the original, but on the way from Python to YAML generates the original (or at least something much closer).

Smartening

When you use round-tripping, then the complex data you get are already subclasses of the built-in types. So you can patch in extra methods or override existing ones. Some methods are already included and you can do:

yaml_str = """\
a:
- b:
  c: 42
- d:
    f: 196
  e:
    g: 3.14
"""


data = yaml.load(yaml_str, Loader=yaml.RoundTripLoader)

assert data.mlget(['a', 1, 'd', 'f'], list_ok=True) == 196

Examples

Basic round trip of parsing YAML to Python objects, modifying and generating YAML:

from __future__ import print_function

import ruamel.yaml

inp = """\
# example
name:
  # details
  family: Smith   # very common
  given: Alice    # one of the siblings
"""

code = ruamel.yaml.load(inp, ruamel.yaml.RoundTripLoader)
code['name']['given'] = 'Bob'

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

Resulting in

# example
name:
  # details
  family: Smith   # very common
  given: Bob      # one of the siblings

YAML handcrafted anchors and references as well as key merging is preserved. The merged keys can transparently be accessed using [] and .get():

import ruamel.yaml

inp = """\
- &CENTER {x: 1, y: 2}
- &LEFT {x: 0, y: 2}
- &BIG {r: 10}
- &SMALL {r: 1}
# All the following maps are equal:
# Explicit keys
- x: 1
  y: 2
  r: 10
  label: center/big
# Merge one map
- <<: *CENTER
  r: 10
  label: center/big
# Merge multiple maps
- <<: [*CENTER, *BIG]
  label: center/big
# Override
- <<: [*BIG, *LEFT, *SMALL]
  x: 1
  label: center/big
"""

data = ruamel.yaml.load(inp, ruamel.yaml.RoundTripLoader)
assert data[7]['y'] == 2

Optional requirements

If you have the C yaml library and headers installed, as well as the header files for your Python executables then you can use the non-roundtrip but faster C loader and emitter.

On Debian systems you should use:

sudo apt-get install libyaml-dev python-dev python3-dev

you can leave out python3-dev if you don’t use python3

For CentOS (7) based systems you should do:

sudo yum install libyaml-devel python-devel

Testing

Testing is done using tox, which uses virtualenv and pytest.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ruamel.yaml-0.10.23.tar.gz (228.6 kB view details)

Uploaded Source

Built Distributions

ruamel.yaml-0.10.23-py3-none-win_amd64.whl (70.0 kB view details)

Uploaded Python 3Windows x86-64

ruamel.yaml-0.10.23-py3-none-win32.whl (70.0 kB view details)

Uploaded Python 3Windows x86

ruamel.yaml-0.10.23-py2-none-win_amd64.whl (70.0 kB view details)

Uploaded Python 2Windows x86-64

ruamel.yaml-0.10.23-py2-none-win32.whl (70.0 kB view details)

Uploaded Python 2Windows x86

File details

Details for the file ruamel.yaml-0.10.23.tar.gz.

File metadata

  • Download URL: ruamel.yaml-0.10.23.tar.gz
  • Upload date:
  • Size: 228.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for ruamel.yaml-0.10.23.tar.gz
Algorithm Hash digest
SHA256 895347f81297f5542e1071092c6760ed13d86547764ebbaedbc2972eb8385dd8
MD5 f91f4586c0b57ec4ef4bb75261e98315
BLAKE2b-256 e1fe0021f94b54f7aa5a730b765f5a4eead9675be98c7f46c206c240fb9ef819

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.10.23-py3-none-win_amd64.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.10.23-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 c8fca701ce03c80f0d29dc313e894eff183ce106e81b12ba9910d3f84a8c77af
MD5 5ff90f9173c9ea3cb54651a392342db3
BLAKE2b-256 f2f46964c9882331e878a6e629131bdb634ce7e7d54b9380e4107e97b7fa3303

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.10.23-py3-none-win32.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.10.23-py3-none-win32.whl
Algorithm Hash digest
SHA256 0d858efd98b6b245c70f292533c32b2c4d33d1048402e53fcada96c361d707ab
MD5 db90a2042ea4ac7b10908edbad463311
BLAKE2b-256 cdd7528d41de57077b5a883bc3b6e5f78f19b0092a43369d404e6bd5e265b4d5

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.10.23-py2-none-win_amd64.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.10.23-py2-none-win_amd64.whl
Algorithm Hash digest
SHA256 d00bc83c9d156fbc3e1c33ea6ff9034dc6660f7368a309110ec13a1d4b76779e
MD5 e00f81b0811e3eee5ad61d61e9515f45
BLAKE2b-256 3c24a2a9b914c076f516db7abc2b4197a77d97ed0cc4ec89aa7ab429600edcce

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.10.23-py2-none-win32.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.10.23-py2-none-win32.whl
Algorithm Hash digest
SHA256 5e6caf0b549da9ea4059b9f05b80a1ebbc41a259e18e0ff8b8cef74ff2deb929
MD5 8b5cf842a0dd6804c929f36d73086fc8
BLAKE2b-256 b69e14dcd0b39693fd14501c955ae26986a6f0dd228aa08f548e28bb879e2acd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page