← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/option.py

  • Committer: Patch Queue Manager
  • Date: 2013-05-27 10:52:24 UTC
  • mfrom: (6576.1.5 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20130527105224-3k2yibl2xrvnh6rf
(vila) Handle empty quoted strings in command lines and various
 cleanups (Vincent Ladeuil)

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) 2005-2010 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
 
20
22
import optparse
21
23
import re
22
24
 
25
27
from bzrlib import (
26
28
    errors,
27
29
    revisionspec,
 
30
    i18n,
28
31
    )
29
32
""")
30
33
 
31
34
from bzrlib import (
32
 
    log,
33
 
    registry,
 
35
    registry as _mod_registry,
34
36
    )
35
37
 
 
38
 
36
39
def _parse_revision_str(revstr):
37
40
    """This handles a revision string -> revno.
38
41
 
40
43
    each revision specifier supplied.
41
44
 
42
45
    >>> _parse_revision_str('234')
43
 
    [<RevisionSpec_revno 234>]
 
46
    [<RevisionSpec_dwim 234>]
44
47
    >>> _parse_revision_str('234..567')
45
 
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
 
48
    [<RevisionSpec_dwim 234>, <RevisionSpec_dwim 567>]
46
49
    >>> _parse_revision_str('..')
47
50
    [<RevisionSpec None>, <RevisionSpec None>]
48
51
    >>> _parse_revision_str('..234')
49
 
    [<RevisionSpec None>, <RevisionSpec_revno 234>]
 
52
    [<RevisionSpec None>, <RevisionSpec_dwim 234>]
50
53
    >>> _parse_revision_str('234..')
51
 
    [<RevisionSpec_revno 234>, <RevisionSpec None>]
 
54
    [<RevisionSpec_dwim 234>, <RevisionSpec None>]
52
55
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
53
 
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
 
56
    [<RevisionSpec_dwim 234>, <RevisionSpec_dwim 456>, <RevisionSpec_dwim 789>]
54
57
    >>> _parse_revision_str('234....789') #Error ?
55
 
    [<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
 
58
    [<RevisionSpec_dwim 234>, <RevisionSpec None>, <RevisionSpec_dwim 789>]
56
59
    >>> _parse_revision_str('revid:test@other.com-234234')
57
60
    [<RevisionSpec_revid revid:test@other.com-234234>]
58
61
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
59
62
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
60
63
    >>> _parse_revision_str('revid:test@other.com-234234..23')
61
 
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
 
64
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_dwim 23>]
62
65
    >>> _parse_revision_str('date:2005-04-12')
63
66
    [<RevisionSpec_date date:2005-04-12>]
64
67
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
68
71
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
69
72
    [<RevisionSpec_date date:2005-04-12,12:24:33>]
70
73
    >>> _parse_revision_str('-5..23')
71
 
    [<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
 
74
    [<RevisionSpec_dwim -5>, <RevisionSpec_dwim 23>]
72
75
    >>> _parse_revision_str('-5')
73
 
    [<RevisionSpec_revno -5>]
 
76
    [<RevisionSpec_dwim -5>]
74
77
    >>> _parse_revision_str('123a')
75
 
    Traceback (most recent call last):
76
 
      ...
77
 
    NoSuchRevisionSpec: No namespace registered for string: '123a'
 
78
    [<RevisionSpec_dwim 123a>]
78
79
    >>> _parse_revision_str('abc')
79
 
    Traceback (most recent call last):
80
 
      ...
81
 
    NoSuchRevisionSpec: No namespace registered for string: 'abc'
 
80
    [<RevisionSpec_dwim abc>]
82
81
    >>> _parse_revision_str('branch:../branch2')
83
82
    [<RevisionSpec_branch branch:../branch2>]
84
83
    >>> _parse_revision_str('branch:../../branch2')
85
84
    [<RevisionSpec_branch branch:../../branch2>]
86
85
    >>> _parse_revision_str('branch:../../branch2..23')
87
 
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
 
86
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_dwim 23>]
88
87
    >>> _parse_revision_str('branch:..\\\\branch2')
89
88
    [<RevisionSpec_branch branch:..\\branch2>]
90
89
    >>> _parse_revision_str('branch:..\\\\..\\\\branch2..23')
91
 
    [<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_revno 23>]
 
90
    [<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_dwim 23>]
92
91
    """
93
92
    # TODO: Maybe move this into revisionspec.py
94
93
    revs = []
104
103
    parent of the revision.
105
104
 
106
105
    >>> _parse_change_str('123')
107
 
    (<RevisionSpec_before before:123>, <RevisionSpec_revno 123>)
 
106
    (<RevisionSpec_before before:123>, <RevisionSpec_dwim 123>)
108
107
    >>> _parse_change_str('123..124')
109
108
    Traceback (most recent call last):
110
109
      ...
136
135
 
137
136
class Option(object):
138
137
    """Description of a command line option
