← 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: 2007-08-28 08:23:40 UTC
  • mfrom: (2757.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070828082340-2byilw23kzl3cjx4
(Daniel Watkins) Better explanation of -r in uncommit help

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
 
import optparse
21
20
import re
22
21
 
23
22
from bzrlib.lazy_import import lazy_import
24
23
lazy_import(globals(), """
 
24
import optparse
 
25
 
25
26
from bzrlib import (
26
27
    errors,
 
28
    log,
 
29
    registry,
27
30
    revisionspec,
 
31
    symbol_versioning,
28
32
    )
29
33
""")
30
 
 
31
 
from bzrlib import (
32
 
    registry as _mod_registry,
33
 
    )
 
34
from bzrlib.trace import warning
34
35
 
35
36
 
36
37
def _parse_revision_str(revstr):
40
41
    each revision specifier supplied.
41
42
 
42
43
    >>> _parse_revision_str('234')
43
 
    [<RevisionSpec_dwim 234>]
 
44
    [<RevisionSpec_revno 234>]
44
45
    >>> _parse_revision_str('234..567')
45
 
    [<RevisionSpec_dwim 234>, <RevisionSpec_dwim 567>]
 
46
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
46
47
    >>> _parse_revision_str('..')
47
48
    [<RevisionSpec None>, <RevisionSpec None>]
48
49
    >>> _parse_revision_str('..234')
49
 
    [<RevisionSpec None>, <RevisionSpec_dwim 234>]
 
50
    [<RevisionSpec None>, <RevisionSpec_revno 234>]
50
51
    >>> _parse_revision_str('234..')
51
 
    [<RevisionSpec_dwim 234>, <RevisionSpec None>]
 
52
    [<RevisionSpec_revno 234>, <RevisionSpec None>]
52
53
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
53
 
    [<RevisionSpec_dwim 234>, <RevisionSpec_dwim 456>, <RevisionSpec_dwim 789>]
 
54
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
54
55
    >>> _parse_revision_str('234....789') #Error ?
55
 
    [<RevisionSpec_dwim 234>, <RevisionSpec None>, <RevisionSpec_dwim 789>]
 
56
    [<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
56
57
    >>> _parse_revision_str('revid:test@other.com-234234')
57
58
    [<RevisionSpec_revid revid:test@other.com-234234>]
58
59
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
59
60
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
60
61
    >>> _parse_revision_str('revid:test@other.com-234234..23')
61
 
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_dwim 23>]
 
62
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
62
63
    >>> _parse_revision_str('date:2005-04-12')
63
64
    [<RevisionSpec_date date:2005-04-12>]
64
65
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
68
69
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
69
70
    [<RevisionSpec_date date:2005-04-12,12:24:33>]
70
71
    >>> _parse_revision_str('-5..23')
71
 
    [<RevisionSpec_dwim -5>, <RevisionSpec_dwim 23>]
 
72
    [<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
72
73
    >>> _parse_revision_str('-5')
73
 
    [<RevisionSpec_dwim -5>]
 
74
    [<RevisionSpec_revno -5>]
74
75
    >>> _parse_revision_str('123a')
75
 
    [<RevisionSpec_dwim 123a>]
 
76
    Traceback (most recent call last):
 
77
      ...
 
78
    NoSuchRevisionSpec: No namespace registered for string: '123a'
76
79
    >>> _parse_revision_str('abc')
77
 
    [<RevisionSpec_dwim abc>]
 
80
    Traceback (most recent call last):
 
81
      ...
 
82
    NoSuchRevisionSpec: No namespace registered for string: 'abc'
78
83
    >>> _parse_revision_str('branch:../branch2')
79
84
    [<RevisionSpec_branch branch:../branch2>]
80
85
    >>> _parse_revision_str('branch:../../branch2')
81
86
    [<RevisionSpec_branch branch:../../branch2>]
82
87
    >>> _parse_revision_str('branch:../../branch2..23')
83
 
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_dwim 23>]
 
88
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
84
89
    >>> _parse_revision_str('branch:..\\\\branch2')
85
90
    [<RevisionSpec_branch branch:..\\branch2>]
86
91
    >>> _parse_revision_str('branch:..\\\\..\\\\branch2..23')
87
 
    [<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_dwim 23>]
 
92
    [<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_revno 23>]
88
93
    """
89
94
    # TODO: Maybe move this into revisionspec.py
90
95
    revs = []
95
100
    return revs
96
101
 
97
102
 
98
 
def _parse_change_str(revstr):
99
 
    """Parse the revision string and return a tuple with left-most
100
 
    parent of the revision.
101
 
 
102
 
    >>> _parse_change_str('123')
103
 
    (<RevisionSpec_before before:123>, <RevisionSpec_dwim 123>)
104
 
    >>> _parse_change_str('123..124')
105
 
    Traceback (most recent call last):
106
 
      ...
107
 
    RangeInChangeOption: Option --change does not accept revision ranges
108
 
    """
109
 
    revs = _parse_revision_str(revstr)
110
 
    if len(revs) > 1:
111
 
        raise errors.RangeInChangeOption()
112
 
    return (revisionspec.RevisionSpec.from_string('before:' + revstr),
113
 
            revs[0])
114
 
 
115
 
 
116
103
def _parse_merge_type(typestring):
117
104
    return get_merge_type(typestring)
118
105
 
132
119
 
133
120
class Option(object):
134
121
    """Description of a command line option
135
 
 
 
122
    
136
123
    :ivar _short_name: If this option has a single-letter name, this is it.
137
124
    Otherwise None.
138
125
    """
139
126
 
140
 
    # The dictionary of standard options. These are always legal.
141
 
    STD_OPTIONS = {}
 
127
    # TODO: Some way to show in help a description of the option argument
142
128
 
143
 
    # The dictionary of commonly used options. these are only legal
144
 
    # if a command explicitly references them by name in the list
145
 
    # of supported options.
146
129
    OPTIONS = {}
147
130
 
148
131
    def __init__(self, name, help='', type=None, argname=None,
149
 
                 short_name=None, param_name=None, custom_callback=None,
150
 
                 hidden=False):
 
132
                 short_name=None):
151
133
        """Make a new command option.
152
134
 
153
 
        :param name: regular name of the command, used in the double-dash
154
 
            form and also as the parameter to the command's run()
155
 
            method (unless param_name is specified).
156
 
 
157
 
        :param help: help message displayed in command help
158
 
 
159
 
        :param type: function called to parse the option argument, or
 
135
        name -- regular name of the command, used in the double-dash
 
136
            form and also as the parameter to the command's run() 
 
137
            method.
 
138
 
 
139
        help -- help message displayed in command help
 
140
 
 
141
        type -- function called to parse the option argument, or 
160
142
            None (default) if this option doesn't take an argument.
161
143
 
162
 
        :param argname: name of option argument, if any
163
 
 
164
 
        :param short_name: short option code for use with a single -, e.g.
165
 
            short_name="v" to enable parsing of -v.
166
 
 
167
 
        :param param_name: name of the parameter which will be passed to
168
 
            the command's run() method.
169
 
 
170
 
        :param custom_callback: a callback routine to be called after normal
171
 
            processing. The signature of the callback routine is
172
 
            (option, name, new_value, parser).
173
 
        :param hidden: If True, the option should be hidden in help and
174
 
            documentation.
 
144
        argname -- name of option argument, if any
175
145
        """
176
146
        self.name = name
177
147
        self.help = help
178
148
        self.type = type
179
149
        self._short_name = short_name
180
150
        if type is None:
181
 
            if argname:
182
 
                raise ValueError('argname not valid for booleans')
 
151
            assert argname is None
183
152
        elif argname is None:
184
153
            argname = 'ARG'
185
154
        self.argname = argname
186
 
        if param_name is None:
187
 
            self._param_name = self.name.replace('-', '_')
188
 
        else:
189
 
            self._param_name = param_name
190
 
        self.custom_callback = custom_callback
191
 
        self.hidden = hidden
192
155
 
193
156
    def short_name(self):
194
157
        if self._short_name:
208
171
        option_strings = ['--%s' % self.name]
209
172
        if short_name is not None:
210
173
            option_strings.append('-%s' % short_name)
211
 
        if self.hidden:
212
 
            help = optparse.SUPPRESS_HELP
213
 
        else:
214
 
            help = self.help
215
174
        optargfn = self.type
216
175
        if optargfn is None:
217
 
            parser.add_option(action='callback',
218
 
                              callback=self._optparse_bool_callback,
219
 
                              callback_args=(True,),
220
 
                              help=help,
 
176
            parser.add_option(action='store_true', dest=self.name, 
 
177
                              help=self.help,
 
178
                              default=OptionParser.DEFAULT_VALUE,
221
179
                              *option_strings)
222
180
            negation_strings = ['--%s' % self.get_negation_name()]
223
 
            parser.add_option(action='callback',
224
 
                              callback=self._optparse_bool_callback,
225
 
                              callback_args=(False,),
 
181
            parser.add_option(action='store_false', dest=self.name, 
226
182
                              help=optparse.SUPPRESS_HELP, *negation_strings)
227
183
        else:
228
 
            parser.add_option(action='callback',
229
 
                              callback=self._optparse_callback,
 
184
            parser.add_option(action='callback', 
 
185
                              callback=self._optparse_callback, 
230
186
                              type='string', metavar=self.argname.upper(),
231
 
                              help=help,
232
 
                              default=OptionParser.DEFAULT_VALUE,
 
187
                              help=self.help,
 
188
                              default=OptionParser.DEFAULT_VALUE, 
233
189
                              *option_strings)
234
190
 
235
 
    def _optparse_bool_callback(self, option, opt_str, value, parser, bool_v):
236
 
        setattr(parser.values, self._param_name, bool_v)
237
 
        if self.custom_callback is not None:
238
 
            self.custom_callback(option, self._param_name, bool_v, parser)
239
 
 
240
191
    def _optparse_callback(self, option, opt, value, parser):
241
 
        v = self.type(value)
242
 
        setattr(parser.values, self._param_name, v)
243
 
        if self.custom_callback is not None:
244
 
            self.custom_callback(option, self.name, v, parser)
 
192
        setattr(parser.values, self.name, self.type(value))
245
193
 
246
194
    def iter_switches(self):
247
195
        """Iterate through the list of switches provided by the option
248
 
 
 
196
        
249
197
        :return: an iterator of (name, short_name, argname, help)
250
198
        """
251
199
        argname =  self.argname
254
202
        yield self.name, self.short_name(), argname, self.help
255
203
 
256
204
    def is_hidden(self, name):
257
 
        return self.hidden
 
205
        return False
258
206
 
259
207
 
260
208
class ListOption(Option):
280
228
                          *option_strings)
281
229
 
282
230
    def _optparse_callback(self, option, opt, value, parser):
283
 
        values = getattr(parser.values, self._param_name)
 
231
        values = getattr(parser.values, self.name)
284
232
        if value == '-':
285
233
            del values[:]
286
234
        else:
287
235
            values.append(self.type(value))
288
 
        if self.custom_callback is not None:
289
 
            self.custom_callback(option, self._param_name, values, parser)
290
236
 
291
237
 
292
238
class RegistryOption(Option):
310
256
        else:
311
257
            return self.converter(value)
312
258
 
313
 
    def __init__(self, name, help, registry=None, converter=None,
314
 
        value_switches=False, title=None, enum_switch=True,
315
 
        lazy_registry=None):
 
259
    def __init__(self, name, help, registry, converter=None,
 
260
        value_switches=False, title=None, enum_switch=True):
316
261
        """
317
262
        Constructor.
318
263
 
326
271
            '--knit' can be used interchangeably.
327
272
        :param enum_switch: If true, a switch is provided with the option name,
328
273
            which takes a value.
329
 
        :param lazy_registry: A tuple of (module name, attribute name) for a
330
 
            registry to be lazily loaded.
331
274
        """
332
275
        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')
 
276
        self.registry = registry
343
277
        self.name = name
344
278
        self.converter = converter
345
279
        self.value_switches = value_switches
348
282
        if self.title is None:
349
283
            self.title = name
350
284
 
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
285
    @staticmethod
358
286
    def from_kwargs(name_, help=None, title=None, value_switches=False,
359
287
                    enum_switch=True, **kwargs):
361
289
 
362
290
        name, help, value_switches and enum_switch are passed to the
363
291
        RegistryOption constructor.  Any other keyword arguments are treated
364
 
        as values for the option, and their value is treated as the help.
 
292
        as values for the option, and they value is treated as the help.
365
293
        """
366
 
        reg = _mod_registry.Registry()
 
294
        reg = registry.Registry()
367
295
        for name, switch_help in kwargs.iteritems():
368
296
            name = name.replace('_', '-')
369
297
            reg.register(name, name, help=switch_help)
370
 
            if not value_switches:
371
 
                help = help + '  "' + name + '": ' + switch_help
372
 
                if not help.endswith("."):
373
 
                    help = help + "."
374
298
        return RegistryOption(name_, help, reg, title=title,
375
299
            value_switches=value_switches, enum_switch=enum_switch)
376
300
 
394
318
 
395
319
    def _optparse_value_callback(self, cb_value):
396
320
        def cb(option, opt, value, parser):
397
 
            v = self.type(cb_value)
398
 
            setattr(parser.values, self._param_name, v)
399
 
            if self.custom_callback is not None:
400
 
                self.custom_callback(option, self._param_name, v, parser)
 
321
            setattr(parser.values, self.name, self.type(cb_value))
401
322
        return cb
402
323
 
403
324
    def iter_switches(self):
436
357
    return parser
437
358
 
438
359
 
439
 
def custom_help(name, help):
440
 
    """Clone a common option overriding the help."""
441
 
    import copy
442
 
    o = copy.copy(Option.OPTIONS[name])
443
 
    o.help = help
444
 
    return o
445
 
 
446
 
 
447
 
def _standard_option(name, **kwargs):
448
 
    """Register a standard option."""
449
 
    # All standard options are implicitly 'global' ones
450
 
    Option.STD_OPTIONS[name] = Option(name, **kwargs)
451
 
    Option.OPTIONS[name] = Option.STD_OPTIONS[name]
452
 
 
453
 
 
454
360
def _global_option(name, **kwargs):
455
 
    """Register a global option."""
 
361
    """Register o as a global option."""
456
362
    Option.OPTIONS[name] = Option(name, **kwargs)
457
363
 
458
364
 
459
 
def _global_registry_option(name, help, registry=None, **kwargs):
 
365
def _global_registry_option(name, help, registry, **kwargs):
460
366
    Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
461
367
 
462
368
 
463
 
# This is the verbosity level detected during command line parsing.
464
 
# Note that the final value is dependent on the order in which the
465
 
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
466
 
# The final value will be one of the following:
467
 
#
468
 
# * -ve for quiet
469
 
# * 0 for normal
470
 
# * +ve for verbose
471
 
_verbosity_level = 0
472
 
 
473
 
 
474
 
def _verbosity_level_callback(option, opt_str, value, parser):
475
 
    global _verbosity_level
476
 
    if not value:
477
 
        # Either --no-verbose or --no-quiet was specified
478
 
        _verbosity_level = 0
479
 
    elif opt_str == "verbose":
480
 
        if _verbosity_level > 0:
481
 
            _verbosity_level += 1
482
 
        else:
483
 
            _verbosity_level = 1
484
 
    else:
485
 
        if _verbosity_level < 0:
486
 
            _verbosity_level -= 1
487
 
        else:
488
 
            _verbosity_level = -1
489
 
 
490
 
 
491
 
class MergeTypeRegistry(_mod_registry.Registry):
 
369
class MergeTypeRegistry(registry.Registry):
492
370
 
493
371
    pass
494
372
 
500
378
                                   "Merge using external diff3")
