importlib_metadata module¶APIs exposing metadata from third-party Python packages.
This codebase is shared between importlib.metadata in the stdliband importlib_metadata in PyPI. Seehttps://github.com/python/importlib_metadata/wiki/Development-Methodologyfor more detail.
Bases:object
An abstract Python distribution package.
Custom providers may derive from this class and definethe abstract methods to provide a concrete implementationfor their environment. Some providers may opt to overridethe default implementation of some properties to bypassthe file-reading mechanism.
Return a Distribution for the indicated metadata path.
path – a string or path-like object
a concrete Distribution instance for the path
Return an iterable of Distribution objects for all packages.
Pass acontext or pass keyword arguments for constructinga context.
ADistributionFinder.Context object.
Iterable of Distribution objects for packages matchingthe context.
Return EntryPoints for this distribution.
Custom providers may provide theentry_points.txt fileor override this property.
Files in this distribution.
List of PackagePath for this distribution or None
Result isNone if the metadata file that enumerates files(i.e. RECORD for dist-info, or installed-files.txt orSOURCES.txt for egg-info) is missing.Result may be empty if the metadata exists but is empty.
Custom providers are recommended to provide a “RECORD” file (inread_text) or override this property to allow for callers to beable to resolve filenames provided by the package.
Return the Distribution for the given package name.
name – The name of the distribution package to search for.
The Distribution instance (or subclass thereof) for the namedpackage, if found.
PackageNotFoundError – When the named package’s distributionmetadata cannot be found.
ValueError – When an invalid value is supplied for name.
Given a path to a file in this distribution, return a SimplePathto it.
This method is used by callers ofDistribution.files() tolocate files within the distribution. If it’s possible for aDistribution to represent files in the distribution asSimplePath objects, it should implement this methodto resolve such objects.
Some Distribution providers may elect not to resolve SimplePathobjects within the distribution by raising aNotImplementedError, but consumers of such a Distribution wouldbe unable to invokeDistribution.files().
Return the parsed metadata for this Distribution.
The returned object will have keys that name the various bits ofmetadata per theCore metadata specifications.
Custom providers may provide the METADATA file or override thisproperty.
Attempt to load metadata file given by the name.
Python distribution metadata is organized by blobs of texttypically represented as “files” in the metadata directory(e.g. package-1.0.dist-info). These files include thingslike:
METADATA: The distribution metadata including fieldslike Name and Version and Description.
entry_points.txt: A series of entry points as defined inthe entry points spec.
RECORD: A record of files according tothis recording spec.
A package may provide any set of files, including thosenot listed here or none at all.
filename – The name of the file in the distribution info.
The text if found, otherwise None.
Bases:MetaPathFinder
A MetaPathFinder capable of discovering installed distributions.
Custom providers should implement this interface in order tosupply metadata.
Bases:object
Keyword arguments presented by the caller todistributions() orDistribution.discover()to narrow the scope of a search for distributionsin all DistributionFinders.
Each DistributionFinder may expect any parametersand should attempt to honor the canonicalparameters defined below when appropriate.
This mechanism gives a custom provider a means tosolicit additional details from the caller beyond“name” and “path” when searching distributions.For example, imagine a provider that exposes suitesof packages in either a “public” or “private”realm.A caller may wish to query only for distributions ina particular realm and could calldistributions(realm="private") to signal to thecustom provider to only include distributions from thatrealm.
Specific name for which a distribution finder should match.A name ofNone matches all distributions.
Find distributions.
Return an iterable of all Distribution instances capable ofloading the metadata for packages matching thecontext,a DistributionFinder.Context instance.
Bases:Protocol
Helper for @overload to raise when called.
Helper for @overload to raise when called.
Bases:ModuleNotFoundError
The package was not found.
Bases:Protocol
A minimal subset of pathlib.Path required by Distribution.
Get theDistribution instance for the named package.
distribution_name – The name of the distribution package as a string.
ADistribution instance (or subclass thereof).
Get allDistribution instances in the current environment.
An iterable ofDistribution instances.
Return EntryPoint objects for all installed packages.
Pass selection parameters (group or name) to filter theresult to entry points matching those properties (seeEntryPoints.select()).
EntryPoints for all installed packages.
Return a list of files for the named package.
distribution_name – The name of the distribution package to query.
List of files composing the distribution.
Get the metadata for the named package.
distribution_name – The name of the distribution package to query.
A PackageMetadata containing the parsed metadata.
Return a mapping of top-level packages to theirdistributions.
>>>importcollections.abc>>>pkgs=packages_distributions()>>>all(isinstance(dist,collections.abc.Sequence)fordistinpkgs.values())True
Return a list of requirements for the named package.
An iterable of requirements, suitable forpackaging.requirement.Requirement.
Get the version string for the named package.
distribution_name – The name of the distribution package to query.
The version string for the package as defined in the package’s“Version” metadata key.