refactor(common): change common lib into mixed rust / py package

mikonse · mikonse · commit b49dcf3bb29b · 2025-12-28T14:56:47.000+01:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,25 @@
 [workspace]
 resolver = "3"
-members = ["packages/debmagic"]
+members = ["packages/debmagic", "packages/debmagic-common"]
 
 [workspace.package]
 edition = "2024"
 rust-version = "1.89"
+
+[workspace.dependencies]
+clap = { version = ">=4.5.23", features = ["derive"] }
+anyhow = { version = ">=1.0.95" }
+config = { version = ">=0.15.9", features = ["toml"] }
+dirs = ">=5.0.0"
+# thiserror = "2.0.17" # for future uses when we need clearer error handling
+glob = ">=0.3.2"
+libc = ">=0.2.169"
+serde = { version = ">=1.0.217", features = ["derive"] }
+serde_json = ">=1.0.139"
+uuid = { version = ">=1.10.0", features = ["v4"] }
+chrono = { version = ">=0.4.42" }
+regex = { version = ">=1.12.2" }
+
+# dev dependencies
+pyo3 = { version = ">=0.27.2" }
+test-case = { version = ">=3.3.1" }
diff --git a/debian/control b/debian/control
@@ -20,7 +20,11 @@ Build-Depends:
  librust-libc-dev (>=0.2.169),
  librust-serde-dev (>=1.0.217),
  librust-serde-json-dev (>=1.0.139),
- librust-uuid-dev (>=1.10.0)
+ librust-uuid-dev (>=1.10.0),
+ librust-chrono-dev (>=0.4.42),
+ librust-regex-dev (>=1.12.2),
+ librust-test-case-dev (>=3.3.1),
+ librust-pyo3-dev (>=0.27.2)
 Rules-Requires-Root: no
 X-Style: black
 Standards-Version: 4.7.2
diff --git a/debian/rules b/debian/rules
@@ -8,7 +8,7 @@ from pathlib import Path
 packages_root = Path(__file__).parent.parent / "packages"
 sys.path.extend(
     [
-        str(packages_root / "debmagic-common" / "src"),
+        str(packages_root / "debmagic-common" / "python"),
         str(packages_root / "debmagic-pkg" / "src"),
     ]
 )
diff --git a/packages/debmagic-common/Cargo.toml b/packages/debmagic-common/Cargo.toml
@@ -0,0 +1,16 @@
+[package]
+name = "debmagic-common"
+version = "0.0.1-alpha1"
+documentation = "https://debmagic.readthedocs.org"
+homepage = "https://github.com/SFTtech/debmagic"
+repository = "https://github.com/SFTtech/debmagic.git"
+edition.workspace = true
+rust-version.workspace = true
+
+[dependencies]
+chrono = { workspace = true }
+regex = { workspace = true }
+pyo3 = { workspace = true }
+
+[dev-dependencies]
+test-case = { workspace = true }
diff --git a/packages/debmagic-common/pyproject.toml b/packages/debmagic-common/pyproject.toml
@@ -1,20 +1,25 @@
+[build-system]
+requires = ['maturin>=1.9.4,<2']
+build-backend = 'maturin'
+
 [project]
 name = "debmagic-common"
-version = "0.0.1-alpha.1"
-description = "utility library for common debmagic code"
-license = "GPL-2.0-or-later"
-# license-files = ["../../LICENSE"]
-# readme = "../../README.md"
+dynamic = [
+    "version",
+    "description",
+    "readme",
+    "urls",
+    "authors",
+    "license",
+    "keywords",
+]
 requires-python = ">=3.12"
 classifiers = ["Programming Language :: Python :: 3"]
 dependencies = ["python-debian>=1.0"]
 
-[project.urls]
-homepage = "https://github.com/SFTtech/debmagic"
-source = "https://github.com/SFTtech/debmagic.git"
-issues = "https://github.com/SFTtech/debmagic/issues"
-releasenotes = "https://github.com/SFTtech/debmagic/-/blob/main/debian/changelog"
-
-[build-system]
-requires = ["setuptools>=77.0.0", "setuptools-scm"]
-build-backend = "setuptools.build_meta"
+[tool.maturin]
+manifest-path = "Cargo.toml"
+module-name = "debmagic_common._debmagic_common"
+python-source = "python"
+strip = true
+exclude = []
diff --git a/packages/debmagic-common/python/debmagic_common/__init__.py b/packages/debmagic-common/python/debmagic_common/__init__.py
@@ -0,0 +1,2 @@
+# export all definitions from the rust submodule - TODO once we have some of those
+# from debmagic_common._debmagic_common import *
diff --git a/packages/debmagic-common/python/debmagic_common/errors.py b/packages/debmagic-common/python/debmagic_common/errors.py
diff --git a/packages/debmagic-common/python/debmagic_common/models/__init__.py b/packages/debmagic-common/python/debmagic_common/models/__init__.py
diff --git a/packages/debmagic-common/python/debmagic_common/models/changelog.py b/packages/debmagic-common/python/debmagic_common/models/changelog.py
@@ -7,7 +7,6 @@
 
 from ..errors import DebmagicError
 from ..type_utils import IterableDataSource
