← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/option.py

merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/option.py
1
 
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006 by Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
17
17
# TODO: For things like --diff-prefix, we want a way to customize the display
18
18
# of the option argument.
19
19
 
 
20
import optparse
20
21
import re
21
22
 
22
 
from bzrlib.lazy_import import lazy_import
23
 
lazy_import(globals(), """
24
 
import optparse
25
 
 
26
 
from bzrlib import (
27
 
    errors,
28
 
    log,
29
 
    registry,
30
 
    revisionspec,
31
 
    symbol_versioning,
32
 
    )
33
 
""")
34
23
from bzrlib.trace import warning
 
24
from bzrlib.revisionspec import RevisionSpec
 
25
from bzrlib.errors import BzrCommandError
35
26
 
36
27
 
37
28
def _parse_revision_str(revstr):
89
80
    """
90
81
    # TODO: Maybe move this into revisionspec.py
91
82
    revs = []
92
 
    # split on the first .. that is not followed by a / ?
93
83
    sep = re.compile("\\.\\.(?!/)")
94
84
    for x in sep.split(revstr):
95
 
        revs.append(revisionspec.RevisionSpec.from_string(x or None))
 
85
        revs.append(RevisionSpec.from_string(x or None))
96
86
    return revs
97
87
 
98
88
 
110
100
        type_list = '\n'.join(lines)
111
101
        msg = "No known merge type %s. Supported types are:\n%s" %\
112
102
            (typestring, type_list)
113
 
        raise errors.BzrCommandError(msg)
114
 
 
 
103
        raise BzrCommandError(msg)
115
104
 
116
105
class Option(object):
117
 
    """Description of a command line option
118
 
    
119
 
    :ivar _short_name: If this option has a single-letter name, this is it.
120
 
    Otherwise None.
121
 
    """
122
 
 
 
106
    """Description of a command line option"""
123
107
    # TODO: Some way to show in help a description of the option argument
124
108
 
125
109
    OPTIONS = {}
 
110
    SHORT_OPTIONS = {}
126
111
 
127
 
    def __init__(self, name, help='', type=None, argname=None,
128
 
                 short_name=None):
 
112
    def __init__(self, name, help='', type=None, argname=None):
129
113
        """Make a new command option.
130
114
 
131
115
        name -- regular name of the command, used in the double-dash
139
123
 
140
124
        argname -- name of option argument, if any
141
125
        """
 
126
        # TODO: perhaps a subclass that automatically does 
 
127
        # --option, --no-option for reversible booleans
142
128
        self.name = name
143
129
        self.help = help
144
130
        self.type = type
145
 
        self._short_name = short_name
146
131
        if type is None:
147
132
            assert argname is None
148
133
        elif argname is None:
150
135
        self.argname = argname
151
136
 
152
137
    def short_name(self):
153
 
        if self._short_name:
154
 
            return self._short_name
155
 
        else:
156
 
            # remove this when SHORT_OPTIONS is removed
157
 
            # XXX: This is accessing a DeprecatedDict, so we call the super 
158
 
            # method to avoid warnings
159
 
            for (k, v) in dict.iteritems(Option.SHORT_OPTIONS):
160
 
                if v == self:
161
 
                    return k
 
138
        """Return the single character option for this command, if any.
162
139
 
163
 
    def set_short_name(self, short_name):
164
 
        self._short_name = short_name
 
140
        Short options are globally registered.
 
141
        """
 
142
        for short, option in Option.SHORT_OPTIONS.iteritems():
 
143
            if option is self:
 
144
                return short
165
145
 
166
146
    def get_negation_name(self):
167
147
        if self.name.startswith('no-'):
205
185
        yield self.name, self.short_name(), argname, self.help
206
186
 
207
187
 
208
 
class ListOption(Option):
209
 
    """Option used to provide a list of values.
210
 
 
211
 
    On the command line, arguments are specified by a repeated use of the
212
 
    option. '-' is a special argument that resets the list. For example,
213
 
      --foo=a --foo=b
214
 
    sets the value of the 'foo' option to ['a', 'b'], and
215
 
      --foo=a --foo=b --foo=- --foo=c
216
 
    sets the value of the 'foo' option to ['c'].
217
 
    """
218
 
 
219
 
    def add_option(self, parser, short_name):
220
 
        """Add this option to an Optparse parser."""
221
 
        option_strings = ['--%s' % self.name]
222
 
        if short_name is not None:
223
 
            option_strings.append('-%s' % short_name)
224
 
        parser.add_option(action='callback',
225
 
                          callback=self._optparse_callback,
226
 
                          type='string', metavar=self.argname.upper(),
227
 
                          help=self.help, default=[],
228
 
                          *option_strings)
229
 
 
230
 
    def _optparse_callback(self, option, opt, value, parser):
231
 
        values = getattr(parser.values, self.name)
232
 
        if value == '-':
233
 
            del values[:]
234
 
        else:
235
 
            values.append(self.type(value))
236
 
 
237
 
 
238
 
class RegistryOption(Option):
239
 
    """Option based on a registry
240
 
 
241
 
    The values for the options correspond to entries in the registry.  Input
