Inheritance diagram for BaseDistribution:

[legend]

Collaboration diagram for BaseDistribution:

Public Member Functions
"BaseDistribution"	from_directory (cls, str directory)

"BaseDistribution"	from_metadata_file_contents (cls, bytes metadata_contents, str filename, str project_name)

"BaseDistribution"	from_wheel (cls, "Wheel" wheel, str name)

str	__repr__ (self)

str	__str__ (self)

Optional[str]	location (self)

Optional[str]	editable_project_location (self)

Optional[str]	installed_location (self)

Optional[str]	info_location (self)

bool	installed_by_distutils (self)

bool	installed_as_egg (self)

bool	installed_with_setuptools_egg_info (self)

bool	installed_with_dist_info (self)

NormalizedName	canonical_name (self)

DistributionVersion	version (self)

str	setuptools_filename (self)

Optional[DirectUrl]	direct_url (self)

str	installer (self)

bool	requested (self)

bool	editable (self)

bool	local (self)

bool	in_usersite (self)

bool	in_site_packages (self)

bool	is_file (self, InfoPath path)

Iterator[str]	iter_distutils_script_names (self)

str	read_text (self, InfoPath path)

Iterable[BaseEntryPoint]	iter_entry_points (self)

email.message.Message	metadata (self)

Dict[str, Any]	metadata_dict (self)

Optional[str]	metadata_version (self)

str	raw_name (self)

SpecifierSet	requires_python (self)

Iterable[Requirement]	iter_dependencies (self, Collection[str] extras=())

Iterable[str]	iter_provided_extras (self)

Optional[Iterator[str]]	iter_declared_entries (self)

Data Fields
	canonical_name

	editable_project_location

	installed_location

	metadata

	raw_name

Protected Member Functions
email.message.Message	_metadata_impl (self)

email.message.Message	_metadata_cached (self)

Optional[Iterator[str]]	_iter_declared_entries_from_record (self)

Optional[Iterator[str]]	_iter_declared_entries_from_legacy (self)

Iterator[RequiresEntry]	_iter_requires_txt_entries (self)

Iterable[str]	_iter_egg_info_extras (self)

Iterable[str]	_iter_egg_info_dependencies (self)

None	_add_egg_info_requires (self, email.message.Message metadata)

Detailed Description

Definition at line 107 of file base.py.

Member Function Documentation

◆ repr()

str __repr__ ( self )

Definition at line 148 of file base.py.

    def __repr__(self) -> str:
        return f"{self.raw_name} {self.version} ({self.location})"
 

◆ str()

str __str__ ( self )

Definition at line 151 of file base.py.

    def __str__(self) -> str:
        return f"{self.raw_name} {self.version}"
 

◆ _add_egg_info_requires()

None _add_egg_info_requires	(		self,
		email.message.Message	metadata
	)

protected

Add egg-info requires.txt information to the metadata.

Definition at line 572 of file base.py.

    def _add_egg_info_requires(self, metadata: email.message.Message) -> None:
        """Add egg-info requires.txt information to the metadata."""
        if not metadata.get_all("Requires-Dist"):
            for dep in self._iter_egg_info_dependencies():
                metadata["Requires-Dist"] = dep
        if not metadata.get_all("Provides-Extra"):
            for extra in self._iter_egg_info_extras():
                metadata["Provides-Extra"] = extra
 
 

References BaseDistribution._iter_egg_info_dependencies(), BaseDistribution._iter_egg_info_extras(), and i.

Referenced by BaseDistribution._metadata_cached().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _iter_declared_entries_from_legacy()

Optional[Iterator[str]] _iter_declared_entries_from_legacy ( self )

protected

Definition at line 474 of file base.py.

    def _iter_declared_entries_from_legacy(self) -> Optional[Iterator[str]]:
        try:
            text = self.read_text("installed-files.txt")
        except FileNotFoundError:
            return None
        paths = (p for p in text.splitlines(keepends=False) if p)
        root = self.location
        info = self.info_location
        if root is None or info is None:
            return paths
        try:
            info_rel = pathlib.Path(info).relative_to(root)
        except ValueError:  # info is not relative to root.
            return paths
        if not info_rel.parts:  # info *is* root.
            return paths
        return (
            _convert_installed_files_path(pathlib.Path(p).parts, info_rel.parts)
            for p in paths
        )
 

References pip._internal.metadata.base._convert_installed_files_path(), i, BaseDistribution.info_location(), WheelDistribution.info_location, Distribution.info_location(), _PackageInfo.location, InvalidWheel.location, BaseDistribution.location(), Wheel.location, FilesystemWheel.location, MemoryWheel.location, Distribution.location(), Distribution.location, LocationParseError.location, BaseDistribution.read_text(), Distribution.read_text(), and WheelDistribution.read_text().

Referenced by BaseDistribution.iter_declared_entries().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _iter_declared_entries_from_record()

Optional[Iterator[str]] _iter_declared_entries_from_record ( self )

