version.py 37 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231
  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. """
  5. .. testsetup::
  6. from packaging.version import parse, normalize_pre, Version, _cmpkey
  7. """
  8. from __future__ import annotations
  9. import re
  10. import sys
  11. import typing
  12. from typing import (
  13. Any,
  14. Callable,
  15. Literal,
  16. NamedTuple,
  17. SupportsInt,
  18. Tuple,
  19. TypedDict,
  20. Union,
  21. )
  22. if typing.TYPE_CHECKING:
  23. from typing_extensions import Self, Unpack
  24. if sys.version_info >= (3, 13): # pragma: no cover
  25. from warnings import deprecated as _deprecated
  26. elif typing.TYPE_CHECKING:
  27. from typing_extensions import deprecated as _deprecated
  28. else: # pragma: no cover
  29. import functools
  30. import warnings
  31. def _deprecated(message: str) -> object:
  32. def decorator(func: Callable[[...], object]) -> object:
  33. @functools.wraps(func)
  34. def wrapper(*args: object, **kwargs: object) -> object:
  35. warnings.warn(
  36. message,
  37. category=DeprecationWarning,
  38. stacklevel=2,
  39. )
  40. return func(*args, **kwargs)
  41. return wrapper
  42. return decorator
  43. _LETTER_NORMALIZATION = {
  44. "alpha": "a",
  45. "beta": "b",
  46. "c": "rc",
  47. "pre": "rc",
  48. "preview": "rc",
  49. "rev": "post",
  50. "r": "post",
  51. }
  52. __all__ = ["VERSION_PATTERN", "InvalidVersion", "Version", "normalize_pre", "parse"]
  53. def __dir__() -> list[str]:
  54. return __all__
  55. LocalType = Tuple[Union[int, str], ...]
  56. CmpLocalType = Tuple[Tuple[int, str], ...]
  57. CmpSuffix = Tuple[int, int, int, int, int, int]
  58. CmpKey = Union[
  59. Tuple[int, Tuple[int, ...], CmpSuffix],
  60. Tuple[int, Tuple[int, ...], CmpSuffix, CmpLocalType],
  61. ]
  62. VersionComparisonMethod = Callable[[CmpKey, CmpKey], bool]
  63. class _VersionReplace(TypedDict, total=False):
  64. epoch: int | None
  65. release: tuple[int, ...] | None
  66. pre: tuple[str, int] | None
  67. post: int | None
  68. dev: int | None
  69. local: str | None
  70. def normalize_pre(letter: str, /) -> str:
  71. """Normalize the pre-release segment of a version string.
  72. Returns a lowercase version of the string if not a known pre-release
  73. identifier.
  74. >>> normalize_pre('alpha')
  75. 'a'
  76. >>> normalize_pre('BETA')
  77. 'b'
  78. >>> normalize_pre('rc')
  79. 'rc'
  80. :param letter:
  81. .. versionadded:: 26.1
  82. """
  83. letter = letter.lower()
  84. return _LETTER_NORMALIZATION.get(letter, letter)
  85. def parse(version: str) -> Version:
  86. """Parse the given version string.
  87. This is identical to the :class:`Version` constructor.
  88. >>> parse('1.0.dev1')
  89. <Version('1.0.dev1')>
  90. :param version: The version string to parse.
  91. :raises InvalidVersion: When the version string is not a valid version.
  92. """
  93. return Version(version)
  94. class InvalidVersion(ValueError):
  95. """Raised when a version string is not a valid version.
  96. >>> Version("invalid")
  97. Traceback (most recent call last):
  98. ...
  99. packaging.version.InvalidVersion: Invalid version: 'invalid'
  100. """
  101. class _BaseVersion:
  102. __slots__ = ()
  103. # This can also be a normal member (see the packaging_legacy package);
  104. # we are just requiring it to be readable. Actually defining a property
  105. # has runtime effect on subclasses, so it's typing only.
  106. if typing.TYPE_CHECKING:
  107. @property
  108. def _key(self) -> tuple[Any, ...]: ...
  109. def __hash__(self) -> int:
  110. return hash(self._key)
  111. # Please keep the duplicated `isinstance` check
  112. # in the six comparisons hereunder
  113. # unless you find a way to avoid adding overhead function calls.
  114. def __lt__(self, other: _BaseVersion) -> bool:
  115. if not isinstance(other, _BaseVersion):
  116. return NotImplemented
  117. return self._key < other._key
  118. def __le__(self, other: _BaseVersion) -> bool:
  119. if not isinstance(other, _BaseVersion):
  120. return NotImplemented
  121. return self._key <= other._key
  122. def __eq__(self, other: object) -> bool:
  123. if not isinstance(other, _BaseVersion):
  124. return NotImplemented
  125. return self._key == other._key
  126. def __ge__(self, other: _BaseVersion) -> bool:
  127. if not isinstance(other, _BaseVersion):
  128. return NotImplemented
  129. return self._key >= other._key
  130. def __gt__(self, other: _BaseVersion) -> bool:
  131. if not isinstance(other, _BaseVersion):
  132. return NotImplemented
  133. return self._key > other._key
  134. def __ne__(self, other: object) -> bool:
  135. if not isinstance(other, _BaseVersion):
  136. return NotImplemented
  137. return self._key != other._key
  138. # Deliberately not anchored to the start and end of the string, to make it
  139. # easier for 3rd party code to reuse
  140. # Note that ++ doesn't behave identically on CPython and PyPy, so not using it here
  141. _VERSION_PATTERN = r"""
  142. v?+ # optional leading v
  143. (?a:
  144. (?:(?P<epoch>[0-9]+)!)?+ # epoch
  145. (?P<release>[0-9]+(?:\.[0-9]+)*+) # release segment
  146. (?P<pre> # pre-release
  147. [._-]?+
  148. (?P<pre_l>alpha|a|beta|b|preview|pre|c|rc)
  149. [._-]?+
  150. (?P<pre_n>[0-9]+)?
  151. )?+
  152. (?P<post> # post release
  153. (?:-(?P<post_n1>[0-9]+))
  154. |
  155. (?:
  156. [._-]?
  157. (?P<post_l>post|rev|r)
  158. [._-]?
  159. (?P<post_n2>[0-9]+)?
  160. )
  161. )?+
  162. (?P<dev> # dev release
  163. [._-]?+
  164. (?P<dev_l>dev)
  165. [._-]?+
  166. (?P<dev_n>[0-9]+)?
  167. )?+
  168. )
  169. (?a:\+
  170. (?P<local> # local version
  171. [a-z0-9]+
  172. (?:[._-][a-z0-9]+)*+
  173. )
  174. )?+
  175. """
  176. _VERSION_PATTERN_OLD = _VERSION_PATTERN.replace("*+", "*").replace("?+", "?")
  177. # Possessive qualifiers were added in Python 3.11.
  178. # CPython 3.11.0-3.11.4 had a bug: https://github.com/python/cpython/pull/107795
  179. # Older PyPy also had a bug.
  180. VERSION_PATTERN = (
  181. _VERSION_PATTERN_OLD
  182. if (sys.implementation.name == "cpython" and sys.version_info < (3, 11, 5))
  183. or (sys.implementation.name == "pypy" and sys.version_info < (3, 11, 13))
  184. or sys.version_info < (3, 11)
  185. else _VERSION_PATTERN
  186. )
  187. """
  188. A string containing the regular expression used to match a valid version.
  189. The pattern is not anchored at either end, and is intended for embedding in larger
  190. expressions (for example, matching a version number as part of a file name). The
  191. regular expression should be compiled with the ``re.VERBOSE`` and ``re.IGNORECASE``
  192. flags set.
  193. .. versionchanged:: 26.0
  194. The regex now uses possessive qualifiers on Python 3.11 if they are
  195. supported (CPython 3.11.5+, PyPy 3.11.13+).
  196. :meta hide-value:
  197. """
  198. # Validation pattern for local version in replace()
  199. _LOCAL_PATTERN = re.compile(r"[a-z0-9]+(?:[._-][a-z0-9]+)*", re.IGNORECASE | re.ASCII)
  200. # Fast path: If a version has only digits and dots then we
  201. # can skip the regex and parse it as a release segment
  202. _SIMPLE_VERSION_INDICATORS = frozenset(".0123456789")
  203. def _validate_epoch(value: object, /) -> int:
  204. epoch = value or 0
  205. if isinstance(epoch, int) and epoch >= 0:
  206. return epoch
  207. msg = f"epoch must be non-negative integer, got {epoch}"
  208. raise InvalidVersion(msg)
  209. def _validate_release(value: object, /) -> tuple[int, ...]:
  210. release = (0,) if value is None else value
  211. if (
  212. isinstance(release, tuple)
  213. and len(release) > 0
  214. and all(isinstance(i, int) and i >= 0 for i in release)
  215. ):
  216. return release
  217. msg = f"release must be a non-empty tuple of non-negative integers, got {release}"
  218. raise InvalidVersion(msg)
  219. def _validate_pre(value: object, /) -> tuple[Literal["a", "b", "rc"], int] | None:
  220. if value is None:
  221. return value
  222. if isinstance(value, tuple) and len(value) == 2:
  223. letter, number = value
  224. letter = normalize_pre(letter)
  225. if letter in {"a", "b", "rc"} and isinstance(number, int) and number >= 0:
  226. # type checkers can't infer the Literal type here on letter
  227. return (letter, number) # type: ignore[return-value]
  228. msg = f"pre must be a tuple of ('a'|'b'|'rc', non-negative int), got {value}"
  229. raise InvalidVersion(msg)
  230. def _validate_post(value: object, /) -> tuple[Literal["post"], int] | None:
  231. if value is None:
  232. return value
  233. if isinstance(value, int) and value >= 0:
  234. return ("post", value)
  235. msg = f"post must be non-negative integer, got {value}"
  236. raise InvalidVersion(msg)
  237. def _validate_dev(value: object, /) -> tuple[Literal["dev"], int] | None:
  238. if value is None:
  239. return value
  240. if isinstance(value, int) and value >= 0:
  241. return ("dev", value)
  242. msg = f"dev must be non-negative integer, got {value}"
  243. raise InvalidVersion(msg)
  244. def _validate_local(value: object, /) -> LocalType | None:
  245. if value is None:
  246. return value
  247. if isinstance(value, str) and _LOCAL_PATTERN.fullmatch(value):
  248. return _parse_local_version(value)
  249. msg = f"local must be a valid version string, got {value!r}"
  250. raise InvalidVersion(msg)
  251. # Backward compatibility for internals before 26.0. Do not use.
  252. class _Version(NamedTuple):
  253. epoch: int
  254. release: tuple[int, ...]
  255. dev: tuple[Literal["dev"], int] | None
  256. pre: tuple[Literal["a", "b", "rc"], int] | None
  257. post: tuple[Literal["post"], int] | None
  258. local: LocalType | None
  259. class Version(_BaseVersion):
  260. """This class abstracts handling of a project's versions.
  261. A :class:`Version` instance is comparison aware and can be compared and
  262. sorted using the standard Python interfaces.
  263. >>> v1 = Version("1.0a5")
  264. >>> v2 = Version("1.0")
  265. >>> v1
  266. <Version('1.0a5')>
  267. >>> v2
  268. <Version('1.0')>
  269. >>> v1 < v2
  270. True
  271. >>> v1 == v2
  272. False
  273. >>> v1 > v2
  274. False
  275. >>> v1 >= v2
  276. False
  277. >>> v1 <= v2
  278. True
  279. :class:`Version` is immutable; use :meth:`__replace__` to change
  280. part of a version.
  281. Instances are safe to serialize with :mod:`pickle`. They use a stable
  282. format so the same pickle can be loaded in future packaging releases.
  283. .. versionchanged:: 26.2
  284. Added a stable pickle format. Pickles created with packaging 26.2+ can
  285. be unpickled with future releases. Backward compatibility with pickles
  286. from packaging < 26.2 is supported but may be removed in a future
  287. release.
  288. """
  289. __slots__ = (
  290. "_dev",
  291. "_epoch",
  292. "_hash_cache",
  293. "_key_cache",
  294. "_local",
  295. "_post",
  296. "_pre",
  297. "_release",
  298. )
  299. __match_args__ = ("_str",)
  300. """
  301. Pattern matching is supported on Python 3.10+.
  302. .. versionadded:: 26.0
  303. :meta hide-value:
  304. """
  305. _regex = re.compile(r"\s*" + VERSION_PATTERN + r"\s*", re.VERBOSE | re.IGNORECASE)
  306. _epoch: int
  307. _release: tuple[int, ...]
  308. _dev: tuple[Literal["dev"], int] | None
  309. _pre: tuple[Literal["a", "b", "rc"], int] | None
  310. _post: tuple[Literal["post"], int] | None
  311. _local: LocalType | None
  312. _hash_cache: int | None
  313. _key_cache: CmpKey | None
  314. def __init__(self, version: str) -> None:
  315. """Initialize a Version object.
  316. :param version:
  317. The string representation of a version which will be parsed and normalized
  318. before use.
  319. :raises InvalidVersion:
  320. If the ``version`` does not conform to PEP 440 in any way then this
  321. exception will be raised.
  322. """
  323. if _SIMPLE_VERSION_INDICATORS.issuperset(version):
  324. try:
  325. self._release = tuple(map(int, version.split(".")))
  326. except ValueError:
  327. # Empty parts (from "1..2", ".1", etc.) are invalid versions.
  328. # Any other ValueError (e.g. int str-digits limit) should
  329. # propagate to the caller.
  330. if "" in version.split("."):
  331. raise InvalidVersion(f"Invalid version: {version!r}") from None
  332. # TODO: remove "no cover" when Python 3.9 is dropped.
  333. raise # pragma: no cover
  334. self._epoch = 0
  335. self._pre = None
  336. self._post = None
  337. self._dev = None
  338. self._local = None
  339. self._key_cache = None
  340. self._hash_cache = None
  341. return
  342. # Validate the version and parse it into pieces
  343. match = self._regex.fullmatch(version)
  344. if not match:
  345. raise InvalidVersion(f"Invalid version: {version!r}")
  346. self._epoch = int(match.group("epoch")) if match.group("epoch") else 0
  347. self._release = tuple(map(int, match.group("release").split(".")))
  348. # We can type ignore the assignments below because the regex guarantees
  349. # the correct strings
  350. self._pre = _parse_letter_version(match.group("pre_l"), match.group("pre_n")) # type: ignore[assignment]
  351. self._post = _parse_letter_version( # type: ignore[assignment]
  352. match.group("post_l"), match.group("post_n1") or match.group("post_n2")
  353. )
  354. self._dev = _parse_letter_version(match.group("dev_l"), match.group("dev_n")) # type: ignore[assignment]
  355. self._local = _parse_local_version(match.group("local"))
  356. # Key which will be used for sorting
  357. self._key_cache = None
  358. self._hash_cache = None
  359. @classmethod
  360. def from_parts(
  361. cls,
  362. *,
  363. epoch: int = 0,
  364. release: tuple[int, ...],
  365. pre: tuple[str, int] | None = None,
  366. post: int | None = None,
  367. dev: int | None = None,
  368. local: str | None = None,
  369. ) -> Self:
  370. """
  371. Return a new version composed of the various parts.
  372. This allows you to build a version without going though a string and
  373. running a regular expression. It normalizes pre-release strings. The
  374. ``release=`` keyword argument is required.
  375. >>> Version.from_parts(release=(1,2,3))
  376. <Version('1.2.3')>
  377. >>> Version.from_parts(release=(0,1,0), pre=("b", 1))
  378. <Version('0.1.0b1')>
  379. :param epoch:
  380. :param release: This version tuple is required
  381. .. versionadded:: 26.1
  382. """
  383. _epoch = _validate_epoch(epoch)
  384. _release = _validate_release(release)
  385. _pre = _validate_pre(pre) if pre is not None else None
  386. _post = _validate_post(post) if post is not None else None
  387. _dev = _validate_dev(dev) if dev is not None else None
  388. _local = _validate_local(local) if local is not None else None
  389. new_version = cls.__new__(cls)
  390. new_version._key_cache = None
  391. new_version._hash_cache = None
  392. new_version._epoch = _epoch
  393. new_version._release = _release
  394. new_version._pre = _pre
  395. new_version._post = _post
  396. new_version._dev = _dev
  397. new_version._local = _local
  398. return new_version
  399. def __replace__(self, **kwargs: Unpack[_VersionReplace]) -> Self:
  400. """
  401. __replace__(*, epoch=..., release=..., pre=..., post=..., dev=..., local=...)
  402. Return a new version with parts replaced.
  403. This returns a new version (unless no parts were changed). The
  404. pre-release is normalized. Setting a value to ``None`` clears it.
  405. >>> v = Version("1.2.3")
  406. >>> v.__replace__(pre=("a", 1))
  407. <Version('1.2.3a1')>
  408. :param int | None epoch:
  409. :param tuple[int, ...] | None release:
  410. :param tuple[str, int] | None pre:
  411. :param int | None post:
  412. :param int | None dev:
  413. :param str | None local:
  414. .. versionadded:: 26.0
  415. .. versionchanged:: 26.1
  416. The pre-release portion is now normalized.
  417. """
  418. epoch = _validate_epoch(kwargs["epoch"]) if "epoch" in kwargs else self._epoch
  419. release = (
  420. _validate_release(kwargs["release"])
  421. if "release" in kwargs
  422. else self._release
  423. )
  424. pre = _validate_pre(kwargs["pre"]) if "pre" in kwargs else self._pre
  425. post = _validate_post(kwargs["post"]) if "post" in kwargs else self._post
  426. dev = _validate_dev(kwargs["dev"]) if "dev" in kwargs else self._dev
  427. local = _validate_local(kwargs["local"]) if "local" in kwargs else self._local
  428. if (
  429. epoch == self._epoch
  430. and release == self._release
  431. and pre == self._pre
  432. and post == self._post
  433. and dev == self._dev
  434. and local == self._local
  435. ):
  436. return self
  437. new_version = self.__class__.__new__(self.__class__)
  438. new_version._key_cache = None
  439. new_version._hash_cache = None
  440. new_version._epoch = epoch
  441. new_version._release = release
  442. new_version._pre = pre
  443. new_version._post = post
  444. new_version._dev = dev
  445. new_version._local = local
  446. return new_version
  447. @property
  448. def _key(self) -> CmpKey:
  449. if self._key_cache is None:
  450. self._key_cache = _cmpkey(
  451. self._epoch,
  452. self._release,
  453. self._pre,
  454. self._post,
  455. self._dev,
  456. self._local,
  457. )
  458. return self._key_cache
  459. # __hash__ must be defined when __eq__ is overridden,
  460. # otherwise Python sets __hash__ to None.
  461. def __hash__(self) -> int:
  462. if (cached_hash := self._hash_cache) is not None:
  463. return cached_hash
  464. if (key := self._key_cache) is None:
  465. self._key_cache = key = _cmpkey(
  466. self._epoch,
  467. self._release,
  468. self._pre,
  469. self._post,
  470. self._dev,
  471. self._local,
  472. )
  473. self._hash_cache = cached_hash = hash(key)
  474. return cached_hash
  475. # Override comparison methods to use direct _key_cache access
  476. # This is faster than property access, especially before Python 3.12
  477. def __lt__(self, other: _BaseVersion) -> bool:
  478. if isinstance(other, Version):
  479. if self._key_cache is None:
  480. self._key_cache = _cmpkey(
  481. self._epoch,
  482. self._release,
  483. self._pre,
  484. self._post,
  485. self._dev,
  486. self._local,
  487. )
  488. if other._key_cache is None:
  489. other._key_cache = _cmpkey(
  490. other._epoch,
  491. other._release,
  492. other._pre,
  493. other._post,
  494. other._dev,
  495. other._local,
  496. )
  497. return self._key_cache < other._key_cache
  498. if not isinstance(other, _BaseVersion):
  499. return NotImplemented
  500. return super().__lt__(other)
  501. def __le__(self, other: _BaseVersion) -> bool:
  502. if isinstance(other, Version):
  503. if self._key_cache is None:
  504. self._key_cache = _cmpkey(
  505. self._epoch,
  506. self._release,
  507. self._pre,
  508. self._post,
  509. self._dev,
  510. self._local,
  511. )
  512. if other._key_cache is None:
  513. other._key_cache = _cmpkey(
  514. other._epoch,
  515. other._release,
  516. other._pre,
  517. other._post,
  518. other._dev,
  519. other._local,
  520. )
  521. return self._key_cache <= other._key_cache
  522. if not isinstance(other, _BaseVersion):
  523. return NotImplemented
  524. return super().__le__(other)
  525. def __eq__(self, other: object) -> bool:
  526. if isinstance(other, Version):
  527. if self._key_cache is None:
  528. self._key_cache = _cmpkey(
  529. self._epoch,
  530. self._release,
  531. self._pre,
  532. self._post,
  533. self._dev,
  534. self._local,
  535. )
  536. if other._key_cache is None:
  537. other._key_cache = _cmpkey(
  538. other._epoch,
  539. other._release,
  540. other._pre,
  541. other._post,
  542. other._dev,
  543. other._local,
  544. )
  545. return self._key_cache == other._key_cache
  546. if not isinstance(other, _BaseVersion):
  547. return NotImplemented
  548. return super().__eq__(other)
  549. def __ge__(self, other: _BaseVersion) -> bool:
  550. if isinstance(other, Version):
  551. if self._key_cache is None:
  552. self._key_cache = _cmpkey(
  553. self._epoch,
  554. self._release,
  555. self._pre,
  556. self._post,
  557. self._dev,
  558. self._local,
  559. )
  560. if other._key_cache is None:
  561. other._key_cache = _cmpkey(
  562. other._epoch,
  563. other._release,
  564. other._pre,
  565. other._post,
  566. other._dev,
  567. other._local,
  568. )
  569. return self._key_cache >= other._key_cache
  570. if not isinstance(other, _BaseVersion):
  571. return NotImplemented
  572. return super().__ge__(other)
  573. def __gt__(self, other: _BaseVersion) -> bool:
  574. if isinstance(other, Version):
  575. if self._key_cache is None:
  576. self._key_cache = _cmpkey(
  577. self._epoch,
  578. self._release,
  579. self._pre,
  580. self._post,
  581. self._dev,
  582. self._local,
  583. )
  584. if other._key_cache is None:
  585. other._key_cache = _cmpkey(
  586. other._epoch,
  587. other._release,
  588. other._pre,
  589. other._post,
  590. other._dev,
  591. other._local,
  592. )
  593. return self._key_cache > other._key_cache
  594. if not isinstance(other, _BaseVersion):
  595. return NotImplemented
  596. return super().__gt__(other)
  597. def __ne__(self, other: object) -> bool:
  598. if isinstance(other, Version):
  599. if self._key_cache is None:
  600. self._key_cache = _cmpkey(
  601. self._epoch,
  602. self._release,
  603. self._pre,
  604. self._post,
  605. self._dev,
  606. self._local,
  607. )
  608. if other._key_cache is None:
  609. other._key_cache = _cmpkey(
  610. other._epoch,
  611. other._release,
  612. other._pre,
  613. other._post,
  614. other._dev,
  615. other._local,
  616. )
  617. return self._key_cache != other._key_cache
  618. if not isinstance(other, _BaseVersion):
  619. return NotImplemented
  620. return super().__ne__(other)
  621. def __getstate__(
  622. self,
  623. ) -> tuple[
  624. int,
  625. tuple[int, ...],
  626. tuple[str, int] | None,
  627. tuple[str, int] | None,
  628. tuple[str, int] | None,
  629. LocalType | None,
  630. ]:
  631. # Return state as a 6-item tuple for compactness:
  632. # (epoch, release, pre, post, dev, local)
  633. # Cache members are excluded and will be recomputed on demand
  634. return (
  635. self._epoch,
  636. self._release,
  637. self._pre,
  638. self._post,
  639. self._dev,
  640. self._local,
  641. )
  642. def __setstate__(self, state: object) -> None:
  643. # Always discard cached values — they may contain stale references
  644. # (e.g. packaging._structures.InfinityType from pre-26.1 pickles)
  645. # and will be recomputed on demand from the core fields above.
  646. self._key_cache = None
  647. self._hash_cache = None
  648. if isinstance(state, tuple):
  649. if len(state) == 6:
  650. # New format (26.2+): (epoch, release, pre, post, dev, local)
  651. (
  652. self._epoch,
  653. self._release,
  654. self._pre,
  655. self._post,
  656. self._dev,
  657. self._local,
  658. ) = state
  659. return
  660. if len(state) == 2:
  661. # Format (packaging 26.0-26.1): (None, {slot: value}).
  662. _, slot_dict = state
  663. if isinstance(slot_dict, dict):
  664. self._epoch = slot_dict["_epoch"]
  665. self._release = slot_dict["_release"]
  666. self._pre = slot_dict.get("_pre")
  667. self._post = slot_dict.get("_post")
  668. self._dev = slot_dict.get("_dev")
  669. self._local = slot_dict.get("_local")
  670. return
  671. if isinstance(state, dict):
  672. # Old format (packaging <= 25.x, no __slots__): state is a plain
  673. # dict with "_version" (_Version NamedTuple) and "_key" entries.
  674. version_nt = state.get("_version")
  675. if version_nt is not None:
  676. self._epoch = version_nt.epoch
  677. self._release = version_nt.release
  678. self._pre = version_nt.pre
  679. self._post = version_nt.post
  680. self._dev = version_nt.dev
  681. self._local = version_nt.local
  682. return
  683. raise TypeError(f"Cannot restore Version from {state!r}")
  684. @property
  685. @_deprecated("Version._version is private and will be removed soon")
  686. def _version(self) -> _Version:
  687. return _Version(
  688. self._epoch, self._release, self._dev, self._pre, self._post, self._local
  689. )
  690. @_version.setter
  691. @_deprecated("Version._version is private and will be removed soon")
  692. def _version(self, value: _Version) -> None:
  693. self._epoch = value.epoch
  694. self._release = value.release
  695. self._dev = value.dev
  696. self._pre = value.pre
  697. self._post = value.post
  698. self._local = value.local
  699. self._key_cache = None
  700. self._hash_cache = None
  701. def __repr__(self) -> str:
  702. """A representation of the Version that shows all internal state.
  703. >>> Version('1.0.0')
  704. <Version('1.0.0')>
  705. """
  706. return f"<{self.__class__.__name__}({str(self)!r})>"
  707. def __str__(self) -> str:
  708. """A string representation of the version that can be round-tripped.
  709. >>> str(Version("1.0a5"))
  710. '1.0a5'
  711. """
  712. # This is a hot function, so not calling self.base_version
  713. version = ".".join(map(str, self.release))
  714. # Epoch
  715. if self.epoch:
  716. version = f"{self.epoch}!{version}"
  717. # Pre-release
  718. if self.pre is not None:
  719. version += "".join(map(str, self.pre))
  720. # Post-release
  721. if self.post is not None:
  722. version += f".post{self.post}"
  723. # Development release
  724. if self.dev is not None:
  725. version += f".dev{self.dev}"
  726. # Local version segment
  727. if self.local is not None:
  728. version += f"+{self.local}"
  729. return version
  730. @property
  731. def _str(self) -> str:
  732. """Internal property for match_args"""
  733. return str(self)
  734. @property
  735. def epoch(self) -> int:
  736. """The epoch of the version.
  737. >>> Version("2.0.0").epoch
  738. 0
  739. >>> Version("1!2.0.0").epoch
  740. 1
  741. """
  742. return self._epoch
  743. @property
  744. def release(self) -> tuple[int, ...]:
  745. """The components of the "release" segment of the version.
  746. >>> Version("1.2.3").release
  747. (1, 2, 3)
  748. >>> Version("2.0.0").release
  749. (2, 0, 0)
  750. >>> Version("1!2.0.0.post0").release
  751. (2, 0, 0)
  752. Includes trailing zeroes but not the epoch or any pre-release / development /
  753. post-release suffixes.
  754. """
  755. return self._release
  756. @property
  757. def pre(self) -> tuple[Literal["a", "b", "rc"], int] | None:
  758. """The pre-release segment of the version.
  759. >>> print(Version("1.2.3").pre)
  760. None
  761. >>> Version("1.2.3a1").pre
  762. ('a', 1)
  763. >>> Version("1.2.3b1").pre
  764. ('b', 1)
  765. >>> Version("1.2.3rc1").pre
  766. ('rc', 1)
  767. """
  768. return self._pre
  769. @property
  770. def post(self) -> int | None:
  771. """The post-release number of the version.
  772. >>> print(Version("1.2.3").post)
  773. None
  774. >>> Version("1.2.3.post1").post
  775. 1
  776. """
  777. return self._post[1] if self._post else None
  778. @property
  779. def dev(self) -> int | None:
  780. """The development number of the version.
  781. >>> print(Version("1.2.3").dev)
  782. None
  783. >>> Version("1.2.3.dev1").dev
  784. 1
  785. """
  786. return self._dev[1] if self._dev else None
  787. @property
  788. def local(self) -> str | None:
  789. """The local version segment of the version.
  790. >>> print(Version("1.2.3").local)
  791. None
  792. >>> Version("1.2.3+abc").local
  793. 'abc'
  794. """
  795. if self._local:
  796. return ".".join(str(x) for x in self._local)
  797. else:
  798. return None
  799. @property
  800. def public(self) -> str:
  801. """The public portion of the version.
  802. This returns a string. If you want a :class:`Version` again and care
  803. about performance, use ``v.__replace__(local=None)`` instead.
  804. >>> Version("1.2.3").public
  805. '1.2.3'
  806. >>> Version("1.2.3+abc").public
  807. '1.2.3'
  808. >>> Version("1!1.2.3dev1+abc").public
  809. '1!1.2.3.dev1'
  810. """
  811. return str(self).split("+", 1)[0]
  812. @property
  813. def base_version(self) -> str:
  814. """The "base version" of the version.
  815. This returns a string. If you want a :class:`Version` again and care
  816. about performance, use
  817. ``v.__replace__(pre=None, post=None, dev=None, local=None)`` instead.
  818. >>> Version("1.2.3").base_version
  819. '1.2.3'
  820. >>> Version("1.2.3+abc").base_version
  821. '1.2.3'
  822. >>> Version("1!1.2.3dev1+abc").base_version
  823. '1!1.2.3'
  824. The "base version" is the public version of the project without any pre or post
  825. release markers.
  826. """
  827. release_segment = ".".join(map(str, self.release))
  828. return f"{self.epoch}!{release_segment}" if self.epoch else release_segment
  829. @property
  830. def is_prerelease(self) -> bool:
  831. """Whether this version is a pre-release.
  832. >>> Version("1.2.3").is_prerelease
  833. False
  834. >>> Version("1.2.3a1").is_prerelease
  835. True
  836. >>> Version("1.2.3b1").is_prerelease
  837. True
  838. >>> Version("1.2.3rc1").is_prerelease
  839. True
  840. >>> Version("1.2.3dev1").is_prerelease
  841. True
  842. """
  843. return self.dev is not None or self.pre is not None
  844. @property
  845. def is_postrelease(self) -> bool:
  846. """Whether this version is a post-release.
  847. >>> Version("1.2.3").is_postrelease
  848. False
  849. >>> Version("1.2.3.post1").is_postrelease
  850. True
  851. """
  852. return self.post is not None
  853. @property
  854. def is_devrelease(self) -> bool:
  855. """Whether this version is a development release.
  856. >>> Version("1.2.3").is_devrelease
  857. False
  858. >>> Version("1.2.3.dev1").is_devrelease
  859. True
  860. """
  861. return self.dev is not None
  862. @property
  863. def major(self) -> int:
  864. """The first item of :attr:`release` or ``0`` if unavailable.
  865. >>> Version("1.2.3").major
  866. 1
  867. """
  868. return self.release[0] if len(self.release) >= 1 else 0
  869. @property
  870. def minor(self) -> int:
  871. """The second item of :attr:`release` or ``0`` if unavailable.
  872. >>> Version("1.2.3").minor
  873. 2
  874. >>> Version("1").minor
  875. 0
  876. """
  877. return self.release[1] if len(self.release) >= 2 else 0
  878. @property
  879. def micro(self) -> int:
  880. """The third item of :attr:`release` or ``0`` if unavailable.
  881. >>> Version("1.2.3").micro
  882. 3
  883. >>> Version("1").micro
  884. 0
  885. """
  886. return self.release[2] if len(self.release) >= 3 else 0
  887. class _TrimmedRelease(Version):
  888. __slots__ = ()
  889. def __init__(self, version: str | Version) -> None:
  890. if isinstance(version, Version):
  891. self._epoch = version._epoch
  892. self._release = version._release
  893. self._dev = version._dev
  894. self._pre = version._pre
  895. self._post = version._post
  896. self._local = version._local
  897. self._key_cache = version._key_cache
  898. return
  899. super().__init__(version) # pragma: no cover
  900. @property
  901. def release(self) -> tuple[int, ...]:
  902. """
  903. Release segment without any trailing zeros.
  904. >>> _TrimmedRelease('1.0.0').release
  905. (1,)
  906. >>> _TrimmedRelease('0.0').release
  907. (0,)
  908. """
  909. # This leaves one 0.
  910. rel = super().release
  911. len_release = len(rel)
  912. i = len_release
  913. while i > 1 and rel[i - 1] == 0:
  914. i -= 1
  915. return rel if i == len_release else rel[:i]
  916. def _parse_letter_version(
  917. letter: str | None, number: str | bytes | SupportsInt | None
  918. ) -> tuple[str, int] | None:
  919. if letter:
  920. # We normalize any letters to their lower case form
  921. letter = letter.lower()
  922. # We consider some words to be alternate spellings of other words and
  923. # in those cases we want to normalize the spellings to our preferred
  924. # spelling.
  925. letter = _LETTER_NORMALIZATION.get(letter, letter)
  926. # We consider there to be an implicit 0 in a pre-release if there is
  927. # not a numeral associated with it.
  928. return letter, int(number or 0)
  929. if number:
  930. # We assume if we are given a number, but we are not given a letter
  931. # then this is using the implicit post release syntax (e.g. 1.0-1)
  932. return "post", int(number)
  933. return None
  934. _local_version_separators = re.compile(r"[\._-]")
  935. def _parse_local_version(local: str | None) -> LocalType | None:
  936. """
  937. Takes a string like ``"abc.1.twelve"`` and turns it into
  938. ``("abc", 1, "twelve")``.
  939. """
  940. if local is not None:
  941. return tuple(
  942. part.lower() if not part.isdigit() else int(part)
  943. for part in _local_version_separators.split(local)
  944. )
  945. return None
  946. # Sort ranks for pre-release: dev-only < a < b < rc < stable (no pre-release).
  947. _PRE_RANK = {"a": 0, "b": 1, "rc": 2}
  948. _PRE_RANK_DEV_ONLY = -1 # sorts before a(0)
  949. _PRE_RANK_STABLE = 3 # sorts after rc(2)
  950. # In local version segments, strings sort before ints per PEP 440.
  951. _LOCAL_STR_RANK = -1 # sorts before all non-negative ints
  952. # Pre-computed suffix for stable releases (no pre, post, or dev segments).
  953. # See _cmpkey() for the suffix layout.
  954. _STABLE_SUFFIX = (_PRE_RANK_STABLE, 0, 0, 0, 1, 0)
  955. def _cmpkey(
  956. epoch: int,
  957. release: tuple[int, ...],
  958. pre: tuple[str, int] | None,
  959. post: tuple[str, int] | None,
  960. dev: tuple[str, int] | None,
  961. local: LocalType | None,
  962. ) -> CmpKey:
  963. """Build a comparison key for PEP 440 ordering.
  964. Returns ``(epoch, release, suffix)`` or
  965. ``(epoch, release, suffix, local)`` so that plain tuple
  966. comparison gives the correct order.
  967. Trailing zeros are stripped from the release so that ``1.0.0 == 1``.
  968. The suffix is a flat 6-int tuple that encodes pre/post/dev:
  969. ``(pre_rank, pre_n, post_rank, post_n, dev_rank, dev_n)``
  970. pre_rank: dev-only=-1, a=0, b=1, rc=2, no-pre=3
  971. Dev-only releases (no pre or post) get -1 so they sort before
  972. any alpha/beta/rc. Releases without a pre-release tag get 3
  973. so they sort after rc.
  974. post_rank: no-post=0, post=1
  975. Releases without a post segment sort before those with one.
  976. dev_rank: dev=0, no-dev=1
  977. Releases without a dev segment sort after those with one.
  978. Local segments use ``(n, "")`` for ints and ``(-1, s)`` for strings,
  979. following PEP 440: strings sort before ints, strings compare
  980. lexicographically, ints compare numerically, and shorter segments
  981. sort before longer when prefixes match. Versions without a local
  982. segment sort before those with one (3-tuple < 4-tuple).
  983. >>> _cmpkey(0, (1, 0, 0), None, None, None, None)
  984. (0, (1,), (3, 0, 0, 0, 1, 0))
  985. >>> _cmpkey(0, (1,), ("a", 1), None, None, None)
  986. (0, (1,), (0, 1, 0, 0, 1, 0))
  987. >>> _cmpkey(0, (1,), None, None, None, ("ubuntu", 1))
  988. (0, (1,), (3, 0, 0, 0, 1, 0), ((-1, 'ubuntu'), (1, '')))
  989. """
  990. # Strip trailing zeros: 1.0.0 compares equal to 1.
  991. len_release = len(release)
  992. i = len_release
  993. while i and release[i - 1] == 0:
  994. i -= 1
  995. trimmed = release if i == len_release else release[:i]
  996. # Fast path: stable release with no local segment.
  997. if pre is None and post is None and dev is None and local is None:
  998. return epoch, trimmed, _STABLE_SUFFIX
  999. if pre is None and post is None and dev is not None:
  1000. # dev-only (e.g. 1.0.dev1) sorts before all pre-releases.
  1001. pre_rank, pre_n = _PRE_RANK_DEV_ONLY, 0
  1002. elif pre is None:
  1003. pre_rank, pre_n = _PRE_RANK_STABLE, 0
  1004. else:
  1005. pre_rank, pre_n = _PRE_RANK[pre[0]], pre[1]
  1006. post_rank = 0 if post is None else 1
  1007. post_n = 0 if post is None else post[1]
  1008. dev_rank = 1 if dev is None else 0
  1009. dev_n = 0 if dev is None else dev[1]
  1010. suffix = (pre_rank, pre_n, post_rank, post_n, dev_rank, dev_n)
  1011. if local is None:
  1012. return epoch, trimmed, suffix
  1013. cmp_local: CmpLocalType = tuple(
  1014. (seg, "") if isinstance(seg, int) else (_LOCAL_STR_RANK, seg) for seg in local
  1015. )
  1016. return epoch, trimmed, suffix, cmp_local