← 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: 2008-05-01 11:25:12 UTC
  • mfrom: (3211.7.10 protocol-v3-doc)
  • Revision ID: pqm@pqm.ubuntu.com-20080501112512-b9lgs4w8r43evtn1
Add the smart protocol v3 specification to network-protocol.txt

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/option.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
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
 
from __future__ import absolute_import
21
 
 
22
20
import optparse
23
21
import re
24
22
 
27
25
from bzrlib import (
28
26
    errors,
29
27
    revisionspec,
30
 
    i18n,
31
28
    )
32
29
""")
33
30
 
34
31
from bzrlib import (
35
 
    registry as _mod_registry,
 
32
    log,
 
33
    registry,
36
34
    )
37
35
 
38
 
 
39
36
def _parse_revision_str(revstr):
40
37
    """This handles a revision string -> revno.
41
38
 
43
40
    each revision specifier supplied.
44
41
 
45
42
    >>> _parse_revision_str('234')
46
 
    [<RevisionSpec_dwim 234>]
 
43
    [<RevisionSpec_revno 234>]
47
44
    >>> _parse_revision_str('234..567')
48
 
    [<RevisionSpec_dwim 234>, <RevisionSpec_dwim 567>]
 
45
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
49
46
    >>> _parse_revision_str('..')
50
47
    [<RevisionSpec None>, <RevisionSpec None>]
51
48
    >>> _parse_revision_str('..234')
52
 
    [<RevisionSpec None>, <RevisionSpec_dwim 234>]
 
49
    [<RevisionSpec None>, <RevisionSpec_revno 234>]
53
50
    >>> _parse_revision_str('234..')
54
 
    [<RevisionSpec_dwim 234>, <RevisionSpec None>]
 
51
    [<RevisionSpec_revno 234>, <RevisionSpec None>]
55
52
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
56
 
    [<RevisionSpec_dwim 234>, <RevisionSpec_dwim 456>, <RevisionSpec_dwim 789>]
 
53
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
57
54
    >>> _parse_revision_str('234....789') #Error ?
58
 
    [<RevisionSpec_dwim 234>, <RevisionSpec None>, <RevisionSpec_dwim 789>]
 
55
    [<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
59
56
    >>> _parse_revision_str('revid:test@other.com-234234')
60
57
    [<RevisionSpec_revid revid:test@other.com-234234>]
61
58
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
62
59
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
63
60
    >>> _parse_revision_str('revid:test@other.com-234234..23')
64
 
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_dwim 23>]
 
61
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
65
62
    >>> _parse_revision_str('date:2005-04-12')
66
63
    [<RevisionSpec_date date:2005-04-12>]
67
64
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
71
68
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
72
69
    [<RevisionSpec_date date:2005-04-12,12:24:33>]
73
70
    >>> _parse_revision_str('-5..23')
74
 
    [<RevisionSpec_dwim -5>, <RevisionSpec_dwim 23>]
 
71
    [<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
75
72
    >>> _parse_revision_str('-5')
76
 
    [<RevisionSpec_dwim -5>]
 
73
    [<RevisionSpec_revno -5>]
77
74
    >>> _parse_revision_str('123a')
78
 
    [<RevisionSpec_dwim 123a>]
 
75
    Traceback (most recent call last):
 
76
      ...
 
77
    NoSuchRevisionSpec: No namespace registered for string: '123a'
79
78
    >>> _parse_revision_str('abc')
80
 
    [<RevisionSpec_dwim abc>]
 
79
    Traceback (most recent call last):
 
80
      ...
 
81
    NoSuchRevisionSpec: No namespace registered for string: 'abc'
81
82
    >>> _parse_revision_str('branch:../branch2')
82
83
    [<RevisionSpec_branch branch:../branch2>]
83
84
    >>> _parse_revision_str('branch:../../branch2')
84
85
    [<RevisionSpec_branch branch:../../branch2>]
85
86
    >>> _parse_revision_str('branch:../../branch2..23')
86
 
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_dwim 23>]
 
