Skip to content

Fix #236: add missing deprecated functions #239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 23, 2020
Merged

Fix #236: add missing deprecated functions #239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
14cd842
Fix #236: add missing deprecated functions
tomschr Apr 21, 2020
4482f8c
Get rid of _compare_by_keys, adapt comparison operators
tomschr Apr 21, 2020
1c8fc74
Remove _to_dict() function
tomschr Apr 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
189 changes: 118 additions & 71 deletions semver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,29 +371,80 @@ def bump_build(self, token="build"):
build = cls._increment_string(self._build or (token or "build") + ".0")
return cls(self._major, self._minor, self._patch, self._prerelease, build)

def compare(self, other):
"""
Compare self with other.

:param other: the second version (can be string, a dict, tuple/list, or
a VersionInfo instance)
:return: The return value is negative if ver1 < ver2,
zero if ver1 == ver2 and strictly positive if ver1 > ver2
:rtype: int

>>> semver.VersionInfo.parse("1.0.0").compare("2.0.0")
-1
>>> semver.VersionInfo.parse("2.0.0").compare("1.0.0")
1
>>> semver.VersionInfo.parse("2.0.0").compare("2.0.0")
0
>>> semver.VersionInfo.parse("2.0.0").compare(dict(major=2, minor=0, patch=0))
0
"""
cls = type(self)
if isinstance(other, str):
other = cls.parse(other)
elif isinstance(other, dict):
other = cls(**other)
elif isinstance(other, (tuple, list)):
other = cls(*other)
elif not isinstance(other, cls):
raise TypeError(
"Expected str or {} instance, but got {}".format(
cls.__name__, type(other)
)
)

v1 = self.to_tuple()[:3]
v2 = other.to_tuple()[:3]
x = cmp(v1, v2)
if x:
return x

rc1, rc2 = self.prerelease, other.prerelease
rccmp = _nat_cmp(rc1, rc2)

if not rccmp:
return 0
if not rc1:
return 1
elif not rc2:
return -1

return rccmp

@comparator
def __eq__(self, other):
return _compare_by_keys(self.to_dict(), _to_dict(other)) == 0
return self.compare(other) == 0

@comparator
def __ne__(self, other):
return _compare_by_keys(self.to_dict(), _to_dict(other)) != 0
return self.compare(other) != 0

@comparator
def __lt__(self, other):
return _compare_by_keys(self.to_dict(), _to_dict(other)) < 0
return self.compare(other) < 0

@comparator
def __le__(self, other):
return _compare_by_keys(self.to_dict(), _to_dict(other)) <= 0
return self.compare(other) <= 0

@comparator
def __gt__(self, other):
return _compare_by_keys(self.to_dict(), _to_dict(other)) > 0
return self.compare(other) > 0

@comparator
def __ge__(self, other):
return _compare_by_keys(self.to_dict(), _to_dict(other)) >= 0
return self.compare(other) >= 0

def __repr__(self):
s = ", ".join("%s=%r" % (key, val) for key, val in self.to_dict().items())
Expand Down Expand Up @@ -424,6 +475,53 @@ def finalize_version(self):
cls = type(self)
return cls(self.major, self.minor, self.patch)

def match(self, match_expr):
"""
Compare self to match a match expression.

:param str match_expr: operator and version; valid operators are
< smaller than
> greater than
>= greator or equal than
<= smaller or equal than
== equal
!= not equal
:return: True if the expression matches the version, otherwise False
:rtype: bool

>>> semver.VersionInfo.parse("2.0.0").match(">=1.0.0")
True
>>> semver.VersionInfo.parse("1.0.0").match(">1.0.0")
False
"""
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:]
else:
raise ValueError(
"match_expr parameter should be in format <op><ver>, "
"where <op> is one of "
"['<', '>', '==', '<=', '>=', '!=']. "
"You provided: %r" % match_expr
)

possibilities_dict = {
">": (1,),
"<": (-1,),
"==": (0,),
"!=": (-1, 1),
">=": (0, 1),
"<=": (-1, 0),
}

