← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/option.py

https://launchpad.net/bugs/524184
NEWS section template into a separate file

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
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
      ...
279
280
        parser.add_option(action='callback',
280
281
                          callback=self._optparse_callback,
281
282
                          type='string', metavar=self.argname.upper(),
282
 
                          help=self.help, dest=self._param_name, default=[],
 
283
                          help=self.help, default=[],
283
284
                          *option_strings)
284
285
 
285
286
    def _optparse_callback(self, option, opt, value, parser):
315
316
 
316
317
    def __init__(self, name, help, registry=None, converter=None,
317
318
        value_switches=False, title=None, enum_switch=True,
318
 
        lazy_registry=None, short_name=None, short_value_switches=None):
 
319
        lazy_registry=None):
319
320
        """
320
321
        Constructor.
321
322
 
331
332
            which takes a value.
332
333
        :param lazy_registry: A tuple of (module name, attribute name) for a
333
334
            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
335
        """
337
 
        Option.__init__(self, name, help, type=self.convert,
338
 
                        short_name=short_name)
 
336
        Option.__init__(self, name, help, type=self.convert)
339
337
        self._registry = registry
340
338
        if registry is None:
341
339
            if lazy_registry is None:
350
348
        self.converter = converter
351
349
        self.value_switches = value_switches
352
350
        self.enum_switch = enum_switch
353
 
        self.short_value_switches = short_value_switches
354
351
        self.title = title
355
352
        if self.title is None:
356
353
            self.title = name
368
365
 
369
366
        name, help, value_switches and enum_switch are passed to the
370
367
        RegistryOption constructor.  Any other keyword arguments are treated
371
 
        as values for the option, and their value is treated as the help.
 
368
        as values for the option, and they value is treated as the help.
372
369
        """
373
370
        reg = _mod_registry.Registry()
374
 
        for name, switch_help in sorted(kwargs.items()):
 
371
        for name, switch_help in kwargs.iteritems():
375
372
            name = name.replace('_', '-')
376
373
            reg.register(name, name, help=switch_help)
377
374
            if not value_switches:
394
391
                    help = optparse.SUPPRESS_HELP
395
392
                else:
396
393
                    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
394
                parser.add_option(action='callback',
402
395
                              callback=self._optparse_value_callback(key),
403
396
                                  help=help,
433
426
 
434
427
    DEFAULT_VALUE = object()
435
428
 
436
 
    def __init__(self):
437
 
        optparse.OptionParser.__init__(self)
438
 
        self.formatter = GettextIndentedHelpFormatter()
439
 
 
440
429
    def error(self, message):
441
430
        raise errors.BzrCommandError(message)
442
431
 
443
432
 
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
433
def get_optparser(options):
457
434
    """Generate an optparse parser for bzrlib-style options"""
458
435
 
477
454
    Option.STD_OPTIONS[name] = Option(name, **kwargs)
478
455
    Option.OPTIONS[name] = Option.STD_OPTIONS[name]
479
456
 
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
457
 
487
458
def _global_option(name, **kwargs):
488
459
    """Register a global option."""
521
492
            _verbosity_level = -1
522
493
 
523
494
 
 
495
class MergeTypeRegistry(_mod_registry.Registry):
 
496
 
 
497
    pass
 
498
 
 
499
 
 
500
_merge_type_registry = MergeTypeRegistry()
 
501
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
 
502
                                   "Native diff3-style merge")
 
503
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
 
504
                                   "Merge using external diff3")
 
505
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
 
506
                                   "Weave-based merge")
 
507
_merge_type_registry.register_lazy('lca', 'bzrlib.merge', 'LCAMerger',
 
508
                                   "LCA-newness merge")
 
509
 
524
510
# Declare the standard options
525
511
_standard_option('help', short_name='h',
526
512
                 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
513
_standard_option('usage',
531
514
                 help='Show usage message and options.')
532
515
_standard_option('verbose', short_name='v',
533
516
                 help='Display more information.',
534
517
                 custom_callback=_verbosity_level_callback)
 
518
_standard_option('quiet', short_name='q',
 
519
                 help="Only display errors and warnings.",
 
520
                 custom_callback=_verbosity_level_callback)
535
521
 
536
522
# 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.')
 
523
_global_option('all')
 
524
_global_option('overwrite', help='Ignore differences between branches and '
 
525
               'overwrite unconditionally.')
 
526
_global_option('basis', type=str)
 
527
_global_option('bound')
 
528
_global_option('diff-options', type=str)
544
529
_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')
 
530
_global_option('force')
 
531
_global_option('format', type=unicode)
 
532
_global_option('forward')
552
533
_global_option('message', type=unicode,
553
534
               short_name='m',
554
535
               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.')
 
536
_global_option('no-recurse')
 
537
_global_option('profile',
 
538
               help='Show performance profiling information.')
563
539
_global_option('revision',
564
540
               type=_parse_revision_str,
565
541
               short_name='r',
566
542
               help='See "help revisionspec" for details.')
 
543
_global_option('change',
 
544
               type=_parse_change_str,
 
545
               short_name='c',
 
546
               param_name='revision',
 
547
               help='Select changes introduced by the specified revision. See also "help revisionspec".')
567
548
_global_option('show-ids',
568
549
               help='Show internal object ids.')
569
550
_global_option('timezone',
570
551
               type=str,
571
552
               help='Display timezone as local, original, or utc.')
 
553
_global_option('unbound')
 
554
_global_option('version')
 
555
_global_option('email')
 
556
_global_option('update')
 
557
_global_registry_option('log-format', "Use specified log format.",
 
558
                        lazy_registry=('bzrlib.log', 'log_formatter_registry'),
 
559
                        value_switches=True, title='Log format')
 
560
_global_option('long', help='Use detailed log format. Same as --log-format long',
 
561
               short_name='l')
 
562
_global_option('short', help='Use moderately short log format. Same as --log-format short')
 
563
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
 
564
_global_option('root', type=str)
 
565
_global_option('no-backup')
 
566
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
 
567
                        _merge_type_registry, value_switches=True,
 
568
                        title='Merge algorithm')
 
569
_global_option('pattern', type=str)
 
570
_global_option('remember', help='Remember the specified location as a'
 
571
               ' default.')
 
572
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
 
573
_global_option('kind', type=str)
 
574
_global_option('dry-run',
 
575
               help="Show what would be done, but don't actually do anything.")
 
576
_global_option('name-from-revision', help='The path name in the old tree.')
572
577
 
573
578
diff_writer_registry = _mod_registry.Registry()
574
579
diff_writer_registry.register('plain', lambda x: x, 'Plaintext diff output.')