← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/option.py

  • Committer: John Arbash Meinel
  • Date: 2008-08-25 21:50:11 UTC
  • mfrom: (0.11.3 tools)
  • mto: This revision was merged to the branch mainline in revision 3659.
  • Revision ID: john@arbash-meinel.com-20080825215011-de9esmzgkue3e522
Merge in Lukáš's helper scripts.
Update the packaging documents to describe how to do the releases
using bzr-builddeb to package all distro platforms
simultaneously.

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.
29
29
""")
30
30
 
31
31
from bzrlib import (
32
 
    registry as _mod_registry,
 
32
    log,
 
33
    registry,
33
34
    )
34
35
 
35
 
 
36
36
def _parse_revision_str(revstr):
37
37
    """This handles a revision string -> revno.
38
38
 
40
40
    each revision specifier supplied.
41
41
 
42
42
    >>> _parse_revision_str('234')
43
 
    [<RevisionSpec_dwim 234>]
 
43
    [<RevisionSpec_revno 234>]
44
44
    >>> _parse_revision_str('234..567')
45
 
    [<RevisionSpec_dwim 234>, <RevisionSpec_dwim 567>]
 
45
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
46
46
    >>> _parse_revision_str('..')
47
47
    [<RevisionSpec None>, <RevisionSpec None>]
48
48
    >>> _parse_revision_str('..234')
49
 
    [<RevisionSpec None>, <RevisionSpec_dwim 234>]
 
49
    [<RevisionSpec None>, <RevisionSpec_revno 234>]
50
50
    >>> _parse_revision_str('234..')
51
 
    [<RevisionSpec_dwim 234>, <RevisionSpec None>]
 
51
    [<RevisionSpec_revno 234>, <RevisionSpec None>]
52
52
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
53
 
    [<RevisionSpec_dwim 234>, <RevisionSpec_dwim 456>, <RevisionSpec_dwim 789>]
 
53
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
54
54
    >>> _parse_revision_str('234....789') #Error ?
55
 
    [<RevisionSpec_dwim 234>, <RevisionSpec None>, <RevisionSpec_dwim 789>]
 
55
    [<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
56
56
    >>> _parse_revision_str('revid:test@other.com-234234')
57
57
    [<RevisionSpec_revid revid:test@other.com-234234>]
58
58
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
59
59
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
60
60
    >>> _parse_revision_str('revid:test@other.com-234234..23')
61
 
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_dwim 23>]
 
61
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
62
62
    >>> _parse_revision_str('date:2005-04-12')
63
63
    [<RevisionSpec_date date:2005-04-12>]
64
64
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
68
68
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
69
69
    [<RevisionSpec_date date:2005-04-12,12:24:33>]
70
70
    >>> _parse_revision_str('-5..23')
71
 
    [<RevisionSpec_dwim -5>, <RevisionSpec_dwim 23>]
 
71
    [<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
72
72
    >>> _parse_revision_str('-5')
73
 
    [<RevisionSpec_dwim -5>]
 
73
    [<RevisionSpec_revno -5>]
74
74
    >>> _parse_revision_str('123a')
75
 
    [<RevisionSpec_dwim 123a>]
 
75
    Traceback (most recent call last):
 
76
      ...
 
77
    NoSuchRevisionSpec: No namespace registered for string: '123a'
76
78
    >>> _parse_revision_str('abc')
77
 
    [<RevisionSpec_dwim abc>]
 
79
    Traceback (most recent call last):
 
80
      ...
 
81
    NoSuchRevisionSpec: No namespace registered for string: 'abc'
78
82
    >>> _parse_revision_str('branch:../branch2')
79
83
    [<RevisionSpec_branch branch:../branch2>]
80
84
    >>> _parse_revision_str('branch:../../branch2')
81
85
    [<RevisionSpec_branch branch:../../branch2>]
82
86
    >>> _parse_revision_str('branch:../../branch2..23')
83
 
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_dwim 23>]
 
87
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
84
88
    >>> _parse_revision_str('branch:..\\\\branch2')
85
89
    [<RevisionSpec_branch branch:..\\branch2>]
86
90
    >>> _parse_revision_str('branch:..\\\\..\\\\branch2..23')
87
 
    [<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_dwim 23>]
 
91
    [<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_revno 23>]
88
92
    """
89
93
    # TODO: Maybe move this into revisionspec.py
90
94
    revs = []
100
104
    parent of the revision.
101
105
 
102
106
    >>> _parse_change_str('123')
103
 
    (<RevisionSpec_before before:123>, <RevisionSpec_dwim 123>)
 
107
    (<RevisionSpec_before before:123>, <RevisionSpec_revno 123>)
104
108
    >>> _parse_change_str('123..124')
105
109
    Traceback (most recent call last):
106
110
      ...
132
136
 
133
137
class Option(object):
134
138
    """Description of a command line option
