Mercurial > hg > configuration

annotate configuration/config.py @ 28:c516ab813079

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
begin stubbing serialization/deserialization
author Jeff Hammel <jhammel@mozilla.com>
date Mon, 26 Mar 2012 16:54:37 -0700
parents c6d966431498
children fadcc6ab51d4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
1 #!/usr/bin/env python
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
2
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
3 """
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
4 multi-level unified configuration
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
5 """
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
6
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
7 import sys
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
8 import optparse
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
9
5
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
10 # imports for contigent configuration providers
4
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
11 try:
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
12 import json
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
13 except ImportError:
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
14 try:
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
15 import simplejson as json
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
16 except ImportError:
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
17 json = None
5
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
18 try:
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
19 import yaml
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
20 except ImportError:
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
21 yaml = None
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
22
24
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
23 __all__ = ['Configuration', 'configuration_providers', 'types']
6
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
24
26
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
25 ### configuration providers for serialization/deserialization
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
26
5
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
27 configuration_providers = []
26
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
28
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
29 class ConfigurationProvider(object):
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
30 """
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
31 abstract base class for configuration providers for
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
32 serialization/deserialization
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
33 """
27
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
34 def read(self, filename):
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
35 raise NotImplementedError("Abstract base class")
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
36
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
37 def write(self, config, filename):
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
38 if isinstance(filename, basestring):
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
39 f = file(filename, 'w')
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
40 newfile = True
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
41 else:
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
42 f = filename
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
43 newfile = False
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
44 try:
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
45 self._write(f, config)
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
46 finally:
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
47 # XXX try: finally: works in python >= 2.5
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
48 if newfile:
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
49 f.close()
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
50 def _write(self, fp, config):
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
51 raise NotImplementedError("Abstract base class")
26
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
52
5
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
53 if json:
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
54 class JSON(object):
27
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
55 indent = 2
5
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
56 extensions = ['json']
7
6e3cf8f05464 note TODO: reading JSON
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
57 def read(self, filename):
9
b28ec204df23 flush out JSON provider
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
58 return json.loads(file(filename).read())
27
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
59 def _write(self, fp, config):
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
60 fp.write(json.dumps(config), indent=self.indent, sort_keys=True)
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
61 # TODO: could use templates to get order down, etc
5
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
62 configuration_providers.append(JSON)
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
63
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
64 if yaml:
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
65 class YAML(object):
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
66 extensions = ['yml']
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
67 def read(self, filename):
6
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
68 f = file(filename)
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
69 config = yaml.load(f)
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
70 f.close()
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
71 return config
27
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
72 def _write(self, fp, config):
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
73 fp.write(yaml.dump(config))
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
74 # TODO: could use templates to get order down, etc
6
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
75
5
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
76 configuration_providers.append(YAML)
4
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
77
21
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
78 ### plugins for option types
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
79 ### TODO: this could use a bit of thought
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
80 def base_cli(name, value):
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
81 # CLI arguments
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
82 args = value.get('flags', ['--%s' % name])
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
83 if not args:
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
84 # No CLI interface
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
85 return (), {}
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
86
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
87 kw = {'dest': name}
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
88 help = value.get('help', name)
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
89 if 'default' in value:
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
90 kw['default'] = value['default']
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
91 # TODO: use default pattern a la
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
92 # - http://hg.mozilla.org/build/talos/file/c6013a2f09ce/talos/PerfConfigurator.py#l358
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
93 # - http://k0s.org/mozilla/hg/bzconsole/file/d5e88dadde69/bzconsole/command.py#l12
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
94
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
95 help += ' [DEFAULT: %s]' % value['default']
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
96 kw['help'] = help
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
97 kw['action'] = 'store'
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
98 return args, kw
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
99
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
100 def bool_cli(name, value):
23
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
101
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
102 # preserve the default values
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
103 help = value.get('help')
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
104 flags = value.get('flags')
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
105
21
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
106 args, kw = base_cli(name, value)
23
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
107 kw['help'] = help # reset
21
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
108 if value.get('default'):
23
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
109 kw['action'] = 'store_false'
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
110 if not flags:
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
111 args = ['--no-%s' % name]
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
112 if not help:
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
113 kw['help'] = 'disable %s' % name
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
114 else:
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
115 kw['action'] = 'store_true'
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
116 if not help:
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
117 kw['help'] = 'enable %s' % name
21
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
118 return args, kw
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
119
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
120 def list_cli(name, value):
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
121 args, kw = base_cli(name, value)
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
122
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
123 # TODO: could use 'extend'
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
124 # - http://hg.mozilla.org/build/mozharness/file/5f44ba08f4be/mozharness/base/config.py#l41
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
125
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
126 # TODO: what about nested types?
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
127 kw['action'] = 'append'
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
128 return args, kw
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
129
23
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
130 def int_cli(name, value):
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
131 args, kw = base_cli(name, value)
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
132 kw['type'] = 'int'
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
133 return args, kw
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
134
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
135 def float_cli(name, value):
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
136 args, kw = base_cli(name, value)
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
137 kw['type'] = 'float'
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
138 return args, kw
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
139
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
140 types = {bool: bool_cli,
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
141 int: int_cli,
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
142 float: float_cli,
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
143 list: list_cli,
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
144 None: base_cli} # default
24
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
145 __all__ += [i.__name__ for i in types.values()]
4
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
146
1
1dbdb4a57e0c stub configuration class
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
147 class Configuration(object):
1dbdb4a57e0c stub configuration class
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
148 options = {}
1dbdb4a57e0c stub configuration class
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
149
21
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
150 def __init__(self, configuration_providers=configuration_providers, types=types):
2
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
151 self.config = {}
6
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
152 self.configuration_providers = configuration_providers
21
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
153 self.types = types
2
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
154
11
e00afe2c83bf stubbing configuration parser
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
155 def items(self):
e00afe2c83bf stubbing configuration parser
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
156 # TODO: allow options to be a list of 2-tuples
13
0f8115a41ad6 bug fixes
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
157 return self.options.items()
11
e00afe2c83bf stubbing configuration parser
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
158
24
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
159 ### methods for validating configuration
2
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
160
24
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
161 def check(self, config):
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
162 """
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
163 check validity of configuration to be added
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
164 """
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
165 # TODO: should probably deepcopy config
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
166
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
167 # ensure options in configuration are in self.options
25
b39e550402ea we now update configuration correctly
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
168 unknown_options = [i for i in config if i not in self.options]
24
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
169 if unknown_options:
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
170 # TODO: more specific error type
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
171 raise Exception("Unknown options: %s" % ', '.join(unknown_options))
6
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
172
10
c782d750fd6d comment
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
173 # TODO: ensure options are of the right type (if specified)
24
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
174 for key, value in config.items():
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
175 _type = self.options[key].get('type')
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
176 if _type is not None:
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
177 config[key] = _type(value)
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
178
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
179 return config
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
180
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
181 def validate(self):
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
182 """validate resultant configuration"""
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
183 # TODO: configuration should be locked after this is called
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
184
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
185 ### methods for adding configuration
6
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
186
2
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
187 def __call__(self, *args):
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
188 """add items to configuration and check it"""
24
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
189 for config in args:
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
190 self.add(config)
25
b39e550402ea we now update configuration correctly
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
191 self.validate() # validate total configuration
24
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
192 # TODO: configuration should be locked after this is called
2
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
193
24
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
194 def add(self, config, check=True):
2
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
195 """update configuration: not undoable"""
6
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
196
24
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
197 self.check(config) # check config to be added
2
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
198 self.config.update(config)
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
199 # TODO: option to extend; augment lists/dicts
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
200
18
d8871956536e remove cruft and start to organize
Jeff Hammel <jhammel@mozilla.com>
parents: 17
diff changeset
201 ### methods for optparse
d8871956536e remove cruft and start to organize
Jeff Hammel <jhammel@mozilla.com>
parents: 17
diff changeset
202 ### XXX could go in a subclass
d8871956536e remove cruft and start to organize
Jeff Hammel <jhammel@mozilla.com>
parents: 17
diff changeset
203
17
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
204 def optparse_options(self, parser):
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
205 """add optparse options to a OptionParser instance"""
11
e00afe2c83bf stubbing configuration parser
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
206 for key, value in self.items():
21
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
207 handler = self.types[value.get('type')]
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
208 args, kw = handler(key, value)
11
e00afe2c83bf stubbing configuration parser
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
209 if not args:
21
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
210 # No CLI interface
11
e00afe2c83bf stubbing configuration parser
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
211 continue
12
db43d30afcf5 note pattern to use
Jeff Hammel <jhammel@mozilla.com>
parents: 11
diff changeset
212 parser.add_option(*args, **kw)
17
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
213
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
214 def parser(self, configuration_provider_option=None, **parser_args):
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
215 """
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
216 return OptionParser for this Configuration instance
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
217 - configuration_provider_options : option for configuration files [TODO]
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
218 (also TODO: a special value that equates to the first file extension value
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
219 for the configuration_providers)
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
220 - parser_args : arguments to the OptionParser constructor
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
221 """
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
222 if 'description' not in parser_args:
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
223 parser_args['description'] = getattr(self, '__doc__', '')
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
224 if 'formatter' not in parser_args:
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
225 class PlainDescriptionFormatter(optparse.IndentedHelpFormatter):
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
226 """description formatter for console script entry point"""
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
227 def format_description(self, description):
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
228 if description:
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
229 return description.strip() + '\n'
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
230 else:
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
231 return ''
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
232 parser_args['formatter'] = PlainDescriptionFormatter()
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
233 parser = optparse.OptionParser(**parser_args)
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
234 self.optparse_options(parser)
15
0df4bfdc2c96 make --help work
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
235 return parser
19
cadc9514f60a we have a legitimately failing test!
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
236
24
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
237 def parse(self, args=sys.argv[1:], parser=None, configuration_provider_option=None):
19
cadc9514f60a we have a legitimately failing test!
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
238 """parse configuration including command line options"""
cadc9514f60a we have a legitimately failing test!
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
239
cadc9514f60a we have a legitimately failing test!
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
240 # parse arguments
cadc9514f60a we have a legitimately failing test!
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
241 if parser is None:
24
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
242 parser = self.parser(configuration_provider_option=configuration_provider_option)
19
cadc9514f60a we have a legitimately failing test!
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
243 options, args = parser.parse_args(args)
cadc9514f60a we have a legitimately failing test!
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
244
24
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
245 # get CLI configuration options
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
246 cli_config = dict([(key, value) for key, value in options.__dict__.items()
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
247 if key in self.options])
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
248
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
249 # generate configuration
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
250 self(cli_config)
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
251
19
cadc9514f60a we have a legitimately failing test!
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
252 # return parsed arguments
cadc9514f60a we have a legitimately failing test!
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
253 return options, args
28
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
254
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
255 ### serialization/deserialization
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
256
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
257 def configuration_provider(self, format):
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
258 """configuration provider guess for a given filename"""
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
259 for provider in self.configuration_providers:
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
260 if format in provider.extensions:
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
261 return provider
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
262
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
263 def serialize(self, filename, format=None):
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
264 """serialize configuration to a file"""
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
265
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
266 def deserialize(self, filename, format=None):
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
267 """load configuration from a file"""
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
268
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
269 extension = os.path.splitext(filename)[-1]
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
270 if not extension:
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
271 return None