1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
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.
* `Overview <http://yaml.readthedocs.org/en/latest/overview.html>`_
* `Installing <http://yaml.readthedocs.org/en/latest/install.html>`_
* `Basic Usage <http://yaml.readthedocs.org/en/latest/basicuse.html>`_
* `Details <http://yaml.readthedocs.org/en/latest/detail.html>`_
* `Examples <http://yaml.readthedocs.org/en/latest/example.html>`_
* `API <http://yaml.readthedocs.org/en/latest/api.html>`_
* `Differences with PyYAML <http://yaml.readthedocs.org/en/latest/pyyaml.html>`_
.. image:: https://readthedocs.org/projects/yaml/badge/?version=stable
:target: https://yaml.readthedocs.org/en/stable
.. image:: https://bestpractices.coreinfrastructure.org/projects/1128/badge
:target: https://bestpractices.coreinfrastructure.org/projects/1128
ChangeLog
=========
.. should insert NEXT: at the beginning of line for next key
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):
- fix for writing unicode in new API, https://stackoverflow.com/a/45281922/1307905
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
<https://stackoverflow.com/a/44913652/1307905>`_
- 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 <https://stackoverflow.com/a/44875714/1307905>`_ Stack Overflow Q&A)
0.15.16 (2017-07-01):
- minor typing issues (reported and fix provided by
`Manvendra Singh <https://bitbucket.org/manu-chroma/>`_
- small doc improvements
0.15.15 (2017-06-27):
- fix for issue 135, typ='safe' not dumping in Python 2.7
(reported by Andrzej Ostrowski <https://bitbucket.org/aostr123/>`_)
0.15.14 (2017-06-25):
- fix for issue 133, in setup.py: change ModuleNotFoundError to
ImportError (reported and fix by
`Asley Drake <https://github.com/aldraco>`_)
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 <https://bitbucket.org/dfee/>`_)
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 <https://bitbucket.org/twang817/>`_)
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 <http://yaml.readthedocs.io/en/latest/api.html#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):
- remove dependency on ``typing`` while still supporting ``mypy``
(http://stackoverflow.com/a/43516781/1307905)
- fix unclarity in doc that stated 2.6 is supported (reported by feetdust)
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 <https://bitbucket.org/jpmag/>`_)
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):
- fix for 0o52 not being a string in YAML 1.1 (reported on
`StackOverflow Q&A 43138503 <http://stackoverflow.com/a/43138503/1307905>`_ by
`Frank D <http://stackoverflow.com/users/7796630/frank-d>`_)
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 <https://bitbucket.org/ruamel/yaml/src/default/CHANGES>`_
|
