Skip to content

Ensure equal versions have equal hashes #283

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
Oct 20, 2020
Merged

Ensure equal versions have equal hashes #283

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
f0ce8c5
Ensure equal versions have equal hashes
sbrudenell Oct 15, 2020
3b2c27d
Apply suggestions from code review
tomschr Oct 20, 2020
d02ce16
Doc: Fix underline in header
tomschr Oct 20, 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
26 changes: 26 additions & 0 deletions docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,32 @@ functions that leverage this capability; builtins including, but not limited to:
(for examples, see :ref:`sec_max_min`) and :func:`sorted`.


Determining Version Equality
----------------------------

Version equality means for semver, that major, minor, patch, and prerelease
parts are equal in both versions you compare. The build part is ignored.
For example::

>>> v = semver.VersionInfo.parse("1.2.3-rc4+1e4664d")
>>> v == "1.2.3-rc4+dedbeef"
True

This also applies when a :class:`semver.VersionInfo` is a member of a set, or a
dictionary key::

>>> d = {}
>>> v1 = semver.VersionInfo.parse("1.2.3-rc4+1e4664d")
>>> v2 = semver.VersionInfo.parse("1.2.3-rc4+dedbeef")
>>> d[v1] = 1
>>> d[v2]
1
>>> s = set()
>>> s.add(v1)
>>> v2 in s
True



Comparing Versions through an Expression
----------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion semver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -575,7 +575,7 @@ def __str__(self):
return version

def __hash__(self):
return hash(self.to_tuple())
return hash(self.to_tuple()[:4])

def finalize_version(self):
"""
Expand Down
14 changes: 14 additions & 0 deletions test_semver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -679,6 +679,20 @@ def test_parse_version_info_str_hash():
d[v] = "" # to ensure that VersionInfo are hashable


def test_equal_versions_have_equal_hashes():
v1 = parse_version_info("1.2.3-alpha.1.2+build.11.e0f985a")
v2 = parse_version_info("1.2.3-alpha.1.2+build.22.a589f0e")
assert v1 == v2
assert hash(v1) == hash(v2)
d = {}
d[v1] = 1
d[v2] = 2
assert d[v1] == 2
s = set()
s.add(v1)
assert v2 in s


def test_parse_method_for_version_info():
s_version = "1.2.3-alpha.1.2+build.11.e0f985a"
v = VersionInfo.parse(s_version)
Expand Down