protected

Definition at line 466 of file base.py.

    def _iter_declared_entries_from_record(self) -> Optional[Iterator[str]]:
        try:
            text = self.read_text("RECORD")
        except FileNotFoundError:
            return None
        # This extra Path-str cast normalizes entries.
        return (str(pathlib.Path(row[0])) for row in csv.reader(text.splitlines()))
 

References i, BaseDistribution.read_text(), Distribution.read_text(), and WheelDistribution.read_text().

Referenced by BaseDistribution.iter_declared_entries().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _iter_egg_info_dependencies()

Iterable[str] _iter_egg_info_dependencies ( self )

protected

Get distribution dependencies from the egg-info directory.

To ease parsing, this converts a legacy dependency entry into a PEP 508
requirement string. Like ``_iter_requires_txt_entries()``, there is code
in ``importlib.metadata`` that does mostly the same, but not do exactly
what we need.

Namely, ``importlib.metadata`` does not normalize the extra name before
putting it into the requirement string, which causes marker comparison
to fail because the dist-info format do normalize. This is consistent in
all currently available PEP 517 backends, although not standardized.

Definition at line 545 of file base.py.

    def _iter_egg_info_dependencies(self) -> Iterable[str]:
        """Get distribution dependencies from the egg-info directory.
 
        To ease parsing, this converts a legacy dependency entry into a PEP 508
        requirement string. Like ``_iter_requires_txt_entries()``, there is code
        in ``importlib.metadata`` that does mostly the same, but not do exactly
        what we need.
 
        Namely, ``importlib.metadata`` does not normalize the extra name before
        putting it into the requirement string, which causes marker comparison
        to fail because the dist-info format do normalize. This is consistent in
        all currently available PEP 517 backends, although not standardized.
        """
        for entry in self._iter_requires_txt_entries():
            if entry.extra and entry.marker:
                marker = f'({entry.marker}) and extra == "{safe_extra(entry.extra)}"'
            elif entry.extra:
                marker = f'extra == "{safe_extra(entry.extra)}"'
            elif entry.marker:
                marker = entry.marker
            else:
                marker = ""
            if marker:
                yield f"{entry.requirement} ; {marker}"
            else:
                yield entry.requirement
 

References BaseDistribution._iter_requires_txt_entries(), and i.

Referenced by BaseDistribution._add_egg_info_requires().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _iter_egg_info_extras()

Iterable[str] _iter_egg_info_extras ( self )

protected

Get extras from the egg-info directory.

Definition at line 536 of file base.py.

    def _iter_egg_info_extras(self) -> Iterable[str]:
        """Get extras from the egg-info directory."""
        known_extras = {""}
        for entry in self._iter_requires_txt_entries():
            if entry.extra in known_extras:
                continue
            known_extras.add(entry.extra)
            yield entry.extra
 

References BaseDistribution._iter_requires_txt_entries(), and i.

Referenced by BaseDistribution._add_egg_info_requires().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _iter_requires_txt_entries()

Iterator[RequiresEntry] _iter_requires_txt_entries ( self )

protected

Parse a ``requires.txt`` in an egg-info directory.

This is an INI-ish format where an egg-info stores dependencies. A
section name describes extra other environment markers, while each entry
is an arbitrary string (not a key-value pair) representing a dependency
as a requirement string (no markers).

There is a construct in ``importlib.metadata`` called ``Sectioned`` that
does mostly the same, but the format is currently considered private.

Definition at line 511 of file base.py.

    def _iter_requires_txt_entries(self) -> Iterator[RequiresEntry]:
        """Parse a ``requires.txt`` in an egg-info directory.
 
        This is an INI-ish format where an egg-info stores dependencies. A
        section name describes extra other environment markers, while each entry
        is an arbitrary string (not a key-value pair) representing a dependency
        as a requirement string (no markers).
 
        There is a construct in ``importlib.metadata`` called ``Sectioned`` that
        does mostly the same, but the format is currently considered private.
        """
        try:
            content = self.read_text("requires.txt")
        except FileNotFoundError:
            return
        extra = marker = ""  # Section-less entries don't have markers.
        for line in content.splitlines():
            line = line.strip()
            if not line or line.startswith("#"):  # Comment; ignored.
                continue
            if line.startswith("[") and line.endswith("]"):  # A section header.
                extra, _, marker = line.strip("[]").partition(":")
                continue
            yield RequiresEntry(requirement=line, extra=extra, marker=marker)
 

References i, BaseDistribution.read_text(), Distribution.read_text(), and WheelDistribution.read_text().

Referenced by BaseDistribution._iter_egg_info_dependencies(), and BaseDistribution._iter_egg_info_extras().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _metadata_cached()

email.message.Message _metadata_cached ( self )

protected

Definition at line 390 of file base.py.

    def _metadata_cached(self) -> email.message.Message:
        # When we drop python 3.7 support, move this to the metadata property and use
        # functools.cached_property instead of lru_cache.
        metadata = self._metadata_impl()
        self._add_egg_info_requires(metadata)
        return metadata
 

