← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/option.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-01-17 18:41:07 UTC
  • mfrom: (2221.4.9 registryoption)
  • Revision ID: pqm@pqm.ubuntu.com-20070117184107-a6267599a6b636f1
Add RegistryOption, use for directory format

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/option.py
203
203
        yield self.name, self.short_name(), argname, self.help
204
204
 
205
205
 
 
206
class RegistryOption(Option):
 
207
    """Option based on a registry
 
208
 
 
209
    The values for the options correspond to entries in the registry.  Input
 
210
    must be a registry key.  After validation, it is converted into an object
 
211
    using Registry.get or a caller-provided converter.
 
212
    """
 
213
 
 
214
    def validate_value(self, value):
 
215
        """Validate a value name"""
 
216
        if value not in self.registry:
 
217
            raise errors.BadOptionValue(self.name, value)
 
218
 
 
219
    def convert(self, value):
 
220
        """Convert a value name into an output type"""
 
221
        self.validate_value(value)
 
222
        if self.converter is None:
 
223
            return self.registry.get(value)
 
224
        else:
 
225
            return self.converter(value)
 
226
 
 
227
    def __init__(self, name, help, registry, converter=None,
 
228
        value_switches=False):
 
229
        """
 
230
        Constructor.
 
231
 
 
232
        :param name: The option name.
 
233
        :param help: Help for the option.
 
234
        :param registry: A Registry containing the values
 
235
        :param converter: Callable to invoke with the value name to produce
 
236
            the value.  If not supplied, self.registry.get is used.
 
237
        :param value_switches: If true, each possible value is assigned its
 
238
            own switch.  For example, instead of '--format metaweave',
 
239
            '--metaweave' can be used interchangeably.
 
240
        """
 
241
        Option.__init__(self, name, help, type=self.convert)
 
242
        self.registry = registry
 
243
        self.name = name
 
244
        self.converter = converter
 
245
        self.value_switches = value_switches
 
246
 
 
247
    def add_option(self, parser, short_name):
 
248
        """Add this option to an Optparse parser"""
 
249
        Option.add_option(self, parser, short_name)
 
250
        if self.value_switches:
 
251
            for key in self.registry.keys():
 
252
                option_strings = ['--%s' % key]
 
253
                parser.add_option(action='callback',
 
254
                              callback=self._optparse_value_callback(key),
 
255
                                  help=self.registry.get_help(key),
 
256
                                  *option_strings)
 
257
 
 
258
    def _optparse_value_callback(self, cb_value):
 
259
        def cb(option, opt, value, parser):
 
260
            setattr(parser.values, self.name, self.type(cb_value))
 
261
        return cb
 
262
 
 
263
    def iter_switches(self):
 
264
        """Iterate through the list of switches provided by the option
 
265
 
 
266
        :return: an iterator of (name, short_name, argname, help)
 
267
        """
 
268
        for value in Option.iter_switches(self):
 
269
            yield value
 
270
        if self.value_switches:
 
271
            for key in sorted(self.registry.keys()):
 
272
                yield key, None, None, self.registry.get_help(key)
 
273
 
 
274
 
206
275
class OptionParser(optparse.OptionParser):
207
276
    """OptionParser that raises exceptions instead of exiting"""
208
277