Requirement Class Reference

Inheritance diagram for Requirement:

Collaboration diagram for Requirement:

Public Member Functions
	__init__ (self, requirement_string)
	__eq__ (self, other)
	__ne__ (self, other)
	__contains__ (self, item)
	__hash__ (self)
	__repr__ (self)
Public Member Functions inherited from Requirement
str	__str__ (self)

Static Public Member Functions
	parse (s)

Data Fields
	unsafe_name
	project_name
	key
	specs
	extras
	hashCmp
	url
	specifier
	marker
Data Fields inherited from Requirement
	url
	specifier

Detailed Description

Definition at line 3171 of file __init__.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			requirement_string
	)

DO NOT CALL THIS UNDOCUMENTED METHOD; use Requirement.parse()!

Reimplemented from Requirement.

Definition at line 3172 of file __init__.py.

    def __init__(self, requirement_string):
        """DO NOT CALL THIS UNDOCUMENTED METHOD; use Requirement.parse()!"""
        super(Requirement, self).__init__(requirement_string)
        self.unsafe_name = self.name
        project_name = safe_name(self.name)
        self.project_name, self.key = project_name, project_name.lower()
        self.specs = [(spec.operator, spec.version) for spec in self.specifier]
        self.extras = tuple(map(safe_extra, self.extras))
        self.hashCmp = (
            self.key,
            self.url,
            self.specifier,
            frozenset(self.extras),
            str(self.marker) if self.marker else None,
        )
        self.__hash = hash(self.hashCmp)
 

Referenced by Protocol.__init_subclass__().

Here is the caller graph for this function:

Member Function Documentation

__contains__()

__contains__	(		self,
			item
	)

Definition at line 3195 of file __init__.py.

    def __contains__(self, item):
        if isinstance(item, Distribution):
            if item.key != self.key:
                return False
 
            item = item.version
 
        # Allow prereleases always in order to match the previous behavior of
        # this method. In the future this should be smarter and follow PEP 440
        # more accurately.
        return self.specifier.contains(item, prereleases=True)
 

__eq__()

__eq__	(		self,
			other
	)

Definition at line 3189 of file __init__.py.

    def __eq__(self, other):
        return isinstance(other, Requirement) and self.hashCmp == other.hashCmp
 

Referenced by Version.__ge__(), Version.__gt__(), Version.__le__(), Version.__ne__(), Matcher.__ne__(), Timestamp.__ne__(), and HTTPHeaderDict.__ne__().

Here is the caller graph for this function:

__hash__()

__hash__

(

self

)

Definition at line 3207 of file __init__.py.

    def __hash__(self):
        return self.__hash
 

Referenced by Style.__eq__(), and Style.__ne__().

Here is the caller graph for this function:

__ne__()

__ne__	(		self,
			other
	)

Definition at line 3192 of file __init__.py.

    def __ne__(self, other):
        return not self == other
 

__repr__()

__repr__

(

self

)

Reimplemented from Requirement.

Definition at line 3210 of file __init__.py.

    def __repr__(self):
        return "Requirement.parse(%r)" % str(self)
 

parse()

parse (   s )

static

Definition at line 3214 of file __init__.py.

    def parse(s):
        (req,) = parse_requirements(s)
        return req
 
 

Referenced by Style.normalize().

Here is the caller graph for this function:

Field Documentation

extras

extras

Definition at line 3179 of file __init__.py.

Referenced by ExtrasCandidate.__eq__(), ExtrasCandidate.__hash__(), ExtrasCandidate.__repr__(), ExtrasCandidate.__str__(), Requirement.__str__(), Distribution._get_requirements(), Metadata._to_legacy(), ExtrasCandidate.format_for_error(), Metadata.get_requirements(), ExtrasCandidate.iter_dependencies(), and ExtrasCandidate.name().

hashCmp

hashCmp

Definition at line 3180 of file __init__.py.

key

key

Definition at line 3177 of file __init__.py.

Referenced by Matcher.__eq__(), Matcher.__hash__(), and SelfCheckState.set().

marker

marker

Definition at line 3185 of file __init__.py.

project_name

project_name

Definition at line 3177 of file __init__.py.

Referenced by SimpleScrapingLocator._process_download(), _InstallRequirementBackedCandidate.name(), and AlreadyInstalledCandidate.name().

specifier

specifier

Definition at line 3183 of file __init__.py.

Referenced by Constraint.__and__(), Constraint.__bool__(), RequiresPythonRequirement.__repr__(), Requirement.__str__(), RequiresPythonRequirement.get_candidate_lookup(), InstallRequirement.is_pinned(), Constraint.is_satisfied_by(), and RequiresPythonRequirement.is_satisfied_by().

specs

specs

Definition at line 3178 of file __init__.py.

unsafe_name

unsafe_name

Definition at line 3175 of file __init__.py.

url

url

Definition at line 3182 of file __init__.py.

Referenced by Requirement.__init__(), HTMLLinkParser.__init__(), RequestError.__reduce__(), IndexContent.__str__(), Url.__str__(), PackageIndex._url_for_path(), PackageIndex.check_credentials(), PreparedRequest.copy(), PackageIndex.encode_request(), RequestEncodingMixin.path_url(), Request.prepare(), PreparedRequest.prepare_auth(), PreparedRequest.prepare_url(), PyPIRCFile.read(), DirectUrl.redacted_url(), and PackageIndex.search().

---

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

• /home/liwuen/projects_dev/pqc-engineering-ssec-23/venv/lib/python3.12/site-packages/pip/_vendor/pkg_resources/__init__.py