87
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
87
88
    >>> _parse_revision_str('branch:..\\\\branch2')
88
89
    [<RevisionSpec_branch branch:..\\branch2>]
89
90
    >>> _parse_revision_str('branch:..\\\\..\\\\branch2..23')
90
 
    [<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_dwim 23>]
 
91
    [<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_revno 23>]
91
92
    """
92
93
    # TODO: Maybe move this into revisionspec.py
93
94
    revs = []
103
104
    parent of the revision.
104
105
 
105
106
    >>> _parse_change_str('123')
106
 
    (<RevisionSpec_before before:123>, <RevisionSpec_dwim 123>)
 
107
    (<RevisionSpec_before before:123>, <RevisionSpec_revno 123>)
107
108
    >>> _parse_change_str('123..124')
108
109
    Traceback (most recent call last):
109
110
      ...
135
136
 
136
137
class Option(object):
137
138
    """Description of a command line option
138
 
 
 
139
    
139
140
    :ivar _short_name: If this option has a single-letter name, this is it.
140
141
    Otherwise None.
141
142
    """
149
150
    OPTIONS = {}
150
151
 
151
152
    def __init__(self, name, help='', type=None, argname=None,
152
 
                 short_name=None, param_name=None, custom_callback=None,
153
 
                 hidden=False):
 
153
                 short_name=None, param_name=None, custom_callback=None):
154
154
        """Make a new command option.
155
155
 
156
156
        :param name: regular name of the command, used in the double-dash
157
 
            form and also as the parameter to the command's run()
 
157
            form and also as the parameter to the command's run() 
158
158
            method (unless param_name is specified).
159
159
 
160
160
        :param help: help message displayed in command help
161
161
 
162
 
        :param type: function called to parse the option argument, or
 
162
        :param type: function called to parse the option argument, or 
163
163
            None (default) if this option doesn't take an argument.
164
164
 
165
165
        :param argname: name of option argument, if any
173
173
        :param custom_callback: a callback routine to be called after normal
174
174
            processing. The signature of the callback routine is
175
175
            (option, name, new_value, parser).
176
 
        :param hidden: If True, the option should be hidden in help and
177
 
            documentation.
178
176
        """
179
177
        self.name = name
180
178
        self.help = help
181
179
        self.type = type
182
180
        self._short_name = short_name
183
181
        if type is None:
184
 
            if argname:
185
 
                raise ValueError('argname not valid for booleans')
 
182
            assert argname is None
186
183
        elif argname is None:
187
184
            argname = 'ARG'
188
185
        self.argname = argname
189
186
        if param_name is None:
190
 
            self._param_name = self.name.replace('-', '_')
 
187
            self._param_name = self.name
191
188
        else:
192
189
            self._param_name = param_name
193
190
        self.custom_callback = custom_callback
194
 
        self.hidden = hidden
195
191
 
196
192
    def short_name(self):
197
193
        if self._short_name:
211
207
        option_strings = ['--%s' % self.name]
212
208
        if short_name is not None:
213
209
            option_strings.append('-%s' % short_name)
214
 
        if self.hidden:
215
 
            help = optparse.SUPPRESS_HELP
216
 
        else:
217
 
            help = self.help
218
210
        optargfn = self.type
219
211
        if optargfn is None:
220
 
            parser.add_option(action='callback',
221
 
                              callback=self._optparse_bool_callback,
 
212
            parser.add_option(action='callback', 
 
213
                              callback=self._optparse_bool_callback, 
222
214
                              callback_args=(True,),
223
 
                              help=help,
 
215
                              help=self.help,
224
216
                              *option_strings)
225
217
            negation_strings = ['--%s' % self.get_negation_name()]
226
 
            parser.add_option(action='callback',
227
 
                              callback=self._optparse_bool_callback,
 
218
            parser.add_option(action='callback', 
 
219
                              callback=self._optparse_bool_callback, 
228
220
                              callback_args=(False,),
229
221
                              help=optparse.SUPPRESS_HELP, *negation_strings)
230
222
        else:
231
 
            parser.add_option(action='callback',
232
 
                              callback=self._optparse_callback,
 
223
            parser.add_option(action='callback', 
 
224
                              callback=self._optparse_callback, 
233
225
                              type='string', metavar=self.argname.upper(),
234
 
                              help=help,
235
 
                              default=OptionParser.DEFAULT_VALUE,
 
226
                              help=self.help,
 
227
                              default=OptionParser.DEFAULT_VALUE, 
236
228
                              *option_strings)
237
229
 
238
230
    def _optparse_bool_callback(self, option, opt_str, value, parser, bool_v):
248
240
 
249
241
    def iter_switches(self):
250
242
        """Iterate through the list of switches provided by the option
