pip._internal.cli.req_command Namespace Reference

Data Structures
class	IndexGroupCommand
class	RequirementCommand
class	SessionCommandMixin

Functions
Optional["SSLContext"]	_create_truststore_ssl_context ()
None	warn_if_run_as_root ()
Any	with_cleanup (Any func)

Variables
	logger = logging.getLogger(__name__)
list	KEEPABLE_TEMPDIR_TYPES
	tempdir_registry

Detailed Description

Contains the Command base classes that depend on PipSession.

The classes in this module are in a separate module so the commands not
needing download / PackageFinder capability don't unnecessarily import the
PackageFinder machinery and all its vendored dependencies, etc.

Function Documentation

_create_truststore_ssl_context()

Optional["SSLContext"] _create_truststore_ssl_context ( )

protected

Definition at line 50 of file req_command.py.

def _create_truststore_ssl_context() -> Optional["SSLContext"]:
    if sys.version_info < (3, 10):
        raise CommandError("The truststore feature is only available for Python 3.10+")
 
    try:
        import ssl
    except ImportError:
        logger.warning("Disabling truststore since ssl support is missing")
        return None
 
    try:
        import truststore
    except ImportError:
        raise CommandError(
            "To use the truststore feature, 'truststore' must be installed into "
            "pip's current environment."
        )
 
    return truststore.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
 
 

References i.

Referenced by SessionCommandMixin._build_session().

Here is the caller graph for this function:

warn_if_run_as_root()

None warn_if_run_as_root

(

)

Output a warning for sudo users on Unix.

In a virtual environment, sudo pip still writes to virtualenv.
On Windows, users may run pip as Administrator without issues.
This warning only applies to Unix root users outside of virtualenv.

Definition at line 201 of file req_command.py.

def warn_if_run_as_root() -> None:
    """Output a warning for sudo users on Unix.
 
    In a virtual environment, sudo pip still writes to virtualenv.
    On Windows, users may run pip as Administrator without issues.
    This warning only applies to Unix root users outside of virtualenv.
    """
    if running_under_virtualenv():
        return
    if not hasattr(os, "getuid"):
        return
    # On Windows, there are no "system managed" Python packages. Installing as
    # Administrator via pip is the correct way of updating system environments.
    #
    # We choose sys.platform over utils.compat.WINDOWS here to enable Mypy platform
    # checks: https://mypy.readthedocs.io/en/stable/common_issues.html
    if sys.platform == "win32" or sys.platform == "cygwin":
        return
 
    if os.getuid() != 0:
        return
 
    logger.warning(
        "Running pip as the 'root' user can result in broken permissions and "
        "conflicting behaviour with the system package manager. "
        "It is recommended to use a virtual environment instead: "
        "https://pip.pypa.io/warnings/venv"
    )
 
 

References i.

with_cleanup()

Any with_cleanup

(

Any

func

)

Decorator for common logic related to managing temporary
directories.

Definition at line 231 of file req_command.py.

def with_cleanup(func: Any) -> Any:
    """Decorator for common logic related to managing temporary
    directories.
    """
 
    def configure_tempdir_registry(registry: TempDirectoryTypeRegistry) -> None:
        for t in KEEPABLE_TEMPDIR_TYPES:
            registry.set_delete(t, False)
 
    def wrapper(
        self: RequirementCommand, options: Values, args: List[Any]
    ) -> Optional[int]:
        assert self.tempdir_registry is not None
        if options.no_clean:
            configure_tempdir_registry(self.tempdir_registry)
 
        try:
            return func(self, options, args)
        except PreviousBuildDirError:
            # This kind of conflict can occur when the user passes an explicit
            # build directory with a pre-existing folder. In that case we do
            # not want to accidentally remove it.
            configure_tempdir_registry(self.tempdir_registry)
            raise
 
    return wrapper
 
 

References i.

Variable Documentation

KEEPABLE_TEMPDIR_TYPES

list KEEPABLE_TEMPDIR_TYPES

Initial value:

=  [
    tempdir_kinds.BUILD_ENV,
    tempdir_kinds.EPHEM_WHEEL_CACHE,
    tempdir_kinds.REQ_BUILD,
]

Definition at line 194 of file req_command.py.

logger

logger = logging.getLogger(__name__)

Definition at line 47 of file req_command.py.

tempdir_registry

tempdir_registry

Definition at line 245 of file req_command.py.