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

ChangeLog

0.15.38 (2018-06-13):
0.15.37 (2018-03-21):
  • again trying to create installable files for 187

0.15.36 (2018-02-07):
  • fix issue 187, incompatibility of C extension with 3.7 (reported by Daniel Blanchard)

0.15.35 (2017-12-03):
  • allow None as stream when specifying transform parameters to YAML.dump(). This is useful if the transforming function doesn’t return a meaningful value (inspired by StackOverflow by rsaw).

0.15.34 (2017-09-17):
  • fix for issue 157: CDumper not dumping floats (reported by Jan Smitka)

0.15.33 (2017-08-31):
  • support for “undefined” round-tripping tagged scalar objects (in addition to tagged mapping object). Inspired by a use case presented by Matthew Patton on StackOverflow.

  • fix issue 148: replace cryptic error message when using !!timestamp with an incorrectly formatted or non- scalar. Reported by FichteFoll.

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 (reported by jan.brezina@tul.cz)

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

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

Uploaded Source

Built Distributions

ruamel.yaml-0.15.38-cp36-cp36m-win_amd64.whl (203.4 kB view details)

Uploaded CPython 3.6m Windows x86-64

ruamel.yaml-0.15.38-cp36-cp36m-win32.whl (183.7 kB view details)

Uploaded CPython 3.6m Windows x86

ruamel.yaml-0.15.38-cp36-cp36m-manylinux1_x86_64.whl (641.9 kB view details)

Uploaded CPython 3.6m

ruamel.yaml-0.15.38-cp35-cp35m-win_amd64.whl (200.2 kB view details)

Uploaded CPython 3.5m Windows x86-64

ruamel.yaml-0.15.38-cp35-cp35m-win32.whl (180.8 kB view details)

Uploaded CPython 3.5m Windows x86

ruamel.yaml-0.15.38-cp35-cp35m-manylinux1_x86_64.whl (622.0 kB view details)

Uploaded CPython 3.5m

ruamel.yaml-0.15.38-cp34-cp34m-win_amd64.whl (202.3 kB view details)

Uploaded CPython 3.4m Windows x86-64

ruamel.yaml-0.15.38-cp34-cp34m-win32.whl (189.0 kB view details)

Uploaded CPython 3.4m Windows x86

ruamel.yaml-0.15.38-cp34-cp34m-manylinux1_x86_64.whl (632.1 kB view details)

Uploaded CPython 3.4m

ruamel.yaml-0.15.38-cp33-cp33m-win_amd64.whl (208.5 kB view details)

Uploaded CPython 3.3m Windows x86-64

ruamel.yaml-0.15.38-cp33-cp33m-win32.whl (194.9 kB view details)

Uploaded CPython 3.3m Windows x86

ruamel.yaml-0.15.38-cp33-cp33m-manylinux1_x86_64.whl (601.6 kB view details)

Uploaded CPython 3.3m

ruamel.yaml-0.15.38-cp27-cp27mu-manylinux1_x86_64.whl (590.2 kB view details)

Uploaded CPython 2.7mu

ruamel.yaml-0.15.38-cp27-cp27m-win_amd64.whl (207.2 kB view details)

Uploaded CPython 2.7m Windows x86-64

ruamel.yaml-0.15.38-cp27-cp27m-win32.whl (188.9 kB view details)

Uploaded CPython 2.7m Windows x86

ruamel.yaml-0.15.38-cp27-cp27m-manylinux1_x86_64.whl (590.2 kB view details)

