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 https://bestpractices.coreinfrastructure.org/projects/1128/badge

ChangeLog

0.15.32 (2017-08-21):
  • allow setting yaml.default_flow_style = None (default: False) for for typ='rt'.

  • fix for issue 149: multiplications on ScalarFloat now return float

0.15.31 (2017-08-15):
  • fix Comment dumping

0.15.30 (2017-08-14):
  • fix for issue with “compact JSON” not parsing: {"in":{},"out":{}} (reported on StackOverflow by mjalkio

0.15.29 (2017-08-14):
  • fix issue #51: different indents for mappings and sequences (reported by Alex Harvey)

  • fix for flow sequence/mapping as element/value of block sequence with sequence-indent minus dash-offset not equal two.

0.15.28 (2017-08-13):
  • fix issue #61: merge of merge cannot be __repr__-ed (reported by Tal Liron)

0.15.27 (2017-08-13):
  • fix issue 62, YAML 1.2 allows ? and : in plain scalars if non-ambigious (reported by nowox)

  • fix lists within lists which would make comments disappear

0.15.26 (2017-08-10):
  • fix for disappearing comment after empty flow sequence (reported by oit-tzhimmash)

0.15.25 (2017-08-09):
  • fix for problem with dumping (unloaded) floats (reported by eyenseo)

0.15.24 (2017-08-09):
  • added ScalarFloat which supports roundtripping of 23.1, 23.100, 42.00E+56, 0.0, -0.0 etc. while keeping the format. Underscores in mantissas are not preserved/supported (yet, is anybody using that?).

  • (finally) fixed longstanding issue 23 (reported by Antony Sottile), now handling comment between block mapping key and value correctly

  • warn on YAML 1.1 float input that is incorrect (triggered by invalid YAML provided by Cecil Curry)

  • allow setting of boolean representation (false, true) by using: yaml.boolean_representation = [u'False', u'True']

0.15.23 (2017-08-01):
  • fix for round_tripping integers on 2.7.X > sys.maxint (reported by ccatterina)

0.15.22 (2017-07-28):
  • fix for round_tripping singe excl. mark tags doubling (reported and fix by Jan Brezina)

0.15.21 (2017-07-25):
0.15.20 (2017-07-23):
  • wheels for windows including C extensions

0.15.19 (2017-07-13):
  • added object constructor for rt, decorator yaml_object to replace YAMLObject.

  • fix for problem using load_all with Path() instance

  • fix for load_all in combination with zero indent block style literal (pure=True only!)

0.15.18 (2017-07-04):
  • missing pure attribute on YAML useful for implementing !include tag constructor for including YAML files in a YAML file

  • some documentation improvements

  • trigger of doc build on new revision

0.15.17 (2017-07-03):
  • support for Unicode supplementary Plane output (input was already supported, triggered by this Stack Overflow Q&A)

0.15.16 (2017-07-01):
  • minor typing issues (reported and fix provided by Manvendra Singh

  • small doc improvements

0.15.15 (2017-06-27):
0.15.14 (2017-06-25):
  • fix for issue 133, in setup.py: change ModuleNotFoundError to ImportError (reported and fix by Asley Drake)

0.15.13 (2017-06-24):
  • suppress duplicate key warning on mappings with merge keys (reported by Cameron Sweeney)

0.15.12 (2017-06-24):
  • remove fatal dependency of setup.py on wheel package (reported by Cameron Sweeney)

0.15.11 (2017-06-24):
  • fix for issue 130, regression in nested merge keys (reported by David Fee)

0.15.10 (2017-06-23):
  • top level PreservedScalarString not indented if not explicitly asked to

  • remove Makefile (not very useful anyway)

  • some mypy additions

0.15.9 (2017-06-16):
  • fix for issue 127: tagged scalars were always quoted and seperated by a newline when in a block sequence (reported and largely fixed by Tommy Wang)

0.15.8 (2017-06-15):
  • allow plug-in install via install ruamel.yaml[jinja2]

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 now 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


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.32.tar.gz (259.5 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.32-cp36-cp36m-win_amd64.whl (186.4 kB view details)

Uploaded CPython 3.6mWindows x86-64

ruamel.yaml-0.15.32-cp36-cp36m-win32.whl (172.1 kB view details)

Uploaded CPython 3.6mWindows x86

ruamel.yaml-0.15.32-cp36-cp36m-manylinux1_x86_64.whl (557.1 kB view details)

Uploaded CPython 3.6m

ruamel.yaml-0.15.32-cp35-cp35m-win_amd64.whl (186.4 kB view details)

Uploaded CPython 3.5mWindows x86-64

ruamel.yaml-0.15.32-cp35-cp35m-win32.whl (172.1 kB view details)

Uploaded CPython 3.5mWindows x86

ruamel.yaml-0.15.32-cp35-cp35m-manylinux1_x86_64.whl (556.9 kB view details)

Uploaded CPython 3.5m

ruamel.yaml-0.15.32-cp34-cp34m-win_amd64.whl (189.2 kB view details)

Uploaded CPython 3.4mWindows x86-64

ruamel.yaml-0.15.32-cp34-cp34m-win32.whl (178.3 kB view details)

Uploaded CPython 3.4mWindows x86

ruamel.yaml-0.15.32-cp34-cp34m-manylinux1_x86_64.whl (563.4 kB view details)

Uploaded CPython 3.4m

ruamel.yaml-0.15.32-cp33-cp33m-win_amd64.whl (189.0 kB view details)

Uploaded CPython 3.3mWindows x86-64

ruamel.yaml-0.15.32-cp33-cp33m-win32.whl (178.3 kB view details)

Uploaded CPython 3.3mWindows x86

ruamel.yaml-0.15.32-cp33-cp33m-manylinux1_x86_64.whl (537.6 kB view details)

Uploaded CPython 3.3m

ruamel.yaml-0.15.32-cp27-cp27mu-manylinux1_x86_64.whl (533.4 kB view details)

Uploaded CPython 2.7mu

ruamel.yaml-0.15.32-cp27-cp27m-win_amd64.whl (190.0 kB view details)

Uploaded CPython 2.7mWindows x86-64

ruamel.yaml-0.15.32-cp27-cp27m-win32.whl (178.2 kB view details)

Uploaded CPython 2.7mWindows x86

ruamel.yaml-0.15.32-cp27-cp27m-manylinux1_x86_64.whl (533.4 kB view details)

Uploaded CPython 2.7m

File details

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

File metadata

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

File hashes

Hashes for ruamel.yaml-0.15.32.tar.gz
Algorithm Hash digest
SHA256 57639d0787ecdbc97f520f01880f3e48fe124b6b9ecafdfed4a739df0f5d7256
MD5 925103b5fcb71d721ba0afa50230e3b3
BLAKE2b-256 055c3e4e151527638d178a128f399164c4557392b475376d4d4d78bbbf9c680c

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.15.32-cp36-cp36m-win_amd64.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.15.32-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 b1aa95db69c9a934e7d1879f5d1ba74029070548801d31fe07f4fadb99258c4f
MD5 5361a2bd2b8e3828698974738227db9a
BLAKE2b-256 fc17cb6d078b60a72e0ad4bc8f0e02fc4b9f203fc99d75bbde4765f480af5de2

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.15.32-cp36-cp36m-win32.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.15.32-cp36-cp36m-win32.whl
Algorithm Hash digest
SHA256 de759c87da5a546ccc6c2d1ec78e8d7bc265a7b40d1a5febd1d1c06047d78d6c
MD5 4ed7ef519a822fc74cba6e1224191012
BLAKE2b-256 08c08e94ed2810b143f8c66e8c54f54682057ee26ea1cbc8628d81634e9ba97c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.32-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 ab389b375388fa283c1a265e8b54b1793f3a44933dc6871689350c29855298dc
MD5 a8620d8ea78240b93a4d30d3dd3b81cd
BLAKE2b-256 f31921d3d06e562dc5f02ef00d8d86742aec339405b41ce38343faee17232cf8

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.15.32-cp35-cp35m-win_amd64.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.15.32-cp35-cp35m-win_amd64.whl
Algorithm Hash digest
SHA256 73cc39377c3518b20d19eaedbd91e84ab92a22eb8d6af7a3adb1fa221ce83988
MD5 f9ddb5005daa09a15af4650819976f55
BLAKE2b-256 d8f07e70428b2672eb91a198040c37b66d402685f1acde8b9b6f9b29733e920d

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.15.32-cp35-cp35m-win32.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.15.32-cp35-cp35m-win32.whl
Algorithm Hash digest
SHA256 192f6e959d6b5a2a75ab66eeb4086494bf2fdf93413cf06f214f5755f477d6c6
MD5 e11863c25bc3f03796ce5f27906bc0f4
BLAKE2b-256 ffaa846ee9f3856201fd521bce86f9d34b439655b19f09661a6082bc935fc35b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.32-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 743daa4ece55b579e8a45b1840c9263bc77eccd33ece12927d147f64b7d48dce
MD5 f072bb24bb90ba15ac572309e69b988d
BLAKE2b-256 77cf971c0ecdca166eb2308a8118e4a44a548df12512338ea42b6acbb69c25ba

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.15.32-cp34-cp34m-win_amd64.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.15.32-cp34-cp34m-win_amd64.whl
Algorithm Hash digest
SHA256 f8e6a2ae25a4003d021692f27ede394774a55b296f4049b3c29278fe917b8bc3
MD5 1ec623b1bc6790e14877f9280630fba7
BLAKE2b-256 efd62786fdb072b0636dc4a4f03912e1aafa7b89380018a0526a397a523f445f

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.15.32-cp34-cp34m-win32.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.15.32-cp34-cp34m-win32.whl
Algorithm Hash digest
SHA256 b91b344a3974abbf9c355cfc703e931252996e4ccdeebe0ab8311b9f5f4a318e
MD5 e5f14d39382ccd19521e52d892ea72b3
BLAKE2b-256 02bdb096733467ec2155dc933142003eeb19ea9b80e16b3f2e6dff96bc21b7b5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.32-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 d26f477fa67e8f17ecca6fd3457b0af8fb876785bbf27d3b3127fdbce060907e
MD5 31c31f7fc334794b540243100a84389d
BLAKE2b-256 00402b07e55c260168c5afa5e8f233d82d42210f48eee481100d2ba4fe1f0d26

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.15.32-cp33-cp33m-win_amd64.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.15.32-cp33-cp33m-win_amd64.whl
Algorithm Hash digest
SHA256 52a0536ae540a12cd02fc89fd93933559d6755f1d5d4b48afbb50412d0fd1df9
MD5 0ab0289adf0a15e023c3dd13cd90c018
BLAKE2b-256 3c71651a2d89ecde6cac33d4f817780486742b3e33e386f7ecef718777d61bea

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.15.32-cp33-cp33m-win32.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.15.32-cp33-cp33m-win32.whl
Algorithm Hash digest
SHA256 5a36bc5fd6179951599f564dc0ee81c74980779375cac9b546616073d7992428
MD5 c54b93ad4533cb11a526542218b10466
BLAKE2b-256 92f00c8d1fa8c5b0697d5343b693b5fcda2c290b2f12db93fce91b5b3ca67bb3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.32-cp33-cp33m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 c681bf887373ac995f2bf7b9304da7ff0cc08b88bbb5207b0bb9c17a80a9614a
MD5 73bab906d616d349d7ba3b6b0784eb65
BLAKE2b-256 3b583037e099dcc482cd8ab54f6e883d1e77783e1264603b8a445af6c3344e17

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.32-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 c6a2805e77213a9b8c62789add471cce72993d72d24523f94955fffac6931355
MD5 7c60cc5d32932a73a8d725e8dcaab26a
BLAKE2b-256 12b680d7af32a5a4bfe42e31a2e1ffcf2f3eca35c029eba59649254e463b40b2

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.15.32-cp27-cp27m-win_amd64.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.15.32-cp27-cp27m-win_amd64.whl
Algorithm Hash digest
SHA256 b1cc5b9476e6df1c44d9831d53ecaed26fd31e2d94e401d157f12a58e89e2d81
MD5 f0fe37e2fc57f2e541cf82e8ee820298
BLAKE2b-256 7a78e05cceb4953179684f8e86b682b0b84ebe7ea85ce963e2476313a1f86043

See more details on using hashes here.

File details

Details for the file ruamel.yaml-0.15.32-cp27-cp27m-win32.whl.

File metadata

File hashes

Hashes for ruamel.yaml-0.15.32-cp27-cp27m-win32.whl
Algorithm Hash digest
SHA256 5ba6a5866a4e13d41d33cc4381b1bfb608ce4b368f290e011488de83142dcbdd
MD5 bc95a9d4695ffe18993fed908ce32e55
BLAKE2b-256 11748b3aafdadb625941907eb8985c298b685fdbd412088df80c8397418e3aec

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.32-cp27-cp27m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 351c8f83c0c3ec148231fc25cb80d118979099db8c01e21ba85156956cb4abf0
MD5 4d0b0c1fb1f35f6dc8dab0975a6183b0
BLAKE2b-256 354688b476bf282b882e8187b7dd5bf3ca6169fa06cdde69d5aad4bea5b7c2f2

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