more logs

Author: rmorshea

hatch_build_scripts/__init__.py

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

hatch_build_scripts/plugin.py

@@ -13,7 +13,9 @@
 import pathspec
 from hatchling.builders.hooks.plugin.interface import BuildHookInterface
 
-logger = logging.getLogger(__name__)
+log = logging.getLogger(__name__)
+log_level = logging.getLevelName(os.getenv("HATCH_BUILD_SCRIPTS_LOG_LEVEL", "INFO"))
+log.setLevel(log_level)
 
 
 class BuildScriptsHook(BuildHookInterface):
@@ -31,10 +33,11 @@ def initialize(
         for script in all_scripts:
             if script.clean_out_dir:
                 out_dir = Path(self.root, script.out_dir)
-                logger.info(f"Cleaning {out_dir}")
+                log.debug(f"Cleaning {out_dir}")
                 shutil.rmtree(out_dir, ignore_errors=True)
             elif script.clean_artifacts:
                 for out_file in script.out_files(self.root):
+                    log.debug(f"Cleaning {out_file}")
                     out_file.unlink(missing_ok=True)
 
         for script in all_scripts:
@@ -43,16 +46,20 @@ def initialize(
             out_dir.mkdir(parents=True, exist_ok=True)
 
             for cmd in script.commands:
+                log.info(f"Running command: {cmd}")
                 run(cmd, cwd=str(work_dir), check=True, shell=True)  # noqa: S602
 
-            logger.info(f"Copying artifacts to {out_dir}")
-            for artifact_file in script.artifact_files():
-                src_file = work_dir / artifact_file
-                out_file = out_dir / artifact_file
+            log.info(f"Copying artifacts to {out_dir}")
+            for work_file in script.work_files(self.root, relative=True):
+                src_file = work_dir / work_file
+                out_file = out_dir / work_file
+                log.debug(f"Copying {src_file} to {out_file}")
                 if src_file not in created:
                     out_file.parent.mkdir(parents=True, exist_ok=True)
                     shutil.copyfile(src_file, out_file)
                     created.add(out_file)
+                else:
+                    log.debug(f"Skipping {src_file} - already exists")
 
             build_data["artifacts"].append(str(out_dir.relative_to(self.root)))
 
@@ -92,28 +99,24 @@ def __post_init__(self) -> None:
         self.out_dir = conv_path(self.out_dir)
         self.work_dir = conv_path(self.work_dir)
 
-    def work_files(self, root: str | Path) -> Sequence[Path]:
-        """Get the files that will be used by the script."""
-        work_dir = Path(root, self.work_dir)
-        if not work_dir.exists():
+    def work_files(self, root: str | Path, *, relative: bool = False) -> Sequence[Path]:
+        """Get files in the work directory that match the artifacts spec."""
+        abs_dir = Path(root, self.work_dir)
+        if not abs_dir.exists():
             return []
         return [
-            Path(root, self.work_dir, f)
-            for f in self.artifacts_spec.match_tree(work_dir)
+            Path(f) if relative else abs_dir / f
+            for f in self.artifacts_spec.match_tree(abs_dir)
         ]
 
-    def out_files(self, root: str | Path) -> Sequence[Path]:
-        """Get the files that will be created by the script."""
-        out_dir = Path(root, self.out_dir)
-        if not out_dir.exists():
+    def out_files(self, root: str | Path, *, relative: bool = False) -> Sequence[Path]:
+        """Get files in the output directory that match the artifacts spec."""
+        abs_dir = Path(root, self.out_dir)
+        if not abs_dir.exists():
             return []
         return [
-            Path(root, self.out_dir, f) for f in self.artifacts_spec.match_tree(out_dir)
-        ]
-
-    def artifact_files(self) -> Sequence[Path]:
-        return [
-            Path(conv_path(p)) for p in self.artifacts_spec.match_tree(self.work_dir)
+            Path(f) if relative else abs_dir / f
+            for f in self.artifacts_spec.match_tree(abs_dir)
         ]
 
     @cached_property

tests/test_plugin.py

@@ -4,23 +4,26 @@
 
 
 def test_plugin(tmpdir):
-    (tmpdir / "some-dir").mkdir()
-    (tmpdir / "another-dir").mkdir()
+    tmp_lib_dir = tmpdir / "lib"
+    tmp_lib_dir.mkdir()
 
-    some_dir_out = tmpdir / "some-dir-out"
+    (tmp_lib_dir / "some-dir").mkdir()
+    (tmp_lib_dir / "another-dir").mkdir()
+
+    some_dir_out = tmp_lib_dir / "some-dir-out"
     some_dir_out.mkdir()
     # we expect that this file will not be cleaned
     (some_dir_out / "module.py").write_text('print("hello")', "utf-8")
     # we expect that this file will be cleaned
     (some_dir_out / "f3.txt").write_text("this should be cleaned", "utf-8")
 
-    another_dir_out = tmpdir / "another-dir-out"
+    another_dir_out = tmp_lib_dir / "another-dir-out"
     another_dir_out.mkdir()
     # we expect that this file will be cleaned
     (another_dir_out / "module.py").write_text('print("hello")', "utf-8")
 
     proj = create_project(
-        tmpdir,
+        tmp_lib_dir,
         [
             OneScriptConfig(
                 out_dir="fake",