Add a parameter flag to clean up artifacts after build (#11)

* Add clean_artifacts_after_build script config parameter

* Bump version

* README.md doc additions for new `clean_artifacts_after_build` parameter

* Added clean_artifacts_after_build=True scripts to test case

Author: Rakagami

README.md

@@ -29,6 +29,7 @@ an array of scripts to the `tool.hatch.build.hooks.build-scripts.scripts` key in
 | `work_dir` | `"."` | The directory to run the commands in. All artifact patterns are relative to this directory. |
 | `clean_artifacts` | `true` | Whether to clean files from the `out_dir` that match the artifact patterns before running the commands. |
 | `clean_out_dir` | `false` | Whether to clean the `out_dir` before running the commands. |
+| `clean_artifacts_after_build` | `false` | Whether to clean the files from the `out_dir` that were generated by the scripts. |
 
 In practice this looks like:
 
@@ -56,3 +57,4 @@ You can configure script defaults for scripts by adding a `[tool.hatch.build.hoo
 | `work_dir` | `"."` | The directory to run the commands in. All artifact patterns are relative to this directory. |
 | `clean_artifacts` | `true` | Whether to clean files from the `out_dir` that match the artifact patterns before running the commands. |
 | `clean_out_dir` | `false` | Whether to clean the `out_dir` before running the commands. |
+| `clean_artifacts_after_build` | `false` | Whether to clean the files from the `out_dir` that were generated by the scripts. |

hatch_build_scripts/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.4"
+__version__ = "0.0.5"

hatch_build_scripts/hooks.py

@@ -1,4 +1,5 @@
 """Register hooks for the plugin."""
+
 from hatchling.plugin import hookimpl
 
 from hatch_build_scripts.plugin import BuildScriptsHook

hatch_build_scripts/plugin.py

@@ -65,6 +65,22 @@ def initialize(
 
             build_data["artifacts"].append(str(out_dir.relative_to(self.root)))
 
+    def finalize(
+        self,
+        version: str,  # noqa: ARG002
+        build_data: dict[str, Any],  # noqa: ARG002
+        artifact_path: str,  # noqa: ARG002
+    ) -> None:
+        all_scripts = load_scripts(self.config)
+
+        for script in all_scripts:
+            if not script.clean_artifacts_after_build:
+                continue
+
+            for out_file in script.out_files(self.root):
+                log.debug(f"After build, cleaning {out_file}")
+                out_file.unlink(missing_ok=True)
+
 
 def load_scripts(config: dict[str, Any]) -> Sequence[OneScriptConfig]:
     script_defaults = dataclass_defaults(OneScriptConfig)
@@ -97,6 +113,9 @@ class OneScriptConfig:
     clean_out_dir: bool = False
     """Whether to clean the output directory before running the scripts"""
 
+    clean_artifacts_after_build: bool = False
+    """Whether to clean the build directory after running the scripts"""
+
     def __post_init__(self) -> None:
         self.out_dir = conv_path(self.out_dir)
         self.work_dir = conv_path(self.work_dir)

tests/test_plugin.py

@@ -9,6 +9,7 @@ def test_plugin(tmpdir):
 
     (tmp_lib_dir / "some-dir").mkdir()
     (tmp_lib_dir / "another-dir").mkdir()
+    (tmp_lib_dir / "yet-another-dir").mkdir()
 
     some_dir_out = tmp_lib_dir / "some-dir-out"
     some_dir_out.mkdir()
@@ -50,6 +51,17 @@ def test_plugin(tmpdir):
                 artifacts=["*.txt"],
                 clean_out_dir=True,
             ),
+            OneScriptConfig(
+                out_dir="yet-another-dir-out",
+                work_dir="yet-another-dir",
+                commands=[
+                    "echo 'hello world' > f1.txt",
+                    "echo 'hello world' > f2.txt",
+                ],
+                artifacts=["*.txt"],
+                clean_out_dir=True,
+                clean_artifacts_after_build=True,
+            ),
         ],
     )
 
@@ -66,3 +78,9 @@ def test_plugin(tmpdir):
 
         assert not (extract_dir / "some-dir-out" / "f3.txt").exists()
         assert not (extract_dir / "another-dir-out" / "module.py").exists()
+
+        # we expect that this file still exists in the source
+        assert (tmp_lib_dir / "fake" / "fake.txt").exists()
+        # we expect that this file was cleaned in the source but exists in wheel
+        assert (extract_dir / "yet-another-dir-out" / "f1.txt").exists()
+        assert not (tmp_lib_dir / "yet-another-dir-out" / "f1.txt").exists()