Uploaded CPython 2.7m

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38.tar.gz
Algorithm Hash digest
SHA256 18f90a4ecbcf74429bacac13a79b8754f3f1e6d595bfdc7d9ed87d92110b23dc
MD5 b10fc3e00ec53a1f39de959f3a25b68d
BLAKE2b-256 ff2078ce49baec9d1fadab9a8ae6a475bec798219f4f308345a444006a3c9e6b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 7658c153b9afee7e34f3eeac4b054d649eb439969916da5b8ece4923c9da4267
MD5 dac350e21ee1547162288cbcb2c1c362
BLAKE2b-256 c71fd18ff3a42fa69b6ea2795f483ea9a981ed50cf57b02a3434ae391550c207

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38-cp36-cp36m-win32.whl
Algorithm Hash digest
SHA256 9cfe020d40c0b1f0084190bcdfbc9cdf1c994d2e2f758c2d1dcdbcfe407b5669
MD5 0fd3e26bee70c3993feee6d71f9633dc
BLAKE2b-256 45419868844c0b054105d5ba4719facdc58c5fea8cd167e2b1de0a6ec1df52cc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 08e5fe95231ab901f969c4840035906fb2e52d40f4f1eb7f1a5f2587b60d445b
MD5 b071a0a2ff2f69074bba42c68cbd07c4
BLAKE2b-256 da2d9b08ef62f1c86a70e767d7bf4f56effb7795c5ebdf178d3d1d9f276f8afa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38-cp35-cp35m-win_amd64.whl
Algorithm Hash digest
SHA256 0b375da0c5e1682068b0c570ff0a83371c7e2d70731bdc50639273f1bc96d7a9
MD5 2d7a76e09a0fa58e519b0c2abb4e142f
BLAKE2b-256 0344e814fd816e82d3acbb3972433eea2891b48ff8e45042dc12c11d19b4c643

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38-cp35-cp35m-win32.whl
Algorithm Hash digest
SHA256 0a6cd7e5171c2ea286a2c66d0198d972c609d82d94f9a055d2510bf0e13c5d48
MD5 d72801c5d43a688e4084be30389dd3f5
BLAKE2b-256 ebe8d299fdd4e74ce99192af26bd25955803a1bacf819f6a8d8ee70fa1e348bd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 2efec6ec310ef42ebf6b01135e8a3d282562a3e300156e3a2c08d8e9fc830aaa
MD5 2e0e2088dd50748817af13af74a7b4a6
BLAKE2b-256 3b148d50909e275ab673076e2031dca3cb2cf47cfb0c0c5367329ee903b6e5cb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38-cp34-cp34m-win_amd64.whl
Algorithm Hash digest
SHA256 8713ea70426fa55dc0baccb473e9a20f359cdabab02921e2f901a13089bec7e5
MD5 3c3b1796be3bcfe9dcf6948d189de585
BLAKE2b-256 7543237378b136131827ca7218d8e0049bdb0412f8116f28b95f951d659a428c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38-cp34-cp34m-win32.whl
Algorithm Hash digest
SHA256 35769288452ad3d2b0e2c135f87e48b9c6f106d2a00dbde0c881b4c905a27179
MD5 10f94f0830ba6f4cd6bba306bd51b859
BLAKE2b-256 231d2d82e92b5f320ee5ae263ff9e97414b192b482391708c2a83c4292450bf7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 6969104259735f11c9e5a24c91d2a0f2174329c66be155d86bc387908297fe9d
MD5 0b7f059a1ab5162eb08d0feaaca80aec
BLAKE2b-256 46147fa98d9c8e55a9b3e271d231ff501fb00185c5c3f308b9af6094c41ffb72

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38-cp33-cp33m-win_amd64.whl
Algorithm Hash digest
SHA256 e7176691ec66eecdfccf921a9b42f1d7bbb22aa6e9ccde3dc0eb959ac17415d0
MD5 466bee18744294ad5778b60a32b49c79
BLAKE2b-256 77f701b47727ca3ba47feee3c9185b1ad50b73f4a0aa93cc4b84401e18cf5866

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38-cp33-cp33m-win32.whl
Algorithm Hash digest
SHA256 613acf5aa8fd828929e71a1d11f6ae8d95086cd54e5bc6d0dd8fa8d8368bd157
MD5 1fd08bce64a72e9ef146786899f75b3b
BLAKE2b-256 f088c5a23ca954cf8aedb0912cf36060f33b5cbac29ec4ac7b8660d0ea3f19d1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38-cp33-cp33m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 e1bcd48febee5abb2fb9fe6706870b5c4c5f4b7115b5ba87acadf17a658dae89
MD5 c7fe8d4b0a3a2cd9a5afec75260b4306
BLAKE2b-256 a2c11d79fe67483d62029e79c2398799cf988b11c22a77ad54a43fae18494385

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 9411b1fd59c95456dc11ec64f3f30b11069a2685c3c4e0ad3e1138c92624b7af
MD5 bd9d17a765f3e076de17e4868327ebb1
BLAKE2b-256 eb879864d75578b88c23ef5247a908619c53fcb851379ad94cf3c2028391d3e7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38-cp27-cp27m-win_amd64.whl
Algorithm Hash digest
SHA256 4915133b0b6b98bf175f340801d7848ec4bcdf2cae32e8dc13b7cab7d70363c3
MD5 8d45b0c4907766ba81a30e52e9a56b85
BLAKE2b-256 bc4203ef6ac77efa91ecf2c57d99016ee3d8875063d6be5c0ae84832587d5439

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38-cp27-cp27m-win32.whl
Algorithm Hash digest
SHA256 743513c3bc59705caf2fdb77f71b3af539db4418a6df97f3751ac9dfc63e77c8
MD5 8928372e109dd3982a53b0d5d797ee58
BLAKE2b-256 3e1c1c342737c72017c1d4ded7cb76be53a82736236aa6f81b186eb4323d50be

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ruamel.yaml-0.15.38-cp27-cp27m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 a1e2a5730e1fd9036ce5563ea999ccb43a2ff360b7a9c4b13eff8e56e8660431
MD5 ade28abdd0e802df789feb158385ff8a
BLAKE2b-256 fc4fbfbec488d4233e0afbf3382ba40bd4e5b897d994e57115d37f9e008bf5b3

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