Specifiers

Specifier

Bases: Representation, ToString, Specification

Represents all possible specifiers.

Source code in versions/specifiers.py

class Specifier(Representation, ToString, Specification):
    """Represents all possible specifiers."""

SpecifierNever

Bases: Specifier

Represents specifiers that do not accept any versions.

Source code in versions/specifiers.py

@frozen(repr=False)
class SpecifierNever(Specifier):
    """Represents specifiers that do not accept any versions."""

    def accepts(self, version: Version) -> Literal[False]:
        return False

    def to_string(self) -> str:
        return EMPTY_VERSION

SpecifierAlways

Bases: Specifier

Represents specifiers that accept all versions.

Source code in versions/specifiers.py

@frozen(repr=False)
class SpecifierAlways(Specifier):
    """Represents specifiers that accept all versions."""

    def accepts(self, version: Version) -> Literal[True]:
        return True

    def to_string(self) -> str:
        return UNIVERSE_VERSION

SpecifierOne

Bases: Operator, Specifier

Represents specifiers that accept versions according to the Operator type.

Source code in versions/specifiers.py

@frozen(repr=False)
class SpecifierOne(Operator, Specifier):
    """Represents specifiers that accept versions according to the
    [`Operator`][versions.operators.Operator] type.
    """

    def accepts(self, version: Version) -> bool:
        return self.partial_matches(version)

SpecifierAny

Bases: Specifier

Represents collections of two or more specifiers that accept versions if any of the contained specifiers accept it.

Source code in versions/specifiers.py

@frozen(repr=False)
class SpecifierAny(Specifier):
    """Represents collections of two or more specifiers that accept versions
    if *any* of the contained specifiers accept it.
    """

    WRAP: ClassVar[bool] = False

    specifiers: Specifiers = field()

    @specifiers.validator
    def check_specifiers(self, attribute: Attribute[Specifiers], specifiers: Specifiers) -> None:
        check_specifiers(specifiers)

    @classmethod
    def of_specifiers(cls, specifiers: Specifiers) -> Specifier:
        if not specifiers:
            return SpecifierNever()

        if contains_only_item(specifiers):
            return first(specifiers)

        return cls(specifiers)

    @classmethod
    def of(cls, *specifiers: Specifier) -> Specifier:
        return cls.of_specifiers(specifiers)

    @classmethod
    def of_iterable(cls, iterable: Iterable[Specifier]) -> Specifier:
        return cls.of_specifiers(tuple(iterable))

    def accepts(self, version: Version) -> bool:
        return any(specifier.accepts(version) for specifier in self.specifiers)

    def to_string(self) -> str:
        return create_wrap_around(
            concat_pipes_spaced(specifier.to_string() for specifier in self.specifiers)
        )

    def to_short_string(self) -> str:
        return create_wrap_around(
            concat_pipes(specifier.to_short_string() for specifier in self.specifiers)
        )

SpecifierAll

Bases: Specifier

Represents collections of two or more specifiers that accept versions if and only if all of the contained specifiers accept it.

Source code in versions/specifiers.py

@frozen(repr=False)
class SpecifierAll(Specifier):
    """Represents collections of two or more specifiers that accept versions
    if and only if *all* of the contained specifiers accept it.
    """

    WRAP: ClassVar[bool] = False

    specifiers: Specifiers = field()

    @specifiers.validator
    def check_specifiers(self, attribute: Attribute[Specifiers], specifiers: Specifiers) -> None:
        check_specifiers(specifiers)

    @classmethod
    def of_specifiers(cls, specifiers: Specifiers) -> Specifier:
        if not specifiers:
            return SpecifierAlways()

        if contains_only_item(specifiers):
            return first(specifiers)

        return cls(specifiers)

    @classmethod
    def of(cls, *specifiers: Specifier) -> Specifier:
        return cls.of_specifiers(specifiers)

    @classmethod
    def of_iterable(cls, iterable: Iterable[Specifier]) -> Specifier:
        return cls.of_specifiers(tuple(iterable))

    def accepts(self, version: Version) -> bool:
        return all(specifier.accepts(version) for specifier in self.specifiers)

    def to_string(self) -> str:
        return create_wrap_around(
            concat_comma_space(specifier.to_string() for specifier in self.specifiers)
        )

    def to_short_string(self) -> str:
        return create_wrap_around(
            concat_comma(specifier.to_short_string() for specifier in self.specifiers)
        )

is_specifier(item: Any) -> TypeGuard[Specifier]

Checks if an item is an instance of Specifier.

