BuildEnvironment Class Reference

Inheritance diagram for BuildEnvironment:

Public Member Functions
None	__init__ (self)
None	__enter__ (self)
None	__exit__ (self, Optional[Type[BaseException]] exc_type, Optional[BaseException] exc_val, Optional[TracebackType] exc_tb)
Tuple[Set[Tuple[str, str]], Set[str]]	check_requirements (self, Iterable[str] reqs)
None	install_requirements (self, "PackageFinder" finder, Iterable[str] requirements, str prefix_as_string, *str kind)

Static Protected Member Functions
None	_install_requirements (str pip_runnable, "PackageFinder" finder, Iterable[str] requirements, _Prefix prefix, *str kind)

Protected Attributes
	_prefixes
	_site_dir
	_save_env
	_lib_dirs

Detailed Description

Creates and manages an isolated environment to install build deps

Definition at line 80 of file build_env.py.

Constructor & Destructor Documentation

__init__()

None __init__

(

self

)

Reimplemented in NoOpBuildEnvironment.

Definition at line 83 of file build_env.py.

    def __init__(self) -> None:
        temp_dir = TempDirectory(kind=tempdir_kinds.BUILD_ENV, globally_managed=True)
 
        self._prefixes = OrderedDict(
            (name, _Prefix(os.path.join(temp_dir.path, name)))
            for name in ("normal", "overlay")
        )
 
        self._bin_dirs: List[str] = []
        self._lib_dirs: List[str] = []
        for prefix in reversed(list(self._prefixes.values())):
            self._bin_dirs.append(prefix.bin_dir)
            self._lib_dirs.extend(prefix.lib_dirs)
 
        # Customize site to:
        # - ensure .pth files are honored
        # - prevent access to system site packages
        system_sites = _get_system_sitepackages()
 
        self._site_dir = os.path.join(temp_dir.path, "site")
        if not os.path.exists(self._site_dir):
            os.mkdir(self._site_dir)
        with open(
            os.path.join(self._site_dir, "sitecustomize.py"), "w", encoding="utf-8"
        ) as fp:
            fp.write(
                textwrap.dedent(
                    """
                import os, site, sys
 
                # First, drop system-sites related paths.
                original_sys_path = sys.path[:]
                known_paths = set()
                for path in {system_sites!r}:
                    site.addsitedir(path, known_paths=known_paths)
                system_paths = set(
                    os.path.normcase(path)
                    for path in sys.path[len(original_sys_path):]
                )
                original_sys_path = [
                    path for path in original_sys_path
                    if os.path.normcase(path) not in system_paths
                ]
                sys.path = original_sys_path
 
                # Second, add lib directories.
                # ensuring .pth file are processed.
                for path in {lib_dirs!r}:
                    assert not path in sys.path
                    site.addsitedir(path)
                """
                ).format(system_sites=system_sites, lib_dirs=self._lib_dirs)
            )
 

References i.

Referenced by Protocol.__init_subclass__().

Here is the caller graph for this function:

Member Function Documentation

__enter__()

None __enter__

(

self

)

Reimplemented in NoOpBuildEnvironment.

Definition at line 137 of file build_env.py.

    def __enter__(self) -> None:
        self._save_env = {
            name: os.environ.get(name, None)
            for name in ("PATH", "PYTHONNOUSERSITE", "PYTHONPATH")
        }
 
        path = self._bin_dirs[:]
        old_path = self._save_env["PATH"]
        if old_path:
            path.extend(old_path.split(os.pathsep))
 
        pythonpath = [self._site_dir]
 
        os.environ.update(
            {
                "PATH": os.pathsep.join(path),
                "PYTHONNOUSERSITE": "1",
                "PYTHONPATH": os.pathsep.join(pythonpath),
            }
        )
 

__exit__()

None __exit__	(		self,
		Optional[Type[BaseException]]	exc_type,
		Optional[BaseException]	exc_val,
		Optional[TracebackType]	exc_tb
	)

Reimplemented in NoOpBuildEnvironment.

Definition at line 158 of file build_env.py.

    ) -> None:
        for varname, old_value in self._save_env.items():
            if old_value is None:
                os.environ.pop(varname, None)
            else:
                os.environ[varname] = old_value
 

References BuildEnvironment._save_env, and i.

_install_requirements()

None _install_requirements ( str  pip_runnable, "PackageFinder"  finder, Iterable[str]  requirements, _Prefix  prefix, *str  kind  )

staticprotected

