Merge pull request #501 from dora-rs/python-dataflow-id

Add `dataflow_id` getter in python
dora-rs · May 18, 2024 · 8e14df4 · 8e14df4
2 parents bdecc71 + 0f53090
commit 8e14df4
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/apis/python/node/dora/__init__.pyi b/apis/python/node/dora/__init__.pyi
@@ -39,6 +39,9 @@ node = Node()
 
 This method returns the parsed dataflow YAML file."""
 
+    def dataflow_id(self) -> str:
+        """Returns the dataflow id."""
+
     def merge_external_events(self, subscription: dora.Ros2Subscription) -> None:
         """Merge an external event stream with dora main loop.
 This currently only work with ROS2."""

diff --git a/apis/python/node/src/lib.rs b/apis/python/node/src/lib.rs
@@ -154,6 +154,13 @@ impl Node {
         pythonize::pythonize(py, self.node.dataflow_descriptor())
     }
 
+    /// Returns the dataflow id.
+    ///
+    /// :rtype: str
+    pub fn dataflow_id(&self) -> String {
+        self.node.dataflow_id().to_string()
+    }
+
     /// Merge an external event stream with dora main loop.
     /// This currently only work with ROS2.
     ///