feat(py-pixi): Add option to create ProjectModelV1 from json and dict (#373)

Add option to create ProjectModelV1 from json and dict

Author: daenny

backends/pixi-build-ros/pixi.lock

@@ -21,9 +21,9 @@ test = "pytest tests"
 [feature.test.dependencies]
 pixi-pycharm = ">=0.0.8,<0.1"
 pytest = "*"
-py-pixi-build-backend = "*"
-# Skipping as it's a long build, uncomment this when developing from source
-# py-pixi-build-backend = { path = "../../py-pixi-build-backend" }
+# You can skip this as it's a long build, uncomment this when developing only in this package
+#py-pixi-build-backend = "*"
+py-pixi-build-backend = { path = "../../py-pixi-build-backend" }
 
 [package.build.backend]
 name = "pixi-build-python"
@@ -44,4 +44,6 @@ pyyaml = "*"
 pixi-build-api-version = ">=2,<3"
 # should be added to `py-pixi-build-backend`
 typing-extensions = "*"
-py-pixi-build-backend = "*"
+# this depends has to match the test dependency, so switch comments if needed
+# py-pixi-build-backend = "*"
+py-pixi-build-backend = { path = "../../py-pixi-build-backend" }

backends/pixi-build-ros/pixi.toml

@@ -1,5 +1,8 @@
-from pathlib import Path
+import json
+import shutil
 import tempfile
+import tomllib
+from pathlib import Path
 from typing import Dict
 
 from pixi_build_ros.distro import Distro
@@ -144,6 +147,56 @@ def test_generate_recipe(package_xmls: Path):
             )
 
 
+def test_recipe_includes_project_run_dependency(package_xmls: Path):
+    """Ensure dependencies declared in project manifest merge into run requirements."""
+
+    with tempfile.TemporaryDirectory() as temp_dir:
+        temp_path = Path(temp_dir)
+
+        package_xml_source = package_xmls / "custom_ros.xml"
+        package_xml_dest = temp_path / "package.xml"
+        package_xml_dest.write_text(package_xml_source.read_text(encoding="utf-8"))
+
+        model_payload = {
+            "name": "custom_ros",
+            "version": "0.0.1",
+            "description": "Demo",
+            "authors": ["Tester the Tester"],
+            "targets": {
+                "defaultTarget": {
+                    "hostDependencies": {},
+                    "buildDependencies": {},
+                    "runDependencies": {
+                        "rich": {
+                            "binary": {
+                                "version": ">=10.0"
+                            }
+                        }
+                    },
+                },
+                "targets": {},
+            },
+        }
+        model = ProjectModelV1.from_json(json.dumps(model_payload))
+
+        config = {"distro": "noetic", "noarch": False}
+        host_platform = Platform.current()
+        generator = ROSGenerator()
+
+        generated_recipe = generator.generate_recipe(
+            model=model,
+            config=config,
+            manifest_path=str(temp_path),
+            host_platform=host_platform,
+        )
+
+        run_requirements = [str(dep) for dep in generated_recipe.recipe.requirements.run]
+
+        assert any("rich" in dep for dep in run_requirements), (
+            f"Expected pixi run dependency 'rich' missing from recipe run requirements"
+        )
+
+
 def test_robostack_target_platform_linux(package_map: Dict[str, PackageMapEntry]):
     """Test that target platform correctly selects Linux packages from robostack.yaml."""
     distro = Distro("jazzy")

backends/pixi-build-ros/tests/test_package_xml.py

@@ -36,7 +36,6 @@ serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 serde_yaml = "0.9"
 tokio = { version = "1.43.0", features = ["macros", "rt-multi-thread", "rt"] }
-
 rattler_conda_types = { version = "0.39.0", default-features = false }
 
 rattler-build = "*"

py-pixi-build-backend/Cargo.toml

@@ -1,4 +1,5 @@
-from typing import Optional, List
+from typing import Optional, List, Mapping, Dict, Any
+from pathlib import Path
 from pixi_build_backend.pixi_build_backend import (
     PyProjectModelV1,
 )
@@ -35,6 +36,27 @@ def _from_py(cls, model: PyProjectModelV1) -> "ProjectModelV1":
         instance._inner = model
         return instance
 
