Merge pull request #28 from faucetsdn/ruamel.yaml-0.18.16

gizmoguy · web-flow · commit a011c9cdb681 · 2025-11-13T09:49:34.000+13:00
Import ruamel.yaml 0.18.16 source
diff --git a/.hgignore b/.hgignore
@@ -15,6 +15,8 @@ _doc/*.pdf
 _doc/*.html
 _doc/*.rst
 _doc/*.md
+_doc/spec
+_doc/.zine*
 *.py_alt
 
 ziglib
diff --git a/.hgtags b/.hgtags
@@ -241,3 +241,4 @@ eb3ecf31085135283908fc8449befebbc1fff4b3 0.18.5
 d815398d9f0fc4034dc709e36775cfff5f7a2a6b 0.18.12
 375c4db4c7c5fad61e149fc0690e50229df23ab3 0.18.13
 8912dd84f448cbe00b38495f01386fc966d7e9f3 0.18.14
+d3d281cdfa9d128f98abf7750220cd5bf1526c76 0.18.15
diff --git a/CHANGES b/CHANGES
@@ -1,3 +1,9 @@
+[0.18.16, 2025-10-22]:
+- root level block style scalars that started with a directives-end marker or a 
+  document-end marker, are now indented 2 spaces.
+- merged fix for accessing end_marks on Tokens provided by 
+  [Toknak](https://sourceforge.net/u/taknok/)
+
 [0.18.15, 2025-08-19]:
 - duplicate merge keys are never allowed (not even with .allow_duplicate_keys = 
   True
diff --git a/README.md b/README.md
@@ -4,8 +4,8 @@
 
 | | |
 | - | - |
-| version |0.18.14 |
-| updated |2025-06-09 |
+| version |0.18.16 |
+| updated |2025-10-22 |
 | documentation |https://yaml.dev/doc/ruamel.yaml |
 | repository |https://sourceforge.net/projects/ruamel-yaml |
 | pypi |https://pypi.org/project/ruamel.yaml |
@@ -81,7 +81,7 @@ 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.
 
-For packaging purposes you can use a download of the [tar balls oof tagged source](https://yaml.dev/ruamel-dl-tagged-releases)
+For packaging purposes you can use a download of the [tar balls of tagged source](https://yaml.dev/ruamel-dl-tagged-releases)
 
 
 <a href="https://bestpractices.coreinfrastructure.org/projects/1128"><img src="https://bestpractices.coreinfrastructure.org/projects/1128/badge"></a>
@@ -90,7 +90,14 @@ For packaging purposes you can use a download of the [tar balls oof tagged sourc
 <a href="https://pypi.org/project/oitnb/"><img src="https://sourceforge.net/p/oitnb/code/ci/default/tree/_doc/_static/oitnb.svg?format=raw"></a>
 <a href="http://mypy-lang.org/"><img src="http://www.mypy-lang.org/static/mypy_badge.svg"></a>
 <a href="https://www.pepy.tech/projects/ruamel.yaml"><img src="https://img.shields.io/pepy/dt/ruamel.yaml.svg"></a>
-NEXT:<br>
+
+0.18.16 (2025-10-22):
+
+- root level block style scalars that started with a directives-end marker or a document-end marker, are now indented 2 spaces.
+- merged fix for accessing end_marks on Tokens provided by [Toknak](https://sourceforge.net/u/taknok/)
+
+0.18.15 (2025-08-19):
+
 - duplicate merge keys are never allowed (not even with .allow_duplicate_keys = True
 - merge keys now keep there position if a key before the merge key gets deleted (previously a key after the merge key would move before it)
 
diff --git a/__init__.py b/__init__.py
@@ -6,9 +6,9 @@
 
 _package_data = dict(
     full_package_name='ruamel.yaml',
-    version_info=(0, 18, 15),
-    __version__='0.18.15',
-    version_timestamp='2025-08-19 12:01:38',
+    version_info=(0, 18, 16),
+    __version__='0.18.16',
+    version_timestamp='2025-10-22 19:50:12',
     author='Anthon van der Neut',
     author_email='a.van.der.neut@ruamel.eu',
     description='ruamel.yaml is a YAML parser/emitter that supports roundtrip preservation of comments, seq/map flow style, and map key order',  # NOQA
diff --git a/_doc/README.ryd b/_doc/README.ryd
@@ -130,7 +130,7 @@ 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.
 
-For packaging purposes you can use a download of the [tar balls oof tagged source](https://yaml.dev/ruamel-dl-tagged-releases)
+For packaging purposes you can use a download of the [tar balls of tagged source](https://yaml.dev/ruamel-dl-tagged-releases)
 
 --- !comment |
 # # ToDo 2024-12
diff --git a/_doc/_static/pypi.svg b/_doc/_static/pypi.svg
@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="86" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="86" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h33v20H0z"/><path fill="#007ec6" d="M33 0h53v20H33z"/><path fill="url(#b)" d="M0 0h86v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"> <text x="175" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="230">pypi</text><text x="175" y="140" transform="scale(.1)" textLength="230">pypi</text><text x="585" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">0.18.15</text><text x="585" y="140" transform="scale(.1)" textLength="430">0.18.15</text></g> </svg>
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="86" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="86" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h33v20H0z"/><path fill="#007ec6" d="M33 0h53v20H33z"/><path fill="url(#b)" d="M0 0h86v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"> <text x="175" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="230">pypi</text><text x="175" y="140" transform="scale(.1)" textLength="230">pypi</text><text x="585" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">0.18.16</text><text x="585" y="140" transform="scale(.1)" textLength="430">0.18.16</text></g> </svg>
diff --git a/_test/test_literal.py b/_test/test_literal.py
@@ -323,6 +323,20 @@ def test_rt_root_literal_scalar_no_indent_no_eol(self) -> None:
         d = yaml.load(ys)
         yaml.dump(d, compare=ys)
 
+    def test_rt_root_literal_scalar_directive_end_at_start(self) -> None:
+        yaml = YAML()
+        yaml.explicit_start = True
+        s = 'abc'
+        ys = """
+        --- |
+          ---
+          {}
+        """
+        ys = ys.format(s)
+        d = yaml.load(ys)
+        assert str(d) == '---\n{}\n'.format(s)
+        yaml.dump(d, compare=ys)
+
     def test_rt_non_root_literal_scalar(self) -> None:
         yaml = YAML()
         s = 'testing123'
diff --git a/_test/test_z_data.py b/_test/test_z_data.py
@@ -102,7 +102,7 @@ def pytest_generate_tests(metafunc: Any) -> None:
     for path in paths:
         # while developing tests put them in data/debug and run:
         #   auto -c "pytest _test/test_z_data.py" data/debug/*.yaml *.py _test/*.py
-        if os.environ.get('RUAMELAUTOTEST') == '1':
+        if os.environ.get('RUAMEL_AUTOTEST') == '1':
             if path.parent.stem != 'debug':
                 continue
         elif path.parent.stem == 'debug':
diff --git a/compat.py b/compat.py
@@ -70,8 +70,8 @@ def with_metaclass(meta: Any, *bases: Any) -> Any:
 
 
 _debug: Optional[int] = None
-if 'RUAMELDEBUG' in os.environ:
-    _debugx = os.environ.get('RUAMELDEBUG')
+if 'RUAMEL_DEBUG' in os.environ:
+    _debugx = os.environ.get('RUAMEL_DEBUG')
     if _debugx is None:
         _debug = 0
     else:
diff --git a/emitter.py b/emitter.py
@@ -1490,21 +1490,27 @@ def determine_block_hints(self, text: Any) -> Any:
                 indent = 2
                 hints += str(indent)
             elif self.root_context:
-                for end in ['\n---', '\n...']:
+                for end in ['---', '...']:
+                    position = -1
                     pos = 0
-                    while True:
+                    while position == -1:
                         pos = text.find(end, pos)
                         if pos == -1:
                             break
+                        if pos != 0:
+                            if text[pos - 1] != '\n':
+                                pos += 1
+                                continue
                         try:
-                            if text[pos + 4] in ' \r\n':
+                            if text[pos + len(end)] in ' \r\n':
+                                position = pos
                                 break
                         except IndexError:
                             pass
                         pos += 1
-                    if pos > -1:
+                    if position != -1:
                         break
-                if pos > 0:
+                if position != -1:
                     indent = 2
             if text[-1] not in '\n\x85\u2028\u2029':
                 indicator = '-'
diff --git a/scalarbool.py b/scalarbool.py
@@ -1,6 +1,3 @@
-
-from __future__ import annotations
-
 """
 You cannot subclass bool, and this is necessary for round-tripping anchored
 bool values (and also if you want to preserve the original way of writing)
@@ -10,6 +7,8 @@
 You can use these in an if statement, but not when testing equivalence
 """
 
+from __future__ import annotations
+
 from ruamel.yaml.anchor import Anchor
 
 if False:  # MYPY
diff --git a/scanner.py b/scanner.py
diff --git a/tokens.py b/tokens.py
diff --git a/tox.ini b/tox.ini