251
 
 
 
243
        
252
244
        :return: an iterator of (name, short_name, argname, help)
253
245
        """
254
246
        argname =  self.argname
257
249
        yield self.name, self.short_name(), argname, self.help
258
250
 
259
251
    def is_hidden(self, name):
260
 
        return self.hidden
 
252
        return False
261
253
 
262
254
 
263
255
class ListOption(Option):
279
271
        parser.add_option(action='callback',
280
272
                          callback=self._optparse_callback,
281
273
                          type='string', metavar=self.argname.upper(),
282
 
                          help=self.help, dest=self._param_name, default=[],
 
274
                          help=self.help, default=[],
283
275
                          *option_strings)
284
276
 
285
277
    def _optparse_callback(self, option, opt, value, parser):
313
305
        else:
314
306
            return self.converter(value)
315
307
 
316
 
    def __init__(self, name, help, registry=None, converter=None,
317
 
        value_switches=False, title=None, enum_switch=True,
318
 
        lazy_registry=None, short_name=None, short_value_switches=None):
 
308
    def __init__(self, name, help, registry, converter=None,
 
309
        value_switches=False, title=None, enum_switch=True):
319
310
        """
320
311
        Constructor.
321
312
 
329
320
            '--knit' can be used interchangeably.
330
321
        :param enum_switch: If true, a switch is provided with the option name,
331
322
            which takes a value.
332
 
        :param lazy_registry: A tuple of (module name, attribute name) for a
333
 
            registry to be lazily loaded.
334
 
        :param short_name: The short name for the enum switch, if any
335
 
        :param short_value_switches: A dict mapping values to short names
336
323
        """
337
 
        Option.__init__(self, name, help, type=self.convert,
338
 
                        short_name=short_name)
339
 
        self._registry = registry
340
 
        if registry is None:
341
 
            if lazy_registry is None:
342
 
                raise AssertionError(
343
 
                    'One of registry or lazy_registry must be given.')
344
 
            self._lazy_registry = _mod_registry._LazyObjectGetter(
345
 
                *lazy_registry)
346
 
        if registry is not None and lazy_registry is not None:
347
 
            raise AssertionError(
348
 
                'registry and lazy_registry are mutually exclusive')
 
324
        Option.__init__(self, name, help, type=self.convert)
 
325
        self.registry = registry
349
326
        self.name = name
350
327
        self.converter = converter
351
328
        self.value_switches = value_switches
352
329
        self.enum_switch = enum_switch
353
 
        self.short_value_switches = short_value_switches
354
330
        self.title = title
355
331
        if self.title is None:
356
332
            self.title = name
357
333
 
358
 
    @property
359
 
    def registry(self):
360
 
        if self._registry is None:
361
 
            self._registry = self._lazy_registry.get_obj()
362
 
        return self._registry
363
 
 
364
334
    @staticmethod
365
335
    def from_kwargs(name_, help=None, title=None, value_switches=False,
366
336
                    enum_switch=True, **kwargs):
368
338
 
369
339
        name, help, value_switches and enum_switch are passed to the
370
340
        RegistryOption constructor.  Any other keyword arguments are treated
371
 
        as values for the option, and their value is treated as the help.
 
341
        as values for the option, and they value is treated as the help.
372
342
        """
373
 
        reg = _mod_registry.Registry()
374
 
        for name, switch_help in sorted(kwargs.items()):
 
343
        reg = registry.Registry()
 
