Merge branch 'main' into intdot-scheme

Author: immqu

CHANGELOG.rst

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+Version v31.0.0
+----------------
+
+- Raise instead of returning ``NotImplementedError`` in ``version_range.VersionRange`` methods. https://github.com/aboutcode-org/univers/pull/158
+
 Version v30.12.1
 ----------------
 

src/univers/py.typed

@@ -21,6 +21,8 @@
 from univers.utils import remove_spaces
 from univers.version_constraint import VersionConstraint
 from univers.version_constraint import contains_version
+from univers.versions import AllVersion
+from univers.versions import NoneVersion
 
 
 class InvalidVersionRange(Exception):
@@ -76,15 +78,15 @@ def from_native(cls, string):
         Return a VersionRange built from a scheme-specific, native version range
         ``string``. Subclasses can implement.
         """
-        return NotImplementedError
+        raise NotImplementedError
 
     @classmethod
     def from_natives(cls, strings):
         """
         Return a VersionRange built from a ``strings`` list of scheme-
         specific native version range strings. Subclasses can implement.
         """
-        return NotImplementedError
+        raise NotImplementedError
 
     def to_native(self, *args, **kwargs):
         """
@@ -93,7 +95,7 @@ def to_native(self, *args, **kwargs):
         extra arguments (such as a package name that some scheme may require
         like for deb and rpm.)
         """
-        return NotImplementedError
+        raise NotImplementedError
 
     @classmethod
     def from_string(cls, vers, simplify=False, validate=False):
@@ -174,7 +176,7 @@ def from_versions(cls, sequence):
         such as ["3.0.0", "1.0.1b", "3.0.2", "0.9.7a", "1.1.1ka"]
         """
         if not cls.scheme or not cls.version_class:
-            return NotImplementedError
+            raise NotImplementedError
 
         constraints = []
         for version in sequence:
@@ -220,6 +222,13 @@ def __contains__(self, version):
         object. A version is contained in a VersionRange if it satisfies its
         constraints according to ``vers`` rules.
         """
+
+        if self.version_class is AllVersion:
+            return True
+
+        if self.version_class is NoneVersion:
+            return False
+
         if not isinstance(version, self.version_class):
             raise TypeError(
                 f"{version!r} is not of expected type: {self.version_class!r}",
@@ -712,9 +721,9 @@ class PypiVersionRange(VersionRange):
     def from_native(cls, string):
         """
         Return a VersionRange built from a PyPI PEP440 version specifiers ``string``.
-        Raise an a univers.versions.InvalidVersion
+        Raise a univers.versions.InvalidVersion
         """
-        # TODO: environment markers are yet supported
+        # TODO: environment markers are not yet supported
         # TODO: handle  .* version, ~= and === operators
 
         if ";" in string:
@@ -1182,6 +1191,16 @@ class MattermostVersionRange(VersionRange):
     version_class = versions.SemverVersion
 
 
+class AllVersionRange(VersionRange):
+    scheme = "all"
+    version_class = versions.AllVersion
+
+
+class NoneVersionRange(VersionRange):
+    scheme = "none"
+    version_class = versions.NoneVersion
+
+
 def from_gitlab_native(gitlab_scheme, string):
     purl_scheme = gitlab_scheme
     if gitlab_scheme not in PURL_TYPE_BY_GITLAB_SCHEME.values():
@@ -1425,6 +1444,8 @@ def build_range_from_snyk_advisory_string(scheme: str, string: Union[str, List])
     "mattermost": MattermostVersionRange,
     "conan": ConanVersionRange,
     "intdot": IntdotVersionRange,
+    "all": AllVersionRange,
+    "none": NoneVersionRange,
 }
 
 PURL_TYPE_BY_GITLAB_SCHEME = {

src/univers/version_range.py

@@ -124,7 +124,7 @@ def build_value(self, string):
 
     def satisfies(self, constraint):
         """
-        Return True is this Version satisfies the ``constraint``
+        Return True if this Version satisfies the ``constraint``
         VersionConstraint. Satisfying means that this version is "within" the
         ``constraint``.
         """
@@ -144,6 +144,18 @@ def is_valid(cls, string):
         return intdot.IntdotVersion.is_valid(string)
 
 
+class AllVersion(Version):
+    @classmethod
+    def is_valid(cls, string):
+        return string == "vers:all/*"
+
+
+class NoneVersion(Version):
+    @classmethod
+    def is_valid(cls, string):
+        return string == "vers:none/*"
+
+
 class GenericVersion(Version):
     @classmethod
     def is_valid(cls, string):

src/univers/versions.py

@@ -30,6 +30,7 @@
 from univers.versions import PypiVersion
 from univers.versions import RubygemsVersion
 from univers.versions import SemverVersion
+from univers.versions import Version
 
 
 class TestVersionRange(TestCase):
@@ -557,3 +558,25 @@ def test_version_range_intdot():
     assert IntdotVersion("1.3.3alpha") in intdot_range
     assert IntdotVersion("1.2.2.pre") not in intdot_range
     assert IntdotVersion("1010.23.234203.0") in IntdotVersionRange.from_string("vers:intdot/*")
+
+
+def test_version_range_all():
+    all_vers = VersionRange.from_string("vers:all/*")
+    assert all_vers.contains(Version("1.2.3"))
+    assert PypiVersion("2.0.3") in all_vers
+    # test for invalid all range specification
+    with pytest.raises(Exception):
+        VersionRange.from_string("vers:all/>1.2.3")
+    with pytest.raises(Exception):
+        VersionRange.from_string("vers:all/*|>1.2.3")
+
+
+def test_version_range_none():
+    none_vers = VersionRange.from_string("vers:none/*")
+    assert not none_vers.contains(Version("1.2.3"))
+    assert PypiVersion("2.0.3") not in none_vers
+    # test for invalid all range specification
+    with pytest.raises(Exception):
+        VersionRange.from_string("vers:none/!1.2.3")
+    with pytest.raises(Exception):
+        VersionRange.from_string("vers:none/*|>1.2.3")