lib: strictly type function return status enumerations
[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 import bt2.component
25 import bt2.logging
26 import bt2
27
28
29 class QueryExecutor(object._SharedObject):
30 _get_ref = staticmethod(native_bt.query_executor_get_ref)
31 _put_ref = staticmethod(native_bt.query_executor_put_ref)
32
33 def __init__(self):
34 ptr = native_bt.query_executor_create()
35
36 if ptr is None:
37 raise bt2.CreationError('cannot create query executor object')
38
39 super().__init__(ptr)
40
41 def cancel(self):
42 status = native_bt.query_executor_cancel(self._ptr)
43 utils._handle_func_status(status,
44 'cannot cancel query executor object')
45
46 @property
47 def is_canceled(self):
48 is_canceled = native_bt.query_executor_is_canceled(self._ptr)
49 assert(is_canceled >= 0)
50 return is_canceled > 0
51
52 def query(self, component_class, object, params=None,
53 logging_level=bt2.logging.LoggingLevel.NONE):
54 if self.is_canceled:
55 raise bt2.Canceled
56
57 if not isinstance(component_class, bt2.component._GenericComponentClass):
58 err = False
59
60 try:
61 if not issubclass(component_class, bt2.component._UserComponent):
62 err = True
63 except TypeError:
64 err = True
65
66 if err:
67 o = component_class
68 raise TypeError("'{}' is not a component class object".format(o))
69
70 utils._check_str(object)
71
72 if params is None:
73 params_ptr = native_bt.value_null
74 else:
75 params = bt2.create_value(params)
76 params_ptr = params._ptr
77
78 utils._check_log_level(logging_level)
79 cc_ptr = component_class._component_class_ptr()
80
81 status, result_ptr = native_bt.query_executor_query(self._ptr, cc_ptr,
82 object, params_ptr,
83 logging_level)
84 utils._handle_func_status(status, 'cannot query component class')
85 assert(result_ptr)
86 return bt2.value._create_from_ptr(result_ptr)
This page took 0.03121 seconds and 4 git commands to generate.