X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fbindings%2Fpython%2Fbt2%2Fbt2%2Fcomponent.py;h=a0d29e272f43d5286cad50f47ff400c68eb33a2f;hb=5783664e46332216fd38a7b287258a7c9543af57;hp=7a79666abae5455db3ce36ed7e2e76b83fd6e3da;hpb=5290f876138c2b71026bd2bbed78077b68cf961a;p=babeltrace.git diff --git a/src/bindings/python/bt2/bt2/component.py b/src/bindings/python/bt2/bt2/component.py index 7a79666a..a0d29e27 100644 --- a/src/bindings/python/bt2/bt2/component.py +++ b/src/bindings/python/bt2/bt2/component.py @@ -21,15 +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 bt2.trace_class -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 # This class wraps a component class pointer. This component class could @@ -247,7 +247,7 @@ 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, ) @@ -264,7 +264,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 @@ -274,7 +274,7 @@ 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, ) @@ -291,7 +291,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, ) @@ -482,9 +482,9 @@ class _UserComponentType(type): 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( + if not hasattr(cls, '_user_consume'): + raise bt2._IncompleteUserClass( + "cannot create component class '{}': missing a _user_consume() method".format( class_name ) ) @@ -493,7 +493,7 @@ 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 ) @@ -506,7 +506,7 @@ class _UserComponentType(type): cls._bt_cc_ptr = cc_ptr - def _bt_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) @@ -515,11 +515,11 @@ 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 - self.__init__(params) + self.__init__(params, obj) return self def __call__(cls, *args, **kwargs): @@ -530,21 +530,21 @@ class _UserComponentType(type): @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__ ) @@ -571,18 +571,47 @@ 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): - # 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) @@ -590,16 +619,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, object, params, method_obj): + raise bt2.UnknownObject def _bt_component_class_ptr(self): return self._bt_as_component_class_ptr(self._bt_cc_ptr) @@ -608,6 +635,7 @@ class _UserComponentType(type): 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: @@ -649,46 +677,57 @@ class _UserComponent(metaclass=_UserComponentType): def addr(self): return int(self._bt_ptr) - def __init__(self, params=None): + @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 __init__(self, params=None, obj=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): + def _create_trace_class( + self, user_attributes=None, 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._MemoryError('could not create trace class') - tc = bt2.trace_class._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 + if user_attributes is not None: + tc._user_attributes = user_attributes + return tc def _create_clock_class( self, frequency=None, name=None, + user_attributes=None, description=None, precision=None, offset=None, @@ -701,7 +740,7 @@ class _UserComponent(metaclass=_UserComponentType): if cc_ptr is None: 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 @@ -709,6 +748,9 @@ class _UserComponent(metaclass=_UserComponentType): if name is not None: cc._name = name + if user_attributes is not None: + cc._user_attributes = user_attributes + if description is not None: cc._description = description @@ -745,7 +787,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): @@ -756,7 +798,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): @@ -778,7 +820,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 @@ -792,7 +834,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): @@ -803,7 +845,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) @@ -813,7 +855,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): @@ -825,9 +867,9 @@ class _UserSinkComponent(_UserComponent, _SinkComponent): ) def _bt_graph_is_configured_from_native(self): - self._graph_is_configured() + self._user_graph_is_configured() - def _graph_is_configured(self): + def _user_graph_is_configured(self): pass @property @@ -841,7 +883,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): @@ -852,19 +894,19 @@ 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) + 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') + raise bt2._MemoryError('cannot create message iterator object') - return bt2.message_iterator._UserComponentInputPortMessageIterator(msg_iter_ptr) + return bt2_message_iterator._UserComponentInputPortMessageIterator(msg_iter_ptr) @property def _is_interrupted(self):