Fix: bt2: _trim_docstring(): docstring can have 0 or 1 line

[babeltrace.git] / src / bindings / python / bt2 / bt2 / component.py

diff --git a/src/bindings/python/bt2/bt2/component.py b/src/bindings/python/bt2/bt2/component.py
index 980a0d45f9f7dd42f9ca4100b38c124be978e161..df62ae639bc3022c2d06db25c91f4404794eea0a 100644 (file)
--- a/src/bindings/python/bt2/bt2/component.py
+++ b/src/bindings/python/bt2/bt2/component.py
@@ -345,17 +345,22 @@ def _create_component_class_from_const_ptr_and_get_ref(ptr, comp_cls_type):
 
 def _trim_docstring(docstring):
     lines = docstring.expandtabs().splitlines()
+
+    if len(lines) == 0:
+        return ''
+
     indent = sys.maxsize
 
-    for line in lines[1:]:
-        stripped = line.lstrip()
+    if len(lines) > 1:
+        for line in lines[1:]:
+            stripped = line.lstrip()
 
-        if stripped:
-            indent = min(indent, len(line) - len(stripped))
+            if stripped:
+                indent = min(indent, len(line) - len(stripped))
 
     trimmed = [lines[0].strip()]
 
-    if indent < sys.maxsize:
+    if indent < sys.maxsize and len(lines) > 1:
         for line in lines[1:]:
             trimmed.append(line[indent:].rstrip())
 
@@ -613,7 +618,9 @@ class _UserComponentType(type):
     def _user_get_supported_mip_versions(cls, params, obj, log_level):
         return [0]
 
-    def _bt_query_from_native(cls, priv_query_exec_ptr, object, params_ptr, method_obj):
+    def _bt_query_from_native(
+        cls, priv_query_exec_ptr, object_name, params_ptr, method_obj
+    ):
         # this can raise, but the native side checks the exception
         if params_ptr is not None:
             params = bt2_value._create_from_const_ptr_and_get_ref(params_ptr)
@@ -624,7 +631,7 @@ class _UserComponentType(type):
 
         try:
             # this can raise, but the native side checks the exception
-            results = cls._user_query(priv_query_exec, object, params, method_obj)
+            results = cls._user_query(priv_query_exec, object_name, params, method_obj)
         finally:
             # the private query executor is a private view on the query
             # executor; it's not a shared object (the library does not
@@ -646,7 +653,7 @@ class _UserComponentType(type):
         bt2_value._Value._get_ref(results_ptr)
         return int(results_ptr)
 
-    def _user_query(cls, priv_query_executor, object, params, method_obj):
+    def _user_query(cls, priv_query_executor, object_name, params, method_obj):
         raise bt2.UnknownObject
 
     def _bt_component_class_ptr(self):
@@ -843,7 +850,9 @@ class _UserSourceComponent(_UserComponent, _SourceComponentConst):
             comp_status, 'cannot add output port to source component object'
         )
         assert self_port_ptr is not None
-        return bt2_port._UserComponentOutputPort._create_from_ptr(self_port_ptr)
+        return bt2_port._UserComponentOutputPort._create_from_ptr_and_get_ref(
+            self_port_ptr
+        )
 
 
 class _UserFilterComponent(_UserComponent, _FilterComponentConst):
@@ -891,7 +900,9 @@ class _UserFilterComponent(_UserComponent, _FilterComponentConst):
             comp_status, 'cannot add output port to filter component object'
         )
         assert self_port_ptr
-        return bt2_port._UserComponentOutputPort._create_from_ptr(self_port_ptr)
+        return bt2_port._UserComponentOutputPort._create_from_ptr_and_get_ref(
+            self_port_ptr
+        )
 
     def _add_input_port(self, name, user_data=None):
         utils._check_str(name)
@@ -901,7 +912,9 @@ class _UserFilterComponent(_UserComponent, _FilterComponentConst):
             comp_status, 'cannot add input port to filter component object'
         )
         assert self_port_ptr
-        return bt2_port._UserComponentInputPort._create_from_ptr(self_port_ptr)
+        return bt2_port._UserComponentInputPort._create_from_ptr_and_get_ref(
+            self_port_ptr
+        )
 
 
 class _UserSinkComponent(_UserComponent, _SinkComponentConst):
@@ -941,15 +954,17 @@ class _UserSinkComponent(_UserComponent, _SinkComponentConst):
             comp_status, 'cannot add input port to sink component object'
         )
         assert self_port_ptr
-        return bt2_port._UserComponentInputPort._create_from_ptr(self_port_ptr)
+        return bt2_port._UserComponentInputPort._create_from_ptr_and_get_ref(
+            self_port_ptr
+        )
 
-    def _create_input_port_message_iterator(self, input_port):
+    def _create_message_iterator(self, input_port):
         utils._check_type(input_port, bt2_port._UserComponentInputPort)
 
         (
             status,
             msg_iter_ptr,
-        ) = native_bt.bt2_self_component_port_input_message_iterator_create_from_sink_component(
+        ) = native_bt.bt2_message_iterator_create_from_sink_component(
             self._bt_ptr, input_port._ptr
         )
         utils._handle_func_status(status, 'cannot create message iterator object')