Skip to main content

ruamel.yaml

ruamel.yaml is a YAML 1.2 loader/dumper package for Python.

Starting with version 0.15.0 the way YAML files are loaded and dumped is changing. See the API doc for details. Currently existing functionality will throw a warning before being changed/removed. For production systems you should pin the version being used with ``ruamel.yaml<=0.15``. There might be bug fixes in the 0.14 series, but new functionality is likely only to be available via the new API.

If your package uses ruamel.yaml and is not listed on PyPI, drop me an email, preferably with some infomormation on how you use the package (or a link to bitbucket/github) and I’ll keep you informed when the status of the API is stable enough to make the transition.

https://readthedocs.org/projects/yaml/badge/?version=stable

ChangeLog

0.15.1 (2017-06-07):
  • duplicate keys in mappings generate an error (in the old API this change generates a warning until 0.16)

  • dependecy on ruamel.ordereddict for 2.7 now via extras_require

0.15.0 (2017-06-04):
  • it is no allowed to pass in a pathlib.Path as “stream” parameter to all load/dump functions

  • passing in a non-supported object (e.g. a string) as “stream” will result in a much more meaningful YAMLStreamError.

  • assigning a normal string value to an existing CommentedMap key or CommentedSeq element will result in a value cast to the previous value’s type if possible.

  • added YAML class for new API

0.14.12 (2017-05-14):
  • fix for issue 119, deepcopy not returning subclasses (reported and PR by Constantine Evans <cevans@evanslabs.org>)

0.14.11 (2017-05-01):
  • fix for issue 103 allowing implicit documents after document end marker line (...) in YAML 1.2

0.14.10 (2017-04-26):
  • fix problem with emitting using cyaml

0.14.9 (2017-04-22):
0.14.8 (2017-04-19):
  • fix Text not available on 3.5.0 and 3.5.1, now proactively setting version guards on all files (reported by João Paulo Magalhães)

0.14.7 (2017-04-18):
  • round trip of integers (decimal, octal, hex, binary) now preserve leading zero(s) padding and underscores. Underscores are presumed to be at regular distances (i.e. 0o12_345_67 dumps back as 0o1_23_45_67 as the space from the last digit to the underscore before that is the determining factor).

0.14.6 (2017-04-14):
  • binary, octal and hex integers are now preserved by default. This was a known deficiency. Working on this was prompted by the issue report (112) from devnoname120, as well as the additional experience with .replace() on scalarstring classes.

  • fix issues 114: cannot install on Buildozer (reported by mixmastamyk). Setting env. var RUAMEL_NO_PIP_INSTALL_CHECK will suppress pip-check.

0.14.5 (2017-04-04):
  • fix issue 109: None not dumping correctly at top level (reported by Andrea Censi)

  • fix issue 110: .replace on Preserved/DoubleQuoted/SingleQuoted ScalarString would give back “normal” string (reported by sandres23)

0.14.4 (2017-03-31):
  • fix readme

0.14.3 (2017-03-31):
0.14.2 (2017-03-23):
  • fix for old default pip on Ubuntu 14.04 (reported by Sébastien Maccagnoni-Munch)

0.14.1 (2017-03-22):
  • fix Text not available on 3.5.0 and 3.5.1 (reported by Charles Bouchard-Légaré)

0.14.0 (2017-03-21):
  • updates for mypy –strict

  • preparation for moving away from inheritance in Loader and Dumper, calls from e.g. the Representer to the Serializer.serialize() are now done via the attribute .serializer.serialize(). Usage of .serialize() outside of Serializer will be deprecated soon

  • some extra tests on main.py functions

0.13.14 (2017-02-12):
  • fix for issue 97: clipped block scalar followed by empty lines and comment would result in two CommentTokens of which the first was dropped. (reported by Colm O’Connor)

0.13.13 (2017-01-28):
  • fix for issue 96: prevent insertion of extra empty line if indented mapping entries are separated by an empty line (reported by Derrick Sawyer)

0.13.11 (2017-01-23):
  • allow ‘:’ in flow style scalars if not followed by space. Also don’t quote such scalar as this is no longer necessary.

  • add python 3.6 manylinux wheel to PyPI

0.13.10 (2017-01-22):
  • fix for issue 93, insert spurious blank line before single line comment between indented sequence elements (reported by Alex)

0.13.9 (2017-01-18):
  • fix for issue 92, wrong import name reported by the-corinthian

0.13.8 (2017-01-18):
  • fix for issue 91, when a compiler is unavailable reported by Maximilian Hils

  • fix for deepcopy issue with TimeStamps not preserving ‘T’, reported on StackOverflow Q&A by Quuxplusone

0.13.7 (2016-12-27):
  • fix for issue 85, constructor.py importing unicode_literals caused mypy to fail on 2.7 (reported by Peter Amstutz)