+    @classmethod
+    def from_json(cls, json: str) -> "ProjectModelV1":
+        """Create a ProjectModelV1 from a JSON document."""
+        instance = cls.__new__(cls)
+        instance._inner = PyProjectModelV1.from_json(json)
+        return instance
+
+    @classmethod
+    def from_dict(cls, data: Mapping[str, Any] | Dict[str, Any]) -> "ProjectModelV1":
+        """Create a ProjectModelV1 from a Python mapping."""
+        instance = cls.__new__(cls)
+        instance._inner = PyProjectModelV1.from_dict(dict(data))
+        return instance
+
+    @classmethod
+    def from_json_file(cls, path: Path | str) -> "ProjectModelV1":
+        """Create a ProjectModelV1 from a JSON file."""
+        instance = cls.__new__(cls)
+        instance._inner = PyProjectModelV1.from_json_file(str(path))
+        return instance
+
     @property
     def version(self) -> Optional[str]:
         """

py-pixi-build-backend/pixi_build_backend/types/project_model.py

@@ -1,8 +1,13 @@
-use std::str::FromStr;
+use std::{
+    fs,
+    str::FromStr,
+};
 
-use pixi_build_types::ProjectModelV1;
-use pyo3::prelude::*;
-use rattler_conda_types::Version;
+use pixi_build_types::{ProjectModelV1};
+use pyo3::{exceptions::PyValueError, prelude::*};
+use rattler_conda_types::{Version};
+use serde_json::from_str;
+use pythonize::depythonize;
 
 #[pyclass]
 #[derive(Clone)]
@@ -35,6 +40,34 @@ impl PyProjectModelV1 {
         }
     }
 
+    #[staticmethod]
+    pub fn from_json(json: &str) -> PyResult<Self> {
+        let project: ProjectModelV1 = from_str(json).map_err(|err| {
+            PyErr::new::<PyValueError, _>(format!(
+                "Failed to parse ProjectModelV1 from JSON: {err}"
+            ))
+        })?;
+
+        Ok(PyProjectModelV1 { inner: project })
+    }
+
+    #[staticmethod]
+    pub fn from_dict(value: &Bound<PyAny>) -> PyResult<Self> {
+        let project: ProjectModelV1 = depythonize(value)?;
+        Ok(PyProjectModelV1 { inner: project })
+    }
+
+    #[staticmethod]
+    pub fn from_json_file(path: &str) -> PyResult<Self> {
+        let content = fs::read_to_string(path).map_err(|err| {
+            PyErr::new::<PyValueError, _>(format!(
+                "Failed to read ProjectModelV1 JSON file '{path}': {err}"
+            ))
+        })?;
+
+        Self::from_json(&content)
+    }
+    
     #[getter]
     pub fn name(&self) -> Option<&String> {
         self.inner.name.as_ref()

py-pixi-build-backend/src/types/project_model.rs

@@ -0,0 +1,38 @@
+{
+  "name": "minimal-package",
+  "version": "1.0.0",
+  "description": null,
+  "authors": null,
+  "license": null,
+  "license_file": null,
+  "readme": null,
+  "homepage": null,
+  "repository": null,
+  "documentation": null,
+  "targets": {
+    "defaultTarget": {
+      "hostDependencies": {},
+      "buildDependencies": {},
+      "runDependencies": {
+        "python": {
+          "binary": {
+            "version": ">=3.8"
+          }
+        }
+      }
+    },
+    "targets": {
+      "Linux": {
+        "hostDependencies": {
+            "rich": {
+                "binary": {
+                "version": ">=10.0"
+                }
+            }
+        },
+        "buildDependencies": {},
+        "runDependencies": {}
+      }
+    }
+  }
+}

py-pixi-build-backend/tests/data/project_model_example.json

@@ -2,3 +2,12 @@
 # name: test_project_model_initialization
   'ProjectModelV1 { name: Some("test_project"), version: Some(Version { version: [[0], [1], [0], [0]], local: [] }), description: None, authors: None, license: None, license_file: None, readme: None, homepage: None, repository: None, documentation: None, targets: None }'
 # ---
+# name: test_project_model_initialization_from_json
+  'ProjectModelV1 { name: Some("test_project"), version: Some(Version { version: [[0], [1], [0], [0]], local: [] }), description: None, authors: None, license: None, license_file: None, readme: None, homepage: None, repository: None, documentation: None, targets: None }'
+# ---
+# name: test_project_model_initialization_from_dict
+  'ProjectModelV1 { name: Some("test_project"), version: Some(Version { version: [[0], [1], [0], [0]], local: [] }), description: None, authors: None, license: None, license_file: None, readme: None, homepage: None, repository: None, documentation: None, targets: None }'
+# ---
+# name: test_project_model_initialization_from_json_file
+  'ProjectModelV1 { name: Some("minimal-package"), version: Some(Version { version: [[0], [1], [0], [0]], local: [] }), description: None, authors: None, license: None, license_file: None, readme: None, homepage: None, repository: None, documentation: None, targets: Some(TargetsV1 { default_target: Some(TargetV1 { host_dependencies: Some({}), build_dependencies: Some({}), run_dependencies: Some({"python": Binary(NamelessMatchSpecV1 { version: Range(GreaterEquals, Version { version: [[0], [3], [8]], local: [] }) })}) }), targets: Some({Platform("Linux"): TargetV1 { host_dependencies: Some({"rich": Binary(NamelessMatchSpecV1 { version: Range(GreaterEquals, Version { version: [[0], [10], [0]], local: [] }) })}), build_dependencies: Some({}), run_dependencies: Some({}) }}) }) }'
+# ---

py-pixi-build-backend/tests/unit/__snapshots__/test_project_model.ambr

@@ -1,6 +1,8 @@
 """Unit tests for project_model.py module."""
 
 from typing import Any
+from pathlib import Path
+import json
 from pixi_build_backend.types.project_model import ProjectModelV1
 
 
@@ -9,3 +11,23 @@ def test_project_model_initialization(snapshot: Any) -> None:
     model = ProjectModelV1(name="test_project", version="1.0.0")
 
     assert model._debug_str() == snapshot
+
+
+def test_project_model_initialization_from_json(snapshot: Any) -> None:
+    """Test initialization of ProjectModelV1."""
+    model = ProjectModelV1.from_json(json.dumps({"name": "test_project", "version": "1.0.0"}))
+
+    assert model._debug_str() == snapshot
+
+
+def test_project_model_initialization_from_dict(snapshot: Any) -> None:
+    """Test initialization of ProjectModelV1 from a Python mapping."""
+    model = ProjectModelV1.from_dict({"name": "test_project", "version": "1.0.0"})
+
+    assert model._debug_str() == snapshot
+
+
+def test_project_model_initialization_from_json_file(snapshot: Any) -> None:
+    json_file =  Path(__file__).parent.parent / "data" / "project_model_example.json"
+    model = ProjectModelV1.from_json_file(json_file)
+    assert model._debug_str() == snapshot