error

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

Author: shsms

python/frequenz/microgrid_component_graph/__init__.py

@@ -3,10 +3,16 @@
 
 """Python bindings for the Frequenz microgrid component graph rust library."""
 
-from ._component_graph import ComponentGraph, ComponentGraphConfig, InvalidGraphError
+from ._component_graph import (
+    ComponentGraph,
+    ComponentGraphConfig,
+    FormulaGenerationError,
+    InvalidGraphError,
+)
 
 __all__ = [
     "ComponentGraph",
     "ComponentGraphConfig",
+    "FormulaGenerationError",
     "InvalidGraphError",
 ]

python/frequenz/microgrid_component_graph/__init__.pyi

@@ -11,6 +11,9 @@ from typing import AbstractSet, Generic, Protocol, TypeVar
 class InvalidGraphError(Exception):
     """Exception type that will be thrown if graph data is not valid."""
 
+class FormulaGenerationError(Exception):
+    """Encountered during formula generation from the component graph."""
+
 class ComponentIdProtocol(Protocol):
     def __int__(self) -> int:
         """Get the integer representation of the Component ID."""

src/graph.rs

@@ -4,7 +4,7 @@
 use std::collections::BTreeSet;
 
 use crate::{
-    InvalidGraphError,
+    FormulaGenerationError, InvalidGraphError,
     category::{category_from_python_component, match_category},
     component::Component,
     connection::Connection,
@@ -210,21 +210,21 @@ impl ComponentGraph {
         self.graph
             .consumer_formula()
             .map(|f| f.to_string())
-            .map_err(|e| PyErr::new::<pyo3::exceptions::PyValueError, _>(e.to_string()))
+            .map_err(|e| PyErr::new::<FormulaGenerationError, _>(e.to_string()))
     }
 
     fn producer_formula(&self) -> PyResult<String> {
         self.graph
             .producer_formula()
             .map(|f| f.to_string())
-            .map_err(|e| PyErr::new::<pyo3::exceptions::PyValueError, _>(e.to_string()))
+            .map_err(|e| PyErr::new::<FormulaGenerationError, _>(e.to_string()))
     }
 
     fn grid_formula(&self) -> PyResult<String> {
         self.graph
             .grid_formula()
             .map(|f| f.to_string())
-            .map_err(|e| PyErr::new::<pyo3::exceptions::PyValueError, _>(e.to_string()))
+            .map_err(|e| PyErr::new::<FormulaGenerationError, _>(e.to_string()))
     }
 
     #[pyo3(signature = (battery_ids=None))]
@@ -236,15 +236,15 @@ impl ComponentGraph {
         self.graph
             .battery_formula(extract_ids(py, battery_ids)?)
             .map(|f| f.to_string())
-            .map_err(|e| PyErr::new::<pyo3::exceptions::PyValueError, _>(e.to_string()))
+            .map_err(|e| PyErr::new::<FormulaGenerationError, _>(e.to_string()))
     }
 
     #[pyo3(signature = (chp_ids=None))]
     fn chp_formula(&self, py: Python<'_>, chp_ids: Option<Bound<'_, PyAny>>) -> PyResult<String> {
         self.graph
             .chp_formula(extract_ids(py, chp_ids)?)
             .map(|f| f.to_string())
-            .map_err(|e| PyErr::new::<pyo3::exceptions::PyValueError, _>(e.to_string()))
+            .map_err(|e| PyErr::new::<FormulaGenerationError, _>(e.to_string()))
     }
 
     #[pyo3(signature = (pv_inverter_ids=None))]
@@ -256,7 +256,7 @@ impl ComponentGraph {
         self.graph
             .pv_formula(extract_ids(py, pv_inverter_ids)?)
             .map(|f| f.to_string())
-            .map_err(|e| PyErr::new::<pyo3::exceptions::PyValueError, _>(e.to_string()))
+            .map_err(|e| PyErr::new::<FormulaGenerationError, _>(e.to_string()))
     }
 
     #[pyo3(signature = (ev_charger_ids=None))]
@@ -268,14 +268,14 @@ impl ComponentGraph {
         self.graph
             .ev_charger_formula(extract_ids(py, ev_charger_ids)?)
             .map(|f| f.to_string())
-            .map_err(|e| PyErr::new::<pyo3::exceptions::PyValueError, _>(e.to_string()))
+            .map_err(|e| PyErr::new::<FormulaGenerationError, _>(e.to_string()))
     }
 
     fn grid_coalesce_formula(&self) -> PyResult<String> {
         self.graph
             .grid_coalesce_formula()
             .map(|f| f.to_string())
-            .map_err(|e| PyErr::new::<pyo3::exceptions::PyValueError, _>(e.to_string()))
+            .map_err(|e| PyErr::new::<FormulaGenerationError, _>(e.to_string()))
     }
 
     #[pyo3(signature = (battery_ids=None))]
@@ -287,7 +287,7 @@ impl ComponentGraph {
         self.graph
             .battery_ac_coalesce_formula(extract_ids(py, battery_ids)?)
             .map(|f| f.to_string())
-            .map_err(|e| PyErr::new::<pyo3::exceptions::PyValueError, _>(e.to_string()))
+            .map_err(|e| PyErr::new::<FormulaGenerationError, _>(e.to_string()))
     }
 
     #[pyo3(signature = (pv_inverter_ids=None))]
@@ -299,7 +299,7 @@ impl ComponentGraph {
         self.graph
             .pv_ac_coalesce_formula(extract_ids(py, pv_inverter_ids)?)
             .map(|f| f.to_string())
-            .map_err(|e| PyErr::new::<pyo3::exceptions::PyValueError, _>(e.to_string()))
+            .map_err(|e| PyErr::new::<FormulaGenerationError, _>(e.to_string()))
     }
 }
 

src/lib.rs

@@ -16,16 +16,22 @@ pyo3::create_exception!(
     InvalidGraphError,
     pyo3::exceptions::PyException
 );
+pyo3::create_exception!(
+    _component_graph,
+    FormulaGenerationError,
+    pyo3::exceptions::PyException
+);
 
 /// A Python module implemented in Rust.
 #[pymodule]
 mod _component_graph {
+    #[pymodule_export]
+    use super::FormulaGenerationError;
     #[pymodule_export]
     use super::InvalidGraphError;
 
     #[pymodule_export]
     use crate::graph::ComponentGraph;
-
     #[pymodule_export]
     use crate::graph::ComponentGraphConfig;
 }