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
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
|
# Copyright (c) 2003-2006 LOGILAB S.A. (Paris, FRANCE).
# http://www.logilab.fr/ -- mailto:contact@logilab.fr
#
# 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.,
# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
"""Some classes used to handle advanced configuration in simple to
complex applications.
It's able to load the configuration from a file and or command line
options, to generate a sample configuration file or to display program's
usage. It basically fill the gap between optik/optparse and ConfigParser,
with some additional data types (available as standalone optik extension
in the `optik_ext` module)
Quick start: simplest usage
```````````````````````````
import sys
from logilab.common.configuration import Configuration
options = [('dothis', {'type':'yn', 'default': True, 'metavar': '<y or n>'}),
('value', {'type': 'string', 'metavar': '<string>'}),
('multiple', {'type': 'csv', 'default': ('yop',),
'metavar': '<comma separated values>',
'help': 'you can also document the option'}),
('number', {'type': 'int', 'default':2, 'metavar':'<int>'}),
]
config = Configuration(options=options, name='My config')
print config['dothis']
print config['value']
print config['multiple']
print config['number']
print config.help()
f = open('myconfig.ini', 'w')
f.write('''[MY CONFIG]
number = 3
dothis = no
multiple = 1,2,3
''')
f.close()
config.load_file_configuration('myconfig.ini')
print config['dothis']
print config['value']
print config['multiple']
print config['number']
sys.argv = ['mon prog', '--value', 'bacon', '--multiple', '4,5,6',
'nonoptionargument']
print config.load_command_line_configuration()
print config['value']
config.generate_config()
:version: $Revision: 1.40 $
:author: Logilab
:copyright: 2003-2006 LOGILAB S.A. (Paris, FRANCE)
:contact: http://www.logilab.fr/ -- mailto:python-projects@logilab.org
"""
from __future__ import generators
__docformat__ = "restructuredtext en"
__all__ = ('OptionsManagerMixIn', 'OptionsProviderMixIn',
'ConfigurationMixIn', 'Configuration',
'OptionsManager2ConfigurationAdapter')
import os
import sys
import re
from os.path import exists
from copy import copy
from ConfigParser import ConfigParser, NoOptionError, NoSectionError
from logilab.common.textutils import normalize_text, unquote
from logilab.common.optik_ext import OptionParser, OptionGroup, Values, \
OptionValueError, OptionError, HelpFormatter, generate_manpage, check_date, \
check_yn, check_csv, check_file, check_color, check_named, check_password,\
NO_DEFAULT, OPTPARSE_FORMAT_DEFAULT
REQUIRED = []
class UnsupportedAction(Exception):
"""raised by set_option when it doesn't know what to do for an action"""
# validation functions ########################################################
def choice_validator(opt_dict, name, value):
"""validate and return a converted value for option of type 'choice'
"""
if not value in opt_dict['choices']:
msg = "option %s: invalid value: %r, should be in %s"
raise OptionValueError(msg % (name, value, opt_dict['choices']))
return value
def multiple_choice_validator(opt_dict, name, value):
"""validate and return a converted value for option of type 'choice'
"""
choices = opt_dict['choices']
values = check_csv(None, name, value)
for value in values:
if not value in choices:
msg = "option %s: invalid value: %r, should be in %s"
raise OptionValueError(msg % (name, value, choices))
return values
def csv_validator(opt_dict, name, value):
"""validate and return a converted value for option of type 'csv'
"""
return check_csv(None, name, value)
def yn_validator(opt_dict, name, value):
"""validate and return a converted value for option of type 'yn'
"""
return check_yn(None, name, value)
def named_validator(opt_dict, name, value):
"""validate and return a converted value for option of type 'named'
"""
return check_named(None, name, value)
def file_validator(opt_dict, name, value):
"""validate and return a filepath for option of type 'file'"""
return check_file(None, name, value)
def color_validator(opt_dict, name, value):
"""validate and return a valid color for option of type 'color'"""
return check_color(None, name, value)
def password_validator(opt_dict, name, value):
"""validate and return a string for option of type 'password'"""
return check_password(None, name, value)
def date_validator(opt_dict, name, value):
"""validate and return a mx DateTime object for option of type 'date'"""
return check_password(None, name, value)
VALIDATORS = {'string' : unquote,
'int' : int,
'float': float,
'file': file_validator,
'font': unquote,
'color': color_validator,
'regexp': re.compile,
'csv': csv_validator,
'yn': yn_validator,
'bool': yn_validator,
'named': named_validator,
'password': password_validator,
'date': date_validator,
'choice': choice_validator,
'multiple_choice': multiple_choice_validator,
}
def _call_validator(opttype, optdict, option, value):
if not VALIDATORS.has_key(opttype):
raise Exception('Unsupported type "%s"' % opttype)
try:
return VALIDATORS[opttype](optdict, option, value)
except TypeError:
try:
return VALIDATORS[opttype](value)
except OptionValueError:
raise
except:
raise OptionValueError('%s value (%r) should be of type %s' %
(option, value, opttype))
# user input functions ########################################################
def input_password(optdict, question='password:'):
from getpass import getpass
while True:
value = getpass(question)
value2 = getpass('confirm: ')
if value == value2:
return value
print 'password mismatch, try again'
def input_string(optdict, question):
value = raw_input(question).strip()
return value or None
def _make_input_function(opttype):
def input_validator(optdict, question):
while True:
value = raw_input(question)
if not value.strip():
return None
try:
return _call_validator(opttype, optdict, None, value)
except OptionValueError, ex:
msg = str(ex).split(':', 1)[-1].strip()
print 'bad value: %s' % msg
return input_validator
INPUT_FUNCTIONS = {
'string': input_string,
'password': input_password,
}
for opttype in VALIDATORS.keys():
INPUT_FUNCTIONS.setdefault(opttype, _make_input_function(opttype))
def expand_default(self, option):
"""monkey patch OptionParser.expand_default since we have a particular
way to handle defaults to avoid overriding values in the configuration
file
"""
if self.parser is None or not self.default_tag:
return option.help
optname = option._long_opts[0][2:]
try:
provider = self.parser.options_manager._all_options[optname]
except KeyError:
value = None
else:
optdict = provider.get_option_def(optname)
optname = provider.option_name(optname, optdict)
value = getattr(provider.config, optname, optdict)
value = format_option_value(optdict, value)
if value is NO_DEFAULT or not value:
value = self.NO_DEFAULT_VALUE
return option.help.replace(self.default_tag, str(value))
def convert(value, opt_dict, name=''):
"""return a validated value for an option according to its type
optional argument name is only used for error message formatting
"""
try:
_type = opt_dict['type']
except KeyError:
# FIXME
return value
return _call_validator(_type, opt_dict, name, value)
def comment(string):
"""return string as a comment"""
lines = [line.strip() for line in string.splitlines()]
return '# ' + ('%s# ' % os.linesep).join(lines)
def format_option_value(optdict, value):
"""return the user input's value from a 'compiled' value"""
if isinstance(value, (list, tuple)):
value = ','.join(value)
elif isinstance(value, dict):
value = ','.join(['%s:%s' % (k,v) for k,v in value.items()])
elif hasattr(value, 'match'): # optdict.get('type') == 'regexp'
# compiled regexp
value = value.pattern
elif optdict.get('type') == 'yn':
value = value and 'yes' or 'no'
elif isinstance(value, (str, unicode)) and value.isspace():
value = "'%s'" % value
return value
def ini_format_section(stream, section, options, doc=None):
"""format an options section using the INI format"""
section_printed = False
for optname, optdict, value in options:
if value is None:
continue
if not section_printed:
if doc:
print >> stream, comment(doc)
print >> stream, '[%s]' % section
section_printed = True
value = format_option_value(optdict, value)
help = optdict.get('help')
if help:
print >> stream
print >> stream, normalize_text(help, line_len=79, indent='# ')
else:
print >> stream
print >> stream, '%s=%s' % (optname, str(value).strip())
format_section = ini_format_section
def rest_format_section(stream, section, options, doc=None):
"""format an options section using the INI format"""
if section:
print >> stream, '%s\n%s' % (section, "'"*len(section))
if doc:
print >> stream, normalize_text(doc, line_len=79, indent='')
print >> stream
for optname, optdict, value in options:
help = optdict.get('help')
print >> stream, ':%s:' % optname
if help:
print >> stream, normalize_text(help, line_len=79, indent=' ')
if value:
print >> stream, ' Default: %s' % format_option_value(optdict, value)
class OptionsManagerMixIn(object):
"""MixIn to handle a configuration from both a configuration file and
command line options
"""
def __init__(self, usage, config_file=None, version=None, quiet=0):
self.config_file = config_file
# configuration file parser
self._config_parser = ConfigParser()
# command line parser
self._optik_parser = OptionParser(usage=usage, version=version)
self._optik_parser.options_manager = self
# list of registered options providers
self.options_providers = []
# dictionary assocating option name to checker
self._all_options = {}
self._short_options = {}
self._nocallback_options = {}
# verbosity
self.quiet = quiet
def register_options_provider(self, provider, own_group=True):
"""register an options provider"""
assert provider.priority <= 0, "provider's priority can't be >= 0"
for i in range(len(self.options_providers)):
if provider.priority > self.options_providers[i].priority:
self.options_providers.insert(i, provider)
break
else:
self.options_providers.append(provider)
non_group_spec_options = [option for option in provider.options
if not option[1].has_key('group')]
groups = getattr(provider, 'option_groups', ())
if own_group:
self.add_option_group(provider.name.upper(), provider.__doc__,
non_group_spec_options, provider)
else:
for opt_name, opt_dict in non_group_spec_options:
args, opt_dict = self.optik_option(provider, opt_name, opt_dict)
self._optik_parser.add_option(*args, **opt_dict)
self._all_options[opt_name] = provider
for gname, gdoc in groups:
goptions = [option for option in provider.options
if option[1].get('group') == gname]
self.add_option_group(gname, gdoc, goptions, provider)
def add_option_group(self, group_name, doc, options, provider):
"""add an option group including the listed options
"""
# add section to the config file
self._config_parser.add_section(group_name)
# add option group to the command line parser
if options:
group = OptionGroup(self._optik_parser,
title=group_name.capitalize())
self._optik_parser.add_option_group(group)
# add provider's specific options
for opt_name, opt_dict in options:
args, opt_dict = self.optik_option(provider, opt_name, opt_dict)
group.add_option(*args, **opt_dict)
self._all_options[opt_name] = provider
def optik_option(self, provider, opt_name, opt_dict):
"""get our personal option definition and return a suitable form for
use with optik/optparse
"""
opt_dict = copy(opt_dict)
if opt_dict.has_key('action'):
self._nocallback_options[provider] = opt_name
else:
opt_dict['action'] = 'callback'
opt_dict['callback'] = self.cb_set_provider_option
for specific in ('default', 'group', 'inputlevel'):
if opt_dict.has_key(specific):
del opt_dict[specific]
if (OPTPARSE_FORMAT_DEFAULT
and specific == 'default' and opt_dict.has_key('help')):
opt_dict['help'] += ' [current: %default]'
args = ['--' + opt_name]
if opt_dict.has_key('short'):
self._short_options[opt_dict['short']] = opt_name
args.append('-' + opt_dict['short'])
del opt_dict['short']
return args, opt_dict
def cb_set_provider_option(self, option, opt_name, value, parser):
"""optik callback for option setting"""
if opt_name.startswith('--'):
# remove -- on long option
opt_name = opt_name[2:]
else:
# short option, get its long equivalent
opt_name = self._short_options[opt_name[1:]]
# trick since we can't set action='store_true' on options
if value is None:
value = 1
self.global_set_option(opt_name, value)
def global_set_option(self, opt_name, value):
"""set option on the correct option provider"""
self._all_options[opt_name].set_option(opt_name, value)
def generate_config(self, stream=None):
"""write a configuration file according to the current configuration
into the given stream or stdout
"""
stream = stream or sys.stdout
printed = False
for provider in self.options_providers:
default_options = []
sections = {}
for section, options in provider.options_by_section():
options = [(n, d, v) for (n, d, v) in options
if d.get('type') is not None and v is not None]
if section is None:
section = provider.name
doc = provider.__doc__
else:
doc = None
if printed:
print >> stream, '\n'
format_section(stream, section.upper(), options, doc)
printed = True
def generate_manpage(self, pkginfo, section=1, stream=None):
"""write a man page for the current configuration into the given
stream or stdout
"""
generate_manpage(self._optik_parser, pkginfo,
section, stream=stream or sys.stdout)
# initialization methods ##################################################
def load_provider_defaults(self):
"""initialize configuration using default values"""
for provider in self.options_providers:
provider.load_defaults()
def load_file_configuration(self, config_file=None):
"""load the configuration from file"""
self.read_config_file(config_file)
self.load_config_file()
def read_config_file(self, config_file=None):
"""read the configuration file but do not load it (ie dispatching
values to each options provider)
"""
if config_file is None:
config_file = self.config_file
if config_file and exists(config_file):
self._config_parser.read([config_file])
elif not self.quiet:
msg = 'No config file found, using default configuration'
print >> sys.stderr, msg
return
def input_config(self, onlysection=None, inputlevel=0, stream=None):
"""interactivly get configuration values by asking to the user and generate
a configuration file
"""
if onlysection is not None:
onlysection = onlysection.upper()
for provider in self.options_providers:
for section, option, optdict in provider.all_options():
if onlysection is not None and section != onlysection:
continue
default = provider.option_default(option, optdict)
if default is REQUIRED:
defaultstr = 'required'
else:
if optdict.get('inputlevel', 0) > inputlevel:
provider.set_option(option, default, opt_dict=optdict)
continue
defaultstr = 'default: %s' % format_option_value(optdict, default)
print ':%s:' % option
print optdict.get('help') or option
inputfunc = INPUT_FUNCTIONS[optdict['type']]
value = inputfunc(optdict, '(%s): ' % defaultstr)
while default is REQUIRED and not value:
print 'please specify a value'
value = inputfunc(optdict, '%s: ' % option)
if value is None and default is not None:
value = default
provider.set_option(option, value, opt_dict=optdict)
# now we can generate the configuration file
if stream is not None:
self.generate_config(stream)
def load_config_file(self):
"""dispatch values previously read from a configuration file to each
options provider)
"""
parser = self._config_parser
for provider in self.options_providers:
for section, option, optdict in provider.all_options():
try:
value = parser.get(section, option)
provider.set_option(option, value, opt_dict=optdict)
except (NoSectionError, NoOptionError), ex:
continue
def load_configuration(self, **kwargs):
"""override configuration according to given parameters
"""
for opt_name, opt_value in kwargs.items():
opt_name = opt_name.replace('_', '-')
provider = self._all_options[opt_name]
provider.set_option(opt_name, opt_value)
def load_command_line_configuration(self, args=None):
"""override configuration according to command line parameters
return additional arguments
"""
# monkey patch optparse to deal with our default values
try:
expand_default_backup = HelpFormatter.expand_default
HelpFormatter.expand_default = expand_default
except AttributeError:
# python < 2.4: nothing to be done
pass
try:
if args is None:
args = sys.argv[1:]
else:
args = list(args)
(options, args) = self._optik_parser.parse_args(args=args)
for provider in self._nocallback_options.keys():
config = provider.config
for attr in config.__dict__.keys():
value = getattr(options, attr, None)
if value is None:
continue
setattr(config, attr, value)
return args
finally:
if hasattr(HelpFormatter, 'expand_default'):
# unpatch optparse to avoid side effects
HelpFormatter.expand_default = expand_default_backup
# help methods ############################################################
def add_help_section(self, title, description):
"""add a dummy option section for help purpose """
group = OptionGroup(self._optik_parser,
title=title.capitalize(),
description=description)
self._optik_parser.add_option_group(group)
def help(self):
"""return the usage string for available options """
return self._optik_parser.format_help()
class Method:
"""used to ease late binding of default method (so you can define options
on the class using default methods on the configuration instance)
"""
def __init__(self, methname):
self.method = methname
self._inst = None
def bind(self, instance):
"""bind the method to its instance"""
self._inst = instance
def __call__(self):
assert self._inst, 'unbound method'
return getattr(self._inst, self.method)()
class OptionsProviderMixIn:
"""Mixin to provide options to an OptionsManager
"""
# those attributes should be overridden
priority = -1
name = 'default'
options = ()
def __init__(self):
self.config = Values()
for option in self.options:
try:
option, optdict = option
except ValueError:
raise Exception('Bad option: %r' % option)
if isinstance(optdict.get('default'), Method):
optdict['default'].bind(self)
def load_defaults(self):
"""initialize the provider using default values"""
for opt_name, opt_dict in self.options:
action = opt_dict.get('action')
if action != 'callback':
# callback action have no default
default = self.option_default(opt_name, opt_dict)
self.set_option(opt_name, default, action, opt_dict)
def option_default(self, opt_name, opt_dict=None):
"""return the default value for an option"""
if opt_dict is None:
opt_dict = self.get_option_def(opt_name)
default = opt_dict.get('default')
if callable(default):
default = default()
return default
def option_name(self, opt_name, opt_dict=None):
"""get the config attribute corresponding to opt_name
"""
if opt_dict is None:
opt_dict = self.get_option_def(opt_name)
return opt_dict.get('dest', opt_name.replace('-', '_'))
def option_value(self, opt_name):
"""get the current value for the given option"""
return getattr(self.config, self.option_name(opt_name), None)
def set_option(self, opt_name, value, action=None, opt_dict=None):
"""method called to set an option (registered in the options list)
"""
# print "************ setting option", opt_name," to value", value
if opt_dict is None:
opt_dict = self.get_option_def(opt_name)
if value is not None:
value = convert(value, opt_dict, opt_name)
if action is None:
action = opt_dict.get('action', 'store')
if opt_dict.get('type') == 'named': # XXX need specific handling
optname = self.option_name(opt_name, opt_dict)
currentvalue = getattr(self.config, optname, None)
if currentvalue:
currentvalue.update(value)
value = currentvalue
if action == 'store':
setattr(self.config, self.option_name(opt_name, opt_dict), value)
elif action in ('store_true', 'count'):
setattr(self.config, self.option_name(opt_name, opt_dict), 0)
elif action == 'store_false':
setattr(self.config, self.option_name(opt_name, opt_dict), 1)
elif action == 'append':
opt_name = self.option_name(opt_name, opt_dict)
_list = getattr(self.config, opt_name, None)
if _list is None:
if type(value) in (type(()), type([])):
_list = value
elif value is not None:
_list = []
_list.append(value)
setattr(self.config, opt_name, _list)
elif type(_list) is type(()):
setattr(self.config, opt_name, _list + (value,))
else:
_list.append(value)
else:
raise UnsupportedAction(action)
def get_option_def(self, opt_name):
"""return the dictionary defining an option given it's name"""
assert self.options
for opt in self.options:
if opt[0] == opt_name:
return opt[1]
raise OptionError('no such option in section %r' % self.name, opt_name)
def all_options(self):
"""return an iterator on available options for this provider
option are actually described by a 3-uple:
(section, option name, option dictionary)
"""
for section, options in self.options_by_section():
if section is None:
section = self.name.upper()
for option, optiondict, value in options:
yield section, option, optiondict
def options_by_section(self):
"""return an iterator on options grouped by section
(section, [list of (optname, optdict, optvalue)])
"""
sections = {}
for optname, optdict in self.options:
sections.setdefault(optdict.get('group'), []).append(
(optname, optdict, self.option_value(optname)))
if None in sections:
yield None, sections.pop(None)
for section, options in sections.items():
yield section.upper(), options
class ConfigurationMixIn(OptionsManagerMixIn, OptionsProviderMixIn):
"""basic mixin for simple configurations which don't need the
manager / providers model
"""
def __init__(self, *args, **kwargs):
if not args:
kwargs.setdefault('usage', '')
kwargs.setdefault('quiet', 1)
OptionsManagerMixIn.__init__(self, *args, **kwargs)
OptionsProviderMixIn.__init__(self)
if not getattr(self, 'option_groups', None):
self.option_groups = []
for option, optdict in self.options:
try:
gdef = (optdict['group'], '')
except KeyError:
continue
if not gdef in self.option_groups:
self.option_groups.append(gdef)
self.register_options_provider(self, own_group=0)
def register_options(self, options):
"""add some options to the configuration"""
options_by_group = {}
for optname, optdict in options:
options_by_group.setdefault(optdict['group'], []).append((optname, optdict))
for group, options in options_by_group.items():
self.add_option_group(group, None, options, self)
self.options += tuple(options)
def load_defaults(self):
OptionsProviderMixIn.load_defaults(self)
def __getitem__(self, key):
try:
return getattr(self.config, self.option_name(key))
except (OptionValueError, AttributeError):
raise KeyError(key)
def __setitem__(self, key, value):
self.set_option(self.option_name(key), value)
def get(self, key, default=None):
try:
return getattr(self.config, self.option_name(key))
except (OptionError, AttributeError):
return default
class Configuration(ConfigurationMixIn):
"""class for simple configurations which don't need the
manager / providers model and prefer delegation to inheritance
configuration values are accessible through a dict like interface
"""
def __init__(self, config_file=None, options=None, name=None,
usage=None, doc=None, version=None):
if options is not None:
self.options = options
if name is not None:
self.name = name
if doc is not None:
self.__doc__ = doc
super(Configuration, self).__init__(config_file=config_file, usage=usage, version=version)
self.load_defaults()
class OptionsManager2ConfigurationAdapter:
"""Adapt an option manager to behave like a
`logilab.common.configuration.Configuration` instance
"""
def __init__(self, provider):
self.config = provider
def __getattr__(self, key):
return getattr(self.config, key)
def __getitem__(self, key):
provider = self.config._all_options[key]
try:
return getattr(provider.config, provider.option_name(key))
except AttributeError:
raise KeyError(key)
def __setitem__(self, key, value):
self.config.global_set_option(self.config.option_name(key), value)
def get(self, key, default=None):
provider = self.config._all_options[key]
try:
return getattr(provider.config, provider.option_name(key))
except AttributeError:
return default
|