344
        for name, switch_help in kwargs.iteritems():
375
345
            name = name.replace('_', '-')
376
346
            reg.register(name, name, help=switch_help)
377
 
            if not value_switches:
378
 
                help = help + '  "' + name + '": ' + switch_help
379
 
                if not help.endswith("."):
380
 
                    help = help + "."
381
347
        return RegistryOption(name_, help, reg, title=title,
382
348
            value_switches=value_switches, enum_switch=enum_switch)
383
349
 
394
360
                    help = optparse.SUPPRESS_HELP
395
361
                else:
396
362
                    help = self.registry.get_help(key)
397
 
                if (self.short_value_switches and
398
 
                    key in self.short_value_switches):
399
 
                    option_strings.append('-%s' %
400
 
                                          self.short_value_switches[key])
401
363
                parser.add_option(action='callback',
402
364
                              callback=self._optparse_value_callback(key),
403
365
                                  help=help,
433
395
 
434
396
    DEFAULT_VALUE = object()
435
397
 
436
 
    def __init__(self):
437
 
        optparse.OptionParser.__init__(self)
438
 
        self.formatter = GettextIndentedHelpFormatter()
439
 
 
440
398
    def error(self, message):
441
399
        raise errors.BzrCommandError(message)
442
400
 
443
401
 
444
 
class GettextIndentedHelpFormatter(optparse.IndentedHelpFormatter):
445
 
    """Adds gettext() call to format_option()"""
446
 
    def __init__(self):
447
 
        optparse.IndentedHelpFormatter.__init__(self)
448
 
 
449
 
    def format_option(self, option):
450
 
        """code taken from Python's optparse.py"""
451
 
        if option.help:
452
 
            option.help = i18n.gettext(option.help)
453
 
        return optparse.IndentedHelpFormatter.format_option(self, option)
454
 
 
455
 
 
456
402
def get_optparser(options):
457
403
    """Generate an optparse parser for bzrlib-style options"""
458
404
 
477
423
    Option.STD_OPTIONS[name] = Option(name, **kwargs)
478
424
    Option.OPTIONS[name] = Option.STD_OPTIONS[name]
479
425
 
480
 
def _standard_list_option(name, **kwargs):
481
 
    """Register a standard option."""
482
 
    # All standard options are implicitly 'global' ones
483
 
    Option.STD_OPTIONS[name] = ListOption(name, **kwargs)
484
 
    Option.OPTIONS[name] = Option.STD_OPTIONS[name]
485
 
 
486
426
 
487
427
def _global_option(name, **kwargs):
488
428
    """Register a global option."""
489
429
    Option.OPTIONS[name] = Option(name, **kwargs)
490
430
 
491
431
 
492
 
def _global_registry_option(name, help, registry=None, **kwargs):
 
432
def _global_registry_option(name, help, registry, **kwargs):
493
433
    Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
494
434
 
495
435
 
 
436
class MergeTypeRegistry(registry.Registry):
 
437
 
 
438
    pass
 
439
 
 
440
 
496
441
# This is the verbosity level detected during command line parsing.
497
442
# Note that the final value is dependent on the order in which the
498
443
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
521
466
            _verbosity_level = -1
522
467
 
523
468
 
 
469
_merge_type_registry = MergeTypeRegistry()
 
470
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
 
471
                                   "Native diff3-style merge")
 
472
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
 
473
                                   "Merge using external diff3")
 
474
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
 
475
                                   "Weave-based merge")
 
476
_merge_type_registry.register_lazy('lca', 'bzrlib.merge', 'LCAMerger',
 
477
                                   "LCA-newness merge")
 
478
 
524
479
# Declare the standard options
525
480
_standard_option('help', short_name='h',
526
481
                 help='Show help message.')
 
482
_standard_option('verbose', short_name='v',
 
483
                 help='Display more information.',
 
484
                 custom_callback=_verbosity_level_callback)
527
485
_standard_option('quiet', short_name='q',
528
486
                 help="Only display errors and warnings.",
529
487
                 custom_callback=_verbosity_level_callback)