135
 
 
 
139
    
136
140
    :ivar _short_name: If this option has a single-letter name, this is it.
137
141
    Otherwise None.
138
142
    """
146
150
    OPTIONS = {}
147
151
 
148
152
    def __init__(self, name, help='', type=None, argname=None,
149
 
                 short_name=None, param_name=None, custom_callback=None,
150
 
                 hidden=False):
 
153
                 short_name=None, param_name=None, custom_callback=None):
151
154
        """Make a new command option.
152
155
 
153
156
        :param name: regular name of the command, used in the double-dash
154
 
            form and also as the parameter to the command's run()
 
157
            form and also as the parameter to the command's run() 
155
158
            method (unless param_name is specified).
156
159
 
157
160
        :param help: help message displayed in command help
158
161
 
159
 
        :param type: function called to parse the option argument, or
 
162
        :param type: function called to parse the option argument, or 
160
163
            None (default) if this option doesn't take an argument.
161
164
 
162
165
        :param argname: name of option argument, if any
170
173
        :param custom_callback: a callback routine to be called after normal
171
174
            processing. The signature of the callback routine is
172
175
            (option, name, new_value, parser).
173
 
        :param hidden: If True, the option should be hidden in help and
174
 
            documentation.
175
176
        """
176
177
        self.name = name
177
178
        self.help = help
184
185
            argname = 'ARG'
185
186
        self.argname = argname
186
187
        if param_name is None:
187
 
            self._param_name = self.name.replace('-', '_')
 
188
            self._param_name = self.name
188
189
        else:
189
190
            self._param_name = param_name
190
191
        self.custom_callback = custom_callback
191
 
        self.hidden = hidden
192
192
 
193
193
    def short_name(self):
194
194
        if self._short_name:
208
208
        option_strings = ['--%s' % self.name]
209
209
        if short_name is not None:
210
210
            option_strings.append('-%s' % short_name)
211
 
        if self.hidden:
212
 
            help = optparse.SUPPRESS_HELP
213
 
        else:
214
 
            help = self.help
215
211
        optargfn = self.type
216
212
        if optargfn is None:
217
 
            parser.add_option(action='callback',
218
 
                              callback=self._optparse_bool_callback,
 
213
            parser.add_option(action='callback', 
 
214
                              callback=self._optparse_bool_callback, 
219
215
                              callback_args=(True,),
220
 
                              help=help,
 
216
                              help=self.help,
221
217
                              *option_strings)
222
218
            negation_strings = ['--%s' % self.get_negation_name()]
223
 
            parser.add_option(action='callback',
224
 
                              callback=self._optparse_bool_callback,
 
219
            parser.add_option(action='callback', 
 
220
                              callback=self._optparse_bool_callback, 
225
221
                              callback_args=(False,),
226
222
                              help=optparse.SUPPRESS_HELP, *negation_strings)
227
223
        else:
228
 
            parser.add_option(action='callback',
229
 
                              callback=self._optparse_callback,
 
224
            parser.add_option(action='callback', 
 
225
                              callback=self._optparse_callback, 
230
226
                              type='string', metavar=self.argname.upper(),
231
 
                              help=help,
232
 
                              default=OptionParser.DEFAULT_VALUE,
 
227
                              help=self.help,
 
228
                              default=OptionParser.DEFAULT_VALUE, 
233
229
                              *option_strings)
234
230
 
235
231
    def _optparse_bool_callback(self, option, opt_str, value, parser, bool_v):
245
241
 
246
242
    def iter_switches(self):
247
243
        """Iterate through the list of switches provided by the option
248
 
 
 
244
        
249
245
        :return: an iterator of (name, short_name, argname, help)
250
246
        """
251
247
        argname =  self.argname
254
250
        yield self.name, self.short_name(), argname, self.help
255
251
 
256
252
    def is_hidden(self, name):
257
 
        return self.hidden
 
253
        return False
258
254
 
259
255
 
260
256
class ListOption(Option):
310
306
        else:
311
307
            return self.converter(value)
312
308
 
313
 
    def __init__(self, name, help, registry=None, converter=None,
314
 
        value_switches=False, title=None, enum_switch=True,
315
 
        lazy_registry=None):
 
309
    def __init__(self, name, help, registry, converter=None,
 
310
        value_switches=False, title=None, enum_switch=True):
316
311
        """
