pip._vendor.distlib.database.BaseInstalledDistribution Class Reference

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

Public Member Functions
def	__init__
def	get_hash
Public Member Functions inherited from pip._vendor.distlib.database.Distribution
def	__init__
def	source_url
def	name_and_version
def	provides
def	run_requires
def	meta_requires
def	build_requires
def	test_requires
def	dev_requires
def	matches_requirement
def	__repr__
def	__eq__
def	__hash__

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

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

Detailed Description

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

Constructor & Destructor Documentation

def 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.

Member Function Documentation

def 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

Member Data Documentation

pip._vendor.distlib.database.BaseInstalledDistribution.dist_path

pip._vendor.distlib.database.BaseInstalledDistribution.hasher = None

static

pip._vendor.distlib.database.BaseInstalledDistribution.path

---

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

• orbits/lib/python2.7/site-packages/pip/_vendor/distlib/database.py