bt2: EnumerationFieldType: rename append_mapping() -> add_mapping()

We're not _appending_ anything in bt2.EnumerationFieldType here, as
opposed to bt2.StructureFieldType (which contains ordered fields), so
the method should be named add_mapping(), like a Python set has the
add() method, whereas a Python list has the append() method.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>

diff --git a/bindings/python/babeltrace/babeltrace/writer.py b/bindings/python/babeltrace/babeltrace/writer.py
index b80b178b057c53983e95f059bd35d22dd7e86193..21b7e6f5cb6395c63bef842411250db4c70796b8 100644 (file)
--- a/bindings/python/babeltrace/babeltrace/writer.py
+++ b/bindings/python/babeltrace/babeltrace/writer.py
@@ -559,7 +559,7 @@ class EnumerationFieldDeclaration(FieldDeclaration):
         """
 
         try:
-            self._field_type.append_mapping(name, range_start, range_end)
+            self._field_type.add_mapping(name, range_start, range_end)
         except:
             raise ValueError(
                 "Could not add mapping to enumeration declaration.")

diff --git a/bindings/python/bt2/bt2/field_types.py b/bindings/python/bt2/bt2/field_types.py
index d954ffdd4e138615273585a1705b4df8cf02cf21..b6c68aaf9e19074ace5282ef35470f17f4dce96a 100644 (file)
--- a/bindings/python/bt2/bt2/field_types.py
+++ b/bindings/python/bt2/bt2/field_types.py
@@ -430,7 +430,7 @@ class EnumerationFieldType(IntegerFieldType, collections.abc.Sequence):
 
         return self._get_mapping_iter(iter_ptr)
 
-    def append_mapping(self, name, lower, upper=None):
+    def add_mapping(self, name, lower, upper=None):
         utils._check_str(name)
 
         if upper is None:
@@ -450,7 +450,7 @@ class EnumerationFieldType(IntegerFieldType, collections.abc.Sequence):
 
     def __iadd__(self, mappings):
         for mapping in mappings:
-            self.append_mapping(mapping.name, mapping.lower, mapping.upper)
+            self.add_mapping(mapping.name, mapping.lower, mapping.upper)
 
         return self
 

diff --git a/tests/bindings/python/babeltrace/test_reader_field_declaration.py b/tests/bindings/python/babeltrace/test_reader_field_declaration.py
index baa15be3887e1c7e8c4ac59ad35bac775d46fe3c..b552cab6fc90ef3cb04af3812d6f73aa80ab793d 100644 (file)
--- a/tests/bindings/python/babeltrace/test_reader_field_declaration.py
+++ b/tests/bindings/python/babeltrace/test_reader_field_declaration.py
@@ -47,10 +47,10 @@ class FieldDeclarationTestCase(unittest.TestCase):
         int_ft = bt2.IntegerFieldType(32)
 
         enum_ft = bt2.EnumerationFieldType(int_ft)
-        enum_ft.append_mapping('corner', 23)
-        enum_ft.append_mapping('zoom', 17, 20)
-        enum_ft.append_mapping('mellotron', 1001)
-        enum_ft.append_mapping('giorgio', 2000, 3000)
+        enum_ft.add_mapping('corner', 23)
+        enum_ft.add_mapping('zoom', 17, 20)
+        enum_ft.add_mapping('mellotron', 1001)
+        enum_ft.add_mapping('giorgio', 2000, 3000)
 
         array_ft = bt2.ArrayFieldType(int_ft, 5)
         seq_ft = bt2.SequenceFieldType(int_ft, 'the_len_field')

diff --git a/tests/bindings/python/bt2/test_field_types.py b/tests/bindings/python/bt2/test_field_types.py
index 763e30e6f3718854ae7f120758637e64fdb1874c..c92f916ddd505715986b9f5f07ed38152a03786d 100644 (file)
--- a/tests/bindings/python/bt2/test_field_types.py
+++ b/tests/bindings/python/bt2/test_field_types.py
@@ -219,50 +219,50 @@ class EnumerationFieldTypeTestCase(_TestIntegerFieldTypeProps, _TestInvalidEq,
         enum_ft = bt2.EnumerationFieldType(int_ft)
         self.assertEqual(enum_ft.integer_field_type.addr, int_ft.addr)
 
-    def test_append_mapping_simple(self):
-        self._ft.append_mapping('hello', 24)
+    def test_add_mapping_simple(self):
+        self._ft.add_mapping('hello', 24)
         mapping = self._ft[0]
         self.assertEqual(mapping.name, 'hello')
         self.assertEqual(mapping.lower, 24)
         self.assertEqual(mapping.upper, 24)
 
-    def test_append_mapping_simple_kwargs(self):
-        self._ft.append_mapping(name='hello', lower=17, upper=23)
+    def test_add_mapping_simple_kwargs(self):
+        self._ft.add_mapping(name='hello', lower=17, upper=23)
         mapping = self._ft[0]
         self.assertEqual(mapping.name, 'hello')
         self.assertEqual(mapping.lower, 17)
         self.assertEqual(mapping.upper, 23)
 
-    def test_append_mapping_range(self):
-        self._ft.append_mapping('hello', 21, 199)
+    def test_add_mapping_range(self):
+        self._ft.add_mapping('hello', 21, 199)
         mapping = self._ft[0]
         self.assertEqual(mapping.name, 'hello')
         self.assertEqual(mapping.lower, 21)
         self.assertEqual(mapping.upper, 199)
 
-    def test_append_mapping_invalid_name(self):
+    def test_add_mapping_invalid_name(self):
         with self.assertRaises(TypeError):
-            self._ft.append_mapping(17, 21, 199)
+            self._ft.add_mapping(17, 21, 199)
 
-    def test_append_mapping_invalid_signedness_lower(self):
+    def test_add_mapping_invalid_signedness_lower(self):
         with self.assertRaises(ValueError):
-            self._ft.append_mapping('hello', -21, 199)
+            self._ft.add_mapping('hello', -21, 199)
 
-    def test_append_mapping_invalid_signedness_upper(self):
+    def test_add_mapping_invalid_signedness_upper(self):
         with self.assertRaises(ValueError):
-            self._ft.append_mapping('hello', 21, -199)
+            self._ft.add_mapping('hello', 21, -199)
 
-    def test_append_mapping_simple_signed(self):
+    def test_add_mapping_simple_signed(self):
         self._ft.is_signed = True
-        self._ft.append_mapping('hello', -24)
+        self._ft.add_mapping('hello', -24)
         mapping = self._ft[0]
         self.assertEqual(mapping.name, 'hello')
         self.assertEqual(mapping.lower, -24)
         self.assertEqual(mapping.upper, -24)
 
-    def test_append_mapping_range_signed(self):
+    def test_add_mapping_range_signed(self):
         self._ft.is_signed = True
-        self._ft.append_mapping('hello', -21, 199)
+        self._ft.add_mapping('hello', -21, 199)
         mapping = self._ft[0]
         self.assertEqual(mapping.name, 'hello')
         self.assertEqual(mapping.lower, -21)
@@ -270,11 +270,11 @@ class EnumerationFieldTypeTestCase(_TestIntegerFieldTypeProps, _TestInvalidEq,
 
     def test_iadd(self):
         enum_ft = bt2.EnumerationFieldType(size=16)
-        enum_ft.append_mapping('c', 4, 5)
-        enum_ft.append_mapping('d', 6, 18)
-        enum_ft.append_mapping('e', 20, 27)
-        self._ft.append_mapping('a', 0, 2)
-        self._ft.append_mapping('b', 3)
+        enum_ft.add_mapping('c', 4, 5)
+        enum_ft.add_mapping('d', 6, 18)
+        enum_ft.add_mapping('e', 20, 27)
+        self._ft.add_mapping('a', 0, 2)
+        self._ft.add_mapping('b', 3)
         self._ft += enum_ft
         self.assertEqual(self._ft[0].name, 'a')
         self.assertEqual(self._ft[0].lower, 0)
@@ -294,19 +294,19 @@ class EnumerationFieldTypeTestCase(_TestIntegerFieldTypeProps, _TestInvalidEq,
 
     def test_bool_op(self):
         self.assertFalse(self._ft)
-        self._ft.append_mapping('a', 0)
+        self._ft.add_mapping('a', 0)
         self.assertTrue(self._ft)
 
     def test_len(self):
-        self._ft.append_mapping('a', 0)
-        self._ft.append_mapping('b', 1)
-        self._ft.append_mapping('c', 2)
+        self._ft.add_mapping('a', 0)
+        self._ft.add_mapping('b', 1)
+        self._ft.add_mapping('c', 2)
         self.assertEqual(len(self._ft), 3)
 
     def test_getitem(self):
-        self._ft.append_mapping('a', 0)
-        self._ft.append_mapping('b', 1, 3)
-        self._ft.append_mapping('c', 5)
+        self._ft.add_mapping('a', 0)
+        self._ft.add_mapping('b', 1, 3)
+        self._ft.add_mapping('c', 5)
         mapping = self._ft[1]
         self.assertEqual(mapping.name, 'b')
         self.assertEqual(mapping.lower, 1)
@@ -321,7 +321,7 @@ class EnumerationFieldTypeTestCase(_TestIntegerFieldTypeProps, _TestInvalidEq,
         )
 
         for mapping in mappings:
-            self._ft.append_mapping(*mapping)
+            self._ft.add_mapping(*mapping)
 
         for ft_mapping, mapping in zip(self._ft, mappings):
             self.assertEqual(ft_mapping.name, mapping[0])
@@ -331,21 +331,21 @@ class EnumerationFieldTypeTestCase(_TestIntegerFieldTypeProps, _TestInvalidEq,
     def test_mapping_eq(self):
         enum1 = bt2.EnumerationFieldType(size=32)
         enum2 = bt2.EnumerationFieldType(size=16)
-        enum1.append_mapping('b', 1, 3)
-        enum2.append_mapping('b', 1, 3)
+        enum1.add_mapping('b', 1, 3)
+        enum2.add_mapping('b', 1, 3)
         self.assertEqual(enum1[0], enum2[0])
 
     def test_mapping_eq_invalid(self):
         enum1 = bt2.EnumerationFieldType(size=32)
-        enum1.append_mapping('b', 1, 3)
+        enum1.add_mapping('b', 1, 3)
         self.assertNotEqual(enum1[0], 23)
 
     def _test_find_by_name(self, ft):
-        ft.append_mapping('a', 0)
-        ft.append_mapping('b', 1, 3)
-        ft.append_mapping('a', 5)
-        ft.append_mapping('a', 17, 144)
-        ft.append_mapping('C', 5)
+        ft.add_mapping('a', 0)
+        ft.add_mapping('b', 1, 3)
+        ft.add_mapping('a', 5)
+        ft.add_mapping('a', 17, 144)
+        ft.add_mapping('C', 5)
         mapping_iter = ft.mappings_by_name('a')
         mappings = list(mapping_iter)
         a0 = False
@@ -376,13 +376,13 @@ class EnumerationFieldTypeTestCase(_TestIntegerFieldTypeProps, _TestInvalidEq,
         self._test_find_by_name(bt2.EnumerationFieldType(size=8))
 
     def _test_find_by_value(self, ft):
-        ft.append_mapping('a', 0)
-        ft.append_mapping('b', 1, 3)
-        ft.append_mapping('c', 5, 19)
-        ft.append_mapping('d', 8, 15)
-        ft.append_mapping('e', 10, 21)
-        ft.append_mapping('f', 0)
-        ft.append_mapping('g', 14)
+        ft.add_mapping('a', 0)
+        ft.add_mapping('b', 1, 3)
+        ft.add_mapping('c', 5, 19)
+        ft.add_mapping('d', 8, 15)
+        ft.add_mapping('e', 10, 21)
+        ft.add_mapping('f', 0)
+        ft.add_mapping('g', 14)
         mapping_iter = ft.mappings_by_value(14)
         mappings = list(mapping_iter)
         c = False
@@ -416,12 +416,12 @@ class EnumerationFieldTypeTestCase(_TestIntegerFieldTypeProps, _TestInvalidEq,
         self._test_find_by_value(bt2.EnumerationFieldType(size=8))
 
     def test_create_field(self):
-        self._ft.append_mapping('c', 4, 5)
+        self._ft.add_mapping('c', 4, 5)
         field = self._ft()
         self.assertIsInstance(field, bt2.fields._EnumerationField)
 
     def test_create_field_init(self):
-        self._ft.append_mapping('c', 4, 5)
+        self._ft.add_mapping('c', 4, 5)
         field = self._ft(4)
         self.assertEqual(field, 4)
 

diff --git a/tests/bindings/python/bt2/test_fields.py b/tests/bindings/python/bt2/test_fields.py
index 6274202c84fc1ac3f22ff5184bdef3ff847330f1..a53b82dadf0c50d009ba76b05389f4a61bdfd1cf 100644 (file)
--- a/tests/bindings/python/bt2/test_fields.py
+++ b/tests/bindings/python/bt2/test_fields.py
@@ -792,11 +792,11 @@ class IntegerFieldTestCase(_TestIntegerFieldCommon, unittest.TestCase):
 class EnumerationFieldTestCase(_TestIntegerFieldCommon, unittest.TestCase):
     def setUp(self):
         self._ft = bt2.EnumerationFieldType(size=32, is_signed=True)
-        self._ft.append_mapping('whole range', -(2 ** 31), (2 ** 31) - 1)
-        self._ft.append_mapping('something', 17)
-        self._ft.append_mapping('speaker', 12, 16)
-        self._ft.append_mapping('can', 18, 2540)
-        self._ft.append_mapping('zip', -45, 1001)
+        self._ft.add_mapping('whole range', -(2 ** 31), (2 ** 31) - 1)
+        self._ft.add_mapping('something', 17)
+        self._ft.add_mapping('speaker', 12, 16)
+        self._ft.add_mapping('can', 18, 2540)
+        self._ft.add_mapping('zip', -45, 1001)
         self._def = self._ft()
         self._def.value = 17
         self._def_value = 17
@@ -1550,10 +1550,10 @@ class StructureFieldTestCase(_TestCopySimple, unittest.TestCase):
 class VariantFieldTestCase(_TestCopySimple, unittest.TestCase):
     def setUp(self):
         self._tag_ft = bt2.EnumerationFieldType(size=32)
-        self._tag_ft.append_mapping('corner', 23)
-        self._tag_ft.append_mapping('zoom', 17, 20)
-        self._tag_ft.append_mapping('mellotron', 1001)
-        self._tag_ft.append_mapping('giorgio', 2000, 3000)
+        self._tag_ft.add_mapping('corner', 23)
+        self._tag_ft.add_mapping('zoom', 17, 20)
+        self._tag_ft.add_mapping('mellotron', 1001)
+        self._tag_ft.add_mapping('giorgio', 2000, 3000)
         self._ft0 = bt2.IntegerFieldType(32, is_signed=True)
         self._ft1 = bt2.StringFieldType()
         self._ft2 = bt2.FloatingPointNumberFieldType()
@@ -1608,10 +1608,10 @@ class VariantFieldTestCase(_TestCopySimple, unittest.TestCase):
 
     def test_eq(self):
         tag_ft = bt2.EnumerationFieldType(size=32)
-        tag_ft.append_mapping('corner', 23)
-        tag_ft.append_mapping('zoom', 17, 20)
-        tag_ft.append_mapping('mellotron', 1001)
-        tag_ft.append_mapping('giorgio', 2000, 3000)
+        tag_ft.add_mapping('corner', 23)
+        tag_ft.add_mapping('zoom', 17, 20)
+        tag_ft.add_mapping('mellotron', 1001)
+        tag_ft.add_mapping('giorgio', 2000, 3000)
         ft0 = bt2.IntegerFieldType(32, is_signed=True)
         ft1 = bt2.StringFieldType()
         ft2 = bt2.FloatingPointNumberFieldType()

diff --git a/tests/lib/ctf-ir/test_trace.py b/tests/lib/ctf-ir/test_trace.py
index 14e94ec1666f129d91bfd1100ef50926609b2020..116f7ba240749e8934eee96d6bef31ea1b615840 100644 (file)
--- a/tests/lib/ctf-ir/test_trace.py
+++ b/tests/lib/ctf-ir/test_trace.py
@@ -42,7 +42,7 @@ class TraceTestCase(unittest.TestCase):
         phft = bt2.StructureFieldType()
         ft = bt2.IntegerFieldType(32, mapped_clock_class=cc)
         tag_ft = bt2.EnumerationFieldType(size=32)
-        tag_ft.append_mapping('heille', 12)
+        tag_ft.add_mapping('heille', 12)
         variant_ft = bt2.VariantFieldType('tag', tag_ft)
         variant_ft.append_field('heille', ft)
         phft.append_field('tag', tag_ft)