← 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-06-18 05:22:35 UTC
  • mfrom: (1551.15.27 Aaron's mergeable stuff)
  • Revision ID: pqm@pqm.ubuntu.com-20070618052235-mvns8j28szyzscy0
Turn list-weave into list-versionedfile

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/option.py
1
 
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006 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
86
86
    [<RevisionSpec_branch branch:../../branch2>]
87
87
    >>> _parse_revision_str('branch:../../branch2..23')
88
88
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
89
 
    >>> _parse_revision_str('branch:..\\\\branch2')
90
 
    [<RevisionSpec_branch branch:..\\branch2>]
91
 
    >>> _parse_revision_str('branch:..\\\\..\\\\branch2..23')
92
 
    [<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_revno 23>]
93
89
    """
94
90
    # TODO: Maybe move this into revisionspec.py
95
91
    revs = []
96
 
    # split on .. that is not followed by a / or \
97
 
    sep = re.compile(r'\.\.(?![\\/])')
 
92
    # split on the first .. that is not followed by a / ?
 
93
    sep = re.compile("\\.\\.(?!/)")
98
94
    for x in sep.split(revstr):
99
95
        revs.append(revisionspec.RevisionSpec.from_string(x or None))
100
96
    return revs
101
97
 
102
98
 
103
 
def _parse_change_str(revstr):
104
 
    """Parse the revision string and return a tuple with left-most
105
 
    parent of the revision.
106
 
 
107
 
    >>> _parse_change_str('123')
108
 
    (<RevisionSpec_before before:123>, <RevisionSpec_revno 123>)
109
 
    >>> _parse_change_str('123..124')
110
 
    Traceback (most recent call last):
111
 
      ...
112
 
    RangeInChangeOption: Option --change does not accept revision ranges
113
 
    """
114
 
    revs = _parse_revision_str(revstr)
115
 
    if len(revs) > 1:
116
 
        raise errors.RangeInChangeOption()
117
 
    return (revisionspec.RevisionSpec.from_string('before:' + revstr),
118
 
            revs[0])
119
 
 
120
 
 
121
99
def _parse_merge_type(typestring):
122
100
    return get_merge_type(typestring)
123
101
 
142
120
    Otherwise None.
143
121
    """
144
122
 
145
 
    # The dictionary of standard options. These are always legal.
146
 
    STD_OPTIONS = {}
 
123
    # TODO: Some way to show in help a description of the option argument
147
124
 
148
 
    # The dictionary of commonly used options. these are only legal
149
 
    # if a command explicitly references them by name in the list
150
 
    # of supported options.
151
125
    OPTIONS = {}
152
126
 
153
127
    def __init__(self, name, help='', type=None, argname=None,
154
 
                 short_name=None, param_name=None, custom_callback=None):
 
128
                 short_name=None):
155
129
        """Make a new command option.
156
130
 
157
 
        :param name: regular name of the command, used in the double-dash
 
131
        name -- regular name of the command, used in the double-dash
158
132
            form and also as the parameter to the command's run() 
159
 
            method (unless param_name is specified).
160
 
 
161
 
        :param help: help message displayed in command help
162
 
 
163
 
        :param type: function called to parse the option argument, or 
 
133
            method.
 
134
 
 
135
        help -- help message displayed in command help
 
136
 
 
137
        type -- function called to parse the option argument, or 
164
138
            None (default) if this option doesn't take an argument.
165
139
 
166
 
        :param argname: name of option argument, if any
167
 
 
168
 
        :param short_name: short option code for use with a single -, e.g.
169
 
            short_name="v" to enable parsing of -v.
170
 
 
171
 
        :param param_name: name of the parameter which will be passed to
172
 
            the command's run() method.
173
 
 
174
 
        :param custom_callback: a callback routine to be called after normal
175
 
            processing. The signature of the callback routine is
176
 
            (option, name, new_value, parser).
 
140
        argname -- name of option argument, if any
177
141
        """
178
142
        self.name = name
179
143
        self.help = help
184
148
        elif argname is None:
185
149
            argname = 'ARG'
186
150
        self.argname = argname
187
 
        if param_name is None:
188
 
            self._param_name = self.name
189
 
        else:
190
 
            self._param_name = param_name
191
 
        self.custom_callback = custom_callback
192
151
 
193
152
    def short_name(self):
194
153
        if self._short_name:
195
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
196
162
 
197
163
    def set_short_name(self, short_name):
198
164
        self._short_name = short_name
210
176
            option_strings.append('-%s' % short_name)
211
177
        optargfn = self.type
212
178
        if optargfn is None:
