diff options
Diffstat (limited to 'kvmd/plugins/__init__.py')
| -rw-r--r-- | kvmd/plugins/__init__.py | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/kvmd/plugins/__init__.py b/kvmd/plugins/__init__.py new file mode 100644 index 00000000..87510e9c --- /dev/null +++ b/kvmd/plugins/__init__.py @@ -0,0 +1,71 @@ +# ========================================================================== # +# # +# KVMD - The main Pi-KVM daemon. # +# # +# Copyright (C) 2018 Maxim Devaev <[email protected]> # +# # +# This program is free software: you can redistribute it and/or modify # +# it under the terms of the GNU General Public License as published by # +# the Free Software Foundation, either version 3 of the License, or # +# (at your option) any later version. # +# # +# This program is distributed in the hope that it will be useful, # +# but WITHOUT ANY WARRANTY; without even the implied warranty of # +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # +# GNU General Public License for more details. # +# # +# You should have received a copy of the GNU General Public License # +# along with this program. If not, see <https://www.gnu.org/licenses/>. # +# # +# ========================================================================== # + + +import importlib +import functools +import os + +from typing import Dict +from typing import Type +from typing import Any + +from ..yamlconf import Option + + +# ===== +class UnknownPluginError(Exception): + pass + + +# ===== +class BasePlugin: + PLUGIN_NAME: str = "" + + def __init__(self, **_: Any) -> None: + pass + + @classmethod + def get_options(cls) -> Dict[str, Option]: + return {} + + +# ===== +def get_plugin_class(sub: str, name: str) -> Type[BasePlugin]: + classes = _get_plugin_classes(sub) + try: + return classes[name] + except KeyError: + raise UnknownPluginError("Unknown plugin '%s/%s'" % (sub, name)) + + +# ===== [email protected]_cache() +def _get_plugin_classes(sub: str) -> Dict[str, Type[BasePlugin]]: + classes: Dict[str, Type[BasePlugin]] = {} # noqa: E701 + sub_path = os.path.join(os.path.dirname(__file__), sub) + for file_name in os.listdir(sub_path): + if not file_name.startswith("__") and file_name.endswith(".py"): + module_name = file_name[:-3] + module = importlib.import_module("kvmd.plugins.{}.{}".format(sub, module_name)) + plugin_class = getattr(module, "Plugin") + classes[plugin_class.PLUGIN_NAME] = plugin_class + return classes |