1 # SPDX-License-Identifier: MIT
3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
5 from bt2
import native_bt
, object, utils
6 from bt2
import message_iterator
as bt2_message_iterator
8 from bt2
import value
as bt2_value
9 from bt2
import trace_class
as bt2_trace_class
10 from bt2
import clock_class
as bt2_clock_class
11 from bt2
import query_executor
as bt2_query_executor
12 from bt2
import port
as bt2_port
17 # This class wraps a component class pointer. This component class could
18 # have been created by Python code, but since we only have the pointer,
19 # we can only wrap it in a generic way and lose the original Python
22 # Subclasses must implement some methods that this base class uses:
24 # - _bt_as_component_class_ptr: static method, convert the passed component class
25 # pointer to a 'bt_component_class *'.
28 class _ComponentClassConst(object._SharedObject
):
31 ptr
= self
._bt
_as
_component
_class
_ptr
(self
._ptr
)
32 name
= native_bt
.component_class_get_name(ptr
)
33 assert name
is not None
37 def description(self
):
38 ptr
= self
._bt
_as
_component
_class
_ptr
(self
._ptr
)
39 return native_bt
.component_class_get_description(ptr
)
43 ptr
= self
._bt
_as
_component
_class
_ptr
(self
._ptr
)
44 return native_bt
.component_class_get_help(ptr
)
46 def _bt_component_class_ptr(self
):
47 return self
._bt
_as
_component
_class
_ptr
(self
._ptr
)
49 def __eq__(self
, other
):
50 if not isinstance(other
, _ComponentClassConst
):
52 if not issubclass(other
, _UserComponent
):
57 return self
.addr
== other
.addr
60 class _SourceComponentClassConst(_ComponentClassConst
):
63 native_bt
.component_class_source_get_ref(ptr
)
67 native_bt
.component_class_source_put_ref(ptr
)
69 _bt_as_component_class_ptr
= staticmethod(
70 native_bt
.component_class_source_as_component_class
74 class _FilterComponentClassConst(_ComponentClassConst
):
77 native_bt
.component_class_filter_get_ref(ptr
)
81 native_bt
.component_class_filter_put_ref(ptr
)
83 _bt_as_component_class_ptr
= staticmethod(
84 native_bt
.component_class_filter_as_component_class
88 class _SinkComponentClassConst(_ComponentClassConst
):
91 native_bt
.component_class_sink_get_ref(ptr
)
95 native_bt
.component_class_sink_put_ref(ptr
)
97 _bt_as_component_class_ptr
= staticmethod(
98 native_bt
.component_class_sink_as_component_class
102 class _PortIterator(collections
.abc
.Iterator
):
103 def __init__(self
, comp_ports
):
104 self
._comp
_ports
= comp_ports
108 if self
._at
== len(self
._comp
_ports
):
111 comp_ports
= self
._comp
_ports
112 comp_ptr
= comp_ports
._component
_ptr
114 port_ptr
= comp_ports
._borrow
_port
_ptr
_at
_index
(comp_ptr
, self
._at
)
115 assert port_ptr
is not None
117 name
= native_bt
.port_get_name(comp_ports
._port
_pycls
._as
_port
_ptr
(port_ptr
))
118 assert name
is not None
124 class _ComponentPorts(collections
.abc
.Mapping
):
126 # component_ptr is a bt_component_source *, bt_component_filter * or
127 # bt_component_sink *. Its type must match the type expected by the
128 # functions passed as arguments.
133 borrow_port_ptr_by_name
,
134 borrow_port_ptr_at_index
,
138 self
._component
_ptr
= component_ptr
139 self
._borrow
_port
_ptr
_by
_name
= borrow_port_ptr_by_name
140 self
._borrow
_port
_ptr
_at
_index
= borrow_port_ptr_at_index
141 self
._get
_port
_count
= get_port_count
142 self
._port
_pycls
= port_pycls
144 def __getitem__(self
, key
):
145 utils
._check
_str
(key
)
146 port_ptr
= self
._borrow
_port
_ptr
_by
_name
(self
._component
_ptr
, key
)
151 return self
._port
_pycls
._create
_from
_ptr
_and
_get
_ref
(port_ptr
)
154 count
= self
._get
_port
_count
(self
._component
_ptr
)
159 return _PortIterator(self
)
162 # This class holds the methods which are common to both generic
163 # component objects and Python user component objects.
165 # Subclasses must provide these methods or property:
167 # - _bt_borrow_component_class_ptr: static method, must return a pointer to the
168 # specialized component class (e.g. 'bt_component_class_sink *') of the
169 # passed specialized component pointer (e.g. 'bt_component_sink *').
170 # - _bt_comp_cls_type: property, one of the native_bt.COMPONENT_CLASS_TYPE_*
172 # - _bt_as_component_ptr: static method, must return the passed specialized
173 # component pointer (e.g. 'bt_component_sink *') as a 'bt_component *'.
176 class _ComponentConst
:
179 ptr
= self
._bt
_as
_component
_ptr
(self
._ptr
)
180 name
= native_bt
.component_get_name(ptr
)
181 assert name
is not None
185 def logging_level(self
):
186 ptr
= self
._bt
_as
_component
_ptr
(self
._ptr
)
187 return native_bt
.component_get_logging_level(ptr
)
191 cc_ptr
= self
._bt
_borrow
_component
_class
_ptr
(self
._ptr
)
192 assert cc_ptr
is not None
193 return _create_component_class_from_const_ptr_and_get_ref(
194 cc_ptr
, self
._bt
_comp
_cls
_type
197 def __eq__(self
, other
):
198 if not hasattr(other
, "addr"):
201 return self
.addr
== other
.addr
204 class _SourceComponentConst(_ComponentConst
):
205 _bt_borrow_component_class_ptr
= staticmethod(
206 native_bt
.component_source_borrow_class_const
208 _bt_comp_cls_type
= native_bt
.COMPONENT_CLASS_TYPE_SOURCE
209 _bt_as_component_class_ptr
= staticmethod(
210 native_bt
.component_class_source_as_component_class
212 _bt_as_component_ptr
= staticmethod(native_bt
.component_source_as_component_const
)
215 class _FilterComponentConst(_ComponentConst
):
216 _bt_borrow_component_class_ptr
= staticmethod(
217 native_bt
.component_filter_borrow_class_const
219 _bt_comp_cls_type
= native_bt
.COMPONENT_CLASS_TYPE_FILTER
220 _bt_as_component_class_ptr
= staticmethod(
221 native_bt
.component_class_filter_as_component_class
223 _bt_as_component_ptr
= staticmethod(native_bt
.component_filter_as_component_const
)
226 class _SinkComponentConst(_ComponentConst
):
227 _bt_borrow_component_class_ptr
= staticmethod(
228 native_bt
.component_sink_borrow_class_const
230 _bt_comp_cls_type
= native_bt
.COMPONENT_CLASS_TYPE_SINK
231 _bt_as_component_class_ptr
= staticmethod(
232 native_bt
.component_class_sink_as_component_class
234 _bt_as_component_ptr
= staticmethod(native_bt
.component_sink_as_component_const
)
237 # This is analogous to _SourceComponentClassConst, but for source
239 class _GenericSourceComponentConst(object._SharedObject
, _SourceComponentConst
):
242 native_bt
.component_source_get_ref(ptr
)
246 native_bt
.component_source_put_ref(ptr
)
249 def output_ports(self
):
250 return _ComponentPorts(
252 native_bt
.component_source_borrow_output_port_by_name_const
,
253 native_bt
.component_source_borrow_output_port_by_index_const
,
254 native_bt
.component_source_get_output_port_count
,
255 bt2_port
._OutputPortConst
,
259 # This is analogous to _FilterComponentClassConst, but for filter
261 class _GenericFilterComponentConst(object._SharedObject
, _FilterComponentConst
):
264 native_bt
.component_filter_get_ref(ptr
)
268 native_bt
.component_filter_put_ref(ptr
)
271 def output_ports(self
):
272 return _ComponentPorts(
274 native_bt
.component_filter_borrow_output_port_by_name_const
,
275 native_bt
.component_filter_borrow_output_port_by_index_const
,
276 native_bt
.component_filter_get_output_port_count
,
277 bt2_port
._OutputPortConst
,
281 def input_ports(self
):
282 return _ComponentPorts(
284 native_bt
.component_filter_borrow_input_port_by_name_const
,
285 native_bt
.component_filter_borrow_input_port_by_index_const
,
286 native_bt
.component_filter_get_input_port_count
,
287 bt2_port
._InputPortConst
,
291 # This is analogous to _SinkComponentClassConst, but for sink
293 class _GenericSinkComponentConst(object._SharedObject
, _SinkComponentConst
):
296 native_bt
.component_sink_get_ref(ptr
)
300 native_bt
.component_sink_put_ref(ptr
)
303 def input_ports(self
):
304 return _ComponentPorts(
306 native_bt
.component_sink_borrow_input_port_by_name_const
,
307 native_bt
.component_sink_borrow_input_port_by_index_const
,
308 native_bt
.component_sink_get_input_port_count
,
309 bt2_port
._InputPortConst
,
313 _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS
= {
314 native_bt
.COMPONENT_CLASS_TYPE_SOURCE
: _GenericSourceComponentConst
,
315 native_bt
.COMPONENT_CLASS_TYPE_FILTER
: _GenericFilterComponentConst
,
316 native_bt
.COMPONENT_CLASS_TYPE_SINK
: _GenericSinkComponentConst
,
320 _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS
= {
321 native_bt
.COMPONENT_CLASS_TYPE_SOURCE
: _SourceComponentClassConst
,
322 native_bt
.COMPONENT_CLASS_TYPE_FILTER
: _FilterComponentClassConst
,
323 native_bt
.COMPONENT_CLASS_TYPE_SINK
: _SinkComponentClassConst
,
327 # Create a component Python object of type _GenericSourceComponentConst,
328 # _GenericFilterComponentConst or _GenericSinkComponentConst, depending on
331 # Steals the reference to ptr from the caller.
334 def _create_component_from_const_ptr(ptr
, comp_cls_type
):
335 return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS
[comp_cls_type
]._create
_from
_ptr
(ptr
)
338 # Same as the above, but acquire a new reference instead of stealing the
339 # reference from the caller.
342 def _create_component_from_const_ptr_and_get_ref(ptr
, comp_cls_type
):
343 return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS
[
345 ]._create
_from
_ptr
_and
_get
_ref
(ptr
)
348 # Create a component class Python object of type
349 # _SourceComponentClassConst, _FilterComponentClassConst or
350 # _SinkComponentClassConst, depending on comp_cls_type.
352 # Acquires a new reference to ptr.
355 def _create_component_class_from_const_ptr_and_get_ref(ptr
, comp_cls_type
):
356 return _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS
[
358 ]._create
_from
_ptr
_and
_get
_ref
(ptr
)
361 def _trim_docstring(docstring
):
362 lines
= docstring
.expandtabs().splitlines()
370 for line
in lines
[1:]:
371 stripped
= line
.lstrip()
374 indent
= min(indent
, len(line
) - len(stripped
))
376 trimmed
= [lines
[0].strip()]
378 if indent
< sys
.maxsize
and len(lines
) > 1:
379 for line
in lines
[1:]:
380 trimmed
.append(line
[indent
:].rstrip())
382 while trimmed
and not trimmed
[-1]:
385 while trimmed
and not trimmed
[0]:
388 return "\n".join(trimmed
)
391 # Metaclass for component classes defined by Python code.
393 # The Python user can create a standard Python class which inherits one
394 # of the three base classes (_UserSourceComponent, _UserFilterComponent,
395 # or _UserSinkComponent). Those base classes set this class
396 # (_UserComponentType) as their metaclass.
398 # Once the body of a user-defined component class is executed, this
399 # metaclass is used to create and initialize the class. The metaclass
400 # creates a native BT component class of the corresponding type and
401 # associates it with this user-defined class. The metaclass also defines
402 # class methods like the `name` and `description` properties to match
403 # the _ComponentClassConst interface.
405 # The component class name which is used is either:
407 # * The `name` parameter of the class:
409 # class MySink(bt2.SinkComponent, name='my-custom-sink'):
412 # * If the `name` class parameter is not used: the name of the class
413 # itself (`MySink` in the example above).
415 # The component class description which is used is the user-defined
418 # class MySink(bt2.SinkComponent):
419 # 'Description goes here'
422 # A user-defined Python component class can have an __init__() method
423 # which must accept the following parameters:
425 # def __init__(self, config, params, obj):
428 # The value of the `obj` parameter is what was passed as the `obj`
429 # parameter if the component was instantiated from Python with
430 # Graph.add_component(). If the component was not instantiated from
431 # Python, is is always `None`.
433 # The user-defined component class can also have a _user_finalize()
434 # method (do NOT use __del__()) to be notified when the component object
437 # User-defined source and filter component classes must use the
438 # `message_iterator_class` class parameter to specify the
439 # message iterator class to use for this component class:
441 # class MyMessageIterator(bt2._UserMessageIterator):
444 # class MySource(bt2._UserSourceComponent,
445 # message_iterator_class=MyMessageIterator):
448 # This message iterator class must inherit bt2._UserMessageIterator.
449 # It can implement the __init__() method, which must accept the
450 # following parameters:
452 # def __init__(self, config, port):
455 # It can also implement the __next__() and _user_finalize() methods
456 # (again, do NOT use __del__()), which don't accept any parameters
459 # When the user-defined class is destroyed, this metaclass's __del__()
460 # method is called: the native BT component class pointer is put (not
461 # needed anymore, at least not by any Python code since all references
462 # are dropped for __del__() to be called).
463 class _UserComponentType(type):
464 # __new__() is used to catch custom class parameters
465 def __new__(meta_cls
, class_name
, bases
, attrs
, **kwargs
):
466 return super().__new
__(meta_cls
, class_name
, bases
, attrs
)
468 def __init__(cls
, class_name
, bases
, namespace
, **kwargs
):
469 super().__init
__(class_name
, bases
, namespace
)
471 # skip our own bases; they are never directly instantiated by the user
474 "_UserFilterSinkComponent",
475 "_UserSourceComponent",
476 "_UserFilterComponent",
477 "_UserSinkComponent",
480 if class_name
in own_bases
:
483 comp_cls_name
= kwargs
.get("name", class_name
)
484 utils
._check
_str
(comp_cls_name
)
485 comp_cls_descr
= None
488 if hasattr(cls
, "__doc__") and cls
.__doc
__ is not None:
489 utils
._check
_str
(cls
.__doc
__)
490 docstring
= _trim_docstring(cls
.__doc
__)
491 lines
= docstring
.splitlines()
494 comp_cls_descr
= lines
[0]
497 comp_cls_help
= "\n".join(lines
[2:])
499 iter_cls
= kwargs
.get("message_iterator_class")
501 if _UserSourceComponent
in bases
:
502 _UserComponentType
._bt
_set
_iterator
_class
(cls
, iter_cls
)
503 cc_ptr
= native_bt
.bt2_component_class_source_create(
504 cls
, comp_cls_name
, comp_cls_descr
, comp_cls_help
506 elif _UserFilterComponent
in bases
:
507 _UserComponentType
._bt
_set
_iterator
_class
(cls
, iter_cls
)
508 cc_ptr
= native_bt
.bt2_component_class_filter_create(
509 cls
, comp_cls_name
, comp_cls_descr
, comp_cls_help
511 elif _UserSinkComponent
in bases
:
512 if not hasattr(cls
, "_user_consume"):
513 raise bt2
._IncompleteUserClass(
514 "cannot create component class '{}': missing a _user_consume() method".format(
519 cc_ptr
= native_bt
.bt2_component_class_sink_create(
520 cls
, comp_cls_name
, comp_cls_descr
, comp_cls_help
523 raise bt2
._IncompleteUserClass(
524 "cannot find a known component class base in the bases of '{}'".format(
530 raise bt2
._MemoryError(
531 "cannot create component class '{}'".format(class_name
)
534 cls
._bt
_cc
_ptr
= cc_ptr
536 def _bt_init_from_native(cls
, comp_ptr
, params_ptr
, obj
):
537 # create instance, not user-initialized yet
538 self
= cls
.__new
__(cls
)
541 config
= cls
._config
_pycls
()
543 # pointer to native self component object (weak/borrowed)
544 self
._bt
_ptr
= comp_ptr
546 # call user's __init__() method
547 if params_ptr
is not None:
548 params
= bt2_value
._create
_from
_const
_ptr
_and
_get
_ref
(params_ptr
)
552 self
.__init
__(config
, params
, obj
)
555 def __call__(cls
, *args
, **kwargs
):
557 "cannot directly instantiate a user component from a Python module"
561 def _bt_set_iterator_class(cls
, iter_cls
):
563 raise bt2
._IncompleteUserClass(
564 "cannot create component class '{}': missing message iterator class".format(
569 if not issubclass(iter_cls
, bt2_message_iterator
._UserMessageIterator
):
570 raise bt2
._IncompleteUserClass(
571 "cannot create component class '{}': message iterator class does not inherit bt2._UserMessageIterator".format(
576 if not hasattr(iter_cls
, "__next__"):
577 raise bt2
._IncompleteUserClass(
578 "cannot create component class '{}': message iterator class is missing a __next__() method".format(
583 if hasattr(iter_cls
, "_user_can_seek_ns_from_origin") and not hasattr(
584 iter_cls
, "_user_seek_ns_from_origin"
586 raise bt2
._IncompleteUserClass(
587 "cannot create component class '{}': message iterator class implements _user_can_seek_ns_from_origin but not _user_seek_ns_from_origin".format(
592 if hasattr(iter_cls
, "_user_can_seek_beginning") and not hasattr(
593 iter_cls
, "_user_seek_beginning"
595 raise bt2
._IncompleteUserClass(
596 "cannot create component class '{}': message iterator class implements _user_can_seek_beginning but not _user_seek_beginning".format(
601 cls
._iter
_cls
= iter_cls
605 ptr
= cls
._bt
_as
_component
_class
_ptr
(cls
._bt
_cc
_ptr
)
606 return native_bt
.component_class_get_name(ptr
)
609 def description(cls
):
610 ptr
= cls
._bt
_as
_component
_class
_ptr
(cls
._bt
_cc
_ptr
)
611 return native_bt
.component_class_get_description(ptr
)
615 ptr
= cls
._bt
_as
_component
_class
_ptr
(cls
._bt
_cc
_ptr
)
616 return native_bt
.component_class_get_help(ptr
)
620 return int(cls
._bt
_cc
_ptr
)
622 def _bt_get_supported_mip_versions_from_native(cls
, params_ptr
, obj
, log_level
):
623 # this can raise, but the native side checks the exception
624 if params_ptr
is not None:
625 params
= bt2_value
._create
_from
_const
_ptr
_and
_get
_ref
(params_ptr
)
629 # this can raise, but the native side checks the exception
630 range_set
= cls
._user
_get
_supported
_mip
_versions
(params
, obj
, log_level
)
632 if type(range_set
) is not bt2
.UnsignedIntegerRangeSet
:
633 # this can raise, but the native side checks the exception
634 range_set
= bt2
.UnsignedIntegerRangeSet(range_set
)
636 # return new reference
637 range_set
._get
_ref
(range_set
._ptr
)
638 return int(range_set
._ptr
)
640 def _user_get_supported_mip_versions(cls
, params
, obj
, log_level
):
643 def _bt_query_from_native(
644 cls
, priv_query_exec_ptr
, object_name
, params_ptr
, method_obj
646 # this can raise, but the native side checks the exception
647 if params_ptr
is not None:
648 params
= bt2_value
._create
_from
_const
_ptr
_and
_get
_ref
(params_ptr
)
652 priv_query_exec
= bt2_query_executor
._PrivateQueryExecutor
(priv_query_exec_ptr
)
655 # this can raise, but the native side checks the exception
656 results
= cls
._user
_query
(priv_query_exec
, object_name
, params
, method_obj
)
658 # the private query executor is a private view on the query
659 # executor; it's not a shared object (the library does not
660 # offer an API to get/put a reference, just like "self"
661 # objects) from this query's point of view, so invalidate
662 # the object in case the user kept a reference and uses it
664 priv_query_exec
._invalidate
()
666 # this can raise, but the native side checks the exception
667 results
= bt2
.create_value(results
)
670 results_ptr
= native_bt
.value_null
672 results_ptr
= results
._ptr
674 # return new reference
675 bt2_value
._Value
._get
_ref
(results_ptr
)
676 return int(results_ptr
)
678 def _user_query(cls
, priv_query_executor
, object_name
, params
, method_obj
):
679 raise bt2
.UnknownObject
681 def _bt_component_class_ptr(self
):
682 return self
._bt
_as
_component
_class
_ptr
(self
._bt
_cc
_ptr
)
685 if hasattr(cls
, "_bt_cc_ptr"):
686 cc_ptr
= cls
._bt
_as
_component
_class
_ptr
(cls
._bt
_cc
_ptr
)
687 native_bt
.component_class_put_ref(cc_ptr
)
688 native_bt
.bt2_unregister_cc_ptr_to_py_cls(cc_ptr
)
691 # Configuration objects for components.
693 # These are passed in __init__ to allow components to change some configuration
694 # parameters during initialization and not after. As you can see, they are not
695 # used at the moment, but are there in case we want to add such parameters.
698 class _UserComponentConfiguration
:
702 class _UserSourceComponentConfiguration(_UserComponentConfiguration
):
706 class _UserFilterComponentConfiguration(_UserComponentConfiguration
):
710 class _UserSinkComponentConfiguration(_UserComponentConfiguration
):
714 # Subclasses must provide these methods or property:
716 # - _bt_as_not_self_specific_component_ptr: static method, must return the passed
717 # specialized self component pointer (e.g. 'bt_self_component_sink *') as a
718 # specialized non-self pointer (e.g. 'bt_component_sink *').
719 # - _bt_borrow_component_class_ptr: static method, must return a pointer to the
720 # specialized component class (e.g. 'bt_component_class_sink *') of the
721 # passed specialized component pointer (e.g. 'bt_component_sink *').
722 # - _bt_comp_cls_type: property, one of the native_bt.COMPONENT_CLASS_TYPE_*
726 class _UserComponent(metaclass
=_UserComponentType
):
729 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self
._bt
_ptr
)
730 ptr
= self
._bt
_as
_component
_ptr
(ptr
)
731 name
= native_bt
.component_get_name(ptr
)
732 assert name
is not None
736 def logging_level(self
):
737 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self
._bt
_ptr
)
738 ptr
= self
._bt
_as
_component
_ptr
(ptr
)
739 return native_bt
.component_get_logging_level(ptr
)
743 comp_ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self
._bt
_ptr
)
744 cc_ptr
= self
._bt
_borrow
_component
_class
_ptr
(comp_ptr
)
745 return _create_component_class_from_const_ptr_and_get_ref(
746 cc_ptr
, self
._bt
_comp
_cls
_type
751 return int(self
._bt
_ptr
)
754 def _graph_mip_version(self
):
755 ptr
= self
._bt
_as
_self
_component
_ptr
(self
._bt
_ptr
)
756 return native_bt
.self_component_get_graph_mip_version(ptr
)
758 def __init__(self
, config
, params
, obj
):
761 def _user_finalize(self
):
764 def _user_port_connected(self
, port
, other_port
):
767 def _bt_port_connected_from_native(
768 self
, self_port_ptr
, self_port_type
, other_port_ptr
770 port
= bt2_port
._create
_self
_from
_ptr
_and
_get
_ref
(self_port_ptr
, self_port_type
)
772 if self_port_type
== native_bt
.PORT_TYPE_OUTPUT
:
773 other_port_type
= native_bt
.PORT_TYPE_INPUT
775 other_port_type
= native_bt
.PORT_TYPE_OUTPUT
777 other_port
= bt2_port
._create
_from
_const
_ptr
_and
_get
_ref
(
778 other_port_ptr
, other_port_type
780 self
._user
_port
_connected
(port
, other_port
)
782 def _create_trace_class(
783 self
, user_attributes
=None, assigns_automatic_stream_class_id
=True
785 ptr
= self
._bt
_as
_self
_component
_ptr
(self
._bt
_ptr
)
786 tc_ptr
= native_bt
.trace_class_create(ptr
)
789 raise bt2
._MemoryError("could not create trace class")
791 tc
= bt2_trace_class
._TraceClass
._create
_from
_ptr
(tc_ptr
)
792 tc
._assigns
_automatic
_stream
_class
_id
= assigns_automatic_stream_class_id
794 if user_attributes
is not None:
795 tc
._user
_attributes
= user_attributes
799 def _create_clock_class(
803 user_attributes
=None,
807 origin_is_unix_epoch
=True,
810 ptr
= self
._bt
_as
_self
_component
_ptr
(self
._bt
_ptr
)
811 cc_ptr
= native_bt
.clock_class_create(ptr
)
814 raise bt2
._MemoryError("could not create clock class")
816 cc
= bt2_clock_class
._ClockClass
._create
_from
_ptr
(cc_ptr
)
818 if frequency
is not None:
819 cc
._frequency
= frequency
824 if user_attributes
is not None:
825 cc
._user
_attributes
= user_attributes
827 if description
is not None:
828 cc
._description
= description
830 if precision
is not None:
831 cc
._precision
= precision
833 if offset
is not None:
836 cc
._origin
_is
_unix
_epoch
= origin_is_unix_epoch
844 class _UserSourceComponent(_UserComponent
, _SourceComponentConst
):
845 _bt_as_not_self_specific_component_ptr
= staticmethod(
846 native_bt
.self_component_source_as_component_source
848 _bt_as_self_component_ptr
= staticmethod(
849 native_bt
.self_component_source_as_self_component
851 _config_pycls
= _UserSourceComponentConfiguration
854 def _output_ports(self
):
855 def get_output_port_count(self_ptr
):
856 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self_ptr
)
857 return native_bt
.component_source_get_output_port_count(ptr
)
859 return _ComponentPorts(
861 native_bt
.self_component_source_borrow_output_port_by_name
,
862 native_bt
.self_component_source_borrow_output_port_by_index
,
863 get_output_port_count
,
864 bt2_port
._UserComponentOutputPort
,
867 def _add_output_port(self
, name
, user_data
=None):
868 utils
._check
_str
(name
)
870 if name
in self
._output
_ports
:
872 "source component `{}` already contains an output port named `{}`".format(
877 fn
= native_bt
.self_component_source_add_output_port
878 comp_status
, self_port_ptr
= fn(self
._bt
_ptr
, name
, user_data
)
879 utils
._handle
_func
_status
(
880 comp_status
, "cannot add output port to source component object"
882 assert self_port_ptr
is not None
883 return bt2_port
._UserComponentOutputPort
._create
_from
_ptr
_and
_get
_ref
(
888 class _UserFilterComponent(_UserComponent
, _FilterComponentConst
):
889 _bt_as_not_self_specific_component_ptr
= staticmethod(
890 native_bt
.self_component_filter_as_component_filter
892 _bt_as_self_component_ptr
= staticmethod(
893 native_bt
.self_component_filter_as_self_component
895 _config_pycls
= _UserFilterComponentConfiguration
898 def _output_ports(self
):
899 def get_output_port_count(self_ptr
):
900 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self_ptr
)
901 return native_bt
.component_filter_get_output_port_count(ptr
)
903 return _ComponentPorts(
905 native_bt
.self_component_filter_borrow_output_port_by_name
,
906 native_bt
.self_component_filter_borrow_output_port_by_index
,
907 get_output_port_count
,
908 bt2_port
._UserComponentOutputPort
,
912 def _input_ports(self
):
913 def get_input_port_count(self_ptr
):
914 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self_ptr
)
915 return native_bt
.component_filter_get_input_port_count(ptr
)
917 return _ComponentPorts(
919 native_bt
.self_component_filter_borrow_input_port_by_name
,
920 native_bt
.self_component_filter_borrow_input_port_by_index
,
921 get_input_port_count
,
922 bt2_port
._UserComponentInputPort
,
925 def _add_output_port(self
, name
, user_data
=None):
926 utils
._check
_str
(name
)
928 if name
in self
._output
_ports
:
930 "filter component `{}` already contains an output port named `{}`".format(
935 fn
= native_bt
.self_component_filter_add_output_port
936 comp_status
, self_port_ptr
= fn(self
._bt
_ptr
, name
, user_data
)
937 utils
._handle
_func
_status
(
938 comp_status
, "cannot add output port to filter component object"
941 return bt2_port
._UserComponentOutputPort
._create
_from
_ptr
_and
_get
_ref
(
945 def _add_input_port(self
, name
, user_data
=None):
946 utils
._check
_str
(name
)
948 if name
in self
._input
_ports
:
950 "filter component `{}` already contains an input port named `{}`".format(
955 fn
= native_bt
.self_component_filter_add_input_port
956 comp_status
, self_port_ptr
= fn(self
._bt
_ptr
, name
, user_data
)
957 utils
._handle
_func
_status
(
958 comp_status
, "cannot add input port to filter component object"
961 return bt2_port
._UserComponentInputPort
._create
_from
_ptr
_and
_get
_ref
(
966 class _UserSinkComponent(_UserComponent
, _SinkComponentConst
):
967 _bt_as_not_self_specific_component_ptr
= staticmethod(
968 native_bt
.self_component_sink_as_component_sink
970 _bt_as_self_component_ptr
= staticmethod(
971 native_bt
.self_component_sink_as_self_component
973 _config_pycls
= _UserSinkComponentConfiguration
975 def _bt_graph_is_configured_from_native(self
):
976 self
._user
_graph
_is
_configured
()
978 def _user_graph_is_configured(self
):
982 def _input_ports(self
):
983 def get_input_port_count(self_ptr
):
984 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self_ptr
)
985 return native_bt
.component_sink_get_input_port_count(ptr
)
987 return _ComponentPorts(
989 native_bt
.self_component_sink_borrow_input_port_by_name
,
990 native_bt
.self_component_sink_borrow_input_port_by_index
,
991 get_input_port_count
,
992 bt2_port
._UserComponentInputPort
,
995 def _add_input_port(self
, name
, user_data
=None):
996 utils
._check
_str
(name
)
998 if name
in self
._input
_ports
:
1000 "sink component `{}` already contains an input port named `{}`".format(
1005 fn
= native_bt
.self_component_sink_add_input_port
1006 comp_status
, self_port_ptr
= fn(self
._bt
_ptr
, name
, user_data
)
1007 utils
._handle
_func
_status
(
1008 comp_status
, "cannot add input port to sink component object"
1010 assert self_port_ptr
1011 return bt2_port
._UserComponentInputPort
._create
_from
_ptr
_and
_get
_ref
(
1015 def _create_message_iterator(self
, input_port
):
1016 utils
._check
_type
(input_port
, bt2_port
._UserComponentInputPort
)
1018 if not input_port
.is_connected
:
1019 raise ValueError("input port is not connected")
1024 ) = native_bt
.bt2_message_iterator_create_from_sink_component(
1025 self
._bt
_ptr
, input_port
._ptr
1027 utils
._handle
_func
_status
(status
, "cannot create message iterator object")
1028 assert msg_iter_ptr
is not None
1030 return bt2_message_iterator
._UserComponentInputPortMessageIterator
(msg_iter_ptr
)
1033 def _is_interrupted(self
):
1034 return bool(native_bt
.self_component_sink_is_interrupted(self
._bt
_ptr
))