pip._internal.locations._distutils Namespace Reference

Functions
Dict[str, str]	distutils_scheme (str dist_name, bool user=False, Optional[str] home=None, Optional[str] root=None, bool isolated=False, Optional[str] prefix=None, *bool ignore_config_files=False)
Scheme	get_scheme (str dist_name, bool user=False, Optional[str] home=None, Optional[str] root=None, bool isolated=False, Optional[str] prefix=None)
str	get_bin_prefix ()
str	get_purelib ()
str	get_platlib ()

Variables
	logger = logging.getLogger(__name__)

Detailed Description

Locations where we look for configs, install stuff, etc

Function Documentation

distutils_scheme()

Dict[str, str] pip._internal.locations._distutils.distutils_scheme	(	str	dist_name,
		bool	user = False,
		Optional[str]	home = None,
		Optional[str]	root = None,
		bool	isolated = False,
		Optional[str]	prefix = None,
		*bool	ignore_config_files = False
	)

Return a distutils install scheme

get_scheme()

Scheme pip._internal.locations._distutils.get_scheme	(	str	dist_name,
		bool	user = False,
		Optional[str]	home = None,
		Optional[str]	root = None,
		bool	isolated = False,
		Optional[str]	prefix = None
	)

Get the "scheme" corresponding to the input parameters. The distutils
documentation provides the context for the available schemes:
https://docs.python.org/3/install/index.html#alternate-installation

:param dist_name: the name of the package to retrieve the scheme for, used
    in the headers scheme path
:param user: indicates to use the "user" scheme
:param home: indicates to use the "home" scheme and provides the base
    directory for the same
:param root: root under which other directories are re-based
:param isolated: equivalent to --no-user-cfg, i.e. do not consider
    ~/.pydistutils.cfg (posix) or ~/pydistutils.cfg (non-posix) for
    scheme paths
:param prefix: indicates to use the "prefix" scheme and provides the
    base directory for the same