Implement semver.VersionInfo.to_dict

tomschr · tomschr · commit 9c89a539ffa7 · 2020-04-10T13:20:45.000+02:00
* Replace _asdict -&gt; to_dict
* Add docstring to to_dict
* Add test case
* Keep _asdict as a (deprecated) function for compatibility reasons
* Use to_dict in all lines instead of _asdict
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -38,8 +38,10 @@ Removals
   - ``semver.bump_{major,minor,patch,prerelease,build}``
   - ``semver.finalize_version``
   - ``semver.replace``
+  - ``semver.VersionInfo._asdict`` (use the new, public available
+    function ``semver.VersionInfo.to_dict()``)
 
-  These functions will be removed in major 3 of semver.
+  These functions will be removed in major 4 of semver.
 
 
 
diff --git a/semver.py b/semver.py
@@ -79,7 +79,7 @@ def parse(version):
     >>> ver['build']
     'build.4'
     """
-    return VersionInfo.parse(version)._asdict()
+    return VersionInfo.parse(version).to_dict()
 
 
 def comparator(operator):
@@ -186,7 +186,22 @@ def build(self, value):
     def _astuple(self):
         return (self.major, self.minor, self.patch, self.prerelease, self.build)
 
-    def _asdict(self):
+    def to_dict(self):
+        """
+        Convert the VersionInfo object to an OrderedDict.
+
+        .. versionadded:: 2.9.2
+           Renamed from ``VersionInfo._asdict`` to ``VersionInfo.to_dict`` to
+           make this function available in the public API.
+
+        :return: an OrderedDict with the keys in the order ``major``, ``minor``,
+          ``patch``, ``prerelease``, and ``build``.
+        :rtype: :class:`collections.OrderedDict`
+
+        >>> semver.VersionInfo(3, 2, 1).to_dict()
+        OrderedDict([('major', 3), ('minor', 2), ('patch', 1), \
+('prerelease', None), ('build', None)])
+        """
         return collections.OrderedDict(
             (
                 ("major", self.major),
@@ -197,6 +212,9 @@ def _asdict(self):
             )
         )
 
+    # For compatibility reasons:
+    _asdict = deprecated("to_dict")(to_dict)
+
     def __iter__(self):
         """Implement iter(self)."""
         # As long as we support Py2.7, we can't use the "yield from" syntax
@@ -286,30 +304,30 @@ def bump_build(self, token="build"):
 
     @comparator
     def __eq__(self, other):
-        return _compare_by_keys(self._asdict(), _to_dict(other)) == 0
+        return _compare_by_keys(self.to_dict(), _to_dict(other)) == 0
 
     @comparator
     def __ne__(self, other):
-        return _compare_by_keys(self._asdict(), _to_dict(other)) != 0
+        return _compare_by_keys(self.to_dict(), _to_dict(other)) != 0
 
     @comparator
     def __lt__(self, other):
-        return _compare_by_keys(self._asdict(), _to_dict(other)) < 0
+        return _compare_by_keys(self.to_dict(), _to_dict(other)) < 0
 
     @comparator
     def __le__(self, other):
-        return _compare_by_keys(self._asdict(), _to_dict(other)) <= 0
+        return _compare_by_keys(self.to_dict(), _to_dict(other)) <= 0
 
     @comparator
     def __gt__(self, other):
-        return _compare_by_keys(self._asdict(), _to_dict(other)) > 0
+        return _compare_by_keys(self.to_dict(), _to_dict(other)) > 0
 
     @comparator
     def __ge__(self, other):
-        return _compare_by_keys(self._asdict(), _to_dict(other)) >= 0
+        return _compare_by_keys(self.to_dict(), _to_dict(other)) >= 0
 
     def __repr__(self):
-        s = ", ".join("%s=%r" % (key, val) for key, val in self._asdict().items())
+        s = ", ".join("%s=%r" % (key, val) for key, val in self.to_dict().items())
         return "%s(%s)" % (type(self).__name__, s)
 
     def __str__(self):
@@ -376,12 +394,12 @@ def replace(self, **parts):
           parts
         :raises: TypeError, if ``parts`` contains invalid keys
         """
-        version = self._asdict()
+        version = self.to_dict()
         version.update(parts)
         try:
             return VersionInfo(**version)
         except TypeError:
-            unknownkeys = set(parts) - set(self._asdict())
+            unknownkeys = set(parts) - set(self.to_dict())
             error = "replace() got %d unexpected keyword " "argument(s): %s" % (
                 len(unknownkeys),
                 ", ".join(unknownkeys),
@@ -409,9 +427,9 @@ def isvalid(cls, version):
 
 def _to_dict(obj):
     if isinstance(obj, VersionInfo):
-        return obj._asdict()
+        return obj.to_dict()
     elif isinstance(obj, tuple):
-        return VersionInfo(*obj)._asdict()
+        return VersionInfo(*obj).to_dict()
     return obj
 
 
@@ -512,8 +530,8 @@ def compare(ver1, ver2):
     0
     """
 
-    v1 = VersionInfo.parse(ver1)._asdict()
-    v2 = VersionInfo.parse(ver2)._asdict()
+    v1 = VersionInfo.parse(ver1).to_dict()
+    v2 = VersionInfo.parse(ver2).to_dict()
 
     return _compare_by_keys(v1, v2)
 
diff --git a/test_semver.py b/test_semver.py
@@ -393,6 +393,12 @@ def test_should_versioninfo_bump_multiple():
     assert v.bump_prerelease().bump_build().bump_build().bump_prerelease() == expected
 
 
+def test_should_versioninfo_todict(version):
+    resultdict = version.to_dict()
+    assert isinstance(resultdict, dict), "Got type from to_dict"
+    assert list(resultdict.keys()) == ["major", "minor", "patch", "prerelease", "build"]
+
+
 def test_should_ignore_extensions_for_bump():
     assert bump_patch("3.4.5-rc1+build4") == "3.4.6"
 
