| single |
ruamel.yaml
===========
``ruamel.yaml`` is a YAML 1.2 loader/dumper package for Python.
:version: 0.17.17
:updated: 2021-10-31
:documentation: http://yaml.readthedocs.io
:repository: https://sourceforge.net/projects/ruamel-yaml/
:pypi: https://pypi.org/project/ruamel.yaml/
*The 0.16.13 release was the last that was tested to be working on Python
2.7.
The 0.17 series will still be tested on Python 3.5, but the 0.18 will not.
The
0.17 series will also stop support for the old PyYAML functions, so a
`YAML()` instance
will need to be created.*
*The 0.17 series will also see changes in how comments are attached during
roundtrip. This will result in backwards incompatibilities on the `.ca`
data and
it might even be necessary for documented methods that handle comments.*
*Please adjust your dependencies accordingly if necessary.
(`ruamel.yaml<0.17`)*
Starting with version 0.15.0 the way YAML files are loaded and dumped
has been changing, see the API doc for details. Currently existing
functionality will throw a warning before being changed/removed.
**For production systems already using a pre 0.16 version, you should
pin the version being used with ``ruamel.yaml<=0.15``** if you cannot
fully test upgrading to a newer version. For new usage
pin to the minor version tested ( ``ruamel.yaml<=0.17``) or even to the
exact version used.
New functionality is usually only available via the new API, so
make sure you use it and stop using the `ruamel.yaml.safe_load()`,
`ruamel.yaml.round_trip_load()` and `ruamel.yaml.load()` functions
(and their `
ChangeLog
=========
.. should insert NEXT: at the beginning of line for next key (with empty
line)
0.17.17 (2021-10-31):
- extract timestamp matching/creation to util
0.17.16 (2021-08-28):
- 398 also handle issue 397 when comment is newline
0.17.15 (2021-08-28):
- fix issue 397, insert comment before key when a comment between key and
value exists
(reported by [Bastien gerard])
0.17.14 (2021-08-25):
- fix issue 396, inserting key/val in merged-in dictionary (reported by
[Bastien gerard
])
0.17.13 (2021-08-21):
- minor fix in attr handling
0.17.12 (2021-08-21):
- fix issue with anchor on registered class not preserved and those
classes using package
attrs with `@attr.s()` (both reported by [ssph])
0.17.11 (2021-08-19):
- fix error baseclass for DuplicateKeyErorr (reported by `Łukasz
Rogalski
`__)
- fix typo in reader error message, causing `KeyError` during reader
error
(reported by [MTU])
0.17.10 (2021-06-24):
- fix issue 388, token with old comment structure != two elements
(reported by [Dimitrios Bariamis])
0.17.9 (2021-06-10):
- fix issue with updating CommentedMap (reported by sri on
[StackOverflow])
0.17.8 (2021-06-09):
- fix for issue 387 where templated anchors on tagged object did get set
resulting in potential id reuse. (reported by [Artem Ploujnikov
])
0.17.7 (2021-05-31):
- issue 385 also affected other deprecated loaders (reported via email
by Oren Watson)
0.17.6 (2021-05-31):
- merged type annotations update provided by
[Jochen Sprickerhof]
|