pip._vendor.distlib.locators.DirectoryLocator Class Reference

Inheritance diagram for pip._vendor.distlib.locators.DirectoryLocator:

Collaboration diagram for pip._vendor.distlib.locators.DirectoryLocator:

Public Member Functions
	__init__ (self, path, **kwargs)
	should_include (self, filename, parent)
	get_distribution_names (self)
Public Member Functions inherited from pip._vendor.distlib.locators.Locator
	get_errors (self)
	clear_errors (self)
	clear_cache (self)
	get_project (self, name)
	score_url (self, url)
	prefer_url (self, url1, url2)
	split_filename (self, filename, project_name)
	convert_url_to_download_info (self, url, project_name)
	locate (self, requirement, prereleases=False)

Public Attributes
	recursive
	base_dir
	downloadable_extensions
Public Attributes inherited from pip._vendor.distlib.locators.Locator
	opener
	matcher
	errors
	downloadable_extensions

Protected Member Functions
	_get_project (self, name)
Protected Member Functions inherited from pip._vendor.distlib.locators.Locator
	_get_scheme (self)
	_set_scheme (self, value)
	_get_digest (self, info)
	_update_version_data (self, result, info)

Additional Inherited Members
Static Public Attributes inherited from pip._vendor.distlib.locators.Locator
tuple	source_extensions = ('.tar.gz', '.tar.bz2', '.tar', '.zip', '.tgz', '.tbz')
tuple	binary_extensions = ('.egg', '.exe', '.whl')
tuple	excluded_extensions = ('.pdf',)
	wheel_tags = None
tuple	downloadable_extensions = source_extensions + ('.whl',)
Protected Attributes inherited from pip._vendor.distlib.locators.Locator
	_cache
	_scheme
Properties inherited from pip._vendor.distlib.locators.Locator
	scheme = property(_get_scheme, _set_scheme)

Detailed Description

This class locates distributions in a directory tree.

Constructor & Destructor Documentation

__init__()

pip._vendor.distlib.locators.DirectoryLocator.__init__	(		self,
			path,
		**	kwargs
	)

Initialise an instance.
:param path: The root of the directory tree to search.
:param kwargs: Passed to the superclass constructor,
               except for:
               * recursive - if True (the default), subdirectories are
                 recursed into. If False, only the top-level directory
                 is searched,

Reimplemented from pip._vendor.distlib.locators.Locator.

Member Function Documentation

_get_project()

pip._vendor.distlib.locators.DirectoryLocator._get_project (   self,   name  )

protected

For a given project, get a dictionary mapping available versions to Distribution
instances.

This should be implemented in subclasses.

If called from a locate() request, self.matcher will be set to a
matcher for the requirement to satisfy, otherwise it will be None.

Reimplemented from pip._vendor.distlib.locators.Locator.

get_distribution_names()

pip._vendor.distlib.locators.DirectoryLocator.get_distribution_names

(

self

)

Return all the distribution names known to this locator.

Reimplemented from pip._vendor.distlib.locators.Locator.

should_include()

pip._vendor.distlib.locators.DirectoryLocator.should_include	(		self,
			filename,
			parent
	)

Should a filename be considered as a candidate for a distribution
archive? As well as the filename, the directory which contains it
is provided, though not used by the current implementation.

---

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

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