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

Uploaded Source

Built Distributions

ruamel.yaml-0.15.8-cp36-cp36m-manylinux1_x86_64.whl (550.4 kB view details)

Uploaded CPython 3.6m

ruamel.yaml-0.15.8-cp35-cp35m-manylinux1_x86_64.whl (550.3 kB view details)

Uploaded CPython 3.5m

ruamel.yaml-0.15.8-cp34-cp34m-manylinux1_x86_64.whl (556.8 kB view details)

Uploaded CPython 3.4m

ruamel.yaml-0.15.8-cp33-cp33m-manylinux1_x86_64.whl (531.0 kB view details)

Uploaded CPython 3.3m

ruamel.yaml-0.15.8-cp27-cp27mu-manylinux1_x86_64.whl (526.8 kB view details)

Uploaded CPython 2.7mu

ruamel.yaml-0.15.8-cp27-cp27m-manylinux1_x86_64.whl (526.8 kB view details)

Uploaded CPython 2.7m

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.8.tar.gz
Algorithm Hash digest
SHA256 07e9879b9910cbf883a6d87b19cf59da7b866666db5fd3535ecd5ef9af696fb1
MD5 6edbf812427ee67c6d9f9bc7656c02b4
BLAKE2b-256 239d29ec5160f9be632b077143a55dceb7338b2f18990b3839d88b03a2bb1371

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.8-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 d1d4c912fa81f7545941359bb1e535d7380082ddd4762fd01a3ca1b76d9744cd
MD5 3ad3ad45874d8e31788a1dca39e7924b
BLAKE2b-256 458d3d60027fcc29b1d8db62470c8953d991e18521af6b5fe7446141d8de3ed9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.8-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 37e8889953e08281ea2f09cbf21f0a6f81a259a0d34345d9bfa1e6b03b102b61
MD5 6eb631e157d7f8ea2fc6071c7595fe21
BLAKE2b-256 2c41852e92b1fcf4692677df349875300bc9f50a29ee8c7d08d21b43016ecf9c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.8-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 1ce6703dd585a39950683cf36b8205dc53c24ae3574ed128a820627812054a4f
MD5 f269125c02ad47fedd5d22e6d58f13d3
BLAKE2b-256 13d62424255a2b932fdf725dd8fb594e20a92cfeacd56bfc28cc30d5222dd7e7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.8-cp33-cp33m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 6d88a9da959c6dc179d93a3ba64805db52151a8233957946432c308b6d0a489b
MD5 ccf43bea982da2da24338bb8831efae5
BLAKE2b-256 52f9551724bf19eefe1ca946f64b1bff5fd6e7f65d199ff72d1219a7e576724f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.8-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 2548438acdb87ce04d4298aa84f4d39e61f03a2ffe7b118a08d1a541e50251ad
MD5 a43805edbbaf15692278dbf1d05ee1b7
BLAKE2b-256 af822ae534a95f814c63116337c09a8962d8086834df4134bc2b865e62ccb84a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.8-cp27-cp27m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 341b6c3f10df75aeb5342a1fdff782cdec36e1202dfa86f81d04ca00b1a911e7
MD5 0b4ddee896696aa91ec4d9cc44d6e820
BLAKE2b-256 f939cb5977706d4f346182ee12d4749a5a3b30432b23f9ff1eff5b49549cf8f1

See more details on using hashes here.

Supported by

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