refactor(pkg): improve naming of SourcePackage and Build members

Author: mikonse

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

@@ -11,22 +11,18 @@
 
 if typing.TYPE_CHECKING:
     from debmagic.common.package import BinaryPackage
-    from debmagic.common.utils import Namespace
 
-    from ._package import PackageFilter, SourcePackageBuild
-    from ._preset import Preset
+    from ._package import Package, PackageFilter
 
 
 @dataclass
 class Build:
-    presets: list[Preset]
-    source_package: SourcePackageBuild
+    package: Package
     source_dir: Path
     binary_packages: list[BinaryPackage]
     install_base_dir: Path
     architecture_target: str
     architecture_host: str
-    flags: Namespace
     parallel: int
     prefix: Path
     dry_run: bool = False
@@ -49,14 +45,14 @@ def select_packages(self, names: set[str]):
         """only build those packages"""
         self.binary_packages = []
 
-        for pkg in self.source_package.source_package.binary_packages:
+        for pkg in self.package.source_package.binary_packages:
             if pkg.name in names:
                 self.binary_packages.append(pkg)
 
     def filter_packages(self, package_filter: PackageFilter) -> None:
         """apply filter to only build those packages"""
         self.select_packages(
-            {pkg.name for pkg in package_filter.get_packages(self.source_package.source_package.binary_packages)}
+            {pkg.name for pkg in package_filter.get_packages(self.package.source_package.binary_packages)}
         )
 
     def filtered_binary_packages(self, names: set[str]) -> typing.Iterator[BinaryPackage]:
@@ -85,14 +81,14 @@ def run(
             print(":")
 
             # run stage function from debian/rules.py
-            if rules_stage_function := self.source_package.stage_functions.get(stage):
+            if rules_stage_function := self.package.stage_functions.get(stage):
                 print("debmagic:  running stage from rules file...")
                 rules_stage_function(self)
                 self._mark_stage_done(stage)
 
             else:
                 # run stage function from first providing preset
-                for preset in self.presets:
+                for preset in self.package.presets:
                     print(f"debmagic:  trying preset {preset}...")
                     if preset_stage_function := preset.get_stage(stage):
                         print("debmagic:   running stage from preset")

…-pkg/src/debmagic/v0/_dpkg/buildflags.py …c-pkg/src/debmagic/v0/_dpkg/build_env.pypackages/debmagic-pkg/src/debmagic/v0/_dpkg/buildflags.py renamed to packages/debmagic-pkg/src/debmagic/v0/_dpkg/build_env.py packages/debmagic-pkg/src/debmagic/v0/_dpkg/buildflags.py renamed to packages/debmagic-pkg/src/debmagic/v0/_dpkg/build_env.py

@@ -28,7 +28,7 @@ def configure(self, build: Build, args: list[str] | None = None):
             # "--with-bugurl=https://bugs.launchpad.net/ubuntu/+source/${srcpkg}",
         ]
 
-        if multiarch := build.flags["DEB_HOST_MULTIARCH"]:
+        if multiarch := build.package.build_env["DEB_HOST_MULTIARCH"]:
             default_args.append(f"--libdir=${{prefix}}/lib/{multiarch}")
             default_args.append(f"--libexecdir=${{prefix}}/lib/{multiarch}")
         else:
@@ -55,7 +55,7 @@ def build(self, build: Build, args: list[str] = []):
 
     def install(self, build: Build, args: list[str] = []):
         # TODO: figure out installdir handling for multi package builds
-        destdir = build.install_dirs[build.source_package.source_package.name]
+        destdir = build.install_dirs[build.package.source_package.name]
         build.cmd(["make", f"DESTDIR={destdir}", "install", *args], cwd=build.source_dir)
 
 

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

@@ -12,7 +12,7 @@
 from debmagic.common.utils import list_strip_head, prefix_idx, run_cmd
 
 from .._build import Build
-from .._package import SourcePackageBuild
+from .._package import Package
 from .._preset import Preset as PresetBase
 
 
@@ -56,7 +56,7 @@ def __init__(self, dh_args: list[str] | str | None = None):
         # all seen sequence cmd ids (the dh command script itself)
         self._seq_ids: set[str] = set()
 
