blob: 847a61872677f80e6603c5d3ac2358b39374b1f3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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)
|