References BaseDistribution._add_egg_info_requires(), BaseDistribution._metadata_impl(), and Distribution._metadata_impl().

Referenced by BaseDistribution.metadata().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _metadata_impl()

email.message.Message _metadata_impl ( self )

protected

Reimplemented in Distribution, and Distribution.

Definition at line 386 of file base.py.

    def _metadata_impl(self) -> email.message.Message:
        raise NotImplementedError()
 

References i.

Referenced by BaseDistribution._metadata_cached().

Here is the caller graph for this function:

◆ canonical_name()

NormalizedName canonical_name ( self )

Reimplemented in Distribution, and Distribution.

Definition at line 279 of file base.py.

    def canonical_name(self) -> NormalizedName:
        raise NotImplementedError()
 

References i.

Referenced by BaseDistribution.raw_name().

Here is the caller graph for this function:

◆ direct_url()

Optional[DirectUrl] direct_url ( self )

Obtain a DirectUrl from this distribution.

Returns None if the distribution has no `direct_url.json` metadata,
or if `direct_url.json` is invalid.

Definition at line 295 of file base.py.

    def direct_url(self) -> Optional[DirectUrl]:
        """Obtain a DirectUrl from this distribution.
 
        Returns None if the distribution has no `direct_url.json` metadata,
        or if `direct_url.json` is invalid.
        """
        try:
            content = self.read_text(DIRECT_URL_METADATA_NAME)
        except FileNotFoundError:
            return None
        try:
            return DirectUrl.from_json(content)
        except (
            UnicodeDecodeError,
            json.JSONDecodeError,
            DirectUrlValidationError,
        ) as e:
            logger.warning(
                "Error parsing %s for %s: %s",
                DIRECT_URL_METADATA_NAME,
                self.canonical_name,
                e,
            )
            return None
 

References i, BaseDistribution.read_text(), Distribution.read_text(), and WheelDistribution.read_text().

Referenced by BaseDistribution.editable_project_location().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editable()

bool editable ( self )

Definition at line 337 of file base.py.

    def editable(self) -> bool:
        return bool(self.editable_project_location)
 

Referenced by InstallRequirement.__repr__(), FrozenRequirement.__str__(), DirInfo._to_dict(), InstallRequirement.install(), InstallRequirement.isolated_editable_sanity_check(), InstallRequirement.prepare_metadata(), and InstallRequirement.update_editable().

Here is the caller graph for this function:

◆ editable_project_location()

Optional[str] editable_project_location ( self )

The project location for editable distributions.

This is the directory where pyproject.toml or setup.py is located.
None if the distribution is not installed in editable mode.

Definition at line 169 of file base.py.

    def editable_project_location(self) -> Optional[str]:
        """The project location for editable distributions.
 
        This is the directory where pyproject.toml or setup.py is located.
        None if the distribution is not installed in editable mode.
        """
        # TODO: this property is relatively costly to compute, memoize it ?
        direct_url = self.direct_url
        if direct_url:
            if direct_url.is_local_editable():
                return url_to_path(direct_url.url)
        else:
            # Search for an .egg-link file by walking sys.path, as it was
            # done before by dist_is_editable().
            egg_link_path = egg_link_path_from_sys_path(self.raw_name)
            if egg_link_path:
                # TODO: get project location from second line of egg_link file
                #       (https://github.com/pypa/pip/issues/10243)
                return self.location
        return None
 

References BaseDistribution.direct_url(), i, _PackageInfo.location, InvalidWheel.location, BaseDistribution.location(), Wheel.location, FilesystemWheel.location, MemoryWheel.location, Distribution.location(), Distribution.location, LocationParseError.location, BaseDistribution.raw_name(), and BaseDistribution.raw_name.

Here is the call graph for this function:

◆ from_directory()

"BaseDistribution" from_directory	(		cls,
		str	directory
	)

Load the distribution from a metadata directory.

:param directory: Path to a metadata directory, e.g. ``.dist-info``.

Reimplemented in Distribution, and Distribution.

Definition at line 109 of file base.py.

    def from_directory(cls, directory: str) -> "BaseDistribution":
        """Load the distribution from a metadata directory.
 
        :param directory: Path to a metadata directory, e.g. ``.dist-info``.
        """
        raise NotImplementedError()
 

References i.

◆ from_metadata_file_contents()

"BaseDistribution" from_metadata_file_contents	(		cls,
		bytes	metadata_contents,
		str	filename,
		str	project_name
	)

Load the distribution from the contents of a METADATA file.

This is used to implement PEP 658 by generating a "shallow" dist object that can
be used for resolution without downloading or building the actual dist yet.

:param metadata_contents: The contents of a METADATA file.
:param filename: File name for the dist with this metadata.
:param project_name: Name of the project this dist represents.

Reimplemented in Distribution, and Distribution.

