blob: 44e04028cf02fef97689bc6a5bcb6463a19e3335 (
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
52
53
54
55
56
57
58
59
60
61
62
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import abc
class CommandHook(object, metaclass=abc.ABCMeta):
"""Base class for command hooks.
:param app: Command instance being invoked
:paramtype app: cliff.command.Command
"""
def __init__(self, command):
self.cmd = command
@abc.abstractmethod
def get_parser(self, parser):
"""Return an :class:`argparse.ArgumentParser`.
:param parser: An existing ArgumentParser instance to be modified.
:paramtype parser: ArgumentParser
:returns: ArgumentParser
"""
return parser
@abc.abstractmethod
def get_epilog(self):
"Return text to add to the command help epilog."
return ''
@abc.abstractmethod
def before(self, parsed_args):
"""Called before the command's take_action() method.
:param parsed_args: The arguments to the command.
:paramtype parsed_args: argparse.Namespace
:returns: argparse.Namespace
"""
return parsed_args
@abc.abstractmethod
def after(self, parsed_args, return_code):
"""Called after the command's take_action() method.
:param parsed_args: The arguments to the command.
:paramtype parsed_args: argparse.Namespace
:param return_code: The value returned from take_action().
:paramtype return_code: int
:returns: int
"""
return return_code
|
