File size: 71,514 Bytes
5e9fb2f | 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 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 | # This file is dual licensed under the terms of the Apache License, Version
# 2.0, and the BSD License. See the LICENSE file in the root of this repository
# for complete details.
"""
.. testsetup::
from packaging.specifiers import Specifier, SpecifierSet, InvalidSpecifier
from packaging.version import Version
"""
from __future__ import annotations
import abc
import enum
import functools
import itertools
import re
import sys
import typing
from typing import (
TYPE_CHECKING,
Any,
Callable,
Final,
Iterable,
Iterator,
Sequence,
TypeVar,
Union,
)
from .utils import canonicalize_version
from .version import InvalidVersion, Version
if sys.version_info >= (3, 10):
from typing import TypeGuard # pragma: no cover
elif TYPE_CHECKING:
from typing_extensions import TypeGuard
__all__ = [
"BaseSpecifier",
"InvalidSpecifier",
"Specifier",
"SpecifierSet",
]
def __dir__() -> list[str]:
return __all__
def _validate_spec(spec: object, /) -> TypeGuard[tuple[str, str]]:
return (
isinstance(spec, tuple)
and len(spec) == 2
and isinstance(spec[0], str)
and isinstance(spec[1], str)
)
def _validate_pre(pre: object, /) -> TypeGuard[bool | None]:
return pre is None or isinstance(pre, bool)
T = TypeVar("T")
UnparsedVersion = Union[Version, str]
UnparsedVersionVar = TypeVar("UnparsedVersionVar", bound=UnparsedVersion)
CallableOperator = Callable[[Version, str], bool]
# The smallest possible PEP 440 version. No valid version is less than this.
_MIN_VERSION: Final[Version] = Version("0.dev0")
def _trim_release(release: tuple[int, ...]) -> tuple[int, ...]:
"""Strip trailing zeros from a release tuple for normalized comparison."""
end = len(release)
while end > 1 and release[end - 1] == 0:
end -= 1
return release if end == len(release) else release[:end]
class _BoundaryKind(enum.Enum):
"""Where a boundary marker sits in the version ordering."""
AFTER_LOCALS = enum.auto() # after V+local, before V.post0
AFTER_POSTS = enum.auto() # after V.postN, before next release
@functools.total_ordering
class _BoundaryVersion:
"""A point on the version line between two real PEP 440 versions.
Some specifier semantics imply boundaries between real versions:
``<=1.0`` includes ``1.0+local`` and ``>1.0`` excludes
``1.0.post0``. No real :class:`Version` falls on those boundaries,
so this class creates values that sort between the real versions
on either side.
Two kinds exist, shown relative to a base version V::
V < V+local < AFTER_LOCALS(V) < V.post0 < AFTER_POSTS(V)
``AFTER_LOCALS`` sits after V and every V+local, but before
V.post0. Upper bound of ``<=V``, ``==V``, ``!=V``.
``AFTER_POSTS`` sits after every V.postN, but before the next
release segment. Lower bound of ``>V`` (final or pre-release V)
to exclude post-releases per PEP 440.
"""
__slots__ = ("_kind", "_trimmed_release", "version")
def __init__(self, version: Version, kind: _BoundaryKind) -> None:
self.version = version
self._kind = kind
self._trimmed_release = _trim_release(version.release)
def _is_family(self, other: Version) -> bool:
"""Is ``other`` a version that this boundary sorts above?"""
v = self.version
if not (
other.epoch == v.epoch
and _trim_release(other.release) == self._trimmed_release
and other.pre == v.pre
):
return False
if self._kind == _BoundaryKind.AFTER_LOCALS:
# Local family: exact same public version (any local label).
return other.post == v.post and other.dev == v.dev
# Post family: same base + any post-release (or identical).
return other.dev == v.dev or other.post is not None
def __eq__(self, other: object) -> bool:
if isinstance(other, _BoundaryVersion):
return self.version == other.version and self._kind == other._kind
return NotImplemented
def __lt__(self, other: _BoundaryVersion | Version) -> bool:
if isinstance(other, _BoundaryVersion):
if self.version != other.version:
return self.version < other.version
return self._kind.value < other._kind.value
return not self._is_family(other) and self.version < other
def __hash__(self) -> int:
return hash((self.version, self._kind))
def __repr__(self) -> str:
return f"{self.__class__.__name__}({self.version!r}, {self._kind.name})"
@functools.total_ordering
class _LowerBound:
"""Lower bound of a version range.
A version *v* of ``None`` means unbounded below (-inf).
At equal versions, ``[v`` sorts before ``(v`` because an inclusive
bound starts earlier.
"""
__slots__ = ("inclusive", "version")
def __init__(self, version: _VersionOrBoundary, inclusive: bool) -> None:
self.version = version
self.inclusive = inclusive
def __eq__(self, other: object) -> bool:
if not isinstance(other, _LowerBound):
return NotImplemented # pragma: no cover
return self.version == other.version and self.inclusive == other.inclusive
def __lt__(self, other: _LowerBound) -> bool:
if not isinstance(other, _LowerBound): # pragma: no cover
return NotImplemented
# -inf < anything (except -inf).
if self.version is None:
return other.version is not None
if other.version is None:
return False
if self.version != other.version:
return self.version < other.version
# [v < (v: inclusive starts earlier.
return self.inclusive and not other.inclusive
def __hash__(self) -> int:
return hash((self.version, self.inclusive))
def __repr__(self) -> str:
bracket = "[" if self.inclusive else "("
return f"<{self.__class__.__name__} {bracket}{self.version!r}>"
@functools.total_ordering
class _UpperBound:
"""Upper bound of a version range.
A version *v* of ``None`` means unbounded above (+inf).
At equal versions, ``v)`` sorts before ``v]`` because an exclusive
bound ends earlier.
"""
__slots__ = ("inclusive", "version")
def __init__(self, version: _VersionOrBoundary, inclusive: bool) -> None:
self.version = version
self.inclusive = inclusive
def __eq__(self, other: object) -> bool:
if not isinstance(other, _UpperBound):
return NotImplemented # pragma: no cover
return self.version == other.version and self.inclusive == other.inclusive
def __lt__(self, other: _UpperBound) -> bool:
if not isinstance(other, _UpperBound): # pragma: no cover
return NotImplemented
# Nothing < +inf (except +inf itself).
if self.version is None:
return False
if other.version is None:
return True
if self.version != other.version:
return self.version < other.version
# v) < v]: exclusive ends earlier.
return not self.inclusive and other.inclusive
def __hash__(self) -> int:
return hash((self.version, self.inclusive))
def __repr__(self) -> str:
bracket = "]" if self.inclusive else ")"
return f"<{self.__class__.__name__} {self.version!r}{bracket}>"
if typing.TYPE_CHECKING:
_VersionOrBoundary = Union[Version, _BoundaryVersion, None]
#: A single contiguous version range, represented as a
#: (lower bound, upper bound) pair.
_VersionRange = tuple[_LowerBound, _UpperBound]
_NEG_INF = _LowerBound(None, False)
_POS_INF = _UpperBound(None, False)
_FULL_RANGE: tuple[_VersionRange] = ((_NEG_INF, _POS_INF),)
def _range_is_empty(lower: _LowerBound, upper: _UpperBound) -> bool:
"""True when the range defined by *lower* and *upper* contains no versions."""
if lower.version is None or upper.version is None:
return False
if lower.version == upper.version:
return not (lower.inclusive and upper.inclusive)
return lower.version > upper.version
def _intersect_ranges(
left: Sequence[_VersionRange],
right: Sequence[_VersionRange],
) -> list[_VersionRange]:
"""Intersect two sorted, non-overlapping range lists (two-pointer merge)."""
result: list[_VersionRange] = []
left_index = right_index = 0
while left_index < len(left) and right_index < len(right):
left_lower, left_upper = left[left_index]
right_lower, right_upper = right[right_index]
lower = max(left_lower, right_lower)
upper = min(left_upper, right_upper)
if not _range_is_empty(lower, upper):
result.append((lower, upper))
# Advance whichever side has the smaller upper bound.
if left_upper < right_upper:
left_index += 1
else:
right_index += 1
return result
def _next_prefix_dev0(version: Version) -> Version:
"""Smallest version in the next prefix: 1.2 -> 1.3.dev0."""
release = (*version.release[:-1], version.release[-1] + 1)
return Version.from_parts(epoch=version.epoch, release=release, dev=0)
def _base_dev0(version: Version) -> Version:
"""The .dev0 of a version's base release: 1.2 -> 1.2.dev0."""
return Version.from_parts(epoch=version.epoch, release=version.release, dev=0)
def _coerce_version(version: UnparsedVersion) -> Version | None:
if not isinstance(version, Version):
try:
version = Version(version)
except InvalidVersion:
return None
return version
def _public_version(version: Version) -> Version:
if version.local is None:
return version
return version.__replace__(local=None)
def _post_base(version: Version) -> Version:
"""The version that *version* is a post-release of.
1.0.post1 -> 1.0, 1.0a1.post0 -> 1.0a1, 1.0.post0.dev1 -> 1.0.
"""
return version.__replace__(post=None, dev=None, local=None)
def _earliest_prerelease(version: Version) -> Version:
"""Earliest pre-release of *version*.
1.2 -> 1.2.dev0, 1.2.post1 -> 1.2.post1.dev0.
"""
return version.__replace__(dev=0, local=None)
def _nearest_non_prerelease(
v: _VersionOrBoundary,
) -> Version | None:
"""Smallest non-pre-release version at or above *v*, or None."""
if v is None:
return None
if isinstance(v, _BoundaryVersion):
inner = v.version
if inner.is_prerelease:
# AFTER_LOCALS(1.0a1) -> nearest non-pre is 1.0
return inner.__replace__(pre=None, dev=None, local=None)
# AFTER_LOCALS(1.0) -> nearest non-pre is 1.0.post0
# AFTER_LOCALS(1.0.post0) -> nearest non-pre is 1.0.post1
k = (inner.post + 1) if inner.post is not None else 0
return inner.__replace__(post=k, local=None)
if not v.is_prerelease:
return v
# Strip pre/dev to get the final or post-release form.
return v.__replace__(pre=None, dev=None, local=None)
class InvalidSpecifier(ValueError):
"""
Raised when attempting to create a :class:`Specifier` with a specifier
string that is invalid.
>>> Specifier("lolwat")
Traceback (most recent call last):
...
packaging.specifiers.InvalidSpecifier: Invalid specifier: 'lolwat'
"""
class BaseSpecifier(metaclass=abc.ABCMeta):
__slots__ = ()
__match_args__ = ("_str",)
@property
def _str(self) -> str:
"""Internal property for match_args"""
return str(self)
@abc.abstractmethod
def __str__(self) -> str:
"""
Returns the str representation of this Specifier-like object. This
should be representative of the Specifier itself.
"""
@abc.abstractmethod
def __hash__(self) -> int:
"""
Returns a hash value for this Specifier-like object.
"""
@abc.abstractmethod
def __eq__(self, other: object) -> bool:
"""
Returns a boolean representing whether or not the two Specifier-like
objects are equal.
:param other: The other object to check against.
"""
@property
@abc.abstractmethod
def prereleases(self) -> bool | None:
"""Whether or not pre-releases as a whole are allowed.
This can be set to either ``True`` or ``False`` to explicitly enable or disable
prereleases or it can be set to ``None`` (the default) to use default semantics.
"""
@prereleases.setter # noqa: B027
def prereleases(self, value: bool) -> None:
"""Setter for :attr:`prereleases`.
:param value: The value to set.
"""
@abc.abstractmethod
def contains(self, item: str, prereleases: bool | None = None) -> bool:
"""
Determines if the given item is contained within this specifier.
"""
@typing.overload
def filter(
self,
iterable: Iterable[UnparsedVersionVar],
prereleases: bool | None = None,
key: None = ...,
) -> Iterator[UnparsedVersionVar]: ...
@typing.overload
def filter(
self,
iterable: Iterable[T],
prereleases: bool | None = None,
key: Callable[[T], UnparsedVersion] = ...,
) -> Iterator[T]: ...
@abc.abstractmethod
def filter(
self,
iterable: Iterable[Any],
prereleases: bool | None = None,
key: Callable[[Any], UnparsedVersion] | None = None,
) -> Iterator[Any]:
"""
Takes an iterable of items and filters them so that only items which
are contained within this specifier are allowed in it.
"""
class Specifier(BaseSpecifier):
"""This class abstracts handling of version specifiers.
.. tip::
It is generally not required to instantiate this manually. You should instead
prefer to work with :class:`SpecifierSet` instead, which can parse
comma-separated version specifiers (which is what package metadata contains).
Instances are safe to serialize with :mod:`pickle`. They use a stable
format so the same pickle can be loaded in future packaging releases.
.. versionchanged:: 26.2
Added a stable pickle format. Pickles created with packaging 26.2+ can
be unpickled with future releases. Backward compatibility with pickles
from packaging < 26.2 is supported but may be removed in a future
release.
"""
__slots__ = (
"_prereleases",
"_ranges",
"_spec",
"_spec_version",
"_wildcard_split",
)
_specifier_regex_str = r"""
(?:
(?:
# The identity operators allow for an escape hatch that will
# do an exact string match of the version you wish to install.
# This will not be parsed by PEP 440 and we cannot determine
# any semantic meaning from it. This operator is discouraged
# but included entirely as an escape hatch.
=== # Only match for the identity operator
\s*
[^\s;)]* # The arbitrary version can be just about anything,
# we match everything except for whitespace, a
# semi-colon for marker support, and a closing paren
# since versions can be enclosed in them.
)
|
(?:
# The (non)equality operators allow for wild card and local
# versions to be specified so we have to define these two
# operators separately to enable that.
(?:==|!=) # Only match for equals and not equals
\s*
v?
(?:[0-9]+!)? # epoch
[0-9]+(?:\.[0-9]+)* # release
# You cannot use a wild card and a pre-release, post-release, a dev or
# local version together so group them with a | and make them optional.
(?:
\.\* # Wild card syntax of .*
|
(?a: # pre release
[-_\.]?
(alpha|beta|preview|pre|a|b|c|rc)
[-_\.]?
[0-9]*
)?
(?a: # post release
(?:-[0-9]+)|(?:[-_\.]?(post|rev|r)[-_\.]?[0-9]*)
)?
(?a:[-_\.]?dev[-_\.]?[0-9]*)? # dev release
(?a:\+[a-z0-9]+(?:[-_\.][a-z0-9]+)*)? # local
)?
)
|
(?:
# The compatible operator requires at least two digits in the
# release segment.
(?:~=) # Only match for the compatible operator
\s*
v?
(?:[0-9]+!)? # epoch
[0-9]+(?:\.[0-9]+)+ # release (We have a + instead of a *)
(?: # pre release
[-_\.]?
(alpha|beta|preview|pre|a|b|c|rc)
[-_\.]?
[0-9]*
)?
(?: # post release
(?:-[0-9]+)|(?:[-_\.]?(post|rev|r)[-_\.]?[0-9]*)
)?
(?:[-_\.]?dev[-_\.]?[0-9]*)? # dev release
)
|
(?:
# All other operators only allow a sub set of what the
# (non)equality operators do. Specifically they do not allow
# local versions to be specified nor do they allow the prefix
# matching wild cards.
(?:<=|>=|<|>)
\s*
v?
(?:[0-9]+!)? # epoch
[0-9]+(?:\.[0-9]+)* # release
(?a: # pre release
[-_\.]?
(alpha|beta|preview|pre|a|b|c|rc)
[-_\.]?
[0-9]*
)?
(?a: # post release
(?:-[0-9]+)|(?:[-_\.]?(post|rev|r)[-_\.]?[0-9]*)
)?
(?a:[-_\.]?dev[-_\.]?[0-9]*)? # dev release
)
)
"""
_regex = re.compile(
r"\s*" + _specifier_regex_str + r"\s*", re.VERBOSE | re.IGNORECASE
)
_operators: Final = {
"~=": "compatible",
"==": "equal",
"!=": "not_equal",
"<=": "less_than_equal",
">=": "greater_than_equal",
"<": "less_than",
">": "greater_than",
"===": "arbitrary",
}
def __init__(self, spec: str = "", prereleases: bool | None = None) -> None:
"""Initialize a Specifier instance.
:param spec:
The string representation of a specifier which will be parsed and
normalized before use.
:param prereleases:
This tells the specifier if it should accept prerelease versions if
applicable or not. The default of ``None`` will autodetect it from the
given specifiers.
:raises InvalidSpecifier:
If the given specifier is invalid (i.e. bad syntax).
"""
if not self._regex.fullmatch(spec):
raise InvalidSpecifier(f"Invalid specifier: {spec!r}")
spec = spec.strip()
if spec.startswith("==="):
operator, version = spec[:3], spec[3:].strip()
elif spec.startswith(("~=", "==", "!=", "<=", ">=")):
operator, version = spec[:2], spec[2:].strip()
else:
operator, version = spec[:1], spec[1:].strip()
self._spec: tuple[str, str] = (operator, version)
# Store whether or not this Specifier should accept prereleases
self._prereleases = prereleases
# Specifier version cache
self._spec_version: tuple[str, Version] | None = None
# Populated on first wildcard (==X.*) comparison
self._wildcard_split: tuple[list[str], int] | None = None
# Version range cache (populated by _to_ranges)
self._ranges: Sequence[_VersionRange] | None = None
def _get_spec_version(self, version: str) -> Version | None:
"""One element cache, as only one spec Version is needed per Specifier."""
if self._spec_version is not None and self._spec_version[0] == version:
return self._spec_version[1]
version_specifier = _coerce_version(version)
if version_specifier is None:
return None
self._spec_version = (version, version_specifier)
return version_specifier
def _require_spec_version(self, version: str) -> Version:
"""Get spec version, asserting it's valid (not for === operator).
This method should only be called for operators where version
strings are guaranteed to be valid PEP 440 versions (not ===).
"""
spec_version = self._get_spec_version(version)
assert spec_version is not None
return spec_version
def _to_ranges(self) -> Sequence[_VersionRange]:
"""Convert this specifier to sorted, non-overlapping version ranges.
Each standard operator maps to one or two ranges. ``===`` is
modeled as full range (actual check done separately). Cached.
"""
if self._ranges is not None:
return self._ranges
op = self.operator
ver_str = self.version
if op == "===":
self._ranges = _FULL_RANGE
return _FULL_RANGE
if ver_str.endswith(".*"):
result = self._wildcard_ranges(op, ver_str)
else:
result = self._standard_ranges(op, ver_str)
self._ranges = result
return result
def _wildcard_ranges(self, op: str, ver_str: str) -> list[_VersionRange]:
# ==1.2.* -> [1.2.dev0, 1.3.dev0); !=1.2.* -> complement.
base = self._require_spec_version(ver_str[:-2])
lower = _base_dev0(base)
upper = _next_prefix_dev0(base)
if op == "==":
return [(_LowerBound(lower, True), _UpperBound(upper, False))]
# !=
return [
(_NEG_INF, _UpperBound(lower, False)),
(_LowerBound(upper, True), _POS_INF),
]
def _standard_ranges(self, op: str, ver_str: str) -> list[_VersionRange]:
v = self._require_spec_version(ver_str)
if op == ">=":
return [(_LowerBound(v, True), _POS_INF)]
if op == "<=":
return [
(
_NEG_INF,
_UpperBound(_BoundaryVersion(v, _BoundaryKind.AFTER_LOCALS), True),
)
]
if op == ">":
if v.dev is not None:
# >V.devN: dev versions have no post-releases, so the
# next real version is V.dev(N+1).
lower_ver = v.__replace__(dev=v.dev + 1, local=None)
return [(_LowerBound(lower_ver, True), _POS_INF)]
if v.post is not None:
# >V.postN: next real version is V.post(N+1).dev0.
lower_ver = v.__replace__(post=v.post + 1, dev=0, local=None)
return [(_LowerBound(lower_ver, True), _POS_INF)]
# >V (final or pre-release): skip V+local and all V.postN.
return [
(
_LowerBound(_BoundaryVersion(v, _BoundaryKind.AFTER_POSTS), False),
_POS_INF,
)
]
if op == "<":
# <V excludes prereleases of V when V is not a prerelease.
# V.dev0 is the earliest prerelease of V (final, post, etc.).
bound = v if v.is_prerelease else v.__replace__(dev=0, local=None)
if bound <= _MIN_VERSION:
return []
return [(_NEG_INF, _UpperBound(bound, False))]
# ==, !=: local versions of V match when spec has no local segment.
has_local = "+" in ver_str
after_locals = _BoundaryVersion(v, _BoundaryKind.AFTER_LOCALS)
upper = v if has_local else after_locals
if op == "==":
return [(_LowerBound(v, True), _UpperBound(upper, True))]
if op == "!=":
return [
(_NEG_INF, _UpperBound(v, False)),
(_LowerBound(upper, False), _POS_INF),
]
if op == "~=":
prefix = v.__replace__(release=v.release[:-1])
return [
(_LowerBound(v, True), _UpperBound(_next_prefix_dev0(prefix), False))
]
raise ValueError(f"Unknown operator: {op!r}") # pragma: no cover
@property
def prereleases(self) -> bool | None:
# If there is an explicit prereleases set for this, then we'll just
# blindly use that.
if self._prereleases is not None:
return self._prereleases
# Only the "!=" operator does not imply prereleases when
# the version in the specifier is a prerelease.
operator, version_str = self._spec
if operator == "!=":
return False
# The == specifier with trailing .* cannot include prereleases
# e.g. "==1.0a1.*" is not valid.
if operator == "==" and version_str.endswith(".*"):
return False
# "===" can have arbitrary string versions, so we cannot parse
# those, we take prereleases as unknown (None) for those.
version = self._get_spec_version(version_str)
if version is None:
return None
# For all other operators, use the check if spec Version
# object implies pre-releases.
return version.is_prerelease
@prereleases.setter
def prereleases(self, value: bool | None) -> None:
self._prereleases = value
def __getstate__(self) -> tuple[tuple[str, str], bool | None]:
# Return state as a 2-item tuple for compactness:
# ((operator, version), prereleases)
# Cache members are excluded and will be recomputed on demand.
return (self._spec, self._prereleases)
def __setstate__(self, state: object) -> None:
# Always discard cached values - they will be recomputed on demand.
self._spec_version = None
self._wildcard_split = None
self._ranges = None
if isinstance(state, tuple):
if len(state) == 2:
# New format (26.2+): ((operator, version), prereleases)
spec, prereleases = state
if _validate_spec(spec) and _validate_pre(prereleases):
self._spec = spec
self._prereleases = prereleases
return
if len(state) == 2 and isinstance(state[1], dict):
# Format (packaging 26.0-26.1): (None, {slot: value}).
_, slot_dict = state
spec = slot_dict.get("_spec")
prereleases = slot_dict.get("_prereleases", "invalid")
if _validate_spec(spec) and _validate_pre(prereleases):
self._spec = spec
self._prereleases = prereleases
return
if isinstance(state, dict):
# Old format (packaging <= 25.x, no __slots__): state is a plain dict.
spec = state.get("_spec")
prereleases = state.get("_prereleases", "invalid")
if _validate_spec(spec) and _validate_pre(prereleases):
self._spec = spec
self._prereleases = prereleases
return
raise TypeError(f"Cannot restore Specifier from {state!r}")
@property
def operator(self) -> str:
"""The operator of this specifier.
>>> Specifier("==1.2.3").operator
'=='
"""
return self._spec[0]
@property
def version(self) -> str:
"""The version of this specifier.
>>> Specifier("==1.2.3").version
'1.2.3'
"""
return self._spec[1]
def __repr__(self) -> str:
"""A representation of the Specifier that shows all internal state.
>>> Specifier('>=1.0.0')
<Specifier('>=1.0.0')>
>>> Specifier('>=1.0.0', prereleases=False)
<Specifier('>=1.0.0', prereleases=False)>
>>> Specifier('>=1.0.0', prereleases=True)
<Specifier('>=1.0.0', prereleases=True)>
"""
pre = (
f", prereleases={self.prereleases!r}"
if self._prereleases is not None
else ""
)
return f"<{self.__class__.__name__}({str(self)!r}{pre})>"
def __str__(self) -> str:
"""A string representation of the Specifier that can be round-tripped.
>>> str(Specifier('>=1.0.0'))
'>=1.0.0'
>>> str(Specifier('>=1.0.0', prereleases=False))
'>=1.0.0'
"""
return "{}{}".format(*self._spec)
@property
def _canonical_spec(self) -> tuple[str, str]:
operator, version = self._spec
if operator == "===" or version.endswith(".*"):
return operator, version
spec_version = self._require_spec_version(version)
canonical_version = canonicalize_version(
spec_version, strip_trailing_zero=(operator != "~=")
)
return operator, canonical_version
def __hash__(self) -> int:
return hash(self._canonical_spec)
def __eq__(self, other: object) -> bool:
"""Whether or not the two Specifier-like objects are equal.
:param other: The other object to check against.
The value of :attr:`prereleases` is ignored.
>>> Specifier("==1.2.3") == Specifier("== 1.2.3.0")
True
>>> (Specifier("==1.2.3", prereleases=False) ==
... Specifier("==1.2.3", prereleases=True))
True
>>> Specifier("==1.2.3") == "==1.2.3"
True
>>> Specifier("==1.2.3") == Specifier("==1.2.4")
False
>>> Specifier("==1.2.3") == Specifier("~=1.2.3")
False
"""
if isinstance(other, str):
try:
other = self.__class__(str(other))
except InvalidSpecifier:
return NotImplemented
elif not isinstance(other, self.__class__):
return NotImplemented
return self._canonical_spec == other._canonical_spec
def _get_operator(self, op: str) -> CallableOperator:
operator_callable: CallableOperator = getattr(
self, f"_compare_{self._operators[op]}"
)
return operator_callable
def _compare_compatible(self, prospective: Version, spec: str) -> bool:
# Compatible releases have an equivalent combination of >= and ==. That
# is that ~=2.2 is equivalent to >=2.2,==2.*. This allows us to
# implement this in terms of the other specifiers instead of
# implementing it ourselves. The only thing we need to do is construct
# the other specifiers.
# We want everything but the last item in the version, but we want to
# ignore suffix segments.
prefix = _version_join(
list(itertools.takewhile(_is_not_suffix, _version_split(spec)))[:-1]
)
# Add the prefix notation to the end of our string
prefix += ".*"
return (self._compare_greater_than_equal(prospective, spec)) and (
self._compare_equal(prospective, prefix)
)
def _get_wildcard_split(self, spec: str) -> tuple[list[str], int]:
"""Cached split of a wildcard spec into components and numeric length.
>>> Specifier("==1.*")._get_wildcard_split("1.*")
(['0', '1'], 2)
>>> Specifier("==3.10.*")._get_wildcard_split("3.10.*")
(['0', '3', '10'], 3)
"""
wildcard_split = self._wildcard_split
if wildcard_split is None:
normalized = canonicalize_version(spec[:-2], strip_trailing_zero=False)
split_spec = _version_split(normalized)
wildcard_split = (split_spec, _numeric_prefix_len(split_spec))
self._wildcard_split = wildcard_split
return wildcard_split
def _compare_equal(self, prospective: Version, spec: str) -> bool:
# We need special logic to handle prefix matching
if spec.endswith(".*"):
split_spec, spec_numeric_len = self._get_wildcard_split(spec)
# In the case of prefix matching we want to ignore local segment.
normalized_prospective = canonicalize_version(
_public_version(prospective), strip_trailing_zero=False
)
# Split the prospective version out by bangs and dots, and pretend
# that there is an implicit dot in between a release segment and
# a pre-release segment.
split_prospective = _version_split(normalized_prospective)
# 0-pad the prospective version before shortening it to get the correct
# shortened version.
padded_prospective = _left_pad(split_prospective, spec_numeric_len)
# Shorten the prospective version to be the same length as the spec
# so that we can determine if the specifier is a prefix of the
# prospective version or not.
shortened_prospective = padded_prospective[: len(split_spec)]
return shortened_prospective == split_spec
else:
# Convert our spec string into a Version
spec_version = self._require_spec_version(spec)
# If the specifier does not have a local segment, then we want to
# act as if the prospective version also does not have a local
# segment.
if not spec_version.local:
prospective = _public_version(prospective)
return prospective == spec_version
def _compare_not_equal(self, prospective: Version, spec: str) -> bool:
return not self._compare_equal(prospective, spec)
def _compare_less_than_equal(self, prospective: Version, spec: str) -> bool:
# NB: Local version identifiers are NOT permitted in the version
# specifier, so local version labels can be universally removed from
# the prospective version.
return _public_version(prospective) <= self._require_spec_version(spec)
def _compare_greater_than_equal(self, prospective: Version, spec: str) -> bool:
# NB: Local version identifiers are NOT permitted in the version
# specifier, so local version labels can be universally removed from
# the prospective version.
return _public_version(prospective) >= self._require_spec_version(spec)
def _compare_less_than(self, prospective: Version, spec_str: str) -> bool:
# Convert our spec to a Version instance, since we'll want to work with
# it as a version.
spec = self._require_spec_version(spec_str)
# Check to see if the prospective version is less than the spec
# version. If it's not we can short circuit and just return False now
# instead of doing extra unneeded work.
if not prospective < spec:
return False
# The spec says: "<V MUST NOT allow a pre-release of the specified
# version unless the specified version is itself a pre-release."
if (
not spec.is_prerelease
and prospective.is_prerelease
and prospective >= _earliest_prerelease(spec)
):
return False
# If we've gotten to here, it means that prospective version is both
# less than the spec version *and* it's not a pre-release of the same
# version in the spec.
return True
def _compare_greater_than(self, prospective: Version, spec_str: str) -> bool:
# Convert our spec to a Version instance, since we'll want to work with
# it as a version.
spec = self._require_spec_version(spec_str)
# Check to see if the prospective version is greater than the spec
# version. If it's not we can short circuit and just return False now
# instead of doing extra unneeded work.
if not prospective > spec:
return False
# The spec says: ">V MUST NOT allow a post-release of the specified
# version unless the specified version is itself a post-release."
if (
not spec.is_postrelease
and prospective.is_postrelease
and _post_base(prospective) == spec
):
return False
# Per the spec: ">V MUST NOT match a local version of the specified
# version". A "local version of V" is any version whose public part
# equals V. So >1.0a1 must not match 1.0a1+local, but must still
# match 1.0a2+local.
if prospective.local is not None and _public_version(prospective) == spec:
return False
# If we've gotten to here, it means that prospective version is both
# greater than the spec version *and* it's not a pre-release of the
# same version in the spec.
return True
def _compare_arbitrary(self, prospective: Version | str, spec: str) -> bool:
return str(prospective).lower() == str(spec).lower()
def __contains__(self, item: str | Version) -> bool:
"""Return whether or not the item is contained in this specifier.
:param item: The item to check for.
This is used for the ``in`` operator and behaves the same as
:meth:`contains` with no ``prereleases`` argument passed.
>>> "1.2.3" in Specifier(">=1.2.3")
True
>>> Version("1.2.3") in Specifier(">=1.2.3")
True
>>> "1.0.0" in Specifier(">=1.2.3")
False
>>> "1.3.0a1" in Specifier(">=1.2.3")
True
>>> "1.3.0a1" in Specifier(">=1.2.3", prereleases=True)
True
"""
return self.contains(item)
def contains(self, item: UnparsedVersion, prereleases: bool | None = None) -> bool:
"""Return whether or not the item is contained in this specifier.
:param item:
The item to check for, which can be a version string or a
:class:`Version` instance.
:param prereleases:
Whether or not to match prereleases with this Specifier. If set to
``None`` (the default), it will follow the recommendation from
:pep:`440` and match prereleases, as there are no other versions.
>>> Specifier(">=1.2.3").contains("1.2.3")
True
>>> Specifier(">=1.2.3").contains(Version("1.2.3"))
True
>>> Specifier(">=1.2.3").contains("1.0.0")
False
>>> Specifier(">=1.2.3").contains("1.3.0a1")
True
>>> Specifier(">=1.2.3", prereleases=False).contains("1.3.0a1")
False
>>> Specifier(">=1.2.3").contains("1.3.0a1")
True
"""
return bool(list(self.filter([item], prereleases=prereleases)))
@typing.overload
def filter(
self,
iterable: Iterable[UnparsedVersionVar],
prereleases: bool | None = None,
key: None = ...,
) -> Iterator[UnparsedVersionVar]: ...
@typing.overload
def filter(
self,
iterable: Iterable[T],
prereleases: bool | None = None,
key: Callable[[T], UnparsedVersion] = ...,
) -> Iterator[T]: ...
def filter(
self,
iterable: Iterable[Any],
prereleases: bool | None = None,
key: Callable[[Any], UnparsedVersion] | None = None,
) -> Iterator[Any]:
"""Filter items in the given iterable, that match the specifier.
:param iterable:
An iterable that can contain version strings and :class:`Version` instances.
The items in the iterable will be filtered according to the specifier.
:param prereleases:
Whether or not to allow prereleases in the returned iterator. If set to
``None`` (the default), it will follow the recommendation from :pep:`440`
and match prereleases if there are no other versions.
:param key:
A callable that takes a single argument (an item from the iterable) and
returns a version string or :class:`Version` instance to be used for
filtering.
>>> list(Specifier(">=1.2.3").filter(["1.2", "1.3", "1.5a1"]))
['1.3']
>>> list(Specifier(">=1.2.3").filter(["1.2", "1.2.3", "1.3", Version("1.4")]))
['1.2.3', '1.3', <Version('1.4')>]
>>> list(Specifier(">=1.2.3").filter(["1.2", "1.5a1"]))
['1.5a1']
>>> list(Specifier(">=1.2.3").filter(["1.3", "1.5a1"], prereleases=True))
['1.3', '1.5a1']
>>> list(Specifier(">=1.2.3", prereleases=True).filter(["1.3", "1.5a1"]))
['1.3', '1.5a1']
>>> list(Specifier(">=1.2.3").filter(
... [{"ver": "1.2"}, {"ver": "1.3"}],
... key=lambda x: x["ver"]))
[{'ver': '1.3'}]
"""
prereleases_versions = []
found_non_prereleases = False
# Determine if to include prereleases by default
include_prereleases = (
prereleases if prereleases is not None else self.prereleases
)
# Get the matching operator
operator_callable = self._get_operator(self.operator)
# Filter versions
for version in iterable:
parsed_version = _coerce_version(version if key is None else key(version))
match = False
if parsed_version is None:
# === operator can match arbitrary (non-version) strings
if self.operator == "===" and self._compare_arbitrary(
version, self.version
):
yield version
elif self.operator == "===":
match = self._compare_arbitrary(
version if key is None else key(version), self.version
)
else:
match = operator_callable(parsed_version, self.version)
if match and parsed_version is not None:
# If it's not a prerelease or prereleases are allowed, yield it directly
if not parsed_version.is_prerelease or include_prereleases:
found_non_prereleases = True
yield version
# Otherwise collect prereleases for potential later use
elif prereleases is None and self._prereleases is not False:
prereleases_versions.append(version)
# If no non-prereleases were found and prereleases weren't
# explicitly forbidden, yield the collected prereleases
if (
not found_non_prereleases
and prereleases is None
and self._prereleases is not False
):
yield from prereleases_versions
_prefix_regex = re.compile(r"([0-9]+)((?:a|b|c|rc)[0-9]+)")
def _pep440_filter_prereleases(
iterable: Iterable[Any], key: Callable[[Any], UnparsedVersion] | None
) -> Iterator[Any]:
"""Filter per PEP 440: exclude prereleases unless no finals exist."""
# Two lists used:
# * all_nonfinal to preserve order if no finals exist
# * arbitrary_strings for streaming when first final found
all_nonfinal: list[Any] = []
arbitrary_strings: list[Any] = []
found_final = False
for item in iterable:
parsed = _coerce_version(item if key is None else key(item))
if parsed is None:
# Arbitrary strings are always included as it is not
# possible to determine if they are prereleases,
# and they have already passed all specifiers.
if found_final:
yield item
else:
arbitrary_strings.append(item)
all_nonfinal.append(item)
continue
if not parsed.is_prerelease:
# Final release found - flush arbitrary strings, then yield
if not found_final:
yield from arbitrary_strings
found_final = True
yield item
continue
# Prerelease - buffer if no finals yet, otherwise skip
if not found_final:
all_nonfinal.append(item)
# No finals found - yield all buffered items
if not found_final:
yield from all_nonfinal
def _version_split(version: str) -> list[str]:
"""Split version into components.
The split components are intended for version comparison. The logic does
not attempt to retain the original version string, so joining the
components back with :func:`_version_join` may not produce the original
version string.
"""
result: list[str] = []
epoch, _, rest = version.rpartition("!")
result.append(epoch or "0")
for item in rest.split("."):
match = _prefix_regex.fullmatch(item)
if match:
result.extend(match.groups())
else:
result.append(item)
return result
def _version_join(components: list[str]) -> str:
"""Join split version components into a version string.
This function assumes the input came from :func:`_version_split`, where the
first component must be the epoch (either empty or numeric), and all other
components numeric.
"""
epoch, *rest = components
return f"{epoch}!{'.'.join(rest)}"
def _is_not_suffix(segment: str) -> bool:
return not any(
segment.startswith(prefix) for prefix in ("dev", "a", "b", "rc", "post")
)
def _numeric_prefix_len(split: list[str]) -> int:
"""Count leading numeric components in a :func:`_version_split` result.
>>> _numeric_prefix_len(["0", "1", "2", "a1"])
3
"""
count = 0
for segment in split:
if not segment.isdigit():
break
count += 1
return count
def _left_pad(split: list[str], target_numeric_len: int) -> list[str]:
"""Pad a :func:`_version_split` result with ``"0"`` segments to reach
``target_numeric_len`` numeric components. Suffix segments are preserved.
>>> _left_pad(["0", "1", "a1"], 4)
['0', '1', '0', '0', 'a1']
"""
numeric_len = _numeric_prefix_len(split)
pad_needed = target_numeric_len - numeric_len
if pad_needed <= 0:
return split
return [*split[:numeric_len], *(["0"] * pad_needed), *split[numeric_len:]]
def _operator_cost(op_entry: tuple[CallableOperator, str, str]) -> int:
"""Sort key for Cost Based Ordering of specifier operators in _filter_versions.
Operators run sequentially on a shrinking candidate set, so operators that
reject the most versions should run first to minimize work for later ones.
Tier 0: Exact equality (==, ===), likely to narrow candidates to one version
Tier 1: Range checks (>=, <=, >, <), cheap and usually reject a large portion
Tier 2: Wildcard equality (==.*) and compatible release (~=), more expensive
Tier 3: Exact !=, cheap but rarely rejects
Tier 4: Wildcard !=.*, expensive and rarely rejects
"""
_, ver, op = op_entry
if op == "==":
return 0 if not ver.endswith(".*") else 2
if op in (">=", "<=", ">", "<"):
return 1
if op == "~=":
return 2
if op == "!=":
return 3 if not ver.endswith(".*") else 4
if op == "===":
return 0
raise ValueError(f"Unknown operator: {op!r}") # pragma: no cover
class SpecifierSet(BaseSpecifier):
"""This class abstracts handling of a set of version specifiers.
It can be passed a single specifier (``>=3.0``), a comma-separated list of
specifiers (``>=3.0,!=3.1``), or no specifier at all.
Instances are safe to serialize with :mod:`pickle`. They use a stable
format so the same pickle can be loaded in future packaging
releases.
.. versionchanged:: 26.2
Added a stable pickle format. Pickles created with
packaging 26.2+ can be unpickled with future releases.
Backward compatibility with pickles from
packaging < 26.2 is supported but may be removed in a future
release.
"""
__slots__ = (
"_canonicalized",
"_has_arbitrary",
"_is_unsatisfiable",
"_prereleases",
"_resolved_ops",
"_specs",
)
def __init__(
self,
specifiers: str | Iterable[Specifier] = "",
prereleases: bool | None = None,
) -> None:
"""Initialize a SpecifierSet instance.
:param specifiers:
The string representation of a specifier or a comma-separated list of
specifiers which will be parsed and normalized before use.
May also be an iterable of ``Specifier`` instances, which will be used
as is.
:param prereleases:
This tells the SpecifierSet if it should accept prerelease versions if
applicable or not. The default of ``None`` will autodetect it from the
given specifiers.
:raises InvalidSpecifier:
If the given ``specifiers`` are not parseable than this exception will be
raised.
"""
if isinstance(specifiers, str):
# Split on `,` to break each individual specifier into its own item, and
# strip each item to remove leading/trailing whitespace.
split_specifiers = [s.strip() for s in specifiers.split(",") if s.strip()]
self._specs: tuple[Specifier, ...] = tuple(map(Specifier, split_specifiers))
# Fast substring check; avoids iterating parsed specs.
self._has_arbitrary = "===" in specifiers
else:
self._specs = tuple(specifiers)
# Substring check works for both Specifier objects and plain
# strings (setuptools passes lists of strings).
self._has_arbitrary = any("===" in str(s) for s in self._specs)
self._canonicalized = len(self._specs) <= 1
self._resolved_ops: list[tuple[CallableOperator, str, str]] | None = None
# Store our prereleases value so we can use it later to determine if
# we accept prereleases or not.
self._prereleases = prereleases
self._is_unsatisfiable: bool | None = None
def _canonical_specs(self) -> tuple[Specifier, ...]:
"""Deduplicate, sort, and cache specs for order-sensitive operations."""
if not self._canonicalized:
self._specs = tuple(dict.fromkeys(sorted(self._specs, key=str)))
self._canonicalized = True
self._resolved_ops = None
self._is_unsatisfiable = None
return self._specs
@property
def prereleases(self) -> bool | None:
# If we have been given an explicit prerelease modifier, then we'll
# pass that through here.
if self._prereleases is not None:
return self._prereleases
# If we don't have any specifiers, and we don't have a forced value,
# then we'll just return None since we don't know if this should have
# pre-releases or not.
if not self._specs:
return None
# Otherwise we'll see if any of the given specifiers accept
# prereleases, if any of them do we'll return True, otherwise False.
if any(s.prereleases for s in self._specs):
return True
return None
@prereleases.setter
def prereleases(self, value: bool | None) -> None:
self._prereleases = value
self._is_unsatisfiable = None
def __getstate__(self) -> tuple[tuple[Specifier, ...], bool | None]:
# Return state as a 2-item tuple for compactness:
# (specs, prereleases)
# Cache members are excluded and will be recomputed on demand.
return (self._specs, self._prereleases)
def __setstate__(self, state: object) -> None:
# Always discard cached values - they will be recomputed on demand.
self._resolved_ops = None
self._is_unsatisfiable = None
if isinstance(state, tuple):
if len(state) == 2:
# New format (26.2+): (specs, prereleases)
specs, prereleases = state
if (
isinstance(specs, tuple)
and all(isinstance(s, Specifier) for s in specs)
and _validate_pre(prereleases)
):
self._specs = specs
self._prereleases = prereleases
self._canonicalized = len(specs) <= 1
self._has_arbitrary = any("===" in str(s) for s in specs)
return
if len(state) == 2 and isinstance(state[1], dict):
# Format (packaging 26.0-26.1): (None, {slot: value}).
_, slot_dict = state
specs = slot_dict.get("_specs", ())
prereleases = slot_dict.get("_prereleases")
# Convert frozenset to tuple (26.0 stored as frozenset)
if isinstance(specs, frozenset):
specs = tuple(sorted(specs, key=str))
if (
isinstance(specs, tuple)
and all(isinstance(s, Specifier) for s in specs)
and _validate_pre(prereleases)
):
self._specs = specs
self._prereleases = prereleases
self._canonicalized = len(self._specs) <= 1
self._has_arbitrary = any("===" in str(s) for s in self._specs)
return
if isinstance(state, dict):
# Old format (packaging <= 25.x, no __slots__): state is a plain dict.
specs = state.get("_specs", ())
prereleases = state.get("_prereleases")
# Convert frozenset to tuple (26.0 stored as frozenset)
if isinstance(specs, frozenset):
specs = tuple(sorted(specs, key=str))
if (
isinstance(specs, tuple)
and all(isinstance(s, Specifier) for s in specs)
and _validate_pre(prereleases)
):
self._specs = specs
self._prereleases = prereleases
self._canonicalized = len(self._specs) <= 1
self._has_arbitrary = any("===" in str(s) for s in self._specs)
return
raise TypeError(f"Cannot restore SpecifierSet from {state!r}")
def __repr__(self) -> str:
"""A representation of the specifier set that shows all internal state.
Note that the ordering of the individual specifiers within the set may not
match the input string.
>>> SpecifierSet('>=1.0.0,!=2.0.0')
<SpecifierSet('!=2.0.0,>=1.0.0')>
>>> SpecifierSet('>=1.0.0,!=2.0.0', prereleases=False)
<SpecifierSet('!=2.0.0,>=1.0.0', prereleases=False)>
>>> SpecifierSet('>=1.0.0,!=2.0.0', prereleases=True)
<SpecifierSet('!=2.0.0,>=1.0.0', prereleases=True)>
"""
pre = (
f", prereleases={self.prereleases!r}"
if self._prereleases is not None
else ""
)
return f"<{self.__class__.__name__}({str(self)!r}{pre})>"
def __str__(self) -> str:
"""A string representation of the specifier set that can be round-tripped.
Note that the ordering of the individual specifiers within the set may not
match the input string.
>>> str(SpecifierSet(">=1.0.0,!=1.0.1"))
'!=1.0.1,>=1.0.0'
>>> str(SpecifierSet(">=1.0.0,!=1.0.1", prereleases=False))
'!=1.0.1,>=1.0.0'
"""
return ",".join(str(s) for s in self._canonical_specs())
def __hash__(self) -> int:
return hash(self._canonical_specs())
def __and__(self, other: SpecifierSet | str) -> SpecifierSet:
"""Return a SpecifierSet which is a combination of the two sets.
:param other: The other object to combine with.
>>> SpecifierSet(">=1.0.0,!=1.0.1") & '<=2.0.0,!=2.0.1'
<SpecifierSet('!=1.0.1,!=2.0.1,<=2.0.0,>=1.0.0')>
>>> SpecifierSet(">=1.0.0,!=1.0.1") & SpecifierSet('<=2.0.0,!=2.0.1')
<SpecifierSet('!=1.0.1,!=2.0.1,<=2.0.0,>=1.0.0')>
"""
if isinstance(other, str):
other = SpecifierSet(other)
elif not isinstance(other, SpecifierSet):
return NotImplemented
specifier = SpecifierSet()
specifier._specs = self._specs + other._specs
specifier._canonicalized = len(specifier._specs) <= 1
specifier._has_arbitrary = self._has_arbitrary or other._has_arbitrary
specifier._resolved_ops = None
# Combine prerelease settings: use common or non-None value
if self._prereleases is None or self._prereleases == other._prereleases:
specifier._prereleases = other._prereleases
elif other._prereleases is None:
specifier._prereleases = self._prereleases
else:
raise ValueError(
"Cannot combine SpecifierSets with True and False prerelease overrides."
)
return specifier
def __eq__(self, other: object) -> bool:
"""Whether or not the two SpecifierSet-like objects are equal.
:param other: The other object to check against.
The value of :attr:`prereleases` is ignored.
>>> SpecifierSet(">=1.0.0,!=1.0.1") == SpecifierSet(">=1.0.0,!=1.0.1")
True
>>> (SpecifierSet(">=1.0.0,!=1.0.1", prereleases=False) ==
... SpecifierSet(">=1.0.0,!=1.0.1", prereleases=True))
True
>>> SpecifierSet(">=1.0.0,!=1.0.1") == ">=1.0.0,!=1.0.1"
True
>>> SpecifierSet(">=1.0.0,!=1.0.1") == SpecifierSet(">=1.0.0")
False
>>> SpecifierSet(">=1.0.0,!=1.0.1") == SpecifierSet(">=1.0.0,!=1.0.2")
False
"""
if isinstance(other, (str, Specifier)):
other = SpecifierSet(str(other))
elif not isinstance(other, SpecifierSet):
return NotImplemented
return self._canonical_specs() == other._canonical_specs()
def __len__(self) -> int:
"""Returns the number of specifiers in this specifier set."""
return len(self._specs)
def __iter__(self) -> Iterator[Specifier]:
"""
Returns an iterator over all the underlying :class:`Specifier` instances
in this specifier set.
>>> sorted(SpecifierSet(">=1.0.0,!=1.0.1"), key=str)
[<Specifier('!=1.0.1')>, <Specifier('>=1.0.0')>]
"""
return iter(self._specs)
def _get_ranges(self) -> Sequence[_VersionRange]:
"""Intersect all specifiers into a single list of version ranges.
Returns an empty list when unsatisfiable. ``===`` specs are
modeled as full range; string matching is checked separately
by :meth:`_check_arbitrary_unsatisfiable`.
"""
specs = self._specs
result: Sequence[_VersionRange] | None = None
for s in specs:
if result is None:
result = s._to_ranges()
else:
result = _intersect_ranges(result, s._to_ranges())
if not result:
break
if result is None: # pragma: no cover
raise RuntimeError("_get_ranges called with no specs")
return result
def is_unsatisfiable(self) -> bool:
"""Check whether this specifier set can never be satisfied.
Returns True if no version can satisfy all specifiers simultaneously.
>>> SpecifierSet(">=2.0,<1.0").is_unsatisfiable()
True
>>> SpecifierSet(">=1.0,<2.0").is_unsatisfiable()
False
>>> SpecifierSet("").is_unsatisfiable()
False
>>> SpecifierSet("==1.0,!=1.0").is_unsatisfiable()
True
"""
cached = self._is_unsatisfiable
if cached is not None:
return cached
if not self._specs:
self._is_unsatisfiable = False
return False
result = not self._get_ranges()
if not result:
result = self._check_arbitrary_unsatisfiable()
if not result and self.prereleases is False:
result = self._check_prerelease_only_ranges()
self._is_unsatisfiable = result
return result
def _check_prerelease_only_ranges(self) -> bool:
"""With prereleases=False, check if every range contains only
pre-release versions (which would be excluded from matching)."""
for lower, upper in self._get_ranges():
nearest = _nearest_non_prerelease(lower.version)
if nearest is None:
return False
if upper.version is None or nearest < upper.version:
return False
if nearest == upper.version and upper.inclusive:
return False
return True
def _check_arbitrary_unsatisfiable(self) -> bool:
"""Check === (arbitrary equality) specs for unsatisfiability.
=== uses case-insensitive string comparison, so the only candidate
that can match ``===V`` is the literal string V. This method
checks whether that candidate is excluded by other specifiers.
"""
arbitrary = [s for s in self._specs if s.operator == "==="]
if not arbitrary:
return False
# Multiple === must agree on the same string (case-insensitive).
first = arbitrary[0].version.lower()
if any(s.version.lower() != first for s in arbitrary[1:]):
return True
# The sole candidate is the === version string. Check whether
# it can satisfy every standard spec.
candidate = _coerce_version(arbitrary[0].version)
# With prereleases=False, a prerelease candidate is excluded
# by contains() before the === string check even runs.
if (
self.prereleases is False
and candidate is not None
and candidate.is_prerelease
):
return True
standard = [s for s in self._specs if s.operator != "==="]
if not standard:
return False
if candidate is None:
# Unparsable string cannot satisfy any standard spec.
return True
return not all(s.contains(candidate) for s in standard)
def __contains__(self, item: UnparsedVersion) -> bool:
"""Return whether or not the item is contained in this specifier.
:param item: The item to check for.
This is used for the ``in`` operator and behaves the same as
:meth:`contains` with no ``prereleases`` argument passed.
>>> "1.2.3" in SpecifierSet(">=1.0.0,!=1.0.1")
True
>>> Version("1.2.3") in SpecifierSet(">=1.0.0,!=1.0.1")
True
>>> "1.0.1" in SpecifierSet(">=1.0.0,!=1.0.1")
False
>>> "1.3.0a1" in SpecifierSet(">=1.0.0,!=1.0.1")
True
>>> "1.3.0a1" in SpecifierSet(">=1.0.0,!=1.0.1", prereleases=True)
True
"""
return self.contains(item)
def contains(
self,
item: UnparsedVersion,
prereleases: bool | None = None,
installed: bool | None = None,
) -> bool:
"""Return whether or not the item is contained in this SpecifierSet.
:param item:
The item to check for, which can be a version string or a
:class:`Version` instance.
:param prereleases:
Whether or not to match prereleases with this SpecifierSet. If set to
``None`` (the default), it will follow the recommendation from :pep:`440`
and match prereleases, as there are no other versions.
:param installed:
Whether or not the item is installed. If set to ``True``, it will
accept prerelease versions even if the specifier does not allow them.
>>> SpecifierSet(">=1.0.0,!=1.0.1").contains("1.2.3")
True
>>> SpecifierSet(">=1.0.0,!=1.0.1").contains(Version("1.2.3"))
True
>>> SpecifierSet(">=1.0.0,!=1.0.1").contains("1.0.1")
False
>>> SpecifierSet(">=1.0.0,!=1.0.1").contains("1.3.0a1")
True
>>> SpecifierSet(">=1.0.0,!=1.0.1", prereleases=False).contains("1.3.0a1")
False
>>> SpecifierSet(">=1.0.0,!=1.0.1").contains("1.3.0a1", prereleases=True)
True
"""
version = _coerce_version(item)
if version is not None and installed and version.is_prerelease:
prereleases = True
# When item is a string and === is involved, keep it as-is
# so the comparison isn't done against the normalized form.
if version is None or (self._has_arbitrary and not isinstance(item, Version)):
check_item = item
else:
check_item = version
return bool(list(self.filter([check_item], prereleases=prereleases)))
@typing.overload
def filter(
self,
iterable: Iterable[UnparsedVersionVar],
prereleases: bool | None = None,
key: None = ...,
) -> Iterator[UnparsedVersionVar]: ...
@typing.overload
def filter(
self,
iterable: Iterable[T],
prereleases: bool | None = None,
key: Callable[[T], UnparsedVersion] = ...,
) -> Iterator[T]: ...
def filter(
self,
iterable: Iterable[Any],
prereleases: bool | None = None,
key: Callable[[Any], UnparsedVersion] | None = None,
) -> Iterator[Any]:
"""Filter items in the given iterable, that match the specifiers in this set.
:param iterable:
An iterable that can contain version strings and :class:`Version` instances.
The items in the iterable will be filtered according to the specifier.
:param prereleases:
Whether or not to allow prereleases in the returned iterator. If set to
``None`` (the default), it will follow the recommendation from :pep:`440`
and match prereleases if there are no other versions.
:param key:
A callable that takes a single argument (an item from the iterable) and
returns a version string or :class:`Version` instance to be used for
filtering.
>>> list(SpecifierSet(">=1.2.3").filter(["1.2", "1.3", "1.5a1"]))
['1.3']
>>> list(SpecifierSet(">=1.2.3").filter(["1.2", "1.3", Version("1.4")]))
['1.3', <Version('1.4')>]
>>> list(SpecifierSet(">=1.2.3").filter(["1.2", "1.5a1"]))
['1.5a1']
>>> list(SpecifierSet(">=1.2.3").filter(["1.3", "1.5a1"], prereleases=True))
['1.3', '1.5a1']
>>> list(SpecifierSet(">=1.2.3", prereleases=True).filter(["1.3", "1.5a1"]))
['1.3', '1.5a1']
>>> list(SpecifierSet(">=1.2.3").filter(
... [{"ver": "1.2"}, {"ver": "1.3"}],
... key=lambda x: x["ver"]))
[{'ver': '1.3'}]
An "empty" SpecifierSet will filter items based on the presence of prerelease
versions in the set.
>>> list(SpecifierSet("").filter(["1.3", "1.5a1"]))
['1.3']
>>> list(SpecifierSet("").filter(["1.5a1"]))
['1.5a1']
>>> list(SpecifierSet("", prereleases=True).filter(["1.3", "1.5a1"]))
['1.3', '1.5a1']
>>> list(SpecifierSet("").filter(["1.3", "1.5a1"], prereleases=True))
['1.3', '1.5a1']
"""
# Determine if we're forcing a prerelease or not, if we're not forcing
# one for this particular filter call, then we'll use whatever the
# SpecifierSet thinks for whether or not we should support prereleases.
if prereleases is None and self.prereleases is not None:
prereleases = self.prereleases
# Filter versions that match all specifiers using Cost Based Ordering.
if self._specs:
# When prereleases is None, we need to let all versions through
# the individual filters, then decide about prereleases at the end
# based on whether any non-prereleases matched ALL specs.
# Fast path: single specifier, delegate directly.
if len(self._specs) == 1:
filtered = self._specs[0].filter(
iterable,
prereleases=True if prereleases is None else prereleases,
key=key,
)
else:
filtered = self._filter_versions(
iterable,
key,
prereleases=True if prereleases is None else prereleases,
)
if prereleases is not None:
return filtered
return _pep440_filter_prereleases(filtered, key)
# Handle Empty SpecifierSet.
if prereleases is True:
return iter(iterable)
if prereleases is False:
return (
item
for item in iterable
if (
(version := _coerce_version(item if key is None else key(item)))
is None
or not version.is_prerelease
)
)
# PEP 440: exclude prereleases unless no final releases matched
return _pep440_filter_prereleases(iterable, key)
def _filter_versions(
self,
iterable: Iterable[Any],
key: Callable[[Any], UnparsedVersion] | None,
prereleases: bool | None = None,
) -> Iterator[Any]:
"""Filter versions against all specifiers in a single pass.
Uses Cost Based Ordering: specifiers are sorted by _operator_cost so
that cheap range operators reject versions early, avoiding expensive
wildcard or compatible operators on versions that would have been
rejected anyway.
"""
# Pre-resolve operators and sort (cached after first call).
if self._resolved_ops is None:
self._resolved_ops = sorted(
(
(spec._get_operator(spec.operator), spec.version, spec.operator)
for spec in self._specs
),
key=_operator_cost,
)
ops = self._resolved_ops
exclude_prereleases = prereleases is False
for item in iterable:
parsed = _coerce_version(item if key is None else key(item))
if parsed is None:
# Only === can match non-parseable versions.
if all(
op == "===" and str(item).lower() == ver.lower()
for _, ver, op in ops
):
yield item
elif exclude_prereleases and parsed.is_prerelease:
pass
elif all(
str(item if key is None else key(item)).lower() == ver.lower()
if op == "==="
else op_fn(parsed, ver)
for op_fn, ver, op in ops
):
# Short-circuits on the first failing operator.
yield item
|