venv.py 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. from __future__ import annotations
  2. import logging
  3. from copy import copy
  4. from typing import TYPE_CHECKING
  5. from python_discovery import PythonInfo
  6. from virtualenv.create.via_global_ref.store import handle_store_python
  7. from virtualenv.util.error import ProcessCallFailedError
  8. from virtualenv.util.path import ensure_dir
  9. from virtualenv.util.subprocess import run_cmd
  10. from .api import ViaGlobalRefApi, ViaGlobalRefMeta
  11. from .builtin.cpython.common import is_mac_os_framework
  12. from .builtin.cpython.mac_os import CPython3macOsBrew
  13. from .builtin.pypy.pypy3 import Pypy3Windows
  14. if TYPE_CHECKING:
  15. from typing import Any
  16. from virtualenv.config.cli.parser import VirtualEnvOptions
  17. LOGGER = logging.getLogger(__name__)
  18. class Venv(ViaGlobalRefApi):
  19. def __init__(self, options: VirtualEnvOptions, interpreter: PythonInfo) -> None:
  20. self.describe = options.describe
  21. super().__init__(options, interpreter)
  22. current = PythonInfo.current()
  23. self.can_be_inline = interpreter is current and interpreter.executable == interpreter.system_executable
  24. self._context = None
  25. def _args(self) -> list[tuple[str, Any]]:
  26. return super()._args() + ([("describe", self.describe.__class__.__name__)] if self.describe else [])
  27. @classmethod
  28. def can_create(cls, interpreter: PythonInfo) -> ViaGlobalRefMeta | None:
  29. if interpreter.has_venv:
  30. if CPython3macOsBrew.can_describe(interpreter):
  31. return CPython3macOsBrew.setup_meta(interpreter)
  32. meta = ViaGlobalRefMeta()
  33. if interpreter.platform == "win32":
  34. meta = handle_store_python(meta, interpreter)
  35. if is_mac_os_framework(interpreter):
  36. meta.copy_error = "macOS framework builds do not support copy-based virtual environments"
  37. return meta
  38. return None
  39. def create(self) -> None:
  40. if self.can_be_inline:
  41. self.create_inline()
  42. else:
  43. self.create_via_sub_process()
  44. for lib in self.libs: # ty: ignore[not-iterable]
  45. ensure_dir(lib)
  46. if self.describe is not None:
  47. self.describe.install_venv_shared_libs(self)
  48. super().create()
  49. self.executables_for_win_pypy_less_v37()
  50. def executables_for_win_pypy_less_v37(self) -> None:
  51. """PyPy <= 3.6 (v7.3.3) for Windows contains only pypy3.exe and pypy3w.exe Venv does not handle non-existing exe sources, e.g. python.exe, so this patch does it."""
  52. creator = self.describe
  53. if isinstance(creator, Pypy3Windows) and creator.less_v37:
  54. for exe in creator.executables(self.interpreter):
  55. exe.run(creator, self.symlinks)
  56. def create_inline(self) -> None:
  57. from venv import EnvBuilder # noqa: PLC0415
  58. builder = EnvBuilder(
  59. system_site_packages=self.enable_system_site_package,
  60. clear=False,
  61. symlinks=self.symlinks,
  62. with_pip=False,
  63. )
  64. builder.create(str(self.dest))
  65. def create_via_sub_process(self) -> None:
  66. cmd = self.get_host_create_cmd()
  67. LOGGER.info("using host built-in venv to create via %s", " ".join(cmd))
  68. code, out, err = run_cmd(cmd)
  69. if code != 0:
  70. raise ProcessCallFailedError(code, out, err, cmd)
  71. def get_host_create_cmd(self) -> list[str]:
  72. cmd = [self.interpreter.system_executable, "-m", "venv", "--without-pip"]
  73. if self.interpreter.version_info >= (3, 13):
  74. cmd.append("--without-scm-ignore-files")
  75. if self.enable_system_site_package:
  76. cmd.append("--system-site-packages")
  77. cmd.extend(("--symlinks" if self.symlinks else "--copies", str(self.dest)))
  78. return cmd # ty: ignore[invalid-return-type]
  79. def set_pyenv_cfg(self) -> None:
  80. # prefer venv options over ours, but keep our extra
  81. venv_content = copy(self.pyenv_cfg.refresh())
  82. super().set_pyenv_cfg()
  83. self.pyenv_cfg.update(venv_content)
  84. def __getattribute__(self, item: str) -> object:
  85. describe = object.__getattribute__(self, "describe")
  86. if describe is not None and hasattr(describe, item):
  87. element = getattr(describe, item)
  88. if not callable(element) or item == "script":
  89. return element
  90. return object.__getattribute__(self, item)
  91. __all__ = [
  92. "Venv",
  93. ]