Add examples from Raphael

tomschr · rafalkrupinski · tomschr · commit 37733f39e728 · 2022-11-19T12:48:56.000+01:00
Co-authored-by: Raphael Krupinski &lt;rafalkrupinski@users.noreply.github.com&gt;
diff --git a/docs/usage/check-compatible-semver-version.rst b/docs/usage/check-compatible-semver-version.rst
@@ -4,8 +4,9 @@ Checking for a Compatible Semver Version
 In case you need to check if a semver version is compatible
 with another semver version, use :meth:`Version.is_compatible <semver.Version.is_compatible>`.
 
-A version `a` is compatible with another `b` if:
+A version `a` is compatible with another version `b` if:
 
+* Both are of type :class:`Version <semver.version.Version>`.
 * If the two majors parts are different, it's incompatible.
 * If the two major parts are equal, but the minor of `b` is
   lower than `a`, it's incompatible.
@@ -14,7 +15,6 @@ A version `a` is compatible with another `b` if:
 
 Keep in mind, the method *does not* check patches!
 
-For example, 
 
 .. code-block:: python
 
@@ -33,3 +33,23 @@ For example,
     >>> b = Version(1, 0, 0) # This is another "B"
     >>> a.is_compatible(b)
     False
+
+    # Checking compatibility between release and pre-release:
+    >>> b = Version(1,0,0,'rc1.')
+    >>> a.is_compatible(b)
+    False
+
+    # But pre-release and release:
+    >>> b.is_compatible(a)
+    True
+
+All major zero versions are incompatible with anything but itself:
+
+.. code-block:: python
+
+    >>> Version(0,1,0).is_compatible(Version(0,1,1))
+    False
+
+    # Only identical versions are compatible for major zero versions:
+    >>> Version(0,1,0).is_compatible(Version(0,1,0))
+    True
diff --git a/src/semver/version.py b/src/semver/version.py
@@ -684,6 +684,11 @@ def is_compatible(self, new: 'Version') -> bool:
             raise TypeError(
                 f"Expected a Version type but got {type(new)}"
             )
+
+        # All major-0 versions should be incompatible with anything but itself
+        if (0 == self.major == new.major) and (self[:3] != new[:3]):
+            return False
+
         return (
             (self.major == new.major)
             and (new.minor >= self.minor)
diff --git a/tests/test_semver.py b/tests/test_semver.py
@@ -89,7 +89,8 @@ def test_versioninfo_compare_should_raise_when_passed_invalid_value():
         ((1, 2, 3), (1, 2, 4)),
         ((1, 2, 4), (1, 2, 3)),
         ((1, 2, 3, "rc.0"), (1, 2, 4, "rc.0")),
-        # ((0, 1, 0, "rc.1"), (0, 0, 0, "rc.2")),
+        ((0, 1, 0), (0, 1, 0)),
+        # ((1, 0, 0, "rc1"), (1, 0, 0)),
     ],
 )
 def test_should_succeed_compatible_match(old, new):
@@ -105,11 +106,14 @@ def test_should_succeed_compatible_match(old, new):
         ((2, 0, 0), (1, 5, 0)),
         ((1, 2, 3, "rc.1"), (1, 2, 3, "rc.0")),
         ((1, 2, 3, "rc.1"), (1, 2, 4, "rc.0")),
+        ((0, 1, 0), (0, 1, 1)),
+        ((1, 0, 0), (1, 0, 0, "rc1")),
     ]
 )
 def test_should_fail_compatible_match(old, new):
     old = Version(*old)
-    assert not old.is_compatible(Version(*new))
+    new = Version(*new)
+    assert not old.is_compatible(new)
 
 
 @pytest.mark.parametrize(
@@ -121,6 +125,6 @@ def test_should_fail_compatible_match(old, new):
     ]
 )
 def test_should_fail_with_incompatible_type_for_compatible_match(wrongtype):
-    with pytest.raises(TypeError):
+    with pytest.raises(TypeError, match="Expected a Version type .*"):
         v = Version(1, 2, 3)
         v.is_compatible(wrongtype)