242
 
    must be a registry key.  After validation, it is converted into an object
243
 
    using Registry.get or a caller-provided converter.
244
 
    """
245
 
 
246
 
    def validate_value(self, value):
247
 
        """Validate a value name"""
248
 
        if value not in self.registry:
249
 
            raise errors.BadOptionValue(self.name, value)
250
 
 
251
 
    def convert(self, value):
252
 
        """Convert a value name into an output type"""
253
 
        self.validate_value(value)
254
 
        if self.converter is None:
255
 
            return self.registry.get(value)
256
 
        else:
257
 
            return self.converter(value)
258
 
 
259
 
    def __init__(self, name, help, registry, converter=None,
260
 
        value_switches=False, title=None, enum_switch=True):
261
 
        """
262
 
        Constructor.
263
 
 
264
 
        :param name: The option name.
265
 
        :param help: Help for the option.
266
 
        :param registry: A Registry containing the values
267
 
        :param converter: Callable to invoke with the value name to produce
268
 
            the value.  If not supplied, self.registry.get is used.
269
 
        :param value_switches: If true, each possible value is assigned its
270
 
            own switch.  For example, instead of '--format knit',
271
 
            '--knit' can be used interchangeably.
272
 
        :param enum_switch: If true, a switch is provided with the option name,
273
 
            which takes a value.
274
 
        """
275
 
        Option.__init__(self, name, help, type=self.convert)
276
 
        self.registry = registry
277
 
        self.name = name
278
 
        self.converter = converter
279
 
        self.value_switches = value_switches
280
 
        self.enum_switch = enum_switch
281
 
        self.title = title
282
 
        if self.title is None:
283
 
            self.title = name
284
 
 
285
 
    @staticmethod
286
 
    def from_kwargs(name_, help=None, title=None, value_switches=False,
287
 
                    enum_switch=True, **kwargs):
288
 
        """Convenience method to generate string-map registry options
289
 
 
290
 
        name, help, value_switches and enum_switch are passed to the
291
 
        RegistryOption constructor.  Any other keyword arguments are treated
292
 
        as values for the option, and they value is treated as the help.
293
 
        """
294
 
        reg = registry.Registry()
295
 
        for name, help in kwargs.iteritems():
296
 
            name = name.replace('_', '-')
297
 
            reg.register(name, name, help=help)
298
 
        return RegistryOption(name_, help, reg, title=title,
299
 
            value_switches=value_switches, enum_switch=enum_switch)
300
 
 
301
 
    def add_option(self, parser, short_name):
302
 
        """Add this option to an Optparse parser"""
303
 
        if self.value_switches:
304
 
            parser = parser.add_option_group(self.title)
305
 
        if self.enum_switch:
306
 
            Option.add_option(self, parser, short_name)
307
 
        if self.value_switches:
308
 
            for key in self.registry.keys():
309
 
                option_strings = ['--%s' % key]
310
 
                if getattr(self.registry.get_info(key), 'hidden', False):
311
 
                    help = optparse.SUPPRESS_HELP
312
 
                else:
313
 
                    help = self.registry.get_help(key)
314
 
                parser.add_option(action='callback',
315
 
                              callback=self._optparse_value_callback(key),
316
 
                                  help=help,
317
 
                                  *option_strings)
318
 
 
319
 
    def _optparse_value_callback(self, cb_value):
320
 
        def cb(option, opt, value, parser):
321
 
            setattr(parser.values, self.name, self.type(cb_value))
322
 
        return cb
323
 
 
324
 
    def iter_switches(self):
325
 
        """Iterate through the list of switches provided by the option
326
 
 
327
 
        :return: an iterator of (name, short_name, argname, help)
