Skip to content
Navigation Menu
{{ message }}
forked from cirosantilli/linux-kernel-module-cheat
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcli_function.py
More file actions
executable file
·458 lines (410 loc) · 17.5 KB
/
Copy pathcli_function.py
File metadata and controls
executable file
·458 lines (410 loc) · 17.5 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
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
#!/usr/bin/env python3
'''
This file is GPLv3 like the rest of this repo.
However, you may use it in a project with any license through imports,
without affecting the license of the rest of your project, even if you include
this file in the project source tree, as long as you publish any modifications
made to this file.
'''
import argparse
import bisect
import collections
import imp
import os
import sys
class _Argument:
def __init__(
self,
long_or_short_1,
long_or_short_2=None,
default=None,
dest=None,
help=None,
nargs=None,
**kwargs
):
self.args = []
# argparse is crappy and cannot tell us if arguments were given or not.
# We need that information to decide if the config file should override argparse or not.
# So we just use None as a sentinel.
self.kwargs = {'default': None}
shortname, longname, key, is_option = self.get_key(
long_or_short_1,
long_or_short_2,
dest
)
if shortname is not None:
self.args.append(shortname)
if is_option:
self.args.append(longname)
else:
self.args.append(key)
self.kwargs['metavar'] = longname
if default is not None and nargs is None:
self.kwargs['nargs'] = '?'
if dest is not None:
self.kwargs['dest'] = dest
if nargs is not None:
self.kwargs['nargs'] = nargs
if default is True or default is False:
bool_action = 'store_true'
self.is_bool = True
else:
self.is_bool = False
if default is None and (
nargs in ('*', '+')
or ('action' in kwargs and kwargs['action'] == 'append')
):
default = []
if self.is_bool and not 'action' in kwargs:
self.kwargs['action'] = bool_action
if help is not None:
if default is not None:
if help[-1] == '\n':
if '\n\n' in help[:-1]:
help += '\n'
elif help[-1] == ' ':
pass
else:
help += ' '
help += 'Default: {}'.format(default)
self.kwargs['help'] = help
self.optional = (
default is not None or
self.is_bool or
is_option or
nargs in ('?', '*', '+')
)
self.kwargs.update(kwargs)
self.default = default
self.longname = longname
self.key = key
self.is_option = is_option
self.nargs = nargs
def __str__(self):
return str(self.args) + ' ' + str(self.kwargs)
@staticmethod
def get_key(
long_or_short_1,
long_or_short_2=None,
dest=None,
**kwargs
):
if long_or_short_2 is None:
shortname = None
longname = long_or_short_1
else:
shortname = long_or_short_1
longname = long_or_short_2
if longname[0] == '-':
key = longname.lstrip('-').replace('-', '_')
is_option = True
else:
key = longname.replace('-', '_')
is_option = False
if dest is not None:
key = dest
return shortname, longname, key, is_option
class CliFunction:
'''
Represent a function that can be called either from Python code, or
from the command line.
Features:
* single argument description in format very similar to argparse
* handle default arguments transparently in both cases
* expose a configuration file mechanism to get default parameters from a file
* fix some argparse.ArgumentParser() annoyances:
** allow dashes in positional arguments:
https://stackoverflow.com/questions/12834785/having-options-in-argparse-with-a-dash
** boolean defaults automatically use store_true or store_false, and add a --no-* CLI
option to invert them if set from the config
* from a Python call, get the corresponding CLI string list. See get_cli.
* easily determine if arguments were given on the command line
https://stackoverflow.com/questions/30487767/check-if-argparse-optional-argument-is-set-or-not/30491369
This somewhat duplicates: https://click.palletsprojects.com but:
* that decorator API is insane
* CLI + Python for single functions was wontfixed: https://github.com/pallets/click/issues/40
'''
def __call__(self, **kwargs):
'''
Python version of the function call. Not called by cli() indirectly,
so can be overridden to distinguish between Python and CLI calls.
:type arguments: Dict
'''
return self._do_main(kwargs)
def _do_main(self, kwargs):
return self.main(**self._get_args(kwargs))
def __init__(self, config_file=None, description=None, extra_config_params=None):
self._arguments = collections.OrderedDict()
self._config_file = config_file
self._description = description
self.extra_config_params = extra_config_params
if self._config_file is not None:
self.add_argument(
'--config-file',
default=self._config_file,
help='Path to the configuration file to use'
)
def __str__(self):
return '\n'.join(str(arg[key]) for key in self._arguments)
def _get_args(self, kwargs):
'''
Resolve default arguments from the config file and CLI param defaults.
Add an extra _args_given argument which determines if an argument was given or not.
Args set from the config file count as given.
'''
args_with_defaults = kwargs.copy()
# Add missing args from config file.
config_file = None
if 'config_file' in args_with_defaults and args_with_defaults['config_file'] is not None:
config_file = args_with_defaults['config_file']
else:
config_file = self._config_file
args_given = {}
for key in self._arguments:
args_given[key] = not (
not key in args_with_defaults or
args_with_defaults[key] is None or
self._arguments[key].nargs == '*' and args_with_defaults[key] == []
)
if config_file is not None and os.path.exists(config_file):
config_configs = {}
config = imp.load_source('config', config_file)
if self.extra_config_params is None:
config.set_args(config_configs)
else:
config.set_args(config_configs, self.extra_config_params)
for key in config_configs:
if key not in self._arguments:
raise Exception('Unknown key in config file: ' + key)
if not args_given[key]:
args_with_defaults[key] = config_configs[key]
args_given[key] = True
# Add missing args from hard-coded defaults.
for key in self._arguments:
argument = self._arguments[key]
if (not key in args_with_defaults) or args_with_defaults[key] is None:
if argument.optional:
args_with_defaults[key] = argument.default
else:
raise Exception('Value not given for mandatory argument: ' + key)
args_with_defaults['_args_given'] = args_given
if 'config_file' in args_with_defaults:
del args_with_defaults['config_file']
return args_with_defaults
def add_argument(
self,
*args,
**kwargs
):
argument = _Argument(*args, **kwargs)
self._arguments[argument.key] = argument
def cli_noexit(self, cli_args=None):
'''
Call the function from the CLI. Parse command line arguments
to get all arguments.
:return: the return of main
'''
parser = argparse.ArgumentParser(
description=self._description,
formatter_class=argparse.RawTextHelpFormatter,
)
for key in self._arguments:
argument = self._arguments[key]
parser.add_argument(*argument.args, **argument.kwargs)
if argument.is_bool:
new_longname = '--no' + argument.longname[1:]
kwargs = argument.kwargs.copy()
kwargs['default'] = not argument.default
if kwargs['action'] in ('store_true', 'store_false'):
kwargs['action'] = 'store_false'
if 'help' in kwargs:
del kwargs['help']
parser.add_argument(new_longname, dest=argument.key, **kwargs)
args = parser.parse_args(args=cli_args)
return self._do_main(vars(args))
def cli(self, *args, **kwargs):
'''
Same as cli, but also exit the program with status equal to the return value of main.
main must return an integer for this to be used.
None is considered 0.
'''
exit_status = self.cli_noexit(*args, **kwargs)
if exit_status is None:
exit_status = 0
sys.exit(exit_status)
def get_cli(self, **kwargs):
'''
:rtype: List[Type(str)]
:return: the canonical command line arguments arguments that would
generate this Python function call.
(--key, value) option pairs are grouped into tuples, and all
other values are grouped in their own tuple (positional_arg,)
or (--bool-arg,).
Arguments with default values are not added, but arguments
that are set by the config are also given.
The optional arguments are sorted alphabetically, followed by
positional arguments.
The long option name is used if both long and short versions
are given.
'''
options = []
positional_dict = {}
kwargs = self._get_args(kwargs)
for key in kwargs:
if not key in ('_args_given',):
argument = self._arguments[key]
default = argument.default
value = kwargs[key]
if value != default:
if argument.is_option:
if argument.is_bool:
vals = [(argument.longname,)]
elif 'action' in argument.kwargs and argument.kwargs['action'] == 'append':
vals = [(argument.longname, str(val)) for val in value]
else:
vals = [(argument.longname, str(value))]
for val in vals:
bisect.insort(options, val)
else:
if type(value) is list:
positional_dict[key] = [tuple([v]) for v in value]
else:
positional_dict[key] = [(str(value),)]
# Python built-in data structures suck.
# https://stackoverflow.com/questions/27726245/getting-the-key-index-in-a-python-ordereddict/27726534#27726534
positional = []
for key in self._arguments.keys():
if key in positional_dict:
positional.extend(positional_dict[key])
return options + positional
@staticmethod
def get_key(*args, **kwargs):
return _Argument.get_key(*args, **kwargs)
def main(self, **kwargs):
'''
Do the main function call work.
:type arguments: Dict
'''
raise NotImplementedError
if __name__ == '__main__':
class OneCliFunction(CliFunction):
def __init__(self):
super().__init__(
config_file='cli_function_test_config.py',
description = '''\
Description of this
amazing function!
''',
)
self.add_argument('-a', '--asdf', default='A', help='Help for asdf'),
self.add_argument('-q', '--qwer', default='Q', help='Help for qwer'),
self.add_argument('-b', '--bool-true', default=True, help='Help for bool-true'),
self.add_argument('--bool-false', default=False, help='Help for bool-false'),
self.add_argument('--dest', dest='custom_dest', help='Help for dest'),
self.add_argument('--bool-cli', default=False, help='Help for bool'),
self.add_argument('--bool-nargs', default=False, nargs='?', action='store', const='')
self.add_argument('--no-default', help='Help for no-bool'),
self.add_argument('--append', action='append')
self.add_argument('pos-mandatory', help='Help for pos-mandatory', type=int),
self.add_argument('pos-optional', default=0, help='Help for pos-optional', type=int),
self.add_argument('args-star', help='Help for args-star', nargs='*'),
def main(self, **kwargs):
del kwargs['_args_given']
return kwargs
one_cli_function = OneCliFunction()
# Default code call.
default = one_cli_function(pos_mandatory=1)
assert default == {
'asdf': 'A',
'qwer': 'Q',
'bool_true': True,
'bool_false': False,
'bool_nargs': False,
'bool_cli': True,
'custom_dest': None,
'no_default': None,
'append': [],
'pos_mandatory': 1,
'pos_optional': 0,
'args_star': []
}
# Default CLI call with programmatic CLI arguments.
out = one_cli_function.cli_noexit(['1'])
assert out == default
# asdf
out = one_cli_function(pos_mandatory=1, asdf='B')
assert out['asdf'] == 'B'
out['asdf'] = default['asdf']
assert out == default
# asdf and qwer
out = one_cli_function(pos_mandatory=1, asdf='B', qwer='R')
assert out['asdf'] == 'B'
assert out['qwer'] == 'R'
out['asdf'] = default['asdf']
out['qwer'] = default['qwer']
assert out == default
if '--bool-true':
out = one_cli_function(pos_mandatory=1, bool_true=False)
cli_out = one_cli_function.cli_noexit(['--no-bool-true', '1'])
assert out == cli_out
assert out['bool_true'] == False
out['bool_true'] = default['bool_true']
assert out == default
if '--bool-false':
out = one_cli_function(pos_mandatory=1, bool_false=True)
cli_out = one_cli_function.cli_noexit(['--bool-false', '1'])
assert out == cli_out
assert out['bool_false'] == True
out['bool_false'] = default['bool_false']
assert out == default
if '--bool-nargs':
out = one_cli_function(pos_mandatory=1, bool_nargs=True)
assert out['bool_nargs'] == True
out['bool_nargs'] = default['bool_nargs']
assert out == default
out = one_cli_function(pos_mandatory=1, bool_nargs='asdf')
assert out['bool_nargs'] == 'asdf'
out['bool_nargs'] = default['bool_nargs']
assert out == default
# --dest
out = one_cli_function(pos_mandatory=1, custom_dest='a')
cli_out = one_cli_function.cli_noexit(['--dest', 'a', '1'])
assert out == cli_out
assert out['custom_dest'] == 'a'
out['custom_dest'] = default['custom_dest']
assert out == default
# Positional
out = one_cli_function(pos_mandatory=1, pos_optional=2, args_star=['3', '4'])
assert out['pos_mandatory'] == 1
assert out['pos_optional'] == 2
assert out['args_star'] == ['3', '4']
cli_out = one_cli_function.cli_noexit(['1', '2', '3', '4'])
assert out == cli_out
out['pos_mandatory'] = default['pos_mandatory']
out['pos_optional'] = default['pos_optional']
out['args_star'] = default['args_star']
assert out == default
# Star
out = one_cli_function(append=['1', '2'], pos_mandatory=1)
cli_out = one_cli_function.cli_noexit(['--append', '1', '--append', '2', '1'])
assert out == cli_out
assert out['append'] == ['1', '2']
out['append'] = default['append']
assert out == default
# Force a boolean value set on the config to be False on CLI.
assert one_cli_function.cli_noexit(['--no-bool-cli', '1'])['bool_cli'] is False
# Pick another config file.
assert one_cli_function.cli_noexit(['--config-file', 'cli_function_test_config_2.py', '1'])['bool_cli'] is False
# Extra config file for '*'.
assert one_cli_function.cli_noexit(['--config-file', 'cli_function_test_config_2.py', '1', '2', '3', '4'])['args_star'] == ['3', '4']
assert one_cli_function.cli_noexit(['--config-file', 'cli_function_test_config_2.py', '1', '2'])['args_star'] == ['asdf', 'qwer']
# get_cli
assert one_cli_function.get_cli(pos_mandatory=1, asdf='B') == [('--asdf', 'B'), ('--bool-cli',), ('1',)]
assert one_cli_function.get_cli(pos_mandatory=1, asdf='B', qwer='R') == [('--asdf', 'B'), ('--bool-cli',), ('--qwer', 'R'), ('1',)]
assert one_cli_function.get_cli(pos_mandatory=1, bool_true=False) == [('--bool-cli',), ('--bool-true',), ('1',)]
assert one_cli_function.get_cli(pos_mandatory=1, pos_optional=2, args_star=['asdf', 'qwer']) == [('--bool-cli',), ('1',), ('2',), ('asdf',), ('qwer',)]
assert one_cli_function.get_cli(pos_mandatory=1, append=['2', '3']) == [('--append', '2'), ('--append', '3',), ('--bool-cli',), ('1',)]
if len(sys.argv) > 1:
# CLI call with argv command line arguments.
print(one_cli_function.cli())
You can’t perform that action at this time.