File size: 18,057 Bytes
7c99225 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 | from __future__ import annotations
__lazy_modules__ = [
'abc',
'contextlib',
f'{__spec__.parent}._ctx',
f'{__spec__.parent}._exceptions',
f'{__spec__.parent}._util',
'importlib',
'importlib.util',
'os',
'platform',
'shutil',
'subprocess',
'sys',
'sysconfig',
'tempfile',
'warnings',
]
import abc
import contextlib
import functools
import importlib.util
import os
import platform
import shutil
import subprocess
import sys
import sysconfig
import tempfile
import typing
import warnings
from . import _ctx
from ._ctx import run_subprocess
from ._exceptions import FailedProcessError
from ._util import check_dependency
TYPE_CHECKING = False
if TYPE_CHECKING:
from collections.abc import Collection, Mapping
from ._compat.importlib import metadata as importlib_metadata
if sys.version_info < (3, 11):
from typing_extensions import Self
else:
from typing import Self
Installer = typing.Literal['pip', 'uv']
INSTALLERS = typing.get_args(Installer)
class IsolatedEnv(typing.Protocol):
"""Isolated build environment ABC."""
@property
@abc.abstractmethod
def python_executable(self) -> str:
"""The Python executable of the isolated environment."""
@abc.abstractmethod
def make_extra_environ(self) -> Mapping[str, str] | None:
"""Generate additional env vars specific to the isolated environment."""
def _has_dependency(
name: str, minimum_version_str: str | None = None, /, **distargs: object
) -> importlib_metadata.Distribution | None:
"""
Given a distribution name, see if it is present and return the distribution
if the version is sufficient for build, None if the package is missing or
too old.
"""
from packaging.version import Version
from ._compat import importlib
try:
distribution = next(iter(importlib.metadata.distributions(name=name, **distargs)))
except StopIteration:
return None
if minimum_version_str is None:
return distribution
if Version(distribution.version) < Version(minimum_version_str):
return None
return distribution
class DefaultIsolatedEnv(IsolatedEnv):
"""
Isolated environment which supports several different underlying implementations.
"""
def __init__(
self,
*,
installer: Installer = 'pip',
) -> None:
self.installer: Installer = installer
def __enter__(self) -> Self:
try:
path = tempfile.mkdtemp(prefix='build-env-')
# Call ``realpath`` to prevent spurious warning from being emitted
# that the venv location has changed on Windows for the venv impl.
# The username is DOS-encoded in the output of tempfile - the location is the same
# but the representation of it is different, which confuses venv.
# Ref: https://bugs.python.org/issue46171
path = os.path.realpath(path)
self._path = path
self._env_backend: _EnvBackend
# uv is opt-in only.
if self.installer == 'uv':
self._env_backend = _UvBackend()
else:
self._env_backend = _PipBackend()
_ctx.log(f'Creating isolated environment: {self._env_backend.display_name}...', kind=('step',))
self._env_backend.create(self._path)
except Exception: # cleanup folder if creation fails
self.__exit__(*sys.exc_info())
raise
return self
def __exit__(self, *args: object) -> None:
shutil.rmtree(self._path, ignore_errors=True)
@property
def path(self) -> str:
"""The location of the isolated build environment."""
return self._path
@property
def python_executable(self) -> str:
"""The python executable of the isolated build environment."""
return self._env_backend.python_executable
def make_extra_environ(self) -> dict[str, str]:
path = os.environ.get('PATH')
return {
'PATH': os.pathsep.join([self._env_backend.scripts_dir, path])
if path is not None
else self._env_backend.scripts_dir,
# Set PYTHONPATH to empty to override any host value. An empty
# PYTHONPATH is treated as unset by CPython's path initialization
# (the ``if pythonpath_env:`` check makes it a no-op).
'PYTHONPATH': '',
}
def install(
self,
requirements: Collection[str],
constraints: Collection[str] = [],
*,
_fresh: bool = False, # Used internally by CLI to support preset PYTHONPATH
) -> None:
"""
Install packages from PEP 508 requirements in the isolated build environment.
:param requirements: PEP 508 requirement specification to install
:note: Passing non-PEP 508 strings will result in undefined behavior, you *should not* rely on it. It is
merely an implementation detail, it may change any time without warning.
"""
if not requirements:
return
_ctx.log(
'Installing packages in isolated environment:\n' + '\n'.join(f'- {r}' for r in sorted(requirements)),
kind=('step',),
)
self._env_backend.install_dependencies(requirements, constraints, _fresh=_fresh)
class _EnvBackend(typing.Protocol): # pragma: no cover
python_executable: str
scripts_dir: str
def create(self, path: str) -> None: ...
def install_dependencies(
self,
requirements: Collection[str],
constraints: Collection[str],
*,
_fresh: bool = False,
) -> None: ...
@property
def display_name(self) -> str: ...
@functools.cache
def _has_keyring_cli() -> bool:
return shutil.which('keyring') is not None
def _pip_env() -> dict[str, str] | None:
if 'PIP_KEYRING_PROVIDER' not in os.environ and _has_keyring_cli():
return {**os.environ, 'PIP_KEYRING_PROVIDER': 'subprocess'}
return None
class _PipBackend(_EnvBackend):
def __init__(self) -> None:
self._create_with_virtualenv = not self._has_valid_outer_pip and self._has_virtualenv
@functools.cached_property
def _has_valid_outer_pip(self) -> bool | None:
"""
This checks for a valid global pip. Returns None if pip is missing, False
if pip is too old or debundled, and True if it can be used.
"""
# Version to have added the `--python` option.
# `pip install --python` is nonfunctional on Gentoo debundled pip.
if dist := _has_dependency('pip', '22.3'): # pragma: no cover
files = dist.files
if files:
return any(str(f).startswith('pip/_vendor') for f in files)
# The distribution package manager deleted the RECORD file,
# generally to force pip to be unable to uninstall itself
# Only try this on 3.12+ since it can have side effects before 3.12
# due to _distutils_hack and pip interacting.
if sys.version_info >= (3, 12):
with warnings.catch_warnings():
warnings.simplefilter('ignore')
if importlib.util.find_spec('pip._vendor') is not None:
return True
return False
return None # pragma: no cover
@functools.cached_property
def _has_virtualenv(self) -> bool:
"""
virtualenv might be incompatible if it was installed separately
from build. This verifies that virtualenv and all of its
dependencies are installed as required by build.
"""
from packaging.requirements import Requirement
name = 'virtualenv'
return importlib.util.find_spec(name) is not None and not any(
Requirement(d[1]).name == name for d in check_dependency(f'build[{name}]') if len(d) > 1
)
@staticmethod
def _get_minimum_pip_version_str() -> str:
if platform.system() == 'Darwin':
release, _, machine = platform.mac_ver()
if int(release[: release.find('.')]) >= 11:
# macOS 11+ name scheme change requires 20.3. Intel macOS 11.0 can be
# told to report 10.16 for backwards compatibility; but that also fixes
# earlier versions of pip so this is only needed for 11+.
is_apple_silicon_python = machine != 'x86_64'
return '21.0.1' if is_apple_silicon_python else '20.3.0'
# PEP-517 and manylinux1 was first implemented in 19.1
return '19.1.0'
def create(self, path: str) -> None:
if self._create_with_virtualenv:
import packaging.version
import virtualenv
from ._compat import importlib
virtualenv_ver = packaging.version.Version(importlib.metadata.version('virtualenv'))
opts = [
path,
'--activators',
'',
'--no-setuptools',
'--no-periodic-update',
]
if virtualenv_ver < packaging.version.Version('20.31.0'):
opts.append('--no-wheel')
result = virtualenv.cli_run(opts, setup_logging=False)
# The creator attributes are `pathlib.Path`s.
self.python_executable = str(result.creator.exe)
self.scripts_dir = str(result.creator.script_dir)
else:
import venv
with_pip = not self._has_valid_outer_pip
try:
venv.EnvBuilder(symlinks=_fs_supports_symlink(), with_pip=with_pip).create(path)
except subprocess.CalledProcessError as exc:
_ctx.log_subprocess_error(exc)
raise FailedProcessError(exc, 'Failed to create venv. Maybe try installing virtualenv.') from None
self.python_executable, self.scripts_dir, purelib = _find_executable_and_scripts(path)
if with_pip:
minimum_pip_version_str = self._get_minimum_pip_version_str()
if not _has_dependency(
'pip',
minimum_pip_version_str,
path=[purelib],
):
run_subprocess(
[self.python_executable, '-Im', 'pip', 'install', '--no-input', f'pip>={minimum_pip_version_str}'],
env=_pip_env(),
)
# Uninstall setuptools from the build env to prevent depending on it implicitly.
# Pythons 3.12 and up do not install setuptools, check if it exists first.
if _has_dependency(
'setuptools',
path=[purelib],
):
run_subprocess(
[self.python_executable, '-Im', 'pip', 'uninstall', '--no-input', '-y', 'setuptools'],
env=_pip_env(),
)
def install_dependencies(
self,
requirements: Collection[str],
constraints: Collection[str],
*,
_fresh: bool = False,
) -> None:
with contextlib.ExitStack() as exit_stack:
if self._has_valid_outer_pip:
cmd = [sys.executable, '-m', 'pip', '--python', self.python_executable]
else:
cmd = [self.python_executable, '-Im', 'pip']
if (verbosity := _ctx.verbosity) > 1:
cmd += [f'-{"v" * (verbosity - 1)}']
cmd += ['install']
if _fresh:
cmd += ['--ignore-installed']
cmd += ['--use-pep517', '--no-warn-script-location', '--no-compile', '--no-input']
# pip does not honour environment markers in command line arguments
# but it does from requirement files.
with tempfile.NamedTemporaryFile(
'w', prefix='build-requirements-', suffix='.txt', delete=False, encoding='utf-8'
) as requirement_file:
requirement_file.write(os.linesep.join(requirements))
exit_stack.callback(functools.partial(os.unlink, requirement_file.name))
cmd += ['-r', os.path.abspath(requirement_file.name)]
if constraints:
with tempfile.NamedTemporaryFile(
'w', prefix='build-constraints-', suffix='.txt', delete=False, encoding='utf-8'
) as constraint_file:
constraint_file.write(os.linesep.join(constraints))
exit_stack.callback(functools.partial(os.unlink, constraint_file.name))
cmd += ['-c', os.path.abspath(constraint_file.name)]
run_subprocess(cmd, env=_pip_env())
@property
def display_name(self) -> str:
return 'virtualenv+pip' if self._create_with_virtualenv else 'venv+pip'
class _UvBackend(_EnvBackend):
def create(self, path: str) -> None:
import venv
self._env_path = path
try:
import uv
self._uv_bin = uv.find_uv_bin()
except (ModuleNotFoundError, FileNotFoundError):
uv_bin = shutil.which(os.environ.get('UV') or 'uv')
if uv_bin is None:
msg = 'uv executable not found'
raise RuntimeError(msg) from None
_ctx.log(f'Using external uv from {uv_bin}')
self._uv_bin = uv_bin
venv.EnvBuilder(symlinks=_fs_supports_symlink(), with_pip=False).create(self._env_path)
self.python_executable, self.scripts_dir, _ = _find_executable_and_scripts(self._env_path)
def install_dependencies( # pragma: no cover -- uv tests are skipped on PyPy, covered on CPython
self,
requirements: Collection[str],
constraints: Collection[str],
*,
_fresh: bool = False,
) -> None:
with contextlib.ExitStack() as exit_stack:
cmd = [self._uv_bin, 'pip']
if (verbosity := _ctx.verbosity) > 1:
cmd += [f'-{"v" * min(2, verbosity - 1)}']
cmd += ['install', *requirements, '--python', self.python_executable]
if constraints:
with tempfile.NamedTemporaryFile(
'w', prefix='build-constraints-', suffix='.txt', delete=False, encoding='utf-8'
) as constraint_file:
constraint_file.write(os.linesep.join(constraints))
exit_stack.callback(functools.partial(os.unlink, constraint_file.name))
cmd += ['-c', os.path.abspath(constraint_file.name)]
env = {k: v for k, v in os.environ.items() if k != 'PYTHONPATH'}
env['VIRTUAL_ENV'] = self._env_path
if 'UV_KEYRING_PROVIDER' not in os.environ and _has_keyring_cli():
env['UV_KEYRING_PROVIDER'] = 'subprocess'
run_subprocess(cmd, env=env)
@property
def display_name(self) -> str:
return 'venv+uv'
@functools.cache
def _fs_supports_symlink() -> bool:
"""Return True if symlinks are supported"""
# Using definition used by venv.main()
if os.name != 'nt':
return True # pragma: win32 no cover
# Windows may support symlinks (setting in Windows 10)
with tempfile.NamedTemporaryFile(prefix='build-symlink-') as tmp_file: # pragma: win32 cover
dest = f'{tmp_file}-b'
try:
os.symlink(tmp_file.name, dest)
os.unlink(dest)
except (OSError, NotImplementedError, AttributeError):
return False
return True
def _find_executable_and_scripts(path: str) -> tuple[str, str, str]:
"""
Detect the Python executable and script folder of a virtual environment.
:param path: The location of the virtual environment
:return: The Python executable, script folder, and purelib folder
"""
config_vars = sysconfig.get_config_vars().copy() # globally cached, copy before altering it
config_vars['base'] = path
scheme_names = sysconfig.get_scheme_names()
if 'venv' in scheme_names:
# Python distributors with custom default installation scheme can set a
# scheme that can't be used to expand the paths in a venv.
# This can happen if build itself is not installed in a venv.
# The distributors are encouraged to set a "venv" scheme to be used for this.
# See https://bugs.python.org/issue45413
# and https://github.com/pypa/virtualenv/issues/2208
paths = sysconfig.get_paths(scheme='venv', vars=config_vars) # pragma: no cover
elif 'posix_local' in scheme_names:
# The Python that ships on Debian/Ubuntu varies the default scheme to
# install to /usr/local
# But it does not (yet) set the "venv" scheme.
# If we're the Debian "posix_local" scheme is available, but "venv"
# is not, we use "posix_prefix" instead which is venv-compatible there.
paths = sysconfig.get_paths(scheme='posix_prefix', vars=config_vars)
elif 'osx_framework_library' in scheme_names:
# The Python that ships with the macOS developer tools varies the
# default scheme depending on whether the ``sys.prefix`` is part of a framework.
# But it does not (yet) set the "venv" scheme.
# If the Apple-custom "osx_framework_library" scheme is available but "venv"
# is not, we use "posix_prefix" instead which is venv-compatible there.
paths = sysconfig.get_paths(scheme='posix_prefix', vars=config_vars)
else:
paths = sysconfig.get_paths(vars=config_vars)
executable = os.path.join(paths['scripts'], 'python.exe' if os.name == 'nt' else 'python')
if not os.path.exists(executable):
msg = f'Virtual environment creation failed, executable {executable} missing'
raise RuntimeError(msg)
return executable, paths['scripts'], paths['purelib']
__all__ = [
'DefaultIsolatedEnv',
'IsolatedEnv',
]
|