FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
aws-cli/awscli/customizations/flatten.py at develop · ProGamerCode/aws-cli · GitHub
ProGamerCode
/
aws-cli
Public
forked from
aws/aws-cli
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
0
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
aws-cli
/
awscli
/
customizations
/
flatten.py
Copy path
More file actions
More file actions
Latest commit
History
History
History
244 lines (201 loc) · 9.28 KB
Breadcrumbs
aws-cli
/
awscli
/
customizations
/
flatten.py
Copy path
File metadata and controls
244 lines (201 loc) · 9.28 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
# Copyright 2014 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.
import
logging
from
awscli
.
arguments
import
CustomArgument
LOG
=
logging
.
getLogger
(
__name__
)
# Nested argument member separator
SEP
=
'.'
class
FlattenedArgument
(
CustomArgument
):
"""
A custom argument which has been flattened from an existing structure. When
added to the call params it is hydrated back into the structure.
Supports both an object and a list of objects, in which case the flattened
parameters will hydrate a list with a single object in it.
"""
def
__init__
(
self
,
name
,
container
,
prop
,
help_text
=
''
,
required
=
None
,
type
=
None
,
hydrate
=
None
,
hydrate_value
=
None
):
self
.
type
=
type
self
.
_container
=
container
self
.
_property
=
prop
self
.
_hydrate
=
hydrate
self
.
_hydrate_value
=
hydrate_value
super
(
FlattenedArgument
,
self
).
__init__
(
name
=
name
,
help_text
=
help_text
,
required
=
required
)
@
property
def
cli_type_name
(
self
):
return
self
.
type
def
add_to_params
(
self
,
parameters
,
value
):
"""
Hydrate the original structure with the value of this flattened
argument.
TODO: This does not hydrate nested structures (``XmlName1.XmlName2``)!
To do this for now you must provide your own ``hydrate`` method.
"""
container
=
self
.
_container
.
argument_model
.
name
cli_type
=
self
.
_container
.
cli_type_name
key
=
self
.
_property
LOG
.
debug
(
'Hydrating {0}[{1}]'
.
format
(
container
,
key
))
if
value
is
not
None
:
# Convert type if possible
if
self
.
type
==
'boolean'
:
value
=
not
value
.
lower
()
==
'false'
elif
self
.
type
in
[
'integer'
,
'long'
]:
value
=
int
(
value
)
elif
self
.
type
in
[
'float'
,
'double'
]:
value
=
float
(
value
)
if
self
.
_hydrate
:
self
.
_hydrate
(
parameters
,
container
,
cli_type
,
key
,
value
)
else
:
if
container
not
in
parameters
:
if
cli_type
==
'list'
:
parameters
[
container
]
=
[{}]
else
:
parameters
[
container
]
=
{}
if
self
.
_hydrate_value
:
value
=
self
.
_hydrate_value
(
value
)
if
cli_type
==
'list'
:
parameters
[
container
][
0
][
key
]
=
value
else
:
parameters
[
container
][
key
]
=
value
class
FlattenArguments
(
object
):
"""
Flatten arguments for one or more commands for a particular service from
a given configuration which maps service call parameters to flattened
names. Takes in a configuration dict of the form::
{
"command-cli-name": {
"argument-cli-name": {
"keep": False,
"flatten": {
"XmlName": {
"name": "flattened-cli-name",
"type": "Optional custom type",
"required": "Optional custom required",
"help_text": "Optional custom docs",
"hydrate_value": Optional function to hydrate value,
"hydrate": Optional function to hydrate
},
...
}
},
...
},
...
}
The ``type``, ``required`` and ``help_text`` arguments are entirely
optional and by default are pulled from the model. You should only set them
if you wish to override the default values in the model.
The ``keep`` argument determines whether the original command is still
accessible vs. whether it is removed. It defaults to ``False`` if not
present, which removes the original argument.
The keys inside of ``flatten`` (e.g. ``XmlName`` above) can include nested
references to structures via a colon. For example, ``XmlName1:XmlName2``
for the following structure::
{
"XmlName1": {
"XmlName2": ...
}
}
The ``hydrate_value`` function takes in a value and should return a value.
It is only called when the value is not ``None``. Example::
"hydrate_value": lambda (value): value.upper()
The ``hydrate`` function takes in a list of existing parameters, the name
of the container, its type, the name of the container key and its set
value. For the example above, the container would be
``'argument-cli-name'``, the key would be ``'XmlName'`` and the value
whatever the user passed in. Example::
def my_hydrate(params, container, cli_type, key, value):
if container not in params:
params[container] = {'default': 'values'}
params[container][key] = value
It's possible for ``cli_type`` to be ``list``, in which case you should
ensure that a list of one or more objects is hydrated rather than a
single object.
"""
def
__init__
(
self
,
service_name
,
configs
):
self
.
configs
=
configs
self
.
service_name
=
service_name
def
register
(
self
,
cli
):
"""
Register with a CLI instance, listening for events that build the
argument table for operations in the configuration dict.
"""
# Flatten each configured operation when they are built
service
=
self
.
service_name
for
operation
in
self
.
configs
:
cli
.
register
(
'building-argument-table.{0}.{1}'
.
format
(
service
,
operation
),
self
.
flatten_args
)
def
flatten_args
(
self
,
command
,
argument_table
,
**
kwargs
):
# For each argument with a bag of parameters
for
name
,
argument
in
self
.
configs
[
command
.
name
].
items
():
argument_from_table
=
argument_table
[
name
]
overwritten
=
False
LOG
.
debug
(
'Flattening {0} argument {1} into {2}'
.
format
(
command
.
name
,
name
,
', '
.
join
([
v
[
'name'
]
for
k
,
v
in
argument
[
'flatten'
].
items
()])
))
# For each parameter to flatten out
for
sub_argument
,
new_config
in
argument
[
'flatten'
].
items
():
config
=
new_config
.
copy
()
config
[
'container'
]
=
argument_from_table
config
[
'prop'
]
=
sub_argument
# Handle nested arguments
_arg
=
self
.
_find_nested_arg
(
argument_from_table
.
argument_model
,
sub_argument
)
# Pull out docs and required attribute
self
.
_merge_member_config
(
_arg
,
sub_argument
,
config
)
# Create and set the new flattened argument
new_arg
=
FlattenedArgument
(
**
config
)
argument_table
[
new_config
[
'name'
]]
=
new_arg
if
name
==
new_config
[
'name'
]:
overwritten
=
True
# Delete the original argument?
if
not
overwritten
and
(
'keep'
not
in
argument
or
not
argument
[
'keep'
]):
del
argument_table
[
name
]
def
_find_nested_arg
(
self
,
argument
,
name
):
"""
Find and return a nested argument, if it exists. If no nested argument
is requested then the original argument is returned. If the nested
argument cannot be found, then a ValueError is raised.
"""
if
SEP
in
name
:
# Find the actual nested argument to pull out
LOG
.
debug
(
'Finding nested argument in {0}'
.
format
(
name
))
for
piece
in
name
.
split
(
SEP
)[:
-
1
]:
for
member_name
,
member
in
argument
.
members
.
items
():
if
member_name
==
piece
:
argument
=
member
break
else
:
raise
ValueError
(
'Invalid piece {0}'
.
format
(
piece
))
return
argument
def
_merge_member_config
(
self
,
argument
,
name
,
config
):
"""
Merges an existing config taken from the configuration dict with an
existing member of an existing argument object. This pulls in
attributes like ``required`` and ``help_text`` if they have not been
overridden in the configuration dict. Modifies the config in-place.
"""
# Pull out docs and required attribute
for
member_name
,
member
in
argument
.
members
.
items
():
if
member_name
==
name
.
split
(
SEP
)[
-
1
]:
if
'help_text'
not
in
config
:
config
[
'help_text'
]
=
member
.
documentation
if
'required'
not
in
config
:
config
[
'required'
]
=
member_name
in
argument
.
required_members
if
'type'
not
in
config
:
config
[
'type'
]
=
member
.
type_name
break
Back
|
FazBrowse Home
|
New Git URL