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

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.6.tar.gz (250.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.6-cp36-cp36m-manylinux1_x86_64.whl (549.8 kB view details)

Uploaded CPython 3.6m

ruamel.yaml-0.15.6-cp35-cp35m-manylinux1_x86_64.whl (549.7 kB view details)

Uploaded CPython 3.5m

ruamel.yaml-0.15.6-cp34-cp34m-manylinux1_x86_64.whl (556.2 kB view details)

Uploaded CPython 3.4m

ruamel.yaml-0.15.6-cp33-cp33m-manylinux1_x86_64.whl (530.4 kB view details)

Uploaded CPython 3.3m

ruamel.yaml-0.15.6-cp27-cp27mu-manylinux1_x86_64.whl (526.2 kB view details)

Uploaded CPython 2.7mu

ruamel.yaml-0.15.6-cp27-cp27m-manylinux1_x86_64.whl (526.2 kB view details)

Uploaded CPython 2.7m

File details

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

File metadata

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

File hashes

Hashes for ruamel.yaml-0.15.6.tar.gz
Algorithm Hash digest
SHA256 f8e6ef8656f56e47cafaa54d93668083bb0438424d2f47065eb448368bd7d5d3
MD5 509420487dd2d2af17b14c429e538f7a
BLAKE2b-256 2bfbc51dbdd5ed51eff51c8e5519c2b4593c11c0209cef75be7ef02b0a115744

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.6-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 1f87c9eda73019be00cdcf6cbbffedb546d0a1f635531bacb527cb1314550511
MD5 c613f6640667e20911e75016fe0d18af
BLAKE2b-256 5d200cfbcf40a33e8b5710293f263f397703a3f0a9877754e9f8a766cfb2b01b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.6-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 9295539da0101aafa9d144563b0ccb6ff91746a281b3138ed240c097acb488ac
MD5 35369d26e5ce2fcd32479df22eb00ddb
BLAKE2b-256 8f16fb7454a0fbf916c5b762ec57d7dea59834768858f677c050a391f8f177d2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.6-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 9648977e488a45a2233a87b47da70f04d8f973b6346cf912eb0346e274108f62
MD5 ec493b243d0b417a1171a83faf972aed
BLAKE2b-256 145977065aa0b79bd60e6405c83d807b5353d70e6df938a83bf0612b21958efe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.6-cp33-cp33m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 99c50b7ab6df30c5b7474348e52140d24237424f2f54e9ebcef409175fb986b9
MD5 af94d1045af3e8cc1e964571ad7e1d80
BLAKE2b-256 e2f313e5b299a12cc3983973a5e90ca26ec74c5ba7b2d018264e4043bb257dce

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.6-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 6a70b183a91a139253edcfbb307228c450af914fcbcbcd0ac76aaf061faf1b84
MD5 2d610decd62a3c16bbca3d38d1972ae5
BLAKE2b-256 338a778b9824d4a0fa8be84a89aafdb4482a5fbad24c12903d49b045b7fc577e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.6-cp27-cp27m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 90ca3c78404452c7cbaf9667169fe2b3ca6764a93515738b8ecb9c6bb8a9003d
MD5 ca8e7b547568f12ad0bd48eeb499a2d1
BLAKE2b-256 690984fde92e2b9e0bcda3a62b37fc049963308171b9d1c47f87383621eeb3cc

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