pip._internal.distributions.base.AbstractDistribution Class Reference

Inheritance diagram for pip._internal.distributions.base.AbstractDistribution:

Collaboration diagram for pip._internal.distributions.base.AbstractDistribution:

Public Member Functions
None	__init__ (self, InstallRequirement req)
Optional[str]	build_tracker_id (self)
BaseDistribution	get_metadata_distribution (self)
None	prepare_distribution_metadata (self, PackageFinder finder, bool build_isolation, bool check_build_deps)

Public Attributes
	req

Detailed Description

A base class for handling installable artifacts.

The requirements for anything installable are as follows:

 - we must be able to determine the requirement name
   (or we can't correctly handle the non-upgrade case).

 - for packages with setup requirements, we must also be able
   to determine their requirements without installing additional
   packages (for the same reason as run-time dependencies)

 - we must be able to create a Distribution object exposing the
   above metadata.

 - if we need to do work in the build tracker, we must be able to generate a unique
   string to identify the requirement in the build tracker.

Member Function Documentation

build_tracker_id()

Optional[str] pip._internal.distributions.base.AbstractDistribution.build_tracker_id

(

self

)

A string that uniquely identifies this requirement to the build tracker.

If None, then this dist has no work to do in the build tracker, and
``.prepare_distribution_metadata()`` will not be called.

Reimplemented in pip._internal.distributions.installed.InstalledDistribution, pip._internal.distributions.sdist.SourceDistribution, and pip._internal.distributions.wheel.WheelDistribution.

get_metadata_distribution()

BaseDistribution pip._internal.distributions.base.AbstractDistribution.get_metadata_distribution

(

self

)

Reimplemented in pip._internal.distributions.wheel.WheelDistribution.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_internal/distributions/base.py