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
|
#
# coding=utf-8
"""An example cmd2 plugin"""
import functools
from typing import (
TYPE_CHECKING,
Callable,
)
import cmd2
if TYPE_CHECKING: # pragma: no cover
_Base = cmd2.Cmd
else:
_Base = object
def empty_decorator(func: Callable) -> Callable:
"""An empty decorator for myplugin"""
@functools.wraps(func)
def _empty_decorator(self, *args, **kwargs):
self.poutput("in the empty decorator")
func(self, *args, **kwargs)
_empty_decorator.__doc__ = func.__doc__
return _empty_decorator
class MyPluginMixin(_Base):
"""A mixin class which adds a 'say' command to a cmd2 subclass
The order in which you add the mixin matters. Say you want to
use this mixin in a class called MyApp.
class MyApp(cmd2_myplugin.MyPlugin, cmd2.Cmd):
def __init__(self, *args, **kwargs):
# gotta have this or neither the plugin or cmd2 will initialize
super().__init__(*args, **kwargs)
"""
def __init__(self, *args, **kwargs):
# code placed here runs before cmd2 initializes
super().__init__(*args, **kwargs)
# code placed here runs after cmd2 initializes
# this is where you register any hook functions
self.register_preloop_hook(self.cmd2_myplugin_preloop_hook)
self.register_postloop_hook(self.cmd2_myplugin_postloop_hook)
self.register_postparsing_hook(self.cmd2_myplugin_postparsing_hook)
def do_say(self, statement):
"""Simple say command"""
self.poutput(statement)
#
# define hooks as functions, not methods
def cmd2_myplugin_preloop_hook(self) -> None:
"""Method to be called before the command loop begins"""
self.poutput("preloop hook")
def cmd2_myplugin_postloop_hook(self) -> None:
"""Method to be called after the command loop finishes"""
self.poutput("postloop hook")
def cmd2_myplugin_postparsing_hook(self, data: cmd2.plugin.PostparsingData) -> cmd2.plugin.PostparsingData:
"""Method to be called after parsing user input, but before running the command"""
self.poutput('in postparsing hook')
return data
|
