pip._internal.locations.base Namespace Reference

Functions
str	get_major_minor_version ()
str	change_root (str new_root, str pathname)
str	get_src_prefix ()
bool	is_osx_framework ()

Variables
	USER_CACHE_DIR = appdirs.user_cache_dir("pip")
str	site_packages = sysconfig.get_path("purelib")
typing	user_site = site.getusersitepackages()

Function Documentation

change_root()

str change_root	(	str	new_root,
		str	pathname
	)

Return 'pathname' with 'new_root' prepended.

If 'pathname' is relative, this is equivalent to os.path.join(new_root, pathname).
Otherwise, it requires making 'pathname' relative and then joining the
two, which is tricky on DOS/Windows and Mac OS.

This is borrowed from Python's standard library's distutils module.

Definition at line 27 of file base.py.

def change_root(new_root: str, pathname: str) -> str:
    """Return 'pathname' with 'new_root' prepended.
 
    If 'pathname' is relative, this is equivalent to os.path.join(new_root, pathname).
    Otherwise, it requires making 'pathname' relative and then joining the
    two, which is tricky on DOS/Windows and Mac OS.
 
    This is borrowed from Python's standard library's distutils module.
    """
    if os.name == "posix":
        if not os.path.isabs(pathname):
            return os.path.join(new_root, pathname)
        else:
            return os.path.join(new_root, pathname[1:])
 
    elif os.name == "nt":
        (drive, path) = os.path.splitdrive(pathname)
        if path[0] == "\\":
            path = path[1:]
        return os.path.join(new_root, path)
 
    else:
        raise InstallationError(
            f"Unknown platform: {os.name}\n"
            "Can not change root path prefix on unknown platform."
        )
 
 

References i.

get_major_minor_version()

str get_major_minor_version

(

)

Return the major-minor version of the current Python as a string, e.g.
"3.7" or "3.10".

Definition at line 19 of file base.py.

def get_major_minor_version() -> str:
    """
    Return the major-minor version of the current Python as a string, e.g.
    "3.7" or "3.10".
    """
    return "{}.{}".format(*sys.version_info)
 
 

References i.

get_src_prefix()

str get_src_prefix

(

)

Definition at line 55 of file base.py.

def get_src_prefix() -> str:
    if running_under_virtualenv():
        src_prefix = os.path.join(sys.prefix, "src")
    else:
        # FIXME: keep src in cwd for now (it is not a temporary folder)
        try:
            src_prefix = os.path.join(os.getcwd(), "src")
        except OSError:
            # In case the current working directory has been renamed or deleted
            sys.exit("The folder you are executing pip from can no longer be found.")
 
    # under macOS + virtualenv sys.prefix is not properly resolved
    # it is something like /path/to/python/bin/..
    return os.path.abspath(src_prefix)
 
 

References i.

is_osx_framework()

bool is_osx_framework

(

)

Definition at line 80 of file base.py.

def is_osx_framework() -> bool:
    return bool(sysconfig.get_config_var("PYTHONFRAMEWORK"))

References i.

Variable Documentation

site_packages

str site_packages = sysconfig.get_path("purelib")

Definition at line 16 of file base.py.

USER_CACHE_DIR

USER_CACHE_DIR = appdirs.user_cache_dir("pip")

Definition at line 13 of file base.py.

user_site

user_site = site.getusersitepackages()

Definition at line 74 of file base.py.