pip._vendor.distlib.database.BaseInstalledDistribution Class Reference

Inheritance diagram for pip._vendor.distlib.database.BaseInstalledDistribution:

Collaboration diagram for pip._vendor.distlib.database.BaseInstalledDistribution:

Public Member Functions
	__init__ (self, metadata, path, env=None)
	get_hash (self, data, hasher=None)
Public Member Functions inherited from pip._vendor.distlib.database.Distribution
	source_url (self)
	name_and_version (self)
	provides (self)
	run_requires (self)
	meta_requires (self)
	build_requires (self)
	test_requires (self)
	dev_requires (self)
	matches_requirement (self, req)
	__repr__ (self)
	__eq__ (self, other)
	__hash__ (self)

Public Attributes
	path
	dist_path
Public Attributes inherited from pip._vendor.distlib.database.Distribution
	metadata
	name
	key
	version
	locator
	digest
	extras
	context
	download_urls
	digests
	source_url

Static Public Attributes
	hasher = None
Static Public Attributes inherited from pip._vendor.distlib.database.Distribution
bool	build_time_dependency = False
bool	requested = False
	download_url = source_url

Additional Inherited Members
Protected Member Functions inherited from pip._vendor.distlib.database.Distribution
	_get_requirements (self, req_attr)

Detailed Description

This is the base class for installed distributions (whether PEP 376 or
legacy).

Constructor & Destructor Documentation

__init__()

pip._vendor.distlib.database.BaseInstalledDistribution.__init__	(		self,
			metadata,
			path,
			env = None
	)

Initialise an instance.
:param metadata: An instance of :class:`Metadata` which describes the
                 distribution. This will normally have been initialised
                 from a metadata file in the ``path``.
:param path:     The path of the ``.dist-info`` or ``.egg-info``
                 directory for the distribution.
:param env:      This is normally the :class:`DistributionPath`
                 instance where this distribution was found.

Reimplemented from pip._vendor.distlib.database.Distribution.

Reimplemented in pip._vendor.distlib.database.EggInfoDistribution, and pip._vendor.distlib.database.InstalledDistribution.

Member Function Documentation

get_hash()

pip._vendor.distlib.database.BaseInstalledDistribution.get_hash	(		self,
			data,
			hasher = None
	)

Get the hash of some data, using a particular hash algorithm, if
specified.

:param data: The data to be hashed.
:type data: bytes
:param hasher: The name of a hash implementation, supported by hashlib,
               or ``None``. Examples of valid values are ``'sha1'``,
               ``'sha224'``, ``'sha384'``, '``sha256'``, ``'md5'`` and
               ``'sha512'``. If no hasher is specified, the ``hasher``
               attribute of the :class:`InstalledDistribution` instance
               is used. If the hasher is determined to be ``None``, MD5
               is used as the hashing algorithm.
:returns: The hash of the data. If a hasher was explicitly specified,
          the returned hash will be prefixed with the specified hasher
          followed by '='.
:rtype: str

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/distlib/database.py