distlib API reference

62 public APIs from distlib (pypa/distlib) — 29 classes, 5 functions, 28 methods. Signatures extracted by static analysis of the actual source.

Repository: pypa/distlib

Kind	Count
Classes	29
Functions	5
Methods	28

API list

classdistlib.compat.BaseConfigurator

The configurator base class which defines some useful defaults.

methoddistlib.compat.BaseConfigurator.convert(value)

Convert values to an appropriate type.

methoddistlib.compat.ChainMap.clear()

Clear maps[0], leaving maps[1:] intact.

methoddistlib.compat.ChainMap.parents()

New ChainMap from maps[1:].

methoddistlib.compat.ChainMap.pop(key, *args)

Remove *key* from maps[0] and return its value.

classdistlib.compat.Container

A generic container for when multiple values need to be returned

classdistlib.compat.ConvertingDict

A converting dictionary wrapper.

classdistlib.compat.ConvertingList

A converting list wrapper.

classdistlib.compat.ConvertingTuple

A converting tuple wrapper.

classdistlib.compat.OrderedDict

Dictionary that remembers insertion order

methoddistlib.compat.OrderedDict.clear()

od.clear() -> None.

methoddistlib.compat.OrderedDict.copy()

od.copy() -> a shallow copy of od

methoddistlib.compat.OrderedDict.items()

od.items() -> list of (key, value) pairs in od

methoddistlib.compat.OrderedDict.keys()

od.keys() -> list of keys in od

methoddistlib.compat.OrderedDict.update(*args, **kwds)

od.update(E, **F) -> None.

methoddistlib.compat.OrderedDict.values()

od.values() -> list of values in od

classdistlib.database.DependencyGraph

Represents a dependency graph between distributions.

methoddistlib.database.DependencyGraph.repr_node(dist, level=1)

Prints only a subgraph

classdistlib.locators.DependencyFinder

Locate dependencies for distributions.

methoddistlib.locators.DependencyFinder.add_distribution(dist)

Add a distribution to the finder.

classdistlib.locators.DirectoryLocator

This class locates distributions in a directory tree.

classdistlib.locators.DistPathLocator

This locator finds installed distributions in a path.

classdistlib.locators.Locator

A base class for locators - things that locate distributions.

methoddistlib.locators.Locator.get_errors()

Return any errors which have occurred.

classdistlib.locators.Page

This class represents a scraped HTML page.

funcdistlib.locators.Page.clean(url)

Tidy up an URL.

classdistlib.locators.PyPIJSONLocator

This locator uses PyPI's JSON interface.

classdistlib.locators.PyPIRPCLocator

This locator uses XML-RPC to locate distributions.

classdistlib.locators.RedirectHandler

A class to work around a bug in some Python 3.2.x releases.

methoddistlib.manifest.Manifest.add(item)

Add a file to the manifest.

methoddistlib.manifest.Manifest.add_many(items)

Add a list of files to the manifest.

methoddistlib.manifest.Manifest.clear()

Clear all collected files.

methoddistlib.manifest.Manifest.sorted(wantdirs=False)

Return sorted files in directory order

classdistlib.markers.Evaluator

This class is used to evaluate marker expressions.

classdistlib.metadata.LegacyMetadata

The legacy metadata of a release.

methoddistlib.metadata.LegacyMetadata.check(strict=False)

Check if the metadata is compliant.

methoddistlib.metadata.LegacyMetadata.get(name, default=_MISSING)

Get a metadata field.

methoddistlib.metadata.LegacyMetadata.read(filepath)

Read the metadata values from a file path.

methoddistlib.metadata.LegacyMetadata.set(name, value)

Control then set a metadata field.

methoddistlib.metadata.LegacyMetadata.todict(skip_missing=False)

Return fields as a dict.

methoddistlib.metadata.LegacyMetadata.write(filepath, skip_unknown=False)

Write the metadata fields to filepath.

classdistlib.metadata.Metadata

The metadata of a release.

classdistlib.metadata.MetadataInvalidError

A metadata value is invalid

classdistlib.metadata.MetadataMissingError

A required metadata is missing

classdistlib.metadata.MetadataUnrecognizedVersionError

Unknown metadata version number.

classdistlib.resources.Resource

A class representing an in-package resource, such as a data file.

methoddistlib.resources.Resource.as_stream()

Get the resource as a stream.

classdistlib.resources.ResourceFinder

Resource finder for file system resources.

classdistlib.resources.ZipResourceFinder

Resource finder for resources in .zip files.

funcdistlib.resources.finder(package)

Return a resource finder for a package.

methoddistlib.util.Cache.clear()

Clear the cache.

classdistlib.util.EventMixin

A very simple publish/subscribe system.

methoddistlib.util.EventMixin.add(event, subscriber, append=True)

Add a subscriber for an event.

methoddistlib.util.EventMixin.remove(event, subscriber)

Remove a subscriber for an event.

classdistlib.util.SubprocessMixin

Mixin for running subprocesses and capturing their output

funcdistlib.util.get_resources_dests(resources_root, rules)

Find destinations for resources files

funcdistlib.util.parse_requirement(req)

Parse a requirement passed in as a string.

funcdistlib.util.zip_dir(directory)

zip a directory tree into a BytesIO object

classdistlib.version.NormalizedVersion

A rational version.

classdistlib.version.UnsupportedVersionError

This is an unsupported version.

classdistlib.wheel.Wheel

Class to build and install from Wheel files (PEP 427).

methoddistlib.wheel.Wheel.install(paths, maker, **kwargs)

Install a wheel to the specified paths.

About this data

These signatures were extracted from the public source of pypa/distlib using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries