Update build-system to maturin and expose ComponentGraph to python

Also add tests to make sure graph creation and formula creation work.

Signed-off-by: Sahas Subramanian <[email protected]>

Author: shsms

pyproject.toml

@@ -2,20 +2,15 @@
 # Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
 [build-system]
-requires = [
-  "setuptools == 75.8.0",
-  "setuptools_scm[toml] == 9.2.2",
-  "frequenz-repo-config[lib] == 0.13.6",
-]
-build-backend = "setuptools.build_meta"
+requires = ["maturin>=1.9.6,<2.0"]
+build-backend = "maturin"
 
 [project]
 name = "frequenz-microgrid-component-graph"
 description = "Python bindings for the Frequenz microgrid component graph rust library."
 readme = "README.md"
 license = { text = "MIT" }
 keywords = ["frequenz", "python", "lib", "library", "microgrid-component-graph"]
-# TODO(cookiecutter): Remove and add more classifiers if appropriate
 classifiers = [
   "Development Status :: 3 - Alpha",
   "Intended Audience :: Developers",
@@ -26,7 +21,6 @@ classifiers = [
   "Typing :: Typed",
 ]
 requires-python = ">= 3.11, < 4"
-# TODO(cookiecutter): Remove and add more dependencies if appropriate
 dependencies = [
   "typing-extensions >= 4.14.1, < 5",
 ]
@@ -36,8 +30,13 @@ dynamic = ["version"]
 name = "Frequenz Energy-as-a-Service GmbH"
 email = "[email protected]"
 
-# TODO(cookiecutter): Remove and add more optional dependencies if appropriate
 [project.optional-dependencies]
+microgrid = [
+  "frequenz-client-microgrid >= 0.18.0, < 0.19",
+]
+assets = [
+  "frequenz-client-assets >= 0.1.0, < 0.2",
+]
 dev-flake8 = [
   "flake8 == 7.3.0",
   "flake8-docstrings == 1.7.0",
@@ -74,6 +73,7 @@ dev-pylint = [
   "frequenz-microgrid-component-graph[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
+  "frequenz-microgrid-component-graph[microgrid]",
   "pytest == 8.4.2",
   "pylint == 4.0.2",       # We need this to check for the examples
   "frequenz-repo-config[extra-lint-examples] == 0.13.6",
@@ -92,6 +92,11 @@ Issues = "https://github.com/frequenz-floss/frequenz-microgrid-component-graph-p
 Repository = "https://github.com/frequenz-floss/frequenz-microgrid-component-graph-python"
 Support = "https://github.com/frequenz-floss/frequenz-microgrid-component-graph-python/discussions/categories/support"
 
+[tool.maturin]
+features = ["pyo3/extension-module"]
+module-name = "frequenz.microgrid_component_graph._component_graph"
+python-source = "python"
+
 [tool.black]
 line-length = 88
 target-version = ['py311']
@@ -101,6 +106,7 @@ include = '\.pyi?$'
 profile = "black"
 line_length = 88
 src_paths = ["benchmarks", "examples", "python", "tests"]
+skip_glob = ["*.pyi"]
 
 [tool.flake8]
 # We give some flexibility to go over 88, there are cases like long URLs or

python/frequenz/microgrid_component_graph/__init__.py

@@ -2,3 +2,17 @@
 # Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
 """Python bindings for the Frequenz microgrid component graph rust library."""
+
+from ._component_graph import (
+    ComponentGraph,
+    ComponentGraphConfig,
+    FormulaGenerationError,
+    InvalidGraphError,
+)
+
+__all__ = [
+    "ComponentGraph",
+    "ComponentGraphConfig",
+    "FormulaGenerationError",
+    "InvalidGraphError",
+]

tests/test_microgrid_component_graph.py

@@ -3,9 +3,77 @@
 
 """Tests for the frequenz.microgrid_component_graph package."""
 
+from frequenz.client.common.microgrid import MicrogridId
+from frequenz.client.common.microgrid.components import ComponentId
+from frequenz.client.microgrid.component import (
+    Component,
+    ComponentConnection,
+    GridConnectionPoint,
+    Meter,
+    SolarInverter,
+)
+
 from frequenz import microgrid_component_graph
 
 
-def test_loading() -> None:
+def test_graph_creation() -> None:
     """Test that the microgrid_component_graph module loads correctly."""
-    assert microgrid_component_graph is not None
+    graph: microgrid_component_graph.ComponentGraph[
+        Component, ComponentConnection, ComponentId
+    ] = microgrid_component_graph.ComponentGraph(
+        components={
+            GridConnectionPoint(
+                id=ComponentId(1),
+                microgrid_id=MicrogridId(1),
+                rated_fuse_current=100,
+            ),
+            Meter(id=ComponentId(2), microgrid_id=MicrogridId(1)),
+            Meter(id=ComponentId(3), microgrid_id=MicrogridId(1)),
+            SolarInverter(id=ComponentId(4), microgrid_id=MicrogridId(1)),
+        },
+        connections={
+            ComponentConnection(source=ComponentId(1), destination=ComponentId(2)),
+            ComponentConnection(source=ComponentId(1), destination=ComponentId(3)),
+            ComponentConnection(source=ComponentId(2), destination=ComponentId(4)),
+        },
+    )
+    assert graph.components() == {
+        GridConnectionPoint(
+            id=ComponentId(1), microgrid_id=MicrogridId(1), rated_fuse_current=100
+        ),
+        Meter(id=ComponentId(2), microgrid_id=MicrogridId(1)),
+        Meter(id=ComponentId(3), microgrid_id=MicrogridId(1)),
+        SolarInverter(id=ComponentId(4), microgrid_id=MicrogridId(1)),
+    }
+    assert graph.connections() == {
+        ComponentConnection(source=ComponentId(1), destination=ComponentId(2)),
+        ComponentConnection(source=ComponentId(1), destination=ComponentId(3)),
+        ComponentConnection(source=ComponentId(2), destination=ComponentId(4)),
+    }
+    assert graph.components(matching_ids=[ComponentId(2), ComponentId(3)]) == {
+        Meter(id=ComponentId(2), microgrid_id=MicrogridId(1)),
+        Meter(id=ComponentId(3), microgrid_id=MicrogridId(1)),
+    }
+    assert graph.components(matching_ids=ComponentId(1)) == {
+        GridConnectionPoint(
+            id=ComponentId(1), microgrid_id=MicrogridId(1), rated_fuse_current=100
+        )
+    }
+    assert graph.components(matching_types=Meter) == {
+        Meter(id=ComponentId(2), microgrid_id=MicrogridId(1)),
+        Meter(id=ComponentId(3), microgrid_id=MicrogridId(1)),
+    }
+    assert graph.components(matching_types=[Meter, GridConnectionPoint]) == {
+        Meter(id=ComponentId(2), microgrid_id=MicrogridId(1)),
+        Meter(id=ComponentId(3), microgrid_id=MicrogridId(1)),
+        GridConnectionPoint(
+            id=ComponentId(1), microgrid_id=MicrogridId(1), rated_fuse_current=100
+        ),
+    }
+    assert graph.components(
+        matching_types=[Meter, SolarInverter],
+        matching_ids=[ComponentId(1), ComponentId(3), ComponentId(4)],
+    ) == {
+        Meter(id=ComponentId(3), microgrid_id=MicrogridId(1)),
+        SolarInverter(id=ComponentId(4), microgrid_id=MicrogridId(1)),
+    }