package documentation

Undocumented

Module _adapters Undocumented
Module _collections No module docstring; 1/2 class documented
Module _compat No module docstring; 3/3 functions, 1/1 class documented
Module _functools No module docstring; 2/2 functions documented
Module _itertools No module docstring; 2/2 functions documented
Module _meta No module docstring; 0/1 type variable, 1/1 class documented
Module _py39compat Compatibility layer with Python 3.8/3.9
Module _text No module docstring; 1/1 class documented

From __init__.py:

Class DeprecatedTuple Provide subscript item access for backward compatibility.
Class Distribution A Python distribution package.
Class DistributionFinder A MetaPathFinder capable of discovering installed distributions.
Class EntryPoint An entry point as defined by Python packaging conventions.
Class EntryPoints An immutable collection of selectable EntryPoint objects.
Class FastPath Micro-optimized class for searching a path for children.
Class FileHash Undocumented
Class Lookup Undocumented
Class MetadataPathFinder A degenerate finder for distribution packages on the file system.
Class PackageMetadata No class docstring; 1/1 property, 1/5 method documented
Class PackagePath A reference to a path in a package
Class PathDistribution No class docstring; 1/1 property, 0/1 instance variable, 1/3 method, 1/1 static method documented
Class Prepared A prepared search for metadata on a possibly-named package.
Class Sectioned A simple entry point config parser for performance
Exception PackageNotFoundError The package was not found.
Function distribution Get the ``Distribution`` instance for the named package.
Function distributions Get all ``Distribution`` instances in the current environment.
Function entry_points Return EntryPoint objects for all installed packages.
Function files Return a list of files for the named package.
Function metadata Get the metadata for the named package.
Function packages_distributions Return a mapping of top-level packages to their distributions.
Function requires Return a list of requirements for the named package.
Function version Get the version string for the named package.
Function _top_level_declared Undocumented
Function _top_level_inferred Undocumented
Variable _unique Wrapper for ``distributions`` to return unique distributions by name.
def distribution(distribution_name): (source)

Get the ``Distribution`` instance for the named package. :param distribution_name: The name of the distribution package as a string. :return: A ``Distribution`` instance (or subclass thereof).

def distributions(**kwargs): (source)

Get all ``Distribution`` instances in the current environment. :return: An iterable of ``Distribution`` instances.

def metadata(distribution_name) -> _meta.PackageMetadata: (source)

Get the metadata for the named package. :param distribution_name: The name of the distribution package to query. :return: A PackageMetadata containing the parsed metadata.

def version(distribution_name): (source)

Get the version string for the named package. :param distribution_name: The name of the distribution package to query. :return: The version string for the package as defined in the package's "Version" metadata key.

Wrapper for ``distributions`` to return unique distributions by name.

def entry_points(**params) -> EntryPoints: (source)

Return EntryPoint objects for all installed packages. Pass selection parameters (group or name) to filter the result to entry points matching those properties (see EntryPoints.select()). :return: EntryPoints for all installed packages.

def files(distribution_name): (source)

Return a list of files for the named package. :param distribution_name: The name of the distribution package to query. :return: List of files composing the distribution.

def requires(distribution_name): (source)

Return a list of requirements for the named package. :return: An iterator of requirements, suitable for packaging.requirement.Requirement.

def packages_distributions() -> Mapping[str, List[str]]: (source)

Return a mapping of top-level packages to their distributions. >>> import collections.abc >>> pkgs = packages_distributions() >>> all(isinstance(dist, collections.abc.Sequence) for dist in pkgs.values()) True

def _top_level_declared(dist): (source)

Undocumented

def _top_level_inferred(dist): (source)

Undocumented