1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
|
# Copyright (c) 2021 Ultimaker B.V.
# Uranium is released under the terms of the LGPLv3 or higher.
import re # To replace parts of version strings with regex.
from typing import cast, Union, List
from UM.Logger import Logger
class Version:
"""Represents a version number, like "3.2.8" and allows comparison of those
numbers.
"""
def __init__(self, version: Union[str, bytes, int, "Version", List[Union[int, str, bytes]]]) -> None:
"""Constructs the version instance from a string representing the version.
The string representation may have dashes or underscores that separate
the major, minor and revision version numbers. All text is ignored.
:param version: A string or bytes representing a version number.
"""
super().__init__()
if type(version) == bytes:
version = cast(bytes, version)
version = version.decode("utf-8")
if isinstance(version, str):
version = cast(str, version)
# Versions are in (MOD-)x.x.x(-POSTFIX.x) format.
version = version.replace("MOD-", "")
version = version.replace("-", ".")
version = version.replace("_", ".")
version = version.replace("\"", "")
version_list = version.split(".") # type: ignore
# Only the third element (the postfix_type) is allowed to be a string. In other cases all non numeric
# characters need to be filtered out
try:
version_list[0] = re.sub(r"[A-Z]+", "", version_list[0])
version_list[1] = re.sub(r"[A-Z]+", "", version_list[1])
version_list[2] = re.sub(r"[A-Z]+", "", version_list[2])
version_list[4] = re.sub(r"[A-Z]+", "", version_list[4])
except IndexError:
pass
elif isinstance(version, list):
version_list = version # type: ignore
elif isinstance(version, int):
version_list = [version] # type: ignore
elif isinstance(version, Version):
version_list = [version.getMajor(), version.getMinor(), version.getRevision(), version.getPostfixType(), version.getPostfixVersion()] # type: ignore
else:
Logger.log("w", "Unable to convert version %s of type %s into a usable version", version, type(version))
version_list = []
self._major = 0
self._minor = 0
self._revision = 0
self._postfix_type = ""
self._postfix_version = 0
try:
self._major = int(version_list[0])
self._minor = int(version_list[1])
self._revision = int(version_list[2])
self._postfix_type = version_list[3]
self._postfix_version = int(version_list[4])
except IndexError:
pass
except ValueError:
pass
def getMajor(self) -> int:
"""Gets the major version number.
The major version number is the first number of the version: "3" in the
version "3.2.8".
"""
return self._major
def getMinor(self) -> int:
"""Gets the minor version number.
The minor version number is the second number of the version: "2" in the
version "3.2.8".
"""
return self._minor
def getRevision(self) -> int:
"""Gets the revision or patch version number.
The revision version number is the third number of the version: "8" in
the version "3.2.8".
"""
return self._revision
def getPostfixType(self) -> str:
"""Gets the postfix type.
The postfix type is the name of the postfix, e.g. "alpha" in the version "1.2.3-alpha.4"
"""
return self._postfix_type
def getPostfixVersion(self) -> int:
"""Gets the postfix version number.
The postfix version is the last number, e.g. "4" in the version "1.2.3-alpha.4"
"""
return self._postfix_version
def getWithoutPostfix(self) -> "Version":
"""Returns this as _only_ a major.minor.revision, without the postfix type/version.
The postfix is everything beyond the patch, like '-beta+1' in 5.0.0-beta+1 -- in this example 5.0.0 is returned.
"""
return Version([self._major, self._minor, self._revision])
def hasPostFix(self) -> bool:
"""Check if a version has a postfix."""
return self._postfix_type != ""
def __gt__(self, other: Union["Version", str]) -> bool:
"""Indicates whether this version is later than the specified version.
Implements the > operator.
:param other: Either another version object or a string representing one.
"""
if isinstance(other, Version):
return other.__lt__(self)
elif isinstance(other, str):
return Version(other).__lt__(self)
else:
return False
def __lt__(self, other: Union["Version", str]) -> bool:
"""Indicates whether this version is earlier than the specified version.
Implements the < operator.
:param other: Either another version object or a string representing one.
"""
if isinstance(other, Version):
if self._major < other.getMajor():
# The major version is lower.
return True
if self._minor < other.getMinor() \
and self._major == other.getMajor():
# The minor version is lower.
return True
if self._revision < other.getRevision() \
and self._major == other.getMajor() \
and self._minor == other.getMinor():
# The revision version is lower.
return True
if self.hasPostFix() and other.hasPostFix() \
and self._postfix_version < other.getPostfixVersion() \
and self._postfix_type == other.getPostfixType() \
and self._revision == other.getRevision() \
and self._major == other.getMajor() \
and self._minor == other.getMinor():
# The postfix version is lower. This is only allowed if the postfix type is the same!
return True
if self.hasPostFix() and not other.hasPostFix():
# If the root version is the same but the other has no postfix, we consider the other larger.
# E.g. Version("1.0.0") > Version("1.0.0-alpha.7")
return Version("{}.{}.{}".format(
self.getMajor(),
self.getMinor(),
self.getRevision()
)) == other
return False
elif isinstance(other, str):
return self < Version(other)
else:
return False
def __eq__(self, other: object) -> bool:
"""Indicates whether this version is equal to the specified version.
Implements the == operator.
:param other: Either another version object or a string representing one.
"""
if isinstance(other, Version):
# Direct comparison with same type.
return self._major == other.getMajor() \
and self._minor == other.getMinor() \
and self._revision == other.getRevision() \
and self._postfix_type == other.getPostfixType() \
and self._postfix_version == other.getPostfixVersion()
if isinstance(other, str):
# Comparison with string by converting to Version first.
return self == Version(other)
return False
def __ge__(self, other: Union["Version", str]) -> bool:
"""Indicates whether this version is later or equal to the specified
version.
Implements the >= operator.
:param other: Either another version object or a string representing one.
"""
return self.__gt__(other) or self.__eq__(other)
def __le__(self, other: Union["Version", str]) -> bool:
"""Indicates whether this version is earlier or equal to the specified
version.
Implements the <= operator.
:param other: Either another version object or a string representing one.
"""
return self.__lt__(other) or self.__eq__(other)
def __str__(self) -> str:
"""Returns a string representation containing the major, minor and revision
number.
Such as "3.2.8".
"""
if self._postfix_type:
# If we have a postfix, return a string including that postfix.
return "%s.%s.%s-%s.%s"\
% (self._major, self._minor, self._revision, self._postfix_type, self._postfix_version)
return "%s.%s.%s" % (self._major, self._minor, self._revision)
def __hash__(self) -> int:
"""Returns a number reasonably representing the identity of the version."""
return hash(self.__str__())
|