-from .package_version import PackageVersion
 
 
 class ChangelogFormatError(DebmagicError):
@@ -42,7 +41,7 @@ class ChangelogMetadata:
 @dataclass
 class ChangelogEntry:
     package: str | None
-    version: PackageVersion
+    version: str
     distributions: list[str]
     metadata: ChangelogMetadata
     changes: list[str]
diff --git a/packages/debmagic-common/python/debmagic_common/models/package_version.py b/packages/debmagic-common/python/debmagic_common/models/package_version.py
diff --git a/packages/debmagic-common/python/debmagic_common/package.py b/packages/debmagic-common/python/debmagic_common/package.py
diff --git a/packages/debmagic-common/python/debmagic_common/py.typed b/packages/debmagic-common/python/debmagic_common/py.typed
diff --git a/packages/debmagic-common/python/debmagic_common/type_utils.py b/packages/debmagic-common/python/debmagic_common/type_utils.py
diff --git a/packages/debmagic-common/python/debmagic_common/utils.py b/packages/debmagic-common/python/debmagic_common/utils.py
diff --git a/packages/debmagic-common/src/debian.rs b/packages/debmagic-common/src/debian.rs
@@ -0,0 +1 @@
+pub mod version;
diff --git a/packages/debmagic-common/src/debian/version.rs b/packages/debmagic-common/src/debian/version.rs
@@ -0,0 +1,110 @@
+use std::str::FromStr;
+
+use regex::Regex;
+
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub struct PackageVersion {
+    // distro packaging override base version (default is 0)
+    epoch: String,
+
+    // upstream package version
+    upstream: String,
+
+    // packaging (linux distro) revision
+    revision: String,
+}
+
+impl PackageVersion {
+    pub fn version(&self) -> String {
+        let mut ret: String = "".to_owned();
+        if self.epoch != "0" {
+            ret.push_str(&format!("{}:", self.epoch));
+        }
+        ret.push_str(&self.upstream);
+        if !self.revision.is_empty() {
+            ret.push_str(&format!("-{}", self.revision));
+        }
+        ret
+    }
+
+    /// distro epoch plus upstream version
+    pub fn epoch_upstream(&self) -> String {
+        if !self.epoch.is_empty() {
+            return format!("{}:{}", self.epoch, self.upstream);
+        }
+        self.upstream.clone()
+    }
+
+    /// distro epoch plus upstream version
+    pub fn upstream_revision(&self) -> String {
+        if !self.revision.is_empty() {
+            return format!("{}-{}", self.upstream, self.revision);
+        }
+        self.upstream.clone()
+    }
+}
+
+#[derive(Debug, PartialEq, Eq)]
+pub struct VersionParseError;
+
+impl FromStr for PackageVersion {
+    type Err = VersionParseError;
+
+    fn from_str(version: &str) -> Result<Self, Self::Err> {
+        let re_epoch_upstream = Regex::new(r"^(.*?)(-[^-]*)?$").map_err(|_| VersionParseError)?;
+        let epoch_upstream = re_epoch_upstream.replace(version, "$1").to_string();
+
+        // epoch = distro packaging override base version (default is 0)
+        // pkg-info.mk uses the full version if no epoch is in it.
+        // instead, we return "0" as oritinally intended if no epoch is in version.
+        let epoch = if !version.contains(':') {
+            "0".to_string()
+        } else {
+            let re_epoch = Regex::new(r"^([0-9]+):.*$").map_err(|_| VersionParseError)?;
+            re_epoch.replace(version, "$1").to_string()
+        };
+
+        let re_upstream = Regex::new(r"^([0-9]*:)?(.*?)$").map_err(|_| VersionParseError)?;
+        let upstream = re_upstream.replace(&epoch_upstream, "$2").to_string();
+
+        let re_revision = Regex::new(r"^.*?(-([^-]*))?$").map_err(|_| VersionParseError)?;
+        let revision = re_revision.replace(version, "$2").to_string();
+
+        Ok(Self {
+            epoch,
+            upstream,
+            revision,
+        })
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use test_case::test_case;
+
+    use super::*;
+
+    #[test_case(
+        "1.2.3a.4-42.2-14ubuntu2~20.04.1", 
+        &PackageVersion{epoch:"0".to_string(), upstream:"1.2.3a.4-42.2".to_string(), revision:"14ubuntu2~20.04.1".to_string()})]
+    #[test_case(
+        "3:1.2.3a.4-42.2-14ubuntu2~20.04.1", 
+        &PackageVersion{epoch:"3".to_string(), upstream:"1.2.3a.4-42.2".to_string(), revision:"14ubuntu2~20.04.1".to_string()})]
+    #[test_case(
+        "3:1.2.3a.4ubuntu", 
+        &PackageVersion{epoch:"3".to_string(), upstream:"1.2.3a.4ubuntu".to_string(), revision:"".to_string()})]
+    #[test_case(
+        "3:1.2.3a-4ubuntu", 
+        &PackageVersion{epoch:"3".to_string(), upstream:"1.2.3a".to_string(), revision:"4ubuntu".to_string()})]
+    #[test_case(
+        "3:1.2.3a-4ubuntu1", 
+        &PackageVersion{epoch:"3".to_string(), upstream:"1.2.3a".to_string(), revision:"4ubuntu1".to_string()})]
+    fn test_version_parsing(version: &str, expected: &PackageVersion) {
+        let parsed_version = PackageVersion::from_str(version).unwrap();
+
+        // initial parsing works
+        assert_eq!(&parsed_version, expected);
+        // reverse formatting works as well
+        assert_eq!(parsed_version.version(), version);
+    }
+}
diff --git a/packages/debmagic-common/src/debmagic/common/models/__init__.py b/packages/debmagic-common/src/debmagic/common/models/__init__.py
diff --git a/packages/debmagic-common/src/lib.rs b/packages/debmagic-common/src/lib.rs
@@ -0,0 +1,9 @@
+use pyo3::prelude::*;
+
+pub mod debian;
+
+#[pymodule]
+#[pyo3(name = "_debmagic_common")]
+fn debmagic_common(_m: &Bound<'_, PyModule>) -> PyResult<()> {
+    Ok(())
+}
diff --git a/packages/debmagic-common/tests/test_changelog.py b/packages/debmagic-common/tests/test_changelog.py
@@ -2,7 +2,7 @@
 from pathlib import Path
 
 import pytest