317
312
        Constructor.
318
313
 
326
321
            '--knit' can be used interchangeably.
327
322
        :param enum_switch: If true, a switch is provided with the option name,
328
323
            which takes a value.
329
 
        :param lazy_registry: A tuple of (module name, attribute name) for a
330
 
            registry to be lazily loaded.
331
324
        """
332
325
        Option.__init__(self, name, help, type=self.convert)
333
 
        self._registry = registry
334
 
        if registry is None:
335
 
            if lazy_registry is None:
336
 
                raise AssertionError(
337
 
                    'One of registry or lazy_registry must be given.')
338
 
            self._lazy_registry = _mod_registry._LazyObjectGetter(
339
 
                *lazy_registry)
340
 
        if registry is not None and lazy_registry is not None:
341
 
            raise AssertionError(
342
 
                'registry and lazy_registry are mutually exclusive')
 
326
        self.registry = registry
343
327
        self.name = name
344
328
        self.converter = converter
345
329
        self.value_switches = value_switches
348
332
        if self.title is None:
349
333
            self.title = name
350
334
 
351
 
    @property
352
 
    def registry(self):
353
 
        if self._registry is None:
354
 
            self._registry = self._lazy_registry.get_obj()
355
 
        return self._registry
356
 
 
357
335
    @staticmethod
358
336
    def from_kwargs(name_, help=None, title=None, value_switches=False,
359
337
                    enum_switch=True, **kwargs):
361
339
 
362
340
        name, help, value_switches and enum_switch are passed to the
363
341
        RegistryOption constructor.  Any other keyword arguments are treated
364
 
        as values for the option, and their value is treated as the help.
 
342
        as values for the option, and they value is treated as the help.
365
343
        """
366
 
        reg = _mod_registry.Registry()
 
344
        reg = registry.Registry()
367
345
        for name, switch_help in kwargs.iteritems():
368
346
            name = name.replace('_', '-')
369
347
            reg.register(name, name, help=switch_help)
456
434
    Option.OPTIONS[name] = Option(name, **kwargs)
457
435
 
458
436
 
459
 
def _global_registry_option(name, help, registry=None, **kwargs):
 
437
def _global_registry_option(name, help, registry, **kwargs):
460
438
    Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
461
439
 
462
440
 
 
441
class MergeTypeRegistry(registry.Registry):
 
442
 
 
443
    pass
 
444
 
 
445
 
463
446
# This is the verbosity level detected during command line parsing.
464
447
# Note that the final value is dependent on the order in which the
465
448
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
488
471
            _verbosity_level = -1
489
472
 
490
473
 
491
 
class MergeTypeRegistry(_mod_registry.Registry):
492
 
 
493
 
    pass
494
 
 
495
 
 
496
474
_merge_type_registry = MergeTypeRegistry()
497
475
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
498
476
                                   "Native diff3-style merge")
506
484
# Declare the standard options
507
485
_standard_option('help', short_name='h',
508
486
                 help='Show help message.')
509
 
_standard_option('usage',
510
 
                 help='Show usage message and options.')
511
487
_standard_option('verbose', short_name='v',
512
488
                 help='Display more information.',
513
489
                 custom_callback=_verbosity_level_callback)
543
519
               help='Select changes introduced by the specified revision. See also "help revisionspec".')
544
520
_global_option('show-ids',
545
521
               help='Show internal object ids.')
546
 
_global_option('timezone',
 
522
_global_option('timezone', 
547
523
               type=str,
548
 
               help='Display timezone as local, original, or utc.')
 
524
               help='display timezone as local, original, or utc')
549
525
_global_option('unbound')
550
526
_global_option('version')
551
527
_global_option('email')
552
528
_global_option('update')
553
529
_global_registry_option('log-format', "Use specified log format.",
554
 
                        lazy_registry=('bzrlib.log', 'log_formatter_registry'),
555
 
                        value_switches=True, title='Log format')
 
530
                        log.log_formatter_registry, value_switches=True,
 
531
                        title='Log format')
556
532
_global_option('long', help='Use detailed log format. Same as --log-format long',
557
533
               short_name='l')
558
534
_global_option('short', help='Use moderately short log format. Same as --log-format short')
570
546
_global_option('dry-run',
571
547
               help="Show what would be done, but don't actually do anything.")
572
548
_global_option('name-from-revision', help='The path name in the old tree.')
573
 
 
574
 
diff_writer_registry = _mod_registry.Registry()
575
 
diff_writer_registry.register('plain', lambda x: x, 'Plaintext diff output.')
576
 
diff_writer_registry.default_key = 'plain'