se #doctest: +SKIP to avoid OrderedDict result

tomschr · tomschr · commit 686ce6711a6d · 2023-07-07T13:55:57.000+02:00
The OrderedDict.__repr__ method was changed in Python 3.12 to output a different string than before (see #418 for details). The respective doctests which show the output was marked as "skipped" with the above directive. We keep the test for documentation purpuses. In the test tests/test_semver.py::test_should_versioninfo_to_dict we test the keys and values separately.
diff --git a/docs/usage/convert-version-into-different-types.rst b/docs/usage/convert-version-into-different-types.rst
@@ -16,7 +16,7 @@ It is possible to convert a :class:`~semver.version.Version` instance:
 * Into a dictionary with :meth:`~semver.version.Version.to_dict`::
 
     >>> v = Version(major=3, minor=4, patch=5)
-    >>> v.to_dict()
+    >>> v.to_dict()  #doctest: +SKIP
     OrderedDict({'major': 3, 'minor': 4, 'patch': 5, 'prerelease': None, 'build': None})
 
 * Into a tuple with :meth:`~semver.version.Version.to_tuple`::
diff --git a/docs/usage/create-a-version.rst b/docs/usage/create-a-version.rst
@@ -89,7 +89,7 @@ Depending on your use case, the following methods are available:
 
   To access individual parts, you can use the function :func:`semver.parse`::
 
-    >>> semver.parse("3.4.5-pre.2+build.4")
+    >>> semver.parse("3.4.5-pre.2+build.4")  #doctest: +SKIP
     OrderedDict({'major': 3, 'minor': 4, 'patch': 5, 'prerelease': 'pre.2', 'build': 'build.4'})
 
   If you pass an invalid version string you will get a :py:exc:`ValueError`::
diff --git a/src/semver/version.py b/src/semver/version.py
@@ -227,7 +227,7 @@ def to_dict(self) -> VersionDict:
         :return: an OrderedDict with the keys in the order ``major``, ``minor``,
           ``patch``, ``prerelease``, and ``build``.
 
-        >>> semver.Version(3, 2, 1).to_dict()
+        >>> semver.Version(3, 2, 1).to_dict()  #doctest: +SKIP
         OrderedDict({'major': 3, 'minor': 4, 'patch': 5, 'prerelease': None, \
                      'build': None})
         """
diff --git a/tests/test_semver.py b/tests/test_semver.py
@@ -28,6 +28,7 @@ def test_should_versioninfo_to_dict(version):
     resultdict = version.to_dict()
     assert isinstance(resultdict, dict), "Got type from to_dict"
     assert list(resultdict.keys()) == ["major", "minor", "patch", "prerelease", "build"]
+    assert tuple(resultdict.values()) == tuple(version)
 
 
 def test_should_versioninfo_to_tuple(version):
