pip._vendor.packaging.version Namespace Reference

Data Structures
class	_BaseVersion
class	InvalidVersion
class	LegacyVersion
class	Version

Functions
Union["LegacyVersion", "Version"]	parse (str version)
Iterator[str]	_parse_version_parts (str s)
LegacyCmpKey	_legacy_cmpkey (str version)
Optional[Tuple[str, int]]	_parse_letter_version (str letter, Union[str, bytes, SupportsInt] number)
Optional[LocalType]	_parse_local_version (str local)
CmpKey	_cmpkey (int epoch, Tuple[int,...] release, Optional[Tuple[str, int]] pre, Optional[Tuple[str, int]] post, Optional[Tuple[str, int]] dev, Optional[Tuple[SubLocalType]] local)

Variables
	InfiniteTypes = Union[InfinityType, NegativeInfinityType]
	PrePostDevType = Union[InfiniteTypes, Tuple[str, int]]
	SubLocalType = Union[InfiniteTypes, int, str]
	LocalType
	CmpKey
	LegacyCmpKey = Tuple[int, Tuple[str, ...]]
	VersionComparisonMethod
	_Version
	_legacy_version_component_re = re.compile(r"(\d+ | [a-z]+ | \.| -)", re.VERBOSE)
dict	_legacy_version_replacement_map
str	VERSION_PATTERN
	_local_version_separators = re.compile(r"[\._-]")

Function Documentation

_cmpkey()

CmpKey _cmpkey ( int  epoch, Tuple[int, ...]  release, Optional[Tuple[str, int]]  pre, Optional[Tuple[str, int]]  post, Optional[Tuple[str, int]]  dev, Optional[Tuple[SubLocalType]]  local  )

protected

Definition at line 444 of file version.py.

) -> CmpKey:
 
    # When we compare a release version, we want to compare it with all of the
    # trailing zeros removed. So we'll use a reverse the list, drop all the now
    # leading zeros until we come to something non zero, then take the rest
    # re-reverse it back into the correct order and make it a tuple and use
    # that for our sorting key.
    _release = tuple(
        reversed(list(itertools.dropwhile(lambda x: x == 0, reversed(release))))
    )
 
    # We need to "trick" the sorting algorithm to put 1.0.dev0 before 1.0a0.
    # We'll do this by abusing the pre segment, but we _only_ want to do this
    # if there is not a pre or a post segment. If we have one of those then
    # the normal sorting rules will handle this case correctly.
    if pre is None and post is None and dev is not None:
        _pre: PrePostDevType = NegativeInfinity
    # Versions without a pre-release (except as noted above) should sort after
    # those with one.
    elif pre is None:
        _pre = Infinity
    else:
        _pre = pre
 
    # Versions without a post segment should sort before those with one.
    if post is None:
        _post: PrePostDevType = NegativeInfinity
 
    else:
        _post = post
 
    # Versions without a development segment should sort after those with one.
    if dev is None:
        _dev: PrePostDevType = Infinity
 
    else:
        _dev = dev
 
    if local is None:
        # Versions without a local segment should sort before those with one.
        _local: LocalType = NegativeInfinity
    else:
        # Versions with a local segment need that segment parsed to implement
        # the sorting rules in PEP440.
        # - Alpha numeric segments sort before numeric segments
        # - Alpha numeric segments sort lexicographically
        # - Numeric segments sort numerically
        # - Shorter versions sort before longer versions when the prefixes
        #   match exactly
        _local = tuple(
            (i, "") if isinstance(i, int) else (NegativeInfinity, i) for i in local
        )
 
    return epoch, _release, _pre, _post, _dev, _local

References i.

_legacy_cmpkey()

LegacyCmpKey _legacy_cmpkey ( str  version )

protected

Definition at line 196 of file version.py.

def _legacy_cmpkey(version: str) -> LegacyCmpKey:
 
    # We hardcode an epoch of -1 here. A PEP 440 version can only have a epoch
    # greater than or equal to 0. This will effectively put the LegacyVersion,
    # which uses the defacto standard originally implemented by setuptools,
    # as before all PEP 440 versions.
    epoch = -1
 
    # This scheme is taken from pkg_resources.parse_version setuptools prior to
    # it's adoption of the packaging library.
    parts: List[str] = []
    for part in _parse_version_parts(version.lower()):
        if part.startswith("*"):
            # remove "-" before a prerelease tag
            if part < "*final":
                while parts and parts[-1] == "*final-":
                    parts.pop()
 
            # remove trailing zeros from each series of numeric parts
            while parts and parts[-1] == "00000000":
                parts.pop()
 
        parts.append(part)
 
    return epoch, tuple(parts)
 
 
# Deliberately not anchored to the start and end of the string, to make it
# easier for 3rd party code to reuse

References pip._vendor.packaging.version._parse_version_parts(), and i.

Here is the call graph for this function:

_parse_letter_version()

Optional[Tuple[str, int]] _parse_letter_version ( str  letter, Union[str, bytes, SupportsInt]   number  )

protected

Definition at line 393 of file version.py.

) -> Optional[Tuple[str, int]]:
 
    if letter:
        # We consider there to be an implicit 0 in a pre-release if there is
        # not a numeral associated with it.
        if number is None:
            number = 0
 
        # We normalize any letters to their lower case form
        letter = letter.lower()
 
        # We consider some words to be alternate spellings of other words and
        # in those cases we want to normalize the spellings to our preferred
        # spelling.
        if letter == "alpha":
            letter = "a"
        elif letter == "beta":
            letter = "b"
        elif letter in ["c", "pre", "preview"]:
            letter = "rc"
        elif letter in ["rev", "r"]:
            letter = "post"
 
        return letter, int(number)
    if not letter and number:
        # We assume if we are given a number, but we are not given a letter
        # then this is using the implicit post release syntax (e.g. 1.0-1)
        letter = "post"
 
        return letter, int(number)
 
    return None
 
 