Definition at line 117 of file base.py.

    ) -> "BaseDistribution":
        """Load the distribution from the contents of a METADATA file.
 
        This is used to implement PEP 658 by generating a "shallow" dist object that can
        be used for resolution without downloading or building the actual dist yet.
 
        :param metadata_contents: The contents of a METADATA file.
        :param filename: File name for the dist with this metadata.
        :param project_name: Name of the project this dist represents.
        """
        raise NotImplementedError()
 

References i.

◆ from_wheel()

"BaseDistribution" from_wheel	(		cls,
		"Wheel"	wheel,
		str	name
	)

Load the distribution from a given wheel.

:param wheel: A concrete wheel definition.
:param name: File name of the wheel.

:raises InvalidWheel: Whenever loading of the wheel causes a
    :py:exc:`zipfile.BadZipFile` exception to be thrown.
:raises UnsupportedWheel: If the wheel is a valid zip, but malformed
    internally.

Reimplemented in Distribution, and Distribution.

Definition at line 135 of file base.py.

    def from_wheel(cls, wheel: "Wheel", name: str) -> "BaseDistribution":
        """Load the distribution from a given wheel.
 
        :param wheel: A concrete wheel definition.
        :param name: File name of the wheel.
 
        :raises InvalidWheel: Whenever loading of the wheel causes a
            :py:exc:`zipfile.BadZipFile` exception to be thrown.
        :raises UnsupportedWheel: If the wheel is a valid zip, but malformed
            internally.
        """
        raise NotImplementedError()
 

References i.

◆ in_site_packages()

bool in_site_packages ( self )

Definition at line 357 of file base.py.

    def in_site_packages(self) -> bool:
        if self.installed_location is None or site_packages is None:
            return False
        return self.installed_location.startswith(normalize_path(site_packages))
 

References i, BaseDistribution.installed_location(), BaseDistribution.installed_location, and Distribution.installed_location().

Here is the call graph for this function:

◆ in_usersite()

bool in_usersite ( self )

Definition at line 351 of file base.py.

    def in_usersite(self) -> bool:
        if self.installed_location is None or user_site is None:
            return False
        return self.installed_location.startswith(normalize_path(user_site))
 

References i, BaseDistribution.installed_location(), BaseDistribution.installed_location, and Distribution.installed_location().

Here is the call graph for this function:

◆ info_location()

Optional[str] info_location ( self )

Location of the .[egg|dist]-info directory or file.

Similarly to ``location``, a string value is not necessarily a
filesystem path. ``None`` means the distribution is created in-memory.

For a modern .dist-info installation on disk, this should be something
like ``{location}/{raw_name}-{version}.dist-info``.

Do not canonicalize this value with e.g. ``pathlib.Path.resolve()``. If
this is a symbolic link, we want to preserve the relative path between
it and other files in the distribution.

Reimplemented in Distribution, and Distribution.

Definition at line 204 of file base.py.

    def info_location(self) -> Optional[str]:
        """Location of the .[egg|dist]-info directory or file.
 
        Similarly to ``location``, a string value is not necessarily a
        filesystem path. ``None`` means the distribution is created in-memory.
 
        For a modern .dist-info installation on disk, this should be something
        like ``{location}/{raw_name}-{version}.dist-info``.
 
        Do not canonicalize this value with e.g. ``pathlib.Path.resolve()``. If
        this is a symbolic link, we want to preserve the relative path between
        it and other files in the distribution.
        """
        raise NotImplementedError()
 

References i.

Referenced by BaseDistribution._iter_declared_entries_from_legacy(), BaseDistribution.installed_by_distutils(), BaseDistribution.installed_with_dist_info(), BaseDistribution.installed_with_setuptools_egg_info(), and WheelDistribution.read_text().

Here is the caller graph for this function:

◆ installed_as_egg()

bool installed_as_egg ( self )

Whether this distribution is installed as an egg.

This usually indicates the distribution was installed by (older versions
of) easy_install.

Definition at line 233 of file base.py.

    def installed_as_egg(self) -> bool:
        """Whether this distribution is installed as an egg.
 
        This usually indicates the distribution was installed by (older versions
        of) easy_install.
        """
        location = self.location
        if not location:
            return False
        return location.endswith(".egg")
 

References i, _PackageInfo.location, InvalidWheel.location, BaseDistribution.location(), Wheel.location, FilesystemWheel.location, MemoryWheel.location, Distribution.location(), Distribution.location, and LocationParseError.location.

Here is the call graph for this function:

◆ installed_by_distutils()

bool installed_by_distutils ( self )

Whether this distribution is installed with legacy distutils format.

A distribution installed with "raw" distutils not patched by setuptools
uses one single file at ``info_location`` to store metadata. We need to
treat this specially on uninstallation.

Reimplemented in Distribution.

