pyproject-api 1.12.4__tar.gz → 1.12.5__tar.gz

{pyproject_api-1.12.4 → pyproject_api-1.12.5}/.github/workflows/check.yaml

@@ -7,16 +7,16 @@ on:
   pull_request:
     types: [opened, synchronize, reopened]
   schedule:
-    - cron: "0 8 * * *"
+    - cron: "43 7 * * *"
 concurrency:
   group: check-${{ github.ref }}
-  cancel-in-progress: true
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
 permissions:
   contents: read
 jobs:
   test:
     name: 🧪 Test
-    uses: tox-dev/github-workflows/.github/workflows/check.yaml@bceb5c005e19823dc8835f536f53f172ae223927 # 6.5.0
+    uses: tox-dev/github-workflows/.github/workflows/check.yaml@13381289334b15375958be7f7438f3c3d860e575 # 6.5.5
     permissions:
       contents: read
     with:
@@ -40,20 +40,28 @@ jobs:
           {"env": "type", "os": "windows-2025-vs2026"},
           {"env": "dev", "os": "windows-2025-vs2026"},
           {"env": "pkg_meta", "os": "windows-2025-vs2026"},
-          {"env": "3.15", "os": "macos-26"},
-          {"env": "3.15t", "python": "3.15t", "os": "macos-26"},
-          {"env": "3.14", "python": "3.14", "os": "macos-26"},
-          {"env": "3.13", "python": "3.13", "os": "macos-26"},
-          {"env": "3.12", "python": "3.12", "os": "macos-26"},
-          {"env": "3.11", "python": "3.11", "os": "macos-26"}
+          {"env": "3.15", "os": "macos-26"}
         ]
+  release:
+    name: 🏷️ Release dry run
+    uses: $/.github/workflows/prepare-release.yaml
+    permissions:
+      contents: read
+      pull-requests: read
+    with:
+      dry-run: true
+  hooks:
+    name: 🧹 Hooks under the cooldown
+    uses: tox-dev/github-workflows/.github/workflows/cooled-hooks.yaml@0c4cffd63033d38196319524d101caae1eef925b # 6.7.2
+    permissions:
+      contents: read
   gate:
     name: 🚦 ${{ github.event_name == 'pull_request' && 'Required checks pass' || 'Non-PR checks pass' }}
     if: ${{ !cancelled() }} # codespell:ignore cancelled
-    needs: [test]
+    needs: [test, release, hooks]
     runs-on: ubuntu-26.04
     steps:
       - name: 🚦 Require all needed jobs to pass
-        uses: tox-dev/github-workflows/required-checks@bceb5c005e19823dc8835f536f53f172ae223927 # 6.5.0
+        uses: tox-dev/github-workflows/required-checks@13381289334b15375958be7f7438f3c3d860e575 # 6.5.5
         with:
           needs: ${{ toJSON(needs) }}

{pyproject_api-1.12.4 → pyproject_api-1.12.5}/.github/workflows/prepare-release.yaml

@@ -12,15 +12,22 @@ on:
           - minor
           - patch
         default: auto
+  workflow_call:
+    inputs:
+      dry-run:
+        description: Assemble the release without pushing, for the pull request gate
+        type: boolean
+        required: true
 permissions: {}
 jobs:
   prepare:
     name: 🏷️ Prepare Towncrier release
-    uses: tox-dev/github-workflows/.github/workflows/prepare-towncrier-release.yaml@bceb5c005e19823dc8835f536f53f172ae223927 # 6.5.0
+    uses: tox-dev/github-workflows/.github/workflows/prepare-towncrier-release.yaml@0c4cffd63033d38196319524d101caae1eef925b # 6.7.2
     permissions:
       contents: read
       pull-requests: read
     secrets:
       RELEASE_APP_PRIVATE_KEY: ${{ secrets.RELEASE_APP_PRIVATE_KEY }}
     with:
-      bump: ${{ inputs.bump }}
+      bump: ${{ inputs.bump || 'auto' }}
+      dry-run: ${{ inputs.dry-run == true }}

{pyproject_api-1.12.4 → pyproject_api-1.12.5}/CONTRIBUTING.md

