pip._vendor.pkg_resources.Distribution Class Reference

Inheritance diagram for pip._vendor.pkg_resources.Distribution:

Collaboration diagram for pip._vendor.pkg_resources.Distribution:

Public Member Functions
	__init__ (self, location=None, metadata=None, project_name=None, version=None, py_version=PY_MAJOR, platform=None, precedence=EGG_DIST)
	from_location (cls, location, basename, metadata=None, **kw)
	hashcmp (self)
	__hash__ (self)
	__lt__ (self, other)
	__le__ (self, other)
	__gt__ (self, other)
	__ge__ (self, other)
	__eq__ (self, other)
	__ne__ (self, other)
	key (self)
	parsed_version (self)
	version (self)
	requires (self, extras=())
	activate (self, path=None, replace=False)
	egg_name (self)
	__repr__ (self)
	__str__ (self)
	__getattr__ (self, attr)
	__dir__ (self)
	from_filename (cls, filename, metadata=None, **kw)
	as_requirement (self)
	load_entry_point (self, group, name)
	get_entry_map (self, group=None)
	get_entry_info (self, group, name)
	insert_on (self, path, loc=None, replace=False)
	check_version_conflict (self)
	has_version (self)
	clone (self, **kw)
	extras (self)

Public Attributes
	project_name
	py_version
	platform
	location
	precedence
	key
	hashcmp
	PKG_INFO
	version
	parsed_version

Static Public Attributes
str	PKG_INFO = 'PKG-INFO'

Protected Member Functions
	_reload_version (self)
	_forgiving_parsed_version (self)
	_dep_map (self)
	_build_dep_map (self)
	_get_metadata_path_for_display (self, name)
	_get_metadata (self, name)
	_get_version (self)

Static Protected Member Functions
	_filter_extras (dm)

Protected Attributes
	_version
	_provider
	_forgiving_parsed_version
	_key
	_parsed_version

Detailed Description

Wrap an actual or potential sys.path entry w/metadata

Member Function Documentation

__getattr__()

pip._vendor.pkg_resources.Distribution.__getattr__	(		self,
			attr
	)

Delegate all unrecognized public attributes to .metadata provider

_dep_map()

pip._vendor.pkg_resources.Distribution._dep_map (   self )

protected

A map of extra to its list of (direct) requirements
for this distribution, including the null extra.

Reimplemented in pip._vendor.pkg_resources.DistInfoDistribution.

_filter_extras()

pip._vendor.pkg_resources.Distribution._filter_extras (   dm )

staticprotected

Given a mapping of extras to dependencies, strip off
environment markers and filter out any dependencies
not matching the markers.

_get_metadata_path_for_display()

pip._vendor.pkg_resources.Distribution._get_metadata_path_for_display (   self,   name  )

protected

Return the path to the given metadata file, if available.

_reload_version()

pip._vendor.pkg_resources.Distribution._reload_version (   self )

protected

Reimplemented in pip._vendor.pkg_resources.EggInfoDistribution.

activate()

pip._vendor.pkg_resources.Distribution.activate	(		self,
			path = None,
			replace = False
	)

Ensure distribution is importable on `path` (default=sys.path)

as_requirement()

pip._vendor.pkg_resources.Distribution.as_requirement

(

self

)

Return a ``Requirement`` that matches this distribution exactly

clone()

pip._vendor.pkg_resources.Distribution.clone	(		self,
		**	kw
	)

Copy this distribution, substituting in any changed keyword args

egg_name()

pip._vendor.pkg_resources.Distribution.egg_name

(

self

)

Return what this distribution's standard .egg filename should be

get_entry_info()

pip._vendor.pkg_resources.Distribution.get_entry_info	(		self,
			group,
			name
	)

Return the EntryPoint object for `group`+`name`, or ``None``

get_entry_map()

pip._vendor.pkg_resources.Distribution.get_entry_map	(		self,
			group = None
	)

Return the entry point map for `group`, or the full entry map

insert_on()

pip._vendor.pkg_resources.Distribution.insert_on	(		self,
			path,
			loc = None,
			replace = False
	)

Ensure self.location is on path

If replace=False (default):
    - If location is already in path anywhere, do nothing.
    - Else:
      - If it's an egg and its parent directory is on path,
        insert just ahead of the parent.
      - Else: add to the end of path.
If replace=True:
    - If location is already on path anywhere (not eggs)
      or higher priority than its parent (eggs)
      do nothing.
    - Else:
      - If it's an egg and its parent directory is on path,
        insert just ahead of the parent,
        removing any lower-priority entries.
      - Else: add it to the front of path.

load_entry_point()

pip._vendor.pkg_resources.Distribution.load_entry_point	(		self,
			group,
			name
	)

Return the `name` entry point of `group` or raise ImportError

requires()

pip._vendor.pkg_resources.Distribution.requires	(		self,
			extras = ()
	)

List of Requirements needed for this distro if `extras` are used

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/pkg_resources/__init__.py