possibilities = possibilities_dict[prefix]
cmp_res = self.compare(match_version)

return cmp_res in possibilities

@staticmethod
def parse(version):
"""
Expand Down Expand Up @@ -495,14 +593,6 @@ def isvalid(cls, version):
return False


def _to_dict(obj):
if isinstance(obj, VersionInfo):
return obj.to_dict()
elif isinstance(obj, tuple):
return VersionInfo(*obj).to_dict()
return obj


@deprecated(replace="semver.VersionInfo.parse", version="2.10.0")
def parse_version_info(version):
"""
Expand Down Expand Up @@ -560,25 +650,7 @@ def cmp_prerelease_tag(a, b):
return cmp(len(a), len(b))


def _compare_by_keys(d1, d2):
for key in ["major", "minor", "patch"]:
v = cmp(d1.get(key), d2.get(key))
if v:
return v

rc1, rc2 = d1.get("prerelease"), d2.get("prerelease")
rccmp = _nat_cmp(rc1, rc2)

if not rccmp:
return 0
if not rc1:
return 1
elif not rc2:
return -1

return rccmp


@deprecated(version="2.10.0")
def compare(ver1, ver2):
"""
Compare two versions strings.
Expand All @@ -596,13 +668,11 @@ def compare(ver1, ver2):
>>> semver.compare("2.0.0", "2.0.0")
0
"""

v1 = VersionInfo.parse(ver1).to_dict()
v2 = VersionInfo.parse(ver2).to_dict()

return _compare_by_keys(v1, v2)
v1 = VersionInfo.parse(ver1)
return v1.compare(ver2)


@deprecated(version="2.10.0")
def match(version, match_expr):
"""
Compare two versions strings through a comparison.
Expand All @@ -623,33 +693,8 @@ def match(version, match_expr):
>>> semver.match("1.0.0", ">1.0.0")
False
"""
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:]
else:
raise ValueError(
"match_expr parameter should be in format <op><ver>, "
"where <op> is one of "
"['<', '>', '==', '<=', '>=', '!=']. "
"You provided: %r" % match_expr
)

possibilities_dict = {
">": (1,),
"<": (-1,),
"==": (0,),
"!=": (-1, 1),
">=": (0, 1),
"<=": (-1, 0),
}

possibilities = possibilities_dict[prefix]
cmp_res = compare(version, match_version)

return cmp_res in possibilities
ver = VersionInfo.parse(version)
return ver.match(match_expr)


def max_ver(ver1, ver2):
Expand All @@ -664,9 +709,10 @@ def max_ver(ver1, ver2):
>>> semver.max_ver("1.0.0", "2.0.0")
'2.0.0'
"""
cmp_res = compare(ver1, ver2)
if cmp_res == 0 or cmp_res == 1:
return ver1
ver1 = VersionInfo.parse(ver1)
cmp_res = ver1.compare(ver2)
if cmp_res >= 0:
return str(ver1)
else:
return ver2

Expand All @@ -683,9 +729,10 @@ def min_ver(ver1, ver2):
>>> semver.min_ver("1.0.0", "2.0.0")
'1.0.0'
"""
cmp_res = compare(ver1, ver2)
if cmp_res == 0 or cmp_res == -1:
return ver1
ver1 = VersionInfo.parse(ver1)
cmp_res = ver1.compare(ver2)
if cmp_res <= 0:
return str(ver1)
else:
return ver2

Expand Down
2 changes: 2 additions & 0 deletions test_semver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -855,8 +855,10 @@ def test_should_versioninfo_isvalid():
(bump_minor, ("1.2.3",), {}),
(bump_patch, ("1.2.3",), {}),
(bump_prerelease, ("1.2.3",), {}),
(compare, ("1.2.1", "1.2.2"), {}),
(format_version, (3, 4, 5), {}),
(finalize_version, ("1.2.3-rc.5",), {}),
(match, ("1.0.0", ">=1.0.0"), {}),
(parse, ("1.2.3",), {}),
(parse_version_info, ("1.2.3",), {}),
(replace, ("1.2.3",), dict(major=2, patch=10)),
Expand Down