@@ -2,3 +2,7 @@
 
 See the [contributing guide](https://pyproject-api.readthedocs.io/en/latest/contributing.html) for release note rules
 and local checks.
+
+## Tests
+
+Add a test for every new feature and bug fix. A change without a test needs a reason in the pull request description.

{pyproject_api-1.12.4 → pyproject_api-1.12.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pyproject-api
-Version: 1.12.4
+Version: 1.12.5
 Import-Name: pyproject_api
 Summary: API to interact with the python pyproject.toml based projects
 Project-URL: Changelog, https://github.com/tox-dev/pyproject-api/blob/main/docs/changelog.rst

{pyproject_api-1.12.4 → pyproject_api-1.12.5}/docs/api.rst

@@ -16,6 +16,14 @@ backend runs from the project directory. Result paths retain the spelling of the
 directory argument. Configuration settings and generic command arguments are
 passed through unchanged.
 
+Metadata preparation replaces a symlink used as the output directory with a real directory, leaving the link target
+untouched. Dangling links are replaced too. Paths resolving to the project root or one of its ancestors are still
+rejected before cleanup.
+
+Metadata preparation clears the output directory before calling the metadata hook. If cleanup fails, the filesystem
+error propagates and the hook is not called. When extracting metadata from a built wheel, cleanup errors stop extraction
+after the wheel has been built.
+
 .. autoclass:: OptionalHooks
 
 Exceptions

{pyproject_api-1.12.4 → pyproject_api-1.12.5}/docs/changelog.rst

@@ -5,6 +5,22 @@ Release History
 
 .. towncrier release notes start
 
+.. _release-1-12-5:
+
+v1.12.5 (2026-11-07)
+--------------------
+
+.. _release-1-12-5-fixed:
+
+Fixed
+^^^^^
+
+- Propagate filesystem errors when clearing nested metadata directories (:pr:`357`) by :user:`Quinnod345` and
+  :user:`gaborbernat`.
+- Replace a symlink passed to ``ensure_empty_dir`` instead of following it, so a dangling link no longer raises
+  ``FileExistsError`` and a link to a directory no longer has its target emptied (:pr:`354`) by :user:`abhishekcpp007`
+  and :user:`gaborbernat`.
+
 .. _release-1-12-4:
 
 v1.12.4 (2026-11-04)

{pyproject_api-1.12.4 → pyproject_api-1.12.5}/src/pyproject_api/_frontend.py

@@ -362,7 +362,7 @@ class Frontend(ABC):
         if metadata_path in project_root.parents:
             ancestor_message: Final[str] = f"the metadata directory can't contain the project root {self._root}"
             raise RuntimeError(ancestor_message)
-        if metadata_directory.exists():  # start with fresh
+        if metadata_directory.is_symlink() or metadata_directory.exists():
             ensure_empty_dir(metadata_directory)
         metadata_directory.mkdir(parents=True, exist_ok=True)
 
@@ -502,10 +502,7 @@ class Frontend(ABC):
                     if not root.endswith(".dist-info"):
                         continue
                     if basename is None:
-                        destination: Final[Path] = metadata_directory / root
-                        if destination.is_symlink():  # pragma: win32 no cover
-                            destination.unlink()
-                        ensure_empty_dir(destination)
+                        ensure_empty_dir(metadata_directory / root)
                     basename = root
                     zip_file.extract(name, extract_to)
         if basename is None:  # pragma: no branch

{pyproject_api-1.12.4 → pyproject_api-1.12.5}/src/pyproject_api/_util.py

@@ -8,11 +8,14 @@ if TYPE_CHECKING:
 
 
 def ensure_empty_dir(path: Path) -> None:
-    if path.exists():
+    if path.is_symlink():
+        path.unlink()
+        path.mkdir()
+    elif path.exists():
         if path.is_dir():
             for sub_path in path.iterdir():
                 if sub_path.is_dir() and not sub_path.is_symlink():
-                    rmtree(sub_path, ignore_errors=True)
+                    rmtree(sub_path)
                 else:
                     sub_path.unlink()
         else:

{pyproject_api-1.12.4 → pyproject_api-1.12.5}/src/pyproject_api/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '1.12.4'
-__version_tuple__ = version_tuple = (1, 12, 4)
+__version__ = version = '1.12.5'
+__version_tuple__ = version_tuple = (1, 12, 5)
 
 __commit_id__ = commit_id = None

{pyproject_api-1.12.4 → pyproject_api-1.12.5}/tests/test_frontend.py

@@ -585,6 +585,33 @@ def test_prepare_metadata_allows_sibling_directory(tmp_path: Path, hook: str) ->
     assert list(metadata_directory.iterdir()) == []
 
 
+@pytest.mark.parametrize(
+    "hook",
+    [
+        pytest.param("prepare_metadata_for_build_wheel", id="wheel"),
+        pytest.param("prepare_metadata_for_build_editable", id="editable"),
+    ],
+)
+@pytest.mark.parametrize(
+    "target_name", [pytest.param("missing", id="dangling"), pytest.param("shared", id="directory")]
+)
+def test_prepare_metadata_replaces_symlink(tmp_path: Path, hook: str, target_name: str) -> None:
+    root: Final[Path] = tmp_path / "project"
+    root.mkdir()
+    (root / "build_tester.py").write_text("")
+    shared: Final[Path] = tmp_path / "shared"
+    shared.mkdir()
+    (shared / "keep.txt").write_text("keep me")
+    metadata_directory: Final[Path] = tmp_path / "project-metadata"
+    metadata_directory.symlink_to(tmp_path / target_name, target_is_directory=True)
+
+    assert getattr(SubprocessFrontend(root, (root,), "build_tester", None, ()), hook)(metadata_directory) is None
+
+    assert not metadata_directory.is_symlink()
+    assert list(metadata_directory.iterdir()) == []
+    assert (shared / "keep.txt").read_text() == "keep me"
+
+
 def test_no_wheel_prepare_metadata_for_build_wheel(local_builder: Callable[[str], Path]) -> None:
     txt = "def build_wheel(wheel_directory, config_settings=None, metadata_directory=None): return 'out'"
     tmp_path = local_builder(txt)

{pyproject_api-1.12.4 → pyproject_api-1.12.5}/tests/test_frontend_setuptools.py

@@ -135,8 +135,7 @@ def test_setuptools_exception(frontend_setuptools: SubprocessFrontend) -> None:
 
 def test_bad_message(frontend_setuptools: SubprocessFrontend, tmp_path: Path) -> None:
     with frontend_setuptools._send_msg("bad_cmd", tmp_path / "a", "{{") as status:  # ruff:ignore[private-member-access]
-        while not status.done:  # pragma: no branch
-            pass
+        status.join()
     out, err = status.out_err()
     assert out
     assert "Backend: incorrect request to backend: bytearray(b'{{')" in err

{pyproject_api-1.12.4 → pyproject_api-1.12.5}/tests/test_util.py

@@ -2,11 +2,15 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
+import pytest
+
 from pyproject_api._util import ensure_empty_dir
 
 if TYPE_CHECKING:
     from pathlib import Path
 
+    from pytest_mock import MockerFixture
+
 
 def test_ensure_empty_dir_on_empty(tmp_path: Path) -> None:
     ensure_empty_dir(tmp_path)
@@ -45,6 +49,29 @@ def test_ensure_empty_dir_on_path_folder(tmp_path: Path) -> None:
     assert list(tmp_path.iterdir()) == []
 
 
+@pytest.mark.parametrize(
+    ("target_name", "target_is_directory"),
+    [
+        pytest.param("missing", False, id="dangling-file"),
+        pytest.param("missing", True, id="dangling-directory"),
+        pytest.param("file", False, id="file"),
+        pytest.param("folder", True, id="directory"),
+    ],
+)
+def test_ensure_empty_dir_replaces_symlink(tmp_path: Path, target_name: str, target_is_directory: bool) -> None:
+    (tmp_path / "file").write_text("keep file")
+    folder = tmp_path / "folder"
+    folder.mkdir()
+    (folder / "c").write_text("keep folder contents")
+    path = tmp_path / "a"
+    path.symlink_to(tmp_path / target_name, target_is_directory=target_is_directory)
+    ensure_empty_dir(path)
+    assert not path.is_symlink()
+    assert list(path.iterdir()) == []
+    assert (tmp_path / "file").read_text() == "keep file"
+    assert (folder / "c").read_text() == "keep folder contents"
+
+
 def test_ensure_empty_dir_on_path_symlink_to_folder(tmp_path: Path) -> None:
     target = tmp_path / "target"
     target.mkdir()
@@ -55,3 +82,17 @@ def test_ensure_empty_dir_on_path_symlink_to_folder(tmp_path: Path) -> None:
     ensure_empty_dir(path)
     assert list(path.iterdir()) == []
     assert list(target.iterdir()) == [target / "c"]
+
+
+def test_nested_cleanup_error_propagates(tmp_path: Path, mocker: MockerFixture) -> None:
+    blocked = tmp_path / "blocked"
+    blocked.mkdir()
+    stale = blocked / "stale.txt"
+    stale.write_text("stale metadata")
+    failure = PermissionError("file removal refused")
+    mocker.patch("os.unlink", autospec=True, side_effect=failure)
+    with pytest.raises(PermissionError) as captured:
+        ensure_empty_dir(tmp_path)
+
+    assert captured.value is failure
+    assert stale.read_text() == "stale metadata"