blob: 7dfe749036d81878698b686dab289c7eda88c47a (
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
42
43
44
45
46
47
48
49
50
51
|
import abc
import argparse
import inspect
import six
@six.add_metaclass(abc.ABCMeta)
class Command(object):
"""Base class for command plugins.
:param app: Application instance invoking the command.
:paramtype app: cliff.app.App
"""
def __init__(self, app, app_args):
self.app = app
self.app_args = app_args
return
def get_description(self):
"""Return the command description.
"""
return inspect.getdoc(self.__class__) or ''
def get_parser(self, prog_name):
"""Return an :class:`argparse.ArgumentParser`.
"""
parser = argparse.ArgumentParser(
description=self.get_description(),
prog=prog_name,
)
return parser
@abc.abstractmethod
def take_action(self, parsed_args):
"""Override to do something useful.
"""
def run(self, parsed_args):
"""Invoked by the application when the command is run.
Developers implementing commands should override
:meth:`take_action`.
Developers creating new command base classes (such as
:class:`Lister` and :class:`ShowOne`) should override this
method to wrap :meth:`take_action`.
"""
self.take_action(parsed_args)
return 0
|
