← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/option.py

  • Committer: Martin Pool
  • Date: 2009-01-13 03:06:36 UTC
  • mfrom: (3932.2.3 1.11)
  • mto: This revision was merged to the branch mainline in revision 3937.
  • Revision ID: mbp@sourcefrog.net-20090113030636-dqx4t8yaaqgdvam5
Merge 1.11rc1

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
 
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
191
189
        else:
192
190
            self._param_name = param_name
193
191
        self.custom_callback = custom_callback
194
 
        self.hidden = hidden
195
192
 
196
193
    def short_name(self):
197
194
        if self._short_name:
211
208
        option_strings = ['--%s' % self.name]
212
209
        if short_name is not None:
213
210
            option_strings.append('-%s' % short_name)
214
 
        if self.hidden:
215
 
            help = optparse.SUPPRESS_HELP
216
 
        else:
217
 
            help = self.help
218
211
        optargfn = self.type
219
212
        if optargfn is None:
220
213
            parser.add_option(action='callback',
221
214
                              callback=self._optparse_bool_callback,
222
215
                              callback_args=(True,),
223
 
                              help=help,
 
216
                              help=self.help,
224
217
                              *option_strings)
225
218
            negation_strings = ['--%s' % self.get_negation_name()]
226
219
            parser.add_option(action='callback',
231
224
            parser.add_option(action='callback',
232
225
                              callback=self._optparse_callback,
233
226
                              type='string', metavar=self.argname.upper(),
234
 
                              help=help,
 
227
                              help=self.help,
235
228
                              default=OptionParser.DEFAULT_VALUE,
236
229
                              *option_strings)
237
230
 
248
241
 
249
242
    def iter_switches(self):
250
243
        """Iterate through the list of switches provided by the option
251
 
 
 
244
        
252
245
        :return: an iterator of (name, short_name, argname, help)
253
246
        """
254
247
        argname =  self.argname
257
250
        yield self.name, self.short_name(), argname, self.help
258
251
 
259
252
    def is_hidden(self, name):
260
 
        return self.hidden
 
253
        return False
261
254
 
262
255
 
263
256
class ListOption(Option):
279
272
        parser.add_option(action='callback',
280
273
                          callback=self._optparse_callback,
281
274
                          type='string', metavar=self.argname.upper(),
282
 
                          help=self.help, dest=self._param_name, default=[],
 
275
                          help=self.help, default=[],
283
276
                          *option_strings)
284
277
 
285
278
    def _optparse_callback(self, option, opt, value, parser):
315
308
 
316
309
    def __init__(self, name, help, registry=None, converter=None,
317
310
        value_switches=False, title=None, enum_switch=True,
318
 
        lazy_registry=None, short_name=None, short_value_switches=None):
 
311
        lazy_registry=None):
319
312
        """
320
313
        Constructor.
321
314
 
331
324
            which takes a value.
332
325
        :param lazy_registry: A tuple of (module name, attribute name) for a
333
326
            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
327
        """
337
 
        Option.__init__(self, name, help, type=self.convert,
338
 
                        short_name=short_name)
 
328
        Option.__init__(self, name, help, type=self.convert)
339
329
        self._registry = registry
340
330
        if registry is None:
341
331
            if lazy_registry is None:
350
340
        self.converter = converter
351
341
        self.value_switches = value_switches
352
342
        self.enum_switch = enum_switch
353
 
        self.short_value_switches = short_value_switches
354
343
        self.title = title
355
344
        if self.title is None:
356
345
            self.title = name
360
349
        if self._registry is None:
361
350
            self._registry = self._lazy_registry.get_obj()
362
351
        return self._registry
363
 
 
 
352
    
364
353
    @staticmethod
365
354
    def from_kwargs(name_, help=None, title=None, value_switches=False,
366
355
                    enum_switch=True, **kwargs):
368
357
 
369
358
        name, help, value_switches and enum_switch are passed to the
370
359
        RegistryOption constructor.  Any other keyword arguments are treated
371
 
        as values for the option, and their value is treated as the help.
 
360
        as values for the option, and they value is treated as the help.
