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

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.7 (2017-06-14):
  • add plug-in mechanism for load/dump pre resp. post-processing

0.15.6 (2017-06-10):
  • a set() with duplicate elements now throws error in rt loading

  • support for toplevel column zero literal/folded scalar in explicit documents

0.15.5 (2017-06-08):
  • repeat load() on a single YAML() instance would fail.

0.15.4 (2017-06-08):
  • transform parameter on dump that expects a function taking a string and returning a string. This allows transformation of the output before it is written to stream. This forces creation of the complete output in memory!

  • some updates to the docs

0.15.3 (2017-06-07):
  • No longer try to compile C extensions on Windows. Compilation can be forced by setting the environment variable RUAMEL_FORCE_EXT_BUILD to some value before starting the pip install.

0.15.2 (2017-06-07):
  • update to conform to mypy 0.511: mypy –strict

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

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

Uploaded Source

Built Distributions

ruamel.yaml-0.15.7-cp36-cp36m-manylinux1_x86_64.whl (550.3 kB view details)

Uploaded CPython 3.6m

ruamel.yaml-0.15.7-cp35-cp35m-manylinux1_x86_64.whl (550.1 kB view details)

Uploaded CPython 3.5m

ruamel.yaml-0.15.7-cp34-cp34m-manylinux1_x86_64.whl (556.6 kB view details)

Uploaded CPython 3.4m

ruamel.yaml-0.15.7-cp33-cp33m-manylinux1_x86_64.whl (530.8 kB view details)

Uploaded CPython 3.3m

ruamel.yaml-0.15.7-cp27-cp27mu-manylinux1_x86_64.whl (526.7 kB view details)

Uploaded CPython 2.7mu

ruamel.yaml-0.15.7-cp27-cp27m-manylinux1_x86_64.whl (526.6 kB view details)

Uploaded CPython 2.7m

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.7.tar.gz
Algorithm Hash digest
SHA256 6a5ae1a257db7a8d9be06e87dba634234bbd4ff78ca558f40a71eb1a3cec807f
MD5 addb35ee2566c841b2c682d763e43d8a
BLAKE2b-256 9932f0768bd0a1c6f2097c3fd4716ea2006466981ffa737a6d8cf7b132fcdc5d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.7-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 812dab46fb2ccd84d871c25a7b18b105b06fe05ab9fa0861b92720ccb1e99082
MD5 c2e3726504f01e90714c94da3e7ecc65
BLAKE2b-256 3e2ec7670de542b0c028bbea8ee8472bfb043fe6a99b46ace1ca4671dce97c75

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.7-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 9502e561beaeacabc280facf3d5b259e002787ffa2561314caba1037400095da
MD5 d7beefe37d567f31545304f7aaf5ce00
BLAKE2b-256 92414520fd108acf3ae180e67db54a3dacf2f03c919a832234671815ad680fb4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.7-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 a70e1f749bf9f9ac4bcdb62baff85bcc3665bf728ad6c552cf7d3da691470f26
MD5 f373a1dec8c191eacb6fa1c957860396
BLAKE2b-256 d2709c7dfd2bec2ed98ecf58546e29706d149ab2a391f047512e269c2c7cc541

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.7-cp33-cp33m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 4234c959b828f184357f9047aaaf5ad9295722b4681f23a7e27d7af079958ec9
MD5 4c0fe6e6a4dd26efbb661fecdc49f68a
BLAKE2b-256 dce6b64f951cfe706043023d5ede381d784c5c8a9371297b5ce8bf4c97d3d6d9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.7-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 97869fcf74847df5e6f1f57a1574ef6c3046fa4306fa501f6d83baa6a5ec5f4f
MD5 821d0e4c21633a5716b68968168a43d9
BLAKE2b-256 ed89f212898b37c6dfe79277891a5127aa94f3fe8fe8d52499b2a186493d752b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.7-cp27-cp27m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 7983183670170b1718e13e4803732813b811be321b23b7875f997358b7895d1e
MD5 cb385f447c1a611e00593d8a3057d08d
BLAKE2b-256 f0e3d236c0cb6858316f63391d2c61475f3f9d8eea3aafa8544a7626f1a0cd9d

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