501
379
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
502
380
                                   "Weave-based merge")
503
 
_merge_type_registry.register_lazy('lca', 'bzrlib.merge', 'LCAMerger',
504
 
                                   "LCA-newness merge")
505
 
 
506
 
# Declare the standard options
507
 
_standard_option('help', short_name='h',
508
 
                 help='Show help message.')
509
 
_standard_option('usage',
510
 
                 help='Show usage message and options.')
511
 
_standard_option('verbose', short_name='v',
512
 
                 help='Display more information.',
513
 
                 custom_callback=_verbosity_level_callback)
514
 
_standard_option('quiet', short_name='q',
515
 
                 help="Only display errors and warnings.",
516
 
                 custom_callback=_verbosity_level_callback)
517
 
 
518
 
# Declare commonly used options
 
381
 
519
382
_global_option('all')
520
383
_global_option('overwrite', help='Ignore differences between branches and '
521
384
               'overwrite unconditionally.')
535
398
_global_option('revision',
536
399
               type=_parse_revision_str,
537
400
               short_name='r',
538
 
               help='See "help revisionspec" for details.')
539
 
_global_option('change',
540
 
               type=_parse_change_str,
541
 
               short_name='c',
542
 
               param_name='revision',
543
 
               help='Select changes introduced by the specified revision. See also "help revisionspec".')
 