372
361
        """
373
362
        reg = _mod_registry.Registry()
374
 
        for name, switch_help in sorted(kwargs.items()):
 
363
        for name, switch_help in kwargs.iteritems():
375
364
            name = name.replace('_', '-')
376
365
            reg.register(name, name, help=switch_help)
377
366
            if not value_switches:
394
383
                    help = optparse.SUPPRESS_HELP
395
384
                else:
396
385
                    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
386
                parser.add_option(action='callback',
402
387
                              callback=self._optparse_value_callback(key),
403
388
                                  help=help,
433
418
 
434
419
    DEFAULT_VALUE = object()
435
420
 
436
 
    def __init__(self):
437
 
        optparse.OptionParser.__init__(self)
438
 
        self.formatter = GettextIndentedHelpFormatter()
439
 
 
440
421
    def error(self, message):
441
422
        raise errors.BzrCommandError(message)
442
423
 
443
424
 
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
425
def get_optparser(options):
457
426
    """Generate an optparse parser for bzrlib-style options"""
458
427
 
477
446
    Option.STD_OPTIONS[name] = Option(name, **kwargs)
478
447
    Option.OPTIONS[name] = Option.STD_OPTIONS[name]
479
448
 
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
449
 
487
450
def _global_option(name, **kwargs):
488
451
    """Register a global option."""
521
484
            _verbosity_level = -1
522
485
 
523
486
 
 
487
class MergeTypeRegistry(_mod_registry.Registry):
 
488
 
 
489
    pass
 
490
 
 
491
 
 
492
_merge_type_registry = MergeTypeRegistry()
 
493
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
 
494
                                   "Native diff3-style merge")
 
495
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
 
496
                                   "Merge using external diff3")
 
497
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
 
498
                                   "Weave-based merge")
 
499
_merge_type_registry.register_lazy('lca', 'bzrlib.merge', 'LCAMerger',
 
500
                                   "LCA-newness merge")
 
501
 
524
502
# Declare the standard options
525
503
_standard_option('help', short_name='h',
526
504
                 help='Show help message.')
 
505
_standard_option('verbose', short_name='v',
 
506
                 help='Display more information.',
 
507
                 custom_callback=_verbosity_level_callback)
527
508
_standard_option('quiet', short_name='q',
528
509
                 help="Only display errors and warnings.",
529
510
                 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
511
 
536
512
# 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.')
 
513
_global_option('all')
 
514
_global_option('overwrite', help='Ignore differences between branches and '
 
515
               'overwrite unconditionally.')
 
516
_global_option('basis', type=str)
 
517
_global_option('bound')
 
518
_global_option('diff-options', type=str)
544
519
_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')
 
520
_global_option('force')
 
521
_global_option('format', type=unicode)
 
522
_global_option('forward')
552
523
_global_option('message', type=unicode,
553
524
               short_name='m',
554
525
               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.')
 
526
_global_option('no-recurse')
 
527
_global_option('profile',
 
528
               help='Show performance profiling information.')
563
529
_global_option('revision',
564
530
               type=_parse_revision_str,
565
531
               short_name='r',
566
532
               help='See "help revisionspec" for details.')
 
533
_global_option('change',
 
534
               type=_parse_change_str,
 
535
               short_name='c',
 
536
               param_name='revision',
 
537
               help='Select changes introduced by the specified revision. See also "help revisionspec".')
567
538
_global_option('show-ids',
568
539
               help='Show internal object ids.')
569
540
_global_option('timezone',
570
541
               type=str,
571
542
               help='Display timezone as local, original, or utc.')
 
543
_global_option('unbound')
 
544
_global_option('version')
 
545
_global_option('email')
 
546
_global_option('update')
 
547
_global_registry_option('log-format', "Use specified log format.",
 
548
                        lazy_registry=('bzrlib.log', 'log_formatter_registry'),
 
549
                        value_switches=True, title='Log format')
 
550
_global_option('long', help='Use detailed log format. Same as --log-format long',
 
551
               short_name='l')
 
552
_global_option('short', help='Use moderately short log format. Same as --log-format short')
 
553
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
 
554
_global_option('root', type=str)
 
555
_global_option('no-backup')
 
556
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
 
557
                        _merge_type_registry, value_switches=True,
 
558
                        title='Merge algorithm')
 
559
_global_option('pattern', type=str)
 
560
_global_option('remember', help='Remember the specified location as a'
 
561
               ' default.')
 
562
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
 
563
_global_option('kind', type=str)
 
564
_global_option('dry-run',
 
565
               help="Show what would be done, but don't actually do anything.")
 
566
_global_option('name-from-revision', help='The path name in the old tree.')
572
567
 
573
568
diff_writer_registry = _mod_registry.Registry()
574
569
diff_writer_registry.register('plain', lambda x: x, 'Plaintext diff output.')