comparison env/lib/python3.7/site-packages/ruamel.yaml-0.16.0.dist-info/DESCRIPTION.rst @ 2:6af9afd405e9 draft

"planemo upload commit 0a63dd5f4d38a1f6944587f52a8cd79874177fc1"
author shellac
date Thu, 14 May 2020 14:56:58 -0400
parents 26e78fe6e8c4
children
comparison
equal deleted inserted replaced
1:75ca89e9b81c 2:6af9afd405e9
1
2 ruamel.yaml
3 ===========
4
5 ``ruamel.yaml`` is a YAML 1.2 loader/dumper package for Python.
6
7 :version: 0.16.0
8 :updated: 2019-07-25
9 :documentation: http://yaml.readthedocs.io
10 :repository: https://bitbucket.org/ruamel/yaml
11 :pypi: https://pypi.org/project/ruamel.yaml/
12
13
14 Starting with version 0.15.0 the way YAML files are loaded and dumped
15 is changing. See the API doc for details. Currently existing
16 functionality will throw a warning before being changed/removed.
17 **For production systems you should pin the version being used with
18 ``ruamel.yaml<=0.15``**. There might be bug fixes in the 0.14 series,
19 but new functionality is likely only to be available via the new API.
20
21 If your package uses ``ruamel.yaml`` and is not listed on PyPI, drop
22 me an email, preferably with some information on how you use the
23 package (or a link to bitbucket/github) and I'll keep you informed
24 when the status of the API is stable enough to make the transition.
25
26 * `Overview <http://yaml.readthedocs.org/en/latest/overview.html>`_
27 * `Installing <http://yaml.readthedocs.org/en/latest/install.html>`_
28 * `Basic Usage <http://yaml.readthedocs.org/en/latest/basicuse.html>`_
29 * `Details <http://yaml.readthedocs.org/en/latest/detail.html>`_
30 * `Examples <http://yaml.readthedocs.org/en/latest/example.html>`_
31 * `API <http://yaml.readthedocs.org/en/latest/api.html>`_
32 * `Differences with PyYAML <http://yaml.readthedocs.org/en/latest/pyyaml.html>`_
33
34 .. image:: https://readthedocs.org/projects/yaml/badge/?version=stable
35 :target: https://yaml.readthedocs.org/en/stable
36
37 .. image:: https://bestpractices.coreinfrastructure.org/projects/1128/badge
38 :target: https://bestpractices.coreinfrastructure.org/projects/1128
39
40 .. image:: https://bitbucket.org/ruamel/yaml/raw/default/_doc/_static/license.svg
41 :target: https://opensource.org/licenses/MIT
42
43 .. image:: https://bitbucket.org/ruamel/yaml/raw/default/_doc/_static/pypi.svg
44 :target: https://pypi.org/project/ruamel.yaml/
45
46 .. image:: https://bitbucket.org/ruamel/oitnb/raw/default/_doc/_static/oitnb.svg
47 :target: https://pypi.org/project/oitnb/
48
49 .. image:: http://www.mypy-lang.org/static/mypy_badge.svg
50 :target: http://mypy-lang.org/
51
52 ChangeLog
53 =========
54
55 .. should insert NEXT: at the beginning of line for next key (with empty line)
56
57 0.16.0 (2019-07-25):
58 - split of C source that generates .so file to ruamel.yaml.clib
59 - duplicate keys are now an error when working with the old API as well
60
61 0.15.100 (2019-07-17):
62 - fixing issue with dumping deep-copied data from commented YAML, by
63 providing both the memo parameter to __deepcopy__, and by allowing
64 startmarks to be compared on their content (reported by `Theofilos
65 Petsios
66 <https://bitbucket.org/%7Be550bc5d-403d-4fda-820b-bebbe71796d3%7D/>`__)
67
68 0.15.99 (2019-07-12):
69 - add `py.typed` to distribution, based on a PR submitted by
70 `Michael Crusoe
71 <https://bitbucket.org/%7Bc9fbde69-e746-48f5-900d-34992b7860c8%7D/>`__
72 - merge PR 40 (also by Michael Crusoe) to more accurately specify
73 repository in the README (also reported in a misunderstood issue
74 some time ago)
75
76 0.15.98 (2019-07-09):
77 - regenerate ext/_ruamel_yaml.c with Cython version 0.29.12, needed
78 for Python 3.8.0b2 (reported by `John Vandenberg
79 <https://bitbucket.org/%7B6d4e8487-3c97-4dab-a060-088ec50c682c%7D/>`__)
80
81 0.15.97 (2019-06-06):
82 - regenerate ext/_ruamel_yaml.c with Cython version 0.29.10, needed for
83 Python 3.8.0b1
84 - regenerate ext/_ruamel_yaml.c with Cython version 0.29.9, needed for
85 Python 3.8.0a4 (reported by `Anthony Sottile
86 <https://bitbucket.org/%7B569cc8ea-0d9e-41cb-94a4-19ea517324df%7D/>`__)
87
88 0.15.96 (2019-05-16):
89 - fix failure to indent comments on round-trip anchored block style
90 scalars in block sequence (reported by `William Kimball
91 <https://bitbucket.org/%7Bba35ed20-4bb0-46f8-bb5d-c29871e86a22%7D/>`__)
92
93 0.15.95 (2019-05-16):
94 - fix failure to round-trip anchored scalars in block sequence
95 (reported by `William Kimball
96 <https://bitbucket.org/%7Bba35ed20-4bb0-46f8-bb5d-c29871e86a22%7D/>`__)
97 - wheel files for Python 3.4 no longer provided (`Python 3.4 EOL 2019-03-18
98 <https://www.python.org/dev/peps/pep-0429/>`__)
99
100 0.15.94 (2019-04-23):
101 - fix missing line-break after end-of-file comments not ending in
102 line-break (reported by `Philip Thompson
103 <https://bitbucket.org/%7Be42ba205-0876-4151-bcbe-ccaea5bd13ce%7D/>`__)
104
105 0.15.93 (2019-04-21):
106 - fix failure to parse empty implicit flow mapping key
107 - in YAML 1.1 plains scalars `y`, 'n', `Y`, and 'N' are now
108 correctly recognised as booleans and such strings dumped quoted
109 (reported by `Marcel Bollmann
110 <https://bitbucket.org/%7Bd8850921-9145-4ad0-ac30-64c3bd9b036d%7D/>`__)
111
112 0.15.92 (2019-04-16):
113 - fix failure to parse empty implicit block mapping key (reported by
114 `Nolan W <https://bitbucket.org/i2labs/>`__)
115
116 0.15.91 (2019-04-05):
117 - allowing duplicate keys would not work for merge keys (reported by mamacdon on
118 `StackOverflow <https://stackoverflow.com/questions/55540686/>`__
119
120 0.15.90 (2019-04-04):
121 - fix issue with updating `CommentedMap` from list of tuples (reported by
122 `Peter Henry <https://bitbucket.org/mosbasik/>`__)
123
124 0.15.89 (2019-02-27):
125 - fix for items with flow-mapping in block sequence output on single line
126 (reported by `Zahari Dim <https://bitbucket.org/zahari_dim/>`__)
127 - fix for safe dumping erroring in creation of representereror when dumping namedtuple
128 (reported and solution by `Jaakko Kantojärvi <https://bitbucket.org/raphendyr/>`__)
129
130 0.15.88 (2019-02-12):
131 - fix inclusing of python code from the subpackage data (containing extra tests,
132 reported by `Florian Apolloner <https://bitbucket.org/apollo13/>`__)
133
134 0.15.87 (2019-01-22):
135 - fix problem with empty lists and the code to reinsert merge keys (reported via email
136 by Zaloo)
137
138 0.15.86 (2019-01-16):
139 - reinsert merge key in its old position (reported by grumbler on
140 `StackOverflow <https://stackoverflow.com/a/54206512/1307905>`__)
141 - fix for issue with non-ASCII anchor names (reported and fix
142 provided by Dandaleon Flux via email)
143 - fix for issue when parsing flow mapping value starting with colon (in pure Python only)
144 (reported by `FichteFoll <https://bitbucket.org/FichteFoll/>`__)
145
146 0.15.85 (2019-01-08):
147 - the types used by ``SafeConstructor`` for mappings and sequences can
148 now by set by assigning to ``XXXConstructor.yaml_base_dict_type``
149 (and ``..._list_type``), preventing the need to copy two methods
150 with 50+ lines that had ``var = {}`` hardcoded. (Implemented to
151 help solve an feature request by `Anthony Sottile
152 <https://bitbucket.org/asottile/>`__ in an easier way)
153
154 0.15.84 (2019-01-07):
155 - fix for ``CommentedMap.copy()`` not returning ``CommentedMap``, let alone copying comments etc.
156 (reported by `Anthony Sottile <https://bitbucket.org/asottile/>`__)
157
158 0.15.83 (2019-01-02):
159 - fix for bug in roundtripping aliases used as key (reported via email by Zaloo)
160
161 0.15.82 (2018-12-28):
162 - anchors and aliases on scalar int, float, string and bool are now preserved. Anchors
163 do not need a referring alias for these (reported by
164 `Alex Harvey <https://bitbucket.org/alexharv074/>`__)
165 - anchors no longer lost on tagged objects when roundtripping (reported by `Zaloo
166 <https://bitbucket.org/zaloo/>`__)
167
168 0.15.81 (2018-12-06):
169 - fix issue dumping methods of metaclass derived classes (reported and fix provided
170 by `Douglas Raillard <https://bitbucket.org/DouglasRaillard/>`__)
171
172 0.15.80 (2018-11-26):
173 - fix issue emitting BEL character when round-tripping invalid folded input
174 (reported by Isaac on `StackOverflow <https://stackoverflow.com/a/53471217/1307905>`__)
175
176 0.15.79 (2018-11-21):
177 - fix issue with anchors nested deeper than alias (reported by gaFF on
178 `StackOverflow <https://stackoverflow.com/a/53397781/1307905>`__)
179
180 0.15.78 (2018-11-15):
181 - fix setup issue for 3.8 (reported by `Sidney Kuyateh
182 <https://bitbucket.org/autinerd/>`__)
183
184 0.15.77 (2018-11-09):
185 - setting `yaml.sort_base_mapping_type_on_output = False`, will prevent
186 explicit sorting by keys in the base representer of mappings. Roundtrip
187 already did not do this. Usage only makes real sense for Python 3.6+
188 (feature request by `Sebastian Gerber <https://bitbucket.org/spacemanspiff2007/>`__).
189 - implement Python version check in YAML metadata in ``_test/test_z_data.py``
190
191 0.15.76 (2018-11-01):
192 - fix issue with empty mapping and sequence loaded as flow-style
193 (mapping reported by `Min RK <https://bitbucket.org/minrk/>`__, sequence
194 by `Maged Ahmed <https://bitbucket.org/maged2/>`__)
195
196 0.15.75 (2018-10-27):
197 - fix issue with single '?' scalar (reported by `Terrance
198 <https://bitbucket.org/OllieTerrance/>`__)
199 - fix issue with duplicate merge keys (prompted by `answering
200 <https://stackoverflow.com/a/52852106/1307905>`__ a
201 `StackOverflow question <https://stackoverflow.com/q/52851168/1307905>`__
202 by `math <https://stackoverflow.com/users/1355634/math>`__)
203
204 0.15.74 (2018-10-17):
205 - fix dropping of comment on rt before sequence item that is sequence item
206 (reported by `Thorsten Kampe <https://bitbucket.org/thorstenkampe/>`__)
207
208 0.15.73 (2018-10-16):
209 - fix irregular output on pre-comment in sequence within sequence (reported
210 by `Thorsten Kampe <https://bitbucket.org/thorstenkampe/>`__)
211 - allow non-compact (i.e. next line) dumping sequence/mapping within sequence.
212
213 0.15.72 (2018-10-06):
214 - fix regression on explicit 1.1 loading with the C based scanner/parser
215 (reported by `Tomas Vavra <https://bitbucket.org/xtomik/>`__)
216
217 0.15.71 (2018-09-26):
218 - some of the tests now live in YAML files in the
219 `yaml.data <https://bitbucket.org/ruamel/yaml.data>`__ repository.
220 ``_test/test_z_data.py`` processes these.
221 - fix regression where handcrafted CommentedMaps could not be initiated (reported by
222 `Dan Helfman <https://bitbucket.org/dhelfman/>`__)
223 - fix regression with non-root literal scalars that needed indent indicator
224 (reported by `Clark Breyman <https://bitbucket.org/clarkbreyman/>`__)
225 - tag:yaml.org,2002:python/object/apply now also uses __qualname__ on PY3
226 (reported by `Douglas RAILLARD <https://bitbucket.org/DouglasRaillard/>`__)
227 - issue with self-referring object creation
228 (reported and fix by `Douglas RAILLARD <https://bitbucket.org/DouglasRaillard/>`__)
229
230 0.15.70 (2018-09-21):
231 - reverted CommentedMap and CommentedSeq to subclass ordereddict resp. list,
232 reimplemented merge maps so that both ``dict(**commented_map_instance)`` and JSON
233 dumping works. This also allows checking with ``isinstance()`` on ``dict`` resp. ``list``.
234 (Proposed by `Stuart Berg <https://bitbucket.org/stuarteberg/>`__, with feedback
235 from `blhsing <https://stackoverflow.com/users/6890912/blhsing>`__ on
236 `StackOverflow <https://stackoverflow.com/q/52314186/1307905>`__)
237
238 0.15.69 (2018-09-20):
239 - fix issue with dump_all gobbling end-of-document comments on parsing
240 (reported by `Pierre B. <https://bitbucket.org/octplane/>`__)
241
242 0.15.68 (2018-09-20):
243 - fix issue with parsabel, but incorrect output with nested flow-style sequences
244 (reported by `Dougal Seeley <https://bitbucket.org/dseeley/>`__)
245 - fix issue with loading Python objects that have __setstate__ and recursion in parameters
246 (reported by `Douglas RAILLARD <https://bitbucket.org/DouglasRaillard/>`__)
247
248 0.15.67 (2018-09-19):
249 - fix issue with extra space inserted with non-root literal strings
250 (Issue reported and PR with fix provided by
251 `Naomi Seyfer <https://bitbucket.org/sixolet/>`__.)
252
253 0.15.66 (2018-09-07):
254 - fix issue with fold indicating characters inserted in safe_load-ed folded strings
255 (reported by `Maximilian Hils <https://bitbucket.org/mhils/>`__).
256
257 0.15.65 (2018-09-07):
258 - fix issue #232 revert to throw ParserError for unexcpected ``]``
259 and ``}`` instead of IndexError. (Issue reported and PR with fix
260 provided by `Naomi Seyfer <https://bitbucket.org/sixolet/>`__.)
261 - added ``key`` and ``reverse`` parameter (suggested by Jannik Klemm via email)
262 - indent root level literal scalars that have directive or document end markers
263 at the beginning of a line
264
265 0.15.64 (2018-08-30):
266 - support round-trip of tagged sequences: ``!Arg [a, {b: 1}]``
267 - single entry mappings in flow sequences now written by default without braces,
268 set ``yaml.brace_single_entry_mapping_in_flow_sequence=True`` to force
269 getting ``[a, {b: 1}, {c: {d: 2}}]`` instead of the default ``[a, b: 1, c: {d: 2}]``
270 - fix issue when roundtripping floats starting with a dot such as ``.5``
271 (reported by `Harrison Gregg <https://bitbucket.org/HarrisonGregg/>`__)
272
273 0.15.63 (2018-08-29):
274 - small fix only necessary for Windows users that don't use wheels.
275
276 0.15.62 (2018-08-29):
277 - C based reader/scanner & emitter now allow setting of 1.2 as YAML version.
278 ** The loading/dumping is still YAML 1.1 code**, so use the common subset of
279 YAML 1.2 and 1.1 (reported by `Ge Yang <https://bitbucket.org/yangge/>`__)
280
281 0.15.61 (2018-08-23):
282 - support for round-tripping folded style scalars (initially requested
283 by `Johnathan Viduchinsky <https://bitbucket.org/johnathanvidu/>`__)
284 - update of C code
285 - speed up of scanning (~30% depending on the input)
286
287 0.15.60 (2018-08-18):
288 - again allow single entry map in flow sequence context (reported by
289 `Lee Goolsbee <https://bitbucket.org/lgoolsbee/>`__)
290 - cleanup for mypy
291 - spurious print in library (reported by
292 `Lele Gaifax <https://bitbucket.org/lele/>`__), now automatically checked
293
294 0.15.59 (2018-08-17):
295 - issue with C based loader and leading zeros (reported by
296 `Tom Hamilton Stubber <https://bitbucket.org/TomHamiltonStubber/>`__)
297
298 0.15.58 (2018-08-17):
299 - simple mappings can now be used as keys when round-tripping::
300
301 {a: 1, b: 2}: hello world
302
303 although using the obvious operations (del, popitem) on the key will
304 fail, you can mutilate it by going through its attributes. If you load the
305 above YAML in `d`, then changing the value is cumbersome:
306
307 d = {CommentedKeyMap([('a', 1), ('b', 2)]): "goodbye"}
308
309 and changing the key even more so:
310
311 d[CommentedKeyMap([('b', 1), ('a', 2)])] = d.pop(
312 CommentedKeyMap([('a', 1), ('b', 2)]))
313
314 (you can use a `dict` instead of a list of tuples (or ordereddict), but that might result
315 in a different order, of the keys of the key, in the output)
316 - check integers to dump with 1.2 patterns instead of 1.1 (reported by
317 `Lele Gaifax <https://bitbucket.org/lele/>`__)
318
319
320 0.15.57 (2018-08-15):
321 - Fix that CommentedSeq could no longer be used in adding or do a sort
322 (reported by `Christopher Wright <https://bitbucket.org/CJ-Wright4242/>`__)
323
324 0.15.56 (2018-08-15):
325 - fix issue with ``python -O`` optimizing away code (reported, and detailed cause
326 pinpointed, by `Alex Grönholm <https://bitbucket.org/agronholm/>`__)
327
328 0.15.55 (2018-08-14):
329 - unmade ``CommentedSeq`` a subclass of ``list``. It is now
330 indirectly a subclass of the standard
331 ``collections.abc.MutableSequence`` (without .abc if you are
332 still on Python2.7). If you do ``isinstance(yaml.load('[1, 2]'),
333 list)``) anywhere in your code replace ``list`` with
334 ``MutableSequence``. Directly, ``CommentedSeq`` is a subclass of
335 the abstract baseclass ``ruamel.yaml.compat.MutableScliceableSequence``,
336 with the result that *(extended) slicing is supported on
337 ``CommentedSeq``*.
338 (reported by `Stuart Berg <https://bitbucket.org/stuarteberg/>`__)
339 - duplicate keys (or their values) with non-ascii now correctly
340 report in Python2, instead of raising a Unicode error.
341 (Reported by `Jonathan Pyle <https://bitbucket.org/jonathan_pyle/>`__)
342
343 0.15.54 (2018-08-13):
344 - fix issue where a comment could pop-up twice in the output (reported by
345 `Mike Kazantsev <https://bitbucket.org/mk_fg/>`__ and by
346 `Nate Peterson <https://bitbucket.org/ndpete21/>`__)
347 - fix issue where JSON object (mapping) without spaces was not parsed
348 properly (reported by `Marc Schmidt <https://bitbucket.org/marcj/>`__)
349 - fix issue where comments after empty flow-style mappings were not emitted
350 (reported by `Qinfench Chen <https://bitbucket.org/flyin5ish/>`__)
351
352 0.15.53 (2018-08-12):
353 - fix issue with flow style mapping with comments gobbled newline (reported
354 by `Christopher Lambert <https://bitbucket.org/XN137/>`__)
355 - fix issue where single '+' under YAML 1.2 was interpreted as
356 integer, erroring out (reported by `Jethro Yu
357 <https://bitbucket.org/jcppkkk/>`__)
358
359 0.15.52 (2018-08-09):
360 - added `.copy()` mapping representation for round-tripping
361 (``CommentedMap``) to fix incomplete copies of merged mappings
362 (reported by `Will Richards
363 <https://bitbucket.org/will_richards/>`__)
364 - Also unmade that class a subclass of ordereddict to solve incorrect behaviour
365 for ``{**merged-mapping}`` and ``dict(**merged-mapping)`` (reported independently by
366 `Tim Olsson <https://bitbucket.org/tgolsson/>`__ and
367 `Filip Matzner <https://bitbucket.org/FloopCZ/>`__)
368
369 0.15.51 (2018-08-08):
370 - Fix method name dumps (were not dotted) and loads (reported by `Douglas Raillard
371 <https://bitbucket.org/DouglasRaillard/>`__)
372 - Fix spurious trailing white-space caused when the comment start
373 column was no longer reached and there was no actual EOL comment
374 (e.g. following empty line) and doing substitutions, or when
375 quotes around scalars got dropped. (reported by `Thomas Guillet
376 <https://bitbucket.org/guillett/>`__)
377
378 0.15.50 (2018-08-05):
379 - Allow ``YAML()`` as a context manager for output, thereby making it much easier
380 to generate multi-documents in a stream.
381 - Fix issue with incorrect type information for `load()` and `dump()` (reported
382 by `Jimbo Jim <https://bitbucket.org/jimbo1qaz/>`__)
383
384 0.15.49 (2018-08-05):
385 - fix preservation of leading newlines in root level literal style scalar,
386 and preserve comment after literal style indicator (``| # some comment``)
387 Both needed for round-tripping multi-doc streams in
388 `ryd <https://pypi.org/project/ryd/>`__.
389
390 0.15.48 (2018-08-03):
391 - housekeeping: ``oitnb`` for formatting, mypy 0.620 upgrade and conformity
392
393 0.15.47 (2018-07-31):
394 - fix broken 3.6 manylinux1, the result of an unclean ``build`` (reported by
395 `Roman Sichnyi <https://bitbucket.org/rsichnyi-gl/>`__)
396
397
398 0.15.46 (2018-07-29):
399 - fixed DeprecationWarning for importing from ``collections`` on 3.7
400 (issue 210, reported by `Reinoud Elhorst
401 <https://bitbucket.org/reinhrst/>`__). It was `difficult to find
402 why tox/pytest did not report
403 <https://stackoverflow.com/q/51573204/1307905>`__ and as time
404 consuming to actually `fix
405 <https://stackoverflow.com/a/51573205/1307905>`__ the tests.
406
407 0.15.45 (2018-07-26):
408 - After adding failing test for ``YAML.load_all(Path())``, remove StopIteration
409 (PR provided by `Zachary Buhman <https://bitbucket.org/buhman/>`__,
410 also reported by `Steven Hiscocks <https://bitbucket.org/sdhiscocks/>`__.
411
412 0.15.44 (2018-07-14):
413 - Correct loading plain scalars consisting of numerals only and
414 starting with `0`, when not explicitly specifying YAML version
415 1.1. This also fixes the issue about dumping string `'019'` as
416 plain scalars as reported by `Min RK
417 <https://bitbucket.org/minrk/>`__, that prompted this chance.
418
419 0.15.43 (2018-07-12):
420 - merge PR33: Python2.7 on Windows is narrow, but has no
421 ``sysconfig.get_config_var('Py_UNICODE_SIZE')``. (merge provided by
422 `Marcel Bargull <https://bitbucket.org/mbargull/>`__)
423 - ``register_class()`` now returns class (proposed by
424 `Mike Nerone <https://bitbucket.org/Manganeez/>`__}
425
426 0.15.42 (2018-07-01):
427 - fix regression showing only on narrow Python 2.7 (py27mu) builds
428 (with help from
429 `Marcel Bargull <https://bitbucket.org/mbargull/>`__ and
430 `Colm O'Connor <https://bitbucket.org/colmoconnorgithub/>`__).
431 - run pre-commit ``tox`` on Python 2.7 wide and narrow, as well as
432 3.4/3.5/3.6/3.7/pypy
433
434 0.15.41 (2018-06-27):
435 - add detection of C-compile failure (investigation prompted by
436 `StackOverlow <https://stackoverflow.com/a/51057399/1307905>`__ by
437 `Emmanuel Blot <https://stackoverflow.com/users/8233409/emmanuel-blot>`__),
438 which was removed while no longer dependent on ``libyaml``, C-extensions
439 compilation still needs a compiler though.
440
441 0.15.40 (2018-06-18):
442 - added links to landing places as suggested in issue 190 by
443 `KostisA <https://bitbucket.org/ankostis/>`__
444 - fixes issue #201: decoding unicode escaped tags on Python2, reported
445 by `Dan Abolafia <https://bitbucket.org/danabo/>`__
446
447 0.15.39 (2018-06-17):
448 - merge PR27 improving package startup time (and loading when regexp not
449 actually used), provided by
450 `Marcel Bargull <https://bitbucket.org/mbargull/>`__
451
452 0.15.38 (2018-06-13):
453 - fix for losing precision when roundtripping floats by
454 `Rolf Wojtech <https://bitbucket.org/asomov/>`__
455 - fix for hardcoded dir separator not working for Windows by
456 `Nuno André <https://bitbucket.org/nu_no/>`__
457 - typo fix by `Andrey Somov <https://bitbucket.org/asomov/>`__
458
459 0.15.37 (2018-03-21):
460 - again trying to create installable files for 187
461
462 0.15.36 (2018-02-07):
463 - fix issue 187, incompatibility of C extension with 3.7 (reported by
464 Daniel Blanchard)
465
466 0.15.35 (2017-12-03):
467 - allow ``None`` as stream when specifying ``transform`` parameters to
468 ``YAML.dump()``.
469 This is useful if the transforming function doesn't return a meaningful value
470 (inspired by `StackOverflow <https://stackoverflow.com/q/47614862/1307905>`__ by
471 `rsaw <https://stackoverflow.com/users/406281/rsaw>`__).
472
473 0.15.34 (2017-09-17):
474 - fix for issue 157: CDumper not dumping floats (reported by Jan Smitka)
475
476 0.15.33 (2017-08-31):
477 - support for "undefined" round-tripping tagged scalar objects (in addition to
478 tagged mapping object). Inspired by a use case presented by Matthew Patton
479 on `StackOverflow <https://stackoverflow.com/a/45967047/1307905>`__.
480 - fix issue 148: replace cryptic error message when using !!timestamp with an
481 incorrectly formatted or non- scalar. Reported by FichteFoll.
482
483 0.15.32 (2017-08-21):
484 - allow setting ``yaml.default_flow_style = None`` (default: ``False``) for
485 for ``typ='rt'``.
486 - fix for issue 149: multiplications on ``ScalarFloat`` now return ``float``
487 (reported by jan.brezina@tul.cz)
488
489 0.15.31 (2017-08-15):
490 - fix Comment dumping
491
492 0.15.30 (2017-08-14):
493 - fix for issue with "compact JSON" not parsing: ``{"in":{},"out":{}}``
494 (reported on `StackOverflow <https://stackoverflow.com/q/45681626/1307905>`__ by
495 `mjalkio <https://stackoverflow.com/users/5130525/mjalkio>`_
496
497 0.15.29 (2017-08-14):
498 - fix issue #51: different indents for mappings and sequences (reported by
499 Alex Harvey)
500 - fix for flow sequence/mapping as element/value of block sequence with
501 sequence-indent minus dash-offset not equal two.
502
503 0.15.28 (2017-08-13):
504 - fix issue #61: merge of merge cannot be __repr__-ed (reported by Tal Liron)
505
506 0.15.27 (2017-08-13):
507 - fix issue 62, YAML 1.2 allows ``?`` and ``:`` in plain scalars if non-ambigious
508 (reported by nowox)
509 - fix lists within lists which would make comments disappear
510
511 0.15.26 (2017-08-10):
512 - fix for disappearing comment after empty flow sequence (reported by
513 oit-tzhimmash)
514
515 0.15.25 (2017-08-09):
516 - fix for problem with dumping (unloaded) floats (reported by eyenseo)
517
518 0.15.24 (2017-08-09):
519 - added ScalarFloat which supports roundtripping of 23.1, 23.100,
520 42.00E+56, 0.0, -0.0 etc. while keeping the format. Underscores in mantissas
521 are not preserved/supported (yet, is anybody using that?).
522 - (finally) fixed longstanding issue 23 (reported by `Antony Sottile
523 <https://bitbucket.org/asottile/>`__), now handling comment between block
524 mapping key and value correctly
525 - warn on YAML 1.1 float input that is incorrect (triggered by invalid YAML
526 provided by Cecil Curry)
527 - allow setting of boolean representation (`false`, `true`) by using:
528 ``yaml.boolean_representation = [u'False', u'True']``
529
530 0.15.23 (2017-08-01):
531 - fix for round_tripping integers on 2.7.X > sys.maxint (reported by ccatterina)
532
533 0.15.22 (2017-07-28):
534 - fix for round_tripping singe excl. mark tags doubling (reported and fix by Jan Brezina)
535
536 0.15.21 (2017-07-25):
537 - fix for writing unicode in new API, (reported on
538 `StackOverflow <https://stackoverflow.com/a/45281922/1307905>`__
539
540 0.15.20 (2017-07-23):
541 - wheels for windows including C extensions
542
543 0.15.19 (2017-07-13):
544 - added object constructor for rt, decorator ``yaml_object`` to replace YAMLObject.
545 - fix for problem using load_all with Path() instance
546 - fix for load_all in combination with zero indent block style literal
547 (``pure=True`` only!)
548
549 0.15.18 (2017-07-04):
550 - missing ``pure`` attribute on ``YAML`` useful for implementing `!include` tag
551 constructor for `including YAML files in a YAML file
552 <https://stackoverflow.com/a/44913652/1307905>`__
553 - some documentation improvements
554 - trigger of doc build on new revision
555
556 0.15.17 (2017-07-03):
557 - support for Unicode supplementary Plane **output**
558 (input was already supported, triggered by
559 `this <https://stackoverflow.com/a/44875714/1307905>`__ Stack Overflow Q&A)
560
561 0.15.16 (2017-07-01):
562 - minor typing issues (reported and fix provided by
563 `Manvendra Singh <https://bitbucket.org/manu-chroma/>`__
564 - small doc improvements
565
566 0.15.15 (2017-06-27):
567 - fix for issue 135, typ='safe' not dumping in Python 2.7
568 (reported by Andrzej Ostrowski <https://bitbucket.org/aostr123/>`__)
569
570 0.15.14 (2017-06-25):
571 - fix for issue 133, in setup.py: change ModuleNotFoundError to
572 ImportError (reported and fix by
573 `Asley Drake <https://github.com/aldraco>`__)
574
575 0.15.13 (2017-06-24):
576 - suppress duplicate key warning on mappings with merge keys (reported by
577 Cameron Sweeney)
578
579 0.15.12 (2017-06-24):
580 - remove fatal dependency of setup.py on wheel package (reported by
581 Cameron Sweeney)
582
583 0.15.11 (2017-06-24):
584 - fix for issue 130, regression in nested merge keys (reported by
585 `David Fee <https://bitbucket.org/dfee/>`__)
586
587 0.15.10 (2017-06-23):
588 - top level PreservedScalarString not indented if not explicitly asked to
589 - remove Makefile (not very useful anyway)
590 - some mypy additions
591
592 0.15.9 (2017-06-16):
593 - fix for issue 127: tagged scalars were always quoted and seperated
594 by a newline when in a block sequence (reported and largely fixed by
595 `Tommy Wang <https://bitbucket.org/twang817/>`__)
596
597 0.15.8 (2017-06-15):
598 - allow plug-in install via ``install ruamel.yaml[jinja2]``
599
600 0.15.7 (2017-06-14):
601 - add plug-in mechanism for load/dump pre resp. post-processing
602
603 0.15.6 (2017-06-10):
604 - a set() with duplicate elements now throws error in rt loading
605 - support for toplevel column zero literal/folded scalar in explicit documents
606
607 0.15.5 (2017-06-08):
608 - repeat `load()` on a single `YAML()` instance would fail.
609
610 0.15.4 (2017-06-08):
611 - `transform` parameter on dump that expects a function taking a
612 string and returning a string. This allows transformation of the output
613 before it is written to stream. This forces creation of the complete output in memory!
614 - some updates to the docs
615
616 0.15.3 (2017-06-07):
617 - No longer try to compile C extensions on Windows. Compilation can be forced by setting
618 the environment variable `RUAMEL_FORCE_EXT_BUILD` to some value
619 before starting the `pip install`.
620
621 0.15.2 (2017-06-07):
622 - update to conform to mypy 0.511: mypy --strict
623
624 0.15.1 (2017-06-07):
625 - `duplicate keys <http://yaml.readthedocs.io/en/latest/api.html#duplicate-keys>`__
626 in mappings generate an error (in the old API this change generates a warning until 0.16)
627 - dependecy on ruamel.ordereddict for 2.7 now via extras_require
628
629 0.15.0 (2017-06-04):
630 - it is now allowed to pass in a ``pathlib.Path`` as "stream" parameter to all
631 load/dump functions
632 - passing in a non-supported object (e.g. a string) as "stream" will result in a
633 much more meaningful YAMLStreamError.
634 - assigning a normal string value to an existing CommentedMap key or CommentedSeq
635 element will result in a value cast to the previous value's type if possible.
636 - added ``YAML`` class for new API
637
638 0.14.12 (2017-05-14):
639 - fix for issue 119, deepcopy not returning subclasses (reported and PR by
640 Constantine Evans <cevans@evanslabs.org>)
641
642 0.14.11 (2017-05-01):
643 - fix for issue 103 allowing implicit documents after document end marker line (``...``)
644 in YAML 1.2
645
646 0.14.10 (2017-04-26):
647 - fix problem with emitting using cyaml
648
649 0.14.9 (2017-04-22):
650 - remove dependency on ``typing`` while still supporting ``mypy``
651 (http://stackoverflow.com/a/43516781/1307905)
652 - fix unclarity in doc that stated 2.6 is supported (reported by feetdust)
653
654 0.14.8 (2017-04-19):
655 - fix Text not available on 3.5.0 and 3.5.1, now proactively setting version guards
656 on all files (reported by `João Paulo Magalhães <https://bitbucket.org/jpmag/>`__)
657
658 0.14.7 (2017-04-18):
659 - round trip of integers (decimal, octal, hex, binary) now preserve
660 leading zero(s) padding and underscores. Underscores are presumed
661 to be at regular distances (i.e. ``0o12_345_67`` dumps back as
662 ``0o1_23_45_67`` as the space from the last digit to the
663 underscore before that is the determining factor).
664
665 0.14.6 (2017-04-14):
666 - binary, octal and hex integers are now preserved by default. This
667 was a known deficiency. Working on this was prompted by the issue report (112)
668 from devnoname120, as well as the additional experience with `.replace()`
669 on `scalarstring` classes.
670 - fix issues 114: cannot install on Buildozer (reported by mixmastamyk).
671 Setting env. var ``RUAMEL_NO_PIP_INSTALL_CHECK`` will suppress ``pip``-check.
672
673 0.14.5 (2017-04-04):
674 - fix issue 109: None not dumping correctly at top level (reported by Andrea Censi)
675 - fix issue 110: .replace on Preserved/DoubleQuoted/SingleQuoted ScalarString
676 would give back "normal" string (reported by sandres23)
677
678 0.14.4 (2017-03-31):
679 - fix readme
680
681 0.14.3 (2017-03-31):
682 - fix for 0o52 not being a string in YAML 1.1 (reported on
683 `StackOverflow Q&A 43138503 <http://stackoverflow.com/a/43138503/1307905>`__ by
684 `Frank D <http://stackoverflow.com/users/7796630/frank-d>`__)
685
686 0.14.2 (2017-03-23):
687 - fix for old default pip on Ubuntu 14.04 (reported by Sébastien Maccagnoni-Munch)
688
689 0.14.1 (2017-03-22):
690 - fix Text not available on 3.5.0 and 3.5.1 (reported by Charles Bouchard-Légaré)
691
692 0.14.0 (2017-03-21):
693 - updates for mypy --strict
694 - preparation for moving away from inheritance in Loader and Dumper, calls from e.g.
695 the Representer to the Serializer.serialize() are now done via the attribute
696 .serializer.serialize(). Usage of .serialize() outside of Serializer will be
697 deprecated soon
698 - some extra tests on main.py functions
699
700 ----
701
702 For older changes see the file
703 `CHANGES <https://bitbucket.org/ruamel/yaml/src/default/CHANGES>`_
704
705