213
 
            parser.add_option(action='callback', 
214
 
                              callback=self._optparse_bool_callback, 
215
 
                              callback_args=(True,),
 
179
            parser.add_option(action='store_true', dest=self.name, 
216
180
                              help=self.help,
 
181
                              default=OptionParser.DEFAULT_VALUE,
217
182
                              *option_strings)
218
183
            negation_strings = ['--%s' % self.get_negation_name()]
219
 
            parser.add_option(action='callback', 
220
 
                              callback=self._optparse_bool_callback, 
221
 
                              callback_args=(False,),
 
184
            parser.add_option(action='store_false', dest=self.name, 
222
185
                              help=optparse.SUPPRESS_HELP, *negation_strings)
223
186
        else:
224
187
            parser.add_option(action='callback', 
228
191
                              default=OptionParser.DEFAULT_VALUE, 
229
192
                              *option_strings)
230
193
 
231
 
    def _optparse_bool_callback(self, option, opt_str, value, parser, bool_v):
232
 
        setattr(parser.values, self._param_name, bool_v)
233
 
        if self.custom_callback is not None:
234
 
            self.custom_callback(option, self._param_name, bool_v, parser)
235
 
 
236
194
    def _optparse_callback(self, option, opt, value, parser):
237
 
        v = self.type(value)
238
 
        setattr(parser.values, self._param_name, v)
239
 
        if self.custom_callback is not None:
240
 
            self.custom_callback(option, self.name, v, parser)
 
195
        setattr(parser.values, self.name, self.type(value))
241
196
 
242
197
    def iter_switches(self):
243
198
        """Iterate through the list of switches provided by the option
249
204
            argname = argname.upper()
250
205
        yield self.name, self.short_name(), argname, self.help
251
206
 
252
 
    def is_hidden(self, name):
253
 
        return False
254
 
 
255
207
 
256
208
class ListOption(Option):
257
209
    """Option used to provide a list of values.
276
228
                          *option_strings)
277
229
 
278
230
    def _optparse_callback(self, option, opt, value, parser):
279
 
        values = getattr(parser.values, self._param_name)
 
231
        values = getattr(parser.values, self.name)
280
232
        if value == '-':
281
233
            del values[:]
282
234
        else:
283
235
            values.append(self.type(value))
284
 
        if self.custom_callback is not None:
285
 
            self.custom_callback(option, self._param_name, values, parser)
286
236
 
287
237
 
288
238
class RegistryOption(Option):
342
292
        as values for the option, and they value is treated as the help.
343
293
        """
344
294
        reg = registry.Registry()
345
 
        for name, switch_help in kwargs.iteritems():
 
295
        for name, help in kwargs.iteritems():
346
296
            name = name.replace('_', '-')
347
 
            reg.register(name, name, help=switch_help)
 
297
            reg.register(name, name, help=help)
348
298
        return RegistryOption(name_, help, reg, title=title,
349
299
            value_switches=value_switches, enum_switch=enum_switch)
350
300
 
357
307
        if self.value_switches:
358
308
            for key in self.registry.keys():
359
309
                option_strings = ['--%s' % key]
360
 
                if self.is_hidden(key):
 
310
                if getattr(self.registry.get_info(key), 'hidden', False):
361
311
                    help = optparse.SUPPRESS_HELP
362
312
                else:
363
313
                    help = self.registry.get_help(key)
368
318
 
369
319
    def _optparse_value_callback(self, cb_value):
370
320
        def cb(option, opt, value, parser):
371
 
            v = self.type(cb_value)
372
 
            setattr(parser.values, self._param_name, v)
373
 
            if self.custom_callback is not None:
374
 
                self.custom_callback(option, self._param_name, v, parser)
 
321
            setattr(parser.values, self.name, self.type(cb_value))
375
322
        return cb
376
323
 
377
324
    def iter_switches(self):
385
332
            for key in sorted(self.registry.keys()):
386
333
                yield key, None, None, self.registry.get_help(key)
387
334
 
388
 
    def is_hidden(self, name):
389
 
        if name == self.name:
390
 
            return Option.is_hidden(self, name)
391
 
        return getattr(self.registry.get_info(name), 'hidden', False)
392
 
 
393
335
 
394
336
class OptionParser(optparse.OptionParser):
395
337
    """OptionParser that raises exceptions instead of exiting"""
410
352
    return parser
411
353
 
412
354
 
413
 
def custom_help(name, help):
414
 
    """Clone a common option overriding the help."""
415
 
    import copy
416
 
    o = copy.copy(Option.OPTIONS[name])
417
 
    o.help = help
418
 
    return o
419
 
 
420
 
 
421
 
def _standard_option(name, **kwargs):
422
 
    """Register a standard option."""
423
 
    # All standard options are implicitly 'global' ones
424
 
    Option.STD_OPTIONS[name] = Option(name, **kwargs)
425
 
    Option.OPTIONS[name] = Option.STD_OPTIONS[name]
426
 
 
427
 
 
428
355
def _global_option(name, **kwargs):
429
 
    """Register a global option."""
 
356
    """Register o as a global option."""
430
357
    Option.OPTIONS[name] = Option(name, **kwargs)
431
358
 
432
359
 
439
366
    pass
440
367
 
441
368
 
442
 
# This is the verbosity level detected during command line parsing.
443
 
# Note that the final value is dependent on the order in which the
444
 
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
445
 
# The final value will be one of the following:
446
 
#
447
 
# * -ve for quiet
448
 
# * 0 for normal
449
 
# * +ve for verbose
450
 
_verbosity_level = 0
451
 
 
452
 
 
453
 
def _verbosity_level_callback(option, opt_str, value, parser):
454
 
    global _verbosity_level
455
 
    if not value:
456
 
        # Either --no-verbose or --no-quiet was specified
457
 
        _verbosity_level = 0
458
 
    elif opt_str == "verbose":
459
 
        if _verbosity_level > 0:
460
 
            _verbosity_level += 1
461
 
        else:
462
 
            _verbosity_level = 1
463
 
    else:
464
 
        if _verbosity_level < 0:
465
 
            _verbosity_level -= 1
466
 
        else:
467
 
            _verbosity_level = -1
468
 
 
469
 
 
470
369
_merge_type_registry = MergeTypeRegistry()
471
370
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
472
371
                                   "Native diff3-style merge")
475
374
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
476
375
                                   "Weave-based merge")
477
376
 
478
 
# Declare the standard options
479
 
_standard_option('help', short_name='h',
480
 
                 help='Show help message.')
481
 
_standard_option('verbose', short_name='v',
482
 
                 help='Display more information.',
483
 
                 custom_callback=_verbosity_level_callback)
484
 
_standard_option('quiet', short_name='q',
485
 
                 help="Only display errors and warnings.",
486
 
                 custom_callback=_verbosity_level_callback)
487
 
 
488
 
# Declare commonly used options
489
377
_global_option('all')
490
378
_global_option('overwrite', help='Ignore differences between branches and '
491
 
               'overwrite unconditionally.')
 
379
               'overwrite unconditionally')
492
380
_global_option('basis', type=str)
493
381
_global_option('bound')
494
382
_global_option('diff-options', type=str)
 
383
_global_option('help',
 
384
               help='show help message',
 
385
               short_name='h')
495
386
_global_option('file', type=unicode, short_name='F')
496
387
_global_option('force')
497
388
_global_option('format', type=unicode)
498
389
_global_option('forward')
499
390
_global_option('message', type=unicode,
500
 
               short_name='m',
501
 
               help='Message string.')
 
391
               short_name='m')
502
392
_global_option('no-recurse')
503
393
_global_option('profile',
504
 
               help='Show performance profiling information.')
 
394
               help='show performance profiling information')
505
395
_global_option('revision',
506
396
               type=_parse_revision_str,
507
397
               short_name='r',
508
 
               help='See "help revisionspec" for details.')
509
 
_global_option('change',
510
 
               type=_parse_change_str,
511
 
               short_name='c',
512
 
               param_name='revision',
513
 
               help='Select changes introduced by the specified revision. See also "help revisionspec".')
514
 
_global_option('show-ids',
515
 
               help='Show internal object ids.')
 
398
               help='See \'help revisionspec\' for details')
 
399
_global_option('show-ids', 
 
400
               help='show internal object ids')
516
401
_global_option('timezone', 
517
402
               type=str,
518
403
               help='display timezone as local, original, or utc')
519
404
_global_option('unbound')
 
405
_global_option('verbose',
 
406
               help='display more information',
 
407
               short_name='v')
520
408
_global_option('version')
521
409
_global_option('email')
522
410
_global_option('update')
523
 
_global_registry_option('log-format', "Use specified log format.",
 
411
_global_registry_option('log-format', "Use this log format",
524
412
                        log.log_formatter_registry, value_switches=True,
525
413
                        title='Log format')
526
414
_global_option('long', help='Use detailed log format. Same as --log-format long',
529
417
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
530
418
_global_option('root', type=str)
531
419
_global_option('no-backup')
532
 
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
 
420
_global_registry_option('merge-type', 'Select a particular merge algorithm',
533
421
                        _merge_type_registry, value_switches=True,
534
422
                        title='Merge algorithm')
535
423
_global_option('pattern', type=str)
 
424
_global_option('quiet', short_name='q')
536
425
_global_option('remember', help='Remember the specified location as a'
537
426
               ' default.')
538
 
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
 
427
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
539
428
_global_option('kind', type=str)
540
429
_global_option('dry-run',
541
 
               help="Show what would be done, but don't actually do anything.")
 
430
               help="show what would be done, but don't actually do anything")
542
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
    )