bt2: Add `Const` suffix to non-user component-related classes and adapt tests

Signed-off-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Change-Id: I2d6703707c55f1d420027cd83fa9124b83467938
Reviewed-on: https://review.lttng.org/c/babeltrace/+/2009
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>

diff --git a/src/bindings/python/bt2/bt2/__init__.py b/src/bindings/python/bt2/bt2/__init__.py
index b7aa3e838a648951866690045f507168a93b01de..dfa71a87032b5c4e40063f3a400696e346b19f3b 100644 (file)
--- a/src/bindings/python/bt2/bt2/__init__.py
+++ b/src/bindings/python/bt2/bt2/__init__.py
@@ -24,12 +24,12 @@
 from bt2.clock_class import ClockClassOffset
 from bt2.clock_snapshot import _ClockSnapshotConst
 from bt2.clock_snapshot import _UnknownClockSnapshot
-from bt2.component import _SourceComponentClass
-from bt2.component import _FilterComponentClass
-from bt2.component import _SinkComponentClass
-from bt2.component import _SourceComponent
-from bt2.component import _FilterComponent
-from bt2.component import _SinkComponent
+from bt2.component import _SourceComponentClassConst
+from bt2.component import _FilterComponentClassConst
+from bt2.component import _SinkComponentClassConst
+from bt2.component import _SourceComponentConst
+from bt2.component import _FilterComponentConst
+from bt2.component import _SinkComponentConst
 from bt2.component import _UserSourceComponent
 from bt2.component import _UserFilterComponent
 from bt2.component import _UserSinkComponent

diff --git a/src/bindings/python/bt2/bt2/component.py b/src/bindings/python/bt2/bt2/component.py
index 142cd26933c333e9104dbefc2eb4d3b01e1dbf4e..a14b78e78e12bbb57eef3f1cfe5b58ea3adf9ab4 100644 (file)
--- a/src/bindings/python/bt2/bt2/component.py
+++ b/src/bindings/python/bt2/bt2/component.py
@@ -43,7 +43,7 @@ import bt2
 #     pointer to a 'bt_component_class *'.
 
 
-class _ComponentClass(object._SharedObject):
+class _ComponentClassConst(object._SharedObject):
     @property
     def name(self):
         ptr = self._bt_as_component_class_ptr(self._ptr)
@@ -65,7 +65,7 @@ class _ComponentClass(object._SharedObject):
         return self._bt_as_component_class_ptr(self._ptr)
 
     def __eq__(self, other):
-        if not isinstance(other, _ComponentClass):
+        if not isinstance(other, _ComponentClassConst):
             try:
                 if not issubclass(other, _UserComponent):
                     return False
@@ -75,7 +75,7 @@ class _ComponentClass(object._SharedObject):
         return self.addr == other.addr
 
 
-class _SourceComponentClass(_ComponentClass):
+class _SourceComponentClassConst(_ComponentClassConst):
     _get_ref = staticmethod(native_bt.component_class_source_get_ref)
     _put_ref = staticmethod(native_bt.component_class_source_put_ref)
     _bt_as_component_class_ptr = staticmethod(
@@ -83,7 +83,7 @@ class _SourceComponentClass(_ComponentClass):
     )
 
 
-class _FilterComponentClass(_ComponentClass):
+class _FilterComponentClassConst(_ComponentClassConst):
     _get_ref = staticmethod(native_bt.component_class_filter_get_ref)
     _put_ref = staticmethod(native_bt.component_class_filter_put_ref)
     _bt_as_component_class_ptr = staticmethod(
@@ -91,7 +91,7 @@ class _FilterComponentClass(_ComponentClass):
     )
 
 