139
 
    
 
138
 
140
139
    :ivar _short_name: If this option has a single-letter name, this is it.
141
140
    Otherwise None.
142
141
    """
150
149
    OPTIONS = {}
151
150
 
152
151
    def __init__(self, name, help='', type=None, argname=None,
153
 
                 short_name=None, param_name=None, custom_callback=None):
 
152
                 short_name=None, param_name=None, custom_callback=None,
 
153
                 hidden=False):
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.
176
178
        """
177
179
        self.name = name
178
180
        self.help = help
189
191
        else:
190
192
            self._param_name = param_name
191
193
        self.custom_callback = custom_callback
 
194
        self.hidden = hidden
192
195
 
193
196
    def short_name(self):
194
197
        if self._short_name:
208
211
        option_strings = ['--%s' % self.name]
209
212
        if short_name is not None:
210
213
            option_strings.append('-%s' % short_name)
 
214
        if self.hidden:
 
215
            help = optparse.SUPPRESS_HELP
 
216
        else:
 
217
            help = self.help
211
218
        optargfn = self.type
212
219
        if optargfn is None:
213
220
            parser.add_option(action='callback',
214
221
                              callback=self._optparse_bool_callback,
215
222
                              callback_args=(True,),
216
 
                              help=self.help,
 
223
                              help=help,
217
224
                              *option_strings)
218
225
            negation_strings = ['--%s' % self.get_negation_name()]
219
226
            parser.add_option(action='callback',
224
231
            parser.add_option(action='callback',
225
232
                              callback=self._optparse_callback,
226
233
                              type='string', metavar=self.argname.upper(),
227
 
                              help=self.help,
 
234
                              help=help,
228
235
                              default=OptionParser.DEFAULT_VALUE,
229
236
                              *option_strings)
230
237
 
241
248
 
242
249
    def iter_switches(self):
243
250
        """Iterate through the list of switches provided by the option
244
 
        
 
251
 
245
252
        :return: an iterator of (name, short_name, argname, help)
246
253
        """
247
254
        argname =  self.argname
250
257
        yield self.name, self.short_name(), argname, self.help
251
258
 
252
259
    def is_hidden(self, name):
253
 
        return False
 
260
        return self.hidden
254
261
 
255
262
 
256
263
class ListOption(Option):
272
279
        parser.add_option(action='callback',
273
280
                          callback=self._optparse_callback,
274
281
                          type='string', metavar=self.argname.upper(),
275
 
                          help=self.help, default=[],
 
282
                          help=self.help, dest=self._param_name, default=[],
276
283
                          *option_strings)
277
284
 
278
285
    def _optparse_callback(self, option, opt, value, parser):
306
313
        else:
307
314
            return self.converter(value)
308
315
 
309
 
    def __init__(self, name, help, registry, converter=None,
310
 
        value_switches=False, title=None, enum_switch=True):
 
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):
311
319
        """
312
320
        Constructor.
313
321
 
321
329
            '--knit' can be used interchangeably.
322
330
        :param enum_switch: If true, a switch is provided with the option name,
323
331
            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
324
336
        """
325
 
        Option.__init__(self, name, help, type=self.convert)
326
 
        self.registry = registry
 
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')
327
349
        self.name = name
328
350
        self.converter = converter
329
351
        self.value_switches = value_switches
330
352
        self.enum_switch = enum_switch
 
353
        self.short_value_switches = short_value_switches
331
354
        self.title = title
332
355
        if self.title is None:
333
356
            self.title = name
334
357
 
 
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
 
335
364
    @staticmethod
336
365
    def from_kwargs(name_, help=None, title=None, value_switches=False,
337
366
                    enum_switch=True, **kwargs):
339
368
 
340
369
        name, help, value_switches and enum_switch are passed to the
341
370
        RegistryOption constructor.  Any other keyword arguments are treated
342
 
        as values for the option, and they value is treated as the help.
 
371
        as values for the option, and their value is treated as the help.