Definition at line 220 of file base.py.

    def installed_by_distutils(self) -> bool:
        """Whether this distribution is installed with legacy distutils format.
 
        A distribution installed with "raw" distutils not patched by setuptools
        uses one single file at ``info_location`` to store metadata. We need to
        treat this specially on uninstallation.
        """
        info_location = self.info_location
        if not info_location:
            return False
        return pathlib.Path(info_location).is_file()
 

References i, BaseDistribution.info_location(), WheelDistribution.info_location, Distribution.info_location(), and BaseDistribution.is_file().

Here is the call graph for this function:

◆ installed_location()

Optional[str] installed_location ( self )

The distribution's "installed" location.

This should generally be a ``site-packages`` directory. This is
usually ``dist.location``, except for legacy develop-installed packages,
where ``dist.location`` is the source code location, and this is where
the ``.egg-link`` file is.

The returned location is normalized (in particular, with symlinks removed).

Reimplemented in Distribution, and Distribution.

Definition at line 191 of file base.py.

    def installed_location(self) -> Optional[str]:
        """The distribution's "installed" location.
 
        This should generally be a ``site-packages`` directory. This is
        usually ``dist.location``, except for legacy develop-installed packages,
        where ``dist.location`` is the source code location, and this is where
        the ``.egg-link`` file is.
 
        The returned location is normalized (in particular, with symlinks removed).
        """
        raise NotImplementedError()
 

References i.

Referenced by BaseDistribution.in_site_packages(), BaseDistribution.in_usersite(), and BaseDistribution.local().

Here is the caller graph for this function:

◆ installed_with_dist_info()

bool installed_with_dist_info ( self )

Whether this distribution is installed with the "modern format".

This indicates a "modern" installation, e.g. storing metadata in the
``.dist-info`` directory. This applies to installations made by
setuptools (but through pip, not directly), or anything using the
standardized build backend interface (PEP 517).

Definition at line 263 of file base.py.

    def installed_with_dist_info(self) -> bool:
        """Whether this distribution is installed with the "modern format".
 
        This indicates a "modern" installation, e.g. storing metadata in the
        ``.dist-info`` directory. This applies to installations made by
        setuptools (but through pip, not directly), or anything using the
        standardized build backend interface (PEP 517).
        """
        info_location = self.info_location
        if not info_location:
            return False
        if not info_location.endswith(".dist-info"):
            return False
        return pathlib.Path(info_location).is_dir()
 

References i, BaseDistribution.info_location(), WheelDistribution.info_location, and Distribution.info_location().

Here is the call graph for this function:

◆ installed_with_setuptools_egg_info()

bool installed_with_setuptools_egg_info ( self )

Whether this distribution is installed with the ``.egg-info`` format.

This usually indicates the distribution was installed with setuptools
with an old pip version or with ``single-version-externally-managed``.

Note that this ensure the metadata store is a directory. distutils can
also installs an ``.egg-info``, but as a file, not a directory. This
property is *False* for that case. Also see ``installed_by_distutils``.

Definition at line 245 of file base.py.

    def installed_with_setuptools_egg_info(self) -> bool:
        """Whether this distribution is installed with the ``.egg-info`` format.
 
        This usually indicates the distribution was installed with setuptools
        with an old pip version or with ``single-version-externally-managed``.
 
        Note that this ensure the metadata store is a directory. distutils can
        also installs an ``.egg-info``, but as a file, not a directory. This
        property is *False* for that case. Also see ``installed_by_distutils``.
        """
        info_location = self.info_location
        if not info_location:
            return False
        if not info_location.endswith(".egg-info"):
            return False
        return pathlib.Path(info_location).is_dir()
 

References i, BaseDistribution.info_location(), WheelDistribution.info_location, and Distribution.info_location().

Here is the call graph for this function:

◆ installer()

str installer ( self )

Definition at line 321 of file base.py.

    def installer(self) -> str:
        try:
            installer_text = self.read_text("INSTALLER")
        except (OSError, ValueError, NoneMetadataError):
            return ""  # Fail silently if the installer file cannot be read.
        for line in installer_text.splitlines():
            cleaned_line = line.strip()
            if cleaned_line:
                return cleaned_line
        return ""
 

References i, BaseDistribution.read_text(), Distribution.read_text(), and WheelDistribution.read_text().

Here is the call graph for this function:

◆ is_file()

bool is_file	(		self,
		InfoPath	path
	)

Check whether an entry in the info directory is a file.

Reimplemented in Distribution, and Distribution.

Definition at line 362 of file base.py.

    def is_file(self, path: InfoPath) -> bool:
        """Check whether an entry in the info directory is a file."""
        raise NotImplementedError()
 

References i.

Referenced by BaseDistribution.installed_by_distutils(), and BaseDistribution.requested().

Here is the caller graph for this function:

◆ iter_declared_entries()

Optional[Iterator[str]] iter_declared_entries ( self )

Iterate through file entries declared in this distribution.

