Remove `skip-string-normalization` in Python formatter config
[babeltrace.git] / src / bindings / python / bt2 / bt2 / trace_class.py
index 08d3e91f400c79e812fe091a61f9c36261c85186..f66f385527934d5348e8e83ed9aa3730396db293 100644 (file)
@@ -1,26 +1,8 @@
-# The MIT License (MIT)
+# SPDX-License-Identifier: MIT
 #
 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
 # Copyright (c) 2018 Francis Deslauriers <francis.deslauriers@efficios.com>
 # Copyright (c) 2019 Simon Marchi <simon.marchi@efficios.com>
-#
-# 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, utils, object
 from bt2 import stream_class as bt2_stream_class
@@ -33,9 +15,12 @@ import functools
 import bt2
 
 
-def _trace_class_destruction_listener_from_native(user_listener, trace_class_ptr):
+def _trace_class_destruction_listener_from_native(
+    user_listener, handle, trace_class_ptr
+):
     trace_class = _TraceClass._create_from_ptr_and_get_ref(trace_class_ptr)
     user_listener(trace_class)
+    handle._invalidate()
 
 
 class _TraceClassConst(object._SharedObject, collections.abc.Mapping):
@@ -100,36 +85,40 @@ class _TraceClassConst(object._SharedObject, collections.abc.Mapping):
         if not callable(listener):
             raise TypeError("'listener' parameter is not callable")
 
-        fn = native_bt.bt2_trace_class_add_destruction_listener
+        handle = utils._ListenerHandle(self.addr)
+
         listener_from_native = functools.partial(
-            _trace_class_destruction_listener_from_native, listener
+            _trace_class_destruction_listener_from_native, listener, handle
         )
 
+        fn = native_bt.bt2_trace_class_add_destruction_listener
         status, listener_id = fn(self._ptr, listener_from_native)
         utils._handle_func_status(
-            status, 'cannot add destruction listener to trace class object'
+            status, "cannot add destruction listener to trace class object"
         )
 
-        return utils._ListenerHandle(listener_id, self)
+        handle._set_listener_id(listener_id)
+
+        return handle
 
     def remove_destruction_listener(self, listener_handle):
         utils._check_type(listener_handle, utils._ListenerHandle)
 
-        if listener_handle._obj.addr != self.addr:
+        if listener_handle._addr != self.addr:
             raise ValueError(
-                'This trace class destruction listener does not match the trace object.'
+                "This trace class destruction listener does not match the trace class object."
             )
 
         if listener_handle._listener_id is None:
             raise ValueError(
-                'This trace class destruction listener was already removed.'
+                "This trace class destruction listener was already removed."
             )
 
         status = native_bt.trace_class_remove_destruction_listener(
             self._ptr, listener_handle._listener_id
         )
         utils._handle_func_status(status)
-        listener_handle._listener_id = None
+        listener_handle._invalidate()
 
 
 class _TraceClass(_TraceClassConst):
@@ -153,7 +142,7 @@ class _TraceClass(_TraceClassConst):
         trace_ptr = native_bt.trace_create(self._ptr)
 
         if trace_ptr is None:
-            raise bt2._MemoryError('cannot create trace class object')
+            raise bt2._MemoryError("cannot create trace class object")
 
         trace = bt2_trace._Trace._create_from_ptr(trace_ptr)
 
@@ -211,14 +200,14 @@ class _TraceClass(_TraceClassConst):
         if self.assigns_automatic_stream_class_id:
             if id is not None:
                 raise ValueError(
-                    'id provided, but trace class assigns automatic stream class ids'
+                    "id provided, but trace class assigns automatic stream class ids"
                 )
 
             sc_ptr = native_bt.stream_class_create(self._ptr)
         else:
             if id is None:
                 raise ValueError(
-                    'id not provided, but trace class does not assign automatic stream class ids'
+                    "id not provided, but trace class does not assign automatic stream class ids"
                 )
 
             utils._check_uint64(id)
@@ -285,7 +274,7 @@ class _TraceClass(_TraceClassConst):
 
     def _check_field_class_create_status(self, ptr, type_name):
         if ptr is None:
-            raise bt2._MemoryError('cannot create {} field class'.format(type_name))
+            raise bt2._MemoryError("cannot create {} field class".format(type_name))
 
     @staticmethod
     def _set_field_class_user_attrs(fc, user_attributes):
@@ -294,7 +283,7 @@ class _TraceClass(_TraceClassConst):
 
     def create_bool_field_class(self, user_attributes=None):
         field_class_ptr = native_bt.field_class_bool_create(self._ptr)
