mirror of
https://github.com/zebrajr/pytorch.git
synced 2025-12-06 12:20:52 +01:00
5721205417
Summary: This PR adds greater equal comparison so that not the base class's (str) comparison method is used. This is necessary for a correct comparison with a version string. Previously the following was the case: ```py >>> torch.__version__ '1.10.0.dev20210830+cpu' >>> torch.__version__>"1.9" True >>> torch.__version__>="1.9" False # Wrong output since the base class (str) was used for __ge__ comparison ``` Pull Request resolved: https://github.com/pytorch/pytorch/pull/64565 Reviewed By: raghuramank100 Differential Revision: D30790463 Pulled By: mrshenli fbshipit-source-id: 79c680f8b448001b34d3e5d5332124a78bea4e34
78 lines
2.9 KiB
Python
78 lines
2.9 KiB
Python
from functools import total_ordering
|
|
from typing import Iterable, Union
|
|
|
|
from pkg_resources import packaging # type: ignore[attr-defined]
|
|
|
|
Version = packaging.version.Version
|
|
InvalidVersion = packaging.version.InvalidVersion
|
|
|
|
from .version import __version__ as internal_version
|
|
|
|
|
|
@total_ordering
|
|
class TorchVersion(str):
|
|
"""A string with magic powers to compare to both Version and iterables!
|
|
|
|
Prior to 1.10.0 torch.__version__ was stored as a str and so many did
|
|
comparisons against torch.__version__ as if it were a str. In order to not
|
|
break them we have TorchVersion which masquerades as a str while also
|
|
having the ability to compare against both packaging.version.Version as
|
|
well as tuples of values, eg. (1, 2, 1)
|
|
|
|
Examples:
|
|
Comparing a TorchVersion object to a Version object
|
|
TorchVersion('1.10.0a') > Version('1.10.0a')
|
|
|
|
Comparing a TorchVersion object to a Tuple object
|
|
TorchVersion('1.10.0a') > (1, 2) # 1.2
|
|
TorchVersion('1.10.0a') > (1, 2, 1) # 1.2.1
|
|
|
|
Comparing a TorchVersion object against a string
|
|
TorchVersion('1.10.0a') > '1.2'
|
|
TorchVersion('1.10.0a') > '1.2.1'
|
|
"""
|
|
# fully qualified type names here to appease mypy
|
|
def _convert_to_version(self, inp: Union[packaging.version.Version, str, Iterable]) -> packaging.version.Version:
|
|
if isinstance(inp, Version):
|
|
return inp
|
|
elif isinstance(inp, str):
|
|
return Version(inp)
|
|
elif isinstance(inp, Iterable):
|
|
# Ideally this should work for most cases by attempting to group
|
|
# the version tuple, assuming the tuple looks (MAJOR, MINOR, ?PATCH)
|
|
# Examples:
|
|
# * (1) -> Version("1")
|
|
# * (1, 20) -> Version("1.20")
|
|
# * (1, 20, 1) -> Version("1.20.1")
|
|
return Version('.'.join((str(item) for item in inp)))
|
|
else:
|
|
raise InvalidVersion(inp)
|
|
|
|
def __gt__(self, cmp):
|
|
try:
|
|
return Version(self).__gt__(self._convert_to_version(cmp))
|
|
except InvalidVersion:
|
|
# Fall back to regular string comparison if dealing with an invalid
|
|
# version like 'parrot'
|
|
return super().__gt__(cmp)
|
|
|
|
|
|
def __eq__(self, cmp):
|
|
try:
|
|
return Version(self).__eq__(self._convert_to_version(cmp))
|
|
except InvalidVersion:
|
|
# Fall back to regular string comparison if dealing with an invalid
|
|
# version like 'parrot'
|
|
return super().__eq__(cmp)
|
|
|
|
|
|
def __ge__(self, cmp):
|
|
try:
|
|
return Version(self).__ge__(self._convert_to_version(cmp))
|
|
except InvalidVersion:
|
|
# Fall back to regular string comparison if dealing with an invalid
|
|
# version like 'parrot'
|
|
return super().__ge__(cmp)
|
|
|
|
__version__ = TorchVersion(internal_version)
|