X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fbindings%2Fpython%2Fbt2%2Fbt2%2Fcomponent.py;h=7f907cc9beee92e1f7e9ce96a3ec5805d994eccd;hb=e5914347c8eea0f26c07348d0ac64dbe020de44a;hp=980a0d45f9f7dd42f9ca4100b38c124be978e161;hpb=75882e97aed48428d4a0abc32a6382be811ad994;p=babeltrace.git diff --git a/src/bindings/python/bt2/bt2/component.py b/src/bindings/python/bt2/bt2/component.py index 980a0d45..7f907cc9 100644 --- a/src/bindings/python/bt2/bt2/component.py +++ b/src/bindings/python/bt2/bt2/component.py @@ -1,26 +1,10 @@ -# 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 native_bt +from bt2 import object as bt2_object +from bt2 import utils as bt2_utils from bt2 import message_iterator as bt2_message_iterator import collections.abc from bt2 import value as bt2_value @@ -43,7 +27,7 @@ import bt2 # pointer to a 'bt_component_class *'. -class _ComponentClassConst(object._SharedObject): +class _ComponentClassConst(bt2_object._SharedObject): @property def name(self): ptr = self._bt_as_component_class_ptr(self._ptr) @@ -76,24 +60,42 @@ class _ComponentClassConst(object._SharedObject): class _SourceComponentClassConst(_ComponentClassConst): - _get_ref = staticmethod(native_bt.component_class_source_get_ref) - _put_ref = staticmethod(native_bt.component_class_source_put_ref) + @staticmethod + def _get_ref(ptr): + native_bt.component_class_source_get_ref(ptr) + + @staticmethod + def _put_ref(ptr): + native_bt.component_class_source_put_ref(ptr) + _bt_as_component_class_ptr = staticmethod( native_bt.component_class_source_as_component_class ) class _FilterComponentClassConst(_ComponentClassConst): - _get_ref = staticmethod(native_bt.component_class_filter_get_ref) - _put_ref = staticmethod(native_bt.component_class_filter_put_ref) + @staticmethod + def _get_ref(ptr): + native_bt.component_class_filter_get_ref(ptr) + + @staticmethod + def _put_ref(ptr): + native_bt.component_class_filter_put_ref(ptr) + _bt_as_component_class_ptr = staticmethod( native_bt.component_class_filter_as_component_class ) class _SinkComponentClassConst(_ComponentClassConst): - _get_ref = staticmethod(native_bt.component_class_sink_get_ref) - _put_ref = staticmethod(native_bt.component_class_sink_put_ref) + @staticmethod + def _get_ref(ptr): + native_bt.component_class_sink_get_ref(ptr) + + @staticmethod + def _put_ref(ptr): + native_bt.component_class_sink_put_ref(ptr) + _bt_as_component_class_ptr = staticmethod( native_bt.component_class_sink_as_component_class ) @@ -122,7 +124,6 @@ class _PortIterator(collections.abc.Iterator): class _ComponentPorts(collections.abc.Mapping): - # component_ptr is a bt_component_source *, bt_component_filter * or # bt_component_sink *. Its type must match the type expected by the # functions passed as arguments. @@ -142,7 +143,7 @@ class _ComponentPorts(collections.abc.Mapping): self._port_pycls = port_pycls def __getitem__(self, key): - utils._check_str(key) + bt2_utils._check_str(key) port_ptr = self._borrow_port_ptr_by_name(self._component_ptr, key) if port_ptr is None: @@ -195,7 +196,7 @@ class _ComponentConst: ) def __eq__(self, other): - if not hasattr(other, 'addr'): + if not hasattr(other, "addr"): return False return self.addr == other.addr @@ -236,9 +237,14 @@ class _SinkComponentConst(_ComponentConst): # This is analogous to _SourceComponentClassConst, but for source # component objects. -class _GenericSourceComponentConst(object._SharedObject, _SourceComponentConst): - _get_ref = staticmethod(native_bt.component_source_get_ref) - _put_ref = staticmethod(native_bt.component_source_put_ref) +class _GenericSourceComponentConst(bt2_object._SharedObject, _SourceComponentConst): + @staticmethod + def _get_ref(ptr): + native_bt.component_source_get_ref(ptr) + + @staticmethod + def _put_ref(ptr): + native_bt.component_source_put_ref(ptr) @property def output_ports(self): @@ -253,9 +259,14 @@ class _GenericSourceComponentConst(object._SharedObject, _SourceComponentConst): # This is analogous to _FilterComponentClassConst, but for filter # component objects. -class _GenericFilterComponentConst(object._SharedObject, _FilterComponentConst): - _get_ref = staticmethod(native_bt.component_filter_get_ref) - _put_ref = staticmethod(native_bt.component_filter_put_ref) +class _GenericFilterComponentConst(bt2_object._SharedObject, _FilterComponentConst): + @staticmethod + def _get_ref(ptr): + native_bt.component_filter_get_ref(ptr) + + @staticmethod + def _put_ref(ptr): + native_bt.component_filter_put_ref(ptr) @property def output_ports(self): @@ -280,9 +291,14 @@ class _GenericFilterComponentConst(object._SharedObject, _FilterComponentConst): # This is analogous to _SinkComponentClassConst, but for sink # component objects. -class _GenericSinkComponentConst(object._SharedObject, _SinkComponentConst): - _get_ref = staticmethod(native_bt.component_sink_get_ref) - _put_ref = staticmethod(native_bt.component_sink_put_ref) +class _GenericSinkComponentConst(bt2_object._SharedObject, _SinkComponentConst): + @staticmethod + def _get_ref(ptr): + native_bt.component_sink_get_ref(ptr) + + @staticmethod + def _put_ref(ptr): + native_bt.component_sink_put_ref(ptr) @property def input_ports(self): @@ -345,17 +361,22 @@ def _create_component_class_from_const_ptr_and_get_ref(ptr, comp_cls_type): def _trim_docstring(docstring): lines = docstring.expandtabs().splitlines() + + if len(lines) == 0: + return "" + indent = sys.maxsize - for line in lines[1:]: - stripped = line.lstrip() + if len(lines) > 1: + for line in lines[1:]: + stripped = line.lstrip() - if stripped: - indent = min(indent, len(line) - len(stripped)) + if stripped: + indent = min(indent, len(line) - len(stripped)) trimmed = [lines[0].strip()] - if indent < sys.maxsize: + if indent < sys.maxsize and len(lines) > 1: for line in lines[1:]: trimmed.append(line[indent:].rstrip()) @@ -365,7 +386,7 @@ def _trim_docstring(docstring): while trimmed and not trimmed[0]: trimmed.pop(0) - return '\n'.join(trimmed) + return "\n".join(trimmed) # Metaclass for component classes defined by Python code. @@ -400,14 +421,19 @@ def _trim_docstring(docstring): # ... # # A user-defined Python component class can have an __init__() method -# which must at least accept the `params` and `name` arguments: +# which must accept the following parameters: # -# def __init__(self, params, name, something_else): +# def __init__(self, config, params, obj): # ... # -# The user-defined component class can also have a _finalize() method -# (do NOT use __del__()) to be notified when the component object is -# finalized. +# The value of the `obj` parameter is what was passed as the `obj` +# parameter if the component was instantiated from Python with +# Graph.add_component(). If the component was not instantiated from +# Python, is is always `None`. +# +# The user-defined component class can also have a _user_finalize() +# method (do NOT use __del__()) to be notified when the component object +# is finalized. # # User-defined source and filter component classes must use the # `message_iterator_class` class parameter to specify the @@ -420,14 +446,16 @@ def _trim_docstring(docstring): # message_iterator_class=MyMessageIterator): # ... # -# This message iterator class must inherit -# bt2._UserMessageIterator, and it must define the _get() and -# _next() methods. The message iterator class can also define an -# __init__() method: this method has access to the original Python -# component object which was used to create it as the `component` -# property. The message iterator class can also define a -# _finalize() method (again, do NOT use __del__()): this is called when -# the message iterator is (really) destroyed. +# This message iterator class must inherit bt2._UserMessageIterator. +# It can implement the __init__() method, which must accept the +# following parameters: +# +# def __init__(self, config, port): +# ... +# +# It can also implement the __next__() and _user_finalize() methods +# (again, do NOT use __del__()), which don't accept any parameters +# other than `self`. # # When the user-defined class is destroyed, this metaclass's __del__() # method is called: the native BT component class pointer is put (not @@ -443,23 +471,23 @@ class _UserComponentType(type): # skip our own bases; they are never directly instantiated by the user own_bases = ( - '_UserComponent', - '_UserFilterSinkComponent', - '_UserSourceComponent', - '_UserFilterComponent', - '_UserSinkComponent', + "_UserComponent", + "_UserFilterSinkComponent", + "_UserSourceComponent", + "_UserFilterComponent", + "_UserSinkComponent", ) if class_name in own_bases: return - comp_cls_name = kwargs.get('name', class_name) - utils._check_str(comp_cls_name) + comp_cls_name = kwargs.get("name", class_name) + bt2_utils._check_str(comp_cls_name) comp_cls_descr = None comp_cls_help = None - if hasattr(cls, '__doc__') and cls.__doc__ is not None: - utils._check_str(cls.__doc__) + if hasattr(cls, "__doc__") and cls.__doc__ is not None: + bt2_utils._check_str(cls.__doc__) docstring = _trim_docstring(cls.__doc__) lines = docstring.splitlines() @@ -467,9 +495,9 @@ class _UserComponentType(type): comp_cls_descr = lines[0] if len(lines) >= 3: - comp_cls_help = '\n'.join(lines[2:]) + comp_cls_help = "\n".join(lines[2:]) - iter_cls = kwargs.get('message_iterator_class') + iter_cls = kwargs.get("message_iterator_class") if _UserSourceComponent in bases: _UserComponentType._bt_set_iterator_class(cls, iter_cls) @@ -482,7 +510,7 @@ class _UserComponentType(type): cls, comp_cls_name, comp_cls_descr, comp_cls_help ) elif _UserSinkComponent in bases: - if not hasattr(cls, '_user_consume'): + if not hasattr(cls, "_user_consume"): raise bt2._IncompleteUserClass( "cannot create component class '{}': missing a _user_consume() method".format( class_name @@ -527,7 +555,7 @@ class _UserComponentType(type): def __call__(cls, *args, **kwargs): raise RuntimeError( - 'cannot directly instantiate a user component from a Python module' + "cannot directly instantiate a user component from a Python module" ) @staticmethod @@ -546,15 +574,15 @@ class _UserComponentType(type): ) ) - if not hasattr(iter_cls, '__next__'): + if not hasattr(iter_cls, "__next__"): raise bt2._IncompleteUserClass( "cannot create component class '{}': message iterator class is missing a __next__() method".format( cls.__name__ ) ) - if hasattr(iter_cls, '_user_can_seek_ns_from_origin') and not hasattr( - iter_cls, '_user_seek_ns_from_origin' + 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( @@ -562,8 +590,8 @@ class _UserComponentType(type): ) ) - if hasattr(iter_cls, '_user_can_seek_beginning') and not hasattr( - iter_cls, '_user_seek_beginning' + 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( @@ -613,7 +641,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) @@ -624,7 +654,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 @@ -646,14 +676,14 @@ 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): return self._bt_as_component_class_ptr(self._bt_cc_ptr) def __del__(cls): - if hasattr(cls, '_bt_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) @@ -757,7 +787,7 @@ class _UserComponent(metaclass=_UserComponentType): tc_ptr = native_bt.trace_class_create(ptr) if tc_ptr is None: - raise bt2._MemoryError('could not create trace class') + 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 @@ -782,7 +812,7 @@ class _UserComponent(metaclass=_UserComponentType): cc_ptr = native_bt.clock_class_create(ptr) if cc_ptr is None: - raise bt2._MemoryError('could not create clock class') + raise bt2._MemoryError("could not create clock class") cc = bt2_clock_class._ClockClass._create_from_ptr(cc_ptr) @@ -836,14 +866,24 @@ class _UserSourceComponent(_UserComponent, _SourceComponentConst): ) def _add_output_port(self, name, user_data=None): - utils._check_str(name) + bt2_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' + bt2_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, _FilterComponentConst): @@ -884,24 +924,44 @@ class _UserFilterComponent(_UserComponent, _FilterComponentConst): ) def _add_output_port(self, name, user_data=None): - utils._check_str(name) + bt2_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' + bt2_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) + bt2_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' + bt2_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, _SinkComponentConst): @@ -934,25 +994,38 @@ class _UserSinkComponent(_UserComponent, _SinkComponentConst): ) def _add_input_port(self, name, user_data=None): - utils._check_str(name) + bt2_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' + bt2_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_message_iterator(self, input_port): + bt2_utils._check_type(input_port, bt2_port._UserComponentInputPort) - def _create_input_port_message_iterator(self, input_port): - utils._check_type(input_port, bt2_port._UserComponentInputPort) + if not input_port.is_connected: + raise ValueError("input port is not connected") ( status, msg_iter_ptr, - ) = native_bt.bt2_self_component_port_input_message_iterator_create_from_sink_component( + ) = 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') + bt2_utils._handle_func_status(status, "cannot create message iterator object") assert msg_iter_ptr is not None return bt2_message_iterator._UserComponentInputPortMessageIterator(msg_iter_ptr)