GitHub

SemVerRange

API reference for SemVerRange.

A parsed range; build one with parse or the constructors.

Functions

__init__

__init__(sets) -> None
ParameterTypeDescription
setstuple[tuple[_Clause, ...], ...]
def __init__(self, sets: tuple[tuple[_Clause, ...], ...]) -> None:
    self._sets = sets

format

format() -> str

The normalized text: 1.x is 1, >= 1.2.3 is >=1.2.3.

Returns str

def format(self) -> str:
    """The normalized text: ``1.x`` is ``1``, ``>= 1.2.3`` is ``>=1.2.3``."""
    return " || ".join(" ".join(map(_format_clause, s)) for s in self._sets)

matches

matches(version, *, include_prerelease=False) -> bool

Whether version is in the range; raises SemVerError for an invalid version.

ParameterTypeDescription
versionVersionInput
include_prereleasebool = False

Returns bool

def matches(self, version: VersionInput, *, include_prerelease: bool = False) -> bool:
    """Whether ``version`` is in the range; raises ``SemVerError`` for
    an invalid version."""
    return self._test(version_from_input_unsafe(version), include_prerelease)

max_satisfying

max_satisfying(versions, *, include_prerelease=False) -> SemVer | None

The highest version in the range (the first of equal ones).

ParameterTypeDescription
versionsIterable[VersionInput]
include_prereleasebool = False

Returns SemVer | None

def max_satisfying(
    self, versions: Iterable[VersionInput], *, include_prerelease: bool = False
) -> SemVer | None:
    """The highest version in the range (the first of equal ones)."""
    return self._select(versions, include_prerelease, 1)

min_satisfying

min_satisfying(versions, *, include_prerelease=False) -> SemVer | None

The lowest version in the range (the first of equal ones).

ParameterTypeDescription
versionsIterable[VersionInput]
include_prereleasebool = False

Returns SemVer | None

def min_satisfying(
    self, versions: Iterable[VersionInput], *, include_prerelease: bool = False
) -> SemVer | None:
    """The lowest version in the range (the first of equal ones)."""
    return self._select(versions, include_prerelease, -1)