Mercurial > repos > shellac > sam_consensus_v3

comparison env/lib/python3.9/site-packages/ruamel.yaml-0.16.5.dist-info/DESCRIPTION.rst @ 0:4f3585e2f14b draft default tip

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