__init__.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579
  1. # Vendored from https://github.com/pypa/packaging/blob/main/packaging/_structures.py
  2. # and https://github.com/pypa/packaging/blob/main/packaging/_structures.py
  3. # changeset ae891fd74d6dd4c6063bb04f2faeadaac6fc6313
  4. # 04/30/2021
  5. # This file is dual licensed under the terms of the Apache License, Version
  6. # 2.0, and the BSD License. Licence at LICENSES/PACKAGING_LICENSE
  7. from __future__ import annotations
  8. import collections
  9. from collections.abc import Iterator
  10. import itertools
  11. import re
  12. from typing import (
  13. Callable,
  14. SupportsInt,
  15. Tuple,
  16. Union,
  17. )
  18. import warnings
  19. __all__ = ["parse", "Version", "LegacyVersion", "InvalidVersion", "VERSION_PATTERN"]
  20. class InfinityType:
  21. def __repr__(self) -> str:
  22. return "Infinity"
  23. def __hash__(self) -> int:
  24. return hash(repr(self))
  25. def __lt__(self, other: object) -> bool:
  26. return False
  27. def __le__(self, other: object) -> bool:
  28. return False
  29. def __eq__(self, other: object) -> bool:
  30. return isinstance(other, type(self))
  31. def __ne__(self, other: object) -> bool:
  32. return not isinstance(other, type(self))
  33. def __gt__(self, other: object) -> bool:
  34. return True
  35. def __ge__(self, other: object) -> bool:
  36. return True
  37. def __neg__(self: object) -> NegativeInfinityType:
  38. return NegativeInfinity
  39. Infinity = InfinityType()
  40. class NegativeInfinityType:
  41. def __repr__(self) -> str:
  42. return "-Infinity"
  43. def __hash__(self) -> int:
  44. return hash(repr(self))
  45. def __lt__(self, other: object) -> bool:
  46. return True
  47. def __le__(self, other: object) -> bool:
  48. return True
  49. def __eq__(self, other: object) -> bool:
  50. return isinstance(other, type(self))
  51. def __ne__(self, other: object) -> bool:
  52. return not isinstance(other, type(self))
  53. def __gt__(self, other: object) -> bool:
  54. return False
  55. def __ge__(self, other: object) -> bool:
  56. return False
  57. def __neg__(self: object) -> InfinityType:
  58. return Infinity
  59. NegativeInfinity = NegativeInfinityType()
  60. InfiniteTypes = Union[InfinityType, NegativeInfinityType]
  61. PrePostDevType = Union[InfiniteTypes, tuple[str, int]]
  62. SubLocalType = Union[InfiniteTypes, int, str]
  63. LocalType = Union[
  64. NegativeInfinityType,
  65. tuple[
  66. Union[
  67. SubLocalType,
  68. tuple[SubLocalType, str],
  69. tuple[NegativeInfinityType, SubLocalType],
  70. ],
  71. ...,
  72. ],
  73. ]
  74. CmpKey = tuple[
  75. int, tuple[int, ...], PrePostDevType, PrePostDevType, PrePostDevType, LocalType
  76. ]
  77. LegacyCmpKey = tuple[int, tuple[str, ...]]
  78. VersionComparisonMethod = Callable[
  79. [Union[CmpKey, LegacyCmpKey], Union[CmpKey, LegacyCmpKey]], bool
  80. ]
  81. _Version = collections.namedtuple(
  82. "_Version", ["epoch", "release", "dev", "pre", "post", "local"]
  83. )
  84. def parse(version: str) -> LegacyVersion | Version:
  85. """
  86. Parse the given version string and return either a :class:`Version` object
  87. or a :class:`LegacyVersion` object depending on if the given version is
  88. a valid PEP 440 version or a legacy version.
  89. """
  90. try:
  91. return Version(version)
  92. except InvalidVersion:
  93. return LegacyVersion(version)
  94. class InvalidVersion(ValueError):
  95. """
  96. An invalid version was found, users should refer to PEP 440.
  97. Examples
  98. --------
  99. >>> pd.util.version.Version('1.')
  100. Traceback (most recent call last):
  101. InvalidVersion: Invalid version: '1.'
  102. """
  103. class _BaseVersion:
  104. _key: CmpKey | LegacyCmpKey
  105. def __hash__(self) -> int:
  106. return hash(self._key)
  107. # Please keep the duplicated `isinstance` check
  108. # in the six comparisons hereunder
  109. # unless you find a way to avoid adding overhead function calls.
  110. def __lt__(self, other: _BaseVersion) -> bool:
  111. if not isinstance(other, _BaseVersion):
  112. return NotImplemented
  113. return self._key < other._key
  114. def __le__(self, other: _BaseVersion) -> bool:
  115. if not isinstance(other, _BaseVersion):
  116. return NotImplemented
  117. return self._key <= other._key
  118. def __eq__(self, other: object) -> bool:
  119. if not isinstance(other, _BaseVersion):
  120. return NotImplemented
  121. return self._key == other._key
  122. def __ge__(self, other: _BaseVersion) -> bool:
  123. if not isinstance(other, _BaseVersion):
  124. return NotImplemented
  125. return self._key >= other._key
  126. def __gt__(self, other: _BaseVersion) -> bool:
  127. if not isinstance(other, _BaseVersion):
  128. return NotImplemented
  129. return self._key > other._key
  130. def __ne__(self, other: object) -> bool:
  131. if not isinstance(other, _BaseVersion):
  132. return NotImplemented
  133. return self._key != other._key
  134. class LegacyVersion(_BaseVersion):
  135. def __init__(self, version: str) -> None:
  136. self._version = str(version)
  137. self._key = _legacy_cmpkey(self._version)
  138. warnings.warn(
  139. "Creating a LegacyVersion has been deprecated and will be "
  140. "removed in the next major release.",
  141. DeprecationWarning,
  142. )
  143. def __str__(self) -> str:
  144. return self._version
  145. def __repr__(self) -> str:
  146. return f"<LegacyVersion('{self}')>"
  147. @property
  148. def public(self) -> str:
  149. return self._version
  150. @property
  151. def base_version(self) -> str:
  152. return self._version
  153. @property
  154. def epoch(self) -> int:
  155. return -1
  156. @property
  157. def release(self) -> None:
  158. return None
  159. @property
  160. def pre(self) -> None:
  161. return None
  162. @property
  163. def post(self) -> None:
  164. return None
  165. @property
  166. def dev(self) -> None:
  167. return None
  168. @property
  169. def local(self) -> None:
  170. return None
  171. @property
  172. def is_prerelease(self) -> bool:
  173. return False
  174. @property
  175. def is_postrelease(self) -> bool:
  176. return False
  177. @property
  178. def is_devrelease(self) -> bool:
  179. return False
  180. _legacy_version_component_re = re.compile(r"(\d+ | [a-z]+ | \.| -)", re.VERBOSE)
  181. _legacy_version_replacement_map = {
  182. "pre": "c",
  183. "preview": "c",
  184. "-": "final-",
  185. "rc": "c",
  186. "dev": "@",
  187. }
  188. def _parse_version_parts(s: str) -> Iterator[str]:
  189. for part in _legacy_version_component_re.split(s):
  190. mapped_part = _legacy_version_replacement_map.get(part, part)
  191. if not mapped_part or mapped_part == ".":
  192. continue
  193. if mapped_part[:1] in "0123456789":
  194. # pad for numeric comparison
  195. yield mapped_part.zfill(8)
  196. else:
  197. yield "*" + mapped_part
  198. # ensure that alpha/beta/candidate are before final
  199. yield "*final"
  200. def _legacy_cmpkey(version: str) -> LegacyCmpKey:
  201. # We hardcode an epoch of -1 here. A PEP 440 version can only have a epoch
  202. # greater than or equal to 0. This will effectively put the LegacyVersion,
  203. # which uses the defacto standard originally implemented by setuptools,
  204. # as before all PEP 440 versions.
  205. epoch = -1
  206. # This scheme is taken from pkg_resources.parse_version setuptools prior to
  207. # it's adoption of the packaging library.
  208. parts: list[str] = []
  209. for part in _parse_version_parts(version.lower()):
  210. if part.startswith("*"):
  211. # remove "-" before a prerelease tag
  212. if part < "*final":
  213. while parts and parts[-1] == "*final-":
  214. parts.pop()
  215. # remove trailing zeros from each series of numeric parts
  216. while parts and parts[-1] == "00000000":
  217. parts.pop()
  218. parts.append(part)
  219. return epoch, tuple(parts)
  220. # Deliberately not anchored to the start and end of the string, to make it
  221. # easier for 3rd party code to reuse
  222. VERSION_PATTERN = r"""
  223. v?
  224. (?:
  225. (?:(?P<epoch>[0-9]+)!)? # epoch
  226. (?P<release>[0-9]+(?:\.[0-9]+)*) # release segment
  227. (?P<pre> # pre-release
  228. [-_\.]?
  229. (?P<pre_l>(a|b|c|rc|alpha|beta|pre|preview))
  230. [-_\.]?
  231. (?P<pre_n>[0-9]+)?
  232. )?
  233. (?P<post> # post release
  234. (?:-(?P<post_n1>[0-9]+))
  235. |
  236. (?:
  237. [-_\.]?
  238. (?P<post_l>post|rev|r)
  239. [-_\.]?
  240. (?P<post_n2>[0-9]+)?
  241. )
  242. )?
  243. (?P<dev> # dev release
  244. [-_\.]?
  245. (?P<dev_l>dev)
  246. [-_\.]?
  247. (?P<dev_n>[0-9]+)?
  248. )?
  249. )
  250. (?:\+(?P<local>[a-z0-9]+(?:[-_\.][a-z0-9]+)*))? # local version
  251. """
  252. class Version(_BaseVersion):
  253. _regex = re.compile(r"^\s*" + VERSION_PATTERN + r"\s*$", re.VERBOSE | re.IGNORECASE)
  254. def __init__(self, version: str) -> None:
  255. # Validate the version and parse it into pieces
  256. match = self._regex.search(version)
  257. if not match:
  258. raise InvalidVersion(f"Invalid version: '{version}'")
  259. # Store the parsed out pieces of the version
  260. self._version = _Version(
  261. epoch=int(match.group("epoch")) if match.group("epoch") else 0,
  262. release=tuple(int(i) for i in match.group("release").split(".")),
  263. pre=_parse_letter_version(match.group("pre_l"), match.group("pre_n")),
  264. post=_parse_letter_version(
  265. match.group("post_l"), match.group("post_n1") or match.group("post_n2")
  266. ),
  267. dev=_parse_letter_version(match.group("dev_l"), match.group("dev_n")),
  268. local=_parse_local_version(match.group("local")),
  269. )
  270. # Generate a key which will be used for sorting
  271. self._key = _cmpkey(
  272. self._version.epoch,
  273. self._version.release,
  274. self._version.pre,
  275. self._version.post,
  276. self._version.dev,
  277. self._version.local,
  278. )
  279. def __repr__(self) -> str:
  280. return f"<Version('{self}')>"
  281. def __str__(self) -> str:
  282. parts = []
  283. # Epoch
  284. if self.epoch != 0:
  285. parts.append(f"{self.epoch}!")
  286. # Release segment
  287. parts.append(".".join([str(x) for x in self.release]))
  288. # Pre-release
  289. if self.pre is not None:
  290. parts.append("".join([str(x) for x in self.pre]))
  291. # Post-release
  292. if self.post is not None:
  293. parts.append(f".post{self.post}")
  294. # Development release
  295. if self.dev is not None:
  296. parts.append(f".dev{self.dev}")
  297. # Local version segment
  298. if self.local is not None:
  299. parts.append(f"+{self.local}")
  300. return "".join(parts)
  301. @property
  302. def epoch(self) -> int:
  303. _epoch: int = self._version.epoch
  304. return _epoch
  305. @property
  306. def release(self) -> tuple[int, ...]:
  307. _release: tuple[int, ...] = self._version.release
  308. return _release
  309. @property
  310. def pre(self) -> tuple[str, int] | None:
  311. _pre: tuple[str, int] | None = self._version.pre
  312. return _pre
  313. @property
  314. def post(self) -> int | None:
  315. return self._version.post[1] if self._version.post else None
  316. @property
  317. def dev(self) -> int | None:
  318. return self._version.dev[1] if self._version.dev else None
  319. @property
  320. def local(self) -> str | None:
  321. if self._version.local:
  322. return ".".join([str(x) for x in self._version.local])
  323. else:
  324. return None
  325. @property
  326. def public(self) -> str:
  327. return str(self).split("+", 1)[0]
  328. @property
  329. def base_version(self) -> str:
  330. parts = []
  331. # Epoch
  332. if self.epoch != 0:
  333. parts.append(f"{self.epoch}!")
  334. # Release segment
  335. parts.append(".".join([str(x) for x in self.release]))
  336. return "".join(parts)
  337. @property
  338. def is_prerelease(self) -> bool:
  339. return self.dev is not None or self.pre is not None
  340. @property
  341. def is_postrelease(self) -> bool:
  342. return self.post is not None
  343. @property
  344. def is_devrelease(self) -> bool:
  345. return self.dev is not None
  346. @property
  347. def major(self) -> int:
  348. return self.release[0] if len(self.release) >= 1 else 0
  349. @property
  350. def minor(self) -> int:
  351. return self.release[1] if len(self.release) >= 2 else 0
  352. @property
  353. def micro(self) -> int:
  354. return self.release[2] if len(self.release) >= 3 else 0
  355. def _parse_letter_version(
  356. letter: str, number: str | bytes | SupportsInt
  357. ) -> tuple[str, int] | None:
  358. if letter:
  359. # We consider there to be an implicit 0 in a pre-release if there is
  360. # not a numeral associated with it.
  361. if number is None:
  362. number = 0
  363. # We normalize any letters to their lower case form
  364. letter = letter.lower()
  365. # We consider some words to be alternate spellings of other words and
  366. # in those cases we want to normalize the spellings to our preferred
  367. # spelling.
  368. if letter == "alpha":
  369. letter = "a"
  370. elif letter == "beta":
  371. letter = "b"
  372. elif letter in ["c", "pre", "preview"]:
  373. letter = "rc"
  374. elif letter in ["rev", "r"]:
  375. letter = "post"
  376. return letter, int(number)
  377. if not letter and number:
  378. # We assume if we are given a number, but we are not given a letter
  379. # then this is using the implicit post release syntax (e.g. 1.0-1)
  380. letter = "post"
  381. return letter, int(number)
  382. return None
  383. _local_version_separators = re.compile(r"[\._-]")
  384. def _parse_local_version(local: str) -> LocalType | None:
  385. """
  386. Takes a string like abc.1.twelve and turns it into ("abc", 1, "twelve").
  387. """
  388. if local is not None:
  389. return tuple(
  390. part.lower() if not part.isdigit() else int(part)
  391. for part in _local_version_separators.split(local)
  392. )
  393. return None
  394. def _cmpkey(
  395. epoch: int,
  396. release: tuple[int, ...],
  397. pre: tuple[str, int] | None,
  398. post: tuple[str, int] | None,
  399. dev: tuple[str, int] | None,
  400. local: tuple[SubLocalType] | None,
  401. ) -> CmpKey:
  402. # When we compare a release version, we want to compare it with all of the
  403. # trailing zeros removed. So we'll use a reverse the list, drop all the now
  404. # leading zeros until we come to something non zero, then take the rest
  405. # re-reverse it back into the correct order and make it a tuple and use
  406. # that for our sorting key.
  407. _release = tuple(
  408. reversed(list(itertools.dropwhile(lambda x: x == 0, reversed(release))))
  409. )
  410. # We need to "trick" the sorting algorithm to put 1.0.dev0 before 1.0a0.
  411. # We'll do this by abusing the pre segment, but we _only_ want to do this
  412. # if there is not a pre or a post segment. If we have one of those then
  413. # the normal sorting rules will handle this case correctly.
  414. if pre is None and post is None and dev is not None:
  415. _pre: PrePostDevType = NegativeInfinity
  416. # Versions without a pre-release (except as noted above) should sort after
  417. # those with one.
  418. elif pre is None:
  419. _pre = Infinity
  420. else:
  421. _pre = pre
  422. # Versions without a post segment should sort before those with one.
  423. if post is None:
  424. _post: PrePostDevType = NegativeInfinity
  425. else:
  426. _post = post
  427. # Versions without a development segment should sort after those with one.
  428. if dev is None:
  429. _dev: PrePostDevType = Infinity
  430. else:
  431. _dev = dev
  432. if local is None:
  433. # Versions without a local segment should sort before those with one.
  434. _local: LocalType = NegativeInfinity
  435. else:
  436. # Versions with a local segment need that segment parsed to implement
  437. # the sorting rules in PEP440.
  438. # - Alpha numeric segments sort before numeric segments
  439. # - Alpha numeric segments sort lexicographically
  440. # - Numeric segments sort numerically
  441. # - Shorter versions sort before longer versions when the prefixes
  442. # match exactly
  443. _local = tuple(
  444. (i, "") if isinstance(i, int) else (NegativeInfinity, i) for i in local
  445. )
  446. return epoch, _release, _pre, _post, _dev, _local