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 if status
== native_bt
.VALUE_STATUS_FROZEN
:
37 raise bt2
.Frozen('{} value object is frozen'.format(obj_name
))
38 elif status
== native_bt
.VALUE_STATUS_INVAL
:
39 # In practice, this should never happen, because arguments
40 # should always be validated in this Python module before
41 # calling the native functions.
42 raise ValueError('unexpected invalid argument')
44 # In practice, this should never happen, because arguments
45 # should always be validated in this Python module before
46 # calling the native functions.
47 raise RuntimeError('unexpected error')
50 def _create_from_ptr(ptr
):
51 if ptr
is None or ptr
== native_bt
.value_null
:
54 typeid
= native_bt
.value_get_type(ptr
)
55 return _TYPE_TO_OBJ
[typeid
]._create
_from
_ptr
(ptr
)
58 def create_value(value
):
63 if isinstance(value
, _Value
):
66 if isinstance(value
, bool):
67 return BoolValue(value
)
69 if isinstance(value
, int):
70 return IntegerValue(value
)
72 if isinstance(value
, float):
73 return FloatValue(value
)
75 if isinstance(value
, str):
76 return StringValue(value
)
79 return MapValue(value
)
84 return ArrayValue(value
)
88 raise TypeError("cannot create value object from '{}' object".format(value
.__class
__.__name
__))
91 class _Value(object._Object
, object._Freezable
, metaclass
=abc
.ABCMeta
):
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('cannot create {} value object'.format(self
._NAME
.lower()))
124 def _is_frozen(self
):
125 return native_bt
.value_is_frozen(self
._ptr
)
128 status
= native_bt
.value_freeze(self
._ptr
)
129 self
._handle
_status
(status
)
134 return self
.__class
__(self
.value
)
136 def __deepcopy__(self
, memo
):
137 copy
= self
.__copy
__()
138 memo
[id(self
)] = copy
142 @functools.total_ordering
143 class _NumericValue(_Value
, _BasicCopy
):
145 def _extract_value(other
):
146 if isinstance(other
, _NumericValue
):
149 if other
is True or other
is False:
152 if isinstance(other
, numbers
.Integral
):
155 if isinstance(other
, numbers
.Real
):
158 if isinstance(other
, numbers
.Complex
):
159 return complex(other
)
161 raise TypeError("'{}' object is not a number object".format(other
.__class
__.__name
__))
164 return int(self
.value
)
167 return float(self
.value
)
170 return str(self
.value
)
172 def __lt__(self
, other
):
173 if not isinstance(other
, numbers
.Number
):
174 raise TypeError('unorderable types: {}() < {}()'.format(self
.__class
__.__name
__,
175 other
.__class
__.__name
__))
177 return self
.value
< float(other
)
179 def __le__(self
, other
):
180 if not isinstance(other
, numbers
.Number
):
181 raise TypeError('unorderable types: {}() <= {}()'.format(self
.__class
__.__name
__,
182 other
.__class
__.__name
__))
184 return self
.value
<= float(other
)
186 def _spec_eq(self
, other
):
189 def __eq__(self
, other
):
190 if not isinstance(other
, numbers
.Number
):
193 return self
.value
== complex(other
)
195 def __rmod__(self
, other
):
196 return self
._extract
_value
(other
) % self
.value
198 def __mod__(self
, other
):
199 return self
.value
% self
._extract
_value
(other
)
201 def __rfloordiv__(self
, other
):
202 return self
._extract
_value
(other
) // self
.value
204 def __floordiv__(self
, other
):
205 return self
.value
// self
._extract
_value
(other
)
207 def __round__(self
, ndigits
=None):
209 return round(self
.value
)
211 return round(self
.value
, ndigits
)
214 return math
.ceil(self
.value
)
217 return math
.floor(self
.value
)
220 return int(self
.value
)
223 return abs(self
.value
)
225 def __add__(self
, other
):
226 return self
.value
+ self
._extract
_value
(other
)
228 def __radd__(self
, other
):
229 return self
.__add
__(other
)
237 def __mul__(self
, other
):
238 return self
.value
* self
._extract
_value
(other
)
240 def __rmul__(self
, other
):
241 return self
.__mul
__(other
)
243 def __truediv__(self
, other
):
244 return self
.value
/ self
._extract
_value
(other
)
246 def __rtruediv__(self
, other
):
247 return self
._extract
_value
(other
) / self
.value
249 def __pow__(self
, exponent
):
250 return self
.value
** self
._extract
_value
(exponent
)
252 def __rpow__(self
, base
):
253 return self
._extract
_value
(base
) ** self
.value
255 def __iadd__(self
, other
):
256 self
.value
= self
+ other
259 def __isub__(self
, other
):
260 self
.value
= self
- other
263 def __imul__(self
, other
):
264 self
.value
= self
* other
267 def __itruediv__(self
, other
):
268 self
.value
= self
/ other
271 def __ifloordiv__(self
, other
):
272 self
.value
= self
// other
275 def __imod__(self
, other
):
276 self
.value
= self
% other
279 def __ipow__(self
, other
):
280 self
.value
= self
** other
284 class _IntegralValue(_NumericValue
, numbers
.Integral
):
285 def __lshift__(self
, other
):
286 return self
.value
<< self
._extract
_value
(other
)
288 def __rlshift__(self
, other
):
289 return self
._extract
_value
(other
) << self
.value
291 def __rshift__(self
, other
):
292 return self
.value
>> self
._extract
_value
(other
)
294 def __rrshift__(self
, other
):
295 return self
._extract
_value
(other
) >> self
.value
297 def __and__(self
, other
):
298 return self
.value
& self
._extract
_value
(other
)
300 def __rand__(self
, other
):
301 return self
._extract
_value
(other
) & self
.value
303 def __xor__(self
, other
):
304 return self
.value ^ self
._extract
_value
(other
)
306 def __rxor__(self
, other
):
307 return self
._extract
_value
(other
) ^ self
.value
309 def __or__(self
, other
):
310 return self
.value | self
._extract
_value
(other
)
312 def __ror__(self
, other
):
313 return self
._extract
_value
(other
) | self
.value
315 def __invert__(self
):
318 def __ilshift__(self
, other
):
319 self
.value
= self
<< other
322 def __irshift__(self
, other
):
323 self
.value
= self
>> other
326 def __iand__(self
, other
):
327 self
.value
= self
& other
330 def __ixor__(self
, other
):
331 self
.value
= self ^ other
334 def __ior__(self
, other
):
335 self
.value
= self | other
339 class _RealValue(_NumericValue
, numbers
.Real
):
343 class BoolValue(_Value
, _BasicCopy
):
346 def __init__(self
, value
=None):
348 ptr
= native_bt
.value_bool_create()
350 ptr
= native_bt
.value_bool_create_init(self
._value
_to
_bool
(value
))
352 self
._check
_create
_status
(ptr
)
353 super().__init
__(ptr
)
355 def _spec_eq(self
, other
):
356 if isinstance(other
, numbers
.Number
):
357 return self
.value
== bool(other
)
363 return str(self
.value
)
365 def _value_to_bool(self
, value
):
366 if isinstance(value
, BoolValue
):
369 if not isinstance(value
, bool):
370 raise TypeError("'{}' object is not a 'bool' or 'BoolValue' object".format(value
.__class
__))
376 status
, value
= native_bt
.value_bool_get(self
._ptr
)
377 assert(status
== native_bt
.VALUE_STATUS_OK
)
381 def value(self
, value
):
382 status
= native_bt
.value_bool_set(self
._ptr
, self
._value
_to
_bool
(value
))
383 self
._handle
_status
(status
)
386 class IntegerValue(_IntegralValue
):
389 def __init__(self
, value
=None):
391 ptr
= native_bt
.value_integer_create()
393 ptr
= native_bt
.value_integer_create_init(self
._value
_to
_int
(value
))
395 self
._check
_create
_status
(ptr
)
396 super().__init
__(ptr
)
398 def _value_to_int(self
, value
):
399 if not isinstance(value
, numbers
.Real
):
400 raise TypeError('expecting a number object')
403 utils
._check
_int
64(value
)
408 status
, value
= native_bt
.value_integer_get(self
._ptr
)
409 assert(status
== native_bt
.VALUE_STATUS_OK
)
413 def value(self
, value
):
414 status
= native_bt
.value_integer_set(self
._ptr
, self
._value
_to
_int
(value
))
415 self
._handle
_status
(status
)
418 class FloatValue(_RealValue
):
419 _NAME
= 'Floating point number'
421 def __init__(self
, value
=None):
423 ptr
= native_bt
.value_float_create()
425 value
= self
._value
_to
_float
(value
)
426 ptr
= native_bt
.value_float_create_init(value
)
428 self
._check
_create
_status
(ptr
)
429 super().__init
__(ptr
)
431 def _value_to_float(self
, value
):
432 if not isinstance(value
, numbers
.Real
):
433 raise TypeError("expecting a real number object")
439 status
, value
= native_bt
.value_float_get(self
._ptr
)
440 assert(status
== native_bt
.VALUE_STATUS_OK
)
444 def value(self
, value
):
445 value
= self
._value
_to
_float
(value
)
446 status
= native_bt
.value_float_set(self
._ptr
, value
)
447 self
._handle
_status
(status
)
450 @functools.total_ordering
451 class StringValue(_BasicCopy
, collections
.abc
.Sequence
, _Value
):
454 def __init__(self
, value
=None):
456 ptr
= native_bt
.value_string_create()
458 ptr
= native_bt
.value_string_create_init(self
._value
_to
_str
(value
))
460 self
._check
_create
_status
(ptr
)
461 super().__init
__(ptr
)
463 def _value_to_str(self
, value
):
464 if isinstance(value
, self
.__class
__):
467 utils
._check
_str
(value
)
472 status
, value
= native_bt
.value_string_get(self
._ptr
)
473 assert(status
== native_bt
.VALUE_STATUS_OK
)
477 def value(self
, value
):
478 status
= native_bt
.value_string_set(self
._ptr
, self
._value
_to
_str
(value
))
479 self
._handle
_status
(status
)
481 def _spec_eq(self
, other
):
483 return self
.value
== self
._value
_to
_str
(other
)
487 def __le__(self
, other
):
488 return self
.value
<= self
._value
_to
_str
(other
)
490 def __lt__(self
, other
):
491 return self
.value
< self
._value
_to
_str
(other
)
494 return bool(self
.value
)
499 def __getitem__(self
, index
):
500 return self
.value
[index
]
503 return len(self
.value
)
505 def __iadd__(self
, value
):
506 curvalue
= self
.value
507 curvalue
+= self
._value
_to
_str
(value
)
508 self
.value
= curvalue
514 return len(self
) != 0
517 return self
.__class
__(self
)
519 def __deepcopy__(self
, memo
):
520 ptr
= native_bt
.value_copy(self
._ptr
)
523 raise RuntimeError('unexpected error: cannot deep-copy {} value object'.format(self
._NAME
))
525 copy
= self
.__class
__._create
_from
_ptr
(ptr
)
526 memo
[id(self
)] = copy
529 def __delitem__(self
, index
):
530 raise NotImplementedError
533 class ArrayValue(_Container
, collections
.abc
.MutableSequence
, _Value
):
536 def __init__(self
, value
=None):
537 ptr
= native_bt
.value_array_create()
538 self
._check
_create
_status
(ptr
)
539 super().__init
__(ptr
)
541 # Python will raise a TypeError if there's anything wrong with
542 # the iterable protocol.
543 if value
is not None:
547 def _spec_eq(self
, other
):
549 if len(self
) != len(other
):
553 for self_elem
, other_elem
in zip(self
, other
):
554 if self_elem
!= other_elem
:
562 size
= native_bt
.value_array_size(self
._ptr
)
566 def _check_index(self
, index
):
567 # TODO: support slices also
568 if not isinstance(index
, numbers
.Integral
):
569 raise TypeError("'{}' object is not an integral number object: invalid index".format(index
.__class
__.__name
__))
573 if index
< 0 or index
>= len(self
):
574 raise IndexError('array value object index is out of range')
576 def __getitem__(self
, index
):
577 self
._check
_index
(index
)
578 ptr
= native_bt
.value_array_get(self
._ptr
, index
)
580 return _create_from_ptr(ptr
)
582 def __setitem__(self
, index
, value
):
583 self
._check
_index
(index
)
584 value
= create_value(value
)
587 ptr
= native_bt
.value_null
591 status
= native_bt
.value_array_set(self
._ptr
, index
, ptr
)
592 self
._handle
_status
(status
)
594 def append(self
, value
):
595 value
= create_value(value
)
598 ptr
= native_bt
.value_null
602 status
= native_bt
.value_array_append(self
._ptr
, ptr
)
603 self
._handle
_status
(status
)
605 def __iadd__(self
, iterable
):
606 # Python will raise a TypeError if there's anything wrong with
607 # the iterable protocol.
608 for elem
in iterable
:
617 if isinstance(elem
, StringValue
):
618 strings
.append(repr(elem
.value
))
620 strings
.append(str(elem
))
622 return '[{}]'.format(', '.join(strings
))
624 def insert(self
, value
):
625 raise NotImplementedError
628 class _MapValueKeyIterator(collections
.abc
.Iterator
):
629 def __init__(self
, map_obj
):
630 self
._map
_obj
= map_obj
632 keys_ptr
= native_bt
.value_map_get_keys_private(map_obj
._ptr
)
635 raise RuntimeError('unexpected error: cannot get map value object keys')
637 self
._keys
= _create_from_ptr(keys_ptr
)
640 if self
._at
== len(self
._map
_obj
):
643 key
= self
._keys
[self
._at
]
648 class MapValue(_Container
, collections
.abc
.MutableMapping
, _Value
):
651 def __init__(self
, value
=None):
652 ptr
= native_bt
.value_map_create()
653 self
._check
_create
_status
(ptr
)
654 super().__init
__(ptr
)
656 # Python will raise a TypeError if there's anything wrong with
657 # the iterable/mapping protocol.
658 if value
is not None:
659 for key
, elem
in value
.items():
662 def __eq__(self
, other
):
663 return _Value
.__eq
__(self
, other
)
665 def __ne__(self
, other
):
666 return _Value
.__ne
__(self
, other
)
668 def _spec_eq(self
, other
):
670 if len(self
) != len(other
):
674 for self_key
in self
:
675 if self_key
not in other
:
678 self_value
= self
[self_key
]
679 other_value
= other
[self_key
]
681 if self_value
!= other_value
:
689 size
= native_bt
.value_map_size(self
._ptr
)
693 def __contains__(self
, key
):
694 self
._check
_key
_type
(key
)
695 return native_bt
.value_map_has_key(self
._ptr
, key
)
697 def _check_key_type(self
, key
):
698 utils
._check
_str
(key
)
700 def _check_key(self
, key
):
704 def __getitem__(self
, key
):
706 ptr
= native_bt
.value_map_get(self
._ptr
, key
)
708 return _create_from_ptr(ptr
)
711 return _MapValueKeyIterator(self
)
713 def __setitem__(self
, key
, value
):
714 self
._check
_key
_type
(key
)
715 value
= create_value(value
)
718 ptr
= native_bt
.value_null
722 status
= native_bt
.value_map_insert(self
._ptr
, key
, ptr
)
723 self
._handle
_status
(status
)
728 for key
, elem
in self
.items():
729 if isinstance(elem
, StringValue
):
730 value
= repr(elem
.value
)
734 strings
.append('{}: {}'.format(repr(key
), value
))
736 return '{{{}}}'.format(', '.join(strings
))
740 native_bt
.VALUE_TYPE_BOOL
: BoolValue
,
741 native_bt
.VALUE_TYPE_INTEGER
: IntegerValue
,
742 native_bt
.VALUE_TYPE_FLOAT
: FloatValue
,
743 native_bt
.VALUE_TYPE_STRING
: StringValue
,
744 native_bt
.VALUE_TYPE_ARRAY
: ArrayValue
,
745 native_bt
.VALUE_TYPE_MAP
: MapValue
,
This page took 0.05193 seconds and 6 git commands to generate.