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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
# coding=utf-8
"""
Supports the definition of commands in separate classes to be composed into cmd2.Cmd
"""
import functools
from typing import Callable, Iterable, Optional, Type
from .constants import COMMAND_FUNC_PREFIX
from .exceptions import CommandSetRegistrationError
# Allows IDEs to resolve types without impacting imports at runtime, breaking circular dependency issues
try: # pragma: no cover
from typing import TYPE_CHECKING
if TYPE_CHECKING:
import cmd2
except ImportError: # pragma: no cover
pass
def _partial_passthru(func: Callable, *args, **kwargs) -> functools.partial:
"""
Constructs a partial function that passes arguments through to the wrapped function.
Must construct a new type every time so that each wrapped function's __doc__ can be copied correctly.
:param func: wrapped function
:param args: positional arguments
:param kwargs: keyword arguments
:return: partial function that exposes attributes of wrapped function
"""
def __getattr__(self, item):
return getattr(self.func, item)
def __setattr__(self, key, value):
return setattr(self.func, key, value)
def __dir__(self) -> Iterable[str]:
return dir(self.func)
passthru_type = type('PassthruPartial' + func.__name__,
(functools.partial,),
{
'__getattr__': __getattr__,
'__setattr__': __setattr__,
'__dir__': __dir__,
})
passthru_type.__doc__ = func.__doc__
return passthru_type(func, *args, **kwargs)
def with_default_category(category: str):
"""
Decorator that applies a category to all ``do_*`` command methods in a class that do not already
have a category specified.
:param category: category to put all uncategorized commands in
:return: decorator function
"""
def decorate_class(cls: Type[CommandSet]):
from .constants import CMD_ATTR_HELP_CATEGORY
import inspect
from .decorators import with_category
methods = inspect.getmembers(
cls,
predicate=lambda meth: inspect.isfunction(meth) and meth.__name__.startswith(COMMAND_FUNC_PREFIX))
category_decorator = with_category(category)
for method in methods:
if not hasattr(method[1], CMD_ATTR_HELP_CATEGORY):
setattr(cls, method[0], category_decorator(method[1]))
return cls
return decorate_class
class CommandSet(object):
"""
Base class for defining sets of commands to load in cmd2.
``with_default_category`` can be used to apply a default category to all commands in the CommandSet.
``do_``, ``help_``, and ``complete_`` functions differ only in that they're now required to accept
a reference to ``cmd2.Cmd`` as the first argument after self.
"""
def __init__(self):
self._cmd = None # type: Optional[cmd2.Cmd]
def on_register(self, cmd):
"""
Called by cmd2.Cmd when a CommandSet is registered. Subclasses can override this
to perform an initialization requiring access to the Cmd object.
:param cmd: The cmd2 main application
:type cmd: cmd2.Cmd
"""
if self._cmd is None:
self._cmd = cmd
else:
raise CommandSetRegistrationError('This CommandSet has already been registered')
def on_unregister(self, cmd):
"""
Called by ``cmd2.Cmd`` when a CommandSet is unregistered and removed.
:param cmd:
:type cmd: cmd2.Cmd
"""
self._cmd = None
|
