pip._internal.utils.entrypoints Namespace Reference

Functions
int	_wrapper (Optional[List[str]] args=None)
str	get_best_invocation_for_this_pip ()
str	get_best_invocation_for_this_python ()

Variables
list	_EXECUTABLE_NAMES
dict	_allowed_extensions = {"", ".exe"}

Function Documentation

_wrapper()

int _wrapper ( Optional[List[str]]   args = None )

protected

Central wrapper for all old entrypoints.

Historically pip has had several entrypoints defined. Because of issues
arising from PATH, sys.path, multiple Pythons, their interactions, and most
of them having a pip installed, users suffer every time an entrypoint gets
moved.

To alleviate this pain, and provide a mechanism for warning users and
directing them to an appropriate place for help, we now define all of
our old entrypoints as wrappers for the current one.

Definition at line 23 of file entrypoints.py.

def _wrapper(args: Optional[List[str]] = None) -> int:
    """Central wrapper for all old entrypoints.
 
    Historically pip has had several entrypoints defined. Because of issues
    arising from PATH, sys.path, multiple Pythons, their interactions, and most
    of them having a pip installed, users suffer every time an entrypoint gets
    moved.
 
    To alleviate this pain, and provide a mechanism for warning users and
    directing them to an appropriate place for help, we now define all of
    our old entrypoints as wrappers for the current one.
    """
    sys.stderr.write(
        "WARNING: pip is being invoked by an old script wrapper. This will "
        "fail in a future version of pip.\n"
        "Please see https://github.com/pypa/pip/issues/5599 for advice on "
        "fixing the underlying issue.\n"
        "To avoid this problem you can invoke Python with '-m pip' instead of "
        "running pip directly.\n"
    )
    return main(args)
 
 

References i.

get_best_invocation_for_this_pip()

str get_best_invocation_for_this_pip

(

)

Try to figure out the best way to invoke pip in the current environment.

Definition at line 46 of file entrypoints.py.

def get_best_invocation_for_this_pip() -> str:
    """Try to figure out the best way to invoke pip in the current environment."""
    binary_directory = "Scripts" if WINDOWS else "bin"
    binary_prefix = os.path.join(sys.prefix, binary_directory)
 
    # Try to use pip[X[.Y]] names, if those executables for this environment are
    # the first on PATH with that name.
    path_parts = os.path.normcase(os.environ.get("PATH", "")).split(os.pathsep)
    exe_are_in_PATH = os.path.normcase(binary_prefix) in path_parts
    if exe_are_in_PATH:
        for exe_name in _EXECUTABLE_NAMES:
            found_executable = shutil.which(exe_name)
            binary_executable = os.path.join(binary_prefix, exe_name)
            if (
                found_executable
                and os.path.exists(binary_executable)
                and os.path.samefile(
                    found_executable,
                    binary_executable,
                )
            ):
                return exe_name
 
    # Use the `-m` invocation, if there's no "nice" invocation.
    return f"{get_best_invocation_for_this_python()} -m pip"
 
 

References i.

get_best_invocation_for_this_python()

str get_best_invocation_for_this_python

(

)

Try to figure out the best way to invoke the current Python.

Definition at line 73 of file entrypoints.py.

def get_best_invocation_for_this_python() -> str:
    """Try to figure out the best way to invoke the current Python."""
    exe = sys.executable
    exe_name = os.path.basename(exe)
 
    # Try to use the basename, if it's the first executable.
    found_executable = shutil.which(exe_name)
    if found_executable and os.path.samefile(found_executable, exe):
        return exe_name
 
    # Use the full executable name, because we couldn't find something simpler.
    return exe

References i.

Variable Documentation

_allowed_extensions

dict _allowed_extensions = {"", ".exe"}

protected

Definition at line 16 of file entrypoints.py.

_EXECUTABLE_NAMES

list _EXECUTABLE_NAMES

protected

Initial value:

=  [
    "pip",
    f"pip{sys.version_info.major}",
    f"pip{sys.version_info.major}.{sys.version_info.minor}",
]

Definition at line 10 of file entrypoints.py.