X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fbindings%2Fpython%2Fbt2%2Fbt2%2Fcomponent.py;h=4e079f7743d934f1b6413efe35c0255028cf0b86;hb=157a98edd5aebe1b6ab7f60a49d8430450fabe76;hp=acc5b22c7b71e931a451cf6cc86629770ed8739b;hpb=e42e1587604ec69593e13503e623688fe26ba1d1;p=babeltrace.git diff --git a/src/bindings/python/bt2/bt2/component.py b/src/bindings/python/bt2/bt2/component.py index acc5b22c..4e079f77 100644 --- a/src/bindings/python/bt2/bt2/component.py +++ b/src/bindings/python/bt2/bt2/component.py @@ -1,24 +1,6 @@ -# The MIT License (MIT) +# SPDX-License-Identifier: MIT # # Copyright (c) 2017 Philippe Proulx -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. from bt2 import native_bt, object, utils from bt2 import message_iterator as bt2_message_iterator @@ -43,7 +25,7 @@ import bt2 # pointer to a 'bt_component_class *'. -class _ComponentClass(object._SharedObject): +class _ComponentClassConst(object._SharedObject): @property def name(self): ptr = self._bt_as_component_class_ptr(self._ptr) @@ -65,7 +47,7 @@ class _ComponentClass(object._SharedObject): return self._bt_as_component_class_ptr(self._ptr) def __eq__(self, other): - if not isinstance(other, _ComponentClass): + if not isinstance(other, _ComponentClassConst): try: if not issubclass(other, _UserComponent): return False @@ -75,7 +57,7 @@ class _ComponentClass(object._SharedObject): return self.addr == other.addr -class _SourceComponentClass(_ComponentClass): +class _SourceComponentClassConst(_ComponentClassConst): _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( @@ -83,7 +65,7 @@ class _SourceComponentClass(_ComponentClass): ) -class _FilterComponentClass(_ComponentClass): +class _FilterComponentClassConst(_ComponentClassConst): _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( @@ -91,7 +73,7 @@ class _FilterComponentClass(_ComponentClass): ) -class _SinkComponentClass(_ComponentClass): +class _SinkComponentClassConst(_ComponentClassConst): _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( @@ -173,7 +155,7 @@ class _ComponentPorts(collections.abc.Mapping): # component pointer (e.g. 'bt_component_sink *') as a 'bt_component *'. -class _Component: +class _ComponentConst: @property def name(self): ptr = self._bt_as_component_ptr(self._ptr) @@ -190,7 +172,7 @@ class _Component: def cls(self): 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( + return _create_component_class_from_const_ptr_and_get_ref( cc_ptr, self._bt_comp_cls_type ) @@ -201,7 +183,7 @@ class _Component: return self.addr == other.addr -class _SourceComponent(_Component): +class _SourceComponentConst(_ComponentConst): _bt_borrow_component_class_ptr = staticmethod( native_bt.component_source_borrow_class_const ) @@ -212,7 +194,7 @@ class _SourceComponent(_Component): _bt_as_component_ptr = staticmethod(native_bt.component_source_as_component_const) -class _FilterComponent(_Component): +class _FilterComponentConst(_ComponentConst): _bt_borrow_component_class_ptr = staticmethod( native_bt.component_filter_borrow_class_const ) @@ -223,7 +205,7 @@ class _FilterComponent(_Component): _bt_as_component_ptr = staticmethod(native_bt.component_filter_as_component_const) -class _SinkComponent(_Component): +class _SinkComponentConst(_ComponentConst): _bt_borrow_component_class_ptr = staticmethod( native_bt.component_sink_borrow_class_const ) @@ -234,9 +216,9 @@ class _SinkComponent(_Component): _bt_as_component_ptr = staticmethod(native_bt.component_sink_as_component_const) -# This is analogous to _SourceComponentClass, but for source +# This is analogous to _SourceComponentClassConst, but for source # component objects. -class _GenericSourceComponent(object._SharedObject, _SourceComponent): +class _GenericSourceComponentConst(object._SharedObject, _SourceComponentConst): _get_ref = staticmethod(native_bt.component_source_get_ref) _put_ref = staticmethod(native_bt.component_source_put_ref) @@ -247,13 +229,13 @@ 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._OutputPortConst, ) -# This is analogous to _FilterComponentClass, but for filter +# This is analogous to _FilterComponentClassConst, but for filter # component objects. -class _GenericFilterComponent(object._SharedObject, _FilterComponent): +class _GenericFilterComponentConst(object._SharedObject, _FilterComponentConst): _get_ref = staticmethod(native_bt.component_filter_get_ref) _put_ref = staticmethod(native_bt.component_filter_put_ref) @@ -264,7 +246,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._OutputPortConst, ) @property @@ -274,13 +256,13 @@ 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._InputPortConst, ) -# This is analogous to _SinkComponentClass, but for sink +# This is analogous to _SinkComponentClassConst, but for sink # component objects. -class _GenericSinkComponent(object._SharedObject, _SinkComponent): +class _GenericSinkComponentConst(object._SharedObject, _SinkComponentConst): _get_ref = staticmethod(native_bt.component_sink_get_ref) _put_ref = staticmethod(native_bt.component_sink_put_ref) @@ -291,32 +273,32 @@ 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._InputPortConst, ) _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS = { - native_bt.COMPONENT_CLASS_TYPE_SOURCE: _GenericSourceComponent, - native_bt.COMPONENT_CLASS_TYPE_FILTER: _GenericFilterComponent, - native_bt.COMPONENT_CLASS_TYPE_SINK: _GenericSinkComponent, + native_bt.COMPONENT_CLASS_TYPE_SOURCE: _GenericSourceComponentConst, + native_bt.COMPONENT_CLASS_TYPE_FILTER: _GenericFilterComponentConst, + native_bt.COMPONENT_CLASS_TYPE_SINK: _GenericSinkComponentConst, } _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS = { - native_bt.COMPONENT_CLASS_TYPE_SOURCE: _SourceComponentClass, - native_bt.COMPONENT_CLASS_TYPE_FILTER: _FilterComponentClass, - native_bt.COMPONENT_CLASS_TYPE_SINK: _SinkComponentClass, + native_bt.COMPONENT_CLASS_TYPE_SOURCE: _SourceComponentClassConst, + native_bt.COMPONENT_CLASS_TYPE_FILTER: _FilterComponentClassConst, + native_bt.COMPONENT_CLASS_TYPE_SINK: _SinkComponentClassConst, } -# Create a component Python object of type _GenericSourceComponent, -# _GenericFilterComponent or _GenericSinkComponent, depending on +# Create a component Python object of type _GenericSourceComponentConst, +# _GenericFilterComponentConst or _GenericSinkComponentConst, depending on # comp_cls_type. # # Steals the reference to ptr from the caller. -def _create_component_from_ptr(ptr, comp_cls_type): +def _create_component_from_const_ptr(ptr, comp_cls_type): return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS[comp_cls_type]._create_from_ptr(ptr) @@ -324,20 +306,20 @@ def _create_component_from_ptr(ptr, comp_cls_type): # reference from the caller. -def _create_component_from_ptr_and_get_ref(ptr, comp_cls_type): +def _create_component_from_const_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) # Create a component class Python object of type -# _SourceComponentClass, _FilterComponentClass or -# _SinkComponentClass, depending on comp_cls_type. +# _SourceComponentClassConst, _FilterComponentClassConst or +# _SinkComponentClassConst, depending on comp_cls_type. # # Acquires a new reference to ptr. -def _create_component_class_from_ptr_and_get_ref(ptr, comp_cls_type): +def _create_component_class_from_const_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) @@ -380,7 +362,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 _ComponentClass interface. +# the _ComponentClassConst interface. # # The component class name which is used is either: # @@ -510,6 +492,9 @@ class _UserComponentType(type): # create instance, not user-initialized yet self = cls.__new__(cls) + # config object + config = cls._config_pycls() + # pointer to native self component object (weak/borrowed) self._bt_ptr = comp_ptr @@ -519,7 +504,7 @@ class _UserComponentType(type): else: params = None - self.__init__(params, obj) + self.__init__(config, params, obj) return self def __call__(cls, *args, **kwargs): @@ -550,6 +535,24 @@ class _UserComponentType(type): ) ) + if hasattr(iter_cls, '_user_can_seek_ns_from_origin') and not hasattr( + iter_cls, '_user_seek_ns_from_origin' + ): + raise bt2._IncompleteUserClass( + "cannot create component class '{}': message iterator class implements _user_can_seek_ns_from_origin but not _user_seek_ns_from_origin".format( + cls.__name__ + ) + ) + + if hasattr(iter_cls, '_user_can_seek_beginning') and not hasattr( + iter_cls, '_user_seek_beginning' + ): + raise bt2._IncompleteUserClass( + "cannot create component class '{}': message iterator class implements _user_can_seek_beginning but not _user_seek_beginning".format( + cls.__name__ + ) + ) + cls._iter_cls = iter_cls @property @@ -592,7 +595,9 @@ class _UserComponentType(type): 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): + def _bt_query_from_native( + cls, priv_query_exec_ptr, object_name, params_ptr, method_obj + ): # this can raise, but the native side checks the exception if params_ptr is not None: params = bt2_value._create_from_const_ptr_and_get_ref(params_ptr) @@ -603,7 +608,7 @@ class _UserComponentType(type): try: # this can raise, but the native side checks the exception - results = cls._user_query(priv_query_exec, object, params, method_obj) + results = cls._user_query(priv_query_exec, object_name, 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 @@ -625,7 +630,7 @@ class _UserComponentType(type): bt2_value._Value._get_ref(results_ptr) return int(results_ptr) - def _user_query(cls, priv_query_executor, object, params, method_obj): + def _user_query(cls, priv_query_executor, object_name, params, method_obj): raise bt2.UnknownObject def _bt_component_class_ptr(self): @@ -638,6 +643,29 @@ class _UserComponentType(type): native_bt.bt2_unregister_cc_ptr_to_py_cls(cc_ptr) +# Configuration objects for components. +# +# These are passed in __init__ to allow components to change some configuration +# parameters during initialization and not after. As you can see, they are not +# used at the moment, but are there in case we want to add such parameters. + + +class _UserComponentConfiguration: + pass + + +class _UserSourceComponentConfiguration(_UserComponentConfiguration): + pass + + +class _UserFilterComponentConfiguration(_UserComponentConfiguration): + pass + + +class _UserSinkComponentConfiguration(_UserComponentConfiguration): + pass + + # Subclasses must provide these methods or property: # # - _bt_as_not_self_specific_component_ptr: static method, must return the passed @@ -669,7 +697,7 @@ class _UserComponent(metaclass=_UserComponentType): def cls(self): 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( + return _create_component_class_from_const_ptr_and_get_ref( cc_ptr, self._bt_comp_cls_type ) @@ -682,7 +710,7 @@ class _UserComponent(metaclass=_UserComponentType): 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): + def __init__(self, config, params, obj): pass def _user_finalize(self): @@ -701,7 +729,7 @@ class _UserComponent(metaclass=_UserComponentType): 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_const_ptr_and_get_ref( other_port_ptr, other_port_type ) self._user_port_connected(port, other_port) @@ -768,13 +796,14 @@ class _UserComponent(metaclass=_UserComponentType): return cc -class _UserSourceComponent(_UserComponent, _SourceComponent): +class _UserSourceComponent(_UserComponent, _SourceComponentConst): _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 ) + _config_pycls = _UserSourceComponentConfiguration @property def _output_ports(self): @@ -792,22 +821,33 @@ class _UserSourceComponent(_UserComponent, _SourceComponent): def _add_output_port(self, name, user_data=None): utils._check_str(name) + + if name in self._output_ports: + raise ValueError( + 'source component `{}` already contains an output port named `{}`'.format( + self.name, name + ) + ) + fn = native_bt.self_component_source_add_output_port 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_and_get_ref( + self_port_ptr + ) -class _UserFilterComponent(_UserComponent, _FilterComponent): +class _UserFilterComponent(_UserComponent, _FilterComponentConst): _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 ) + _config_pycls = _UserFilterComponentConfiguration @property def _output_ports(self): @@ -839,32 +879,53 @@ class _UserFilterComponent(_UserComponent, _FilterComponent): def _add_output_port(self, name, user_data=None): utils._check_str(name) + + if name in self._output_ports: + raise ValueError( + 'filter component `{}` already contains an output port named `{}`'.format( + self.name, name + ) + ) + fn = native_bt.self_component_filter_add_output_port 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_and_get_ref( + self_port_ptr + ) def _add_input_port(self, name, user_data=None): utils._check_str(name) + + if name in self._input_ports: + raise ValueError( + 'filter component `{}` already contains an input port named `{}`'.format( + self.name, name + ) + ) + fn = native_bt.self_component_filter_add_input_port 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_and_get_ref( + self_port_ptr + ) -class _UserSinkComponent(_UserComponent, _SinkComponent): +class _UserSinkComponent(_UserComponent, _SinkComponentConst): _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 ) + _config_pycls = _UserSinkComponentConfiguration def _bt_graph_is_configured_from_native(self): self._user_graph_is_configured() @@ -888,18 +949,31 @@ class _UserSinkComponent(_UserComponent, _SinkComponent): def _add_input_port(self, name, user_data=None): utils._check_str(name) + + if name in self._input_ports: + raise ValueError( + 'sink component `{}` already contains an input port named `{}`'.format( + self.name, name + ) + ) + fn = native_bt.self_component_sink_add_input_port 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_and_get_ref( + self_port_ptr + ) - def _create_input_port_message_iterator(self, input_port): + def _create_message_iterator(self, input_port): utils._check_type(input_port, bt2_port._UserComponentInputPort) - status, msg_iter_ptr = native_bt.bt2_self_component_port_input_message_iterator_create_from_sink_component( + ( + status, + msg_iter_ptr, + ) = native_bt.bt2_message_iterator_create_from_sink_component( self._bt_ptr, input_port._ptr ) utils._handle_func_status(status, 'cannot create message iterator object')