X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fbindings%2Fpython%2Fbt2%2Fbt2%2Fcomponent.py;h=a68da615f1b542f187cc0637c83f4b7f325d94f1;hb=056deb59eb33e87c06c0067907768ab08aff74a2;hp=b2edd34e49e4515a63a7d234e75671ff01fce4dd;hpb=9cf25bf277fee373465b13e2f4f11cc62cff0bd3;p=babeltrace.git diff --git a/src/bindings/python/bt2/bt2/component.py b/src/bindings/python/bt2/bt2/component.py index b2edd34e..a68da615 100644 --- a/src/bindings/python/bt2/bt2/component.py +++ b/src/bindings/python/bt2/bt2/component.py @@ -21,18 +21,15 @@ # 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 -import traceback -import bt2.port +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 +from bt2 import port as bt2_port import sys import bt2 -import os - - -_env_var = os.environ.get('BABELTRACE_PYTHON_BT2_NO_TRACEBACK') -_NO_PRINT_TRACEBACK = _env_var == '1' # This class wraps a component class pointer. This component class could @@ -42,32 +39,33 @@ _NO_PRINT_TRACEBACK = _env_var == '1' # # Subclasses must implement some methods that this base class uses: # -# - _as_component_class_ptr: static method, convert the passed component class +# - _bt_as_component_class_ptr: static method, convert the passed component class # pointer to a 'bt_component_class *'. -class _GenericComponentClass(object._SharedObject): + +class _ComponentClass(object._SharedObject): @property def name(self): - ptr = self._as_component_class_ptr(self._ptr) + ptr = self._bt_as_component_class_ptr(self._ptr) name = native_bt.component_class_get_name(ptr) assert name is not None return name @property def description(self): - ptr = self._as_component_class_ptr(self._ptr) + ptr = self._bt_as_component_class_ptr(self._ptr) return native_bt.component_class_get_description(ptr) @property def help(self): - ptr = self._as_component_class_ptr(self._ptr) + ptr = self._bt_as_component_class_ptr(self._ptr) return native_bt.component_class_get_help(ptr) - def _component_class_ptr(self): - return self._as_component_class_ptr(self._ptr) + def _bt_component_class_ptr(self): + 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 @@ -77,33 +75,28 @@ 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) - _as_component_class_ptr = staticmethod(native_bt.component_class_source_as_component_class) + _bt_as_component_class_ptr = staticmethod( + native_bt.component_class_source_as_component_class + ) -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) - _as_component_class_ptr = staticmethod(native_bt.component_class_filter_as_component_class) + _bt_as_component_class_ptr = staticmethod( + native_bt.component_class_filter_as_component_class + ) -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) - _as_component_class_ptr = staticmethod(native_bt.component_class_sink_as_component_class) - - -def _handle_component_status(status, gen_error_msg): - if status == native_bt.SELF_COMPONENT_STATUS_END: - raise bt2.Stop - elif status == native_bt.SELF_COMPONENT_STATUS_AGAIN: - raise bt2.TryAgain - elif status == native_bt.SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION: - raise bt2.PortConnectionRefused - elif status < 0: - raise bt2.Error(gen_error_msg) + _bt_as_component_class_ptr = staticmethod( + native_bt.component_class_sink_as_component_class + ) class _PortIterator(collections.abc.Iterator): @@ -134,11 +127,14 @@ class _ComponentPorts(collections.abc.Mapping): # bt_component_sink *. Its type must match the type expected by the # functions passed as arguments. - def __init__(self, component_ptr, - borrow_port_ptr_by_name, - borrow_port_ptr_at_index, - get_port_count, - port_pycls): + def __init__( + self, + component_ptr, + borrow_port_ptr_by_name, + borrow_port_ptr_at_index, + get_port_count, + port_pycls, + ): self._component_ptr = component_ptr self._borrow_port_ptr_by_name = borrow_port_ptr_by_name self._borrow_port_ptr_at_index = borrow_port_ptr_at_index @@ -168,32 +164,35 @@ class _ComponentPorts(collections.abc.Mapping): # # Subclasses must provide these methods or property: # -# - _borrow_component_class_ptr: static method, must return a pointer to the +# - _bt_borrow_component_class_ptr: static method, must return a pointer to the # specialized component class (e.g. 'bt_component_class_sink *') of the # passed specialized component pointer (e.g. 'bt_component_sink *'). -# - _comp_cls_type: property, one of the native_bt.COMPONENT_CLASS_TYPE_* +# - _bt_comp_cls_type: property, one of the native_bt.COMPONENT_CLASS_TYPE_* # constants. -# - _as_component_ptr: static method, must return the passed specialized +# - _bt_as_component_ptr: static method, must return the passed specialized # component pointer (e.g. 'bt_component_sink *') as a 'bt_component *'. + class _Component: @property def name(self): - ptr = self._as_component_ptr(self._ptr) + ptr = self._bt_as_component_ptr(self._ptr) name = native_bt.component_get_name(ptr) assert name is not None return name @property def logging_level(self): - ptr = self._as_component_ptr(self._ptr) + ptr = self._bt_as_component_ptr(self._ptr) return native_bt.component_get_logging_level(ptr) @property def cls(self): - cc_ptr = self._borrow_component_class_ptr(self._ptr) + cc_ptr = self._bt_borrow_component_class_ptr(self._ptr) assert cc_ptr is not None - return _create_component_class_from_ptr_and_get_ref(cc_ptr, self._comp_cls_type) + return _create_component_class_from_ptr_and_get_ref( + cc_ptr, self._bt_comp_cls_type + ) def __eq__(self, other): if not hasattr(other, 'addr'): @@ -203,27 +202,39 @@ class _Component: class _SourceComponent(_Component): - _borrow_component_class_ptr = staticmethod(native_bt.component_source_borrow_class_const) - _comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_SOURCE - _as_component_class_ptr = staticmethod(native_bt.component_class_source_as_component_class) - _as_component_ptr = staticmethod(native_bt.component_source_as_component_const) + _bt_borrow_component_class_ptr = staticmethod( + native_bt.component_source_borrow_class_const + ) + _bt_comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_SOURCE + _bt_as_component_class_ptr = staticmethod( + native_bt.component_class_source_as_component_class + ) + _bt_as_component_ptr = staticmethod(native_bt.component_source_as_component_const) class _FilterComponent(_Component): - _borrow_component_class_ptr = staticmethod(native_bt.component_filter_borrow_class_const) - _comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_FILTER - _as_component_class_ptr = staticmethod(native_bt.component_class_filter_as_component_class) - _as_component_ptr = staticmethod(native_bt.component_filter_as_component_const) + _bt_borrow_component_class_ptr = staticmethod( + native_bt.component_filter_borrow_class_const + ) + _bt_comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_FILTER + _bt_as_component_class_ptr = staticmethod( + native_bt.component_class_filter_as_component_class + ) + _bt_as_component_ptr = staticmethod(native_bt.component_filter_as_component_const) class _SinkComponent(_Component): - _borrow_component_class_ptr = staticmethod(native_bt.component_sink_borrow_class_const) - _comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_SINK - _as_component_class_ptr = staticmethod(native_bt.component_class_sink_as_component_class) - _as_component_ptr = staticmethod(native_bt.component_sink_as_component_const) + _bt_borrow_component_class_ptr = staticmethod( + native_bt.component_sink_borrow_class_const + ) + _bt_comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_SINK + _bt_as_component_class_ptr = staticmethod( + native_bt.component_class_sink_as_component_class + ) + _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) @@ -231,14 +242,16 @@ class _GenericSourceComponent(object._SharedObject, _SourceComponent): @property def output_ports(self): - return _ComponentPorts(self._ptr, - 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) + return _ComponentPorts( + self._ptr, + 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, + ) -# 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) @@ -246,22 +259,26 @@ class _GenericFilterComponent(object._SharedObject, _FilterComponent): @property def output_ports(self): - return _ComponentPorts(self._ptr, - 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) + return _ComponentPorts( + self._ptr, + 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, + ) @property def input_ports(self): - return _ComponentPorts(self._ptr, - 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) + return _ComponentPorts( + self._ptr, + 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, + ) -# 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) @@ -269,11 +286,13 @@ class _GenericSinkComponent(object._SharedObject, _SinkComponent): @property def input_ports(self): - return _ComponentPorts(self._ptr, - 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) + return _ComponentPorts( + self._ptr, + 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, + ) _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS = { @@ -284,9 +303,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, } @@ -296,6 +315,7 @@ _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS = { # # Steals the reference to ptr from the caller. + def _create_component_from_ptr(ptr, comp_cls_type): return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS[comp_cls_type]._create_from_ptr(ptr) @@ -303,18 +323,24 @@ def _create_component_from_ptr(ptr, comp_cls_type): # Same as the above, but acquire a new reference instead of stealing the # reference from the caller. + def _create_component_from_ptr_and_get_ref(ptr, comp_cls_type): - return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS[comp_cls_type]._create_from_ptr_and_get_ref(ptr) + return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS[ + comp_cls_type + ]._create_from_ptr_and_get_ref(ptr) # 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. + def _create_component_class_from_ptr_and_get_ref(ptr, comp_cls_type): - return _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS[comp_cls_type]._create_from_ptr_and_get_ref(ptr) + return _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS[ + comp_cls_type + ]._create_from_ptr_and_get_ref(ptr) def _trim_docstring(docstring): @@ -354,7 +380,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: # @@ -446,233 +472,269 @@ class _UserComponentType(type): iter_cls = kwargs.get('message_iterator_class') if _UserSourceComponent in bases: - _UserComponentType._set_iterator_class(cls, iter_cls) - cc_ptr = native_bt.py3_component_class_source_create(cls, - comp_cls_name, - comp_cls_descr, - comp_cls_help) + _UserComponentType._bt_set_iterator_class(cls, iter_cls) + cc_ptr = native_bt.bt2_component_class_source_create( + cls, comp_cls_name, comp_cls_descr, comp_cls_help + ) elif _UserFilterComponent in bases: - _UserComponentType._set_iterator_class(cls, iter_cls) - cc_ptr = native_bt.py3_component_class_filter_create(cls, - comp_cls_name, - comp_cls_descr, - comp_cls_help) + _UserComponentType._bt_set_iterator_class(cls, iter_cls) + cc_ptr = native_bt.bt2_component_class_filter_create( + cls, comp_cls_name, comp_cls_descr, comp_cls_help + ) elif _UserSinkComponent in bases: - if not hasattr(cls, '_consume'): - raise bt2.IncompleteUserClass("cannot create component class '{}': missing a _consume() method".format(class_name)) - - cc_ptr = native_bt.py3_component_class_sink_create(cls, - comp_cls_name, - comp_cls_descr, - comp_cls_help) + if not hasattr(cls, '_user_consume'): + raise bt2._IncompleteUserClass( + "cannot create component class '{}': missing a _user_consume() method".format( + class_name + ) + ) + + cc_ptr = native_bt.bt2_component_class_sink_create( + cls, comp_cls_name, comp_cls_descr, comp_cls_help + ) else: - raise bt2.IncompleteUserClass("cannot find a known component class base in the bases of '{}'".format(class_name)) + 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("cannot create component class '{}'".format(class_name)) + raise bt2._MemoryError( + "cannot create component class '{}'".format(class_name) + ) - cls._cc_ptr = cc_ptr + cls._bt_cc_ptr = cc_ptr - def _init_from_native(cls, comp_ptr, params_ptr): + def _bt_init_from_native(cls, comp_ptr, params_ptr, obj): # create instance, not user-initialized yet self = cls.__new__(cls) # pointer to native self component object (weak/borrowed) - self._ptr = comp_ptr + self._bt_ptr = comp_ptr # 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 - self.__init__(params) + self.__init__(params, obj) return self def __call__(cls, *args, **kwargs): - raise bt2.Error('cannot directly instantiate a user component from a Python module') + raise RuntimeError( + 'cannot directly instantiate a user component from a Python module' + ) @staticmethod - def _set_iterator_class(cls, iter_cls): + def _bt_set_iterator_class(cls, iter_cls): if iter_cls is None: - 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("cannot create component class '{}': message iterator class does not inherit bt2._UserMessageIterator".format(cls.__name__)) + 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( + "cannot create component class '{}': message iterator class does not inherit bt2._UserMessageIterator".format( + cls.__name__ + ) + ) if not hasattr(iter_cls, '__next__'): - raise bt2.IncompleteUserClass("cannot create component class '{}': message iterator class is missing a __next__() method".format(cls.__name__)) + raise bt2._IncompleteUserClass( + "cannot create component class '{}': message iterator class is missing a __next__() method".format( + cls.__name__ + ) + ) cls._iter_cls = iter_cls @property def name(cls): - ptr = cls._as_component_class_ptr(cls._cc_ptr) + ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr) return native_bt.component_class_get_name(ptr) @property def description(cls): - ptr = cls._as_component_class_ptr(cls._cc_ptr) + ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr) return native_bt.component_class_get_description(ptr) @property def help(cls): - ptr = cls._as_component_class_ptr(cls._cc_ptr) + ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr) return native_bt.component_class_get_help(ptr) @property def addr(cls): - return int(cls._cc_ptr) + return int(cls._bt_cc_ptr) - def _query_from_native(cls, query_exec_ptr, obj, params_ptr, log_level): - # this can raise, in which case the native call to - # bt_component_class_query() returns NULL + def _bt_get_supported_mip_versions_from_native(cls, params_ptr, obj, log_level): + # this can raise, but the native side checks the exception 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) + # this can raise, but the native side checks the exception + range_set = cls._user_get_supported_mip_versions(params, obj, log_level) + + if type(range_set) is not bt2.UnsignedIntegerRangeSet: + # this can raise, but the native side checks the exception + range_set = bt2.UnsignedIntegerRangeSet(range_set) + + # return new reference + range_set._get_ref(range_set._ptr) + return int(range_set._ptr) + def _user_get_supported_mip_versions(cls, params, obj, log_level): + return [0] + + def _bt_query_from_native(cls, priv_query_exec_ptr, object, params_ptr, method_obj): # this can raise, but the native side checks the exception - results = cls._query(query_exec, obj, params, log_level) + if params_ptr is not None: + params = bt2_value._create_from_ptr_and_get_ref(params_ptr) + else: + params = None + + priv_query_exec = bt2_query_executor._PrivateQueryExecutor(priv_query_exec_ptr) + + try: + # this can raise, but the native side checks the exception + results = cls._user_query(priv_query_exec, object, params, method_obj) + 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) if results is None: - results_addr = int(native_bt.value_null) + results_ptr = native_bt.value_null else: - # return new reference - results_addr = int(results._release()) + results_ptr = results._ptr - return results_addr + # 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, object, params, method_obj): + raise bt2.UnknownObject - def _component_class_ptr(self): - return self._as_component_class_ptr(self._cc_ptr) + def _bt_component_class_ptr(self): + return self._bt_as_component_class_ptr(self._bt_cc_ptr) def __del__(cls): - if hasattr(cls, '_cc_ptr'): - cc_ptr = cls._as_component_class_ptr(cls._cc_ptr) + if hasattr(cls, '_bt_cc_ptr'): + cc_ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr) native_bt.component_class_put_ref(cc_ptr) + native_bt.bt2_unregister_cc_ptr_to_py_cls(cc_ptr) + # Subclasses must provide these methods or property: # -# - _as_not_self_specific_component_ptr: static method, must return the passed +# - _bt_as_not_self_specific_component_ptr: static method, must return the passed # specialized self component pointer (e.g. 'bt_self_component_sink *') as a # specialized non-self pointer (e.g. 'bt_component_sink *'). -# - _borrow_component_class_ptr: static method, must return a pointer to the +# - _bt_borrow_component_class_ptr: static method, must return a pointer to the # specialized component class (e.g. 'bt_component_class_sink *') of the # passed specialized component pointer (e.g. 'bt_component_sink *'). -# - _comp_cls_type: property, one of the native_bt.COMPONENT_CLASS_TYPE_* +# - _bt_comp_cls_type: property, one of the native_bt.COMPONENT_CLASS_TYPE_* # constants. + class _UserComponent(metaclass=_UserComponentType): @property def name(self): - ptr = self._as_not_self_specific_component_ptr(self._ptr) - ptr = self._as_component_ptr(ptr) + ptr = self._bt_as_not_self_specific_component_ptr(self._bt_ptr) + ptr = self._bt_as_component_ptr(ptr) name = native_bt.component_get_name(ptr) assert name is not None return name @property def logging_level(self): - ptr = self._as_not_self_specific_component_ptr(self._ptr) - ptr = self._as_component_ptr(ptr) + ptr = self._bt_as_not_self_specific_component_ptr(self._bt_ptr) + ptr = self._bt_as_component_ptr(ptr) return native_bt.component_get_logging_level(ptr) @property def cls(self): - comp_ptr = self._as_not_self_specific_component_ptr(self._ptr) - cc_ptr = self._borrow_component_class_ptr(comp_ptr) - return _create_component_class_from_ptr_and_get_ref(cc_ptr, self._comp_cls_type) + comp_ptr = self._bt_as_not_self_specific_component_ptr(self._bt_ptr) + cc_ptr = self._bt_borrow_component_class_ptr(comp_ptr) + return _create_component_class_from_ptr_and_get_ref( + cc_ptr, self._bt_comp_cls_type + ) @property def addr(self): - return int(self._ptr) + return int(self._bt_ptr) - def __init__(self, params=None): - pass + @property + def _graph_mip_version(self): + ptr = self._bt_as_self_component_ptr(self._bt_ptr) + return native_bt.self_component_get_graph_mip_version(ptr) - def _finalize(self): + def __init__(self, params=None, obj=None): pass - def _accept_port_connection(self, port, other_port): - return True - - def _accept_port_connection_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) - - 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_ptr, other_port_type) - res = self._accept_port_connection(port, other_port_ptr) - - if type(res) is not bool: - raise TypeError("'{}' is not a 'bool' object") - - return res + def _user_finalize(self): + pass - def _port_connected(self, port, other_port): + def _user_port_connected(self, port, other_port): pass - def _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) + 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) 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_ptr, other_port_type) - self._port_connected(port, other_port) - - def _graph_is_configured_from_native(self): - self._graph_is_configured() + other_port = bt2_port._create_from_ptr_and_get_ref( + other_port_ptr, other_port_type + ) + self._user_port_connected(port, other_port) - def _create_trace_class(self, env=None, uuid=None, - assigns_automatic_stream_class_id=True): - ptr = self._as_self_component_ptr(self._ptr) + 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') - - tc = bt2._TraceClass._create_from_ptr(tc_ptr) - - if env is not None: - for key, value in env.items(): - tc.env[key] = value - - if uuid is not None: - tc._uuid = uuid + raise bt2._MemoryError('could not create trace class') + tc = bt2_trace_class._TraceClass._create_from_ptr(tc_ptr) tc._assigns_automatic_stream_class_id = assigns_automatic_stream_class_id return tc - def _create_clock_class(self, frequency=None, name=None, description=None, - precision=None, offset=None, origin_is_unix_epoch=True, - uuid=None): - ptr = self._as_self_component_ptr(self._ptr) + def _create_clock_class( + self, + frequency=None, + name=None, + description=None, + precision=None, + offset=None, + origin_is_unix_epoch=True, + uuid=None, + ): + ptr = self._bt_as_self_component_ptr(self._bt_ptr) 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 @@ -698,99 +760,145 @@ class _UserComponent(metaclass=_UserComponentType): class _UserSourceComponent(_UserComponent, _SourceComponent): - _as_not_self_specific_component_ptr = staticmethod(native_bt.self_component_source_as_component_source) - _as_self_component_ptr = staticmethod(native_bt.self_component_source_as_self_component) + _bt_as_not_self_specific_component_ptr = staticmethod( + native_bt.self_component_source_as_component_source + ) + _bt_as_self_component_ptr = staticmethod( + native_bt.self_component_source_as_self_component + ) @property def _output_ports(self): def get_output_port_count(self_ptr): - ptr = self._as_not_self_specific_component_ptr(self_ptr) + ptr = self._bt_as_not_self_specific_component_ptr(self_ptr) return native_bt.component_source_get_output_port_count(ptr) - return _ComponentPorts(self._ptr, - 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) + return _ComponentPorts( + self._bt_ptr, + 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, + ) def _add_output_port(self, name, user_data=None): utils._check_str(name) fn = native_bt.self_component_source_add_output_port - comp_status, self_port_ptr = fn(self._ptr, name, user_data) - _handle_component_status(comp_status, - 'cannot add output port to source component object') + comp_status, self_port_ptr = fn(self._bt_ptr, name, user_data) + utils._handle_func_status( + 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): - _as_not_self_specific_component_ptr = staticmethod(native_bt.self_component_filter_as_component_filter) - _as_self_component_ptr = staticmethod(native_bt.self_component_filter_as_self_component) + _bt_as_not_self_specific_component_ptr = staticmethod( + native_bt.self_component_filter_as_component_filter + ) + _bt_as_self_component_ptr = staticmethod( + native_bt.self_component_filter_as_self_component + ) @property def _output_ports(self): def get_output_port_count(self_ptr): - ptr = self._as_not_self_specific_component_ptr(self_ptr) + ptr = self._bt_as_not_self_specific_component_ptr(self_ptr) return native_bt.component_filter_get_output_port_count(ptr) - return _ComponentPorts(self._ptr, - 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) + return _ComponentPorts( + self._bt_ptr, + 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, + ) @property def _input_ports(self): def get_input_port_count(self_ptr): - ptr = self._as_not_self_specific_component_ptr(self_ptr) + ptr = self._bt_as_not_self_specific_component_ptr(self_ptr) return native_bt.component_filter_get_input_port_count(ptr) - return _ComponentPorts(self._ptr, - 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) + return _ComponentPorts( + self._bt_ptr, + 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, + ) def _add_output_port(self, name, user_data=None): utils._check_str(name) fn = native_bt.self_component_filter_add_output_port - comp_status, self_port_ptr = fn(self._ptr, name, user_data) - _handle_component_status(comp_status, - 'cannot add output port to filter component object') + comp_status, self_port_ptr = fn(self._bt_ptr, name, user_data) + utils._handle_func_status( + 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) fn = native_bt.self_component_filter_add_input_port - comp_status, self_port_ptr = fn(self._ptr, name, user_data) - _handle_component_status(comp_status, - 'cannot add input port to filter component object') + comp_status, self_port_ptr = fn(self._bt_ptr, name, user_data) + utils._handle_func_status( + 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): - _as_not_self_specific_component_ptr = staticmethod(native_bt.self_component_sink_as_component_sink) - _as_self_component_ptr = staticmethod(native_bt.self_component_sink_as_self_component) + _bt_as_not_self_specific_component_ptr = staticmethod( + native_bt.self_component_sink_as_component_sink + ) + _bt_as_self_component_ptr = staticmethod( + native_bt.self_component_sink_as_self_component + ) + + def _bt_graph_is_configured_from_native(self): + self._user_graph_is_configured() + + def _user_graph_is_configured(self): + pass @property def _input_ports(self): def get_input_port_count(self_ptr): - ptr = self._as_not_self_specific_component_ptr(self_ptr) + ptr = self._bt_as_not_self_specific_component_ptr(self_ptr) return native_bt.component_sink_get_input_port_count(ptr) - return _ComponentPorts(self._ptr, - 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) + return _ComponentPorts( + self._bt_ptr, + 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, + ) def _add_input_port(self, name, user_data=None): utils._check_str(name) fn = native_bt.self_component_sink_add_input_port - comp_status, self_port_ptr = fn(self._ptr, name, user_data) - _handle_component_status(comp_status, - 'cannot add input port to sink component object') + comp_status, self_port_ptr = fn(self._bt_ptr, name, user_data) + utils._handle_func_status( + 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._MemoryError('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))