| single |
ruamel.yaml
===========
``ruamel.yaml`` is a YAML 1.2 loader/dumper package for Python.
:version: 0.17.32
:updated: 2023-06-17
:documentation: http://yaml.readthedocs.io
:repository: https://sourceforge.net/projects/ruamel-yaml/
:pypi: https://pypi.org/project/ruamel.yaml/
*Starting with 0.17.22 only Python 3.7+ is supported.
The 0.17 series is also the last to support old PyYAML functions, replace
it by
creating a `YAML()` instance and use its `.load()` and `.dump()` methods.*
New(er) functionality is usually only available via the new API.
The 0.17.21 was the last one tested to be working on Python 3.5 and 3.6
(the
latter was not tested, because
tox/virtualenv stopped supporting that EOL version).
The 0.16.13 release was the last that was tested to be working on Python
2.7.
*Please adjust/pin your dependencies accordingly if necessary.
(`ruamel.yaml<0.18`)*
There are now two extra plug-in packages (`ruamel.yaml.bytes` and
`ruamel.yaml.string`)
for those not wanting to do the streaming to a `io.BytesIO/StringIO` buffer
themselves.
If your package uses ``ruamel.yaml`` and is not listed on PyPI, drop
me an email, preferably with some information on how you use the
package (or a link to the repository) and I'll keep you informed
when the status of the API is stable enough to make the transition.
* [Overview]
* [Installing]
* [Basic Usage]
* [Details]
* [Examples]
* [API]
* [Differences with PyYAML]
ChangeLog
=========
.. should insert NEXT: at the beginning of line for next key (with empty
line)
0.17.32 (2023-06-17):
- fix issue with scanner getting stuck in infinite loop
0.17.31 (2023-05-31):
- added tag.setter on `ScalarEvent` and on `Node`, that takes either
a `Tag` instance, or a str
(reported by [Sorin Sbarnea])
0.17.30 (2023-05-30):
- fix issue 467, caused by Tag instances not being hashable (reported by
[Douglas Raillard
])
0.17.29 (2023-05-30):
- changed the internals of the tag property from a string to a class
which allows
for preservation of the original handle and suffix. This should
result in better results using documents with %TAG directives, as well
as preserving URI escapes in tag suffixes.
0.17.28 (2023-05-26):
- fix for issue 464: documents ending with document end marker without
final newline
fail to load (reported by [Mariusz Rusiniak])
0.17.27 (2023-05-25):
- fix issue with inline mappings as value for merge keys
(reported by Sirish on [StackOverflow])
- fix for 468, error inserting after accessing merge attribute on
CommentedMap
(reported by [Bastien gerard])
- fix for issue 461 pop + insert on same `CommentedMap` key throwing
error
(reported by [John Thorvald Wodder II])
0.17.26 (2023-05-09):
- fix for error on edge cage for issue 459
0.17.25 (2023-05-09):
- fix for regression while dumping wrapped strings with too many
backslashes removed
(issue 459, reported by [Lele Gaifax])
0.17.24 (2023-05-06):
- rewrite of ``CommentedMap.insert()``. If you have a merge key in
the YAML document for the mapping you insert to, the position value
should
be the one as you look at the YAML input.
|