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

Uploaded Source

Built Distributions

ruamel.yaml-0.15.3-cp36-cp36m-manylinux1_x86_64.whl (548.8 kB view details)

Uploaded CPython 3.6m

ruamel.yaml-0.15.3-cp35-cp35m-manylinux1_x86_64.whl (548.7 kB view details)

Uploaded CPython 3.5m

ruamel.yaml-0.15.3-cp34-cp34m-manylinux1_x86_64.whl (555.2 kB view details)

Uploaded CPython 3.4m

ruamel.yaml-0.15.3-cp33-cp33m-manylinux1_x86_64.whl (529.3 kB view details)

Uploaded CPython 3.3m

ruamel.yaml-0.15.3-cp27-cp27mu-manylinux1_x86_64.whl (525.3 kB view details)

Uploaded CPython 2.7mu

ruamel.yaml-0.15.3-cp27-cp27m-manylinux1_x86_64.whl (525.3 kB view details)

Uploaded CPython 2.7m

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.3.tar.gz
Algorithm Hash digest
SHA256 e518880ed4835e0eaa1d3833f33f503d7b2a11f4d2891dbeb401211ac7704935
MD5 089aa2f90263fb3d6d121471fc635487
BLAKE2b-256 642fd6309bacb7d7588e7acd86d391311ad1f91f2ea10ccd2a129d12c36384bd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.3-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 df6ff21131ecc13a36b21520aedf7dc0cf7e4cfb5275fa72f831c036705ae5e7
MD5 cbafa7000cd31fca87fe753152f8f5ea
BLAKE2b-256 572512a67aff072e9f455790364dc43e22d832784d218d0456861f1dcf9aacc2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.3-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 0c1b90d9cf67ddfed3a846bd6ccf17b0d885ac4d965ef479d374cc7017b9d300
MD5 0e3b7e6045ddc851895731dd2c0a02f2
BLAKE2b-256 c5aae9dbce2d364b61a5b0bba3f6d90d4ee38972e53d4f42d6a9e909010ad56a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.3-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 3f0c82a5276934aedd8a97aba66f48fbfa0e865cbdf71a8597b97a7879005e7d
MD5 e3c235c6391368de068c157cd155d44d
BLAKE2b-256 bf89d18de35cfc8efe9a3ecfed5aae2503f1f23db87a6f3b61f6356478971027

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.3-cp33-cp33m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 4767604a07377d2bd8d180be3739a9ea94dcf9e8e2596ed16580a160211a1816
MD5 b272455cd40442da7e27c334559fcb6e
BLAKE2b-256 e8d9e0300ad2af208271dd2f8e7a1100dd5adcba006b474651b0130d43e9f554

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.3-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 dec93e6e1f23b763164d1e5bfe57e075fa4f69f609ed6b94fc9ff653a8f006b5
MD5 4dc845e5ca04cc9e6c1630db4391ba7a
BLAKE2b-256 6a5e97e5565dc2904dbfa5635a0994196f9ca37075a5000fc6bff90a8357b85a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.3-cp27-cp27m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 0467dc2ffdf79b1a29296517ae44788c38805572c7bf988a4bacb08f6676a470
MD5 172205de5daaabb6f258ae829cbefca0
BLAKE2b-256 ca48df45869113f0be8ed4c770ae3780b3a2e4a8c8a3f41620fe6dfa538472ee

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