530
 
_standard_option('usage',
531
 
                 help='Show usage message and options.')
532
 
_standard_option('verbose', short_name='v',
533
 
                 help='Display more information.',
534
 
                 custom_callback=_verbosity_level_callback)
535
488
 
536
489
# Declare commonly used options
537
 
_global_option('change',
538
 
               type=_parse_change_str,
539
 
               short_name='c',
540
 
               param_name='revision',
541
 
               help='Select changes introduced by the specified revision. See also "help revisionspec".')
542
 
_global_option('directory', short_name='d', type=unicode,
543
 
               help='Branch to operate on, instead of working directory.')
 
490
_global_option('all')
 
491
_global_option('overwrite', help='Ignore differences between branches and '
 
492
               'overwrite unconditionally.')
 
493
_global_option('basis', type=str)
 
494
_global_option('bound')
 
495
_global_option('diff-options', type=str)
544
496
_global_option('file', type=unicode, short_name='F')
545
 
_global_registry_option('log-format', "Use specified log format.",
546
 
                        lazy_registry=('bzrlib.log', 'log_formatter_registry'),
547
 
                        value_switches=True, title='Log format',
548
 
                        short_value_switches={'short': 'S'})
549
 
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
550
 
                        lazy_registry=('bzrlib.merge', 'merge_type_registry'),
551
 
                        value_switches=True, title='Merge algorithm')
 
497
_global_option('force')
 
498
_global_option('format', type=unicode)
 
499
_global_option('forward')
552
500
_global_option('message', type=unicode,
553
501
               short_name='m',
554
502
               help='Message string.')
555
 
_global_option('null', short_name='0',
556
 
                 help='Use an ASCII NUL (\\0) separator rather than '
557
 
                      'a newline.')
558
 
_global_option('overwrite', help='Ignore differences between branches and '
559
 
               'overwrite unconditionally.')
560
 
_global_option('remember', help='Remember the specified location as a'
561
 
               ' default.')
562
 
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
 
503
_global_option('no-recurse')
 
504
_global_option('profile',
 
505
               help='Show performance profiling information.')
563
506
_global_option('revision',
564
507
               type=_parse_revision_str,
565
508
               short_name='r',
566
509
               help='See "help revisionspec" for details.')
 
510
_global_option('change',
 
511
               type=_parse_change_str,
 
512
               short_name='c',
 
513
               param_name='revision',
 
514
               help='Select changes introduced by the specified revision. See also "help revisionspec".')
567
515
_global_option('show-ids',
568
516
               help='Show internal object ids.')
569
 
_global_option('timezone',
 
517
_global_option('timezone', 
570
518
               type=str,
571
 
               help='Display timezone as local, original, or utc.')
572
 
 
573
 
diff_writer_registry = _mod_registry.Registry()
574
 
diff_writer_registry.register('plain', lambda x: x, 'Plaintext diff output.')
575
 
diff_writer_registry.default_key = 'plain'
 
519
               help='display timezone as local, original, or utc')
 
520
_global_option('unbound')
 
521
_global_option('version')
 
522
_global_option('email')
 
523
_global_option('update')
 
524
_global_registry_option('log-format', "Use specified log format.",
 
525
                        log.log_formatter_registry, value_switches=True,
 
526
                        title='Log format')
 
527
_global_option('long', help='Use detailed log format. Same as --log-format long',
 
528
               short_name='l')
 
529
_global_option('short', help='Use moderately short log format. Same as --log-format short')
 
530
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
 
531
_global_option('root', type=str)
 
532
_global_option('no-backup')
 
533
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
 
534
                        _merge_type_registry, value_switches=True,
 
535
                        title='Merge algorithm')
 
536
_global_option('pattern', type=str)
 
537
_global_option('remember', help='Remember the specified location as a'
 
538
               ' default.')
 
539
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
 
540
_global_option('kind', type=str)
 
541
_global_option('dry-run',
 
542
               help="Show what would be done, but don't actually do anything.")
 
543
_global_option('name-from-revision', help='The path name in the old tree.')