Add `_bt` prefix to all private attributes and methods of classes of
which the user can inherit. This is done to prevent attribute name
clashes between the base class and the user class. We will document that
the user must not have any attribute with the `_bt_` prefix.
Here are the attribute and method names of inheritable classes with this
commit:
_UserSinkComponent:
self._add_input_port
self._bt_as_component_class_ptr
self._bt_as_component_ptr
self._bt_as_not_self_specific_component_ptr
self._bt_as_self_component_ptr
self._bt_borrow_component_class_ptr
self._bt_cc_ptr
self._bt_comp_cls_type
self._bt_graph_is_configured_from_native
self._bt_port_connected_from_native
self._bt_ptr
self._consume
self._create_clock_class
self._create_trace_class
self._finalize
self._input_ports
self._port_connected
self.addr
self.cls
self.logging_level
self.name
_UserMessageIterator:
self._bt_can_seek_beginning_from_native
self._bt_init_from_native
self._bt_next_from_native
self._bt_ptr
self._bt_seek_beginning_from_native
self._bt_validate_stream_activity_message_default_clock_snapshot
self._can_seek_beginning
self._component
self._create_discarded_events_message
self._create_discarded_packets_message
self._create_event_message
self._create_message_iterator_inactivity_message
self._create_packet_beginning_message
self._create_packet_end_message
self._create_stream_activity_beginning_message
self._create_stream_activity_end_message
self._create_stream_beginning_message
self._create_stream_end_message
self._finalize
self._infinite_clock_snapshot
self._seek_beginning
self._unknown_clock_snapshot
self.addr
Signed-off-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Change-Id: Ia42f247038cc3d054199a8c94becddcb088b646a
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1626
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
#
# Subclasses must implement some methods that this base class uses:
#
#
# 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):
@property
def name(self):
# pointer to a 'bt_component_class *'.
class _GenericComponentClass(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):
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):
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)
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):
def __eq__(self, other):
if not isinstance(other, _GenericComponentClass):
class _GenericSourceComponentClass(_GenericComponentClass):
_get_ref = staticmethod(native_bt.component_class_source_get_ref)
_put_ref = staticmethod(native_bt.component_class_source_put_ref)
class _GenericSourceComponentClass(_GenericComponentClass):
_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):
_get_ref = staticmethod(native_bt.component_class_filter_get_ref)
_put_ref = staticmethod(native_bt.component_class_filter_put_ref)
class _GenericFilterComponentClass(_GenericComponentClass):
_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):
_get_ref = staticmethod(native_bt.component_class_sink_get_ref)
_put_ref = staticmethod(native_bt.component_class_sink_put_ref)
class _GenericSinkComponentClass(_GenericComponentClass):
_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)
+ _bt_as_component_class_ptr = staticmethod(native_bt.component_class_sink_as_component_class)
class _PortIterator(collections.abc.Iterator):
class _PortIterator(collections.abc.Iterator):
#
# Subclasses must provide these methods or property:
#
#
# 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 *').
# 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_*
-# - _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):
# 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):
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):
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
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'):
def __eq__(self, other):
if not hasattr(other, 'addr'):
class _SourceComponent(_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):
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):
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 _GenericSourceComponentClass, but for source
iter_cls = kwargs.get('message_iterator_class')
if _UserSourceComponent in bases:
iter_cls = kwargs.get('message_iterator_class')
if _UserSourceComponent in bases:
- _UserComponentType._set_iterator_class(cls, iter_cls)
+ _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:
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)
+ _UserComponentType._bt_set_iterator_class(cls, iter_cls)
cc_ptr = native_bt.bt2_component_class_filter_create(cls,
comp_cls_name,
comp_cls_descr,
cc_ptr = native_bt.bt2_component_class_filter_create(cls,
comp_cls_name,
comp_cls_descr,
if cc_ptr is None:
raise bt2.CreationError("cannot create component class '{}'".format(class_name))
if cc_ptr is None:
raise bt2.CreationError("cannot create component class '{}'".format(class_name))
+ 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):
# create instance, not user-initialized yet
self = cls.__new__(cls)
# pointer to native self component object (weak/borrowed)
# create instance, not user-initialized yet
self = cls.__new__(cls)
# pointer to native self component object (weak/borrowed)
+ self._bt_ptr = comp_ptr
# call user's __init__() method
if params_ptr is not None:
# call user's __init__() method
if params_ptr is not None:
raise bt2.Error('cannot directly instantiate a user component from a Python module')
@staticmethod
raise bt2.Error('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 iter_cls is None:
raise bt2.IncompleteUserClass("cannot create component class '{}': missing message iterator class".format(cls.__name__))
- 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):
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):
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 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):
+ 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
if params_ptr is not None:
# this can raise, in which case the native call to
# bt_component_class_query() returns NULL
if params_ptr is not None:
def _query(cls, query_executor, obj, params, log_level):
raise NotImplementedError
def _query(cls, query_executor, obj, params, log_level):
raise NotImplementedError
- 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)
- 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)
# Subclasses must provide these methods or property:
#
native_bt.component_class_put_ref(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 *').
# 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 *').
# 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):
# 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):
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):
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):
@property
def addr(self):
+ return int(self._bt_ptr)
def __init__(self, params=None):
pass
def __init__(self, params=None):
pass
def _port_connected(self, port, other_port):
pass
def _port_connected(self, port, other_port):
pass
- def _port_connected_from_native(self, self_port_ptr, self_port_type, other_port_ptr):
+ 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)
other_port_ptr, other_port_type)
self._port_connected(port, other_port)
other_port_ptr, other_port_type)
self._port_connected(port, other_port)
- def _graph_is_configured_from_native(self):
+ def _bt_graph_is_configured_from_native(self):
self._graph_is_configured()
def _create_trace_class(self, env=None, uuid=None,
assigns_automatic_stream_class_id=True):
self._graph_is_configured()
def _create_trace_class(self, env=None, uuid=None,
assigns_automatic_stream_class_id=True):
- ptr = self._as_self_component_ptr(self._ptr)
+ ptr = self._bt_as_self_component_ptr(self._bt_ptr)
tc_ptr = native_bt.trace_class_create(ptr)
if tc_ptr is None:
tc_ptr = native_bt.trace_class_create(ptr)
if tc_ptr is None:
def _create_clock_class(self, frequency=None, name=None, description=None,
precision=None, offset=None, origin_is_unix_epoch=True,
uuid=None):
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)
+ ptr = self._bt_as_self_component_ptr(self._bt_ptr)
cc_ptr = native_bt.clock_class_create(ptr)
if cc_ptr is None:
cc_ptr = native_bt.clock_class_create(ptr)
if cc_ptr is None:
class _UserSourceComponent(_UserComponent, _SourceComponent):
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):
@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 native_bt.component_source_get_output_port_count(ptr)
- return _ComponentPorts(self._ptr,
+ 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,
native_bt.self_component_source_borrow_output_port_by_name,
native_bt.self_component_source_borrow_output_port_by_index,
get_output_port_count,
def _add_output_port(self, name, user_data=None):
utils._check_str(name)
fn = native_bt.self_component_source_add_output_port
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)
+ 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
utils._handle_func_status(comp_status,
'cannot add output port to source component object')
assert self_port_ptr is not None
class _UserFilterComponent(_UserComponent, _FilterComponent):
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):
@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 native_bt.component_filter_get_output_port_count(ptr)
- return _ComponentPorts(self._ptr,
+ 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,
native_bt.self_component_filter_borrow_output_port_by_name,
native_bt.self_component_filter_borrow_output_port_by_index,
get_output_port_count,
@property
def _input_ports(self):
def get_input_port_count(self_ptr):
@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 native_bt.component_filter_get_input_port_count(ptr)
- return _ComponentPorts(self._ptr,
+ 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,
native_bt.self_component_filter_borrow_input_port_by_name,
native_bt.self_component_filter_borrow_input_port_by_index,
get_input_port_count,
def _add_output_port(self, name, user_data=None):
utils._check_str(name)
fn = native_bt.self_component_filter_add_output_port
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)
+ 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
utils._handle_func_status(comp_status,
'cannot add output port to filter component object')
assert 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
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)
+ 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
utils._handle_func_status(comp_status,
'cannot add input port to filter component object')
assert self_port_ptr
class _UserSinkComponent(_UserComponent, _SinkComponent):
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)
@property
def _input_ports(self):
def get_input_port_count(self_ptr):
@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 native_bt.component_sink_get_input_port_count(ptr)
- return _ComponentPorts(self._ptr,
+ 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,
native_bt.self_component_sink_borrow_input_port_by_name,
native_bt.self_component_sink_borrow_input_port_by_index,
get_input_port_count,
def _add_input_port(self, name, user_data=None):
utils._check_str(name)
fn = native_bt.self_component_sink_add_input_port
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)
+ 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
utils._handle_func_status(comp_status,
'cannot add input port to sink component object')
assert self_port_ptr
add_fn = native_bt.graph_add_sink_component
cc_type = native_bt.COMPONENT_CLASS_TYPE_SINK
elif issubclass(component_class, bt2.component._UserSourceComponent):
add_fn = native_bt.graph_add_sink_component
cc_type = native_bt.COMPONENT_CLASS_TYPE_SINK
elif issubclass(component_class, bt2.component._UserSourceComponent):
- cc_ptr = component_class._cc_ptr
+ cc_ptr = component_class._bt_cc_ptr
add_fn = native_bt.graph_add_source_component
cc_type = native_bt.COMPONENT_CLASS_TYPE_SOURCE
elif issubclass(component_class, bt2.component._UserSinkComponent):
add_fn = native_bt.graph_add_source_component
cc_type = native_bt.COMPONENT_CLASS_TYPE_SOURCE
elif issubclass(component_class, bt2.component._UserSinkComponent):
- cc_ptr = component_class._cc_ptr
+ cc_ptr = component_class._bt_cc_ptr
add_fn = native_bt.graph_add_sink_component
cc_type = native_bt.COMPONENT_CLASS_TYPE_SINK
elif issubclass(component_class, bt2.component._UserFilterComponent):
add_fn = native_bt.graph_add_sink_component
cc_type = native_bt.COMPONENT_CLASS_TYPE_SINK
elif issubclass(component_class, bt2.component._UserFilterComponent):
- cc_ptr = component_class._cc_ptr
+ cc_ptr = component_class._bt_cc_ptr
add_fn = native_bt.graph_add_filter_component
cc_type = native_bt.COMPONENT_CLASS_TYPE_FILTER
else:
add_fn = native_bt.graph_add_filter_component
cc_type = native_bt.COMPONENT_CLASS_TYPE_FILTER
else:
# The native code calls this, then manually calls
# self.__init__() without the `ptr` argument. The user has
# access to self.component during this call, thanks to this
# The native code calls this, then manually calls
# self.__init__() without the `ptr` argument. The user has
# access to self.component during this call, thanks to this
- # self._ptr argument being set.
+ # self._bt_ptr argument being set.
- # self._ptr is NOT owned by this object here, so there's nothing
+ # self._bt_ptr is NOT owned by this object here, so there's nothing
# to do in __del__().
self = super().__new__(cls)
# to do in __del__().
self = super().__new__(cls)
- def _init_from_native(self, self_output_port_ptr):
+ def _bt_init_from_native(self, self_output_port_ptr):
self_output_port = bt2.port._create_self_from_ptr_and_get_ref(
self_output_port_ptr, native_bt.PORT_TYPE_OUTPUT)
self.__init__(self_output_port)
self_output_port = bt2.port._create_self_from_ptr_and_get_ref(
self_output_port_ptr, native_bt.PORT_TYPE_OUTPUT)
self.__init__(self_output_port)
@property
def _component(self):
@property
def _component(self):
- return native_bt.bt2_get_user_component_from_user_msg_iter(self._ptr)
+ return native_bt.bt2_get_user_component_from_user_msg_iter(self._bt_ptr)
@property
def addr(self):
@property
def addr(self):
+ return int(self._bt_ptr)
def _finalize(self):
pass
def _finalize(self):
pass
def __next__(self):
raise bt2.Stop
def __next__(self):
raise bt2.Stop
- def _next_from_native(self):
+ def _bt_next_from_native(self):
# this can raise anything: it's catched by the native part
try:
msg = next(self)
# this can raise anything: it's catched by the native part
try:
msg = next(self)
return int(msg._ptr)
@property
return int(msg._ptr)
@property
- def _can_seek_beginning_from_native(self):
+ def _bt_can_seek_beginning_from_native(self):
# Here, we mimic the behavior of the C API:
#
# - If the iterator has a _can_seek_beginning attribute, read it and use
# Here, we mimic the behavior of the C API:
#
# - If the iterator has a _can_seek_beginning attribute, read it and use
else:
return hasattr(self, '_seek_beginning')
else:
return hasattr(self, '_seek_beginning')
- def _seek_beginning_from_native(self):
+ def _bt_seek_beginning_from_native(self):
self._seek_beginning()
def _create_event_message(self, event_class, packet, default_clock_snapshot=None):
self._seek_beginning()
def _create_event_message(self, event_class, packet, default_clock_snapshot=None):
utils._check_uint64(default_clock_snapshot)
ptr = native_bt.message_event_create_with_default_clock_snapshot(
utils._check_uint64(default_clock_snapshot)
ptr = native_bt.message_event_create_with_default_clock_snapshot(
- self._ptr, event_class._ptr, packet._ptr, default_clock_snapshot)
+ self._bt_ptr, event_class._ptr, packet._ptr, default_clock_snapshot)
else:
if event_class.stream_class.default_clock_class is not None:
raise ValueError('event messages in this stream must have a default clock snapshot')
ptr = native_bt.message_event_create(
else:
if event_class.stream_class.default_clock_class is not None:
raise ValueError('event messages in this stream must have a default clock snapshot')
ptr = native_bt.message_event_create(
- self._ptr, event_class._ptr, packet._ptr)
+ self._bt_ptr, event_class._ptr, packet._ptr)
if ptr is None:
raise bt2.CreationError('cannot create event message object')
if ptr is None:
raise bt2.CreationError('cannot create event message object')
def _create_message_iterator_inactivity_message(self, clock_class, clock_snapshot):
utils._check_type(clock_class, bt2.clock_class._ClockClass)
ptr = native_bt.message_message_iterator_inactivity_create(
def _create_message_iterator_inactivity_message(self, clock_class, clock_snapshot):
utils._check_type(clock_class, bt2.clock_class._ClockClass)
ptr = native_bt.message_message_iterator_inactivity_create(
- self._ptr, clock_class._ptr, clock_snapshot)
+ self._bt_ptr, clock_class._ptr, clock_snapshot)
if ptr is None:
raise bt2.CreationError('cannot create inactivity message object')
if ptr is None:
raise bt2.CreationError('cannot create inactivity message object')
_infinite_clock_snapshot = bt2.message._StreamActivityMessageInfiniteClockSnapshot()
@staticmethod
_infinite_clock_snapshot = bt2.message._StreamActivityMessageInfiniteClockSnapshot()
@staticmethod
- def _validate_stream_activity_message_default_clock_snapshot(stream, default_cs):
+ def _bt_validate_stream_activity_message_default_clock_snapshot(stream, default_cs):
isinst_infinite = isinstance(default_cs, bt2.message._StreamActivityMessageInfiniteClockSnapshot)
isinst_unknown = isinstance(default_cs, bt2.message._StreamActivityMessageUnknownClockSnapshot)
isinst_infinite = isinstance(default_cs, bt2.message._StreamActivityMessageInfiniteClockSnapshot)
isinst_unknown = isinstance(default_cs, bt2.message._StreamActivityMessageUnknownClockSnapshot)
def _create_stream_beginning_message(self, stream):
utils._check_type(stream, bt2.stream._Stream)
def _create_stream_beginning_message(self, stream):
utils._check_type(stream, bt2.stream._Stream)
- ptr = native_bt.message_stream_beginning_create(self._ptr, stream._ptr)
+ ptr = native_bt.message_stream_beginning_create(self._bt_ptr, stream._ptr)
if ptr is None:
raise bt2.CreationError('cannot create stream beginning message object')
if ptr is None:
raise bt2.CreationError('cannot create stream beginning message object')
def _create_stream_activity_beginning_message(self, stream,
default_clock_snapshot=_unknown_clock_snapshot):
utils._check_type(stream, bt2.stream._Stream)
def _create_stream_activity_beginning_message(self, stream,
default_clock_snapshot=_unknown_clock_snapshot):
utils._check_type(stream, bt2.stream._Stream)
- self._validate_stream_activity_message_default_clock_snapshot(stream, default_clock_snapshot)
- ptr = native_bt.message_stream_activity_beginning_create(self._ptr, stream._ptr)
+ self._bt_validate_stream_activity_message_default_clock_snapshot(stream, default_clock_snapshot)
+ ptr = native_bt.message_stream_activity_beginning_create(self._bt_ptr, stream._ptr)
if ptr is None:
raise bt2.CreationError(
if ptr is None:
raise bt2.CreationError(
def _create_stream_activity_end_message(self, stream,
default_clock_snapshot=_unknown_clock_snapshot):
utils._check_type(stream, bt2.stream._Stream)
def _create_stream_activity_end_message(self, stream,
default_clock_snapshot=_unknown_clock_snapshot):
utils._check_type(stream, bt2.stream._Stream)
- self._validate_stream_activity_message_default_clock_snapshot(stream, default_clock_snapshot)
- ptr = native_bt.message_stream_activity_end_create(self._ptr, stream._ptr)
+ self._bt_validate_stream_activity_message_default_clock_snapshot(stream, default_clock_snapshot)
+ ptr = native_bt.message_stream_activity_end_create(self._bt_ptr, stream._ptr)
if ptr is None:
raise bt2.CreationError(
if ptr is None:
raise bt2.CreationError(
def _create_stream_end_message(self, stream):
utils._check_type(stream, bt2.stream._Stream)
def _create_stream_end_message(self, stream):
utils._check_type(stream, bt2.stream._Stream)
- ptr = native_bt.message_stream_end_create(self._ptr, stream._ptr)
+ ptr = native_bt.message_stream_end_create(self._bt_ptr, stream._ptr)
if ptr is None:
raise bt2.CreationError('cannot create stream end message object')
if ptr is None:
raise bt2.CreationError('cannot create stream end message object')
utils._check_uint64(default_clock_snapshot)
ptr = native_bt.message_packet_beginning_create_with_default_clock_snapshot(
utils._check_uint64(default_clock_snapshot)
ptr = native_bt.message_packet_beginning_create_with_default_clock_snapshot(
- self._ptr, packet._ptr, default_clock_snapshot)
+ self._bt_ptr, packet._ptr, default_clock_snapshot)
else:
if default_clock_snapshot is not None:
raise ValueError("packet beginning messages in this stream must not have a default clock snapshot")
else:
if default_clock_snapshot is not None:
raise ValueError("packet beginning messages in this stream must not have a default clock snapshot")
- ptr = native_bt.message_packet_beginning_create(self._ptr, packet._ptr)
+ ptr = native_bt.message_packet_beginning_create(self._bt_ptr, packet._ptr)
if ptr is None:
raise bt2.CreationError('cannot create packet beginning message object')
if ptr is None:
raise bt2.CreationError('cannot create packet beginning message object')
utils._check_uint64(default_clock_snapshot)
ptr = native_bt.message_packet_end_create_with_default_clock_snapshot(
utils._check_uint64(default_clock_snapshot)
ptr = native_bt.message_packet_end_create_with_default_clock_snapshot(
- self._ptr, packet._ptr, default_clock_snapshot)
+ self._bt_ptr, packet._ptr, default_clock_snapshot)
else:
if default_clock_snapshot is not None:
raise ValueError("packet end messages in this stream must not have a default clock snapshot")
else:
if default_clock_snapshot is not None:
raise ValueError("packet end messages in this stream must not have a default clock snapshot")
- ptr = native_bt.message_packet_end_create(self._ptr, packet._ptr)
+ ptr = native_bt.message_packet_end_create(self._bt_ptr, packet._ptr)
if ptr is None:
raise bt2.CreationError('cannot create packet end message object')
if ptr is None:
raise bt2.CreationError('cannot create packet end message object')
utils._check_uint64(beg_clock_snapshot)
utils._check_uint64(end_clock_snapshot)
ptr = native_bt.message_discarded_events_create_with_default_clock_snapshots(
utils._check_uint64(beg_clock_snapshot)
utils._check_uint64(end_clock_snapshot)
ptr = native_bt.message_discarded_events_create_with_default_clock_snapshots(
- self._ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot)
+ self._bt_ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot)
else:
if beg_clock_snapshot is not None or end_clock_snapshot is not None:
raise ValueError('discarded events have no default clock snapshots for this stream class')
ptr = native_bt.message_discarded_events_create(
else:
if beg_clock_snapshot is not None or end_clock_snapshot is not None:
raise ValueError('discarded events have no default clock snapshots for this stream class')
ptr = native_bt.message_discarded_events_create(
- self._ptr, stream._ptr)
+ self._bt_ptr, stream._ptr)
if ptr is None:
raise bt2.CreationError('cannot discarded events message object')
if ptr is None:
raise bt2.CreationError('cannot discarded events message object')
utils._check_uint64(beg_clock_snapshot)
utils._check_uint64(end_clock_snapshot)
ptr = native_bt.message_discarded_packets_create_with_default_clock_snapshots(
utils._check_uint64(beg_clock_snapshot)
utils._check_uint64(end_clock_snapshot)
ptr = native_bt.message_discarded_packets_create_with_default_clock_snapshots(
- self._ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot)
+ self._bt_ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot)
else:
if beg_clock_snapshot is not None or end_clock_snapshot is not None:
raise ValueError('discarded packets have no default clock snapshots for this stream class')
ptr = native_bt.message_discarded_packets_create(
else:
if beg_clock_snapshot is not None or end_clock_snapshot is not None:
raise ValueError('discarded packets have no default clock snapshots for this stream class')
ptr = native_bt.message_discarded_packets_create(
- self._ptr, stream._ptr)
+ self._bt_ptr, stream._ptr)
if ptr is None:
raise bt2.CreationError('cannot discarded packets message object')
if ptr is None:
raise bt2.CreationError('cannot discarded packets message object')
/*
* Do the equivalent of this:
*
/*
* Do the equivalent of this:
*
- * py_comp = py_cls._init_from_native(py_comp_ptr, py_params_ptr)
+ * py_comp = py_cls._bt_init_from_native(py_comp_ptr, py_params_ptr)
- * _UserComponentType._init_from_native() calls the Python
+ * _UserComponentType._bt_init_from_native() calls the Python
* component object's __init__() function.
*/
py_comp = PyObject_CallMethod(py_cls,
* component object's __init__() function.
*/
py_comp = PyObject_CallMethod(py_cls,
- "_init_from_native", "(OO)", py_comp_ptr, py_params_ptr);
+ "_bt_init_from_native", "(OO)", py_comp_ptr, py_params_ptr);
- BT_LOGW("Failed to call Python class's _init_from_native() method: "
+ BT_LOGW("Failed to call Python class's _bt_init_from_native() method: "
"py-cls-addr=%p", py_cls);
logw_exception();
goto error;
"py-cls-addr=%p", py_cls);
logw_exception();
goto error;
py_iter = bt_self_message_iterator_get_data(self_message_iterator);
BT_ASSERT(py_iter);
py_iter = bt_self_message_iterator_get_data(self_message_iterator);
BT_ASSERT(py_iter);
- py_result = PyObject_GetAttrString(py_iter, "_can_seek_beginning_from_native");
+ py_result = PyObject_GetAttrString(py_iter, "_bt_can_seek_beginning_from_native");
BT_ASSERT(!py_result || PyBool_Check(py_result));
BT_ASSERT(!py_result || PyBool_Check(py_result));
py_iter = bt_self_message_iterator_get_data(self_message_iterator);
BT_ASSERT(py_iter);
py_iter = bt_self_message_iterator_get_data(self_message_iterator);
BT_ASSERT(py_iter);
- py_result = PyObject_CallMethod(py_iter, "_seek_beginning_from_native",
+ py_result = PyObject_CallMethod(py_iter, "_bt_seek_beginning_from_native",
NULL);
BT_ASSERT(!py_result || py_result == Py_None);
status = py_exc_to_status();
NULL);
BT_ASSERT(!py_result || py_result == Py_None);
status = py_exc_to_status();
goto end; }
py_method_result = PyObject_CallMethod(py_comp,
goto end; }
py_method_result = PyObject_CallMethod(py_comp,
- "_port_connected_from_native", "(OiO)", py_self_port_ptr,
+ "_bt_port_connected_from_native", "(OiO)", py_self_port_ptr,
self_component_port_type, py_other_port_ptr);
BT_ASSERT(!py_method_result || py_method_result == Py_None);
status = py_exc_to_status();
self_component_port_type, py_other_port_ptr);
BT_ASSERT(!py_method_result || py_method_result == Py_None);
status = py_exc_to_status();
py_comp = bt_self_component_get_data(self_component);
py_method_result = PyObject_CallMethod(py_comp,
py_comp = bt_self_component_get_data(self_component);
py_method_result = PyObject_CallMethod(py_comp,
- "_graph_is_configured_from_native", NULL);
+ "_bt_graph_is_configured_from_native", NULL);
BT_ASSERT(!py_method_result || py_method_result == Py_None);
status = py_exc_to_status();
Py_XDECREF(py_method_result);
BT_ASSERT(!py_method_result || py_method_result == Py_None);
status = py_exc_to_status();
Py_XDECREF(py_method_result);
}
py_results_addr = PyObject_CallMethod(py_cls,
}
py_results_addr = PyObject_CallMethod(py_cls,
- "_query_from_native", "(OOOi)", py_query_exec_ptr,
+ "_bt_query_from_native", "(OOOi)", py_query_exec_ptr,
py_object, py_params_ptr, (int) log_level);
if (!py_results_addr) {
py_object, py_params_ptr, (int) log_level);
if (!py_results_addr) {
- BT_LOGW("Failed to call Python class's _query_from_native() method: "
+ BT_LOGW("Failed to call Python class's _bt_query_from_native() method: "
"py-cls-addr=%p", py_cls);
status = py_exc_to_status();
goto end;
"py-cls-addr=%p", py_cls);
status = py_exc_to_status();
goto end;
}
py_init_method_result = PyObject_CallMethod(py_iter,
}
py_init_method_result = PyObject_CallMethod(py_iter,
- "_init_from_native", "O", py_component_port_output_ptr);
+ "_bt_init_from_native", "O", py_component_port_output_ptr);
if (!py_init_method_result) {
BT_LOGW_STR("User's __init__() method failed:");
logw_exception();
if (!py_init_method_result) {
BT_LOGW_STR("User's __init__() method failed:");
logw_exception();
BT_ASSERT(py_message_iter);
py_method_result = PyObject_CallMethod(py_message_iter,
BT_ASSERT(py_message_iter);
py_method_result = PyObject_CallMethod(py_message_iter,
- "_next_from_native", NULL);
+ "_bt_next_from_native", NULL);
if (!py_method_result) {
status = py_exc_to_status();
BT_ASSERT(status != __BT_FUNC_STATUS_OK);
if (!py_method_result) {
status = py_exc_to_status();
BT_ASSERT(status != __BT_FUNC_STATUS_OK);
comp_cls_type = self._plugin_comp_cls._comp_cls_type
comp_cls_pycls = bt2.component._COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS[comp_cls_type]
comp_cls_type = self._plugin_comp_cls._comp_cls_type
comp_cls_pycls = bt2.component._COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS[comp_cls_type]
- comp_cls_ptr = comp_cls_pycls._as_component_class_ptr(comp_cls_ptr)
+ comp_cls_ptr = comp_cls_pycls._bt_as_component_class_ptr(comp_cls_ptr)
name = native_bt.component_class_get_name(comp_cls_ptr)
assert name is not None
return name
name = native_bt.component_class_get_name(comp_cls_ptr)
assert name is not None
return name
params_ptr = params._ptr
utils._check_log_level(logging_level)
params_ptr = params._ptr
utils._check_log_level(logging_level)
- cc_ptr = component_class._component_class_ptr()
+ cc_ptr = component_class._bt_component_class_ptr()
status, result_ptr = native_bt.query_executor_query(self._ptr, cc_ptr,
object, params_ptr,
status, result_ptr = native_bt.query_executor_query(self._ptr, cc_ptr,
object, params_ptr,