diff options
Diffstat (limited to '')
-rw-r--r-- | src/pybind/mgr/dashboard/plugins/plugin.py | 41 |
1 files changed, 41 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 000000000..847a61872 --- /dev/null +++ b/src/pybind/mgr/dashboard/plugins/plugin.py @@ -0,0 +1,41 @@ +from mgr_module import Command, Option + +from . import PLUGIN_MANAGER as PM +from . import interfaces as I # noqa: E741,N812 + +try: + from typing import no_type_check +except ImportError: + no_type_check = object() # Just for type checking + + +class SimplePlugin(I.CanMgr, I.HasOptions, I.HasCommands): + """ + Helper class that provides simplified creation of plugins: + - Default Mixins/Interfaces: CanMgr, 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 # type: ignore + + @PM.final + @no_type_check # https://github.com/python/mypy/issues/7806 + def get_option(self, option): + return self.mgr.get_module_option(option) + + @PM.final + @no_type_check # https://github.com/python/mypy/issues/7806 + def set_option(self, option, value): + self.mgr.set_module_option(option, value) + + @PM.add_hook + @no_type_check # https://github.com/python/mypy/issues/7806 + def register_commands(self): + for cmd in self.COMMANDS: + cmd.register(instance=self) |