-        self._check_field_class_create_status(field_class_ptr, 'boolean')
+        self._check_field_class_create_status(field_class_ptr, "boolean")
         fc = bt2_field_class._BoolFieldClass._create_from_ptr(field_class_ptr)
         self._set_field_class_user_attrs(fc, user_attributes)
         return fc
@@ -304,13 +293,13 @@ class _TraceClass(_TraceClassConst):
 
         if length < 1 or length > 64:
             raise ValueError(
-                'invalid length {}: expecting a value in the [1, 64] range'.format(
+                "invalid length {}: expecting a value in the [1, 64] range".format(
                     length
                 )
             )
 
         field_class_ptr = native_bt.field_class_bit_array_create(self._ptr, length)
-        self._check_field_class_create_status(field_class_ptr, 'bit array')
+        self._check_field_class_create_status(field_class_ptr, "bit array")
         fc = bt2_field_class._BitArrayFieldClass._create_from_ptr(field_class_ptr)
         self._set_field_class_user_attrs(fc, user_attributes)
         return fc
@@ -344,7 +333,7 @@ class _TraceClass(_TraceClassConst):
         return self._create_integer_field_class(
             native_bt.field_class_integer_signed_create,
             bt2_field_class._SignedIntegerFieldClass,
-            'signed integer',
+            "signed integer",
             field_value_range,
             preferred_display_base,
             user_attributes,
@@ -356,7 +345,7 @@ class _TraceClass(_TraceClassConst):
         return self._create_integer_field_class(
             native_bt.field_class_integer_unsigned_create,
             bt2_field_class._UnsignedIntegerFieldClass,
-            'unsigned integer',
+            "unsigned integer",
             field_value_range,
             preferred_display_base,
             user_attributes,
@@ -368,7 +357,7 @@ class _TraceClass(_TraceClassConst):
         return self._create_integer_field_class(
             native_bt.field_class_enumeration_signed_create,
             bt2_field_class._SignedEnumerationFieldClass,
-            'signed enumeration',
+            "signed enumeration",
             field_value_range,
             preferred_display_base,
             user_attributes,
@@ -380,7 +369,7 @@ class _TraceClass(_TraceClassConst):
         return self._create_integer_field_class(
             native_bt.field_class_enumeration_unsigned_create,
             bt2_field_class._UnsignedEnumerationFieldClass,
-            'unsigned enumeration',
+            "unsigned enumeration",
             field_value_range,
             preferred_display_base,
             user_attributes,
@@ -388,7 +377,7 @@ class _TraceClass(_TraceClassConst):
 
     def create_single_precision_real_field_class(self, user_attributes=None):
         field_class_ptr = native_bt.field_class_real_single_precision_create(self._ptr)
-        self._check_field_class_create_status(field_class_ptr, 'single-precision real')
+        self._check_field_class_create_status(field_class_ptr, "single-precision real")
 
         field_class = bt2_field_class._SinglePrecisionRealFieldClass._create_from_ptr(
             field_class_ptr
@@ -400,7 +389,7 @@ class _TraceClass(_TraceClassConst):
 
     def create_double_precision_real_field_class(self, user_attributes=None):
         field_class_ptr = native_bt.field_class_real_double_precision_create(self._ptr)
-        self._check_field_class_create_status(field_class_ptr, 'double-precision real')
+        self._check_field_class_create_status(field_class_ptr, "double-precision real")
 
         field_class = bt2_field_class._DoublePrecisionRealFieldClass._create_from_ptr(
             field_class_ptr
@@ -412,14 +401,14 @@ class _TraceClass(_TraceClassConst):
 
     def create_structure_field_class(self, user_attributes=None):
         field_class_ptr = native_bt.field_class_structure_create(self._ptr)
-        self._check_field_class_create_status(field_class_ptr, 'structure')
+        self._check_field_class_create_status(field_class_ptr, "structure")
         fc = bt2_field_class._StructureFieldClass._create_from_ptr(field_class_ptr)
         self._set_field_class_user_attrs(fc, user_attributes)
         return fc
 
     def create_string_field_class(self, user_attributes=None):
         field_class_ptr = native_bt.field_class_string_create(self._ptr)
-        self._check_field_class_create_status(field_class_ptr, 'string')
+        self._check_field_class_create_status(field_class_ptr, "string")
         fc = bt2_field_class._StringFieldClass._create_from_ptr(field_class_ptr)
         self._set_field_class_user_attrs(fc, user_attributes)
         return fc
@@ -428,8 +417,8 @@ class _TraceClass(_TraceClassConst):
         utils._check_type(elem_fc, bt2_field_class._FieldClass)
         utils._check_uint64(length)
         ptr = native_bt.field_class_array_static_create(self._ptr, elem_fc._ptr, length)
-        self._check_field_class_create_status(ptr, 'static array')
-        fc = bt2_field_class._StaticArrayFieldClass._create_from_ptr_and_get_ref(ptr)
+        self._check_field_class_create_status(ptr, "static array")
+        fc = bt2_field_class._StaticArrayFieldClass._create_from_ptr(ptr)
         self._set_field_class_user_attrs(fc, user_attributes)
         return fc
 
@@ -446,8 +435,8 @@ class _TraceClass(_TraceClassConst):
         ptr = native_bt.field_class_array_dynamic_create(
             self._ptr, elem_fc._ptr, length_fc_ptr
         )
-        self._check_field_class_create_status(ptr, 'dynamic array')
-        fc = bt2_field_class._create_field_class_from_ptr_and_get_ref(ptr)
+        self._check_field_class_create_status(ptr, "dynamic array")
+        fc = bt2_field_class._obj_type_from_field_class_ptr(ptr)._create_from_ptr(ptr)
         self._set_field_class_user_attrs(fc, user_attributes)
         return fc
 
@@ -458,8 +447,8 @@ class _TraceClass(_TraceClassConst):
         ptr = native_bt.field_class_option_without_selector_create(
             self._ptr, content_fc._ptr
         )
-        self._check_field_class_create_status(ptr, 'option')
-        fc = bt2_field_class._create_field_class_from_ptr_and_get_ref(ptr)
+        self._check_field_class_create_status(ptr, "option")
+        fc = bt2_field_class._obj_type_from_field_class_ptr(ptr)._create_from_ptr(ptr)
         self._set_field_class_user_attrs(fc, user_attributes)
         return fc
 
@@ -472,8 +461,8 @@ class _TraceClass(_TraceClassConst):
         ptr = native_bt.field_class_option_with_selector_field_bool_create(
             self._ptr, content_fc._ptr, selector_fc._ptr
         )
-        self._check_field_class_create_status(ptr, 'option')
-        fc = bt2_field_class._create_field_class_from_ptr_and_get_ref(ptr)
+        self._check_field_class_create_status(ptr, "option")
+        fc = bt2_field_class._obj_type_from_field_class_ptr(ptr)._create_from_ptr(ptr)
         self._set_field_class_user_attrs(fc, user_attributes)
         fc._selector_is_reversed = selector_is_reversed
         return fc
@@ -485,7 +474,7 @@ class _TraceClass(_TraceClassConst):
         utils._check_type(selector_fc, bt2_field_class._IntegerFieldClass)
 
         if len(ranges) == 0:
-            raise ValueError('integer range set is empty')
+            raise ValueError("integer range set is empty")
 
         if isinstance(selector_fc, bt2_field_class._UnsignedIntegerFieldClass):
             utils._check_type(ranges, bt2_integer_range_set.UnsignedIntegerRangeSet)
@@ -494,12 +483,14 @@ class _TraceClass(_TraceClassConst):
             )
         else:
             utils._check_type(ranges, bt2_integer_range_set.SignedIntegerRangeSet)
-            ptr = native_bt.field_class_option_with_selector_field_integer_signed_create(
-                self._ptr, content_fc._ptr, selector_fc._ptr, ranges._ptr
+            ptr = (
+                native_bt.field_class_option_with_selector_field_integer_signed_create(
+                    self._ptr, content_fc._ptr, selector_fc._ptr, ranges._ptr
+                )
             )
 
-        self._check_field_class_create_status(ptr, 'option')
-        fc = bt2_field_class._create_field_class_from_ptr_and_get_ref(ptr)
+        self._check_field_class_create_status(ptr, "option")
+        fc = bt2_field_class._obj_type_from_field_class_ptr(ptr)._create_from_ptr(ptr)
         self._set_field_class_user_attrs(fc, user_attributes)
         return fc
 
@@ -511,7 +502,7 @@ class _TraceClass(_TraceClassConst):
             selector_fc_ptr = selector_fc._ptr
 
         ptr = native_bt.field_class_variant_create(self._ptr, selector_fc_ptr)
-        self._check_field_class_create_status(ptr, 'variant')
-        fc = bt2_field_class._create_field_class_from_ptr_and_get_ref(ptr)
+        self._check_field_class_create_status(ptr, "variant")
+        fc = bt2_field_class._obj_type_from_field_class_ptr(ptr)._create_from_ptr(ptr)
         self._set_field_class_user_attrs(fc, user_attributes)
         return fc
This page took 0.029031 seconds and 4 git commands to generate.