328
 
        """
329
 
        for value in Option.iter_switches(self):
330
 
            yield value
331
 
        if self.value_switches:
332
 
            for key in sorted(self.registry.keys()):
333
 
                yield key, None, None, self.registry.get_help(key)
334
 
 
335
 
 
336
188
class OptionParser(optparse.OptionParser):
337
189
    """OptionParser that raises exceptions instead of exiting"""
338
190
 
339
191
    DEFAULT_VALUE = object()
340
192
 
341
193
    def error(self, message):
342
 
        raise errors.BzrCommandError(message)
 
194
        raise BzrCommandError(message)
343
195
 
344
196
 
345
197
def get_optparser(options):
347
199
 
348
200
    parser = OptionParser()
349
201
    parser.remove_option('--help')
 
202
    short_options = dict((k.name, v) for v, k in 
 
203
                         Option.SHORT_OPTIONS.iteritems())
350
204
    for option in options.itervalues():
351
 
        option.add_option(parser, option.short_name())
 
205
        option.add_option(parser, short_options.get(option.name))
352
206
    return parser
353
207
 
354
208
 
356
210
    """Register o as a global option."""
357
211
    Option.OPTIONS[name] = Option(name, **kwargs)
358
212
 
359
 
 
360
 
def _global_registry_option(name, help, registry, **kwargs):
361
 
    Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
362
 
 
363
 
 
364
 
class MergeTypeRegistry(registry.Registry):
365
 
 
366
 
    pass
367
 
 
368
 
 
369
 
_merge_type_registry = MergeTypeRegistry()
370
 
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
371
 
                                   "Native diff3-style merge")
372
 
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
373
 
                                   "Merge using external diff3")
374
 
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
375
 
                                   "Weave-based merge")
376
 
 
377
213
_global_option('all')
378
214
_global_option('overwrite', help='Ignore differences between branches and '
379
215
               'overwrite unconditionally')
381
217
_global_option('bound')
382
218
_global_option('diff-options', type=str)
383
219
_global_option('help',
384
 
               help='show help message',
385
 
               short_name='h')
386
 
_global_option('file', type=unicode, short_name='F')
 
220
               help='show help message')
 
221
_global_option('file', type=unicode)
387
222
_global_option('force')
388
223
_global_option('format', type=unicode)
389
224
_global_option('forward')
390
 
_global_option('message', type=unicode,
391
 
               short_name='m')
 
225
_global_option('message', type=unicode)
392
226
_global_option('no-recurse')
 
227
_global_option('prefix', type=str, 
 
228
               help='Set prefixes to added to old and new filenames, as '
 
229
                    'two values separated by a colon.')
393
230
_global_option('profile',
394
231
               help='show performance profiling information')
395
 
_global_option('revision',
396
 
               type=_parse_revision_str,
397
 
               short_name='r',
398
 
               help='See \'help revisionspec\' for details')
 
232
_global_option('revision', type=_parse_revision_str)
399
233
_global_option('show-ids', 
400
234
               help='show internal object ids')
401
235
_global_option('timezone', 
403
237
               help='display timezone as local, original, or utc')
404
238
_global_option('unbound')
405
239
_global_option('verbose',
406
 
               help='display more information',
407
 
               short_name='v')
 
240
               help='display more information')
408
241
_global_option('version')
409
242
_global_option('email')
410
243
_global_option('update')
411
 
_global_registry_option('log-format', "Use this log format",
412
 
                        log.log_formatter_registry, value_switches=True,
413
 
                        title='Log format')
414
 
_global_option('long', help='Use detailed log format. Same as --log-format long',
415
 
               short_name='l')
 
244
_global_option('log-format', type=str, help="Use this log format")
 
245
_global_option('long', help='Use detailed log format. Same as --log-format long')
416
246
_global_option('short', help='Use moderately short log format. Same as --log-format short')
417
247
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
418
248
_global_option('root', type=str)
419
249
_global_option('no-backup')
420
 
_global_registry_option('merge-type', 'Select a particular merge algorithm',
421
 
                        _merge_type_registry, value_switches=True,
422
 
                        title='Merge algorithm')
 
250
_global_option('merge-type', type=_parse_merge_type, 
 
251
               help='Select a particular merge algorithm')
423
252
_global_option('pattern', type=str)
424
 
_global_option('quiet', short_name='q')
 
253
_global_option('quiet')
425
254
_global_option('remember', help='Remember the specified location as a'
426
255
               ' default.')
427
256
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
428
257
_global_option('kind', type=str)
429
258
_global_option('dry-run',
430
259
               help="show what would be done, but don't actually do anything")
431
 
_global_option('name-from-revision', help='The path name in the old tree.')
432
 
 
433
 
 
434
 
# prior to 0.14 these were always globally registered; the old dict is
435
 
# available for plugins that use it but it should not be used.
436
 
Option.SHORT_OPTIONS = symbol_versioning.DeprecatedDict(
437
 
    symbol_versioning.zero_fourteen,
438
 
    'SHORT_OPTIONS',
439
 
    {
440
 
        'F': Option.OPTIONS['file'],
441
 
        'h': Option.OPTIONS['help'],
442
 
        'm': Option.OPTIONS['message'],
443
 
        'r': Option.OPTIONS['revision'],
444
 
        'v': Option.OPTIONS['verbose'],
445
 
        'l': Option.OPTIONS['long'],
446
 
        'q': Option.OPTIONS['quiet'],
447
 
    },
448
 
    'Set the short option name when constructing the Option.',
449
 
    )
 
260
 
 
261
 
 
262
def _global_short(short_name, long_name):
 
263
    assert short_name not in Option.SHORT_OPTIONS
 
264
    Option.SHORT_OPTIONS[short_name] = Option.OPTIONS[long_name]
 
265
    
 
266
 
 
267
Option.SHORT_OPTIONS['F'] = Option.OPTIONS['file']
 
268
Option.SHORT_OPTIONS['h'] = Option.OPTIONS['help']
 
269
Option.SHORT_OPTIONS['m'] = Option.OPTIONS['message']
 
270
Option.SHORT_OPTIONS['r'] = Option.OPTIONS['revision']
 
271
Option.SHORT_OPTIONS['v'] = Option.OPTIONS['verbose']
 
272
Option.SHORT_OPTIONS['l'] = Option.OPTIONS['long']
 
273
Option.SHORT_OPTIONS['q'] = Option.OPTIONS['quiet']
 
274
Option.SHORT_OPTIONS['p'] = Option.OPTIONS['prefix']