packaging.specifiers.BaseSpecifier Class Reference

Inheritance diagram for packaging.specifiers.BaseSpecifier:

Collaboration diagram for packaging.specifiers.BaseSpecifier:

Public Member Functions
str	__str__ (self)
int	__hash__ (self)
bool	__eq__ (self, object other)
bool|None	prereleases (self)
None	prereleases (self, bool value)
bool	contains (self, str item, bool|None prereleases=None)
Iterator[UnparsedVersionVar]	filter (self, Iterable[UnparsedVersionVar] iterable, bool|None prereleases=None)

Member Function Documentation

__eq__()

bool packaging.specifiers.BaseSpecifier.__eq__	(		self,
		object	other
	)

Returns a boolean representing whether or not the two Specifier-like
objects are equal.

:param other: The other object to check against.

Reimplemented in packaging.specifiers.Specifier, and packaging.specifiers.SpecifierSet.

__hash__()

int packaging.specifiers.BaseSpecifier.__hash__

(

self

)

Returns a hash value for this Specifier-like object.

Reimplemented in packaging.specifiers.Specifier, and packaging.specifiers.SpecifierSet.

__str__()

str packaging.specifiers.BaseSpecifier.__str__

(

self

)

Returns the str representation of this Specifier-like object. This
should be representative of the Specifier itself.

Reimplemented in packaging.specifiers.Specifier, and packaging.specifiers.SpecifierSet.

contains()

bool packaging.specifiers.BaseSpecifier.contains	(		self,
		str	item,
		bool | None	prereleases = None
	)

Determines if the given item is contained within this specifier.

Reimplemented in packaging.specifiers.Specifier, and packaging.specifiers.SpecifierSet.

filter()

Iterator[UnparsedVersionVar] packaging.specifiers.BaseSpecifier.filter	(		self,
		Iterable[UnparsedVersionVar]	iterable,
		bool | None	prereleases = None
	)

Takes an iterable of items and filters them so that only items which
are contained within this specifier are allowed in it.

Reimplemented in packaging.specifiers.Specifier, and packaging.specifiers.SpecifierSet.

prereleases() [1/2]

bool | None packaging.specifiers.BaseSpecifier.prereleases

(

self

)

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.

Reimplemented in packaging.specifiers.Specifier, packaging.specifiers.SpecifierSet, packaging.specifiers.Specifier, and packaging.specifiers.SpecifierSet.

prereleases() [2/2]

None packaging.specifiers.BaseSpecifier.prereleases	(		self,
		bool	value
	)

Setter for :attr:`prereleases`.

:param value: The value to set.

Reimplemented in packaging.specifiers.Specifier, packaging.specifiers.SpecifierSet, packaging.specifiers.Specifier, and packaging.specifiers.SpecifierSet.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/packaging/specifiers.py