forked from aws/aws-cli
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathcommands.py
More file actions
70 lines (54 loc) · 2.06 KB
/
commands.py
File metadata and controls
70 lines (54 loc) · 2.06 KB
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
# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
class CLICommand(object):
"""Interface for a CLI command.
This class represents a top level CLI command
(``aws ec2``, ``aws s3``, ``aws config``).
"""
@property
def name(self):
# Subclasses must implement a name.
raise NotImplementedError("name")
@name.setter
def name(self, value):
# Subclasses must implement setting/changing the cmd name.
raise NotImplementedError("name")
@property
def lineage(self):
# Represents how to get to a specific command using the CLI.
# It includes all commands that came before it and itself in
# a list.
return [self]
@property
def lineage_names(self):
# Represents the lineage of a command in terms of command ``name``
return [cmd.name for cmd in self.lineage]
def __call__(self, args, parsed_globals):
"""Invoke CLI operation.
:type args: str
:param args: The remaining command line args.
:type parsed_globals: ``argparse.Namespace``
:param parsed_globals: The parsed arguments so far.
:rtype: int
:return: The return code of the operation. This will be used
as the RC code for the ``aws`` process.
"""
# Subclasses are expected to implement this method.
pass
def create_help_command(self):
# Subclasses are expected to implement this method if they want
# help docs.
return None
@property
def arg_table(self):
return {}