X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fbindings%2Fpython%2Fbt2%2Fbt2%2Ffield.py;h=40ce52c52adc7b47e0dd5e34f67ae525267508dc;hb=f5567ea88d172767b34373bc6e402da8bfd85ef8;hp=fbe609eedb473377a3a16ff55ac4091540626bc0;hpb=1198c63595288e43f354d8cce6db1e69a38d3a20;p=babeltrace.git diff --git a/src/bindings/python/bt2/bt2/field.py b/src/bindings/python/bt2/bt2/field.py index fbe609ee..40ce52c5 100644 --- a/src/bindings/python/bt2/bt2/field.py +++ b/src/bindings/python/bt2/bt2/field.py @@ -1,24 +1,6 @@ -# The MIT License (MIT) +# SPDX-License-Identifier: MIT # # Copyright (c) 2017 Philippe Proulx -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. from bt2 import native_bt, object, utils from bt2 import field_class as bt2_field_class @@ -101,7 +83,7 @@ class _Field(_FieldConst): class _BitArrayFieldConst(_FieldConst): - _NAME = 'Const bit array' + _NAME = "Const bit array" @property def value_as_integer(self): @@ -124,7 +106,7 @@ class _BitArrayFieldConst(_FieldConst): class _BitArrayField(_BitArrayFieldConst, _Field): - _NAME = 'Bit array' + _NAME = "Bit array" def _value_as_integer(self, value): utils._check_uint64(value) @@ -167,7 +149,7 @@ class _NumericFieldConst(_FieldConst): def __lt__(self, other): if not isinstance(other, numbers.Number): raise TypeError( - 'unorderable types: {}() < {}()'.format( + "unorderable types: {}() < {}()".format( self.__class__.__name__, other.__class__.__name__ ) ) @@ -248,7 +230,7 @@ class _NumericField(_NumericFieldConst, _Field): def __hash__(self): # Non const field are not hashable as their value may be modified # without changing the underlying Python object. - raise TypeError('unhashable type: \'{}\''.format(self._NAME)) + raise TypeError("unhashable type: '{}'".format(self._NAME)) class _IntegralFieldConst(_NumericFieldConst, numbers.Integral): @@ -291,7 +273,7 @@ class _IntegralField(_IntegralFieldConst, _NumericField): class _BoolFieldConst(_IntegralFieldConst, _FieldConst): - _NAME = 'Const boolean' + _NAME = "Const boolean" def __bool__(self): return self._value @@ -316,7 +298,7 @@ class _BoolFieldConst(_IntegralFieldConst, _FieldConst): class _BoolField(_BoolFieldConst, _IntegralField, _Field): - _NAME = 'Boolean' + _NAME = "Boolean" def _set_value(self, value): value = self._value_to_bool(value) @@ -340,12 +322,12 @@ class _IntegerField(_IntegerFieldConst, _IntegralField, _Field): class _UnsignedIntegerFieldConst(_IntegerFieldConst, _FieldConst): - _NAME = 'Const unsigned integer' + _NAME = "Const unsigned integer" @classmethod def _value_to_int(cls, value): if not isinstance(value, numbers.Integral): - raise TypeError('expecting an integral number object') + raise TypeError("expecting an integral number object") return int(value) @@ -355,7 +337,7 @@ class _UnsignedIntegerFieldConst(_IntegerFieldConst, _FieldConst): class _UnsignedIntegerField(_UnsignedIntegerFieldConst, _IntegerField, _Field): - _NAME = 'Unsigned integer' + _NAME = "Unsigned integer" def _set_value(self, value): value = self._value_to_int(value) @@ -372,16 +354,16 @@ class _UnsignedIntegerField(_UnsignedIntegerFieldConst, _IntegerField, _Field): @property def _upper_bound(self): - return (2 ** self.cls.field_value_range) - 1 + return (2**self.cls.field_value_range) - 1 class _SignedIntegerFieldConst(_IntegerFieldConst, _FieldConst): - _NAME = 'Const signed integer' + _NAME = "Const signed integer" @classmethod def _value_to_int(cls, value): if not isinstance(value, numbers.Integral): - raise TypeError('expecting an integral number object') + raise TypeError("expecting an integral number object") return int(value) @@ -391,7 +373,7 @@ class _SignedIntegerFieldConst(_IntegerFieldConst, _FieldConst): class _SignedIntegerField(_SignedIntegerFieldConst, _IntegerField, _Field): - _NAME = 'Signed integer' + _NAME = "Signed integer" def _set_value(self, value): value = self._value_to_int(value) @@ -412,7 +394,7 @@ class _SignedIntegerField(_SignedIntegerFieldConst, _IntegerField, _Field): class _RealFieldConst(_NumericFieldConst, numbers.Real): - _NAME = 'Const real' + _NAME = "Const real" @classmethod def _value_to_float(cls, value): @@ -421,24 +403,50 @@ class _RealFieldConst(_NumericFieldConst, numbers.Real): return float(value) + +class _SinglePrecisionRealFieldConst(_RealFieldConst): + _NAME = "Const single-precision real" + @property def _value(self): - return native_bt.field_real_get_value(self._ptr) + return native_bt.field_real_single_precision_get_value(self._ptr) + + +class _DoublePrecisionRealFieldConst(_RealFieldConst): + _NAME = "Const double-precision real" + + @property + def _value(self): + return native_bt.field_real_double_precision_get_value(self._ptr) class _RealField(_RealFieldConst, _NumericField): - _NAME = 'Real' + _NAME = "Real" + + +class _SinglePrecisionRealField(_SinglePrecisionRealFieldConst, _RealField): + _NAME = "Single-precision real" def _set_value(self, value): value = self._value_to_float(value) - native_bt.field_real_set_value(self._ptr, value) + native_bt.field_real_single_precision_set_value(self._ptr, value) + + value = property(fset=_set_value) + + +class _DoublePrecisionRealField(_DoublePrecisionRealFieldConst, _RealField): + _NAME = "Double-precision real" + + def _set_value(self, value): + value = self._value_to_float(value) + native_bt.field_real_double_precision_set_value(self._ptr, value) value = property(fset=_set_value) class _EnumerationFieldConst(_IntegerFieldConst): def _repr(self): - return '{} ({})'.format(self._value, ', '.join(self.labels)) + return "{} ({})".format(self._value, ", ".join(self.labels)) @property def labels(self): @@ -456,7 +464,7 @@ class _EnumerationField(_EnumerationFieldConst, _IntegerField): class _UnsignedEnumerationFieldConst( _EnumerationFieldConst, _UnsignedIntegerFieldConst ): - _NAME = 'Const unsigned Enumeration' + _NAME = "Const unsigned Enumeration" _get_mapping_labels = staticmethod( native_bt.field_enumeration_unsigned_get_mapping_labels ) @@ -465,11 +473,11 @@ class _UnsignedEnumerationFieldConst( class _UnsignedEnumerationField( _UnsignedEnumerationFieldConst, _EnumerationField, _UnsignedIntegerField ): - _NAME = 'Unsigned enumeration' + _NAME = "Unsigned enumeration" class _SignedEnumerationFieldConst(_EnumerationFieldConst, _SignedIntegerFieldConst): - _NAME = 'Const signed Enumeration' + _NAME = "Const signed Enumeration" _get_mapping_labels = staticmethod( native_bt.field_enumeration_signed_get_mapping_labels ) @@ -478,12 +486,12 @@ class _SignedEnumerationFieldConst(_EnumerationFieldConst, _SignedIntegerFieldCo class _SignedEnumerationField( _SignedEnumerationFieldConst, _EnumerationField, _SignedIntegerField ): - _NAME = 'Signed enumeration' + _NAME = "Signed enumeration" @functools.total_ordering class _StringFieldConst(_FieldConst): - _NAME = 'Const string' + _NAME = "Const string" @classmethod def _value_to_str(cls, value): @@ -528,7 +536,7 @@ class _StringFieldConst(_FieldConst): class _StringField(_StringFieldConst, _Field): - _NAME = 'String' + _NAME = "String" def _set_value(self, value): value = self._value_to_str(value) @@ -547,7 +555,7 @@ class _StringField(_StringFieldConst, _Field): def __hash__(self): # Non const field are not hashable as their value may be modified # without changing the underlying Python object. - raise TypeError('unhashable type: \'{}\''.format(self._NAME)) + raise TypeError("unhashable type: '{}'".format(self._NAME)) class _ContainerFieldConst(_FieldConst): @@ -567,7 +575,7 @@ class _ContainerFieldConst(_FieldConst): def __setitem__(self, index, value): raise TypeError( - '\'{}\' object does not support item assignment'.format(self.__class__) + "'{}' object does not support item assignment".format(self.__class__) ) @@ -576,7 +584,7 @@ class _ContainerField(_ContainerFieldConst, _Field): class _StructureFieldConst(_ContainerFieldConst, collections.abc.Mapping): - _NAME = 'Const structure' + _NAME = "Const structure" _borrow_member_field_ptr_by_index = staticmethod( native_bt.field_structure_borrow_member_field_by_index_const ) @@ -609,8 +617,8 @@ class _StructureFieldConst(_ContainerFieldConst, collections.abc.Mapping): return True def _repr(self): - items = ['{}: {}'.format(repr(k), repr(v)) for k, v in self.items()] - return '{{{}}}'.format(', '.join(items)) + items = ["{}: {}".format(repr(k), repr(v)) for k, v in self.items()] + return "{{{}}}".format(", ".join(items)) def __getitem__(self, key): utils._check_str(key) @@ -638,7 +646,7 @@ class _StructureFieldConst(_ContainerFieldConst, collections.abc.Mapping): class _StructureField( _StructureFieldConst, _ContainerField, collections.abc.MutableMapping ): - _NAME = 'Structure' + _NAME = "Structure" _borrow_member_field_ptr_by_index = staticmethod( native_bt.field_structure_borrow_member_field_by_index ) @@ -665,7 +673,7 @@ class _StructureField( class _OptionFieldConst(_FieldConst): - _NAME = 'Const option' + _NAME = "Const option" _borrow_field_ptr = staticmethod(native_bt.field_option_borrow_field_const) @property @@ -697,7 +705,7 @@ class _OptionFieldConst(_FieldConst): class _OptionField(_OptionFieldConst, _Field): - _NAME = 'Option' + _NAME = "Option" _borrow_field_ptr = staticmethod(native_bt.field_option_borrow_field) def _has_field(self, value): @@ -716,7 +724,7 @@ class _OptionField(_OptionFieldConst, _Field): class _VariantFieldConst(_ContainerFieldConst, _FieldConst): - _NAME = 'Const variant' + _NAME = "Const variant" _borrow_selected_option_field_ptr = staticmethod( native_bt.field_variant_borrow_selected_option_field_const ) @@ -726,7 +734,7 @@ class _VariantFieldConst(_ContainerFieldConst, _FieldConst): @property def selected_option_index(self): - return native_bt.field_variant_get_selected_option_field_index(self._ptr) + return native_bt.field_variant_get_selected_option_index(self._ptr) @property def selected_option(self): @@ -753,16 +761,16 @@ class _VariantFieldConst(_ContainerFieldConst, _FieldConst): class _VariantField(_VariantFieldConst, _ContainerField, _Field): - _NAME = 'Variant' + _NAME = "Variant" _borrow_selected_option_field_ptr = staticmethod( native_bt.field_variant_borrow_selected_option_field ) def _selected_option_index(self, index): if index < 0 or index >= len(self): - raise IndexError('{} field object index is out of range'.format(self._NAME)) + raise IndexError("{} field object index is out of range".format(self._NAME)) - native_bt.field_variant_select_option_field_by_index(self._ptr, index) + native_bt.field_variant_select_option_by_index(self._ptr, index) selected_option_index = property( fget=_VariantFieldConst.selected_option_index.fget, fset=_selected_option_index @@ -795,7 +803,7 @@ class _ArrayFieldConst(_ContainerFieldConst, _FieldConst, collections.abc.Sequen index = int(index) if index < 0 or index >= len(self): - raise IndexError('{} field object index is out of range'.format(self._NAME)) + raise IndexError("{} field object index is out of range".format(self._NAME)) field_ptr = self._borrow_element_field_ptr_by_index(self._ptr, index) assert field_ptr @@ -821,7 +829,7 @@ class _ArrayFieldConst(_ContainerFieldConst, _FieldConst, collections.abc.Sequen return True def _repr(self): - return '[{}]'.format(', '.join([repr(v) for v in self])) + return "[{}]".format(", ".join([repr(v) for v in self])) class _ArrayField( @@ -836,7 +844,7 @@ class _ArrayField( field = self[index] if not isinstance(field, (_NumericField, _StringField)): - raise TypeError('can only set the value of a number or string field') + raise TypeError("can only set the value of a number or string field") # the field's property does the appropriate conversion or raises # the appropriate exception @@ -844,18 +852,22 @@ class _ArrayField( class _StaticArrayFieldConst(_ArrayFieldConst, _FieldConst): - _NAME = 'Const static array' + _NAME = "Const static array" def _count(self): return native_bt.field_array_get_length(self._ptr) class _StaticArrayField(_StaticArrayFieldConst, _ArrayField, _Field): - _NAME = 'Static array' + _NAME = "Static array" def _set_value(self, values): if len(self) != len(values): - raise ValueError('expected length of value and array field to match') + raise ValueError( + "expected length of value ({}) and array field ({}) to match".format( + len(values), len(self) + ) + ) for index, value in enumerate(values): if value is not None: @@ -865,14 +877,14 @@ class _StaticArrayField(_StaticArrayFieldConst, _ArrayField, _Field): class _DynamicArrayFieldConst(_ArrayFieldConst, _FieldConst): - _NAME = 'Const dynamic array' + _NAME = "Const dynamic array" def _count(self): return self.length class _DynamicArrayField(_DynamicArrayFieldConst, _ArrayField, _Field): - _NAME = 'Dynamic array' + _NAME = "Dynamic array" def _set_length(self, length): utils._check_uint64(length) @@ -897,17 +909,22 @@ _TYPE_ID_TO_CONST_OBJ = { native_bt.FIELD_CLASS_TYPE_BIT_ARRAY: _BitArrayFieldConst, native_bt.FIELD_CLASS_TYPE_UNSIGNED_INTEGER: _UnsignedIntegerFieldConst, native_bt.FIELD_CLASS_TYPE_SIGNED_INTEGER: _SignedIntegerFieldConst, - native_bt.FIELD_CLASS_TYPE_REAL: _RealFieldConst, + native_bt.FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL: _SinglePrecisionRealFieldConst, + native_bt.FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL: _DoublePrecisionRealFieldConst, native_bt.FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION: _UnsignedEnumerationFieldConst, native_bt.FIELD_CLASS_TYPE_SIGNED_ENUMERATION: _SignedEnumerationFieldConst, native_bt.FIELD_CLASS_TYPE_STRING: _StringFieldConst, native_bt.FIELD_CLASS_TYPE_STRUCTURE: _StructureFieldConst, native_bt.FIELD_CLASS_TYPE_STATIC_ARRAY: _StaticArrayFieldConst, - native_bt.FIELD_CLASS_TYPE_DYNAMIC_ARRAY: _DynamicArrayFieldConst, - native_bt.FIELD_CLASS_TYPE_OPTION: _OptionFieldConst, - native_bt.FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR: _VariantFieldConst, - native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR: _VariantFieldConst, - native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR: _VariantFieldConst, + native_bt.FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD: _DynamicArrayFieldConst, + native_bt.FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD: _DynamicArrayFieldConst, + native_bt.FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD: _OptionFieldConst, + native_bt.FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD: _OptionFieldConst, + native_bt.FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD: _OptionFieldConst, + native_bt.FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD: _OptionFieldConst, + native_bt.FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD: _VariantFieldConst, + native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD: _VariantFieldConst, + native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD: _VariantFieldConst, } _TYPE_ID_TO_OBJ = { @@ -915,15 +932,20 @@ _TYPE_ID_TO_OBJ = { native_bt.FIELD_CLASS_TYPE_BIT_ARRAY: _BitArrayField, native_bt.FIELD_CLASS_TYPE_UNSIGNED_INTEGER: _UnsignedIntegerField, native_bt.FIELD_CLASS_TYPE_SIGNED_INTEGER: _SignedIntegerField, - native_bt.FIELD_CLASS_TYPE_REAL: _RealField, + native_bt.FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL: _SinglePrecisionRealField, + native_bt.FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL: _DoublePrecisionRealField, native_bt.FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION: _UnsignedEnumerationField, native_bt.FIELD_CLASS_TYPE_SIGNED_ENUMERATION: _SignedEnumerationField, native_bt.FIELD_CLASS_TYPE_STRING: _StringField, native_bt.FIELD_CLASS_TYPE_STRUCTURE: _StructureField, native_bt.FIELD_CLASS_TYPE_STATIC_ARRAY: _StaticArrayField, - native_bt.FIELD_CLASS_TYPE_DYNAMIC_ARRAY: _DynamicArrayField, - native_bt.FIELD_CLASS_TYPE_OPTION: _OptionField, - native_bt.FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR: _VariantField, - native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR: _VariantField, - native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR: _VariantField, + native_bt.FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD: _DynamicArrayField, + native_bt.FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD: _DynamicArrayField, + native_bt.FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD: _OptionField, + native_bt.FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD: _OptionField, + native_bt.FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD: _OptionField, + native_bt.FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD: _OptionField, + native_bt.FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD: _VariantField, + native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD: _VariantField, + native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD: _VariantField, }