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

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

Uploaded Source

Built Distributions

ruamel.yaml-0.15.15-cp36-cp36m-manylinux1_x86_64.whl (549.4 kB view details)

Uploaded CPython 3.6m

ruamel.yaml-0.15.15-cp35-cp35m-manylinux1_x86_64.whl (549.2 kB view details)

Uploaded CPython 3.5m

ruamel.yaml-0.15.15-cp34-cp34m-manylinux1_x86_64.whl (555.7 kB view details)

Uploaded CPython 3.4m

ruamel.yaml-0.15.15-cp33-cp33m-manylinux1_x86_64.whl (529.9 kB view details)

Uploaded CPython 3.3m

ruamel.yaml-0.15.15-cp27-cp27mu-manylinux1_x86_64.whl (525.7 kB view details)

Uploaded CPython 2.7mu

ruamel.yaml-0.15.15-cp27-cp27m-manylinux1_x86_64.whl (525.8 kB view details)

Uploaded CPython 2.7m

File details

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

File metadata

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

File hashes

Hashes for ruamel.yaml-0.15.15.tar.gz
Algorithm Hash digest
SHA256 b1d33d81ba40305c0edf94188068a69767fb489ff43b053f4427c72da209cc22
MD5 16cb2967e0f7417cf99af36d69519235
BLAKE2b-256 d6eb42814c44d2678c460b3322145d5c6b320785ef4590d837fd07d64263ffd8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.15-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 25eb97aef6a1c88b6fd93dad50aebf7524d5f5deabf497282425c1f8049c4747
MD5 82f0b2fefc9b77abfbc02ce95efdfa38
BLAKE2b-256 251760d61c24829d317350a9528f7f72c5fca7ec9da29ff73d230db5d36a611e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.15-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 d6ad7f0fa9086cf54e126cd7a8a2e0c9a29a9ccd603c18d5aa81ce301db4cd96
MD5 11b72fb115e2e062516f5f4f41bd3823
BLAKE2b-256 20c07de5824d74380d370d99d46a6d0bc637c4b8903c22bb7419a85336ff6423

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.15-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 063390702c15458b1a3d80adaa41ed9fbd7424a8ca0a62bc2363a3fa00ae0f8a
MD5 d36f3311b9d98dcef9fda153e4d7b12f
BLAKE2b-256 d431275d925dd9360878ab7db6a2c0fe3b4e2f6ebb391f34916c28dd5290456d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.15-cp33-cp33m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 ce869285aed2962038eceb6cc2f91a2716c9c8a1f1fa3ee6c70750b6e1b9d820
MD5 d2cedaf526299ba2969da53cf6f52601
BLAKE2b-256 24a6cc9abc2e8300784ed47d3cb3e478a90ed16de38946fdc32dc9a6474d4c08

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.15-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 510fddf43eff181662f7fe3d6f0516d8e7e914f8bb6d604f2e7b1147bb4162ba
MD5 14bcb0b2c8d22709794689912daedff3
BLAKE2b-256 d89a763eb0fb618c71efcbff4c827e68ec0b2b1610e1a384ca6c9be5ea2d1ec0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.15-cp27-cp27m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 e71768a83448896627329193e646ab1ef2200a1a159dfbe461dc9c55a6a3725a
MD5 1e631eb2205eae46d927ea4ecb48432e
BLAKE2b-256 54b1977920e83bb91f57665b44dfb71d4db8fb80046c08db6351cadb0f80b83f

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