-class _SinkComponentClass(_ComponentClass):
+class _SinkComponentClassConst(_ComponentClassConst):
     _get_ref = staticmethod(native_bt.component_class_sink_get_ref)
     _put_ref = staticmethod(native_bt.component_class_sink_put_ref)
     _bt_as_component_class_ptr = staticmethod(
@@ -173,7 +173,7 @@ class _ComponentPorts(collections.abc.Mapping):
 #     component pointer (e.g. 'bt_component_sink *') as a 'bt_component *'.
 
 
-class _Component:
+class _ComponentConst:
     @property
     def name(self):
         ptr = self._bt_as_component_ptr(self._ptr)
@@ -190,7 +190,7 @@ class _Component:
     def cls(self):
         cc_ptr = self._bt_borrow_component_class_ptr(self._ptr)
         assert cc_ptr is not None
-        return _create_component_class_from_ptr_and_get_ref(
+        return _create_component_class_from_const_ptr_and_get_ref(
             cc_ptr, self._bt_comp_cls_type
         )
 
@@ -201,7 +201,7 @@ class _Component:
         return self.addr == other.addr
 
 
-class _SourceComponent(_Component):
+class _SourceComponentConst(_ComponentConst):
     _bt_borrow_component_class_ptr = staticmethod(
         native_bt.component_source_borrow_class_const
     )
@@ -212,7 +212,7 @@ class _SourceComponent(_Component):
     _bt_as_component_ptr = staticmethod(native_bt.component_source_as_component_const)
 
 
-class _FilterComponent(_Component):
+class _FilterComponentConst(_ComponentConst):
     _bt_borrow_component_class_ptr = staticmethod(
         native_bt.component_filter_borrow_class_const
     )
@@ -223,7 +223,7 @@ class _FilterComponent(_Component):
     _bt_as_component_ptr = staticmethod(native_bt.component_filter_as_component_const)
 
 
-class _SinkComponent(_Component):
+class _SinkComponentConst(_ComponentConst):
     _bt_borrow_component_class_ptr = staticmethod(
         native_bt.component_sink_borrow_class_const
     )
@@ -234,9 +234,9 @@ class _SinkComponent(_Component):
     _bt_as_component_ptr = staticmethod(native_bt.component_sink_as_component_const)
 
 
-# This is analogous to _SourceComponentClass, but for source
+# This is analogous to _SourceComponentClassConst, but for source
 # component objects.
-class _GenericSourceComponent(object._SharedObject, _SourceComponent):
+class _GenericSourceComponentConst(object._SharedObject, _SourceComponentConst):
     _get_ref = staticmethod(native_bt.component_source_get_ref)
     _put_ref = staticmethod(native_bt.component_source_put_ref)
 
@@ -251,9 +251,9 @@ class _GenericSourceComponent(object._SharedObject, _SourceComponent):
         )
 
 
-# This is analogous to _FilterComponentClass, but for filter
+# This is analogous to _FilterComponentClassConst, but for filter
 # component objects.
-class _GenericFilterComponent(object._SharedObject, _FilterComponent):
+class _GenericFilterComponentConst(object._SharedObject, _FilterComponentConst):
     _get_ref = staticmethod(native_bt.component_filter_get_ref)
     _put_ref = staticmethod(native_bt.component_filter_put_ref)
 
@@ -278,9 +278,9 @@ class _GenericFilterComponent(object._SharedObject, _FilterComponent):
         )
 
 
-# This is analogous to _SinkComponentClass, but for sink
+# This is analogous to _SinkComponentClassConst, but for sink
 # component objects.
-class _GenericSinkComponent(object._SharedObject, _SinkComponent):
+class _GenericSinkComponentConst(object._SharedObject, _SinkComponentConst):
     _get_ref = staticmethod(native_bt.component_sink_get_ref)
     _put_ref = staticmethod(native_bt.component_sink_put_ref)
 