For modern .dist-info distributions, this is the files listed in the
``RECORD`` metadata file. For legacy setuptools distributions, this
comes from ``installed-files.txt``, with entries normalized to be
compatible with the format used by ``RECORD``.

:return: An iterator for listed entries, or None if the distribution
    contains neither ``RECORD`` nor ``installed-files.txt``.

Definition at line 495 of file base.py.

    def iter_declared_entries(self) -> Optional[Iterator[str]]:
        """Iterate through file entries declared in this distribution.
 
        For modern .dist-info distributions, this is the files listed in the
        ``RECORD`` metadata file. For legacy setuptools distributions, this
        comes from ``installed-files.txt``, with entries normalized to be
        compatible with the format used by ``RECORD``.
 
        :return: An iterator for listed entries, or None if the distribution
            contains neither ``RECORD`` nor ``installed-files.txt``.
        """
        return (
            self._iter_declared_entries_from_record()
            or self._iter_declared_entries_from_legacy()
        )
 

References BaseDistribution._iter_declared_entries_from_legacy(), and BaseDistribution._iter_declared_entries_from_record().

Here is the call graph for this function:

◆ iter_dependencies()

Iterable[Requirement] iter_dependencies	(		self,
		Collection[str]	extras = `()`
	)

Dependencies of this distribution.

For modern .dist-info distributions, this is the collection of
"Requires-Dist:" entries in distribution metadata.

Reimplemented in Distribution, and Distribution.

Definition at line 450 of file base.py.

    def iter_dependencies(self, extras: Collection[str] = ()) -> Iterable[Requirement]:
        """Dependencies of this distribution.
 
        For modern .dist-info distributions, this is the collection of
        "Requires-Dist:" entries in distribution metadata.
        """
        raise NotImplementedError()
 

References i.

◆ iter_distutils_script_names()

Iterator[str] iter_distutils_script_names ( self )

Find distutils 'scripts' entries metadata.

If 'scripts' is supplied in ``setup.py``, distutils records those in the
installed distribution's ``scripts`` directory, a file for each script.

Reimplemented in Distribution, and Distribution.

Definition at line 366 of file base.py.

    def iter_distutils_script_names(self) -> Iterator[str]:
        """Find distutils 'scripts' entries metadata.
 
        If 'scripts' is supplied in ``setup.py``, distutils records those in the
        installed distribution's ``scripts`` directory, a file for each script.
        """
        raise NotImplementedError()
 

References i.

◆ iter_entry_points()

Iterable[BaseEntryPoint] iter_entry_points ( self )

Reimplemented in Distribution, and Distribution.

Definition at line 383 of file base.py.

    def iter_entry_points(self) -> Iterable[BaseEntryPoint]:
        raise NotImplementedError()
 

References i.

◆ iter_provided_extras()

Iterable[str] iter_provided_extras ( self )

Extras provided by this distribution.

For modern .dist-info distributions, this is the collection of
"Provides-Extra:" entries in distribution metadata.

Reimplemented in Distribution, and Distribution.

Definition at line 458 of file base.py.

    def iter_provided_extras(self) -> Iterable[str]:
        """Extras provided by this distribution.
 
        For modern .dist-info distributions, this is the collection of
        "Provides-Extra:" entries in distribution metadata.
        """
        raise NotImplementedError()
 

References i.

◆ local()

bool local ( self )

If distribution is installed in the current virtual environment.

Always True if we're not in a virtualenv.

Definition at line 341 of file base.py.

    def local(self) -> bool:
        """If distribution is installed in the current virtual environment.
 
        Always True if we're not in a virtualenv.
        """
        if self.installed_location is None:
            return False
        return is_local(self.installed_location)
 

References BaseDistribution.installed_location(), BaseDistribution.installed_location, and Distribution.installed_location().

Here is the call graph for this function:

◆ location()

Optional[str] location ( self )

Where the distribution is loaded from.

A string value is not necessarily a filesystem path, since distributions
can be loaded from other sources, e.g. arbitrary zip archives. ``None``
means the distribution is created in-memory.

Do not canonicalize this value with e.g. ``pathlib.Path.resolve()``. If
this is a symbolic link, we want to preserve the relative path between
it and files in the distribution.

Reimplemented in Distribution, and Distribution.

Definition at line 155 of file base.py.

    def location(self) -> Optional[str]:
        """Where the distribution is loaded from.
 
        A string value is not necessarily a filesystem path, since distributions
        can be loaded from other sources, e.g. arbitrary zip archives. ``None``
        means the distribution is created in-memory.
 
        Do not canonicalize this value with e.g. ``pathlib.Path.resolve()``. If
        this is a symbolic link, we want to preserve the relative path between
        it and files in the distribution.
        """
        raise NotImplementedError()
 

References i.

Referenced by BaseDistribution._iter_declared_entries_from_legacy(), Distribution._metadata_impl(), FilesystemWheel.as_zipfile(), BaseDistribution.editable_project_location(), BaseDistribution.installed_as_egg(), and Distribution.installed_location().

