pip._internal.cli.req_command Namespace Reference

Classes
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

warn_if_run_as_root()

None pip._internal.cli.req_command.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.

with_cleanup()

Any pip._internal.cli.req_command.with_cleanup

(

Any

func

)

Decorator for common logic related to managing temporary
directories.

Variable Documentation

KEEPABLE_TEMPDIR_TYPES

list pip._internal.cli.req_command.KEEPABLE_TEMPDIR_TYPES

Initial value:

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