401
               help='See \'help revisionspec\' for details.')
544
402
_global_option('show-ids',
545
403
               help='Show internal object ids.')
546
 
_global_option('timezone',
 
404
_global_option('timezone', 
547
405
               type=str,
548
 
               help='Display timezone as local, original, or utc.')
 
406
               help='display timezone as local, original, or utc')
549
407
_global_option('unbound')
 
408
_global_option('verbose',
 
409
               help='Display more information.',
 
410
               short_name='v')
550
411
_global_option('version')
551
412
_global_option('email')
552
413
_global_option('update')
553
414
_global_registry_option('log-format', "Use specified log format.",
554
 
                        lazy_registry=('bzrlib.log', 'log_formatter_registry'),
555
 
                        value_switches=True, title='Log format')
 
415
                        log.log_formatter_registry, value_switches=True,
 
416
                        title='Log format')
556
417
_global_option('long', help='Use detailed log format. Same as --log-format long',
557
418
               short_name='l')
558
419
_global_option('short', help='Use moderately short log format. Same as --log-format short')
563
424
                        _merge_type_registry, value_switches=True,
564
425
                        title='Merge algorithm')
565
426
_global_option('pattern', type=str)
 
427
_global_option('quiet', short_name='q')
566
428
_global_option('remember', help='Remember the specified location as a'
567
429
               ' default.')
568
430
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
571
433
               help="Show what would be done, but don't actually do anything.")
572
434
_global_option('name-from-revision', help='The path name in the old tree.')
573
435
 
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'
 
436
_help_option = Option('help',
 
437
                      help='Show help message.',
 
438
                      short_name='h')