Here is the caller graph for this function:

◆ metadata()

email.message.Message metadata ( self )

Metadata of distribution parsed from e.g. METADATA or PKG-INFO.

This should return an empty message if the metadata file is unavailable.

:raises NoneMetadataError: If the metadata file is available, but does
    not contain valid metadata.

Definition at line 398 of file base.py.

    def metadata(self) -> email.message.Message:
        """Metadata of distribution parsed from e.g. METADATA or PKG-INFO.
 
        This should return an empty message if the metadata file is unavailable.
 
        :raises NoneMetadataError: If the metadata file is available, but does
            not contain valid metadata.
        """
        return self._metadata_cached()
 

References BaseDistribution._metadata_cached().

Referenced by Distribution._get_requirements(), InstallRequirement._set_requirement(), InstallRequirement.archive(), InstallRequirement.assert_source_matches_version(), Distribution.iter_dependencies(), Distribution.iter_provided_extras(), Distribution.matches_requirement(), BaseDistribution.metadata_version(), Distribution.provides(), BaseDistribution.raw_name(), BaseDistribution.requires_python(), Distribution.source_url(), and InstallRequirement.warn_on_mismatching_name().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ metadata_dict()

Dict[str, Any] metadata_dict ( self )

PEP 566 compliant JSON-serializable representation of METADATA or PKG-INFO.

This should return an empty dict if the metadata file is unavailable.

:raises NoneMetadataError: If the metadata file is available, but does
    not contain valid metadata.

Definition at line 409 of file base.py.

    def metadata_dict(self) -> Dict[str, Any]:
        """PEP 566 compliant JSON-serializable representation of METADATA or PKG-INFO.
 
        This should return an empty dict if the metadata file is unavailable.
 
        :raises NoneMetadataError: If the metadata file is available, but does
            not contain valid metadata.
        """
        return msg_to_json(self.metadata)
 

◆ metadata_version()

Optional[str] metadata_version ( self )

Value of "Metadata-Version:" in distribution metadata, if available.

Definition at line 420 of file base.py.

    def metadata_version(self) -> Optional[str]:
        """Value of "Metadata-Version:" in distribution metadata, if available."""
        return self.metadata.get("Metadata-Version")
 

References BaseDistribution.metadata(), BaseDistribution.metadata, InstallRequirement.metadata(), Distribution.metadata, and Wheel.metadata().

Referenced by LegacyMetadata._remove_line_prefix(), and LegacyMetadata.write_file().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ raw_name()

str raw_name ( self )

Value of "Name:" in distribution metadata.

Definition at line 425 of file base.py.

    def raw_name(self) -> str:
        """Value of "Name:" in distribution metadata."""
        # The metadata should NEVER be missing the Name: key, but if it somehow
        # does, fall back to the known canonical name.
        return self.metadata.get("Name", self.canonical_name)
 

References BaseDistribution.canonical_name(), BaseDistribution.canonical_name, Distribution.canonical_name(), FrozenRequirement.canonical_name, BaseDistribution.metadata(), BaseDistribution.metadata, InstallRequirement.metadata(), Distribution.metadata, and Wheel.metadata().

Referenced by BaseDistribution.editable_project_location(), Distribution.installed_location(), and BaseDistribution.setuptools_filename().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read_text()

str read_text	(		self,
		InfoPath	path
	)

Read a file in the info directory.

:raise FileNotFoundError: If ``path`` does not exist in the directory.
:raise NoneMetadataError: If ``path`` exists in the info directory, but
    cannot be read.

Reimplemented in Distribution, and Distribution.

Definition at line 374 of file base.py.

    def read_text(self, path: InfoPath) -> str:
        """Read a file in the info directory.
 
        :raise FileNotFoundError: If ``path`` does not exist in the directory.
        :raise NoneMetadataError: If ``path`` exists in the info directory, but
            cannot be read.
        """
        raise NotImplementedError()
 

References i.

Referenced by BaseDistribution._iter_declared_entries_from_legacy(), BaseDistribution._iter_declared_entries_from_record(), BaseDistribution._iter_requires_txt_entries(), Distribution._metadata_impl(), BaseDistribution.direct_url(), and BaseDistribution.installer().

Here is the caller graph for this function:

◆ requested()

bool requested ( self )

Definition at line 333 of file base.py.

    def requested(self) -> bool:
        return self.is_file("REQUESTED")
 

References Link.is_file(), BaseDistribution.is_file(), and Distribution.is_file().

Here is the call graph for this function:

◆ requires_python()

SpecifierSet requires_python ( self )

Value of "Requires-Python:" in distribution metadata.

If the key does not exist or contains an invalid value, an empty
SpecifierSet should be returned.

