From e5c5b216f2bd2de6a3c3c777e605d2cb83f215dc Mon Sep 17 00:00:00 2001 From: Ernesto Puerta Date: Thu, 10 Oct 2019 11:19:59 +0200 Subject: [PATCH] mgr/dashboard: add SimplePlugin helper Helper added to simplify common tasks when creating a new plugin (OPTIONS, COMMANDS, etc). Fixes: https://tracker.ceph.com/issues/41990 Signed-off-by: Ernesto Puerta --- src/pybind/mgr/dashboard/plugins/plugin.py | 33 ++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 src/pybind/mgr/dashboard/plugins/plugin.py diff --git a/src/pybind/mgr/dashboard/plugins/plugin.py b/src/pybind/mgr/dashboard/plugins/plugin.py new file mode 100644 index 00000000000..0f52aefbf95 --- /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) -- 2.47.3