feat(pkg/build): add InternalPreset for build stages always executed first

Author: TheJJ

packages/debmagic-pkg/src/debmagic/v0/_build.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import shutil
 import subprocess
 import typing
 from dataclasses import dataclass, field
@@ -9,6 +10,7 @@
 from debmagic.common.utils import run_cmd
 
 from ._build_stage import BuildStage
+from ._preset import Preset
 
 if typing.TYPE_CHECKING:
     from debmagic.common.package import BinaryPackage
@@ -73,6 +75,8 @@ def run(
         self,
         target_stage: BuildStage | None = None,
     ) -> None:
+        internal_stages = InternalPreset()
+
         for stage in BuildStage:
             print(f"debmagic: stage {stage!s}", end="")
 
@@ -82,6 +86,10 @@ def run(
                 continue
             print(":")
 
+            # run internal function for stage
+            if internal_stage_function := internal_stages.get_stage(stage):
+                internal_stage_function(self)
+
             # run stage function from debian/rules.py
             if rules_stage_function := self.package.stage_functions.get(stage):
                 print("debmagic:  running stage from rules file...")
@@ -108,3 +116,16 @@ def run(
 
 class BuildError(RuntimeError):
     pass
+
+
+class InternalPreset(Preset):
+    """
+    these stages here are always executed before
+    build stage functions from debian/rules.py or a preset from modules/,
+    """
+
+    def clean(self, build: Build) -> None:
+        # clean install dirs
+        for install_dir in build.install_dirs.values():
+            if install_dir.is_dir():
+                shutil.rmtree(install_dir)

packages/debmagic-pkg/src/debmagic/v0/_module/default.py

@@ -2,12 +2,16 @@
 fallback for all build stages.
 """
 
-import shutil
+from __future__ import annotations
+
+import typing
 
-from .._build import Build
 from .._preset import Preset as BasePreset
 from .dh import Preset as DHPreset
 
+if typing.TYPE_CHECKING:
+    from .._build import Build
+
 
 class Preset(BasePreset):
     """
@@ -24,12 +28,6 @@ def __init__(self):
         self._dh_preset = DHPreset()
 
     def clean(self, build: Build) -> None:
-        # clean install dirs
-        for install_dir in build.install_dirs.values():
-            if install_dir.is_dir():
-                shutil.rmtree(install_dir)
-
-        # run dh's clean sequence
         self._dh_preset.clean(build)
 
     def prepare(self, build: Build) -> None:

packages/debmagic-pkg/src/debmagic/v0/_preset.py

@@ -4,11 +4,11 @@
 from types import MethodType, ModuleType
 from typing import TYPE_CHECKING, Callable, TypeVar, cast, overload
 
-from ._build import Build
 from ._build_stage import BuildStage
-from ._build_step import BuildStep
 
 if TYPE_CHECKING:
+    from ._build import Build
+    from ._build_step import BuildStep
     from ._package import Package