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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
|
# Copyright (C) 2009-2012 Lars Wirzenius
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
import ConfigParser
import optparse
import os
import re
import sys
import cliapp
from cliapp.genman import ManpageGenerator
log_group_name = 'Logging'
config_group_name = 'Configuration files and settings'
perf_group_name = 'Peformance'
default_group_names = [
log_group_name,
config_group_name,
perf_group_name,
]
class Setting(object):
action = 'store'
type = 'string'
nargs = 1
choices = None
def __init__(
self, names, default, help, metavar=None, group=None, hidden=False):
self.names = names
self.set_value(default)
self.help = help
self.metavar = metavar or self.default_metavar()
self.group = group
self.hidden = hidden
def default_metavar(self):
return None
def get_value(self):
return self._string_value
def set_value(self, value):
self._string_value = value
def call_get_value(self):
return self.get_value()
def call_set_value(self, value):
self.set_value(value)
value = property(call_get_value, call_set_value)
def has_value(self):
return self.value is not None
def parse_value(self, string):
self.value = string
def format(self): # pragma: no cover
return str(self.value)
class StringSetting(Setting):
def default_metavar(self):
return self.names[0].upper()
class StringListSetting(Setting):
action = 'append'
def __init__(
self, names, default, help, metavar=None, group=None, hidden=False):
Setting.__init__(
self, names, [], help, metavar=metavar, group=group, hidden=hidden)
self.default = default
self.using_default_value = True
def default_metavar(self):
return self.names[0].upper()
def get_value(self):
if self._string_value.strip():
return [s.strip() for s in self._string_value.split(',')]
else:
return self.default
def set_value(self, strings):
self._string_value = ','.join(strings)
self.using_default_value = False
def has_value(self):
return self.value != []
def parse_value(self, string):
self.value = [s.strip() for s in string.split(',')]
def format(self): # pragma: no cover
return ', '.join(self.value)
class ChoiceSetting(Setting):
type = 'choice'
def __init__(
self, names, choices, help, metavar=None, group=None, hidden=False):
Setting.__init__(
self, names, choices[0], help, metavar=metavar, group=group,
hidden=hidden)
self.choices = choices
def default_metavar(self):
return self.names[0].upper()
class BooleanSetting(Setting):
action = 'store_true'
nargs = None
type = None
_trues = ['yes', 'on', '1', 'true']
_false = 'no'
def get_value(self):
return self._string_value.lower() in self._trues
def set_value(self, value):
def is_true():
if value is True or value is False:
return value
if type(value) in [str, unicode]:
return value.lower() in self._trues
return value
if is_true():
self._string_value = self._trues[0]
else:
self._string_value = self._false
class ByteSizeSetting(Setting):
def parse_human_size(self, size):
'''Parse a size using suffix into plain bytes.'''
m = re.match(r'''(?P<number>\d+(\.\d+)?) \s*
(?P<unit>k|ki|m|mi|g|gi|t|ti)? b? \s*$''',
size.lower(), flags=re.X)
if not m:
return 0
else:
number = float(m.group('number'))
unit = m.group('unit')
units = {
'k': 10**3,
'm': 10**6,
'g': 10**9,
't': 10**12,
'ki': 2**10,
'mi': 2**20,
'gi': 2**30,
'ti': 2**40,
}
return long(number * units.get(unit, 1))
def default_metavar(self):
return 'SIZE'
def get_value(self):
return long(self._string_value)
def set_value(self, value):
if type(value) == str:
value = self.parse_human_size(value)
self._string_value = str(value)
class IntegerSetting(Setting):
type = 'int'
def default_metavar(self):
return self.names[0].upper()
def get_value(self):
return long(self._string_value)
def set_value(self, value):
self._string_value = str(value)
class FormatHelpParagraphs(optparse.IndentedHelpFormatter):
def _format_text(self, text): # pragma: no cover
'''Like the default, except handle paragraphs.'''
fmt = cliapp.TextFormat(width=self.width)
formatted = fmt.format(text)
return formatted.rstrip('\n')
class Settings(object):
'''Settings for a cliapp application.
You probably don't need to create a settings object yourself,
since ``cliapp.Application`` does it for you.
Settings are read from configuration files, and parsed from the
command line. Every setting has a type, name, and help text,
and may have a default value as well.
For example::
settings.boolean(['verbose', 'v'], 'show what is going on')
This would create a new setting, ``verbose``, with a shorter alias
``v``. On the command line, the options ``--verbose`` and
``-v`` would work equally well. There can be any number of aliases.
The help text is shown if the user uses ``--help`` or
``--generate-manpage``.
You can use the ``metavar`` keyword argument to set the name shown
in the generated option lists; the default name is whatever
``optparse`` decides (i.e., name of option).
Use ``load_configs`` to read configuration files, and
``parse_args`` to parse command line arguments.
The current value of a setting can be accessed by indexing
the settings class::
settings['verbose']
The list of configuration files for the appliation is stored
in ``config_files``. Add or remove from the list if you wish.
The files need to exist: those that don't are silently ignored.
'''
def __init__(self, progname, version, usage=None, description=None,
epilog=None):
self._settingses = dict()
self._canonical_names = list()
self.version = version
self.progname = progname
self.usage = usage
self.description = description
self.epilog = epilog
self._add_default_settings()
self._config_files = None
self._cp = ConfigParser.ConfigParser()
def _add_default_settings(self):
self.string(['output'],
'write output to FILE, instead of standard output',
metavar='FILE')
self.string(['log'],
'write log entries to FILE (default is to not write log '
'files at all); use "syslog" to log to system log, '
'or "none" to disable logging',
metavar='FILE', group=log_group_name)
self.choice(['log-level'],
['debug', 'info', 'warning', 'error', 'critical', 'fatal'],
'log at LEVEL, one of debug, info, warning, '
'error, critical, fatal (default: %default)',
metavar='LEVEL', group=log_group_name)
self.bytesize(['log-max'],
'rotate logs larger than SIZE, '
'zero for never (default: %default)',
metavar='SIZE', default=0, group=log_group_name)
self.integer(['log-keep'], 'keep last N logs (%default)',
metavar='N', default=10, group=log_group_name)
self.string(['log-mode'],
'set permissions of new log files to MODE (octal; '
'default %default)',
metavar='MODE', default='0600', group=log_group_name)
self.choice(['dump-memory-profile'],
['simple', 'none', 'meliae', 'heapy'],
'make memory profiling dumps using METHOD, which is one '
'of: none, simple, meliae, or heapy '
'(default: %default)',
metavar='METHOD',
group=perf_group_name)
self.integer(['memory-dump-interval'],
'make memory profiling dumps at least SECONDS apart',
metavar='SECONDS',
default=300,
group=perf_group_name)
def _add_setting(self, setting):
'''Add a setting to self._cp.'''
self._canonical_names.append(setting.names[0])
for name in setting.names:
self._settingses[name] = setting
def string(self, names, help, default='', **kwargs):
'''Add a setting with a string value.'''
self._add_setting(StringSetting(names, default, help, **kwargs))
def string_list(self, names, help, default=None, **kwargs):
'''Add a setting which have multiple string values.
An example would be an option that can be given multiple times
on the command line, e.g., "--exclude=foo --exclude=bar".
'''
self._add_setting(StringListSetting(names, default or [], help,
**kwargs))
def choice(self, names, possibilities, help, **kwargs):
'''Add a setting which chooses from list of acceptable values.
An example would be an option to set debugging level to be
one of a set of accepted names: debug, info, warning, etc.
The default value is the first possibility.
'''
self._add_setting(ChoiceSetting(names, possibilities, help, **kwargs))
def boolean(self, names, help, default=False, **kwargs):
'''Add a setting with a boolean value.'''
self._add_setting(BooleanSetting(names, default, help, **kwargs))
def bytesize(self, names, help, default=0, **kwargs):
'''Add a setting with a size in bytes.
The user can use suffixes for kilo/mega/giga/tera/kibi/mibi/gibi/tibi.
'''
self._add_setting(ByteSizeSetting(names, default, help, **kwargs))
def integer(self, names, help, default=0, **kwargs):
'''Add an integer setting.'''
self._add_setting(IntegerSetting(names, default, help, **kwargs))
def __getitem__(self, name):
return self._settingses[name].value
def __setitem__(self, name, value):
self._settingses[name].value = value
def __contains__(self, name):
return name in self._settingses
def __iter__(self):
'''Iterate over canonical settings names.'''
for name in self._canonical_names:
yield name
def keys(self):
'''Return canonical settings names.'''
return self._canonical_names[:]
def require(self, name):
'''Raise exception if setting has not been set.
Option must have a value, and a default value is OK.
'''
if not self._settingses[name].has_value():
raise cliapp.AppException('Setting %s has no value, '
'but one is required' % name)
def _option_names(self, names):
'''Turn setting names into option names.
Names with a single letter are short options, and get prefixed
with one dash. The rest get prefixed with two dashes.
'''
return ['--%s' % name if len(name) > 1 else '-%s' % name
for name in names]
def _destname(self, name):
name = '_'.join(name.split('-'))
return name
def build_parser(self, configs_only=False, arg_synopsis=None,
cmd_synopsis=None, deferred_last=[], all_options=False):
'''Build OptionParser for parsing command line.'''
# Call a callback function unless we're in configs_only mode.
maybe = lambda func: (lambda *args: None) if configs_only else func
# Maintain lists of callback function calls that are deferred.
# We call them ourselves rather than have OptionParser call them
# directly so that we can do things like --dump-config only
# after the whole command line is parsed.
def defer_last(func): # pragma: no cover
def callback(*args):
deferred_last.append(lambda: func(*args))
return callback
# Create the command line parser.
def getit(x):
if x is None or type(x) in [str, unicode]:
return x
else:
return x()
usage = getit(self.usage)
description = getit(self.description)
p = optparse.OptionParser(prog=self.progname, version=self.version,
formatter=FormatHelpParagraphs(),
usage=usage,
description=description,
epilog=self.epilog)
# Create all OptionGroup objects. This way, the user code can
# add settings to built-in option groups.
group_names = set(default_group_names)
for name in self._canonical_names:
s = self._settingses[name]
if s.group is not None:
group_names.add(s.group)
group_names = sorted(group_names)
option_groups = {}
for name in group_names:
group = optparse.OptionGroup(p, name)
p.add_option_group(group)
option_groups[name] = group
config_group = option_groups[config_group_name]
# Return help text, unless setting/option is hidden, in which
# case return optparse.SUPPRESS_HELP.
def help_text(text, hidden):
if all_options or not hidden:
return text
else:
return optparse.SUPPRESS_HELP
# Add --dump-setting-names.
def dump_setting_names(*args): # pragma: no cover
for name in self._canonical_names:
sys.stdout.write('%s\n' % name)
sys.exit(0)
config_group.add_option('--dump-setting-names',
action='callback',
nargs=0,
callback=defer_last(maybe(dump_setting_names)),
help=help_text(
'write out all names of settings and quit', True))
# Add --dump-config.
def call_dump_config(*args): # pragma: no cover
self.dump_config(sys.stdout)
sys.exit(0)
config_group.add_option('--dump-config',
action='callback',
nargs=0,
callback=defer_last(maybe(call_dump_config)),
help='write out the entire current configuration')
# Add --no-default-configs.
def reset_configs(option, opt_str, value, parser):
self.config_files = []
config_group.add_option('--no-default-configs',
action='callback',
nargs=0,
callback=reset_configs,
help='clear list of configuration files to read')
# Add --config.
def append_to_configs(option, opt_str, value, parser):
self.config_files.append(value)
config_group.add_option('--config',
action='callback',
nargs=1,
type='string',
callback=append_to_configs,
help='add FILE to config files',
metavar='FILE')
# Add --list-config-files.
def list_config_files(*args): # pragma: no cover
for filename in self.config_files:
print filename
sys.exit(0)
config_group.add_option('--list-config-files',
action='callback',
nargs=0,
callback=defer_last(maybe(list_config_files)),
help=help_text('list all possible config files', True))
# Add --generate-manpage.
self._arg_synopsis = arg_synopsis
self._cmd_synopsis = cmd_synopsis
p.add_option('--generate-manpage',
action='callback',
nargs=1,
type='string',
callback=maybe(self._generate_manpage),
help=help_text('fill in manual page TEMPLATE', True),
metavar='TEMPLATE')
# Add --help-all.
def help_all(*args): # pragma: no cover
pp = self.build_parser(
configs_only=configs_only,
arg_synopsis=arg_synopsis,
cmd_synopsis=cmd_synopsis,
all_options=True)
sys.stdout.write(pp.format_help())
sys.exit(0)
config_group.add_option(
'--help-all',
action='callback',
help='show all options',
callback=defer_last(maybe(help_all)))
# Add other options, from the user-defined and built-in
# settingses.
def set_value(option, opt_str, value, parser, setting):
if setting.action == 'append':
if setting.using_default_value:
setting.value = [value]
else:
setting.value += [value]
elif setting.action == 'store_true':
setting.value = True
else:
assert setting.action == 'store'
setting.value = value
def set_false(option, opt_str, value, parser, setting):
setting.value = False
def add_option(obj, s):
option_names = self._option_names(s.names)
obj.add_option(*option_names,
action='callback',
callback=maybe(set_value),
callback_args=(s,),
type=s.type,
nargs=s.nargs,
choices=s.choices,
help=help_text(s.help, s.hidden),
metavar=s.metavar)
def add_negation_option(obj, s):
option_names = self._option_names(s.names)
long_names = [x for x in option_names if x.startswith('--')]
neg_names = ['--no-' + x[2:] for x in long_names]
unused_names = [x for x in neg_names
if x[2:] not in self._settingses]
obj.add_option(*unused_names,
action='callback',
callback=maybe(set_false),
callback_args=(s,),
type=s.type,
help=help_text('', s.hidden))
# Add options for every setting.
for name in self._canonical_names:
s = self._settingses[name]
if s.group is None:
obj = p
else:
obj = option_groups[s.group]
add_option(obj, s)
if type(s) is BooleanSetting:
add_negation_option(obj, s)
p.set_defaults(**{self._destname(name): s.value})
return p
def parse_args(self, args, parser=None, suppress_errors=False,
configs_only=False, arg_synopsis=None,
cmd_synopsis=None, compute_setting_values=None,
all_options=False):
'''Parse the command line.
Return list of non-option arguments. ``args`` would usually
be ``sys.argv[1:]``.
'''
deferred_last = []
p = parser or self.build_parser(configs_only=configs_only,
arg_synopsis=arg_synopsis,
cmd_synopsis=cmd_synopsis,
deferred_last=deferred_last,
all_options=all_options)
if suppress_errors:
p.error = lambda msg: sys.exit(1)
options, args = p.parse_args(args)
if compute_setting_values: # pragma: no cover
compute_setting_values(self)
for callback in deferred_last: # pragma: no cover
callback()
return args
@property
def _default_config_files(self):
'''Return list of default config files to read.
The names of the files are dependent on the name of the program,
as set in the progname attribute.
The files may or may not exist.
'''
configs = []
configs.append('/etc/%s.conf' % self.progname)
configs += self._listconfs('/etc/%s' % self.progname)
configs.append(os.path.expanduser('~/.%s.conf' % self.progname))
configs += self._listconfs(
os.path.expanduser('~/.config/%s' % self.progname))
return configs
def _listconfs(self, dirname, listdir=os.listdir):
'''Return list of pathnames to config files in dirname.
Config files are expectd to have names ending in '.conf'.
If dirname does not exist or is not a directory,
return empty list.
'''
if not os.path.isdir(dirname):
return []
basenames = listdir(dirname)
basenames.sort(key=lambda s: [ord(c) for c in s])
return [os.path.join(dirname, x)
for x in basenames
if x.endswith('.conf')]
def _get_config_files(self):
if self._config_files is None:
self._config_files = self._default_config_files
return self._config_files
def _set_config_files(self, config_files):
self._config_files = config_files
config_files = property(_get_config_files, _set_config_files)
def set_from_raw_string(self, name, raw_string):
'''Set value of a setting from a raw, unparsed string value.'''
s = self._settingses[name]
s.parse_value(raw_string)
return s
def load_configs(self, open=open):
'''Load all config files in self.config_files.
Silently ignore files that do not exist.
'''
cp = ConfigParser.ConfigParser()
cp.add_section('config')
for pathname in self.config_files:
try:
f = open(pathname)
except IOError:
pass
else:
cp.readfp(f)
f.close()
for name in cp.options('config'):
value = cp.get('config', name)
s = self.set_from_raw_string(name, value)
if hasattr(s, 'using_default_value'):
s.using_default_value = True
# Remember the ConfigParser for use in as_cp later on.
self._cp = cp
def _generate_manpage(self, o, os, value, p): # pragma: no cover
template = open(value).read()
generator = ManpageGenerator(template, p, self._arg_synopsis,
self._cmd_synopsis)
sys.stdout.write(generator.format_template())
sys.exit(0)
def as_cp(self):
'''Return a ConfigParser instance with current values of settings.
Any sections outside of ``[config]`` are preserved as is. This
lets the application use those as it wishes, and assign any
meanings it desires to the section names.
'''
cp = ConfigParser.ConfigParser()
cp.add_section('config')
for name in self._canonical_names:
cp.set('config', name, self._settingses[name].format())
for section in self._cp.sections():
if section != 'config':
cp.add_section(section)
for option in self._cp.options(section):
value = self._cp.get(section, option)
cp.set(section, option, value)
return cp
def dump_config(self, output): # pragma: no cover
cp = self.as_cp()
cp.write(output)
|