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 import collections
.abc
32 def _handle_status(status
, obj_name
):
36 raise RuntimeError('unexpected error')
39 def _create_from_ptr(ptr
):
40 if ptr
is None or ptr
== native_bt
.value_null
:
43 typeid
= native_bt
.value_get_type(ptr
)
44 return _TYPE_TO_OBJ
[typeid
]._create
_from
_ptr
(ptr
)
47 def _create_from_ptr_and_get_ref(ptr
):
48 if ptr
is None or ptr
== native_bt
.value_null
:
51 typeid
= native_bt
.value_get_type(ptr
)
52 return _TYPE_TO_OBJ
[typeid
]._create
_from
_ptr
_and
_get
_ref
(ptr
)
55 def create_value(value
):
60 if isinstance(value
, _Value
):
63 if isinstance(value
, bool):
64 return BoolValue(value
)
66 if isinstance(value
, int):
67 return SignedIntegerValue(value
)
69 if isinstance(value
, float):
70 return RealValue(value
)
72 if isinstance(value
, str):
73 return StringValue(value
)
76 return MapValue(value
)
81 return ArrayValue(value
)
85 raise TypeError("cannot create value object from '{}' object".format(value
.__class
__.__name
__))
88 class _Value(object._SharedObject
, metaclass
=abc
.ABCMeta
):
89 _get_ref
= staticmethod(native_bt
.value_get_ref
)
90 _put_ref
= staticmethod(native_bt
.value_put_ref
)
92 def __eq__(self
, other
):
94 # self is never the null value object
97 # try type-specific comparison first
98 spec_eq
= self
._spec
_eq
(other
)
100 if spec_eq
is not None:
103 if not isinstance(other
, _Value
):
104 # not comparing apples to apples
107 # fall back to native comparison function
108 return native_bt
.value_compare(self
._ptr
, other
._ptr
)
110 def __ne__(self
, other
):
111 return not (self
== other
)
114 def _spec_eq(self
, other
):
117 def _handle_status(self
, status
):
118 _handle_status(status
, self
._NAME
)
120 def _check_create_status(self
, ptr
):
122 raise bt2
.CreationError(
123 'cannot create {} value object'.format(self
._NAME
.lower()))
126 @functools.total_ordering
127 class _NumericValue(_Value
):
129 def _extract_value(other
):
130 if isinstance(other
, _NumericValue
):
133 if other
is True or other
is False:
136 if isinstance(other
, numbers
.Integral
):
139 if isinstance(other
, numbers
.Real
):
142 if isinstance(other
, numbers
.Complex
):
143 return complex(other
)
145 raise TypeError("'{}' object is not a number object".format(other
.__class
__.__name
__))
148 return int(self
._value
)
151 return float(self
._value
)
154 return repr(self
._value
)
156 def __lt__(self
, other
):
157 if not isinstance(other
, numbers
.Number
):
158 raise TypeError('unorderable types: {}() < {}()'.format(self
.__class
__.__name
__,
159 other
.__class
__.__name
__))
161 return self
._value
< self
._extract
_value
(other
)
163 def _spec_eq(self
, other
):
166 def __eq__(self
, other
):
167 if not isinstance(other
, numbers
.Number
):
170 return self
._value
== self
._extract
_value
(other
)
172 def __rmod__(self
, other
):
173 return self
._extract
_value
(other
) % self
._value
175 def __mod__(self
, other
):
176 return self
._value
% self
._extract
_value
(other
)
178 def __rfloordiv__(self
, other
):
179 return self
._extract
_value
(other
) // self
._value
181 def __floordiv__(self
, other
):
182 return self
._value
// self
._extract
_value
(other
)
184 def __round__(self
, ndigits
=None):
186 return round(self
._value
)
188 return round(self
._value
, ndigits
)
191 return math
.ceil(self
._value
)
194 return math
.floor(self
._value
)
197 return int(self
._value
)
200 return abs(self
._value
)
202 def __add__(self
, other
):
203 return self
._value
+ self
._extract
_value
(other
)
205 def __radd__(self
, other
):
206 return self
.__add
__(other
)
214 def __mul__(self
, other
):
215 return self
._value
* self
._extract
_value
(other
)
217 def __rmul__(self
, other
):
218 return self
.__mul
__(other
)
220 def __truediv__(self
, other
):
221 return self
._value
/ self
._extract
_value
(other
)
223 def __rtruediv__(self
, other
):
224 return self
._extract
_value
(other
) / self
._value
226 def __pow__(self
, exponent
):
227 return self
._value
** self
._extract
_value
(exponent
)
229 def __rpow__(self
, base
):
230 return self
._extract
_value
(base
) ** self
._value
232 def __iadd__(self
, other
):
233 self
.value
= self
+ other
236 def __isub__(self
, other
):
237 self
.value
= self
- other
240 def __imul__(self
, other
):
241 self
.value
= self
* other
244 def __itruediv__(self
, other
):
245 self
.value
= self
/ other
248 def __ifloordiv__(self
, other
):
249 self
.value
= self
// other
252 def __imod__(self
, other
):
253 self
.value
= self
% other
256 def __ipow__(self
, other
):
257 self
.value
= self
** other
261 class _IntegralValue(_NumericValue
, numbers
.Integral
):
262 def __lshift__(self
, other
):
263 return self
._value
<< self
._extract
_value
(other
)
265 def __rlshift__(self
, other
):
266 return self
._extract
_value
(other
) << self
._value
268 def __rshift__(self
, other
):
269 return self
._value
>> self
._extract
_value
(other
)
271 def __rrshift__(self
, other
):
272 return self
._extract
_value
(other
) >> self
._value
274 def __and__(self
, other
):
275 return self
._value
& self
._extract
_value
(other
)
277 def __rand__(self
, other
):
278 return self
._extract
_value
(other
) & self
._value
280 def __xor__(self
, other
):
281 return self
._value ^ self
._extract
_value
(other
)
283 def __rxor__(self
, other
):
284 return self
._extract
_value
(other
) ^ self
._value
286 def __or__(self
, other
):
287 return self
._value | self
._extract
_value
(other
)
289 def __ror__(self
, other
):
290 return self
._extract
_value
(other
) | self
._value
292 def __invert__(self
):
295 def __ilshift__(self
, other
):
296 self
.value
= self
<< other
299 def __irshift__(self
, other
):
300 self
.value
= self
>> other
303 def __iand__(self
, other
):
304 self
.value
= self
& other
307 def __ixor__(self
, other
):
308 self
.value
= self ^ other
311 def __ior__(self
, other
):
312 self
.value
= self | other
316 class _RealValue(_NumericValue
, numbers
.Real
):
320 class BoolValue(_Value
):
323 def __init__(self
, value
=None):
325 ptr
= native_bt
.value_bool_create()
327 ptr
= native_bt
.value_bool_create_init(self
._value
_to
_bool
(value
))
329 self
._check
_create
_status
(ptr
)
330 super().__init
__(ptr
)
332 def _spec_eq(self
, other
):
333 if isinstance(other
, numbers
.Number
):
334 return self
._value
== bool(other
)
340 return repr(self
._value
)
342 def _value_to_bool(self
, value
):
343 if isinstance(value
, BoolValue
):
346 if not isinstance(value
, bool):
347 raise TypeError("'{}' object is not a 'bool' or 'BoolValue' object".format(value
.__class
__))
353 value
= native_bt
.value_bool_get(self
._ptr
)
356 def _set_value(self
, value
):
357 native_bt
.value_bool_set(self
._ptr
, self
._value
_to
_bool
(value
))
359 value
= property(fset
=_set_value
)
362 class _IntegerValue(_IntegralValue
):
363 def __init__(self
, value
=None):
365 ptr
= self
._create
_default
_value
()
367 ptr
= self
._create
_value
(self
._value
_to
_int
(value
))
369 self
._check
_create
_status
(ptr
)
370 super().__init
__(ptr
)
372 def _value_to_int(self
, value
):
373 if not isinstance(value
, numbers
.Real
):
374 raise TypeError('expecting a number object')
377 self
._check
_int
_range
(value
)
382 return self
._get
_value
(self
._ptr
)
384 def _prop_set_value(self
, value
):
385 self
._set
_value
(self
._ptr
, self
._value
_to
_int
(value
))
387 value
= property(fset
=_prop_set_value
)
390 class UnsignedIntegerValue(_IntegerValue
):
391 _check_int_range
= staticmethod(utils
._check
_uint
64)
392 _create_default_value
= staticmethod(native_bt
.value_unsigned_integer_create
)
393 _create_value
= staticmethod(native_bt
.value_unsigned_integer_create_init
)
394 _set_value
= staticmethod(native_bt
.value_unsigned_integer_set
)
395 _get_value
= staticmethod(native_bt
.value_unsigned_integer_get
)
398 class SignedIntegerValue(_IntegerValue
):
399 _check_int_range
= staticmethod(utils
._check
_int
64)
400 _create_default_value
= staticmethod(native_bt
.value_signed_integer_create
)
401 _create_value
= staticmethod(native_bt
.value_signed_integer_create_init
)
402 _set_value
= staticmethod(native_bt
.value_signed_integer_set
)
403 _get_value
= staticmethod(native_bt
.value_signed_integer_get
)
406 class RealValue(_RealValue
):
407 _NAME
= 'Real number'
409 def __init__(self
, value
=None):
411 ptr
= native_bt
.value_real_create()
413 value
= self
._value
_to
_float
(value
)
414 ptr
= native_bt
.value_real_create_init(value
)
416 self
._check
_create
_status
(ptr
)
417 super().__init
__(ptr
)
419 def _value_to_float(self
, value
):
420 if not isinstance(value
, numbers
.Real
):
421 raise TypeError("expecting a real number object")
427 return native_bt
.value_real_get(self
._ptr
)
429 def _set_value(self
, value
):
430 native_bt
.value_real_set(self
._ptr
, self
._value
_to
_float
(value
))
432 value
= property(fset
=_set_value
)
435 @functools.total_ordering
436 class StringValue(collections
.abc
.Sequence
, _Value
):
439 def __init__(self
, value
=None):
441 ptr
= native_bt
.value_string_create()
443 ptr
= native_bt
.value_string_create_init(self
._value
_to
_str
(value
))
445 self
._check
_create
_status
(ptr
)
446 super().__init
__(ptr
)
448 def _value_to_str(self
, value
):
449 if isinstance(value
, self
.__class
__):
452 utils
._check
_str
(value
)
457 return native_bt
.value_string_get(self
._ptr
)
459 def _set_value(self
, value
):
460 status
= native_bt
.value_string_set(self
._ptr
, self
._value
_to
_str
(value
))
461 self
._handle
_status
(status
)
463 value
= property(fset
=_set_value
)
465 def _spec_eq(self
, other
):
467 return self
._value
== self
._value
_to
_str
(other
)
471 def __lt__(self
, other
):
472 return self
._value
< self
._value
_to
_str
(other
)
475 return bool(self
._value
)
478 return repr(self
._value
)
483 def __getitem__(self
, index
):
484 return self
._value
[index
]
487 return len(self
._value
)
489 def __iadd__(self
, value
):
490 curvalue
= self
._value
491 curvalue
+= self
._value
_to
_str
(value
)
492 self
.value
= curvalue
498 return len(self
) != 0
500 def __delitem__(self
, index
):
501 raise NotImplementedError
504 class ArrayValue(_Container
, collections
.abc
.MutableSequence
, _Value
):
507 def __init__(self
, value
=None):
508 ptr
= native_bt
.value_array_create()
509 self
._check
_create
_status
(ptr
)
510 super().__init
__(ptr
)
512 # Python will raise a TypeError if there's anything wrong with
513 # the iterable protocol.
514 if value
is not None:
518 def _spec_eq(self
, other
):
520 if len(self
) != len(other
):
524 for self_elem
, other_elem
in zip(self
, other
):
525 if self_elem
!= other_elem
:
533 size
= native_bt
.value_array_get_size(self
._ptr
)
537 def _check_index(self
, index
):
538 # TODO: support slices also
539 if not isinstance(index
, numbers
.Integral
):
540 raise TypeError("'{}' object is not an integral number object: invalid index".format(index
.__class
__.__name
__))
544 if index
< 0 or index
>= len(self
):
545 raise IndexError('array value object index is out of range')
547 def __getitem__(self
, index
):
548 self
._check
_index
(index
)
549 ptr
= native_bt
.value_array_borrow_element_by_index(self
._ptr
, index
)
551 return _create_from_ptr_and_get_ref(ptr
)
553 def __setitem__(self
, index
, value
):
554 self
._check
_index
(index
)
555 value
= create_value(value
)
558 ptr
= native_bt
.value_null
562 status
= native_bt
.value_array_set_element_by_index(
563 self
._ptr
, index
, ptr
)
564 self
._handle
_status
(status
)
566 def append(self
, value
):
567 value
= create_value(value
)
570 ptr
= native_bt
.value_null
574 status
= native_bt
.value_array_append_element(self
._ptr
, ptr
)
575 self
._handle
_status
(status
)
577 def __iadd__(self
, iterable
):
578 # Python will raise a TypeError if there's anything wrong with
579 # the iterable protocol.
580 for elem
in iterable
:
586 return '[{}]'.format(', '.join([repr(v
) for v
in self
]))
588 def insert(self
, value
):
589 raise NotImplementedError
592 class _MapValueKeyIterator(collections
.abc
.Iterator
):
593 def __init__(self
, map_obj
):
594 self
._map
_obj
= map_obj
596 keys_ptr
= native_bt
.value_map_get_keys(map_obj
._ptr
)
599 raise RuntimeError('unexpected error: cannot get map value object keys')
601 self
._keys
= _create_from_ptr(keys_ptr
)
604 if self
._at
== len(self
._map
_obj
):
607 key
= self
._keys
[self
._at
]
612 class MapValue(_Container
, collections
.abc
.MutableMapping
, _Value
):
615 def __init__(self
, value
=None):
616 ptr
= native_bt
.value_map_create()
617 self
._check
_create
_status
(ptr
)
618 super().__init
__(ptr
)
620 # Python will raise a TypeError if there's anything wrong with
621 # the iterable/mapping protocol.
622 if value
is not None:
623 for key
, elem
in value
.items():
626 def __eq__(self
, other
):
627 return _Value
.__eq
__(self
, other
)
629 def __ne__(self
, other
):
630 return _Value
.__ne
__(self
, other
)
632 def _spec_eq(self
, other
):
634 if len(self
) != len(other
):
638 for self_key
in self
:
639 if self_key
not in other
:
642 self_value
= self
[self_key
]
643 other_value
= other
[self_key
]
645 if self_value
!= other_value
:
653 size
= native_bt
.value_map_get_size(self
._ptr
)
657 def __contains__(self
, key
):
658 self
._check
_key
_type
(key
)
659 return native_bt
.value_map_has_entry(self
._ptr
, key
)
661 def _check_key_type(self
, key
):
662 utils
._check
_str
(key
)
664 def _check_key(self
, key
):
668 def __getitem__(self
, key
):
670 ptr
= native_bt
.value_map_borrow_entry_value(self
._ptr
, key
)
672 return _create_from_ptr_and_get_ref(ptr
)
675 return _MapValueKeyIterator(self
)
677 def __setitem__(self
, key
, value
):
678 self
._check
_key
_type
(key
)
679 value
= create_value(value
)
682 ptr
= native_bt
.value_null
686 status
= native_bt
.value_map_insert_entry(self
._ptr
, key
, ptr
)
687 self
._handle
_status
(status
)
690 items
= ['{}: {}'.format(repr(k
), repr(v
)) for k
, v
in self
.items()]
691 return '{{{}}}'.format(', '.join(items
))
695 native_bt
.VALUE_TYPE_BOOL
: BoolValue
,
696 native_bt
.VALUE_TYPE_UNSIGNED_INTEGER
: UnsignedIntegerValue
,
697 native_bt
.VALUE_TYPE_SIGNED_INTEGER
: SignedIntegerValue
,
698 native_bt
.VALUE_TYPE_REAL
: RealValue
,
699 native_bt
.VALUE_TYPE_STRING
: StringValue
,
700 native_bt
.VALUE_TYPE_ARRAY
: ArrayValue
,
701 native_bt
.VALUE_TYPE_MAP
: MapValue
,