Definition at line 432 of file base.py.

    def requires_python(self) -> SpecifierSet:
        """Value of "Requires-Python:" in distribution metadata.
 
        If the key does not exist or contains an invalid value, an empty
        SpecifierSet should be returned.
        """
        value = self.metadata.get("Requires-Python")
        if value is None:
            return SpecifierSet()
        try:
            # Convert to str to satisfy the type checker; this can be a Header object.
            spec = SpecifierSet(str(value))
        except InvalidSpecifier as e:
            message = "Package %r has an invalid Requires-Python: %s"
            logger.warning(message, self.raw_name, e)
            return SpecifierSet()
        return spec
 

References BaseDistribution.metadata(), BaseDistribution.metadata, InstallRequirement.metadata(), Distribution.metadata, and Wheel.metadata().

Referenced by Link.__str__().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setuptools_filename()

str setuptools_filename ( self )

Convert a project name to its setuptools-compatible filename.

This is a copy of ``pkg_resources.to_filename()`` for compatibility.

Definition at line 287 of file base.py.

    def setuptools_filename(self) -> str:
        """Convert a project name to its setuptools-compatible filename.
 
        This is a copy of ``pkg_resources.to_filename()`` for compatibility.
        """
        return self.raw_name.replace("-", "_")
 

References BaseDistribution.raw_name(), and BaseDistribution.raw_name.

Here is the call graph for this function:

◆ version()

DistributionVersion version ( self )

Reimplemented in Distribution, and Distribution.

Definition at line 283 of file base.py.

    def version(self) -> DistributionVersion:
        raise NotImplementedError()
 

References i.

Referenced by AlreadyInstalledCandidate.__eq__(), Distribution.__eq__(), Distribution.__hash__(), InstallationCandidate.__repr__(), Distribution.__repr__(), Metadata.__repr__(), InstallationCandidate.__str__(), InstalledDistribution.__str__(), EggInfoDistribution.__str__(), PlatformDirsABC._append_app_name_and_version(), WrappedSocket._custom_validate(), Wheel._get_extensions(), Wheel.build(), Wheel.filename(), InstalledDistribution.get_distinfo_file(), Wheel.get_wheel_metadata(), LinuxDistribution.info(), Wheel.install(), LinuxDistribution.linux_distribution(), Wheel.metadata(), LinuxDistribution.name(), Distribution.name_and_version(), Distribution.provides(), Metadata.provides(), Wheel.update(), Wheel.verify(), and LinuxDistribution.version_parts().

Here is the caller graph for this function:

Field Documentation

◆ canonical_name

canonical_name

Reimplemented in Distribution, and Distribution.

Definition at line 315 of file base.py.

Referenced by BaseDistribution.raw_name().

◆ editable_project_location

editable_project_location

Definition at line 338 of file base.py.

◆ installed_location

installed_location

Reimplemented in Distribution, and Distribution.

Definition at line 348 of file base.py.

Referenced by BaseDistribution.in_site_packages(), BaseDistribution.in_usersite(), and BaseDistribution.local().

◆ metadata

metadata

Definition at line 417 of file base.py.

Referenced by Distribution._get_requirements(), InstallRequirement._set_requirement(), InstallRequirement.archive(), InstallRequirement.assert_source_matches_version(), Distribution.iter_dependencies(), Distribution.iter_provided_extras(), Distribution.matches_requirement(), BaseDistribution.metadata_version(), Distribution.provides(), BaseDistribution.raw_name(), BaseDistribution.requires_python(), Distribution.source_url(), and InstallRequirement.warn_on_mismatching_name().

◆ raw_name

raw_name

Definition at line 446 of file base.py.

Referenced by BaseDistribution.editable_project_location(), Distribution.installed_location(), and BaseDistribution.setuptools_filename().

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/metadata/base.py

Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Member Function Documentation

◆ __repr__()

◆ __str__()

◆ _add_egg_info_requires()

◆ _iter_declared_entries_from_legacy()

◆ _iter_declared_entries_from_record()

◆ _iter_egg_info_dependencies()

◆ _iter_egg_info_extras()

◆ _iter_requires_txt_entries()

◆ _metadata_cached()

◆ _metadata_impl()

◆ canonical_name()

◆ direct_url()

◆ editable()

◆ editable_project_location()

◆ from_directory()

◆ from_metadata_file_contents()

◆ from_wheel()

◆ in_site_packages()

◆ in_usersite()

◆ info_location()

◆ installed_as_egg()

◆ installed_by_distutils()

◆ installed_location()

◆ installed_with_dist_info()

◆ installed_with_setuptools_egg_info()

◆ installer()

◆ is_file()

◆ iter_declared_entries()

◆ iter_dependencies()

◆ iter_distutils_script_names()

◆ iter_entry_points()

◆ iter_provided_extras()

◆ local()

◆ location()

◆ metadata()

◆ metadata_dict()

◆ metadata_version()

◆ raw_name()

◆ read_text()

◆ requested()

◆ requires_python()

◆ setuptools_filename()

◆ version()

Field Documentation

◆ canonical_name

◆ editable_project_location

◆ installed_location

◆ metadata

◆ raw_name

◆ repr()

◆ str()