AbstractDistribution Class Reference

Inheritance diagram for AbstractDistribution:

Collaboration diagram for AbstractDistribution:

Public Member Functions
None	__init__ (self, InstallRequirement req)
BaseDistribution	get_metadata_distribution (self)
None	prepare_distribution_metadata (self, PackageFinder finder, bool build_isolation, bool check_build_deps)

Data Fields
	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.

Definition at line 8 of file base.py.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		InstallRequirement	req
	)

Definition at line 24 of file base.py.

    def __init__(self, req: InstallRequirement) -> None:
        super().__init__()
        self.req = req
 

References AbstractDistribution.__init__(), and i.

Referenced by AbstractDistribution.__init__(), and Protocol.__init_subclass__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

get_metadata_distribution()

BaseDistribution get_metadata_distribution

(

self

)

Reimplemented in InstalledDistribution, SourceDistribution, and WheelDistribution.

Definition at line 29 of file base.py.

    def get_metadata_distribution(self) -> BaseDistribution:
        raise NotImplementedError()
 

References i.

prepare_distribution_metadata()

None prepare_distribution_metadata	(		self,
		PackageFinder	finder,
		bool	build_isolation,
		bool	check_build_deps
	)

Reimplemented in InstalledDistribution, SourceDistribution, and WheelDistribution.

Definition at line 33 of file base.py.

    ) -> None:
        raise NotImplementedError()

References i.

Field Documentation

req

req

Definition at line 26 of file base.py.

Referenced by FrozenRequirement.__str__(), InstallRequirement.__str__(), SourceDistribution._get_build_requires_editable(), SourceDistribution._get_build_requires_wheel(), SourceDistribution._install_build_reqs(), SourceDistribution._prepare_build_backend(), SourceDistribution._raise_conflicts(), SourceDistribution._raise_missing_reqs(), InstallRequirement._set_requirement(), InstallRequirement.assert_source_matches_version(), InstallRequirement.check_if_exists(), InstallRequirement.ensure_build_location(), InstallRequirement.from_path(), InstalledDistribution.get_metadata_distribution(), SourceDistribution.get_metadata_distribution(), WheelDistribution.get_metadata_distribution(), InstallRequirement.name(), SourceDistribution.prepare_distribution_metadata(), InstallRequirement.specifier(), InstallRequirement.uninstall(), and InstallRequirement.warn_on_mismatching_name().

---

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

• /home/liwuen/projects_dev/pqc-engineering-ssec-23/venv/lib/python3.12/site-packages/pip/_internal/distributions/base.py