Support matching 'equal' when no operator is provided (#362)

jmi2k · web-flow · commit b5317af9a7e9 · 2022-07-04T15:51:44.000+02:00
* Add tests for new default equality match behavior
* Change documentation and add changelog
diff --git a/changelog.d/pr362.feature.rst b/changelog.d/pr362.feature.rst
@@ -0,0 +1,2 @@
+Make :meth:`.Version.match` accept a bare version string as match expression, defaulting to
+equality testing.
diff --git a/docs/usage/compare-versions-through-expression.rst b/docs/usage/compare-versions-through-expression.rst
@@ -24,3 +24,16 @@ That gives you the following possibilities to express your condition:
     True
     >>> semver.match("1.0.0", ">1.0.0")
     False
+
+If no operator is specified, the match expression is interpreted as a
+version to be compared for equality. This allows handling the common
+case of version compatibility checking through either an exact version
+or a match expression very easy to implement, as the same code will
+handle both cases:
+
+.. code-block:: python
+
+    >>> semver.match("2.0.0", "2.0.0")
+    True
+    >>> semver.match("1.0.0", "3.5.1")
+    False
diff --git a/src/semver/version.py b/src/semver/version.py
@@ -522,7 +522,7 @@ def match(self, match_expr: str) -> bool:
         """
         Compare self to match a match expression.
 
-        :param match_expr: operator and version; valid operators are
+        :param match_expr: optional operator and version; valid operators are
               ``<```   smaller than
               ``>``   greater than
               ``>=``  greator or equal than
@@ -535,13 +535,18 @@ def match(self, match_expr: str) -> bool:
         True
         >>> semver.Version.parse("1.0.0").match(">1.0.0")
         False
+        >>> semver.Version.parse("4.0.4").match("4.0.4")
+        True
         """
         prefix = match_expr[:2]
         if prefix in (">=", "<=", "==", "!="):
             match_version = match_expr[2:]
         elif prefix and prefix[0] in (">", "<"):
             prefix = prefix[0]
             match_version = match_expr[1:]
+        elif match_expr and match_expr[0] in "0123456789":
+            prefix = "=="
+            match_version = match_expr
         else:
             raise ValueError(
                 "match_expr parameter should be in format <op><ver>, "
diff --git a/tests/test_match.py b/tests/test_match.py
@@ -23,6 +23,18 @@ def test_should_match_not_equal(left, right, expected):
     assert match(left, right) is expected
 
 
+@pytest.mark.parametrize(
+    "left,right,expected",
+    [
+        ("2.3.7", "2.3.7", True),
+        ("2.3.6", "2.3.6", True),
+        ("2.3.7", "4.3.7", False),
+    ],
+)
+def test_should_match_equal_by_default(left, right, expected):
+    assert match(left, right) is expected
+
+
 @pytest.mark.parametrize(
     "left,right,expected",
     [
@@ -49,7 +61,7 @@ def test_should_raise_value_error_for_unexpected_match_expression(left, right):
 
 
 @pytest.mark.parametrize(
-    "left,right", [("1.0.0", ""), ("1.0.0", "!"), ("1.0.0", "1.0.0")]
+    "left,right", [("1.0.0", ""), ("1.0.0", "!")]
 )
 def test_should_raise_value_error_for_invalid_match_expression(left, right):
     with pytest.raises(ValueError):

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+Make :meth:`.Version.match` accept a bare version string as match expression, defaulting to
	`2`	`+equality testing.`