Skip to content
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

Jump to bottom

Fix comparison #104

Closed
wants to merge 3 commits into from
Closed

Fix comparison #104

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
419a482
Fix comparison
scls19fr Jul 17, 2018
b300d97
return NotImplemented instead of raising exception NotImplementedError
scls19fr Jul 17, 2018
56da886
Fix for Python 2
scls19fr Jul 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ Python SemVer library
All notable changes to this code base will be documented in this file,
in every released version.

Version 2.8.x
=============
:Released: 20yy-mm-dd
:Maintainer: Sébastien Celles <s.celles@gmail.com>

* Issue #102 (PR #...). Fix comparison between VersionInfo and tuple
* Issue #103 (PR #...). Disallow comparison between VersionInfo and string (and int)

Version 2.8.1
=============
:Released: 2018-07-09
Expand Down
56 changes: 42 additions & 14 deletions semver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@

import collections
import re
import sys

PY2 = sys.version_info[0] == 2

__version__ = '2.8.1'

__version__ = '2.8.2'
__author__ = 'Kostiantyn Rybnikov'
__author_email__ = 'k-bx@k-bx.com'
__maintainer__ = 'Sebastien Celles'
Expand Down Expand Up @@ -84,7 +87,7 @@ class VersionInfo(object):
"""
__slots__ = ('_major', '_minor', '_patch', '_prerelease', '_build')

def __init__(self, major, minor, patch, prerelease=None, build=None):
def __init__(self, major, minor=0, patch=0, prerelease=None, build=None):
self._major = major
self._minor = minor
self._patch = patch
Expand Down Expand Up @@ -125,33 +128,51 @@ def _asdict(self):
))

def __eq__(self, other):
if not isinstance(other, (VersionInfo, dict)):
return NotImplemented
if not _is_comparable(other):
if PY2:
raise TypeError
else:
return NotImplemented
return _compare_by_keys(self._asdict(), _to_dict(other)) == 0

def __ne__(self, other):
if not isinstance(other, (VersionInfo, dict)):
return NotImplemented
if not _is_comparable(other):
if PY2:
raise TypeError
else:
return NotImplemented
return _compare_by_keys(self._asdict(), _to_dict(other)) != 0

def __lt__(self, other):
if not isinstance(other, (VersionInfo, dict)):
return NotImplemented
if not _is_comparable(other):
if PY2:
raise TypeError
else:
return NotImplemented
return _compare_by_keys(self._asdict(), _to_dict(other)) < 0

def __le__(self, other):
if not isinstance(other, (VersionInfo, dict)):
return NotImplemented
if not _is_comparable(other):
if PY2:
raise TypeError
else:
return NotImplemented
return _compare_by_keys(self._asdict(), _to_dict(other)) <= 0

def __gt__(self, other):
if not isinstance(other, (VersionInfo, dict)):
return NotImplemented
if not _is_comparable(other):
if PY2:
raise TypeError
else:
return NotImplemented
return _compare_by_keys(self._asdict(), _to_dict(other)) > 0

def __ge__(self, other):
if not isinstance(other, (VersionInfo, dict)):
return NotImplemented
if not _is_comparable(other):
if PY2:
raise TypeError
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, but why? NotImplemented existed for Python 2.x as well and there rules are the same for it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See previous build https://travis-ci.org/k-bx/python-semver/builds/404887965?utm_source=github_status&utm_medium=notification for Python 2.7 (see job)

even if NotImplemented existed for Python 2.x returning it doesn't raise TypeError (contrary to Python 3.x) and comparison wasn't returning a correct result.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, NotImplemented in Py2.7 works in the same way: https://docs.python.org/2.7/library/constants.html#NotImplemented

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, Python 2.x swallows them and returns always True or False...or False in our case.

Copy link
Contributor

@kxepal kxepal Jul 17, 2018 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think, it would be better to move that check and behaviour difference into tests.

While it's good idea to keep same behaviour in both Pythons, Python 2.x world tells that every comparison ends with boolean result, so we would looks here like a rule breaker.

Raising TypeError for Python 2.x also breaks NotImplemented behavior when if a.__eq__(b) fails, Python tries to do b.__eq__(a) - by raising exception we drops the second and our behaviour in both Pythons still remains inconsistent.

else:
return NotImplemented
return _compare_by_keys(self._asdict(), _to_dict(other)) >= 0

def __repr__(self):
Expand Down Expand Up @@ -184,6 +205,8 @@ def parse(version):
def _to_dict(obj):
if isinstance(obj, VersionInfo):
return obj._asdict()
elif isinstance(obj, tuple):
return VersionInfo(*obj)._asdict()
return obj


Expand Down Expand Up @@ -261,6 +284,11 @@ def _compare_by_keys(d1, d2):
return rccmp


def _is_comparable(other):
comparable_types = (VersionInfo, dict, tuple)
return isinstance(other, comparable_types)


def compare(ver1, ver2):
"""Compare two versions

Expand Down
24 changes: 24 additions & 0 deletions test_semver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,30 @@ def test_should_compare_version_dictionaries():
assert not(v1 == v4)


def test_should_compare_version_tuples():
v1 = VersionInfo(major=3, minor=4, patch=5,
prerelease='pre.2', build='build.4')
assert v1 > (1, 0, 0)
assert v1 > (1, 0)
assert v1 > (1,)
assert v1 > (1, 0, 0, 'pre.2')
assert v1 > (1, 0, 0, 'pre.2', 'build.4')


def test_should_not_allow_to_compare_version_with_string():
v1 = VersionInfo(major=3, minor=4, patch=5,
prerelease='pre.2', build='build.4')
with pytest.raises(TypeError) as e_info: # noqa
v1 > "1.0.0"


def test_should_not_allow_to_compare_version_with_int():
v1 = VersionInfo(major=3, minor=4, patch=5,
prerelease='pre.2', build='build.4')
with pytest.raises(TypeError) as e_info: # noqa
v1 > 1


def test_should_compare_prerelease_with_numbers_and_letters():
v1 = VersionInfo(major=1, minor=9, patch=1, prerelease='1unms', build=None)
v2 = VersionInfo(major=1, minor=9, patch=1, prerelease=None, build='1asd')
Expand Down