Mercurial > hg > configuration

annotate configuration/config.py @ 38:8909ae1cc4ea

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix serialization (stub) tests
author Jeff Hammel <jhammel@mozilla.com>
date Tue, 27 Mar 2012 10:28:02 -0700
parents a1f8dec4d4f9
children 1bd4ddf2e81d
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
34
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
7 import copy
37
a1f8dec4d4f9 we has another broken test
Jeff Hammel <jhammel@mozilla.com>
parents: 36
diff changeset
8 import os
0
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
9 import sys
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
10 import optparse
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
11
5
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
12 # imports for contigent configuration providers
4
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
13 try:
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
14 import json
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
15 except ImportError:
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
16 try:
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
17 import simplejson as json
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
18 except ImportError:
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
19 json = None
5
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
20 try:
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
21 import yaml
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
22 except ImportError:
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
23 yaml = None
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
24
36
d218df4d0b4c add test for missing values
Jeff Hammel <jhammel@mozilla.com>
parents: 35
diff changeset
25 __all__ = ['Configuration', 'configuration_providers', 'types', 'MissingValueException']
d218df4d0b4c add test for missing values
Jeff Hammel <jhammel@mozilla.com>
parents: 35
diff changeset
26
d218df4d0b4c add test for missing values
Jeff Hammel <jhammel@mozilla.com>
parents: 35
diff changeset
27 ### exceptions
d218df4d0b4c add test for missing values
Jeff Hammel <jhammel@mozilla.com>
parents: 35
diff changeset
28
d218df4d0b4c add test for missing values
Jeff Hammel <jhammel@mozilla.com>
parents: 35
diff changeset
29 class MissingValueException(Exception):
d218df4d0b4c add test for missing values
Jeff Hammel <jhammel@mozilla.com>
parents: 35
diff changeset
30 """exception raised when a required value is missing"""
6
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
31
26
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
32 ### configuration providers for serialization/deserialization
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
33
5
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
34 configuration_providers = []
26
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
35
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
36 class ConfigurationProvider(object):
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
37 """
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
38 abstract base class for configuration providers for
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
39 serialization/deserialization
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
40 """
27
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
41 def read(self, filename):
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
42 raise NotImplementedError("Abstract base class")
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
43
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
44 def write(self, config, filename):
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
45 if isinstance(filename, basestring):
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
46 f = file(filename, 'w')
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
47 newfile = True
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
48 else:
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
49 f = filename
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
50 newfile = False
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
51 try:
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
52 self._write(f, config)
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
53 finally:
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
54 # XXX try: finally: works in python >= 2.5
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
55 if newfile:
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
56 f.close()
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
57 def _write(self, fp, config):
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
58 raise NotImplementedError("Abstract base class")
26
4fd88b1b08d5 ABC-ing configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
59
5
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
60 if json:
38
8909ae1cc4ea fix serialization (stub) tests
Jeff Hammel <jhammel@mozilla.com>
parents: 37
diff changeset
61 class JSON(ConfigurationProvider):
27
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
62 indent = 2
5
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
63 extensions = ['json']
7
6e3cf8f05464 note TODO: reading JSON
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
64 def read(self, filename):
9
b28ec204df23 flush out JSON provider
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
65 return json.loads(file(filename).read())
27
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
66 def _write(self, fp, config):
38
8909ae1cc4ea fix serialization (stub) tests
Jeff Hammel <jhammel@mozilla.com>
parents: 37
diff changeset
67 fp.write(json.dumps(config, indent=self.indent, sort_keys=True))
27
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
68 # TODO: could use templates to get order down, etc
30
b27a7cb2dd5b stub test for configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 29
diff changeset
69 configuration_providers.append(JSON())
5
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
70
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
71 if yaml:
38
8909ae1cc4ea fix serialization (stub) tests
Jeff Hammel <jhammel@mozilla.com>
parents: 37
diff changeset
72 class YAML(ConfigurationProvider):
30
b27a7cb2dd5b stub test for configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 29
diff changeset
73 extensions = ['yml', 'yaml']
5
7910b0ef0bab stub configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
74 def read(self, filename):
6
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
75 f = file(filename)
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
76 config = yaml.load(f)
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
77 f.close()
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
78 return config
27
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
79 def _write(self, fp, config):
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
80 fp.write(yaml.dump(config))
c6d966431498 add serialization details
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
81 # TODO: could use templates to get order down, etc
6
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
82
30
b27a7cb2dd5b stub test for configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 29
diff changeset
83 configuration_providers.append(YAML())
b27a7cb2dd5b stub test for configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 29
diff changeset
84
b27a7cb2dd5b stub test for configuration providers
Jeff Hammel <jhammel@mozilla.com>
parents: 29
diff changeset
85 __all__.extend([i.__class__.__name__ for i in configuration_providers])
4
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
86
21
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
87 ### plugins for option types
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
88 ### TODO: this could use a bit of thought
31
5571d1608cba add comments
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
89 ### They should probably be classes
21
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
90 def base_cli(name, value):
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
91 # CLI arguments
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
92 args = value.get('flags', ['--%s' % name])
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
93 if not args:
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
94 # No CLI interface
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
95 return (), {}
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
96
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
97 kw = {'dest': name}
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
98 help = value.get('help', name)
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
99 if 'default' in value:
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
100 kw['default'] = value['default']
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
101 # TODO: use default pattern a la
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
102 # - 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
103 # - 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
104
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
105 help += ' [DEFAULT: %s]' % value['default']
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
106 kw['help'] = help
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
107 kw['action'] = 'store'
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
108 return args, kw
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
109
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
110 def bool_cli(name, value):
23
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
111
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
112 # preserve the default values
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
113 help = value.get('help')
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
114 flags = value.get('flags')
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
115
21
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
116 args, kw = base_cli(name, value)
23
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
117 kw['help'] = help # reset
21
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
118 if value.get('default'):
23
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
119 kw['action'] = 'store_false'
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
120 if not flags:
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
121 args = ['--no-%s' % name]
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
122 if not help:
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
123 kw['help'] = 'disable %s' % name
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
124 else:
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
125 kw['action'] = 'store_true'
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
126 if not help:
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
127 kw['help'] = 'enable %s' % name
21
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
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
130 def list_cli(name, value):
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
131 args, kw = base_cli(name, value)
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
132
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
133 # TODO: could use 'extend'
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
134 # - 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
135
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
136 # TODO: what about nested types?
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
137 kw['action'] = 'append'
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
138 return args, kw
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
139
23
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
140 def int_cli(name, value):
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
141 args, kw = base_cli(name, value)
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
142 kw['type'] = 'int'
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
143 return args, kw
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
144
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
145 def float_cli(name, value):
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
146 args, kw = base_cli(name, value)
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
147 kw['type'] = 'float'
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
148 return args, kw
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
149
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
150 types = {bool: bool_cli,
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
151 int: int_cli,
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
152 float: float_cli,
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
153 list: list_cli,
73e72a764c3a fix bool parser, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
154 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
155 __all__ += [i.__name__ for i in types.values()]
4
92e1b2dd60c8 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
156
1
1dbdb4a57e0c stub configuration class
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
157 class Configuration(object):
29
fadcc6ab51d4 more (de/)serialization stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
158 """declarative configuration object"""
fadcc6ab51d4 more (de/)serialization stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
159
fadcc6ab51d4 more (de/)serialization stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
160 options = {} # configuration basis
1
1dbdb4a57e0c stub configuration class
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
161
21
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
162 def __init__(self, configuration_providers=configuration_providers, types=types):
2
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
163 self.config = {}
6
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
164 self.configuration_providers = configuration_providers
21
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
165 self.types = types
2
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
166
29
fadcc6ab51d4 more (de/)serialization stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
167 ### methods for iteration
fadcc6ab51d4 more (de/)serialization stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
168 ### TODO: make this a real iterator
fadcc6ab51d4 more (de/)serialization stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
169
11
e00afe2c83bf stubbing configuration parser
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
170 def items(self):
e00afe2c83bf stubbing configuration parser
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
171 # TODO: allow options to be a list of 2-tuples
13
0f8115a41ad6 bug fixes
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
172 return self.options.items()
11
e00afe2c83bf stubbing configuration parser
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
173
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 ### methods for validating configuration
2
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
175
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
176 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
177 """
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 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
179 """
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 # 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
181
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 # ensure options in configuration are in self.options
25
b39e550402ea we now update configuration correctly
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
183 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
184 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
185 # 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
186 raise Exception("Unknown options: %s" % ', '.join(unknown_options))
6
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
187
10
c782d750fd6d comment
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
188 # 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
189 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
190 _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
191 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
192 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
193
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 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
195
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
196 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
197 """validate resultant configuration"""
35
321fe58a9eae flush out validate function
Jeff Hammel <jhammel@mozilla.com>
parents: 34
diff changeset
198 for key, value in self.options.items():
321fe58a9eae flush out validate function
Jeff Hammel <jhammel@mozilla.com>
parents: 34
diff changeset
199 if key not in self.config:
321fe58a9eae flush out validate function
Jeff Hammel <jhammel@mozilla.com>
parents: 34
diff changeset
200 required = value.get('required')
321fe58a9eae flush out validate function
Jeff Hammel <jhammel@mozilla.com>
parents: 34
diff changeset
201 if required:
321fe58a9eae flush out validate function
Jeff Hammel <jhammel@mozilla.com>
parents: 34
diff changeset
202 if isinstance(required, basestring):
321fe58a9eae flush out validate function
Jeff Hammel <jhammel@mozilla.com>
parents: 34
diff changeset
203 required_message = required
321fe58a9eae flush out validate function
Jeff Hammel <jhammel@mozilla.com>
parents: 34
diff changeset
204 else:
321fe58a9eae flush out validate function
Jeff Hammel <jhammel@mozilla.com>
parents: 34
diff changeset
205 required_message = "Parameter %s is required but not present" % key
321fe58a9eae flush out validate function
Jeff Hammel <jhammel@mozilla.com>
parents: 34
diff changeset
206 # TODO: more specific exception
37
a1f8dec4d4f9 we has another broken test
Jeff Hammel <jhammel@mozilla.com>
parents: 36
diff changeset
207 # Also, this should probably raise all missing values vs
a1f8dec4d4f9 we has another broken test
Jeff Hammel <jhammel@mozilla.com>
parents: 36
diff changeset
208 # one by one
36
d218df4d0b4c add test for missing values
Jeff Hammel <jhammel@mozilla.com>
parents: 35
diff changeset
209 raise MissingValueException(required_message)
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
210 # 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
211
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
212 ### methods for adding configuration
6
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
213
2
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
214 def __call__(self, *args):
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
215 """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
216 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
217 self.add(config)
34
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
218
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
219 # add defaults if not present
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
220 for key, value in self.options.items():
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
221 if 'default' in value and key not in self.config:
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
222 self.config[key] = value['default']
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
223
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
224 # validate total configuration
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
225 self.validate()
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
226 # TODO: configuration should be locked after this is called
2
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
227
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
228 def add(self, config, check=True):
2
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
229 """update configuration: not undoable"""
6
dce954a3831f more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
230
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
231 self.check(config) # check config to be added
2
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
232 self.config.update(config)
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
233 # TODO: option to extend; augment lists/dicts
35f57b21885f no stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
234
18
d8871956536e remove cruft and start to organize
Jeff Hammel <jhammel@mozilla.com>
parents: 17
diff changeset
235 ### methods for optparse
d8871956536e remove cruft and start to organize
Jeff Hammel <jhammel@mozilla.com>
parents: 17
diff changeset
236 ### XXX could go in a subclass
d8871956536e remove cruft and start to organize
Jeff Hammel <jhammel@mozilla.com>
parents: 17
diff changeset
237
17
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
238 def optparse_options(self, parser):
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
239 """add optparse options to a OptionParser instance"""
11
e00afe2c83bf stubbing configuration parser
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
240 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
241 handler = self.types[value.get('type')]
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
242 args, kw = handler(key, value)
11
e00afe2c83bf stubbing configuration parser
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
243 if not args:
21
0fe74db6a56c a hacky way to do CLI types handlers
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
244 # No CLI interface
11
e00afe2c83bf stubbing configuration parser
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
245 continue
12
db43d30afcf5 note pattern to use
Jeff Hammel <jhammel@mozilla.com>
parents: 11
diff changeset
246 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
247
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
248 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
249 """
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
250 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
251 - 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
252 (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
253 for the configuration_providers)
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
254 - 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
255 """
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
256 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
257 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
258 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
259 class PlainDescriptionFormatter(optparse.IndentedHelpFormatter):
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
260 """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
261 def format_description(self, description):
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
262 if description:
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
263 return description.strip() + '\n'
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
264 else:
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
265 return ''
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
266 parser_args['formatter'] = PlainDescriptionFormatter()
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
267 parser = optparse.OptionParser(**parser_args)
a78ab14ae376 separate thing to add options to its own function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
268 self.optparse_options(parser)
15
0df4bfdc2c96 make --help work
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
269 return parser
19
cadc9514f60a we have a legitimately failing test!
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
270
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
271 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
272 """parse configuration including command line options"""
cadc9514f60a we have a legitimately failing test!
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
273
cadc9514f60a we have a legitimately failing test!
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
274 # parse arguments
cadc9514f60a we have a legitimately failing test!
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
275 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
276 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
277 options, args = parser.parse_args(args)
cadc9514f60a we have a legitimately failing test!
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
278
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
279 # 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
280 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
281 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
282
39f2611db9be rename a bunch of things and begin to work on the sanity of validation
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
283 # 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
284 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
285
19
cadc9514f60a we have a legitimately failing test!
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
286 # return parsed arguments
cadc9514f60a we have a legitimately failing test!
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
287 return options, args
28
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
288
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
289 ### serialization/deserialization
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
290
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
291 def configuration_provider(self, format):
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
292 """configuration provider guess for a given filename"""
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
293 for provider in self.configuration_providers:
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
294 if format in provider.extensions:
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
295 return provider
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
296
34
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
297 def filename2format(self, filename):
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
298 extension = os.path.splitext(filename)[-1]
38
8909ae1cc4ea fix serialization (stub) tests
Jeff Hammel <jhammel@mozilla.com>
parents: 37
diff changeset
299 return extension.lstrip('.') or None
34
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
300
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
301 def serialize(self, filename, format=None, full=False):
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
302 """
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
303 serialize configuration to a file
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
304 - filename: path of file to serialize to
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
305 - format: format of configuration provider
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
306 - full: whether to serialize non-set optional strings [TODO]
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
307 """
29
fadcc6ab51d4 more (de/)serialization stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
308 # TODO: allow file object vs file name
28
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
309
34
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
310 if not format:
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
311 format = self.filename2format(filename)
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
312 if not format:
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
313 raise Exception('Please specify a format')
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
314 # TODO: more specific exception type
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
315
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
316 provider = self.configuration_provider(format)
38
8909ae1cc4ea fix serialization (stub) tests
Jeff Hammel <jhammel@mozilla.com>
parents: 37
diff changeset
317 if not provider:
8909ae1cc4ea fix serialization (stub) tests
Jeff Hammel <jhammel@mozilla.com>
parents: 37
diff changeset
318 raise Exception("Provider not found for format: %s" % format)
34
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
319
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
320 config = copy.deepcopy(self.config)
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
321
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
322 provider.write(config, filename)
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
323
28
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
324 def deserialize(self, filename, format=None):
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
325 """load configuration from a file"""
29
fadcc6ab51d4 more (de/)serialization stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
326 # TODO: allow file object vs file name
28
c516ab813079 begin stubbing serialization/deserialization
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
327
29
fadcc6ab51d4 more (de/)serialization stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
328 if not format:
fadcc6ab51d4 more (de/)serialization stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
329 extension = os.path.splitext(filename)[-1]
34
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
330
79aca36abd9a fill in defaults if not present
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
331 raise NotImplementedError("TODO")