aws-cli/awscli/formatter.py at develop · Processoriented/aws-cli · GitHub

History

262 lines (229 loc) · 10.7 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

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

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

import sys

import json

from botocore.utils import set_value_from_jmespath

from awscli.table import MultiTable, Styler, ColorizedStyler

from awscli import text

from awscli import compat

LOG = logging.getLogger(__name__)

class Formatter(object):

def __init__(self, args):

self._args = args

def _remove_request_id(self, response_data):

# We only want to display the ResponseMetadata (which includes

# the request id) if there is an error in the response.

# Since all errors have been unified under the Errors key,

# this should be a reasonable way to filter.

if 'Errors' not in response_data:

if 'ResponseMetadata' in response_data:

if 'RequestId' in response_data['ResponseMetadata']:

request_id = response_data['ResponseMetadata']['RequestId']

LOG.debug('RequestId: %s', request_id)

del response_data['ResponseMetadata']

def _get_default_stream(self):

if getattr(sys.stdout, 'encoding', None) is None:

# In python3, sys.stdout.encoding is always set.

# In python2, if you redirect to stdout, then

# encoding is not None. In this case we'll default

# to utf-8.

return compat.get_stdout_text_writer()

else:

return sys.stdout

class FullyBufferedFormatter(Formatter):

def __call__(self, operation, response, stream=None):

if stream is None:

# Retrieve stdout on invocation instead of at import time

# so that if anything wraps stdout we'll pick up those changes

# (specifically colorama on windows wraps stdout).

stream = self._get_default_stream()

# I think the interfaces between non-paginated

# and paginated responses can still be cleaned up.

if operation.can_paginate and self._args.paginate:

response_data = response.build_full_result()

else:

response_data = response

try:

self._remove_request_id(response_data)

if self._args.query is not None:

response_data = self._args.query.search(response_data)

self._format_response(operation, response_data, stream)

finally:

# flush is needed to avoid the "close failed in file object

# destructor" in python2.x (see http://bugs.python.org/issue11380).

stream.flush()

class JSONFormatter(FullyBufferedFormatter):

def _format_response(self, operation, response, stream):

# For operations that have no response body (e.g. s3 put-object)

# the response will be an empty string. We don't want to print

# that out to the user but other "falsey" values like an empty

# dictionary should be printed.

if response:

json.dump(response, stream, indent=4)

stream.write('\n')

class TableFormatter(FullyBufferedFormatter):

"""Pretty print a table from a given response.

The table formatter is able to take any generic response

and generate a pretty printed table. It does this without

using the output definition from the model.

"""

def __init__(self, args, table=None):

super(TableFormatter, self).__init__(args)

if args.color == 'auto':

self.table = MultiTable(initial_section=False,

column_separator='|')

elif args.color == 'off':

styler = Styler()

self.table = MultiTable(initial_section=False,

column_separator='|', styler=styler)

elif args.color == 'on':

styler = ColorizedStyler()

self.table = MultiTable(initial_section=False,

column_separator='|', styler=styler)

else:

raise ValueError("Unknown color option: %s" % args.color)

def _format_response(self, operation, response, stream):

if self._build_table(operation.name, response):

try:

self.table.render(stream)

except IOError:

# If they're piping stdout to another process which exits before

# we're done writing all of our output, we'll get an error about a

# closed pipe which we can safely ignore.

pass

def _build_table(self, title, current, indent_level=0):

if not current:

return False

if title is not None:

self.table.new_section(title, indent_level=indent_level)

if isinstance(current, list):

if isinstance(current[0], dict):

self._build_sub_table_from_list(current, indent_level, title)

else:

for item in current:

if self._scalar_type(item):

self.table.add_row([item])

elif all(self._scalar_type(el) for el in item):

self.table.add_row(item)

else:

self._build_table(title=None, current=item)

if isinstance(current, dict):

# Render a single row section with keys as header

# and the row as the values, unless the value

# is a list.

self._build_sub_table_from_dict(current, indent_level)

return True

def _build_sub_table_from_dict(self, current, indent_level):

# Render a single row section with keys as header

# and the row as the values, unless the value

# is a list.

headers, more = self._group_scalar_keys(current)

if len(headers) == 1:

# Special casing if a dict has a single scalar key/value pair.

self.table.add_row([headers[0], current[headers[0]]])

elif headers:

self.table.add_row_header(headers)

self.table.add_row([current[k] for k in headers])

for remaining in more:

self._build_table(remaining, current[remaining],

indent_level=indent_level + 1)

def _build_sub_table_from_list(self, current, indent_level, title):

headers, more = self._group_scalar_keys_from_list(current)

self.table.add_row_header(headers)

first = True

for element in current:

if not first and more:

self.table.new_section(title,

indent_level=indent_level)

self.table.add_row_header(headers)

first = False

# Use .get() to account for the fact that sometimes an element

# may not have all the keys from the header.

self.table.add_row([element.get(header, '') for header in headers])

for remaining in more:

# Some of the non scalar attributes may not necessarily

# be in every single element of the list, so we need to

# check this condition before recursing.

if remaining in element:

self._build_table(remaining, element[remaining],

indent_level=indent_level + 1)

def _scalar_type(self, element):

return not isinstance(element, (list, dict))

def _group_scalar_keys_from_list(self, list_of_dicts):

# We want to make sure we catch all the keys in the list of dicts.

# Most of the time each list element has the same keys, but sometimes

# a list element will have keys not defined in other elements.

headers = set()

more = set()

for item in list_of_dicts:

current_headers, current_more = self._group_scalar_keys(item)

headers.update(current_headers)

more.update(current_more)

headers = list(sorted(headers))

more = list(sorted(more))

return headers, more

def _group_scalar_keys(self, current):

# Given a dict, separate the keys into those whose values are

# scalar, and those whose values aren't. Return two lists,

# one is the scalar value keys, the second is the remaining keys.

more = []

headers = []

for element in current:

if self._scalar_type(current[element]):

headers.append(element)

else:

more.append(element)

headers.sort()

more.sort()

return headers, more

class TextFormatter(Formatter):

def __call__(self, operation, response, stream=None):

if stream is None:

stream = self._get_default_stream()

try:

if operation.can_paginate and self._args.paginate:

result_keys = response.result_keys

for _, page in response:

current = {}

for result_key in result_keys:

data = result_key.search(page)

set_value_from_jmespath(

current,

result_key.expression,

data

)

self._format_response(current, stream)

if response.resume_token:

# Tell the user about the next token so they can continue

# if they want.

self._format_response(

{'NextToken': {'NextToken': response.resume_token}},

stream)

else:

self._remove_request_id(response)

self._format_response(response, stream)

finally:

# flush is needed to avoid the "close failed in file object

# destructor" in python2.x (see http://bugs.python.org/issue11380).

stream.flush()

def _format_response(self, response, stream):

if self._args.query is not None:

expression = self._args.query

response = expression.search(response)

text.format_text(response, stream)

def get_formatter(format_type, args):

if format_type == 'json':

return JSONFormatter(args)

elif format_type == 'text':

return TextFormatter(args)

elif format_type == 'table':

return TableFormatter(args)

raise ValueError("Unknown output type: %s" % format_type)

aws-cli/awscli/formatter.py at develop · Processoriented/aws-cli · GitHub

Expand file tree

Breadcrumbs

formatter.py

Latest commit

History

Breadcrumbs

formatter.py

File metadata and controls