X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fbindings%2Fpython%2Fbt2%2Fbt2%2Fcomponent.py;h=a057019aa379c37cb7af3f471b2fe46cb070a146;hb=45bab74488ace74075d90fea7f776a19906aec05;hp=d7d42a71bf1447e1b2a46e07022d22268c8feebd;hpb=d14a864ace9bc0a891c17a14a508160165a7d30e;p=babeltrace.git diff --git a/src/bindings/python/bt2/bt2/component.py b/src/bindings/python/bt2/bt2/component.py index d7d42a71..a057019a 100644 --- a/src/bindings/python/bt2/bt2/component.py +++ b/src/bindings/python/bt2/bt2/component.py @@ -21,11 +21,14 @@ # THE SOFTWARE. from bt2 import native_bt, object, utils -import bt2.message_iterator +from bt2 import message_iterator as bt2_message_iterator import collections.abc -import bt2.value +from bt2 import value as bt2_value +from bt2 import trace_class as bt2_trace_class +from bt2 import clock_class as bt2_clock_class +from bt2 import query_executor as bt2_query_executor import traceback -import bt2.port +from bt2 import port as bt2_port import sys import bt2 import os @@ -42,7 +45,7 @@ import os # pointer to a 'bt_component_class *'. -class _GenericComponentClass(object._SharedObject): +class _ComponentClass(object._SharedObject): @property def name(self): ptr = self._bt_as_component_class_ptr(self._ptr) @@ -64,7 +67,7 @@ class _GenericComponentClass(object._SharedObject): return self._bt_as_component_class_ptr(self._ptr) def __eq__(self, other): - if not isinstance(other, _GenericComponentClass): + if not isinstance(other, _ComponentClass): try: if not issubclass(other, _UserComponent): return False @@ -74,7 +77,7 @@ class _GenericComponentClass(object._SharedObject): return self.addr == other.addr -class _GenericSourceComponentClass(_GenericComponentClass): +class _SourceComponentClass(_ComponentClass): _get_ref = staticmethod(native_bt.component_class_source_get_ref) _put_ref = staticmethod(native_bt.component_class_source_put_ref) _bt_as_component_class_ptr = staticmethod( @@ -82,7 +85,7 @@ class _GenericSourceComponentClass(_GenericComponentClass): ) -class _GenericFilterComponentClass(_GenericComponentClass): +class _FilterComponentClass(_ComponentClass): _get_ref = staticmethod(native_bt.component_class_filter_get_ref) _put_ref = staticmethod(native_bt.component_class_filter_put_ref) _bt_as_component_class_ptr = staticmethod( @@ -90,7 +93,7 @@ class _GenericFilterComponentClass(_GenericComponentClass): ) -class _GenericSinkComponentClass(_GenericComponentClass): +class _SinkComponentClass(_ComponentClass): _get_ref = staticmethod(native_bt.component_class_sink_get_ref) _put_ref = staticmethod(native_bt.component_class_sink_put_ref) _bt_as_component_class_ptr = staticmethod( @@ -233,7 +236,7 @@ class _SinkComponent(_Component): _bt_as_component_ptr = staticmethod(native_bt.component_sink_as_component_const) -# This is analogous to _GenericSourceComponentClass, but for source +# This is analogous to _SourceComponentClass, but for source # component objects. class _GenericSourceComponent(object._SharedObject, _SourceComponent): _get_ref = staticmethod(native_bt.component_source_get_ref) @@ -246,11 +249,11 @@ class _GenericSourceComponent(object._SharedObject, _SourceComponent): native_bt.component_source_borrow_output_port_by_name_const, native_bt.component_source_borrow_output_port_by_index_const, native_bt.component_source_get_output_port_count, - bt2.port._OutputPort, + bt2_port._OutputPort, ) -# This is analogous to _GenericFilterComponentClass, but for filter +# This is analogous to _FilterComponentClass, but for filter # component objects. class _GenericFilterComponent(object._SharedObject, _FilterComponent): _get_ref = staticmethod(native_bt.component_filter_get_ref) @@ -263,7 +266,7 @@ class _GenericFilterComponent(object._SharedObject, _FilterComponent): native_bt.component_filter_borrow_output_port_by_name_const, native_bt.component_filter_borrow_output_port_by_index_const, native_bt.component_filter_get_output_port_count, - bt2.port._OutputPort, + bt2_port._OutputPort, ) @property @@ -273,11 +276,11 @@ class _GenericFilterComponent(object._SharedObject, _FilterComponent): native_bt.component_filter_borrow_input_port_by_name_const, native_bt.component_filter_borrow_input_port_by_index_const, native_bt.component_filter_get_input_port_count, - bt2.port._InputPort, + bt2_port._InputPort, ) -# This is analogous to _GenericSinkComponentClass, but for sink +# This is analogous to _SinkComponentClass, but for sink # component objects. class _GenericSinkComponent(object._SharedObject, _SinkComponent): _get_ref = staticmethod(native_bt.component_sink_get_ref) @@ -290,7 +293,7 @@ class _GenericSinkComponent(object._SharedObject, _SinkComponent): native_bt.component_sink_borrow_input_port_by_name_const, native_bt.component_sink_borrow_input_port_by_index_const, native_bt.component_sink_get_input_port_count, - bt2.port._InputPort, + bt2_port._InputPort, ) @@ -302,9 +305,9 @@ _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS = { _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS = { - native_bt.COMPONENT_CLASS_TYPE_SOURCE: _GenericSourceComponentClass, - native_bt.COMPONENT_CLASS_TYPE_FILTER: _GenericFilterComponentClass, - native_bt.COMPONENT_CLASS_TYPE_SINK: _GenericSinkComponentClass, + native_bt.COMPONENT_CLASS_TYPE_SOURCE: _SourceComponentClass, + native_bt.COMPONENT_CLASS_TYPE_FILTER: _FilterComponentClass, + native_bt.COMPONENT_CLASS_TYPE_SINK: _SinkComponentClass, } @@ -330,8 +333,8 @@ def _create_component_from_ptr_and_get_ref(ptr, comp_cls_type): # Create a component class Python object of type -# _GenericSourceComponentClass, _GenericFilterComponentClass or -# _GenericSinkComponentClass, depending on comp_cls_type. +# _SourceComponentClass, _FilterComponentClass or +# _SinkComponentClass, depending on comp_cls_type. # # Acquires a new reference to ptr. @@ -379,7 +382,7 @@ def _trim_docstring(docstring): # creates a native BT component class of the corresponding type and # associates it with this user-defined class. The metaclass also defines # class methods like the `name` and `description` properties to match -# the _GenericComponentClass interface. +# the _ComponentClass interface. # # The component class name which is used is either: # @@ -481,16 +484,9 @@ class _UserComponentType(type): cls, comp_cls_name, comp_cls_descr, comp_cls_help ) elif _UserSinkComponent in bases: - if not hasattr(cls, '_graph_is_configured'): - raise bt2.IncompleteUserClass( - "cannot create component class '{}': missing a _graph_is_configured() method".format( - class_name - ) - ) - - if not hasattr(cls, '_consume'): - raise bt2.IncompleteUserClass( - "cannot create component class '{}': missing a _consume() method".format( + if not hasattr(cls, '_user_consume'): + raise bt2._IncompleteUserClass( + "cannot create component class '{}': missing a _user_consume() method".format( class_name ) ) @@ -499,14 +495,14 @@ class _UserComponentType(type): cls, comp_cls_name, comp_cls_descr, comp_cls_help ) else: - raise bt2.IncompleteUserClass( + raise bt2._IncompleteUserClass( "cannot find a known component class base in the bases of '{}'".format( class_name ) ) if cc_ptr is None: - raise bt2.CreationError( + raise bt2._MemoryError( "cannot create component class '{}'".format(class_name) ) @@ -521,7 +517,7 @@ class _UserComponentType(type): # call user's __init__() method if params_ptr is not None: - params = bt2.value._create_from_ptr_and_get_ref(params_ptr) + params = bt2_value._create_from_ptr_and_get_ref(params_ptr) else: params = None @@ -529,28 +525,28 @@ class _UserComponentType(type): return self def __call__(cls, *args, **kwargs): - raise bt2.Error( + raise RuntimeError( 'cannot directly instantiate a user component from a Python module' ) @staticmethod def _bt_set_iterator_class(cls, iter_cls): if iter_cls is None: - raise bt2.IncompleteUserClass( + raise bt2._IncompleteUserClass( "cannot create component class '{}': missing message iterator class".format( cls.__name__ ) ) - if not issubclass(iter_cls, bt2.message_iterator._UserMessageIterator): - raise bt2.IncompleteUserClass( + if not issubclass(iter_cls, bt2_message_iterator._UserMessageIterator): + raise bt2._IncompleteUserClass( "cannot create component class '{}': message iterator class does not inherit bt2._UserMessageIterator".format( cls.__name__ ) ) if not hasattr(iter_cls, '__next__'): - raise bt2.IncompleteUserClass( + raise bt2._IncompleteUserClass( "cannot create component class '{}': message iterator class is missing a __next__() method".format( cls.__name__ ) @@ -577,18 +573,27 @@ class _UserComponentType(type): def addr(cls): return int(cls._bt_cc_ptr) - def _bt_query_from_native(cls, query_exec_ptr, obj, params_ptr, log_level): + def _bt_query_from_native(cls, priv_query_exec_ptr, obj, params_ptr): # this can raise, in which case the native call to # bt_component_class_query() returns NULL if params_ptr is not None: - params = bt2.value._create_from_ptr_and_get_ref(params_ptr) + params = bt2_value._create_from_ptr_and_get_ref(params_ptr) else: params = None - query_exec = bt2.QueryExecutor._create_from_ptr_and_get_ref(query_exec_ptr) + priv_query_exec = bt2_query_executor._PrivateQueryExecutor(priv_query_exec_ptr) - # this can raise, but the native side checks the exception - results = cls._query(query_exec, obj, params, log_level) + try: + # this can raise, but the native side checks the exception + results = cls._user_query(priv_query_exec, obj, params) + finally: + # the private query executor is a private view on the query + # executor; it's not a shared object (the library does not + # offer an API to get/put a reference, just like "self" + # objects) from this query's point of view, so invalidate + # the object in case the user kept a reference and uses it + # later + priv_query_exec._invalidate() # this can raise, but the native side checks the exception results = bt2.create_value(results) @@ -596,16 +601,14 @@ class _UserComponentType(type): if results is None: results_ptr = native_bt.value_null else: - # return new reference results_ptr = results._ptr - # We return a new reference. - bt2.value._Value._get_ref(results_ptr) - + # return new reference + bt2_value._Value._get_ref(results_ptr) return int(results_ptr) - def _query(cls, query_executor, obj, params, log_level): - raise NotImplementedError + def _user_query(cls, priv_query_executor, obj, params): + raise bt2.UnknownObject def _bt_component_class_ptr(self): return self._bt_as_component_class_ptr(self._bt_cc_ptr) @@ -658,35 +661,35 @@ class _UserComponent(metaclass=_UserComponentType): def __init__(self, params=None): pass - def _finalize(self): + def _user_finalize(self): pass - def _port_connected(self, port, other_port): + def _user_port_connected(self, port, other_port): pass def _bt_port_connected_from_native( self, self_port_ptr, self_port_type, other_port_ptr ): - port = bt2.port._create_self_from_ptr_and_get_ref(self_port_ptr, self_port_type) + port = bt2_port._create_self_from_ptr_and_get_ref(self_port_ptr, self_port_type) if self_port_type == native_bt.PORT_TYPE_OUTPUT: other_port_type = native_bt.PORT_TYPE_INPUT else: other_port_type = native_bt.PORT_TYPE_OUTPUT - other_port = bt2.port._create_from_ptr_and_get_ref( + other_port = bt2_port._create_from_ptr_and_get_ref( other_port_ptr, other_port_type ) - self._port_connected(port, other_port) + self._user_port_connected(port, other_port) def _create_trace_class(self, assigns_automatic_stream_class_id=True): ptr = self._bt_as_self_component_ptr(self._bt_ptr) tc_ptr = native_bt.trace_class_create(ptr) if tc_ptr is None: - raise bt2.CreationError('could not create trace class') + raise bt2._MemoryError('could not create trace class') - tc = bt2._TraceClass._create_from_ptr(tc_ptr) + tc = bt2_trace_class._TraceClass._create_from_ptr(tc_ptr) tc._assigns_automatic_stream_class_id = assigns_automatic_stream_class_id return tc @@ -705,9 +708,9 @@ class _UserComponent(metaclass=_UserComponentType): cc_ptr = native_bt.clock_class_create(ptr) if cc_ptr is None: - raise bt2.CreationError('could not create clock class') + raise bt2._MemoryError('could not create clock class') - cc = bt2.clock_class._ClockClass._create_from_ptr(cc_ptr) + cc = bt2_clock_class._ClockClass._create_from_ptr(cc_ptr) if frequency is not None: cc._frequency = frequency @@ -751,7 +754,7 @@ class _UserSourceComponent(_UserComponent, _SourceComponent): native_bt.self_component_source_borrow_output_port_by_name, native_bt.self_component_source_borrow_output_port_by_index, get_output_port_count, - bt2.port._UserComponentOutputPort, + bt2_port._UserComponentOutputPort, ) def _add_output_port(self, name, user_data=None): @@ -762,7 +765,7 @@ class _UserSourceComponent(_UserComponent, _SourceComponent): comp_status, 'cannot add output port to source component object' ) assert self_port_ptr is not None - return bt2.port._UserComponentOutputPort._create_from_ptr(self_port_ptr) + return bt2_port._UserComponentOutputPort._create_from_ptr(self_port_ptr) class _UserFilterComponent(_UserComponent, _FilterComponent): @@ -784,7 +787,7 @@ class _UserFilterComponent(_UserComponent, _FilterComponent): native_bt.self_component_filter_borrow_output_port_by_name, native_bt.self_component_filter_borrow_output_port_by_index, get_output_port_count, - bt2.port._UserComponentOutputPort, + bt2_port._UserComponentOutputPort, ) @property @@ -798,7 +801,7 @@ class _UserFilterComponent(_UserComponent, _FilterComponent): native_bt.self_component_filter_borrow_input_port_by_name, native_bt.self_component_filter_borrow_input_port_by_index, get_input_port_count, - bt2.port._UserComponentInputPort, + bt2_port._UserComponentInputPort, ) def _add_output_port(self, name, user_data=None): @@ -809,7 +812,7 @@ class _UserFilterComponent(_UserComponent, _FilterComponent): comp_status, 'cannot add output port to filter component object' ) assert self_port_ptr - return bt2.port._UserComponentOutputPort._create_from_ptr(self_port_ptr) + return bt2_port._UserComponentOutputPort._create_from_ptr(self_port_ptr) def _add_input_port(self, name, user_data=None): utils._check_str(name) @@ -819,7 +822,7 @@ class _UserFilterComponent(_UserComponent, _FilterComponent): comp_status, 'cannot add input port to filter component object' ) assert self_port_ptr - return bt2.port._UserComponentInputPort._create_from_ptr(self_port_ptr) + return bt2_port._UserComponentInputPort._create_from_ptr(self_port_ptr) class _UserSinkComponent(_UserComponent, _SinkComponent): @@ -831,7 +834,10 @@ class _UserSinkComponent(_UserComponent, _SinkComponent): ) def _bt_graph_is_configured_from_native(self): - self._graph_is_configured() + self._user_graph_is_configured() + + def _user_graph_is_configured(self): + pass @property def _input_ports(self): @@ -844,7 +850,7 @@ class _UserSinkComponent(_UserComponent, _SinkComponent): native_bt.self_component_sink_borrow_input_port_by_name, native_bt.self_component_sink_borrow_input_port_by_index, get_input_port_count, - bt2.port._UserComponentInputPort, + bt2_port._UserComponentInputPort, ) def _add_input_port(self, name, user_data=None): @@ -855,4 +861,20 @@ class _UserSinkComponent(_UserComponent, _SinkComponent): comp_status, 'cannot add input port to sink component object' ) assert self_port_ptr - return bt2.port._UserComponentInputPort._create_from_ptr(self_port_ptr) + return bt2_port._UserComponentInputPort._create_from_ptr(self_port_ptr) + + def _create_input_port_message_iterator(self, input_port): + utils._check_type(input_port, bt2_port._UserComponentInputPort) + + msg_iter_ptr = native_bt.self_component_port_input_message_iterator_create_from_sink_component( + self._bt_ptr, input_port._ptr + ) + + if msg_iter_ptr is None: + raise bt2.CreationError('cannot create message iterator object') + + return bt2_message_iterator._UserComponentInputPortMessageIterator(msg_iter_ptr) + + @property + def _is_interrupted(self): + return bool(native_bt.self_component_sink_is_interrupted(self._bt_ptr))