A parsed range; build one with parse or the constructors.
Functions#
__init__#
__init__(sets) -> None| Parameter | Type | Description |
|---|---|---|
sets | tuple[tuple[_Clause, ...], ...] |
def __init__(self, sets: tuple[tuple[_Clause, ...], ...]) -> None:
self._sets = setsformat#
format() -> strThe 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) -> boolWhether version is in the range; raises SemVerError for
an invalid version.
| Parameter | Type | Description |
|---|---|---|
version | VersionInput | |
include_prerelease | bool = 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 | NoneThe highest version in the range (the first of equal ones).
| Parameter | Type | Description |
|---|---|---|
versions | Iterable[VersionInput] | |
include_prerelease | bool = 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 | NoneThe lowest version in the range (the first of equal ones).
| Parameter | Type | Description |
|---|---|---|
versions | Iterable[VersionInput] | |
include_prerelease | bool = 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)