343
372
        """
344
 
        reg = registry.Registry()
345
 
        for name, switch_help in kwargs.iteritems():
 
373
        reg = _mod_registry.Registry()
 
374
        for name, switch_help in sorted(kwargs.items()):
346
375
            name = name.replace('_', '-')
347
376
            reg.register(name, name, help=switch_help)
348
377
            if not value_switches:
365
394
                    help = optparse.SUPPRESS_HELP
366
395
                else:
367
396
                    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])
368
401
                parser.add_option(action='callback',
369
402
                              callback=self._optparse_value_callback(key),
370
403
                                  help=help,
400
433
 
401
434
    DEFAULT_VALUE = object()
402
435
 
 
436
    def __init__(self):
 
437
        optparse.OptionParser.__init__(self)
 
438
        self.formatter = GettextIndentedHelpFormatter()
 
439
 
403
440
    def error(self, message):
404
441
        raise errors.BzrCommandError(message)
405
442
 
406
443
 
 
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
 
407
456
def get_optparser(options):
408
457
    """Generate an optparse parser for bzrlib-style options"""
409
458
 
428
477
    Option.STD_OPTIONS[name] = Option(name, **kwargs)
429
478
    Option.OPTIONS[name] = Option.STD_OPTIONS[name]
430
479
 
 
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
 
431
486
 
432
487
def _global_option(name, **kwargs):
433
488
    """Register a global option."""
434
489
    Option.OPTIONS[name] = Option(name, **kwargs)
435
490
 
436
491
 
437
 
def _global_registry_option(name, help, registry, **kwargs):
 
492
def _global_registry_option(name, help, registry=None, **kwargs):
438
493
    Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
439
494
 
440
495
 
441
 
class MergeTypeRegistry(registry.Registry):
442
 
 
443
 
    pass
444
 
 
445
 
 
446
496
# This is the verbosity level detected during command line parsing.
447
497
# Note that the final value is dependent on the order in which the
448
498
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
471
521
            _verbosity_level = -1
472
522
 
473
523
 
474
 
_merge_type_registry = MergeTypeRegistry()
475
 
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
476
 
                                   "Native diff3-style merge")
477
 
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
478
 
                                   "Merge using external diff3")
479
 
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
480
 
                                   "Weave-based merge")
481
 
_merge_type_registry.register_lazy('lca', 'bzrlib.merge', 'LCAMerger',
482
 
                                   "LCA-newness merge")
483
 
 
484
524
# Declare the standard options
485
525
_standard_option('help', short_name='h',
486
526
                 help='Show help message.')
 
527
_standard_option('quiet', short_name='q',
 
528
                 help="Only display errors and warnings.",
 
529
                 custom_callback=_verbosity_level_callback)
 
530
_standard_option('usage',
 
531
                 help='Show usage message and options.')
487
532
_standard_option('verbose', short_name='v',
488
533
                 help='Display more information.',
489
534
                 custom_callback=_verbosity_level_callback)
490
 
_standard_option('quiet', short_name='q',
491
 
                 help="Only display errors and warnings.",
492
 
                 custom_callback=_verbosity_level_callback)
493
535
 
494
536
# Declare commonly used options
495
 
_global_option('all')
496
 
_global_option('overwrite', help='Ignore differences between branches and '
497
 
               'overwrite unconditionally.')
498
 
_global_option('basis', type=str)
499
 
_global_option('bound')
500
 
_global_option('diff-options', type=str)
 
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.')
501
544
_global_option('file', type=unicode, short_name='F')
502
 
_global_option('force')
503
 
_global_option('format', type=unicode)
504
 
_global_option('forward')
 
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')
505
552
_global_option('message', type=unicode,
506
553
               short_name='m',
507
554
               help='Message string.')
508
 
_global_option('no-recurse')
509
 
_global_option('profile',
510
 
               help='Show performance profiling information.')
 
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.')
511
563
_global_option('revision',
512
564
               type=_parse_revision_str,
513
565
               short_name='r',
514
566
               help='See "help revisionspec" for details.')
515
 
_global_option('change',
516
 
               type=_parse_change_str,
517
 
               short_name='c',
518
 
               param_name='revision',
519
 
               help='Select changes introduced by the specified revision. See also "help revisionspec".')
520
567
_global_option('show-ids',
521
568
               help='Show internal object ids.')
522
 
_global_option('timezone', 
 
569
_global_option('timezone',
523
570
               type=str,
524
 
               help='display timezone as local, original, or utc')
525
 
_global_option('unbound')
526
 
_global_option('version')
527
 
_global_option('email')
528
 
_global_option('update')
529
 
_global_registry_option('log-format', "Use specified log format.",
530
 
                        log.log_formatter_registry, value_switches=True,
531
 
                        title='Log format')
532
 
_global_option('long', help='Use detailed log format. Same as --log-format long',
533
 
               short_name='l')
534
 
_global_option('short', help='Use moderately short log format. Same as --log-format short')
535
 
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
536
 
_global_option('root', type=str)
537
 
_global_option('no-backup')
538
 
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
539
 
                        _merge_type_registry, value_switches=True,
540
 
                        title='Merge algorithm')
541
 
_global_option('pattern', type=str)
542
 
_global_option('remember', help='Remember the specified location as a'
543
 
               ' default.')
544
 
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
545
 
_global_option('kind', type=str)
546
 
_global_option('dry-run',
547
 
               help="Show what would be done, but don't actually do anything.")
548
 
_global_option('name-from-revision', help='The path name in the old tree.')
 
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'