0.13.6 (2016-12-27):
  • fix for issue 83, collections.OrderedDict not representable by SafeRepresenter (reported by Frazer McLean)

0.13.5 (2016-12-25):
  • fix for issue 84, deepcopy not properly working (reported by Peter Amstutz)

0.13.4 (2016-12-05):
  • another fix for issue 82, change to non-global resolver data broke implicit type specification

0.13.3 (2016-12-05):
  • fix for issue 82, deepcopy not working (reported by code monk)

0.13.2 (2016-11-28):
  • fix for comments after empty (null) values (reported by dsw2127 and cokelaer)

0.13.1 (2016-11-22):
  • optimisations on memory usage when loading YAML from large files (py3: -50%, py2: -85%)

0.13.0 (2016-11-20):
  • if load() or load_all() is called with only a single argument (stream or string) a UnsafeLoaderWarning will be issued once. If appropriate you can surpress this warning by filtering it. Explicitly supplying the Loader=ruamel.yaml.Loader argument, will also prevent it from being issued. You should however consider using safe_load(), safe_load_all() if your YAML input does not use tags.

  • allow adding comments before and after keys (based on StackOveflow Q&A by msinn)


For older changes see the file CHANGES

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.15.1.tar.gz (248.7 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

ruamel.yaml-0.15.1-cp36-cp36m-manylinux1_x86_64.whl (548.5 kB view details)

Uploaded CPython 3.6m

ruamel.yaml-0.15.1-cp35-cp35m-manylinux1_x86_64.whl (548.3 kB view details)

Uploaded CPython 3.5m

ruamel.yaml-0.15.1-cp34-cp34m-manylinux1_x86_64.whl (554.9 kB view details)

Uploaded CPython 3.4m

ruamel.yaml-0.15.1-cp33-cp33m-manylinux1_x86_64.whl (529.0 kB view details)

Uploaded CPython 3.3m

ruamel.yaml-0.15.1-cp27-cp27mu-manylinux1_x86_64.whl (525.0 kB view details)

Uploaded CPython 2.7mu

ruamel.yaml-0.15.1-cp27-cp27m-manylinux1_x86_64.whl (525.0 kB view details)

Uploaded CPython 2.7m

File details

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

File metadata

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

File hashes

Hashes for ruamel.yaml-0.15.1.tar.gz
Algorithm Hash digest
SHA256 1621cc06c3b6678bd8ca1a0e967decf60ae35d048eed4bd46c5f0efc89193fe7
MD5 05a13083a6bd32a1db17d11c8943606e
BLAKE2b-256 4579a554364b388d129017369d59a54a782808919d53694b470fa0cc65d152c2

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.15.1-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.15.1-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 1ed884d7952934954a572c6312a18d9fbe11049241df03a7e6c63cf3ac2a5f90
MD5 a2e1da181007bdefe3e7368771262066
BLAKE2b-256 8863e8c323040e442029bfc51f86a698905e47f97b1c2ebad6657a0a4f41c3b5

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.15.1-cp35-cp35m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.15.1-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 938fef829537ed170073e35c375c9712012152071c4c3b4e9712c2a375087369
MD5 62682ade6bc7e0f60d89e4b51bfe08a3
BLAKE2b-256 680ee1dc43d341c2b0b59145aa9ae5b8a8471f7a4e25b7972fb00e7e1a300ded

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.15.1-cp34-cp34m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.15.1-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 0d42e93491f915d7268b5357098b84d5e9738241a3d6742c9c1d519ae338a969
MD5 eccc3588954d34cfbeb241aaca054d1b
BLAKE2b-256 d3c27ba439f59c4a4f9f5a773bb2ecad435e1a44222b126363a44b6dfc086bb6

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.15.1-cp33-cp33m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.15.1-cp33-cp33m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 f1a45df7458bc47823f2d41198ee4cc6f39aa7c29677510cf586e9aa112dfdf0
MD5 eeb479ed03b5b309615feb86a1db6a6e
BLAKE2b-256 3240481c3cd31b3524231ebf536efc12f1adb842834e43511893691e8b143d7e

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.15.1-cp27-cp27mu-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.15.1-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 d47da8b63da09d052e103a50c9ef11baf90179e22168476cf8b3a45e030074da
MD5 447c255ef9eae9a3b753887c5f5ed77a
BLAKE2b-256 0014e219808842a53f236bcd22f0e744d83ac4b1de40d3f1bafe74978108e8bb

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.15.1-cp27-cp27m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.15.1-cp27-cp27m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 485dbb00bd713f2c23964355401487cdfea10ce95af5226d4f4d5217b7c3d7c8
MD5 a488a9da5b30e1f943f874fa7ba1d416
BLAKE2b-256 9f79627d5bf61d8636636649591c8cf0e5977b0d211d418164cc2447a54af672

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

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