40
41
each revision specifier supplied.
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):
78
NoSuchRevisionSpec: No namespace registered for string: '123a'
76
79
>>> _parse_revision_str('abc')
77
[<RevisionSpec_dwim abc>]
80
Traceback (most recent call last):
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>]
84
>>> _parse_revision_str('branch:..\\\\branch2')
85
[<RevisionSpec_branch branch:..\\branch2>]
86
>>> _parse_revision_str('branch:..\\\\..\\\\branch2..23')
87
[<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_dwim 23>]
88
[<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
89
90
# TODO: Maybe move this into revisionspec.py
91
# split on .. that is not followed by a / or \
92
sep = re.compile(r'\.\.(?![\\/])')
92
# split on the first .. that is not followed by a / ?
93
sep = re.compile("\\.\\.(?!/)")
93
94
for x in sep.split(revstr):
94
95
revs.append(revisionspec.RevisionSpec.from_string(x or None))
98
def _parse_change_str(revstr):
99
"""Parse the revision string and return a tuple with left-most
100
parent of the revision.
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):
107
RangeInChangeOption: Option --change does not accept revision ranges
109
revs = _parse_revision_str(revstr)
111
raise errors.RangeInChangeOption()
112
return (revisionspec.RevisionSpec.from_string('before:' + revstr),
116
99
def _parse_merge_type(typestring):
117
100
return get_merge_type(typestring)
133
116
class Option(object):
134
117
"""Description of a command line option
136
119
:ivar _short_name: If this option has a single-letter name, this is it.
140
# The dictionary of standard options. These are always legal.
123
# TODO: Some way to show in help a description of the option argument
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.
148
127
def __init__(self, name, help='', type=None, argname=None,
149
short_name=None, param_name=None, custom_callback=None,
151
129
"""Make a new command option.
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).
157
:param help: help message displayed in command help
159
:param type: function called to parse the option argument, or
131
name -- regular name of the command, used in the double-dash
132
form and also as the parameter to the command's run()
135
help -- help message displayed in command help
137
type -- function called to parse the option argument, or
160
138
None (default) if this option doesn't take an argument.
162
:param argname: name of option argument, if any
164
:param short_name: short option code for use with a single -, e.g.
165
short_name="v" to enable parsing of -v.
167
:param param_name: name of the parameter which will be passed to
168
the command's run() method.
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
140
argname -- name of option argument, if any
179
145
self._short_name = short_name
182
raise ValueError('argname not valid for booleans')
147
assert argname is None
183
148
elif argname is None:
185
150
self.argname = argname
186
if param_name is None:
187
self._param_name = self.name.replace('-', '_')
189
self._param_name = param_name
190
self.custom_callback = custom_callback
193
152
def short_name(self):
194
153
if self._short_name:
195
154
return self._short_name
156
# remove this when SHORT_OPTIONS is removed
157
# XXX: This is accessing a DeprecatedDict, so we call the super
158
# method to avoid warnings
159
for (k, v) in dict.iteritems(Option.SHORT_OPTIONS):
197
163
def set_short_name(self, short_name):
198
164
self._short_name = short_name
208
174
option_strings = ['--%s' % self.name]
209
175
if short_name is not None:
210
176
option_strings.append('-%s' % short_name)
212
help = optparse.SUPPRESS_HELP
215
177
optargfn = self.type
216
178
if optargfn is None:
217
parser.add_option(action='callback',
218
callback=self._optparse_bool_callback,
219
callback_args=(True,),
179
parser.add_option(action='store_true', dest=self.name,
181
default=OptionParser.DEFAULT_VALUE,
222
183
negation_strings = ['--%s' % self.get_negation_name()]
223
parser.add_option(action='callback',
224
callback=self._optparse_bool_callback,
225
callback_args=(False,),
184
parser.add_option(action='store_false', dest=self.name,
226
185
help=optparse.SUPPRESS_HELP, *negation_strings)
228
parser.add_option(action='callback',
229
callback=self._optparse_callback,
187
parser.add_option(action='callback',
188
callback=self._optparse_callback,
230
189
type='string', metavar=self.argname.upper(),
232
default=OptionParser.DEFAULT_VALUE,
191
default=OptionParser.DEFAULT_VALUE,
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)
240
194
def _optparse_callback(self, option, opt, value, parser):
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)
195
setattr(parser.values, self.name, self.type(value))
246
197
def iter_switches(self):
247
198
"""Iterate through the list of switches provided by the option
249
200
:return: an iterator of (name, short_name, argname, help)
251
202
argname = self.argname
253
204
argname = argname.upper()
254
205
yield self.name, self.short_name(), argname, self.help
256
def is_hidden(self, name):
260
class ListOption(Option):
261
"""Option used to provide a list of values.
263
On the command line, arguments are specified by a repeated use of the
264
option. '-' is a special argument that resets the list. For example,
266
sets the value of the 'foo' option to ['a', 'b'], and
267
--foo=a --foo=b --foo=- --foo=c
268
sets the value of the 'foo' option to ['c'].
271
def add_option(self, parser, short_name):
272
"""Add this option to an Optparse parser."""
273
option_strings = ['--%s' % self.name]
274
if short_name is not None:
275
option_strings.append('-%s' % short_name)
276
parser.add_option(action='callback',
277
callback=self._optparse_callback,
278
type='string', metavar=self.argname.upper(),
279
help=self.help, dest=self._param_name, default=[],
282
def _optparse_callback(self, option, opt, value, parser):
283
values = getattr(parser.values, self._param_name)
287
values.append(self.type(value))
288
if self.custom_callback is not None:
289
self.custom_callback(option, self._param_name, values, parser)
292
208
class RegistryOption(Option):
293
209
"""Option based on a registry
362
260
name, help, value_switches and enum_switch are passed to the
363
261
RegistryOption constructor. Any other keyword arguments are treated
364
as values for the option, and their value is treated as the help.
262
as values for the option, and they value is treated as the help.
366
reg = _mod_registry.Registry()
367
for name, switch_help in sorted(kwargs.items()):
264
reg = registry.Registry()
265
for name, help in kwargs.iteritems():
368
266
name = name.replace('_', '-')
369
reg.register(name, name, help=switch_help)
370
if not value_switches:
371
help = help + ' "' + name + '": ' + switch_help
372
if not help.endswith("."):
267
reg.register(name, name, help=help)
374
268
return RegistryOption(name_, help, reg, title=title,
375
269
value_switches=value_switches, enum_switch=enum_switch)
439
def custom_help(name, help):
440
"""Clone a common option overriding the help."""
442
o = copy.copy(Option.OPTIONS[name])
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]
454
321
def _global_option(name, **kwargs):
455
"""Register a global option."""
322
"""Register o as a global option."""
456
323
Option.OPTIONS[name] = Option(name, **kwargs)
459
def _global_registry_option(name, help, registry=None, **kwargs):
326
def _global_registry_option(name, help, registry, **kwargs):
460
327
Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
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:
474
def _verbosity_level_callback(option, opt_str, value, parser):
475
global _verbosity_level
477
# Either --no-verbose or --no-quiet was specified
479
elif opt_str == "verbose":
480
if _verbosity_level > 0:
481
_verbosity_level += 1
485
if _verbosity_level < 0:
486
_verbosity_level -= 1
488
_verbosity_level = -1
491
class MergeTypeRegistry(_mod_registry.Registry):
330
class MergeTypeRegistry(registry.Registry):
500
339
"Merge using external diff3")
501
340
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
502
341
"Weave-based merge")
503
_merge_type_registry.register_lazy('lca', 'bzrlib.merge', 'LCAMerger',
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)
518
# Declare commonly used options
519
343
_global_option('all')
520
344
_global_option('overwrite', help='Ignore differences between branches and '
521
'overwrite unconditionally.')
345
'overwrite unconditionally')
522
346
_global_option('basis', type=str)
523
347
_global_option('bound')
524
348
_global_option('diff-options', type=str)
349
_global_option('help',
350
help='show help message',
525
352
_global_option('file', type=unicode, short_name='F')
526
353
_global_option('force')
527
354
_global_option('format', type=unicode)
528
355
_global_option('forward')
529
356
_global_option('message', type=unicode,
531
help='Message string.')
532
358
_global_option('no-recurse')
533
359
_global_option('profile',
534
help='Show performance profiling information.')
360
help='show performance profiling information')
535
361
_global_option('revision',
536
362
type=_parse_revision_str,
538
help='See "help revisionspec" for details.')
539
_global_option('change',
540
type=_parse_change_str,
542
param_name='revision',
543
help='Select changes introduced by the specified revision. See also "help revisionspec".')
544
_global_option('show-ids',
545
help='Show internal object ids.')
546
_global_option('timezone',
364
help='See \'help revisionspec\' for details')
365
_global_option('show-ids',
366
help='show internal object ids')
367
_global_option('timezone',
548
help='Display timezone as local, original, or utc.')
369
help='display timezone as local, original, or utc')
549
370
_global_option('unbound')
371
_global_option('verbose',
372
help='display more information',
550
374
_global_option('version')
551
375
_global_option('email')
552
376
_global_option('update')
553
_global_registry_option('log-format', "Use specified log format.",
554
lazy_registry=('bzrlib.log', 'log_formatter_registry'),
555
value_switches=True, title='Log format')
377
_global_registry_option('log-format', "Use this log format",
378
log.log_formatter_registry, value_switches=True,
556
380
_global_option('long', help='Use detailed log format. Same as --log-format long',
558
382
_global_option('short', help='Use moderately short log format. Same as --log-format short')
559
383
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
560
384
_global_option('root', type=str)
561
385
_global_option('no-backup')
562
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
386
_global_registry_option('merge-type', 'Select a particular merge algorithm',
563
387
_merge_type_registry, value_switches=True,
564
388
title='Merge algorithm')
565
389
_global_option('pattern', type=str)
390
_global_option('quiet', short_name='q')
566
391
_global_option('remember', help='Remember the specified location as a'
568
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
393
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
569
394
_global_option('kind', type=str)
570
395
_global_option('dry-run',
571
help="Show what would be done, but don't actually do anything.")
396
help="show what would be done, but don't actually do anything")
572
397
_global_option('name-from-revision', help='The path name in the old tree.')
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'
400
# prior to 0.14 these were always globally registered; the old dict is
401
# available for plugins that use it but it should not be used.
402
Option.SHORT_OPTIONS = symbol_versioning.DeprecatedDict(
403
symbol_versioning.zero_fourteen,
406
'F': Option.OPTIONS['file'],
407
'h': Option.OPTIONS['help'],
408
'm': Option.OPTIONS['message'],
409
'r': Option.OPTIONS['revision'],
410
'v': Option.OPTIONS['verbose'],
411
'l': Option.OPTIONS['long'],
412
'q': Option.OPTIONS['quiet'],
414
'Set the short option name when constructing the Option.',