1 # The MIT License (MIT)
3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
5 # Permission is hereby granted, free of charge, to any person obtaining a copy
6 # of this software and associated documentation files (the "Software"), to deal
7 # in the Software without restriction, including without limitation the rights
8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 # copies of the Software, and to permit persons to whom the Software is
10 # furnished to do so, subject to the following conditions:
12 # The above copyright notice and this permission notice shall be included in
13 # all copies or substantial portions of the Software.
15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 from bt2
import native_bt
, object, utils
24 from bt2
import message_iterator
as bt2_message_iterator
25 import collections
.abc
26 from bt2
import value
as bt2_value
27 from bt2
import trace_class
as bt2_trace_class
28 from bt2
import clock_class
as bt2_clock_class
29 from bt2
import query_executor
as bt2_query_executor
30 from bt2
import port
as bt2_port
35 # This class wraps a component class pointer. This component class could
36 # have been created by Python code, but since we only have the pointer,
37 # we can only wrap it in a generic way and lose the original Python
40 # Subclasses must implement some methods that this base class uses:
42 # - _bt_as_component_class_ptr: static method, convert the passed component class
43 # pointer to a 'bt_component_class *'.
46 class _ComponentClassConst(object._SharedObject
):
49 ptr
= self
._bt
_as
_component
_class
_ptr
(self
._ptr
)
50 name
= native_bt
.component_class_get_name(ptr
)
51 assert name
is not None
55 def description(self
):
56 ptr
= self
._bt
_as
_component
_class
_ptr
(self
._ptr
)
57 return native_bt
.component_class_get_description(ptr
)
61 ptr
= self
._bt
_as
_component
_class
_ptr
(self
._ptr
)
62 return native_bt
.component_class_get_help(ptr
)
64 def _bt_component_class_ptr(self
):
65 return self
._bt
_as
_component
_class
_ptr
(self
._ptr
)
67 def __eq__(self
, other
):
68 if not isinstance(other
, _ComponentClassConst
):
70 if not issubclass(other
, _UserComponent
):
75 return self
.addr
== other
.addr
78 class _SourceComponentClassConst(_ComponentClassConst
):
79 _get_ref
= staticmethod(native_bt
.component_class_source_get_ref
)
80 _put_ref
= staticmethod(native_bt
.component_class_source_put_ref
)
81 _bt_as_component_class_ptr
= staticmethod(
82 native_bt
.component_class_source_as_component_class
86 class _FilterComponentClassConst(_ComponentClassConst
):
87 _get_ref
= staticmethod(native_bt
.component_class_filter_get_ref
)
88 _put_ref
= staticmethod(native_bt
.component_class_filter_put_ref
)
89 _bt_as_component_class_ptr
= staticmethod(
90 native_bt
.component_class_filter_as_component_class
94 class _SinkComponentClassConst(_ComponentClassConst
):
95 _get_ref
= staticmethod(native_bt
.component_class_sink_get_ref
)
96 _put_ref
= staticmethod(native_bt
.component_class_sink_put_ref
)
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
):
240 _get_ref
= staticmethod(native_bt
.component_source_get_ref
)
241 _put_ref
= staticmethod(native_bt
.component_source_put_ref
)
244 def output_ports(self
):
245 return _ComponentPorts(
247 native_bt
.component_source_borrow_output_port_by_name_const
,
248 native_bt
.component_source_borrow_output_port_by_index_const
,
249 native_bt
.component_source_get_output_port_count
,
250 bt2_port
._OutputPortConst
,
254 # This is analogous to _FilterComponentClassConst, but for filter
256 class _GenericFilterComponentConst(object._SharedObject
, _FilterComponentConst
):
257 _get_ref
= staticmethod(native_bt
.component_filter_get_ref
)
258 _put_ref
= staticmethod(native_bt
.component_filter_put_ref
)
261 def output_ports(self
):
262 return _ComponentPorts(
264 native_bt
.component_filter_borrow_output_port_by_name_const
,
265 native_bt
.component_filter_borrow_output_port_by_index_const
,
266 native_bt
.component_filter_get_output_port_count
,
267 bt2_port
._OutputPortConst
,
271 def input_ports(self
):
272 return _ComponentPorts(
274 native_bt
.component_filter_borrow_input_port_by_name_const
,
275 native_bt
.component_filter_borrow_input_port_by_index_const
,
276 native_bt
.component_filter_get_input_port_count
,
277 bt2_port
._InputPortConst
,
281 # This is analogous to _SinkComponentClassConst, but for sink
283 class _GenericSinkComponentConst(object._SharedObject
, _SinkComponentConst
):
284 _get_ref
= staticmethod(native_bt
.component_sink_get_ref
)
285 _put_ref
= staticmethod(native_bt
.component_sink_put_ref
)
288 def input_ports(self
):
289 return _ComponentPorts(
291 native_bt
.component_sink_borrow_input_port_by_name_const
,
292 native_bt
.component_sink_borrow_input_port_by_index_const
,
293 native_bt
.component_sink_get_input_port_count
,
294 bt2_port
._InputPortConst
,
298 _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS
= {
299 native_bt
.COMPONENT_CLASS_TYPE_SOURCE
: _GenericSourceComponentConst
,
300 native_bt
.COMPONENT_CLASS_TYPE_FILTER
: _GenericFilterComponentConst
,
301 native_bt
.COMPONENT_CLASS_TYPE_SINK
: _GenericSinkComponentConst
,
305 _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS
= {
306 native_bt
.COMPONENT_CLASS_TYPE_SOURCE
: _SourceComponentClassConst
,
307 native_bt
.COMPONENT_CLASS_TYPE_FILTER
: _FilterComponentClassConst
,
308 native_bt
.COMPONENT_CLASS_TYPE_SINK
: _SinkComponentClassConst
,
312 # Create a component Python object of type _GenericSourceComponentConst,
313 # _GenericFilterComponentConst or _GenericSinkComponentConst, depending on
316 # Steals the reference to ptr from the caller.
319 def _create_component_from_const_ptr(ptr
, comp_cls_type
):
320 return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS
[comp_cls_type
]._create
_from
_ptr
(ptr
)
323 # Same as the above, but acquire a new reference instead of stealing the
324 # reference from the caller.
327 def _create_component_from_const_ptr_and_get_ref(ptr
, comp_cls_type
):
328 return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS
[
330 ]._create
_from
_ptr
_and
_get
_ref
(ptr
)
333 # Create a component class Python object of type
334 # _SourceComponentClassConst, _FilterComponentClassConst or
335 # _SinkComponentClassConst, depending on comp_cls_type.
337 # Acquires a new reference to ptr.
340 def _create_component_class_from_const_ptr_and_get_ref(ptr
, comp_cls_type
):
341 return _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS
[
343 ]._create
_from
_ptr
_and
_get
_ref
(ptr
)
346 def _trim_docstring(docstring
):
347 lines
= docstring
.expandtabs().splitlines()
350 for line
in lines
[1:]:
351 stripped
= line
.lstrip()
354 indent
= min(indent
, len(line
) - len(stripped
))
356 trimmed
= [lines
[0].strip()]
358 if indent
< sys
.maxsize
:
359 for line
in lines
[1:]:
360 trimmed
.append(line
[indent
:].rstrip())
362 while trimmed
and not trimmed
[-1]:
365 while trimmed
and not trimmed
[0]:
368 return '\n'.join(trimmed
)
371 # Metaclass for component classes defined by Python code.
373 # The Python user can create a standard Python class which inherits one
374 # of the three base classes (_UserSourceComponent, _UserFilterComponent,
375 # or _UserSinkComponent). Those base classes set this class
376 # (_UserComponentType) as their metaclass.
378 # Once the body of a user-defined component class is executed, this
379 # metaclass is used to create and initialize the class. The metaclass
380 # creates a native BT component class of the corresponding type and
381 # associates it with this user-defined class. The metaclass also defines
382 # class methods like the `name` and `description` properties to match
383 # the _ComponentClassConst interface.
385 # The component class name which is used is either:
387 # * The `name` parameter of the class:
389 # class MySink(bt2.SinkComponent, name='my-custom-sink'):
392 # * If the `name` class parameter is not used: the name of the class
393 # itself (`MySink` in the example above).
395 # The component class description which is used is the user-defined
398 # class MySink(bt2.SinkComponent):
399 # 'Description goes here'
402 # A user-defined Python component class can have an __init__() method
403 # which must at least accept the `params` and `name` arguments:
405 # def __init__(self, params, name, something_else):
408 # The user-defined component class can also have a _finalize() method
409 # (do NOT use __del__()) to be notified when the component object is
412 # User-defined source and filter component classes must use the
413 # `message_iterator_class` class parameter to specify the
414 # message iterator class to use for this component class:
416 # class MyMessageIterator(bt2._UserMessageIterator):
419 # class MySource(bt2._UserSourceComponent,
420 # message_iterator_class=MyMessageIterator):
423 # This message iterator class must inherit
424 # bt2._UserMessageIterator, and it must define the _get() and
425 # _next() methods. The message iterator class can also define an
426 # __init__() method: this method has access to the original Python
427 # component object which was used to create it as the `component`
428 # property. The message iterator class can also define a
429 # _finalize() method (again, do NOT use __del__()): this is called when
430 # the message iterator is (really) destroyed.
432 # When the user-defined class is destroyed, this metaclass's __del__()
433 # method is called: the native BT component class pointer is put (not
434 # needed anymore, at least not by any Python code since all references
435 # are dropped for __del__() to be called).
436 class _UserComponentType(type):
437 # __new__() is used to catch custom class parameters
438 def __new__(meta_cls
, class_name
, bases
, attrs
, **kwargs
):
439 return super().__new
__(meta_cls
, class_name
, bases
, attrs
)
441 def __init__(cls
, class_name
, bases
, namespace
, **kwargs
):
442 super().__init
__(class_name
, bases
, namespace
)
444 # skip our own bases; they are never directly instantiated by the user
447 '_UserFilterSinkComponent',
448 '_UserSourceComponent',
449 '_UserFilterComponent',
450 '_UserSinkComponent',
453 if class_name
in own_bases
:
456 comp_cls_name
= kwargs
.get('name', class_name
)
457 utils
._check
_str
(comp_cls_name
)
458 comp_cls_descr
= None
461 if hasattr(cls
, '__doc__') and cls
.__doc
__ is not None:
462 utils
._check
_str
(cls
.__doc
__)
463 docstring
= _trim_docstring(cls
.__doc
__)
464 lines
= docstring
.splitlines()
467 comp_cls_descr
= lines
[0]
470 comp_cls_help
= '\n'.join(lines
[2:])
472 iter_cls
= kwargs
.get('message_iterator_class')
474 if _UserSourceComponent
in bases
:
475 _UserComponentType
._bt
_set
_iterator
_class
(cls
, iter_cls
)
476 cc_ptr
= native_bt
.bt2_component_class_source_create(
477 cls
, comp_cls_name
, comp_cls_descr
, comp_cls_help
479 elif _UserFilterComponent
in bases
:
480 _UserComponentType
._bt
_set
_iterator
_class
(cls
, iter_cls
)
481 cc_ptr
= native_bt
.bt2_component_class_filter_create(
482 cls
, comp_cls_name
, comp_cls_descr
, comp_cls_help
484 elif _UserSinkComponent
in bases
:
485 if not hasattr(cls
, '_user_consume'):
486 raise bt2
._IncompleteUserClass(
487 "cannot create component class '{}': missing a _user_consume() method".format(
492 cc_ptr
= native_bt
.bt2_component_class_sink_create(
493 cls
, comp_cls_name
, comp_cls_descr
, comp_cls_help
496 raise bt2
._IncompleteUserClass(
497 "cannot find a known component class base in the bases of '{}'".format(
503 raise bt2
._MemoryError(
504 "cannot create component class '{}'".format(class_name
)
507 cls
._bt
_cc
_ptr
= cc_ptr
509 def _bt_init_from_native(cls
, comp_ptr
, params_ptr
, obj
):
510 # create instance, not user-initialized yet
511 self
= cls
.__new
__(cls
)
514 config
= cls
._config
_pycls
()
516 # pointer to native self component object (weak/borrowed)
517 self
._bt
_ptr
= comp_ptr
519 # call user's __init__() method
520 if params_ptr
is not None:
521 params
= bt2_value
._create
_from
_const
_ptr
_and
_get
_ref
(params_ptr
)
525 self
.__init
__(config
, params
, obj
)
528 def __call__(cls
, *args
, **kwargs
):
530 'cannot directly instantiate a user component from a Python module'
534 def _bt_set_iterator_class(cls
, iter_cls
):
536 raise bt2
._IncompleteUserClass(
537 "cannot create component class '{}': missing message iterator class".format(
542 if not issubclass(iter_cls
, bt2_message_iterator
._UserMessageIterator
):
543 raise bt2
._IncompleteUserClass(
544 "cannot create component class '{}': message iterator class does not inherit bt2._UserMessageIterator".format(
549 if not hasattr(iter_cls
, '__next__'):
550 raise bt2
._IncompleteUserClass(
551 "cannot create component class '{}': message iterator class is missing a __next__() method".format(
556 if hasattr(iter_cls
, '_user_can_seek_ns_from_origin') and not hasattr(
557 iter_cls
, '_user_seek_ns_from_origin'
559 raise bt2
._IncompleteUserClass(
560 "cannot create component class '{}': message iterator class implements _user_can_seek_ns_from_origin but not _user_seek_ns_from_origin".format(
565 if hasattr(iter_cls
, '_user_can_seek_beginning') and not hasattr(
566 iter_cls
, '_user_seek_beginning'
568 raise bt2
._IncompleteUserClass(
569 "cannot create component class '{}': message iterator class implements _user_can_seek_beginning but not _user_seek_beginning".format(
574 cls
._iter
_cls
= iter_cls
578 ptr
= cls
._bt
_as
_component
_class
_ptr
(cls
._bt
_cc
_ptr
)
579 return native_bt
.component_class_get_name(ptr
)
582 def description(cls
):
583 ptr
= cls
._bt
_as
_component
_class
_ptr
(cls
._bt
_cc
_ptr
)
584 return native_bt
.component_class_get_description(ptr
)
588 ptr
= cls
._bt
_as
_component
_class
_ptr
(cls
._bt
_cc
_ptr
)
589 return native_bt
.component_class_get_help(ptr
)
593 return int(cls
._bt
_cc
_ptr
)
595 def _bt_get_supported_mip_versions_from_native(cls
, params_ptr
, obj
, log_level
):
596 # this can raise, but the native side checks the exception
597 if params_ptr
is not None:
598 params
= bt2_value
._create
_from
_const
_ptr
_and
_get
_ref
(params_ptr
)
602 # this can raise, but the native side checks the exception
603 range_set
= cls
._user
_get
_supported
_mip
_versions
(params
, obj
, log_level
)
605 if type(range_set
) is not bt2
.UnsignedIntegerRangeSet
:
606 # this can raise, but the native side checks the exception
607 range_set
= bt2
.UnsignedIntegerRangeSet(range_set
)
609 # return new reference
610 range_set
._get
_ref
(range_set
._ptr
)
611 return int(range_set
._ptr
)
613 def _user_get_supported_mip_versions(cls
, params
, obj
, log_level
):
616 def _bt_query_from_native(
617 cls
, priv_query_exec_ptr
, object_name
, params_ptr
, method_obj
619 # this can raise, but the native side checks the exception
620 if params_ptr
is not None:
621 params
= bt2_value
._create
_from
_const
_ptr
_and
_get
_ref
(params_ptr
)
625 priv_query_exec
= bt2_query_executor
._PrivateQueryExecutor
(priv_query_exec_ptr
)
628 # this can raise, but the native side checks the exception
629 results
= cls
._user
_query
(priv_query_exec
, object_name
, params
, method_obj
)
631 # the private query executor is a private view on the query
632 # executor; it's not a shared object (the library does not
633 # offer an API to get/put a reference, just like "self"
634 # objects) from this query's point of view, so invalidate
635 # the object in case the user kept a reference and uses it
637 priv_query_exec
._invalidate
()
639 # this can raise, but the native side checks the exception
640 results
= bt2
.create_value(results
)
643 results_ptr
= native_bt
.value_null
645 results_ptr
= results
._ptr
647 # return new reference
648 bt2_value
._Value
._get
_ref
(results_ptr
)
649 return int(results_ptr
)
651 def _user_query(cls
, priv_query_executor
, object_name
, params
, method_obj
):
652 raise bt2
.UnknownObject
654 def _bt_component_class_ptr(self
):
655 return self
._bt
_as
_component
_class
_ptr
(self
._bt
_cc
_ptr
)
658 if hasattr(cls
, '_bt_cc_ptr'):
659 cc_ptr
= cls
._bt
_as
_component
_class
_ptr
(cls
._bt
_cc
_ptr
)
660 native_bt
.component_class_put_ref(cc_ptr
)
661 native_bt
.bt2_unregister_cc_ptr_to_py_cls(cc_ptr
)
664 # Configuration objects for components.
666 # These are passed in __init__ to allow components to change some configuration
667 # parameters during initialization and not after. As you can see, they are not
668 # used at the moment, but are there in case we want to add such parameters.
671 class _UserComponentConfiguration
:
675 class _UserSourceComponentConfiguration(_UserComponentConfiguration
):
679 class _UserFilterComponentConfiguration(_UserComponentConfiguration
):
683 class _UserSinkComponentConfiguration(_UserComponentConfiguration
):
687 # Subclasses must provide these methods or property:
689 # - _bt_as_not_self_specific_component_ptr: static method, must return the passed
690 # specialized self component pointer (e.g. 'bt_self_component_sink *') as a
691 # specialized non-self pointer (e.g. 'bt_component_sink *').
692 # - _bt_borrow_component_class_ptr: static method, must return a pointer to the
693 # specialized component class (e.g. 'bt_component_class_sink *') of the
694 # passed specialized component pointer (e.g. 'bt_component_sink *').
695 # - _bt_comp_cls_type: property, one of the native_bt.COMPONENT_CLASS_TYPE_*
699 class _UserComponent(metaclass
=_UserComponentType
):
702 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self
._bt
_ptr
)
703 ptr
= self
._bt
_as
_component
_ptr
(ptr
)
704 name
= native_bt
.component_get_name(ptr
)
705 assert name
is not None
709 def logging_level(self
):
710 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self
._bt
_ptr
)
711 ptr
= self
._bt
_as
_component
_ptr
(ptr
)
712 return native_bt
.component_get_logging_level(ptr
)
716 comp_ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self
._bt
_ptr
)
717 cc_ptr
= self
._bt
_borrow
_component
_class
_ptr
(comp_ptr
)
718 return _create_component_class_from_const_ptr_and_get_ref(
719 cc_ptr
, self
._bt
_comp
_cls
_type
724 return int(self
._bt
_ptr
)
727 def _graph_mip_version(self
):
728 ptr
= self
._bt
_as
_self
_component
_ptr
(self
._bt
_ptr
)
729 return native_bt
.self_component_get_graph_mip_version(ptr
)
731 def __init__(self
, config
, params
, obj
):
734 def _user_finalize(self
):
737 def _user_port_connected(self
, port
, other_port
):
740 def _bt_port_connected_from_native(
741 self
, self_port_ptr
, self_port_type
, other_port_ptr
743 port
= bt2_port
._create
_self
_from
_ptr
_and
_get
_ref
(self_port_ptr
, self_port_type
)
745 if self_port_type
== native_bt
.PORT_TYPE_OUTPUT
:
746 other_port_type
= native_bt
.PORT_TYPE_INPUT
748 other_port_type
= native_bt
.PORT_TYPE_OUTPUT
750 other_port
= bt2_port
._create
_from
_const
_ptr
_and
_get
_ref
(
751 other_port_ptr
, other_port_type
753 self
._user
_port
_connected
(port
, other_port
)
755 def _create_trace_class(
756 self
, user_attributes
=None, assigns_automatic_stream_class_id
=True
758 ptr
= self
._bt
_as
_self
_component
_ptr
(self
._bt
_ptr
)
759 tc_ptr
= native_bt
.trace_class_create(ptr
)
762 raise bt2
._MemoryError('could not create trace class')
764 tc
= bt2_trace_class
._TraceClass
._create
_from
_ptr
(tc_ptr
)
765 tc
._assigns
_automatic
_stream
_class
_id
= assigns_automatic_stream_class_id
767 if user_attributes
is not None:
768 tc
._user
_attributes
= user_attributes
772 def _create_clock_class(
776 user_attributes
=None,
780 origin_is_unix_epoch
=True,
783 ptr
= self
._bt
_as
_self
_component
_ptr
(self
._bt
_ptr
)
784 cc_ptr
= native_bt
.clock_class_create(ptr
)
787 raise bt2
._MemoryError('could not create clock class')
789 cc
= bt2_clock_class
._ClockClass
._create
_from
_ptr
(cc_ptr
)
791 if frequency
is not None:
792 cc
._frequency
= frequency
797 if user_attributes
is not None:
798 cc
._user
_attributes
= user_attributes
800 if description
is not None:
801 cc
._description
= description
803 if precision
is not None:
804 cc
._precision
= precision
806 if offset
is not None:
809 cc
._origin
_is
_unix
_epoch
= origin_is_unix_epoch
817 class _UserSourceComponent(_UserComponent
, _SourceComponentConst
):
818 _bt_as_not_self_specific_component_ptr
= staticmethod(
819 native_bt
.self_component_source_as_component_source
821 _bt_as_self_component_ptr
= staticmethod(
822 native_bt
.self_component_source_as_self_component
824 _config_pycls
= _UserSourceComponentConfiguration
827 def _output_ports(self
):
828 def get_output_port_count(self_ptr
):
829 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self_ptr
)
830 return native_bt
.component_source_get_output_port_count(ptr
)
832 return _ComponentPorts(
834 native_bt
.self_component_source_borrow_output_port_by_name
,
835 native_bt
.self_component_source_borrow_output_port_by_index
,
836 get_output_port_count
,
837 bt2_port
._UserComponentOutputPort
,
840 def _add_output_port(self
, name
, user_data
=None):
841 utils
._check
_str
(name
)
842 fn
= native_bt
.self_component_source_add_output_port
843 comp_status
, self_port_ptr
= fn(self
._bt
_ptr
, name
, user_data
)
844 utils
._handle
_func
_status
(
845 comp_status
, 'cannot add output port to source component object'
847 assert self_port_ptr
is not None
848 return bt2_port
._UserComponentOutputPort
._create
_from
_ptr
(self_port_ptr
)
851 class _UserFilterComponent(_UserComponent
, _FilterComponentConst
):
852 _bt_as_not_self_specific_component_ptr
= staticmethod(
853 native_bt
.self_component_filter_as_component_filter
855 _bt_as_self_component_ptr
= staticmethod(
856 native_bt
.self_component_filter_as_self_component
858 _config_pycls
= _UserFilterComponentConfiguration
861 def _output_ports(self
):
862 def get_output_port_count(self_ptr
):
863 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self_ptr
)
864 return native_bt
.component_filter_get_output_port_count(ptr
)
866 return _ComponentPorts(
868 native_bt
.self_component_filter_borrow_output_port_by_name
,
869 native_bt
.self_component_filter_borrow_output_port_by_index
,
870 get_output_port_count
,
871 bt2_port
._UserComponentOutputPort
,
875 def _input_ports(self
):
876 def get_input_port_count(self_ptr
):
877 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self_ptr
)
878 return native_bt
.component_filter_get_input_port_count(ptr
)
880 return _ComponentPorts(
882 native_bt
.self_component_filter_borrow_input_port_by_name
,
883 native_bt
.self_component_filter_borrow_input_port_by_index
,
884 get_input_port_count
,
885 bt2_port
._UserComponentInputPort
,
888 def _add_output_port(self
, name
, user_data
=None):
889 utils
._check
_str
(name
)
890 fn
= native_bt
.self_component_filter_add_output_port
891 comp_status
, self_port_ptr
= fn(self
._bt
_ptr
, name
, user_data
)
892 utils
._handle
_func
_status
(
893 comp_status
, 'cannot add output port to filter component object'
896 return bt2_port
._UserComponentOutputPort
._create
_from
_ptr
(self_port_ptr
)
898 def _add_input_port(self
, name
, user_data
=None):
899 utils
._check
_str
(name
)
900 fn
= native_bt
.self_component_filter_add_input_port
901 comp_status
, self_port_ptr
= fn(self
._bt
_ptr
, name
, user_data
)
902 utils
._handle
_func
_status
(
903 comp_status
, 'cannot add input port to filter component object'
906 return bt2_port
._UserComponentInputPort
._create
_from
_ptr
(self_port_ptr
)
909 class _UserSinkComponent(_UserComponent
, _SinkComponentConst
):
910 _bt_as_not_self_specific_component_ptr
= staticmethod(
911 native_bt
.self_component_sink_as_component_sink
913 _bt_as_self_component_ptr
= staticmethod(
914 native_bt
.self_component_sink_as_self_component
916 _config_pycls
= _UserSinkComponentConfiguration
918 def _bt_graph_is_configured_from_native(self
):
919 self
._user
_graph
_is
_configured
()
921 def _user_graph_is_configured(self
):
925 def _input_ports(self
):
926 def get_input_port_count(self_ptr
):
927 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self_ptr
)
928 return native_bt
.component_sink_get_input_port_count(ptr
)
930 return _ComponentPorts(
932 native_bt
.self_component_sink_borrow_input_port_by_name
,
933 native_bt
.self_component_sink_borrow_input_port_by_index
,
934 get_input_port_count
,
935 bt2_port
._UserComponentInputPort
,
938 def _add_input_port(self
, name
, user_data
=None):
939 utils
._check
_str
(name
)
940 fn
= native_bt
.self_component_sink_add_input_port
941 comp_status
, self_port_ptr
= fn(self
._bt
_ptr
, name
, user_data
)
942 utils
._handle
_func
_status
(
943 comp_status
, 'cannot add input port to sink component object'
946 return bt2_port
._UserComponentInputPort
._create
_from
_ptr
(self_port_ptr
)
948 def _create_input_port_message_iterator(self
, input_port
):
949 utils
._check
_type
(input_port
, bt2_port
._UserComponentInputPort
)
954 ) = native_bt
.bt2_self_component_port_input_message_iterator_create_from_sink_component(
955 self
._bt
_ptr
, input_port
._ptr
957 utils
._handle
_func
_status
(status
, 'cannot create message iterator object')
958 assert msg_iter_ptr
is not None
960 return bt2_message_iterator
._UserComponentInputPortMessageIterator
(msg_iter_ptr
)
963 def _is_interrupted(self
):
964 return bool(native_bt
.self_component_sink_is_interrupted(self
._bt
_ptr
))