-from debmagic.common.models.changelog import Changelog
+from debmagic_common.models.changelog import Changelog
 
 asset_base = Path(__file__).parent / "assets"
 
diff --git a/packages/debmagic-common/tests/test_exec.py b/packages/debmagic-common/tests/test_exec.py
@@ -1,7 +1,7 @@
 import subprocess
 from unittest.mock import patch
 
-from debmagic.common import utils
+from debmagic_common import utils
 
 
 @patch("subprocess.run", autospec=True)
diff --git a/packages/debmagic-common/tests/test_package.py b/packages/debmagic-common/tests/test_package.py
@@ -1,7 +1,7 @@
 from pathlib import Path
 
 import pytest
-from debmagic.common.package import SourcePackage
+from debmagic_common.package import SourcePackage
 
 asset_base = Path(__file__).parent / "assets"
 
diff --git a/packages/debmagic-common/tests/test_versioning.py b/packages/debmagic-common/tests/test_versioning.py
@@ -1,5 +1,5 @@
 import pytest
-from debmagic.common.models.package_version import PackageVersion
+from debmagic_common.models.package_version import PackageVersion
 
 
 @pytest.mark.parametrize(
diff --git a/packages/debmagic-pkg/src/debmagic/v0/__init__.py b/packages/debmagic-pkg/src/debmagic/v0/__init__.py
@@ -1,4 +1,4 @@
-from debmagic.common.utils import run_cmd
+from debmagic_common.utils import run_cmd
 
 from ._build import Build
 from ._module import autotools, dh
diff --git a/packages/debmagic-pkg/src/debmagic/v0/_build.py b/packages/debmagic-pkg/src/debmagic/v0/_build.py
@@ -7,13 +7,13 @@
 from pathlib import Path
 from typing import Sequence
 
-from debmagic.common.utils import run_cmd
+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
+    from debmagic_common.package import BinaryPackage
 
     from ._package import Package
     from ._package_filter import PackageFilter
diff --git a/packages/debmagic-pkg/src/debmagic/v0/_dpkg/build_env.py b/packages/debmagic-pkg/src/debmagic/v0/_dpkg/build_env.py
@@ -3,8 +3,8 @@
 import subprocess
 from pathlib import Path
 
-from debmagic.common.models.package_version import PackageVersion
-from debmagic.common.utils import run_cmd
+from debmagic_common.models.package_version import PackageVersion
+from debmagic_common.utils import run_cmd
 
 from ._rustc_build_env import build_rustc_build_env
 
diff --git a/packages/debmagic-pkg/src/debmagic/v0/_module/autotools.py b/packages/debmagic-pkg/src/debmagic/v0/_module/autotools.py
@@ -22,7 +22,7 @@
 from pathlib import Path
 from typing import Iterable
 
-from debmagic.common.utils import run_cmd
+from debmagic_common.utils import run_cmd
 
 from .._build import Build, BuildError
 from .._preset import Preset as PresetBase
diff --git a/packages/debmagic-pkg/src/debmagic/v0/_module/dh.py b/packages/debmagic-pkg/src/debmagic/v0/_module/dh.py
@@ -29,7 +29,7 @@ def dh_auto_install(build: Build):
 from pathlib import Path
 from typing import Callable
 
-from debmagic.common.utils import list_strip_head, prefix_idx, run_cmd
+from debmagic_common.utils import list_strip_head, prefix_idx, run_cmd
 
 from .._build import Build
 from .._package import Package
diff --git a/packages/debmagic-pkg/src/debmagic/v0/_package.py b/packages/debmagic-pkg/src/debmagic/v0/_package.py
@@ -10,9 +10,9 @@
 from types import FunctionType
 from typing import Callable, ParamSpec, TypeVar
 
-from debmagic.common.models.package_version import PackageVersion
-from debmagic.common.package import SourcePackage
-from debmagic.common.utils import Namespace, disable_output_buffer
+from debmagic_common.models.package_version import PackageVersion
+from debmagic_common.package import SourcePackage
+from debmagic_common.utils import Namespace, disable_output_buffer
 
 from ._build import Build
 from ._build_order import BuildOrder
diff --git a/packages/debmagic-pkg/src/debmagic/v0/_package_filter.py b/packages/debmagic-pkg/src/debmagic/v0/_package_filter.py
@@ -1,6 +1,6 @@
 from enum import Flag, auto
 
-from debmagic.common.package import BinaryPackage
+from debmagic_common.package import BinaryPackage
 
 
 class PackageFilter(Flag):
diff --git a/packages/debmagic/Cargo.toml b/packages/debmagic/Cargo.toml
@@ -8,13 +8,12 @@ rust-version.workspace = true
 edition.workspace = true
 
 [dependencies]
-clap = { version = ">=4.5.23", features = ["derive"] }
-anyhow = { version = ">=1.0.95" }
-config = { version = ">=0.15.9", features = ["toml"] }
-dirs = ">=5.0.0"
-# thiserror = "2.0.17" # for future uses when we need clearer error handling
-glob = ">=0.3.2"
-libc = ">=0.2.169"
-serde = { version = ">=1.0.217", features = ["derive"] }
-serde_json = ">=1.0.139"
-uuid = { version = ">=1.10.0", features = ["v4"] }
+clap = { workspace = true, features = ["derive"] }
+anyhow = { workspace = true }
+config = { workspace = true, features = ["toml"] }
+dirs = { workspace = true }
+glob = { workspace = true }
+libc = { workspace = true }
+serde = { workspace = true, features = ["derive"] }
+serde_json = { workspace = true }
+uuid = { workspace = true, features = ["v4"] }
diff --git a/tests/integration/test_packages.py b/tests/integration/test_packages.py
@@ -4,7 +4,7 @@
 from pathlib import Path
 
 import pytest
-from debmagic.common.utils import run_cmd
+from debmagic_common.utils import run_cmd
 
 PACKAGES_BASE_PATH = Path(__file__).parent / "packages"
 
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ from pathlib import Path`
`8`	`8`	`packages_root = Path(__file__).parent.parent / "packages"`
`9`	`9`	`sys.path.extend(`
`10`	`10`	`[`
`11`		`- str(packages_root / "debmagic-common" / "src"),`
	`11`	`+ str(packages_root / "debmagic-common" / "python"),`
`12`	`12`	`str(packages_root / "debmagic-pkg" / "src"),`
`13`	`13`	`]`
`14`	`14`	`)`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# export all definitions from the rust submodule - TODO once we have some of those`
	`2`	`+# from debmagic_common._debmagic_common import *`