Development of an internal social media platform with personalised dashboards for students
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

version.py 11KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393
  1. # This file is dual licensed under the terms of the Apache License, Version
  2. # 2.0, and the BSD License. See the LICENSE file in the root of this repository
  3. # for complete details.
  4. from __future__ import absolute_import, division, print_function
  5. import collections
  6. import itertools
  7. import re
  8. from ._structures import Infinity
  9. __all__ = [
  10. "parse", "Version", "LegacyVersion", "InvalidVersion", "VERSION_PATTERN"
  11. ]
  12. _Version = collections.namedtuple(
  13. "_Version",
  14. ["epoch", "release", "dev", "pre", "post", "local"],
  15. )
  16. def parse(version):
  17. """
  18. Parse the given version string and return either a :class:`Version` object
  19. or a :class:`LegacyVersion` object depending on if the given version is
  20. a valid PEP 440 version or a legacy version.
  21. """
  22. try:
  23. return Version(version)
  24. except InvalidVersion:
  25. return LegacyVersion(version)
  26. class InvalidVersion(ValueError):
  27. """
  28. An invalid version was found, users should refer to PEP 440.
  29. """
  30. class _BaseVersion(object):
  31. def __hash__(self):
  32. return hash(self._key)
  33. def __lt__(self, other):
  34. return self._compare(other, lambda s, o: s < o)
  35. def __le__(self, other):
  36. return self._compare(other, lambda s, o: s <= o)
  37. def __eq__(self, other):
  38. return self._compare(other, lambda s, o: s == o)
  39. def __ge__(self, other):
  40. return self._compare(other, lambda s, o: s >= o)
  41. def __gt__(self, other):
  42. return self._compare(other, lambda s, o: s > o)
  43. def __ne__(self, other):
  44. return self._compare(other, lambda s, o: s != o)
  45. def _compare(self, other, method):
  46. if not isinstance(other, _BaseVersion):
  47. return NotImplemented
  48. return method(self._key, other._key)
  49. class LegacyVersion(_BaseVersion):
  50. def __init__(self, version):
  51. self._version = str(version)
  52. self._key = _legacy_cmpkey(self._version)
  53. def __str__(self):
  54. return self._version
  55. def __repr__(self):
  56. return "<LegacyVersion({0})>".format(repr(str(self)))
  57. @property
  58. def public(self):
  59. return self._version
  60. @property
  61. def base_version(self):
  62. return self._version
  63. @property
  64. def local(self):
  65. return None
  66. @property
  67. def is_prerelease(self):
  68. return False
  69. @property
  70. def is_postrelease(self):
  71. return False
  72. _legacy_version_component_re = re.compile(
  73. r"(\d+ | [a-z]+ | \.| -)", re.VERBOSE,
  74. )
  75. _legacy_version_replacement_map = {
  76. "pre": "c", "preview": "c", "-": "final-", "rc": "c", "dev": "@",
  77. }
  78. def _parse_version_parts(s):
  79. for part in _legacy_version_component_re.split(s):
  80. part = _legacy_version_replacement_map.get(part, part)
  81. if not part or part == ".":
  82. continue
  83. if part[:1] in "0123456789":
  84. # pad for numeric comparison
  85. yield part.zfill(8)
  86. else:
  87. yield "*" + part
  88. # ensure that alpha/beta/candidate are before final
  89. yield "*final"
  90. def _legacy_cmpkey(version):
  91. # We hardcode an epoch of -1 here. A PEP 440 version can only have a epoch
  92. # greater than or equal to 0. This will effectively put the LegacyVersion,
  93. # which uses the defacto standard originally implemented by setuptools,
  94. # as before all PEP 440 versions.
  95. epoch = -1
  96. # This scheme is taken from pkg_resources.parse_version setuptools prior to
  97. # it's adoption of the packaging library.
  98. parts = []
  99. for part in _parse_version_parts(version.lower()):
  100. if part.startswith("*"):
  101. # remove "-" before a prerelease tag
  102. if part < "*final":
  103. while parts and parts[-1] == "*final-":
  104. parts.pop()
  105. # remove trailing zeros from each series of numeric parts
  106. while parts and parts[-1] == "00000000":
  107. parts.pop()
  108. parts.append(part)
  109. parts = tuple(parts)
  110. return epoch, parts
  111. # Deliberately not anchored to the start and end of the string, to make it
  112. # easier for 3rd party code to reuse
  113. VERSION_PATTERN = r"""
  114. v?
  115. (?:
  116. (?:(?P<epoch>[0-9]+)!)? # epoch
  117. (?P<release>[0-9]+(?:\.[0-9]+)*) # release segment
  118. (?P<pre> # pre-release
  119. [-_\.]?
  120. (?P<pre_l>(a|b|c|rc|alpha|beta|pre|preview))
  121. [-_\.]?
  122. (?P<pre_n>[0-9]+)?
  123. )?
  124. (?P<post> # post release
  125. (?:-(?P<post_n1>[0-9]+))
  126. |
  127. (?:
  128. [-_\.]?
  129. (?P<post_l>post|rev|r)
  130. [-_\.]?
  131. (?P<post_n2>[0-9]+)?
  132. )
  133. )?
  134. (?P<dev> # dev release
  135. [-_\.]?
  136. (?P<dev_l>dev)
  137. [-_\.]?
  138. (?P<dev_n>[0-9]+)?
  139. )?
  140. )
  141. (?:\+(?P<local>[a-z0-9]+(?:[-_\.][a-z0-9]+)*))? # local version
  142. """
  143. class Version(_BaseVersion):
  144. _regex = re.compile(
  145. r"^\s*" + VERSION_PATTERN + r"\s*$",
  146. re.VERBOSE | re.IGNORECASE,
  147. )
  148. def __init__(self, version):
  149. # Validate the version and parse it into pieces
  150. match = self._regex.search(version)
  151. if not match:
  152. raise InvalidVersion("Invalid version: '{0}'".format(version))
  153. # Store the parsed out pieces of the version
  154. self._version = _Version(
  155. epoch=int(match.group("epoch")) if match.group("epoch") else 0,
  156. release=tuple(int(i) for i in match.group("release").split(".")),
  157. pre=_parse_letter_version(
  158. match.group("pre_l"),
  159. match.group("pre_n"),
  160. ),
  161. post=_parse_letter_version(
  162. match.group("post_l"),
  163. match.group("post_n1") or match.group("post_n2"),
  164. ),
  165. dev=_parse_letter_version(
  166. match.group("dev_l"),
  167. match.group("dev_n"),
  168. ),
  169. local=_parse_local_version(match.group("local")),
  170. )
  171. # Generate a key which will be used for sorting
  172. self._key = _cmpkey(
  173. self._version.epoch,
  174. self._version.release,
  175. self._version.pre,
  176. self._version.post,
  177. self._version.dev,
  178. self._version.local,
  179. )
  180. def __repr__(self):
  181. return "<Version({0})>".format(repr(str(self)))
  182. def __str__(self):
  183. parts = []
  184. # Epoch
  185. if self._version.epoch != 0:
  186. parts.append("{0}!".format(self._version.epoch))
  187. # Release segment
  188. parts.append(".".join(str(x) for x in self._version.release))
  189. # Pre-release
  190. if self._version.pre is not None:
  191. parts.append("".join(str(x) for x in self._version.pre))
  192. # Post-release
  193. if self._version.post is not None:
  194. parts.append(".post{0}".format(self._version.post[1]))
  195. # Development release
  196. if self._version.dev is not None:
  197. parts.append(".dev{0}".format(self._version.dev[1]))
  198. # Local version segment
  199. if self._version.local is not None:
  200. parts.append(
  201. "+{0}".format(".".join(str(x) for x in self._version.local))
  202. )
  203. return "".join(parts)
  204. @property
  205. def public(self):
  206. return str(self).split("+", 1)[0]
  207. @property
  208. def base_version(self):
  209. parts = []
  210. # Epoch
  211. if self._version.epoch != 0:
  212. parts.append("{0}!".format(self._version.epoch))
  213. # Release segment
  214. parts.append(".".join(str(x) for x in self._version.release))
  215. return "".join(parts)
  216. @property
  217. def local(self):
  218. version_string = str(self)
  219. if "+" in version_string:
  220. return version_string.split("+", 1)[1]
  221. @property
  222. def is_prerelease(self):
  223. return bool(self._version.dev or self._version.pre)
  224. @property
  225. def is_postrelease(self):
  226. return bool(self._version.post)
  227. def _parse_letter_version(letter, number):
  228. if letter:
  229. # We consider there to be an implicit 0 in a pre-release if there is
  230. # not a numeral associated with it.
  231. if number is None:
  232. number = 0
  233. # We normalize any letters to their lower case form
  234. letter = letter.lower()
  235. # We consider some words to be alternate spellings of other words and
  236. # in those cases we want to normalize the spellings to our preferred
  237. # spelling.
  238. if letter == "alpha":
  239. letter = "a"
  240. elif letter == "beta":
  241. letter = "b"
  242. elif letter in ["c", "pre", "preview"]:
  243. letter = "rc"
  244. elif letter in ["rev", "r"]:
  245. letter = "post"
  246. return letter, int(number)
  247. if not letter and number:
  248. # We assume if we are given a number, but we are not given a letter
  249. # then this is using the implicit post release syntax (e.g. 1.0-1)
  250. letter = "post"
  251. return letter, int(number)
  252. _local_version_seperators = re.compile(r"[\._-]")
  253. def _parse_local_version(local):
  254. """
  255. Takes a string like abc.1.twelve and turns it into ("abc", 1, "twelve").
  256. """
  257. if local is not None:
  258. return tuple(
  259. part.lower() if not part.isdigit() else int(part)
  260. for part in _local_version_seperators.split(local)
  261. )
  262. def _cmpkey(epoch, release, pre, post, dev, local):
  263. # When we compare a release version, we want to compare it with all of the
  264. # trailing zeros removed. So we'll use a reverse the list, drop all the now
  265. # leading zeros until we come to something non zero, then take the rest
  266. # re-reverse it back into the correct order and make it a tuple and use
  267. # that for our sorting key.
  268. release = tuple(
  269. reversed(list(
  270. itertools.dropwhile(
  271. lambda x: x == 0,
  272. reversed(release),
  273. )
  274. ))
  275. )
  276. # We need to "trick" the sorting algorithm to put 1.0.dev0 before 1.0a0.
  277. # We'll do this by abusing the pre segment, but we _only_ want to do this
  278. # if there is not a pre or a post segment. If we have one of those then
  279. # the normal sorting rules will handle this case correctly.
  280. if pre is None and post is None and dev is not None:
  281. pre = -Infinity
  282. # Versions without a pre-release (except as noted above) should sort after
  283. # those with one.
  284. elif pre is None:
  285. pre = Infinity
  286. # Versions without a post segment should sort before those with one.
  287. if post is None:
  288. post = -Infinity
  289. # Versions without a development segment should sort after those with one.
  290. if dev is None:
  291. dev = Infinity
  292. if local is None:
  293. # Versions without a local segment should sort before those with one.
  294. local = -Infinity
  295. else:
  296. # Versions with a local segment need that segment parsed to implement
  297. # the sorting rules in PEP440.
  298. # - Alpha numeric segments sort before numeric segments
  299. # - Alpha numeric segments sort lexicographically
  300. # - Numeric segments sort numerically
  301. # - Shorter versions sort before longer versions when the prefixes
  302. # match exactly
  303. local = tuple(
  304. (i, "") if isinstance(i, int) else (-Infinity, i)
  305. for i in local
  306. )
  307. return epoch, release, pre, post, dev, local