pip._internal.metadata.base Namespace Reference

Data Structures
class	BaseDistribution
class	BaseEntryPoint
class	BaseEnvironment
class	FilesystemWheel
class	MemoryWheel
class	RequiresEntry
class	Wheel

Functions
str	_convert_installed_files_path (Tuple[str,...] entry, Tuple[str,...] info)

Variables
	Protocol = object
	DistributionVersion = Union[LegacyVersion, Version]
	InfoPath = Union[str, pathlib.PurePath]
	logger = logging.getLogger(__name__)

Function Documentation

_convert_installed_files_path()

str _convert_installed_files_path ( Tuple[str, ...]  entry, Tuple[str, ...]  info  )

protected

Convert a legacy installed-files.txt path into modern RECORD path.

The legacy format stores paths relative to the info directory, while the
modern format stores paths relative to the package root, e.g. the
site-packages directory.

:param entry: Path parts of the installed-files.txt entry.
:param info: Path parts of the egg-info directory relative to package root.
:returns: The converted entry.

For best compatibility with symlinks, this does not use ``abspath()`` or
``Path.resolve()``, but tries to work with path parts:

1. While ``entry`` starts with ``..``, remove the equal amounts of parts
   from ``info``; if ``info`` is empty, start appending ``..`` instead.
2. Join the two directly.

Definition at line 71 of file base.py.

) -> str:
    """Convert a legacy installed-files.txt path into modern RECORD path.
 
    The legacy format stores paths relative to the info directory, while the
    modern format stores paths relative to the package root, e.g. the
    site-packages directory.
 
    :param entry: Path parts of the installed-files.txt entry.
    :param info: Path parts of the egg-info directory relative to package root.
    :returns: The converted entry.
 
    For best compatibility with symlinks, this does not use ``abspath()`` or
    ``Path.resolve()``, but tries to work with path parts:
 
    1. While ``entry`` starts with ``..``, remove the equal amounts of parts
       from ``info``; if ``info`` is empty, start appending ``..`` instead.
    2. Join the two directly.
    """
    while entry and entry[0] == "..":
        if not info or info[-1] == "..":
            info += ("..",)
        else:
            info = info[:-1]
        entry = entry[1:]
    return str(pathlib.Path(*info, *entry))
 
 

References i.

Referenced by BaseDistribution._iter_declared_entries_from_legacy().

Here is the caller graph for this function:

Variable Documentation

DistributionVersion

DistributionVersion = Union[LegacyVersion, Version]

Definition at line 50 of file base.py.

InfoPath

InfoPath = Union[str, pathlib.PurePath]

Definition at line 52 of file base.py.

logger

logger = logging.getLogger(__name__)

Definition at line 54 of file base.py.

Protocol

Protocol = object

Definition at line 48 of file base.py.