References i.

_parse_local_version()

Optional[LocalType] _parse_local_version ( str  local )

protected

Takes a string like abc.1.twelve and turns it into ("abc", 1, "twelve").

Definition at line 432 of file version.py.

def _parse_local_version(local: str) -> Optional[LocalType]:
    """
    Takes a string like abc.1.twelve and turns it into ("abc", 1, "twelve").
    """
    if local is not None:
        return tuple(
            part.lower() if not part.isdigit() else int(part)
            for part in _local_version_separators.split(local)
        )
    return None
 
 

References i.

_parse_version_parts()

Iterator[str] _parse_version_parts ( str  s )

protected

Definition at line 179 of file version.py.

def _parse_version_parts(s: str) -> Iterator[str]:
    for part in _legacy_version_component_re.split(s):
        part = _legacy_version_replacement_map.get(part, part)
 
        if not part or part == ".":
            continue
 
        if part[:1] in "0123456789":
            # pad for numeric comparison
            yield part.zfill(8)
        else:
            yield "*" + part
 
    # ensure that alpha/beta/candidate are before final
    yield "*final"
 
 

References i.

Referenced by pip._vendor.packaging.version._legacy_cmpkey().

Here is the caller graph for this function:

parse()

Union["LegacyVersion", "Version"] parse

(

str

version

)

Parse the given version string and return either a :class:`Version` object
or a :class:`LegacyVersion` object depending on if the given version is
a valid PEP 440 version or a legacy version.

Definition at line 42 of file version.py.

def parse(version: str) -> Union["LegacyVersion", "Version"]:
    """
    Parse the given version string and return either a :class:`Version` object
    or a :class:`LegacyVersion` object depending on if the given version is
    a valid PEP 440 version or a legacy version.
    """
    try:
        return Version(version)
    except InvalidVersion:
        return LegacyVersion(version)
 
 

Variable Documentation

_legacy_version_component_re

_legacy_version_component_re = re.compile(r"(\d+ | [a-z]+ | \.| -)", re.VERBOSE)

protected

Definition at line 168 of file version.py.

_legacy_version_replacement_map

dict _legacy_version_replacement_map

protected

Initial value:

=  {
    "pre": "c",
    "preview": "c",
    "-": "final-",
    "rc": "c",
    "dev": "@",
}

Definition at line 170 of file version.py.

_local_version_separators

_local_version_separators = re.compile(r"[\._-]")

protected

Definition at line 429 of file version.py.

_Version

_Version

protected

Initial value:

=  collections.namedtuple(
    "_Version", ["epoch", "release", "dev", "pre", "post", "local"]
)

Definition at line 37 of file version.py.

CmpKey

CmpKey

Initial value:

=  Tuple[
    int, Tuple[int, ...], PrePostDevType, PrePostDevType, PrePostDevType, LocalType
]

Definition at line 29 of file version.py.

InfiniteTypes

InfiniteTypes = Union[InfinityType, NegativeInfinityType]

Definition at line 15 of file version.py.

LegacyCmpKey

LegacyCmpKey = Tuple[int, Tuple[str, ...]]

Definition at line 32 of file version.py.

LocalType

LocalType

Initial value:

=  Union[
    NegativeInfinityType,
    Tuple[
        Union[
            SubLocalType,
            Tuple[SubLocalType, str],
            Tuple[NegativeInfinityType, SubLocalType],
        ],
        ...,
    ],
]

Definition at line 18 of file version.py.

PrePostDevType

PrePostDevType = Union[InfiniteTypes, Tuple[str, int]]

Definition at line 16 of file version.py.

SubLocalType

SubLocalType = Union[InfiniteTypes, int, str]

Definition at line 17 of file version.py.

VERSION_PATTERN

str VERSION_PATTERN

Initial value:

=  r"""
    v?
    (?:
        (?:(?P<epoch>[0-9]+)!)?                           # epoch
        (?P<release>[0-9]+(?:\.[0-9]+)*)                  # release segment
        (?P<pre>                                          # pre-release
            [-_\.]?
            (?P<pre_l>(a|b|c|rc|alpha|beta|pre|preview))
            [-_\.]?
            (?P<pre_n>[0-9]+)?
        )?
        (?P<post>                                         # post release
            (?:-(?P<post_n1>[0-9]+))
            |
            (?:
                [-_\.]?
                (?P<post_l>post|rev|r)
                [-_\.]?
                (?P<post_n2>[0-9]+)?
            )
        )?
        (?P<dev>                                          # dev release
            [-_\.]?
            (?P<dev_l>dev)
            [-_\.]?
            (?P<dev_n>[0-9]+)?
        )?
    )
    (?:\+(?P<local>[a-z0-9]+(?:[-_\.][a-z0-9]+)*))?       # local version
"""

Definition at line 225 of file version.py.

VersionComparisonMethod

VersionComparisonMethod

Initial value:

=  Callable[
    [Union[CmpKey, LegacyCmpKey], Union[CmpKey, LegacyCmpKey]], bool
]

Definition at line 33 of file version.py.