lib: graph API: return borrowed references when adding to an object
[babeltrace.git] / src / bindings / python / bt2 / bt2 / graph.py
index 6c9db7ec96a24b4e97d4b44c993fc2c2a6100514..9611c6e287b9f7f69c8a1560317c5d75a56848f0 100644 (file)
@@ -33,39 +33,13 @@ import bt2
 def _graph_port_added_listener_from_native(
     user_listener, component_ptr, component_type, port_ptr, port_type
 ):
-    component = bt2_component._create_component_from_ptr_and_get_ref(
+    component = bt2_component._create_component_from_const_ptr_and_get_ref(
         component_ptr, component_type
     )
-    port = bt2_port._create_from_ptr_and_get_ref(port_ptr, port_type)
+    port = bt2_port._create_from_const_ptr_and_get_ref(port_ptr, port_type)
     user_listener(component, port)
 
 
-def _graph_ports_connected_listener_from_native(
-    user_listener,
-    upstream_component_ptr,
-    upstream_component_type,
-    upstream_port_ptr,
-    downstream_component_ptr,
-    downstream_component_type,
-    downstream_port_ptr,
-):
-    upstream_component = bt2_component._create_component_from_ptr_and_get_ref(
-        upstream_component_ptr, upstream_component_type
-    )
-    upstream_port = bt2_port._create_from_ptr_and_get_ref(
-        upstream_port_ptr, native_bt.PORT_TYPE_OUTPUT
-    )
-    downstream_component = bt2_component._create_component_from_ptr_and_get_ref(
-        downstream_component_ptr, downstream_component_type
-    )
-    downstream_port = bt2_port._create_from_ptr_and_get_ref(
-        downstream_port_ptr, native_bt.PORT_TYPE_INPUT
-    )
-    user_listener(
-        upstream_component, upstream_port, downstream_component, downstream_port
-    )
-
-
 class Graph(object._SharedObject):
     _get_ref = staticmethod(native_bt.graph_get_ref)
     _put_ref = staticmethod(native_bt.graph_put_ref)
@@ -83,6 +57,10 @@ class Graph(object._SharedObject):
 
         super().__init__(ptr)
 
+        # list of listener partials to keep a reference as long as
+        # this graph exists
+        self._listener_partials = []
+
     def add_component(
         self,
         component_class,
@@ -91,15 +69,15 @@ class Graph(object._SharedObject):
         obj=None,
         logging_level=bt2_logging.LoggingLevel.NONE,
     ):
-        if isinstance(component_class, bt2_component._SourceComponentClass):
+        if isinstance(component_class, bt2_component._SourceComponentClassConst):
             cc_ptr = component_class._ptr
             add_fn = native_bt.bt2_graph_add_source_component
             cc_type = native_bt.COMPONENT_CLASS_TYPE_SOURCE
-        elif isinstance(component_class, bt2_component._FilterComponentClass):
+        elif isinstance(component_class, bt2_component._FilterComponentClassConst):
             cc_ptr = component_class._ptr
             add_fn = native_bt.bt2_graph_add_filter_component
             cc_type = native_bt.COMPONENT_CLASS_TYPE_FILTER
-        elif isinstance(component_class, bt2_component._SinkComponentClass):
+        elif isinstance(component_class, bt2_component._SinkComponentClassConst):
             cc_ptr = component_class._ptr
             add_fn = native_bt.bt2_graph_add_sink_component
             cc_type = native_bt.COMPONENT_CLASS_TYPE_SINK
@@ -129,7 +107,11 @@ class Graph(object._SharedObject):
         if obj is not None and not native_bt.bt2_is_python_component_class(base_cc_ptr):
             raise ValueError('cannot pass a Python object to a non-Python component')
 
+        if params is not None and not isinstance(params, (dict, bt2.MapValue)):
+            raise TypeError("'params' parameter is not a 'dict' or a 'bt2.MapValue'.")
+
         params = bt2.create_value(params)
+
         params_ptr = params._ptr if params is not None else None
 
         status, comp_ptr = add_fn(
@@ -137,17 +119,19 @@ class Graph(object._SharedObject):
         )
         utils._handle_func_status(status, 'cannot add component to graph')
         assert comp_ptr
-        return bt2_component._create_component_from_ptr(comp_ptr, cc_type)
+        return bt2_component._create_component_from_const_ptr_and_get_ref(
+            comp_ptr, cc_type
+        )
 
     def connect_ports(self, upstream_port, downstream_port):
-        utils._check_type(upstream_port, bt2_port._OutputPort)
-        utils._check_type(downstream_port, bt2_port._InputPort)
+        utils._check_type(upstream_port, bt2_port._OutputPortConst)
+        utils._check_type(downstream_port, bt2_port._InputPortConst)
         status, conn_ptr = native_bt.graph_connect_ports(
             self._ptr, upstream_port._ptr, downstream_port._ptr
         )
         utils._handle_func_status(status, 'cannot connect component ports within graph')
         assert conn_ptr
-        return bt2_connection._Connection._create_from_ptr(conn_ptr)
+        return bt2_connection._ConnectionConst._create_from_ptr_and_get_ref(conn_ptr)
 
     def add_port_added_listener(self, listener):
         if not callable(listener):
@@ -162,22 +146,8 @@ class Graph(object._SharedObject):
         if listener_ids is None:
             raise bt2._Error('cannot add listener to graph object')
 
-        return utils._ListenerHandle(listener_ids, self)
-
-    def add_ports_connected_listener(self, listener):
-        if not callable(listener):
-            raise TypeError("'listener' parameter is not callable")
-
-        fn = native_bt.bt2_graph_add_ports_connected_listener
-        listener_from_native = functools.partial(
-            _graph_ports_connected_listener_from_native, listener
-        )
-
-        listener_ids = fn(self._ptr, listener_from_native)
-        if listener_ids is None:
-            raise bt2._Error('cannot add listener to graph object')
-
-        return utils._ListenerHandle(listener_ids, self)
+        # keep the partial's reference
+        self._listener_partials.append(listener_from_native)
 
     def run_once(self):
         status = native_bt.graph_run_once(self._ptr)
@@ -185,18 +155,13 @@ class Graph(object._SharedObject):
 
     def run(self):
         status = native_bt.graph_run(self._ptr)
-
-        try:
-            utils._handle_func_status(status, 'graph object stopped running')
-        except bt2.Stop:
-            # done
-            return
-        except Exception:
-            raise
+        utils._handle_func_status(status, 'graph object stopped running')
 
     def add_interrupter(self, interrupter):
         utils._check_type(interrupter, bt2_interrupter.Interrupter)
         native_bt.graph_add_interrupter(self._ptr, interrupter._ptr)
 
-    def interrupt(self):
-        native_bt.graph_interrupt(self._ptr)
+    @property
+    def default_interrupter(self):
+        ptr = native_bt.graph_borrow_default_interrupter(self._ptr)
+        return bt2_interrupter.Interrupter._create_from_ptr_and_get_ref(ptr)
This page took 0.025211 seconds and 4 git commands to generate.