lib: prepare the ground for stateful query operations
[babeltrace.git] / src / bindings / python / bt2 / bt2 / query_executor.py
1 # The MIT License (MIT)
2 #
3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
4 #
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:
11 #
12 # The above copyright notice and this permission notice shall be included in
13 # all copies or substantial portions of the Software.
14 #
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
21 # THE SOFTWARE.
22
23 from bt2 import native_bt, object, utils
24 from bt2 import interrupter as bt2_interrupter
25 from bt2 import component as bt2_component
26 from bt2 import logging as bt2_logging
27 from bt2 import value as bt2_value
28 import bt2
29
30
31 class _QueryExecutorCommon:
32 @property
33 def _common_ptr(self):
34 return self._as_query_executor_ptr()
35
36 @property
37 def is_interrupted(self):
38 is_interrupted = native_bt.query_executor_is_interrupted(self._common_ptr)
39 return bool(is_interrupted)
40
41 @property
42 def logging_level(self):
43 return native_bt.query_executor_get_logging_level(self._common_ptr)
44
45
46 class QueryExecutor(object._SharedObject, _QueryExecutorCommon):
47 _get_ref = staticmethod(native_bt.query_executor_get_ref)
48 _put_ref = staticmethod(native_bt.query_executor_put_ref)
49
50 def _as_query_executor_ptr(self):
51 return self._ptr
52
53 def __init__(self, component_class, object, params=None):
54 if not isinstance(component_class, bt2_component._ComponentClass):
55 err = False
56
57 try:
58 if not issubclass(component_class, bt2_component._UserComponent):
59 err = True
60 except TypeError:
61 err = True
62
63 if err:
64 o = component_class
65 raise TypeError("'{}' is not a component class object".format(o))
66
67 utils._check_str(object)
68
69 if params is None:
70 params_ptr = native_bt.value_null
71 else:
72 params = bt2.create_value(params)
73 params_ptr = params._ptr
74
75 cc_ptr = component_class._bt_component_class_ptr()
76 assert cc_ptr is not None
77 ptr = native_bt.query_executor_create(cc_ptr, object, params_ptr)
78
79 if ptr is None:
80 raise bt2._MemoryError('cannot create query executor object')
81
82 super().__init__(ptr)
83
84 def add_interrupter(self, interrupter):
85 utils._check_type(interrupter, bt2_interrupter.Interrupter)
86 native_bt.query_executor_add_interrupter(self._ptr, interrupter._ptr)
87
88 def interrupt(self):
89 native_bt.query_executor_interrupt(self._ptr)
90
91 def _set_logging_level(self, log_level):
92 utils._check_log_level(log_level)
93 status = native_bt.query_executor_set_logging_level(self._ptr, log_level)
94 utils._handle_func_status(status, "cannot set query executor's logging level")
95
96 logging_level = property(
97 fget=_QueryExecutorCommon.logging_level, fset=_set_logging_level
98 )
99
100 @property
101 def is_interrupted(self):
102 is_interrupted = native_bt.query_executor_is_interrupted(self._ptr)
103 return bool(is_interrupted)
104
105 def query(self):
106 status, result_ptr = native_bt.query_executor_query(self._ptr)
107 utils._handle_func_status(status, 'cannot query component class')
108 assert result_ptr is not None
109 return bt2_value._create_from_ptr(result_ptr)
110
111
112 class _PrivateQueryExecutor(_QueryExecutorCommon):
113 def __init__(self, ptr):
114 self._ptr = ptr
115
116 def _check_validity(self):
117 if self._ptr is None:
118 raise RuntimeError('this object is not valid anymore')
119
120 def _as_query_executor_ptr(self):
121 self._check_validity()
122 return native_bt.private_query_executor_as_query_executor_const(self._ptr)
123
124 def _invalidate(self):
125 self._ptr = None
This page took 0.033268 seconds and 4 git commands to generate.