-    def initialize(self, src_pkg: SourcePackageBuild) -> None:
+    def initialize(self, src_pkg: Package) -> None:
         # get all steps the dh sequence would do
         self._populate_stages(self._dh_args, base_dir=src_pkg.base_dir)
         self._initialized = True

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

@@ -19,7 +19,7 @@
 from ._build_order import BuildOrder
 from ._build_stage import BuildStage
 from ._build_step import BuildStep
-from ._dpkg import buildflags
+from ._dpkg import build_env
 from ._preset import Preset, PresetsT, as_presets
 from ._rules_file import RulesFile, find_rules_file
 from ._types import CustomFuncArg, CustomFuncArgsT
@@ -109,11 +109,11 @@ def get_packages(self, binary_packages: list[BinaryPackage]) -> list[BinaryPacka
 
 
 @dataclass
-class SourcePackageBuild:
+class Package:
     source_package: SourcePackage
     rules_file: RulesFile
     presets: list[Preset]
-    buildflags: Namespace
+    build_env: Namespace
     version: PackageVersion
     stage_functions: dict[BuildStage, BuildStep] = field(default_factory=dict)
     custom_functions: dict[str, CustomFunction] = field(default_factory=dict)
@@ -174,14 +174,12 @@ def pack(self):
         cli, args = _parse_args(self.custom_functions)
 
         build = Build(
-            presets=self.presets,
-            source_package=self,
+            package=self,
             source_dir=self.base_dir,
             binary_packages=self.source_package.binary_packages,
             install_base_dir=self.rules_file.package_dir / "debian",  # + added binary package
-            architecture_target=self.buildflags.DEB_BUILD_GNU_TYPE,
-            architecture_host=self.buildflags.DEB_HOST_GNU_TYPE,
-            flags=self.buildflags,
+            architecture_target=self.build_env.DEB_BUILD_GNU_TYPE,
+            architecture_host=self.build_env.DEB_HOST_GNU_TYPE,
             parallel=multiprocessing.cpu_count(),  # TODO
             prefix=Path("/usr"),  # TODO
             dry_run=args.dry_run,
@@ -235,7 +233,7 @@ def package(
     preset: PresetsT = None,
     maint_options: str | None = None,
     build_order: BuildOrder = BuildOrder.stages,
-) -> SourcePackageBuild:
+) -> Package:
     """
     provides the packaging environment.
 
@@ -257,15 +255,15 @@ def package(
     presets.append(DefaultPreset())
 
     # set buildflags as environment variables
-    flags, version = buildflags.get_pkg_env(rules_file.package_dir, maint_options=maint_options)
-    os.environ.update(flags)
+    env, version = build_env.get_pkg_env(rules_file.package_dir, maint_options=maint_options)
+    os.environ.update(env)
 
     source_package = SourcePackage.from_control_file(rules_file.package_dir / "debian/control")
-    build = SourcePackageBuild(
+    pkg = Package(
         source_package=source_package,
         rules_file=rules_file,
         presets=presets,
-        buildflags=Namespace(**flags),
+        build_env=Namespace(**env),
         version=version,
     )
-    return build
+    return pkg

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

@@ -9,7 +9,7 @@
 from ._build_step import BuildStep
 
 if TYPE_CHECKING:
-    from ._package import SourcePackageBuild
+    from ._package import Package
 
 
 class Preset:
@@ -25,7 +25,7 @@ def get_stage(self, stage: BuildStage) -> BuildStep | None:
 
         return func
 
-    def initialize(self, src_pkg: SourcePackageBuild) -> None:
+    def initialize(self, src_pkg: Package) -> None:
         """
         usually called when a Preset is set as preset to a SourcePackage.
         if you don't register pass the Preset to the package() function,

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

@@ -12,13 +12,13 @@
     maint_options="hardening=+all",
 )
 
-if pkg.buildflags.DEB_HOST_ARCH_OS == "linux":
+if pkg.build_env.DEB_HOST_ARCH_OS == "linux":
     configure_params = ["--enable-affinity", "--enable-delayacct"]
 else:
     configure_params = ["--enable-hwloc"]
 
 # hurd-i386 can open /proc (nothing there) and /proc/ which works
-if pkg.buildflags.DEB_HOST_ARCH_OS == "hurd":
+if pkg.build_env.DEB_HOST_ARCH_OS == "hurd":
     configure_params += ["--with-proc=/proc/"]
 else:
     configure_params += ["--enable-sensors"]