aws-cli/awscli/argparser.py at develop · firstval/aws-cli · GitHub

History

190 lines (163 loc) · 7.13 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

# 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.

import argparse

import sys

from awscli.compat import six

from difflib import get_close_matches

HELP_BLURB = (

"To see help text, you can run:\n"

"\n"

" aws help\n"

" aws <command> help\n"

" aws <command> <subcommand> help\n"

)

USAGE = (

"aws [options] <command> <subcommand> [<subcommand> ...] [parameters]\n"

"%s" % HELP_BLURB

)

class CommandAction(argparse.Action):

"""Custom action for CLI command arguments

Allows the choices for the argument to be mutable. The choices

are dynamically retrieved from the keys of the referenced command

table

"""

def __init__(self, option_strings, dest, command_table, **kwargs):

self.command_table = command_table

super(CommandAction, self).__init__(

option_strings, dest, choices=self.choices, **kwargs

)

def __call__(self, parser, namespace, values, option_string=None):

setattr(namespace, self.dest, values)

@property

def choices(self):

return list(self.command_table.keys())

@choices.setter

def choices(self, val):

# argparse.Action will always try to set this value upon

# instantiation, but this value should be dynamically

# generated from the command table keys. So make this a

# NOOP if argparse.Action tries to set this value.

pass

class CLIArgParser(argparse.ArgumentParser):

Formatter = argparse.RawTextHelpFormatter

# When displaying invalid choice error messages,

# this controls how many options to show per line.

ChoicesPerLine = 2

def _check_value(self, action, value):

"""

It's probably not a great idea to override a "hidden" method

but the default behavior is pretty ugly and there doesn't

seem to be any other way to change it.

"""

# converted value must be one of the choices (if specified)

if action.choices is not None and value not in action.choices:

msg = ['Invalid choice, valid choices are:\n']

for i in range(len(action.choices))[::self.ChoicesPerLine]:

current = []

for choice in action.choices[i:i+self.ChoicesPerLine]:

current.append('%-40s' % choice)

msg.append(' | '.join(current))

possible = get_close_matches(value, action.choices, cutoff=0.8)

if possible:

extra = ['\n\nInvalid choice: %r, maybe you meant:\n' % value]

for word in possible:

extra.append(' * %s' % word)

msg.extend(extra)

raise argparse.ArgumentError(action, '\n'.join(msg))

def parse_known_args(self, args, namespace=None):

parsed, remaining = super(CLIArgParser, self).parse_known_args(args, namespace)

terminal_encoding = getattr(sys.stdin, 'encoding', 'utf-8')

if terminal_encoding is None:

# In some cases, sys.stdin won't have an encoding set,

# (e.g if it's set to a StringIO). In this case we just

# default to utf-8.

terminal_encoding = 'utf-8'

for arg, value in vars(parsed).items():

if isinstance(value, six.binary_type):

setattr(parsed, arg, value.decode(terminal_encoding))

elif isinstance(value, list):

encoded = []

for v in value:

if isinstance(v, six.binary_type):

encoded.append(v.decode(terminal_encoding))

else:

encoded.append(v)

setattr(parsed, arg, encoded)

return parsed, remaining

class MainArgParser(CLIArgParser):

Formatter = argparse.RawTextHelpFormatter

def __init__(self, command_table, version_string,

description, argument_table, prog=None):

super(MainArgParser, self).__init__(

formatter_class=self.Formatter,

add_help=False,

conflict_handler='resolve',

description=description,

usage=USAGE,

prog=prog)

self._build(command_table, version_string, argument_table)

def _create_choice_help(self, choices):

help_str = ''

for choice in sorted(choices):

help_str += '* %s\n' % choice

return help_str

def _build(self, command_table, version_string, argument_table):

for argument_name in argument_table:

argument = argument_table[argument_name]

argument.add_to_parser(self)

self.add_argument('--version', action="version",

version=version_string,

help='Display the version of this tool')

self.add_argument('command', action=CommandAction,

command_table=command_table)

class ServiceArgParser(CLIArgParser):

def __init__(self, operations_table, service_name):

super(ServiceArgParser, self).__init__(

formatter_class=argparse.RawTextHelpFormatter,

add_help=False,

conflict_handler='resolve',

usage=USAGE)

self._build(operations_table)

self._service_name = service_name

def _build(self, operations_table):

self.add_argument('operation', action=CommandAction,

command_table=operations_table)

class ArgTableArgParser(CLIArgParser):

"""CLI arg parser based on an argument table."""

def __init__(self, argument_table, command_table=None):

# command_table is an optional subcommand_table. If it's passed

# in, then we'll update the argparse to parse a 'subcommand' argument

# and populate the choices field with the command table keys.

super(ArgTableArgParser, self).__init__(

formatter_class=self.Formatter,

add_help=False,

usage=USAGE,

conflict_handler='resolve')

if command_table is None:

command_table = {}

self._build(argument_table, command_table)

def _build(self, argument_table, command_table):

for arg_name in argument_table:

argument = argument_table[arg_name]

argument.add_to_parser(self)

if command_table:

self.add_argument('subcommand', action=CommandAction,

command_table=command_table, nargs='?')

def parse_known_args(self, args, namespace=None):

if len(args) == 1 and args[0] == 'help':

namespace = argparse.Namespace()

namespace.help = 'help'

return namespace, []

else:

return super(ArgTableArgParser, self).parse_known_args(

args, namespace)

aws-cli/awscli/argparser.py at develop · firstval/aws-cli · GitHub

Expand file tree

Breadcrumbs

argparser.py

Latest commit

History

Breadcrumbs

argparser.py

File metadata and controls