@@ -296,27 +296,27 @@ class _GenericSinkComponent(object._SharedObject, _SinkComponent):
 
 
 _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS = {
-    native_bt.COMPONENT_CLASS_TYPE_SOURCE: _GenericSourceComponent,
-    native_bt.COMPONENT_CLASS_TYPE_FILTER: _GenericFilterComponent,
-    native_bt.COMPONENT_CLASS_TYPE_SINK: _GenericSinkComponent,
+    native_bt.COMPONENT_CLASS_TYPE_SOURCE: _GenericSourceComponentConst,
+    native_bt.COMPONENT_CLASS_TYPE_FILTER: _GenericFilterComponentConst,
+    native_bt.COMPONENT_CLASS_TYPE_SINK: _GenericSinkComponentConst,
 }
 
 
 _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS = {
-    native_bt.COMPONENT_CLASS_TYPE_SOURCE: _SourceComponentClass,
-    native_bt.COMPONENT_CLASS_TYPE_FILTER: _FilterComponentClass,
-    native_bt.COMPONENT_CLASS_TYPE_SINK: _SinkComponentClass,
+    native_bt.COMPONENT_CLASS_TYPE_SOURCE: _SourceComponentClassConst,
+    native_bt.COMPONENT_CLASS_TYPE_FILTER: _FilterComponentClassConst,
+    native_bt.COMPONENT_CLASS_TYPE_SINK: _SinkComponentClassConst,
 }
 
 
-# Create a component Python object of type _GenericSourceComponent,
-# _GenericFilterComponent or _GenericSinkComponent, depending on
+# Create a component Python object of type _GenericSourceComponentConst,
+# _GenericFilterComponentConst or _GenericSinkComponentConst, depending on
 # comp_cls_type.
 #
 #    Steals the reference to ptr from the caller.
 
 
-def _create_component_from_ptr(ptr, comp_cls_type):
+def _create_component_from_const_ptr(ptr, comp_cls_type):
     return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS[comp_cls_type]._create_from_ptr(ptr)
 
 
@@ -324,20 +324,20 @@ def _create_component_from_ptr(ptr, comp_cls_type):
 # reference from the caller.
 
 
-def _create_component_from_ptr_and_get_ref(ptr, comp_cls_type):
+def _create_component_from_const_ptr_and_get_ref(ptr, comp_cls_type):
     return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS[
         comp_cls_type
     ]._create_from_ptr_and_get_ref(ptr)
 
 
 # Create a component class Python object of type
-# _SourceComponentClass, _FilterComponentClass or
-# _SinkComponentClass, depending on comp_cls_type.
+# _SourceComponentClassConst, _FilterComponentClassConst or
+# _SinkComponentClassConst, depending on comp_cls_type.
 #
 # Acquires a new reference to ptr.
 
 
-def _create_component_class_from_ptr_and_get_ref(ptr, comp_cls_type):
+def _create_component_class_from_const_ptr_and_get_ref(ptr, comp_cls_type):
     return _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS[
         comp_cls_type
     ]._create_from_ptr_and_get_ref(ptr)
@@ -380,7 +380,7 @@ def _trim_docstring(docstring):
 # creates a native BT component class of the corresponding type and
 # associates it with this user-defined class. The metaclass also defines
 # class methods like the `name` and `description` properties to match
-# the _ComponentClass interface.
+# the _ComponentClassConst interface.
 #
 # The component class name which is used is either:
 #
@@ -669,7 +669,7 @@ class _UserComponent(metaclass=_UserComponentType):
     def cls(self):
         comp_ptr = self._bt_as_not_self_specific_component_ptr(self._bt_ptr)
         cc_ptr = self._bt_borrow_component_class_ptr(comp_ptr)
