Move to kernel style SPDX license identifiers
[babeltrace.git] / src / bindings / python / bt2 / bt2 / plugin.py
index 16c7c4a1ac8dc7122c2dda1b4a262c18ea5fb6b4..8ce94fe910836c62f494715b6ac7934167e47017 100644 (file)
@@ -1,44 +1,59 @@
-# The MIT License (MIT)
+# SPDX-License-Identifier: MIT
 #
 # Copyright (c) 2017 Philippe Proulx <pproulx@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, object, utils
 import collections.abc
-import bt2.component
+from bt2 import component as bt2_component
 import os.path
-import bt2
 
 
-def find_plugins(path, recurse=True, fail_on_load_error=False):
+def find_plugins_in_path(path, recurse=True, fail_on_load_error=False):
     utils._check_str(path)
     utils._check_bool(recurse)
     utils._check_bool(fail_on_load_error)
     plugin_set_ptr = None
 
     if os.path.isfile(path):
-        status, plugin_set_ptr = native_bt.bt2_plugin_find_all_from_file(path, fail_on_load_error)
+        status, plugin_set_ptr = native_bt.bt2_plugin_find_all_from_file(
+            path, fail_on_load_error
+        )
     elif os.path.isdir(path):
-        status, plugin_set_ptr = native_bt.bt2_plugin_find_all_from_dir(path, int(recurse), int(fail_on_load_error))
+        status, plugin_set_ptr = native_bt.bt2_plugin_find_all_from_dir(
+            path, int(recurse), int(fail_on_load_error)
+        )
     else:
-        raise bt2.Error("invalid path: '{}'".format(path))
+        raise ValueError("invalid path: '{}'".format(path))
+
+    if status == native_bt.__BT_FUNC_STATUS_NOT_FOUND:
+        return
+
+    utils._handle_func_status(status, 'failed to find plugins')
+    assert plugin_set_ptr is not None
+    return _PluginSet._create_from_ptr(plugin_set_ptr)
+
+
+def find_plugins(
+    find_in_std_env_var=True,
+    find_in_user_dir=True,
+    find_in_sys_dir=True,
+    find_in_static=True,
+    fail_on_load_error=False,
+):
+    utils._check_bool(find_in_std_env_var)
+    utils._check_bool(find_in_user_dir)
+    utils._check_bool(find_in_sys_dir)
+    utils._check_bool(find_in_static)
+    utils._check_bool(fail_on_load_error)
+    plugin_set_ptr = None
+
+    status, plugin_set_ptr = native_bt.bt2_plugin_find_all(
+        int(find_in_std_env_var),
+        int(find_in_user_dir),
+        int(find_in_sys_dir),
+        int(find_in_static),
+        int(fail_on_load_error),
+    )
 
     if status == native_bt.__BT_FUNC_STATUS_NOT_FOUND:
         return
@@ -48,10 +63,24 @@ def find_plugins(path, recurse=True, fail_on_load_error=False):
     return _PluginSet._create_from_ptr(plugin_set_ptr)
 
 
-def find_plugin(name, fail_on_load_error=False):
+def find_plugin(
+    name,
+    find_in_std_env_var=True,
+    find_in_user_dir=True,
+    find_in_sys_dir=True,
+    find_in_static=True,
+    fail_on_load_error=False,
+):
     utils._check_str(name)
     utils._check_bool(fail_on_load_error)
-    status, ptr = native_bt.bt2_plugin_find(name, int(fail_on_load_error))
+    status, ptr = native_bt.bt2_plugin_find(
+        name,
+        int(find_in_std_env_var),
+        int(find_in_user_dir),
+        int(find_in_sys_dir),
+        int(find_in_static),
+        int(fail_on_load_error),
+    )
 
     if status == native_bt.__BT_FUNC_STATUS_NOT_FOUND:
         return
@@ -67,7 +96,7 @@ class _PluginSet(object._SharedObject, collections.abc.Sequence):
 
     def __len__(self):
         count = native_bt.plugin_set_get_plugin_count(self._ptr)
-        assert(count >= 0)
+        assert count >= 0
         return count
 
     def __getitem__(self, index):
@@ -125,13 +154,17 @@ class _PluginComponentClassesIterator(collections.abc.Iterator):
         if self._at == total:
             raise StopIteration
 