Definition at line 226 of file build_env.py.

    ) -> None:
        args: List[str] = [
            sys.executable,
            pip_runnable,
            "install",
            "--ignore-installed",
            "--no-user",
            "--prefix",
            prefix.path,
            "--no-warn-script-location",
        ]
        if logger.getEffectiveLevel() <= logging.DEBUG:
            args.append("-v")
        for format_control in ("no_binary", "only_binary"):
            formats = getattr(finder.format_control, format_control)
            args.extend(
                (
                    "--" + format_control.replace("_", "-"),
                    ",".join(sorted(formats or {":none:"})),
                )
            )
 
        index_urls = finder.index_urls
        if index_urls:
            args.extend(["-i", index_urls[0]])
            for extra_index in index_urls[1:]:
                args.extend(["--extra-index-url", extra_index])
        else:
            args.append("--no-index")
        for link in finder.find_links:
            args.extend(["--find-links", link])
 
        for host in finder.trusted_hosts:
            args.extend(["--trusted-host", host])
        if finder.allow_all_prereleases:
            args.append("--pre")
        if finder.prefer_binary:
            args.append("--prefer-binary")
        args.append("--")
        args.extend(requirements)
        extra_environ = {"_PIP_STANDALONE_CERT": where()}
        with open_spinner(f"Installing {kind}") as spinner:
            call_subprocess(
                args,
                command_desc=f"pip subprocess to install {kind}",
                spinner=spinner,
                extra_environ=extra_environ,
            )
 
 

References i.

Referenced by BuildEnvironment.install_requirements(), and InstallationReport.to_dict().

Here is the caller graph for this function:

check_requirements()

Tuple[Set[Tuple[str, str]], Set[str]] check_requirements	(		self,
		Iterable[str]	reqs
	)

Return 2 sets:
- conflicting requirements: set of (installed, wanted) reqs tuples
- missing requirements: set of reqs

Definition at line 170 of file build_env.py.

    ) -> Tuple[Set[Tuple[str, str]], Set[str]]:
        """Return 2 sets:
        - conflicting requirements: set of (installed, wanted) reqs tuples
        - missing requirements: set of reqs
        """
        missing = set()
        conflicting = set()
        if reqs:
            env = (
                get_environment(self._lib_dirs)
                if hasattr(self, "_lib_dirs")
                else get_default_environment()
            )
            for req_str in reqs:
                req = Requirement(req_str)
                # We're explicitly evaluating with an empty extra value, since build
                # environments are not provided any mechanism to select specific extras.
                if req.marker is not None and not req.marker.evaluate({"extra": ""}):
                    continue
                dist = env.get_distribution(req.name)
                if not dist:
                    missing.add(req_str)
                    continue
                if isinstance(dist.version, Version):
                    installed_req_str = f"{req.name}=={dist.version}"
                else:
                    installed_req_str = f"{req.name}==={dist.version}"
                if not req.specifier.contains(dist.version, prereleases=True):
                    conflicting.add((installed_req_str, req_str))
                # FIXME: Consider direct URL?
        return conflicting, missing
 

install_requirements()

None install_requirements	(		self,
		"PackageFinder"	finder,
		Iterable[str]	requirements,
		str	prefix_as_string,
		*str	kind
	)

Reimplemented in NoOpBuildEnvironment.

Definition at line 204 of file build_env.py.

    ) -> None:
        prefix = self._prefixes[prefix_as_string]
        assert not prefix.setup
        prefix.setup = True
        if not requirements:
            return
        self._install_requirements(
            get_runnable_pip(),
            finder,
            requirements,
            prefix,
            kind=kind,
        )
 

References BuildEnvironment._install_requirements(), InstallationReport._install_requirements, BuildEnvironment._prefixes, pip._internal.build_env.get_runnable_pip(), and i.

Here is the call graph for this function:

Field Documentation

_lib_dirs

_lib_dirs

protected

Definition at line 181 of file build_env.py.

_prefixes

_prefixes

protected

Definition at line 86 of file build_env.py.

Referenced by BuildEnvironment.install_requirements().

_save_env

_save_env

protected

Definition at line 138 of file build_env.py.

Referenced by BuildEnvironment.__exit__().

_site_dir

_site_dir

protected

Definition at line 102 of file build_env.py.

---

The documentation for this class was generated from the following file:

• /home/liwuen/projects_dev/pqc-engineering-ssec-23/venv/lib/python3.12/site-packages/pip/_internal/build_env.py