lib: strictly type function return status enumerations
[babeltrace.git] / src / bindings / python / bt2 / bt2 / value.py
CommitLineData
81447b5b
PP
1# The MIT License (MIT)
2#
811644b8 3# Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
81447b5b
PP
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
23from bt2 import native_bt, object, utils
24import collections.abc
25import functools
26import numbers
27import math
28import abc
29import bt2
30
31
81447b5b
PP
32def _create_from_ptr(ptr):
33 if ptr is None or ptr == native_bt.value_null:
34 return
35
36 typeid = native_bt.value_get_type(ptr)
37 return _TYPE_TO_OBJ[typeid]._create_from_ptr(ptr)
38
39
10a19b49
SM
40def _create_from_ptr_and_get_ref(ptr):
41 if ptr is None or ptr == native_bt.value_null:
42 return
43
44 typeid = native_bt.value_get_type(ptr)
45 return _TYPE_TO_OBJ[typeid]._create_from_ptr_and_get_ref(ptr)
46
47
81447b5b
PP
48def create_value(value):
49 if value is None:
50 # null value object
51 return
52
53 if isinstance(value, _Value):
54 return value
55
56 if isinstance(value, bool):
57 return BoolValue(value)
58
665658c2 59 if isinstance(value, numbers.Integral):
fdd3a2da 60 return SignedIntegerValue(value)
81447b5b 61
665658c2 62 if isinstance(value, numbers.Real):
10a19b49 63 return RealValue(value)
81447b5b
PP
64
65 if isinstance(value, str):
66 return StringValue(value)
67
665658c2 68 if isinstance(value, collections.abc.Sequence):
81447b5b 69 return ArrayValue(value)
665658c2
PP
70
71 if isinstance(value, collections.abc.Mapping):
72 return MapValue(value)
81447b5b
PP
73
74 raise TypeError("cannot create value object from '{}' object".format(value.__class__.__name__))
75
76
78288f58 77class _Value(object._SharedObject, metaclass=abc.ABCMeta):
2f16a6a2
PP
78 _get_ref = staticmethod(native_bt.value_get_ref)
79 _put_ref = staticmethod(native_bt.value_put_ref)
10a19b49 80
81447b5b
PP
81 def __ne__(self, other):
82 return not (self == other)
83
81447b5b
PP
84 def _check_create_status(self, ptr):
85 if ptr is None:
10a19b49
SM
86 raise bt2.CreationError(
87 'cannot create {} value object'.format(self._NAME.lower()))
81447b5b
PP
88
89
90@functools.total_ordering
10a19b49 91class _NumericValue(_Value):
81447b5b
PP
92 @staticmethod
93 def _extract_value(other):
b00a769c
PP
94 if isinstance(other, BoolValue) or isinstance(other, bool):
95 return bool(other)
81447b5b
PP
96
97 if isinstance(other, numbers.Integral):
98 return int(other)
99
100 if isinstance(other, numbers.Real):
101 return float(other)
102
103 if isinstance(other, numbers.Complex):
104 return complex(other)
105
106 raise TypeError("'{}' object is not a number object".format(other.__class__.__name__))
107
108 def __int__(self):
9b6cd4a7 109 return int(self._value)
81447b5b
PP
110
111 def __float__(self):
9b6cd4a7 112 return float(self._value)
81447b5b 113
83656269
JG
114 def __repr__(self):
115 return repr(self._value)
81447b5b
PP
116
117 def __lt__(self, other):
09a926c1 118 return self._value < self._extract_value(other)
81447b5b 119
81447b5b 120 def __eq__(self, other):
b00a769c
PP
121 try:
122 return self._value == self._extract_value(other)
123 except:
81447b5b
PP
124 return False
125
81447b5b 126 def __rmod__(self, other):
9b6cd4a7 127 return self._extract_value(other) % self._value
81447b5b
PP
128
129 def __mod__(self, other):
9b6cd4a7 130 return self._value % self._extract_value(other)
81447b5b
PP
131
132 def __rfloordiv__(self, other):
9b6cd4a7 133 return self._extract_value(other) // self._value
81447b5b
PP
134
135 def __floordiv__(self, other):
9b6cd4a7 136 return self._value // self._extract_value(other)
81447b5b
PP
137
138 def __round__(self, ndigits=None):
139 if ndigits is None:
9b6cd4a7 140 return round(self._value)
81447b5b 141 else:
9b6cd4a7 142 return round(self._value, ndigits)
81447b5b
PP
143
144 def __ceil__(self):
9b6cd4a7 145 return math.ceil(self._value)
81447b5b
PP
146
147 def __floor__(self):
9b6cd4a7 148 return math.floor(self._value)
81447b5b
PP
149
150 def __trunc__(self):
9b6cd4a7 151 return int(self._value)
81447b5b
PP
152
153 def __abs__(self):
9b6cd4a7 154 return abs(self._value)
81447b5b
PP
155
156 def __add__(self, other):
9b6cd4a7 157 return self._value + self._extract_value(other)
81447b5b
PP
158
159 def __radd__(self, other):
160 return self.__add__(other)
161
162 def __neg__(self):
9b6cd4a7 163 return -self._value
81447b5b
PP
164
165 def __pos__(self):
9b6cd4a7 166 return +self._value
81447b5b
PP
167
168 def __mul__(self, other):
9b6cd4a7 169 return self._value * self._extract_value(other)
81447b5b
PP
170
171 def __rmul__(self, other):
172 return self.__mul__(other)
173
174 def __truediv__(self, other):
9b6cd4a7 175 return self._value / self._extract_value(other)
81447b5b
PP
176
177 def __rtruediv__(self, other):
9b6cd4a7 178 return self._extract_value(other) / self._value
81447b5b
PP
179
180 def __pow__(self, exponent):
9b6cd4a7 181 return self._value ** self._extract_value(exponent)
81447b5b
PP
182
183 def __rpow__(self, base):
9b6cd4a7 184 return self._extract_value(base) ** self._value
81447b5b 185
81447b5b
PP
186
187class _IntegralValue(_NumericValue, numbers.Integral):
188 def __lshift__(self, other):
9b6cd4a7 189 return self._value << self._extract_value(other)
81447b5b
PP
190
191 def __rlshift__(self, other):
9b6cd4a7 192 return self._extract_value(other) << self._value
81447b5b
PP
193
194 def __rshift__(self, other):
9b6cd4a7 195 return self._value >> self._extract_value(other)
81447b5b
PP
196
197 def __rrshift__(self, other):
9b6cd4a7 198 return self._extract_value(other) >> self._value
81447b5b
PP
199
200 def __and__(self, other):
9b6cd4a7 201 return self._value & self._extract_value(other)
81447b5b
PP
202
203 def __rand__(self, other):
9b6cd4a7 204 return self._extract_value(other) & self._value
81447b5b
PP
205
206 def __xor__(self, other):
9b6cd4a7 207 return self._value ^ self._extract_value(other)
81447b5b
PP
208
209 def __rxor__(self, other):
9b6cd4a7 210 return self._extract_value(other) ^ self._value
81447b5b
PP
211
212 def __or__(self, other):
9b6cd4a7 213 return self._value | self._extract_value(other)
81447b5b
PP
214
215 def __ror__(self, other):
9b6cd4a7 216 return self._extract_value(other) | self._value
81447b5b
PP
217
218 def __invert__(self):
9b6cd4a7 219 return ~self._value
81447b5b 220
81447b5b
PP
221
222class _RealValue(_NumericValue, numbers.Real):
223 pass
224
225
88d39313 226class BoolValue(_IntegralValue):
81447b5b
PP
227 _NAME = 'Boolean'
228
229 def __init__(self, value=None):
230 if value is None:
231 ptr = native_bt.value_bool_create()
232 else:
233 ptr = native_bt.value_bool_create_init(self._value_to_bool(value))
234
235 self._check_create_status(ptr)
236 super().__init__(ptr)
237
81447b5b 238 def __bool__(self):
9b6cd4a7 239 return self._value
81447b5b 240
83656269
JG
241 def __repr__(self):
242 return repr(self._value)
81447b5b
PP
243
244 def _value_to_bool(self, value):
245 if isinstance(value, BoolValue):
9b6cd4a7 246 value = value._value
81447b5b
PP
247
248 if not isinstance(value, bool):
249 raise TypeError("'{}' object is not a 'bool' or 'BoolValue' object".format(value.__class__))
250
b00a769c 251 return value
81447b5b
PP
252
253 @property
9b6cd4a7 254 def _value(self):
10a19b49
SM
255 value = native_bt.value_bool_get(self._ptr)
256 return value != 0
81447b5b 257
9b6cd4a7 258 def _set_value(self, value):
10a19b49 259 native_bt.value_bool_set(self._ptr, self._value_to_bool(value))
81447b5b 260
9b6cd4a7
PP
261 value = property(fset=_set_value)
262
81447b5b 263
fdd3a2da 264class _IntegerValue(_IntegralValue):
81447b5b
PP
265 def __init__(self, value=None):
266 if value is None:
fdd3a2da 267 ptr = self._create_default_value()
81447b5b 268 else:
fdd3a2da 269 ptr = self._create_value(self._value_to_int(value))
81447b5b
PP
270
271 self._check_create_status(ptr)
272 super().__init__(ptr)
273
274 def _value_to_int(self, value):
e502b15a
PP
275 if not isinstance(value, numbers.Integral):
276 raise TypeError('expecting an integral number object')
81447b5b
PP
277
278 value = int(value)
fdd3a2da 279 self._check_int_range(value)
81447b5b
PP
280 return value
281
282 @property
9b6cd4a7 283 def _value(self):
fdd3a2da 284 return self._get_value(self._ptr)
81447b5b 285
fdd3a2da
PP
286 def _prop_set_value(self, value):
287 self._set_value(self._ptr, self._value_to_int(value))
81447b5b 288
fdd3a2da
PP
289 value = property(fset=_prop_set_value)
290
291
292class UnsignedIntegerValue(_IntegerValue):
293 _check_int_range = staticmethod(utils._check_uint64)
2f16a6a2
PP
294 _create_default_value = staticmethod(native_bt.value_unsigned_integer_create)
295 _create_value = staticmethod(native_bt.value_unsigned_integer_create_init)
296 _set_value = staticmethod(native_bt.value_unsigned_integer_set)
297 _get_value = staticmethod(native_bt.value_unsigned_integer_get)
fdd3a2da
PP
298
299
300class SignedIntegerValue(_IntegerValue):
301 _check_int_range = staticmethod(utils._check_int64)
2f16a6a2
PP
302 _create_default_value = staticmethod(native_bt.value_signed_integer_create)
303 _create_value = staticmethod(native_bt.value_signed_integer_create_init)
304 _set_value = staticmethod(native_bt.value_signed_integer_set)
305 _get_value = staticmethod(native_bt.value_signed_integer_get)
9b6cd4a7 306
81447b5b 307
10a19b49
SM
308class RealValue(_RealValue):
309 _NAME = 'Real number'
81447b5b
PP
310
311 def __init__(self, value=None):
312 if value is None:
10a19b49 313 ptr = native_bt.value_real_create()
81447b5b
PP
314 else:
315 value = self._value_to_float(value)
10a19b49 316 ptr = native_bt.value_real_create_init(value)
81447b5b
PP
317
318 self._check_create_status(ptr)
319 super().__init__(ptr)
320
321 def _value_to_float(self, value):
322 if not isinstance(value, numbers.Real):
323 raise TypeError("expecting a real number object")
324
325 return float(value)
326
327 @property
9b6cd4a7 328 def _value(self):
10a19b49 329 return native_bt.value_real_get(self._ptr)
81447b5b 330
9b6cd4a7 331 def _set_value(self, value):
10a19b49 332 native_bt.value_real_set(self._ptr, self._value_to_float(value))
81447b5b 333
9b6cd4a7
PP
334 value = property(fset=_set_value)
335
81447b5b
PP
336
337@functools.total_ordering
10a19b49 338class StringValue(collections.abc.Sequence, _Value):
81447b5b
PP
339 _NAME = 'String'
340
341 def __init__(self, value=None):
342 if value is None:
343 ptr = native_bt.value_string_create()
344 else:
345 ptr = native_bt.value_string_create_init(self._value_to_str(value))
346
347 self._check_create_status(ptr)
348 super().__init__(ptr)
349
350 def _value_to_str(self, value):
351 if isinstance(value, self.__class__):
9b6cd4a7 352 value = value._value
81447b5b
PP
353
354 utils._check_str(value)
355 return value
356
357 @property
9b6cd4a7 358 def _value(self):
10a19b49 359 return native_bt.value_string_get(self._ptr)
81447b5b 360
9b6cd4a7 361 def _set_value(self, value):
81447b5b 362 status = native_bt.value_string_set(self._ptr, self._value_to_str(value))
d24d5663 363 utils._handle_func_status(status)
81447b5b 364
9b6cd4a7
PP
365 value = property(fset=_set_value)
366
b00a769c 367 def __eq__(self, other):
81447b5b 368 try:
9b6cd4a7 369 return self._value == self._value_to_str(other)
81447b5b 370 except:
b00a769c 371 return False
81447b5b 372
81447b5b 373 def __lt__(self, other):
9b6cd4a7 374 return self._value < self._value_to_str(other)
81447b5b
PP
375
376 def __bool__(self):
9b6cd4a7 377 return bool(self._value)
81447b5b 378
83656269 379 def __repr__(self):
10a19b49 380 return repr(self._value)
83656269 381
81447b5b 382 def __str__(self):
9b6cd4a7 383 return self._value
81447b5b
PP
384
385 def __getitem__(self, index):
9b6cd4a7 386 return self._value[index]
81447b5b
PP
387
388 def __len__(self):
9b6cd4a7 389 return len(self._value)
81447b5b
PP
390
391 def __iadd__(self, value):
9b6cd4a7 392 curvalue = self._value
81447b5b
PP
393 curvalue += self._value_to_str(value)
394 self.value = curvalue
395 return self
396
397
398class _Container:
399 def __bool__(self):
400 return len(self) != 0
401
81447b5b
PP
402 def __delitem__(self, index):
403 raise NotImplementedError
404
405
406class ArrayValue(_Container, collections.abc.MutableSequence, _Value):
407 _NAME = 'Array'
408
409 def __init__(self, value=None):
410 ptr = native_bt.value_array_create()
411 self._check_create_status(ptr)
412 super().__init__(ptr)
413
414 # Python will raise a TypeError if there's anything wrong with
415 # the iterable protocol.
416 if value is not None:
417 for elem in value:
418 self.append(elem)
419
b00a769c
PP
420 def __eq__(self, other):
421 if not isinstance(other, collections.abc.Sequence):
422 return False
81447b5b 423
b00a769c
PP
424 if len(self) != len(other):
425 # early mismatch
426 return False
81447b5b 427
b00a769c
PP
428 for self_elem, other_elem in zip(self, other):
429 if self_elem != other_elem:
430 return False
431
432 return True
81447b5b
PP
433
434 def __len__(self):
10a19b49 435 size = native_bt.value_array_get_size(self._ptr)
811644b8 436 assert(size >= 0)
81447b5b
PP
437 return size
438
439 def _check_index(self, index):
440 # TODO: support slices also
441 if not isinstance(index, numbers.Integral):
442 raise TypeError("'{}' object is not an integral number object: invalid index".format(index.__class__.__name__))
443
444 index = int(index)
445
446 if index < 0 or index >= len(self):
447 raise IndexError('array value object index is out of range')
448
449 def __getitem__(self, index):
450 self._check_index(index)
10a19b49 451 ptr = native_bt.value_array_borrow_element_by_index(self._ptr, index)
811644b8 452 assert(ptr)
10a19b49 453 return _create_from_ptr_and_get_ref(ptr)
81447b5b
PP
454
455 def __setitem__(self, index, value):
456 self._check_index(index)
457 value = create_value(value)
458
459 if value is None:
460 ptr = native_bt.value_null
461 else:
462 ptr = value._ptr
463
10a19b49
SM
464 status = native_bt.value_array_set_element_by_index(
465 self._ptr, index, ptr)
d24d5663 466 utils._handle_func_status(status)
81447b5b
PP
467
468 def append(self, value):
469 value = create_value(value)
470
471 if value is None:
472 ptr = native_bt.value_null
473 else:
474 ptr = value._ptr
475
10a19b49 476 status = native_bt.value_array_append_element(self._ptr, ptr)
d24d5663 477 utils._handle_func_status(status)
81447b5b
PP
478
479 def __iadd__(self, iterable):
480 # Python will raise a TypeError if there's anything wrong with
481 # the iterable protocol.
482 for elem in iterable:
483 self.append(elem)
484
485 return self
486
83656269
JG
487 def __repr__(self):
488 return '[{}]'.format(', '.join([repr(v) for v in self]))
81447b5b
PP
489
490 def insert(self, value):
491 raise NotImplementedError
492
493
494class _MapValueKeyIterator(collections.abc.Iterator):
495 def __init__(self, map_obj):
496 self._map_obj = map_obj
497 self._at = 0
10a19b49 498 keys_ptr = native_bt.value_map_get_keys(map_obj._ptr)
81447b5b
PP
499
500 if keys_ptr is None:
501 raise RuntimeError('unexpected error: cannot get map value object keys')
502
503 self._keys = _create_from_ptr(keys_ptr)
504
505 def __next__(self):
506 if self._at == len(self._map_obj):
507 raise StopIteration
508
509 key = self._keys[self._at]
510 self._at += 1
511 return str(key)
512
513
514class MapValue(_Container, collections.abc.MutableMapping, _Value):
515 _NAME = 'Map'
516
517 def __init__(self, value=None):
518 ptr = native_bt.value_map_create()
519 self._check_create_status(ptr)
520 super().__init__(ptr)
521
522 # Python will raise a TypeError if there's anything wrong with
523 # the iterable/mapping protocol.
524 if value is not None:
525 for key, elem in value.items():
526 self[key] = elem
527
81447b5b
PP
528 def __ne__(self, other):
529 return _Value.__ne__(self, other)
530
b00a769c
PP
531 def __eq__(self, other):
532 if not isinstance(other, collections.abc.Mapping):
533 return False
81447b5b 534
b00a769c
PP
535 if len(self) != len(other):
536 # early mismatch
537 return False
81447b5b 538
b00a769c
PP
539 for self_key in self:
540 if self_key not in other:
541 return False
81447b5b 542
b00a769c
PP
543 if self[self_key] != other[self_key]:
544 return False
81447b5b 545
b00a769c 546 return True
81447b5b
PP
547
548 def __len__(self):
10a19b49 549 size = native_bt.value_map_get_size(self._ptr)
811644b8 550 assert(size >= 0)
81447b5b
PP
551 return size
552
553 def __contains__(self, key):
554 self._check_key_type(key)
10a19b49 555 return native_bt.value_map_has_entry(self._ptr, key)
81447b5b
PP
556
557 def _check_key_type(self, key):
558 utils._check_str(key)
559
560 def _check_key(self, key):
561 if key not in self:
562 raise KeyError(key)
563
564 def __getitem__(self, key):
565 self._check_key(key)
10a19b49 566 ptr = native_bt.value_map_borrow_entry_value(self._ptr, key)
811644b8 567 assert(ptr)
10a19b49 568 return _create_from_ptr_and_get_ref(ptr)
81447b5b
PP
569
570 def __iter__(self):
571 return _MapValueKeyIterator(self)
572
573 def __setitem__(self, key, value):
574 self._check_key_type(key)
575 value = create_value(value)
576
577 if value is None:
578 ptr = native_bt.value_null
579 else:
580 ptr = value._ptr
581
10a19b49 582 status = native_bt.value_map_insert_entry(self._ptr, key, ptr)
d24d5663 583 utils._handle_func_status(status)
81447b5b 584
83656269
JG
585 def __repr__(self):
586 items = ['{}: {}'.format(repr(k), repr(v)) for k, v in self.items()]
587 return '{{{}}}'.format(', '.join(items))
81447b5b
PP
588
589
590_TYPE_TO_OBJ = {
591 native_bt.VALUE_TYPE_BOOL: BoolValue,
fdd3a2da
PP
592 native_bt.VALUE_TYPE_UNSIGNED_INTEGER: UnsignedIntegerValue,
593 native_bt.VALUE_TYPE_SIGNED_INTEGER: SignedIntegerValue,
10a19b49 594 native_bt.VALUE_TYPE_REAL: RealValue,
81447b5b
PP
595 native_bt.VALUE_TYPE_STRING: StringValue,
596 native_bt.VALUE_TYPE_ARRAY: ArrayValue,
597 native_bt.VALUE_TYPE_MAP: MapValue,
598}
This page took 0.06935 seconds and 4 git commands to generate.