pip._internal.build_env Namespace Reference

Data Structures
class	_Prefix
class	BuildEnvironment
class	NoOpBuildEnvironment

Functions
Union[Tuple[str], Tuple[str, str]]	_dedup (str a, str b)
str	get_runnable_pip ()
Set[str]	_get_system_sitepackages ()

Variables
	logger = logging.getLogger(__name__)

Detailed Description

Build Environment used for isolation during sdist building

Function Documentation

_dedup()

Union[Tuple[str], Tuple[str, str]] _dedup ( str  a, str  b  )

protected

Definition at line 31 of file build_env.py.

def _dedup(a: str, b: str) -> Union[Tuple[str], Tuple[str, str]]:
    return (a, b) if a != b else (a,)
 
 

_get_system_sitepackages()

Set[str] _get_system_sitepackages ( )

protected

Get system site packages

Usually from site.getsitepackages,
but fallback on `get_purelib()/get_platlib()` if unavailable
(e.g. in a virtualenv created by virtualenv<20)

Returns normalized set of strings.

Definition at line 60 of file build_env.py.

def _get_system_sitepackages() -> Set[str]:
    """Get system site packages
 
    Usually from site.getsitepackages,
    but fallback on `get_purelib()/get_platlib()` if unavailable
    (e.g. in a virtualenv created by virtualenv<20)
 
    Returns normalized set of strings.
    """
    if hasattr(site, "getsitepackages"):
        system_sites = site.getsitepackages()
    else:
        # virtualenv < 20 overwrites site.py without getsitepackages
        # fallback on get_purelib/get_platlib.
        # this is known to miss things, but shouldn't in the cases
        # where getsitepackages() has been removed (inside a virtualenv)
        system_sites = [get_purelib(), get_platlib()]
    return {os.path.normcase(path) for path in system_sites}
 
 

References i.

get_runnable_pip()

str get_runnable_pip

(

)

Get a file to pass to a Python executable, to run the currently-running pip.

This is used to run a pip subprocess, for installing requirements into the build
environment.

Definition at line 44 of file build_env.py.

def get_runnable_pip() -> str:
    """Get a file to pass to a Python executable, to run the currently-running pip.
 
    This is used to run a pip subprocess, for installing requirements into the build
    environment.
    """
    source = pathlib.Path(pip_location).resolve().parent
 
    if not source.is_dir():
        # This would happen if someone is using pip from inside a zip file. In that
        # case, we can use that directly.
        return str(source)
 
    return os.fsdecode(source / "__pip-runner__.py")
 
 

References i.

Referenced by BuildEnvironment.install_requirements().

Here is the caller graph for this function:

Variable Documentation

logger

logger = logging.getLogger(__name__)

Definition at line 28 of file build_env.py.