Parameters:

Name	Type	Description	Default
item	Any	The item to check.	required

Returns:

Type	Description
TypeGuard[Specifier]	Whether the item provided is an instance of Specifier.

Source code in versions/specifiers.py

def is_specifier(item: Any) -> TypeGuard[Specifier]:
    """Checks if an `item` is an instance of [`Specifier`][versions.specifiers.Specifier].

    Arguments:
        item: The item to check.

    Returns:
        Whether the `item` provided is an instance of [`Specifier`][versions.specifiers.Specifier].
    """
    return is_instance(item, Specifier)

is_specifier_never(item: Any) -> TypeGuard[SpecifierNever]

Checks if an item is an instance of SpecifierNever.

Parameters:

Name	Type	Description	Default
item	Any	The item to check.	required

Returns:

Type	Description
TypeGuard[SpecifierNever]	Whether the item provided is an instance of SpecifierNever.

Source code in versions/specifiers.py

def is_specifier_never(item: Any) -> TypeGuard[SpecifierNever]:
    """Checks if an `item` is an instance of
    [`SpecifierNever`][versions.specifiers.SpecifierNever].

    Arguments:
        item: The item to check.

    Returns:
        Whether the `item` provided is an instance of
            [`SpecifierNever`][versions.specifiers.SpecifierNever].
    """
    return is_instance(item, SpecifierNever)

is_specifier_always(item: Any) -> TypeGuard[SpecifierAlways]

Checks if an item is an instance of SpecifierAlways.

Parameters:

Name	Type	Description	Default
item	Any	The item to check.	required

Returns:

Type	Description
TypeGuard[SpecifierAlways]	Whether the item provided is an instance of SpecifierAlways.

Source code in versions/specifiers.py

def is_specifier_always(item: Any) -> TypeGuard[SpecifierAlways]:
    """Checks if an `item` is an instance of
    [`SpecifierAlways`][versions.specifiers.SpecifierAlways].

    Arguments:
        item: The item to check.

    Returns:
        Whether the `item` provided is an instance of
            [`SpecifierAlways`][versions.specifiers.SpecifierAlways].
    """
    return is_instance(item, SpecifierAlways)

is_specifier_one(item: Any) -> TypeGuard[SpecifierOne]

Checks if an item is an instance of SpecifierOne.

Parameters:

Name	Type	Description	Default
item	Any	The item to check.	required

Returns:

Type	Description
TypeGuard[SpecifierOne]	Whether the item provided is an instance of SpecifierOne.

Source code in versions/specifiers.py

def is_specifier_one(item: Any) -> TypeGuard[SpecifierOne]:
    """Checks if an `item` is an instance of
    [`SpecifierOne`][versions.specifiers.SpecifierOne].

    Arguments:
        item: The item to check.

    Returns:
        Whether the `item` provided is an instance of
            [`SpecifierOne`][versions.specifiers.SpecifierOne].
    """
    return is_instance(item, SpecifierOne)

is_specifier_any(item: Any) -> TypeGuard[SpecifierAny]

Checks if an item is an instance of SpecifierAny.

Parameters:

Name	Type	Description	Default
item	Any	The item to check.	required

Returns:

Type	Description
TypeGuard[SpecifierAny]	Whether the item provided is an instance of SpecifierAny.

Source code in versions/specifiers.py

def is_specifier_any(item: Any) -> TypeGuard[SpecifierAny]:
    """Checks if an `item` is an instance of
    [`SpecifierAny`][versions.specifiers.SpecifierAny].

    Arguments:
        item: The item to check.

    Returns:
        Whether the `item` provided is an instance of
            [`SpecifierAny`][versions.specifiers.SpecifierAny].
    """
    return is_instance(item, SpecifierAny)

is_specifier_all(item: Any) -> TypeGuard[SpecifierAll]

Checks if an item is an instance of SpecifierAll.

Parameters:

Name	Type	Description	Default
item	Any	The item to check.	required

Returns:

Type	Description
TypeGuard[SpecifierAll]	Whether the item provided is an instance of SpecifierAll.

Source code in versions/specifiers.py

def is_specifier_all(item: Any) -> TypeGuard[SpecifierAll]:
    """Checks if an `item` is an instance of
    [`SpecifierAll`][versions.specifiers.SpecifierAll].

    Arguments:
        item: The item to check.

    Returns:
        Whether the `item` provided is an instance of
            [`SpecifierAll`][versions.specifiers.SpecifierAll].
    """
    return is_instance(item, SpecifierAll)