-        comp_cls_ptr = self._plugin_comp_cls._borrow_component_class_by_index(plugin_ptr, self._at)
+        comp_cls_ptr = self._plugin_comp_cls._borrow_component_class_by_index(
+            plugin_ptr, self._at
+        )
         assert comp_cls_ptr is not None
         self._at += 1
 
         comp_cls_type = self._plugin_comp_cls._comp_cls_type
-        comp_cls_pycls = bt2.component._COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS[comp_cls_type]
-        comp_cls_ptr = comp_cls_pycls._as_component_class_ptr(comp_cls_ptr)
+        comp_cls_pycls = bt2_component._COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS[
+            comp_cls_type
+        ]
+        comp_cls_ptr = comp_cls_pycls._bt_as_component_class_ptr(comp_cls_ptr)
         name = native_bt.component_class_get_name(comp_cls_ptr)
         assert name is not None
         return name
@@ -148,7 +181,9 @@ class _PluginComponentClasses(collections.abc.Mapping):
         if cc_ptr is None:
             raise KeyError(key)
 
-        return bt2.component._create_component_class_from_ptr_and_get_ref(cc_ptr, self._comp_cls_type)
+        return bt2_component._create_component_class_from_const_ptr_and_get_ref(
+            cc_ptr, self._comp_cls_type
+        )
 
     def __len__(self):
         return self._component_class_count(self._plugin._ptr)
@@ -158,23 +193,41 @@ class _PluginComponentClasses(collections.abc.Mapping):
 
 
 class _PluginSourceComponentClasses(_PluginComponentClasses):
-    _component_class_count = staticmethod(native_bt.plugin_get_source_component_class_count)
-    _borrow_component_class_by_name = staticmethod(native_bt.plugin_borrow_source_component_class_by_name_const)
-    _borrow_component_class_by_index = staticmethod(native_bt.plugin_borrow_source_component_class_by_index_const)
+    _component_class_count = staticmethod(
+        native_bt.plugin_get_source_component_class_count
+    )
+    _borrow_component_class_by_name = staticmethod(
+        native_bt.plugin_borrow_source_component_class_by_name_const
+    )
+    _borrow_component_class_by_index = staticmethod(
+        native_bt.plugin_borrow_source_component_class_by_index_const
+    )
     _comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_SOURCE
 
 
 class _PluginFilterComponentClasses(_PluginComponentClasses):
-    _component_class_count = staticmethod(native_bt.plugin_get_filter_component_class_count)
-    _borrow_component_class_by_name = staticmethod(native_bt.plugin_borrow_filter_component_class_by_name_const)
-    _borrow_component_class_by_index = staticmethod(native_bt.plugin_borrow_filter_component_class_by_index_const)
+    _component_class_count = staticmethod(
+        native_bt.plugin_get_filter_component_class_count
+    )
+    _borrow_component_class_by_name = staticmethod(
+        native_bt.plugin_borrow_filter_component_class_by_name_const
+    )
+    _borrow_component_class_by_index = staticmethod(
+        native_bt.plugin_borrow_filter_component_class_by_index_const
+    )
     _comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_FILTER
 
 
 class _PluginSinkComponentClasses(_PluginComponentClasses):
-    _component_class_count = staticmethod(native_bt.plugin_get_sink_component_class_count)
-    _borrow_component_class_by_name = staticmethod(native_bt.plugin_borrow_sink_component_class_by_name_const)
-    _borrow_component_class_by_index = staticmethod(native_bt.plugin_borrow_sink_component_class_by_index_const)
+    _component_class_count = staticmethod(
+        native_bt.plugin_get_sink_component_class_count
+    )
+    _borrow_component_class_by_name = staticmethod(
+        native_bt.plugin_borrow_sink_component_class_by_name_const
+    )
+    _borrow_component_class_by_index = staticmethod(
+        native_bt.plugin_borrow_sink_component_class_by_index_const
+    )
     _comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_SINK
 
 
@@ -185,7 +238,7 @@ class _Plugin(object._SharedObject):
     @property
     def name(self):
         name = native_bt.plugin_get_name(self._ptr)
-        assert(name is not None)
+        assert name is not None
         return name
 
     @property
This page took 0.02566 seconds and 4 git commands to generate.