summaryrefslogtreecommitdiffstats
path: root/src/pybind/mgr/dashboard/plugins/plugin.py
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 18:24:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 18:24:20 +0000
commit483eb2f56657e8e7f419ab1a4fab8dce9ade8609 (patch)
treee5d88d25d870d5dedacb6bbdbe2a966086a0a5cf /src/pybind/mgr/dashboard/plugins/plugin.py
parentInitial commit. (diff)
downloadceph-483eb2f56657e8e7f419ab1a4fab8dce9ade8609.tar.xz
ceph-483eb2f56657e8e7f419ab1a4fab8dce9ade8609.zip
Adding upstream version 14.2.21.upstream/14.2.21upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/pybind/mgr/dashboard/plugins/plugin.py')
-rw-r--r--src/pybind/mgr/dashboard/plugins/plugin.py33
1 files changed, 33 insertions, 0 deletions
diff --git a/src/pybind/mgr/dashboard/plugins/plugin.py b/src/pybind/mgr/dashboard/plugins/plugin.py
new file mode 100644
index 00000000..0f52aefb
--- /dev/null
+++ b/src/pybind/mgr/dashboard/plugins/plugin.py
@@ -0,0 +1,33 @@
+from mgr_module import Option, Command
+
+from . import PLUGIN_MANAGER as PM
+from . import interfaces as I # noqa: E741,N812
+
+
+class SimplePlugin(I.CanMgr, I.CanLog, I.HasOptions, I.HasCommands):
+ """
+ Helper class that provides simplified creation of plugins:
+ - Default Mixins/Interfaces: CanMgr, CanLog, HasOptions & HasCommands
+ - Options are defined by OPTIONS class variable, instead from get_options hook
+ - Commands are created with by COMMANDS list of Commands() and handlers
+ (less compact than CLICommand, but allows using method instances)
+ """
+ Option = Option
+ Command = Command
+
+ @PM.add_hook
+ def get_options(self):
+ return self.OPTIONS
+
+ @PM.final
+ def get_option(self, option):
+ return self.mgr.get_module_option(option)
+
+ @PM.final
+ def set_option(self, option, value):
+ self.mgr.set_module_option(option, value)
+
+ @PM.add_hook
+ def register_commands(self):
+ for cmd in self.COMMANDS:
+ cmd.register(instance=self)