Create session views of the build wheel/sdist into temp_dir (#2614)

Resolves #2612

Author: gaborbernat

.pre-commit-config.yaml

@@ -52,7 +52,7 @@ repos:
     hooks:
       - id: flake8
         additional_dependencies:
-          - flake8-bugbear==22.10.27
+          - flake8-bugbear==22.12.6
           - flake8-comprehensions==3.10.1
           - flake8-pytest-style==1.6
           - flake8-spellcheck==0.28

docs/changelog/2612.bugfix.rst

@@ -0,0 +1 @@
+Create session views of the build wheel/sdist into the :ref:`temp_dir` folder - by :user:`gaborbernat`.

docs/config.rst

@@ -172,7 +172,7 @@ Core
 
 .. conf::
    :keys: temp_dir
-   :default: {tox_root}/.tmp
+   :default: {tox_root}/.temp
 
    Directory where to put tox temporary files. For example: we create a hard link (if possible, otherwise new copy) in
    this directory for the project package. This ensures tox works correctly when having parallel runs (as each session

pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
 build-backend = "hatchling.build"
-requires = ["hatchling>=1.11.1", "hatch-vcs>=0.2"]
+requires = ["hatchling>=1.11.1", "hatch-vcs>=0.2.1"]
 
 [project]
 name = "tox"
@@ -24,8 +24,8 @@ dependencies = [
   "cachetools>=5.2",
   "chardet>=5.1",
   "colorama>=0.4.6",
-  "packaging>=21.3",
-  "platformdirs>=2.5.4",
+  "packaging>=22",
+  "platformdirs>=2.6",
   "pluggy>=1",
   "pyproject-api>=1.2.1",
   'tomli>=2.0.1; python_version < "3.11"',
@@ -35,7 +35,7 @@ dependencies = [
   'typing-extensions>=4.4; python_version < "3.8"',
 ]
 optional-dependencies.docs = [
-  "furo>=2022.9.29",
+  "furo>=2022.12.7",
   "sphinx>=5.3",
   "sphinx-argparse-cli>=1.10",
   "sphinx-autodoc-typehints>=1.19.5",
@@ -51,7 +51,7 @@ optional-dependencies.testing = [
   "diff-cover>=7.2",
   "distlib>=0.3.6",
   "flaky>=3.7",
-  "hatch-vcs>=0.2",
+  "hatch-vcs>=0.2.1",
   "hatchling>=1.11.1",
   "psutil>=5.9.4",
   "pytest>=7.2",

src/tox/config/sets.py

@@ -199,8 +199,8 @@ def work_dir_builder(conf: Config, env_name: str | None) -> Path:  # noqa: U100
         self.add_config(
             keys=["temp_dir"],
             of_type=Path,
-            default=lambda conf, _: cast(Path, self["tox_root"]) / ".tmp",  # noqa: U100, U101
-            desc="temporary directory cleaned at start",
+            default=lambda conf, _: cast(Path, self["work_dir"]) / ".tmp",  # noqa: U100, U101
+            desc="a folder for temporary files (is not cleaned at start)",
         )
 
     def _on_duplicate_conf(self, key: str, definition: ConfigDefinition[V]) -> None:  # noqa: U100

src/tox/tox_env/python/virtual_env/package/pyproject.py

@@ -30,6 +30,7 @@
 )
 from tox.tox_env.register import ToxEnvRegister
 from tox.tox_env.runner import RunToxEnv
+from tox.util.file_view import create_session_view
 
 from ..api import VirtualEnv
 from .util import dependencies_with_extras
@@ -99,6 +100,7 @@ def __init__(self, create_args: ToxEnvCreateArgs) -> None:
         self._package_name: str | None = None
         self._pkg_lock = RLock()  # can build only one package at a time
         self.root = self.conf["package_root"]
+        self._package_paths: set[Path] = set()
 
     @staticmethod
     def id() -> str:
@@ -164,6 +166,10 @@ def _teardown(self) -> None:
                 pass
             finally:
                 executor.close()
+        for path in self._package_paths:
+            if path.exists():
+                logging.debug("delete package %s", path)
+                path.unlink()
         super()._teardown()
 
     def perform_packaging(self, for_env: EnvConfigSet) -> list[Package]:
@@ -189,7 +195,10 @@ def perform_packaging(self, for_env: EnvConfigSet) -> list[Package]:
         elif of_type == "sdist":
             self.setup()
             with self._pkg_lock:
-                package = SdistPackage(self._frontend.build_sdist(sdist_directory=self.pkg_dir).sdist, deps)
+                sdist = self._frontend.build_sdist(sdist_directory=self.pkg_dir).sdist
+                sdist = create_session_view(sdist, self._package_temp_path)
+                self._package_paths.add(sdist)
+                package = SdistPackage(sdist, deps)
         elif of_type in {"wheel", "editable"}:
             w_env = self._wheel_build_envs.get(for_env["wheel_build_env"])
             if w_env is not None and w_env is not self:
@@ -199,16 +208,22 @@ def perform_packaging(self, for_env: EnvConfigSet) -> list[Package]:
                 self.setup()
                 method = "build_editable" if of_type == "editable" else "build_wheel"
                 with self._pkg_lock:
-                    path = getattr(self._frontend, method)(
+                    wheel = getattr(self._frontend, method)(
                         wheel_directory=self.pkg_dir,
                         metadata_directory=self.meta_folder,
                         config_settings=self._wheel_config_settings,
                     ).wheel
-                package = (EditablePackage if of_type == "editable" else WheelPackage)(path, deps)
+                    wheel = create_session_view(wheel, self._package_temp_path)
+                    self._package_paths.add(wheel)
+                package = (EditablePackage if of_type == "editable" else WheelPackage)(wheel, deps)
         else:  # pragma: no cover # for when we introduce new packaging types and don't implement
             raise TypeError(f"cannot handle package type {of_type}")  # pragma: no cover
         return [package]
 
+    @property
+    def _package_temp_path(self) -> Path:
+        return cast(Path, self.core["temp_dir"]) / "package"
+
     def _load_deps(self, for_env: EnvConfigSet) -> list[Requirement]:
         # first check if this is statically available via PEP-621
         deps = self._load_deps_from_static(for_env)

src/tox/tox_env/python/virtual_env/package/util.py

@@ -2,7 +2,7 @@
 
 from copy import deepcopy
 
-from packaging.markers import Variable
+from packaging.markers import Variable  # type: ignore[attr-defined]
 from packaging.requirements import Requirement
 
 

src/tox/util/file_view.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+import logging
+import os
+import shutil
+from itertools import chain
+from os.path import commonpath
+from pathlib import Path
+
+
+def create_session_view(package: Path, temp_path: Path) -> Path:
+    """Allows using the file after you no longer holding a lock to it by moving it into a temp folder"""
+    # we'll number the active instances, and use the max value as session folder for a new build
+    # note we cannot change package names as PEP-491 (wheel binary format)
+    # is strict about file name structure
+
+    temp_path.mkdir(parents=True, exist_ok=True)
+    exists = [i.name for i in temp_path.iterdir()]
+    file_id = max(chain((0,), (int(i) for i in exists if str(i).isnumeric())))
+    session_dir = temp_path / str(file_id + 1)
+    session_dir.mkdir()
+    session_package = session_dir / package.name
+
+    links = False  # if we can do hard links do that, otherwise just copy
+    if hasattr(os, "link"):
+        try:
+            os.link(package, session_package)
+            links = True
+        except (OSError, NotImplementedError):
+            pass
+    if not links:
+        shutil.copyfile(package, session_package)
+    operation = "links" if links else "copied"
+    common = commonpath((session_package, package))
+    rel_session, rel_package = session_package.relative_to(common), package.relative_to(common)
+    logging.debug("package %s %s to %s (%s)", rel_session, operation, rel_package, common)
+    return session_package

tests/tox_env/python/test_python_runner.py

@@ -88,3 +88,14 @@ def test_journal_package_dir(tmp_path: Path) -> None:
             "type": "dir",
         },
     }
+
+
+def test_package_temp_dir_view(tox_project: ToxProjectCreator, demo_pkg_inline: Path) -> None:
+    project = tox_project({"tox.ini": "[testenv]\npackage=wheel"})
+    result = project.run("r", "-vv", "-e", "py", "--root", str(demo_pkg_inline))
+    result.assert_success()
+    wheel_name = "demo_pkg_inline-1.0.0-py3-none-any.whl"
+    session_path = Path(".tmp") / "package" / "1" / wheel_name
+    msg = f" D package {session_path} links to {Path('.pkg') / 'dist'/ wheel_name} ({project.path/ '.tox'}) "
+    assert msg in result.out
+    assert f" D delete package {project.path / '.tox' / session_path}" in result.out

tox.ini

@@ -91,7 +91,7 @@ description = do a release, required posarg of the version number
 skip_install = true
 deps =
     gitpython>=3.1.29
-    packaging>=21.3
+    packaging>=22
     towncrier>=22.8
 commands =
     python {toxinidir}/tasks/release.py --version {posargs}