root / kamaki / cli / commands / __init__.py @ 27d3b17d
History | View | Annotate | Download (12.8 kB)
1 | 27d3b17d | Stavros Sachtouris | # Copyright 2011-2014 GRNET S.A. All rights reserved.
|
---|---|---|---|
2 | 5eae854d | Stavros Sachtouris | #
|
3 | 5eae854d | Stavros Sachtouris | # Redistribution and use in source and binary forms, with or
|
4 | 5eae854d | Stavros Sachtouris | # without modification, are permitted provided that the following
|
5 | 5eae854d | Stavros Sachtouris | # conditions are met:
|
6 | 5eae854d | Stavros Sachtouris | #
|
7 | 5eae854d | Stavros Sachtouris | # 1. Redistributions of source code must retain the above
|
8 | 5eae854d | Stavros Sachtouris | # copyright notice, this list of conditions and the following
|
9 | 5eae854d | Stavros Sachtouris | # disclaimer.
|
10 | 5eae854d | Stavros Sachtouris | #
|
11 | 5eae854d | Stavros Sachtouris | # 2. Redistributions in binary form must reproduce the above
|
12 | 5eae854d | Stavros Sachtouris | # copyright notice, this list of conditions and the following
|
13 | 5eae854d | Stavros Sachtouris | # disclaimer in the documentation and/or other materials
|
14 | 5eae854d | Stavros Sachtouris | # provided with the distribution.
|
15 | 5eae854d | Stavros Sachtouris | #
|
16 | 5eae854d | Stavros Sachtouris | # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
|
17 | 5eae854d | Stavros Sachtouris | # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
18 | 5eae854d | Stavros Sachtouris | # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
19 | 5eae854d | Stavros Sachtouris | # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
|
20 | 5eae854d | Stavros Sachtouris | # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
21 | 5eae854d | Stavros Sachtouris | # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
22 | 5eae854d | Stavros Sachtouris | # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
23 | 5eae854d | Stavros Sachtouris | # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
24 | 5eae854d | Stavros Sachtouris | # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
25 | 5eae854d | Stavros Sachtouris | # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
26 | 5eae854d | Stavros Sachtouris | # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
27 | 5eae854d | Stavros Sachtouris | # POSSIBILITY OF SUCH DAMAGE.
|
28 | 5eae854d | Stavros Sachtouris | #
|
29 | 5eae854d | Stavros Sachtouris | # The views and conclusions contained in the software and
|
30 | 5eae854d | Stavros Sachtouris | # documentation are those of the authors and should not be
|
31 | 5eae854d | Stavros Sachtouris | # interpreted as representing official policies, either expressed
|
32 | 5eae854d | Stavros Sachtouris | # or implied, of GRNET S.A.command
|
33 | 5eae854d | Stavros Sachtouris | |
34 | 137c51f5 | Stavros Sachtouris | from kamaki.cli.logger import get_logger |
35 | ddcb2e09 | Stavros Sachtouris | from kamaki.cli.utils import ( |
36 | ddcb2e09 | Stavros Sachtouris | print_list, print_dict, print_json, print_items, ask_user, |
37 | ddcb2e09 | Stavros Sachtouris | filter_dicts_by_dict) |
38 | 6d190dd1 | Stavros Sachtouris | from kamaki.cli.argument import FlagArgument, ValueArgument |
39 | f76c6bbc | Stavros Sachtouris | from kamaki.cli.errors import CLIInvalidArgument |
40 | ff1c0296 | Stavros Sachtouris | from sys import stdin, stdout, stderr |
41 | 6069b53b | Stavros Sachtouris | |
42 | 0d4a6d0a | Stavros Sachtouris | log = get_logger(__name__) |
43 | 6069b53b | Stavros Sachtouris | |
44 | 234954d1 | Stavros Sachtouris | |
45 | 392d902d | Stavros Sachtouris | def DontRaiseKeyError(func): |
46 | b4f69041 | Stavros Sachtouris | def wrap(*args, **kwargs): |
47 | b4f69041 | Stavros Sachtouris | try:
|
48 | 392d902d | Stavros Sachtouris | return func(*args, **kwargs)
|
49 | b4f69041 | Stavros Sachtouris | except KeyError: |
50 | b4f69041 | Stavros Sachtouris | return None |
51 | b4f69041 | Stavros Sachtouris | return wrap
|
52 | b4f69041 | Stavros Sachtouris | |
53 | b4f69041 | Stavros Sachtouris | |
54 | 392d902d | Stavros Sachtouris | def addLogSettings(func): |
55 | b4f69041 | Stavros Sachtouris | def wrap(self, *args, **kwargs): |
56 | b4f69041 | Stavros Sachtouris | try:
|
57 | 392d902d | Stavros Sachtouris | return func(self, *args, **kwargs) |
58 | b4f69041 | Stavros Sachtouris | finally:
|
59 | b4f69041 | Stavros Sachtouris | self._set_log_params()
|
60 | b4f69041 | Stavros Sachtouris | return wrap
|
61 | b4f69041 | Stavros Sachtouris | |
62 | b4f69041 | Stavros Sachtouris | |
63 | c75be81a | Stavros Sachtouris | def dataModification(func): |
64 | c75be81a | Stavros Sachtouris | def wrap(self, inp): |
65 | c75be81a | Stavros Sachtouris | try:
|
66 | c75be81a | Stavros Sachtouris | inp = func(self, inp)
|
67 | c75be81a | Stavros Sachtouris | except Exception as e: |
68 | c75be81a | Stavros Sachtouris | log.warning('WARNING: Error while running %s: %s' % (func, e))
|
69 | c75be81a | Stavros Sachtouris | log.warning('\tWARNING: Kamaki will use original data to go on')
|
70 | c75be81a | Stavros Sachtouris | finally:
|
71 | c75be81a | Stavros Sachtouris | return inp
|
72 | c75be81a | Stavros Sachtouris | return wrap
|
73 | c75be81a | Stavros Sachtouris | |
74 | c75be81a | Stavros Sachtouris | |
75 | 5eae854d | Stavros Sachtouris | class _command_init(object): |
76 | 36526b3c | Stavros Sachtouris | |
77 | 56d84a4e | Stavros Sachtouris | # self.arguments (dict) contains all non-positional arguments
|
78 | 56d84a4e | Stavros Sachtouris | # self.required (list or tuple) contains required argument keys
|
79 | 56d84a4e | Stavros Sachtouris | # if it is a list, at least one of these arguments is required
|
80 | 56d84a4e | Stavros Sachtouris | # if it is a tuple, all arguments are required
|
81 | 56d84a4e | Stavros Sachtouris | # Lists and tuples can nest other lists and/or tuples
|
82 | 56d84a4e | Stavros Sachtouris | |
83 | 1757c616 | Stavros Sachtouris | def __init__( |
84 | 1757c616 | Stavros Sachtouris | self,
|
85 | ff1c0296 | Stavros Sachtouris | arguments={}, auth_base=None, cloud=None, |
86 | ff1c0296 | Stavros Sachtouris | _in=None, _out=None, _err=None): |
87 | ff1c0296 | Stavros Sachtouris | self._in, self._out, self._err = ( |
88 | ff1c0296 | Stavros Sachtouris | _in or stdin, _out or stdout, _err or stderr) |
89 | 20206179 | Stavros Sachtouris | self.required = getattr(self, 'required', None) |
90 | e15d78e2 | Stavros Sachtouris | if hasattr(self, 'arguments'): |
91 | e15d78e2 | Stavros Sachtouris | arguments.update(self.arguments)
|
92 | 915b99b5 | Stavros Sachtouris | if isinstance(self, _optional_output_cmd): |
93 | 915b99b5 | Stavros Sachtouris | arguments.update(self.oo_arguments)
|
94 | 545c6c29 | Stavros Sachtouris | if isinstance(self, _optional_json): |
95 | 545c6c29 | Stavros Sachtouris | arguments.update(self.oj_arguments)
|
96 | 6d190dd1 | Stavros Sachtouris | if isinstance(self, _name_filter): |
97 | 6d190dd1 | Stavros Sachtouris | arguments.update(self.nf_arguments)
|
98 | 6d190dd1 | Stavros Sachtouris | if isinstance(self, _id_filter): |
99 | 6d190dd1 | Stavros Sachtouris | arguments.update(self.if_arguments)
|
100 | 60c42f9f | Stavros Sachtouris | try:
|
101 | 60c42f9f | Stavros Sachtouris | arguments.update(self.wait_arguments)
|
102 | 60c42f9f | Stavros Sachtouris | except AttributeError: |
103 | 60c42f9f | Stavros Sachtouris | pass
|
104 | e15d78e2 | Stavros Sachtouris | self.arguments = dict(arguments) |
105 | 5eae854d | Stavros Sachtouris | try:
|
106 | e15d78e2 | Stavros Sachtouris | self.config = self['config'] |
107 | 5eae854d | Stavros Sachtouris | except KeyError: |
108 | 5eae854d | Stavros Sachtouris | pass
|
109 | 844a6bdb | Stavros Sachtouris | self.auth_base = auth_base or getattr(self, 'auth_base', None) |
110 | 844a6bdb | Stavros Sachtouris | self.cloud = cloud or getattr(self, 'cloud', None) |
111 | 5eae854d | Stavros Sachtouris | |
112 | ff1c0296 | Stavros Sachtouris | def write(self, s): |
113 | a5b748c2 | Stavros Sachtouris | self._out.write('%s' % s) |
114 | ff1c0296 | Stavros Sachtouris | self._out.flush()
|
115 | ff1c0296 | Stavros Sachtouris | |
116 | ff1c0296 | Stavros Sachtouris | def writeln(self, s=''): |
117 | a5b748c2 | Stavros Sachtouris | self.write('%s\n' % s) |
118 | ff1c0296 | Stavros Sachtouris | |
119 | ff1c0296 | Stavros Sachtouris | def error(self, s=''): |
120 | a5b748c2 | Stavros Sachtouris | self._err.write('%s\n' % s) |
121 | ff1c0296 | Stavros Sachtouris | self._err.flush()
|
122 | ff1c0296 | Stavros Sachtouris | |
123 | ddcb2e09 | Stavros Sachtouris | def print_list(self, *args, **kwargs): |
124 | ddcb2e09 | Stavros Sachtouris | kwargs.setdefault('out', self._out) |
125 | 76f58e2e | Stavros Sachtouris | return print_list(*args, **kwargs)
|
126 | ddcb2e09 | Stavros Sachtouris | |
127 | ddcb2e09 | Stavros Sachtouris | def print_dict(self, *args, **kwargs): |
128 | ddcb2e09 | Stavros Sachtouris | kwargs.setdefault('out', self._out) |
129 | 76f58e2e | Stavros Sachtouris | return print_dict(*args, **kwargs)
|
130 | ddcb2e09 | Stavros Sachtouris | |
131 | ddcb2e09 | Stavros Sachtouris | def print_json(self, *args, **kwargs): |
132 | ddcb2e09 | Stavros Sachtouris | kwargs.setdefault('out', self._out) |
133 | 76f58e2e | Stavros Sachtouris | return print_json(*args, **kwargs)
|
134 | ddcb2e09 | Stavros Sachtouris | |
135 | ddcb2e09 | Stavros Sachtouris | def print_items(self, *args, **kwargs): |
136 | ddcb2e09 | Stavros Sachtouris | kwargs.setdefault('out', self._out) |
137 | 76f58e2e | Stavros Sachtouris | return print_items(*args, **kwargs)
|
138 | ddcb2e09 | Stavros Sachtouris | |
139 | ddcb2e09 | Stavros Sachtouris | def ask_user(self, *args, **kwargs): |
140 | ddcb2e09 | Stavros Sachtouris | kwargs.setdefault('user_in', self._in) |
141 | ddcb2e09 | Stavros Sachtouris | kwargs.setdefault('out', self._out) |
142 | 76f58e2e | Stavros Sachtouris | return ask_user(*args, **kwargs)
|
143 | ddcb2e09 | Stavros Sachtouris | |
144 | b4f69041 | Stavros Sachtouris | @DontRaiseKeyError
|
145 | b4f69041 | Stavros Sachtouris | def _custom_url(self, service): |
146 | 144b3551 | Stavros Sachtouris | return self.config.get_cloud(self.cloud, '%s_url' % service) |
147 | b4f69041 | Stavros Sachtouris | |
148 | b4f69041 | Stavros Sachtouris | @DontRaiseKeyError
|
149 | b4f69041 | Stavros Sachtouris | def _custom_token(self, service): |
150 | 144b3551 | Stavros Sachtouris | return self.config.get_cloud(self.cloud, '%s_token' % service) |
151 | b4f69041 | Stavros Sachtouris | |
152 | b4f69041 | Stavros Sachtouris | @DontRaiseKeyError
|
153 | b4f69041 | Stavros Sachtouris | def _custom_type(self, service): |
154 | 144b3551 | Stavros Sachtouris | return self.config.get_cloud(self.cloud, '%s_type' % service) |
155 | b4f69041 | Stavros Sachtouris | |
156 | b4f69041 | Stavros Sachtouris | @DontRaiseKeyError
|
157 | b4f69041 | Stavros Sachtouris | def _custom_version(self, service): |
158 | 144b3551 | Stavros Sachtouris | return self.config.get_cloud(self.cloud, '%s_version' % service) |
159 | b4f69041 | Stavros Sachtouris | |
160 | f1e5b343 | Stavros Sachtouris | def _uuids2usernames(self, uuids): |
161 | db93db3e | Stavros Sachtouris | return self.auth_base.post_user_catalogs(uuids) |
162 | f1e5b343 | Stavros Sachtouris | |
163 | f1e5b343 | Stavros Sachtouris | def _usernames2uuids(self, username): |
164 | db93db3e | Stavros Sachtouris | return self.auth_base.post_user_catalogs(displaynames=username) |
165 | f1e5b343 | Stavros Sachtouris | |
166 | 95641ecc | Stavros Sachtouris | def _uuid2username(self, uuid): |
167 | f1e5b343 | Stavros Sachtouris | return self._uuids2usernames([uuid]).get(uuid, None) |
168 | 95641ecc | Stavros Sachtouris | |
169 | 95641ecc | Stavros Sachtouris | def _username2uuid(self, username): |
170 | f1e5b343 | Stavros Sachtouris | return self._usernames2uuids([username]).get(username, None) |
171 | 95641ecc | Stavros Sachtouris | |
172 | f47417e7 | Stavros Sachtouris | def _set_log_params(self): |
173 | b3bb083f | Stavros Sachtouris | try:
|
174 | 64a3c0de | Stavros Sachtouris | self.client.LOG_TOKEN = (
|
175 | 534e7bbb | Stavros Sachtouris | self['config'].get('global', 'log_token').lower() == 'on') |
176 | 64a3c0de | Stavros Sachtouris | except Exception as e: |
177 | 64a3c0de | Stavros Sachtouris | log.debug('Failed to read custom log_token setting:'
|
178 | 64a3c0de | Stavros Sachtouris | '%s\n default for log_token is off' % e)
|
179 | 64a3c0de | Stavros Sachtouris | try:
|
180 | 64a3c0de | Stavros Sachtouris | self.client.LOG_DATA = (
|
181 | 534e7bbb | Stavros Sachtouris | self['config'].get('global', 'log_data').lower() == 'on') |
182 | c5b9380c | Stavros Sachtouris | except Exception as e: |
183 | 64a3c0de | Stavros Sachtouris | log.debug('Failed to read custom log_data setting:'
|
184 | 64a3c0de | Stavros Sachtouris | '%s\n default for log_data is off' % e)
|
185 | 64a3c0de | Stavros Sachtouris | try:
|
186 | 64a3c0de | Stavros Sachtouris | self.client.LOG_PID = (
|
187 | 534e7bbb | Stavros Sachtouris | self['config'].get('global', 'log_pid').lower() == 'on') |
188 | 64a3c0de | Stavros Sachtouris | except Exception as e: |
189 | 64a3c0de | Stavros Sachtouris | log.debug('Failed to read custom log_pid setting:'
|
190 | 64a3c0de | Stavros Sachtouris | '%s\n default for log_pid is off' % e)
|
191 | c5b9380c | Stavros Sachtouris | |
192 | 8547cd19 | Stavros Sachtouris | def _safe_progress_bar( |
193 | 8547cd19 | Stavros Sachtouris | self, msg, arg='progress_bar', countdown=False, timeout=100): |
194 | 5a673575 | Stavros Sachtouris | """Try to get a progress bar, but do not raise errors"""
|
195 | 5a673575 | Stavros Sachtouris | try:
|
196 | 5a673575 | Stavros Sachtouris | progress_bar = self.arguments[arg]
|
197 | ff1c0296 | Stavros Sachtouris | progress_bar.file = self._err
|
198 | 8547cd19 | Stavros Sachtouris | gen = progress_bar.get_generator( |
199 | 8547cd19 | Stavros Sachtouris | msg, countdown=countdown, timeout=timeout) |
200 | 5a673575 | Stavros Sachtouris | except Exception: |
201 | 5a673575 | Stavros Sachtouris | return (None, None) |
202 | 5a673575 | Stavros Sachtouris | return (progress_bar, gen)
|
203 | 5a673575 | Stavros Sachtouris | |
204 | 5a673575 | Stavros Sachtouris | def _safe_progress_bar_finish(self, progress_bar): |
205 | 5a673575 | Stavros Sachtouris | try:
|
206 | 5a673575 | Stavros Sachtouris | progress_bar.finish() |
207 | 5a673575 | Stavros Sachtouris | except Exception: |
208 | 5a673575 | Stavros Sachtouris | pass
|
209 | 5a673575 | Stavros Sachtouris | |
210 | 5a37a189 | Stavros Sachtouris | def __getitem__(self, argterm): |
211 | 5a37a189 | Stavros Sachtouris | """
|
212 | 5a37a189 | Stavros Sachtouris | :param argterm: (str) the name/label of an argument in self.arguments
|
213 | 5a37a189 | Stavros Sachtouris |
|
214 | b113e74b | Stavros Sachtouris | :returns: the value of the corresponding Argument (not the argument
|
215 | b113e74b | Stavros Sachtouris | object)
|
216 | 5a37a189 | Stavros Sachtouris |
|
217 | 5a37a189 | Stavros Sachtouris | :raises KeyError: if argterm not in self.arguments of this object
|
218 | 5a37a189 | Stavros Sachtouris | """
|
219 | b113e74b | Stavros Sachtouris | return self.arguments[argterm].value |
220 | 5a37a189 | Stavros Sachtouris | |
221 | 5a37a189 | Stavros Sachtouris | def __setitem__(self, argterm, arg): |
222 | 5a37a189 | Stavros Sachtouris | """Install an argument as argterm
|
223 | 5a37a189 | Stavros Sachtouris | If argterm points to another argument, the other argument is lost
|
224 | 5a37a189 | Stavros Sachtouris |
|
225 | 5a37a189 | Stavros Sachtouris | :param argterm: (str)
|
226 | 5a37a189 | Stavros Sachtouris |
|
227 | 5a37a189 | Stavros Sachtouris | :param arg: (Argument)
|
228 | 5a37a189 | Stavros Sachtouris | """
|
229 | 5a37a189 | Stavros Sachtouris | if not hasattr(self, 'arguments'): |
230 | 5a37a189 | Stavros Sachtouris | self.arguments = {}
|
231 | 5a37a189 | Stavros Sachtouris | self.arguments[argterm] = arg
|
232 | 5a37a189 | Stavros Sachtouris | |
233 | b113e74b | Stavros Sachtouris | def get_argument_object(self, argterm): |
234 | b113e74b | Stavros Sachtouris | """
|
235 | b113e74b | Stavros Sachtouris | :param argterm: (str) the name/label of an argument in self.arguments
|
236 | b113e74b | Stavros Sachtouris |
|
237 | b113e74b | Stavros Sachtouris | :returns: the arument object
|
238 | b113e74b | Stavros Sachtouris |
|
239 | b113e74b | Stavros Sachtouris | :raises KeyError: if argterm not in self.arguments of this object
|
240 | b113e74b | Stavros Sachtouris | """
|
241 | b113e74b | Stavros Sachtouris | return self.arguments[argterm] |
242 | b113e74b | Stavros Sachtouris | |
243 | 5eae854d | Stavros Sachtouris | def get_argument(self, argterm): |
244 | 5a37a189 | Stavros Sachtouris | """
|
245 | 5a37a189 | Stavros Sachtouris | :param argterm: (str) the name/label of an argument in self.arguments
|
246 | 5a37a189 | Stavros Sachtouris |
|
247 | 5a37a189 | Stavros Sachtouris | :returns: the value of the arument object
|
248 | 5a37a189 | Stavros Sachtouris |
|
249 | 5a37a189 | Stavros Sachtouris | :raises KeyError: if argterm not in self.arguments of this object
|
250 | 5a37a189 | Stavros Sachtouris | """
|
251 | e15d78e2 | Stavros Sachtouris | return self[argterm] |
252 | 915b99b5 | Stavros Sachtouris | |
253 | 915b99b5 | Stavros Sachtouris | |
254 | 545c6c29 | Stavros Sachtouris | # feature classes - inherit them to get special features for your commands
|
255 | 545c6c29 | Stavros Sachtouris | |
256 | 545c6c29 | Stavros Sachtouris | |
257 | f76c6bbc | Stavros Sachtouris | class OutputFormatArgument(ValueArgument): |
258 | f76c6bbc | Stavros Sachtouris | """Accepted output formats: json (default)"""
|
259 | f76c6bbc | Stavros Sachtouris | |
260 | f76c6bbc | Stavros Sachtouris | formats = ('json', )
|
261 | f76c6bbc | Stavros Sachtouris | |
262 | f76c6bbc | Stavros Sachtouris | def ___init__(self, *args, **kwargs): |
263 | f76c6bbc | Stavros Sachtouris | super(OutputFormatArgument, self).___init__(*args, **kwargs) |
264 | f76c6bbc | Stavros Sachtouris | |
265 | f76c6bbc | Stavros Sachtouris | @property
|
266 | f76c6bbc | Stavros Sachtouris | def value(self): |
267 | 9b3c8fd9 | Stavros Sachtouris | return getattr(self, '_value', None) |
268 | f76c6bbc | Stavros Sachtouris | |
269 | f76c6bbc | Stavros Sachtouris | @value.setter
|
270 | f76c6bbc | Stavros Sachtouris | def value(self, newvalue): |
271 | f76c6bbc | Stavros Sachtouris | if not newvalue: |
272 | f76c6bbc | Stavros Sachtouris | self._value = self.default |
273 | f76c6bbc | Stavros Sachtouris | elif newvalue.lower() in self.formats: |
274 | f76c6bbc | Stavros Sachtouris | self._value = newvalue.lower
|
275 | f76c6bbc | Stavros Sachtouris | else:
|
276 | f76c6bbc | Stavros Sachtouris | raise CLIInvalidArgument(
|
277 | f76c6bbc | Stavros Sachtouris | 'Invalid value %s for argument %s' % (
|
278 | eb647cfe | Stavros Sachtouris | newvalue, self.lvalue),
|
279 | f76c6bbc | Stavros Sachtouris | details=['Valid output formats: %s' % ', '.join(self.formats)]) |
280 | f76c6bbc | Stavros Sachtouris | |
281 | f76c6bbc | Stavros Sachtouris | |
282 | 915b99b5 | Stavros Sachtouris | class _optional_output_cmd(object): |
283 | 915b99b5 | Stavros Sachtouris | |
284 | 915b99b5 | Stavros Sachtouris | oo_arguments = dict(
|
285 | 915b99b5 | Stavros Sachtouris | with_output=FlagArgument('show response headers', ('--with-output')), |
286 | f76c6bbc | Stavros Sachtouris | json_output=FlagArgument( |
287 | f76c6bbc | Stavros Sachtouris | 'show headers in json (DEPRECATED from v0.12,'
|
288 | de329b4c | Stavros Sachtouris | ' please use --output-format=json instead)', ('-j', '--json')) |
289 | 915b99b5 | Stavros Sachtouris | ) |
290 | 915b99b5 | Stavros Sachtouris | |
291 | 915b99b5 | Stavros Sachtouris | def _optional_output(self, r): |
292 | 915b99b5 | Stavros Sachtouris | if self['json_output']: |
293 | 1757c616 | Stavros Sachtouris | print_json(r, out=self._out)
|
294 | 915b99b5 | Stavros Sachtouris | elif self['with_output']: |
295 | 1757c616 | Stavros Sachtouris | print_items([r] if isinstance(r, dict) else r, out=self._out) |
296 | 545c6c29 | Stavros Sachtouris | |
297 | 545c6c29 | Stavros Sachtouris | |
298 | 545c6c29 | Stavros Sachtouris | class _optional_json(object): |
299 | 545c6c29 | Stavros Sachtouris | |
300 | 545c6c29 | Stavros Sachtouris | oj_arguments = dict(
|
301 | f76c6bbc | Stavros Sachtouris | output_format=OutputFormatArgument( |
302 | f76c6bbc | Stavros Sachtouris | 'Show output in chosen output format (%s)' % ', '.join( |
303 | f76c6bbc | Stavros Sachtouris | OutputFormatArgument.formats), |
304 | f76c6bbc | Stavros Sachtouris | '--output-format'),
|
305 | f76c6bbc | Stavros Sachtouris | json_output=FlagArgument( |
306 | f76c6bbc | Stavros Sachtouris | 'show output in json (DEPRECATED from v0.12,'
|
307 | f76c6bbc | Stavros Sachtouris | ' please use --output-format instead)', ('-j', '--json')) |
308 | 545c6c29 | Stavros Sachtouris | ) |
309 | 545c6c29 | Stavros Sachtouris | |
310 | 1757c616 | Stavros Sachtouris | def _print(self, output, print_method=print_items, **print_method_kwargs): |
311 | f76c6bbc | Stavros Sachtouris | if self['json_output'] or self['output_format']: |
312 | 1757c616 | Stavros Sachtouris | print_json(output, out=self._out)
|
313 | 545c6c29 | Stavros Sachtouris | else:
|
314 | eddaace7 | Stavros Sachtouris | print_method_kwargs.setdefault('out', self._out) |
315 | eddaace7 | Stavros Sachtouris | print_method(output, **print_method_kwargs) |
316 | 6d190dd1 | Stavros Sachtouris | |
317 | 6d190dd1 | Stavros Sachtouris | |
318 | 6d190dd1 | Stavros Sachtouris | class _name_filter(object): |
319 | 6d190dd1 | Stavros Sachtouris | |
320 | 6d190dd1 | Stavros Sachtouris | nf_arguments = dict(
|
321 | 6d190dd1 | Stavros Sachtouris | name=ValueArgument('filter by name', '--name'), |
322 | 6d190dd1 | Stavros Sachtouris | name_pref=ValueArgument( |
323 | 6d190dd1 | Stavros Sachtouris | 'filter by name prefix (case insensitive)', '--name-prefix'), |
324 | 6d190dd1 | Stavros Sachtouris | name_suff=ValueArgument( |
325 | 6d190dd1 | Stavros Sachtouris | 'filter by name suffix (case insensitive)', '--name-suffix'), |
326 | 6d190dd1 | Stavros Sachtouris | name_like=ValueArgument( |
327 | 6d190dd1 | Stavros Sachtouris | 'print only if name contains this (case insensitive)',
|
328 | 6d190dd1 | Stavros Sachtouris | '--name-like')
|
329 | 6d190dd1 | Stavros Sachtouris | ) |
330 | 6d190dd1 | Stavros Sachtouris | |
331 | 6d190dd1 | Stavros Sachtouris | def _non_exact_name_filter(self, items): |
332 | 6d190dd1 | Stavros Sachtouris | np, ns, nl = self['name_pref'], self['name_suff'], self['name_like'] |
333 | 6d190dd1 | Stavros Sachtouris | return [item for item in items if ( |
334 | f3740b99 | Stavros Sachtouris | (not np) or (item['name'] or '').lower().startswith( |
335 | f3740b99 | Stavros Sachtouris | np.lower())) and (
|
336 | f3740b99 | Stavros Sachtouris | (not ns) or (item['name'] or '').lower().endswith( |
337 | f3740b99 | Stavros Sachtouris | ns.lower())) and (
|
338 | f3740b99 | Stavros Sachtouris | (not nl) or nl.lower() in (item['name'] or '').lower())] |
339 | 6d190dd1 | Stavros Sachtouris | |
340 | 6d190dd1 | Stavros Sachtouris | def _exact_name_filter(self, items): |
341 | f3740b99 | Stavros Sachtouris | return filter_dicts_by_dict(items, dict(name=self['name'] or '')) if ( |
342 | 6d190dd1 | Stavros Sachtouris | self['name']) else items |
343 | 6d190dd1 | Stavros Sachtouris | |
344 | 6d190dd1 | Stavros Sachtouris | def _filter_by_name(self, items): |
345 | 6d190dd1 | Stavros Sachtouris | return self._non_exact_name_filter(self._exact_name_filter(items)) |
346 | 6d190dd1 | Stavros Sachtouris | |
347 | 6d190dd1 | Stavros Sachtouris | |
348 | 6d190dd1 | Stavros Sachtouris | class _id_filter(object): |
349 | 6d190dd1 | Stavros Sachtouris | |
350 | 6d190dd1 | Stavros Sachtouris | if_arguments = dict(
|
351 | 6d190dd1 | Stavros Sachtouris | id=ValueArgument('filter by id', '--id'), |
352 | 6d190dd1 | Stavros Sachtouris | id_pref=ValueArgument( |
353 | 6d190dd1 | Stavros Sachtouris | 'filter by id prefix (case insensitive)', '--id-prefix'), |
354 | 6d190dd1 | Stavros Sachtouris | id_suff=ValueArgument( |
355 | 6d190dd1 | Stavros Sachtouris | 'filter by id suffix (case insensitive)', '--id-suffix'), |
356 | 6d190dd1 | Stavros Sachtouris | id_like=ValueArgument( |
357 | aef3fa1f | Stavros Sachtouris | 'print only if id contains this (case insensitive)', '--id-like') |
358 | 6d190dd1 | Stavros Sachtouris | ) |
359 | 6d190dd1 | Stavros Sachtouris | |
360 | 6d190dd1 | Stavros Sachtouris | def _non_exact_id_filter(self, items): |
361 | 6d190dd1 | Stavros Sachtouris | np, ns, nl = self['id_pref'], self['id_suff'], self['id_like'] |
362 | 6d190dd1 | Stavros Sachtouris | return [item for item in items if ( |
363 | 6d190dd1 | Stavros Sachtouris | (not np) or ( |
364 | 6d190dd1 | Stavros Sachtouris | '%s' % item['id']).lower().startswith(np.lower())) and ( |
365 | 6d190dd1 | Stavros Sachtouris | (not ns) or ('%s' % item['id']).lower().endswith(ns.lower())) and ( |
366 | 6d190dd1 | Stavros Sachtouris | (not nl) or nl.lower() in ('%s' % item['id']).lower())] |
367 | 6d190dd1 | Stavros Sachtouris | |
368 | 6d190dd1 | Stavros Sachtouris | def _exact_id_filter(self, items): |
369 | 6d190dd1 | Stavros Sachtouris | return filter_dicts_by_dict(items, dict(id=self['id'])) if ( |
370 | 6d190dd1 | Stavros Sachtouris | self['id']) else items |
371 | 6d190dd1 | Stavros Sachtouris | |
372 | 6d190dd1 | Stavros Sachtouris | def _filter_by_id(self, items): |
373 | 6d190dd1 | Stavros Sachtouris | return self._non_exact_id_filter(self._exact_id_filter(items)) |