-        return _create_component_class_from_ptr_and_get_ref(
+        return _create_component_class_from_const_ptr_and_get_ref(
             cc_ptr, self._bt_comp_cls_type
         )
 
@@ -768,7 +768,7 @@ class _UserComponent(metaclass=_UserComponentType):
         return cc
 
 
-class _UserSourceComponent(_UserComponent, _SourceComponent):
+class _UserSourceComponent(_UserComponent, _SourceComponentConst):
     _bt_as_not_self_specific_component_ptr = staticmethod(
         native_bt.self_component_source_as_component_source
     )
@@ -801,7 +801,7 @@ class _UserSourceComponent(_UserComponent, _SourceComponent):
         return bt2_port._UserComponentOutputPort._create_from_ptr(self_port_ptr)
 
 
-class _UserFilterComponent(_UserComponent, _FilterComponent):
+class _UserFilterComponent(_UserComponent, _FilterComponentConst):
     _bt_as_not_self_specific_component_ptr = staticmethod(
         native_bt.self_component_filter_as_component_filter
     )
@@ -858,7 +858,7 @@ class _UserFilterComponent(_UserComponent, _FilterComponent):
         return bt2_port._UserComponentInputPort._create_from_ptr(self_port_ptr)
 
 
-class _UserSinkComponent(_UserComponent, _SinkComponent):
+class _UserSinkComponent(_UserComponent, _SinkComponentConst):
     _bt_as_not_self_specific_component_ptr = staticmethod(
         native_bt.self_component_sink_as_component_sink
     )

diff --git a/src/bindings/python/bt2/bt2/component_descriptor.py b/src/bindings/python/bt2/bt2/component_descriptor.py
index bafba7e5cfeb146e65aaf008deedb3a80c090461..1281560042083c2825e3fbafb216c6f45f3a84ee 100644 (file)
--- a/src/bindings/python/bt2/bt2/component_descriptor.py
+++ b/src/bindings/python/bt2/bt2/component_descriptor.py
@@ -26,7 +26,7 @@ import bt2
 
 
 def _is_source_comp_cls(comp_cls):
-    if isinstance(comp_cls, bt2_component._SourceComponentClass):
+    if isinstance(comp_cls, bt2_component._SourceComponentClassConst):
         return True
 
     try:
@@ -36,7 +36,7 @@ def _is_source_comp_cls(comp_cls):
 
 
 def _is_filter_comp_cls(comp_cls):
-    if isinstance(comp_cls, bt2_component._FilterComponentClass):
+    if isinstance(comp_cls, bt2_component._FilterComponentClassConst):
         return True
 
     try:
@@ -46,7 +46,7 @@ def _is_filter_comp_cls(comp_cls):
 
 
 def _is_sink_comp_cls(comp_cls):
-    if isinstance(comp_cls, bt2_component._SinkComponentClass):
+    if isinstance(comp_cls, bt2_component._SinkComponentClassConst):
         return True
 
     try:

diff --git a/src/bindings/python/bt2/bt2/graph.py b/src/bindings/python/bt2/bt2/graph.py
index 93636c93a5010b422cc6668499c24b24f2e8746d..82708025c19032b91c72b063d977567b95ca4995 100644 (file)
--- a/src/bindings/python/bt2/bt2/graph.py
+++ b/src/bindings/python/bt2/bt2/graph.py
@@ -33,7 +33,7 @@ import bt2
 def _graph_port_added_listener_from_native(
     user_listener, component_ptr, component_type, port_ptr, port_type
 ):
-    component = bt2_component._create_component_from_ptr_and_get_ref(
+    component = bt2_component._create_component_from_const_ptr_and_get_ref(
         component_ptr, component_type
     )
     port = bt2_port._create_from_const_ptr_and_get_ref(port_ptr, port_type)
@@ -49,13 +49,13 @@ def _graph_ports_connected_listener_from_native(
     downstream_component_type,
     downstream_port_ptr,
 ):
-    upstream_component = bt2_component._create_component_from_ptr_and_get_ref(
+    upstream_component = bt2_component._create_component_from_const_ptr_and_get_ref(
         upstream_component_ptr, upstream_component_type
     )
     upstream_port = bt2_port._create_from_const_ptr_and_get_ref(
         upstream_port_ptr, native_bt.PORT_TYPE_OUTPUT
     )
-    downstream_component = bt2_component._create_component_from_ptr_and_get_ref(
+    downstream_component = bt2_component._create_component_from_const_ptr_and_get_ref(
         downstream_component_ptr, downstream_component_type
     )
     downstream_port = bt2_port._create_from_const_ptr_and_get_ref(
@@ -91,15 +91,15 @@ class Graph(object._SharedObject):
         obj=None,
         logging_level=bt2_logging.LoggingLevel.NONE,
     ):
-        if isinstance(component_class, bt2_component._SourceComponentClass):
+        if isinstance(component_class, bt2_component._SourceComponentClassConst):
             cc_ptr = component_class._ptr
             add_fn = native_bt.bt2_graph_add_source_component
             cc_type = native_bt.COMPONENT_CLASS_TYPE_SOURCE
-        elif isinstance(component_class, bt2_component._FilterComponentClass):
+        elif isinstance(component_class, bt2_component._FilterComponentClassConst):
             cc_ptr = component_class._ptr
             add_fn = native_bt.bt2_graph_add_filter_component
             cc_type = native_bt.COMPONENT_CLASS_TYPE_FILTER
-        elif isinstance(component_class, bt2_component._SinkComponentClass):
+        elif isinstance(component_class, bt2_component._SinkComponentClassConst):
             cc_ptr = component_class._ptr
             add_fn = native_bt.bt2_graph_add_sink_component
             cc_type = native_bt.COMPONENT_CLASS_TYPE_SINK
@@ -137,7 +137,7 @@ class Graph(object._SharedObject):
         )
         utils._handle_func_status(status, 'cannot add component to graph')
         assert comp_ptr
-        return bt2_component._create_component_from_ptr(comp_ptr, cc_type)
+        return bt2_component._create_component_from_const_ptr(comp_ptr, cc_type)
 
     def connect_ports(self, upstream_port, downstream_port):
         utils._check_type(upstream_port, bt2_port._OutputPortConst)

diff --git a/src/bindings/python/bt2/bt2/plugin.py b/src/bindings/python/bt2/bt2/plugin.py
index 66840f9475eeb7de55e1c76d1f8c4b36c97c6495..cb169f484a36ee317ab2cc22011051522f514407 100644 (file)
--- a/src/bindings/python/bt2/bt2/plugin.py
+++ b/src/bindings/python/bt2/bt2/plugin.py
@@ -199,7 +199,7 @@ class _PluginComponentClasses(collections.abc.Mapping):
         if cc_ptr is None:
             raise KeyError(key)
 
-        return bt2_component._create_component_class_from_ptr_and_get_ref(
+        return bt2_component._create_component_class_from_const_ptr_and_get_ref(
             cc_ptr, self._comp_cls_type
         )
 

diff --git a/src/bindings/python/bt2/bt2/query_executor.py b/src/bindings/python/bt2/bt2/query_executor.py
index e23fc96f8f484731c0d76b5dfc12e7873e9898fc..36edb014e500a0a7573b200752a82db785ff7e2b 100644 (file)
--- a/src/bindings/python/bt2/bt2/query_executor.py
+++ b/src/bindings/python/bt2/bt2/query_executor.py
@@ -50,7 +50,7 @@ class QueryExecutor(object._SharedObject, _QueryExecutorCommon):
         return self._ptr
 
     def __init__(self, component_class, object, params=None, method_obj=None):
-        if not isinstance(component_class, bt2_component._ComponentClass):
+        if not isinstance(component_class, bt2_component._ComponentClassConst):
             err = False
 
             try:

diff --git a/src/bindings/python/bt2/bt2/trace_collection_message_iterator.py b/src/bindings/python/bt2/bt2/trace_collection_message_iterator.py
index b91440df4d6211a63a15dfe1f657cb2edda2b565..097e1c8b6e8b37deb3028183f861809ecf56c7af 100644 (file)
--- a/src/bindings/python/bt2/bt2/trace_collection_message_iterator.py
+++ b/src/bindings/python/bt2/bt2/trace_collection_message_iterator.py
@@ -76,7 +76,8 @@ class ComponentSpec(_BaseComponentSpec):
         super().__init__(params, obj, logging_level)
 
         is_cc_object = isinstance(
-            component_class, (bt2._SourceComponentClass, bt2._FilterComponentClass)
+            component_class,
+            (bt2._SourceComponentClassConst, bt2._FilterComponentClassConst),
         )
         is_user_cc_type = isinstance(
             component_class, bt2_component._UserComponentType

diff --git a/tests/bindings/python/bt2/test_component_class.py b/tests/bindings/python/bt2/test_component_class.py
index 98fc91dbb9b7f8de675a95a59e71f66b40542fbd..100694285fcbbee4d8f5aee585b396f011793b33 100644 (file)
--- a/tests/bindings/python/bt2/test_component_class.py
+++ b/tests/bindings/python/bt2/test_component_class.py
@@ -326,7 +326,7 @@ class ComponentClassTestCase(unittest.TestCase):
         graph = bt2.Graph()
         comp = graph.add_component(MySink, 'salut')
         self._comp_cls = comp.cls
-        self.assertTrue(issubclass(type(self._comp_cls), bt2._SinkComponentClass))
+        self.assertTrue(issubclass(type(self._comp_cls), bt2._SinkComponentClassConst))
 
     def tearDown(self):
         del self._py_comp_cls

diff --git a/tests/bindings/python/bt2/test_package.py b/tests/bindings/python/bt2/test_package.py
index c83ea1481632cbb49d810218e5858301143a925d..185cb7170a341dd7e46c6acbba1cae040d27f838 100644 (file)
--- a/tests/bindings/python/bt2/test_package.py
+++ b/tests/bindings/python/bt2/test_package.py
@@ -33,23 +33,23 @@ class PackageTestCase(unittest.TestCase):
     def test_has__UnknownClockSnapshot(self):
         self._assert_in_bt2('_UnknownClockSnapshot')
 
-    def test_has__SourceComponentClass(self):
-        self._assert_in_bt2('_SourceComponentClass')
+    def test_has__SourceComponentClassConst(self):
+        self._assert_in_bt2('_SourceComponentClassConst')
 
-    def test_has__FilterComponentClass(self):
-        self._assert_in_bt2('_FilterComponentClass')
+    def test_has__FilterComponentClassConst(self):
+        self._assert_in_bt2('_FilterComponentClassConst')
 
-    def test_has__SinkComponentClass(self):
-        self._assert_in_bt2('_SinkComponentClass')
+    def test_has__SinkComponentClassConst(self):
+        self._assert_in_bt2('_SinkComponentClassConst')
 
-    def test_has__SourceComponent(self):
-        self._assert_in_bt2('_SourceComponent')
+    def test_has__SourceComponentConst(self):
+        self._assert_in_bt2('_SourceComponentConst')
 
-    def test_has__FilterComponent(self):
-        self._assert_in_bt2('_FilterComponent')
+    def test_has__FilterComponentConst(self):
+        self._assert_in_bt2('_FilterComponentConst')
 
-    def test_has__SinkComponent(self):
-        self._assert_in_bt2('_SinkComponent')
+    def test_has__SinkComponentConst(self):
+        self._assert_in_bt2('_SinkComponentConst')
 
     def test_has__UserSourceComponent(self):
         self._assert_in_bt2('_UserSourceComponent')

diff --git a/tests/bindings/python/bt2/test_trace_collection_message_iterator.py b/tests/bindings/python/bt2/test_trace_collection_message_iterator.py
index f9b6546fdb6b17f6936722ec98069c4c7a13259d..82c05faaaa256e0bea531d29f376e7f9f01bbccf 100644 (file)
--- a/tests/bindings/python/bt2/test_trace_collection_message_iterator.py
+++ b/tests/bindings/python/bt2/test_trace_collection_message_iterator.py
@@ -100,7 +100,8 @@ class ComponentSpecTestCase(unittest.TestCase):
 
     def test_create_sink_from_object(self):
         with self.assertRaisesRegex(
-            TypeError, "'_SinkComponentClass' is not a source or filter component class"
+            TypeError,
+            "'_SinkComponentClassConst' is not a source or filter component class",
         ):
             bt2.ComponentSpec(self._pretty_cc)