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
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.
366
reg = _mod_registry.Registry()
367
for name, switch_help in sorted(kwargs.items()):
294
reg = registry.Registry()
295
for name, help in kwargs.iteritems():
368
296
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("."):
297
reg.register(name, name, help=help)
374
298
return RegistryOption(name_, help, reg, title=title,
375
299
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
355
def _global_option(name, **kwargs):
455
"""Register a global option."""
356
"""Register o as a global option."""
456
357
Option.OPTIONS[name] = Option(name, **kwargs)
459
def _global_registry_option(name, help, registry=None, **kwargs):
360
def _global_registry_option(name, help, registry, **kwargs):
460
361
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):
364
class MergeTypeRegistry(registry.Registry):
500
373
"Merge using external diff3")
501
374
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
502
375
"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
377
_global_option('all')
520
378
_global_option('overwrite', help='Ignore differences between branches and '
521
'overwrite unconditionally.')
379
'overwrite unconditionally')
522
380
_global_option('basis', type=str)
523
381
_global_option('bound')
524
382
_global_option('diff-options', type=str)
383
_global_option('help',
384
help='show help message',
525
386
_global_option('file', type=unicode, short_name='F')
526
387
_global_option('force')
527
388
_global_option('format', type=unicode)
528
389
_global_option('forward')
529
390
_global_option('message', type=unicode,
531
help='Message string.')
532
392
_global_option('no-recurse')
533
_global_option('null', short_name='0',
534
help='Use an ASCII NUL (\\0) separator rather than '
536
393
_global_option('profile',
537
help='Show performance profiling information.')
394
help='show performance profiling information')
538
395
_global_option('revision',
539
396
type=_parse_revision_str,
541
help='See "help revisionspec" for details.')
542
_global_option('change',
543
type=_parse_change_str,
545
param_name='revision',
546
help='Select changes introduced by the specified revision. See also "help revisionspec".')
547
_global_option('show-ids',
548
help='Show internal object ids.')
549
_global_option('timezone',
398
help='See \'help revisionspec\' for details')
399
_global_option('show-ids',
400
help='show internal object ids')
401
_global_option('timezone',
551
help='Display timezone as local, original, or utc.')
403
help='display timezone as local, original, or utc')
552
404
_global_option('unbound')
405
_global_option('verbose',
406
help='display more information',
553
408
_global_option('version')
554
409
_global_option('email')
555
410
_global_option('update')
556
_global_registry_option('log-format', "Use specified log format.",
557
lazy_registry=('bzrlib.log', 'log_formatter_registry'),
558
value_switches=True, title='Log format')
411
_global_registry_option('log-format', "Use this log format",
412
log.log_formatter_registry, value_switches=True,
559
414
_global_option('long', help='Use detailed log format. Same as --log-format long',
561
416
_global_option('short', help='Use moderately short log format. Same as --log-format short')
562
417
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
563
418
_global_option('root', type=str)
564
419
_global_option('no-backup')
565
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
420
_global_registry_option('merge-type', 'Select a particular merge algorithm',
566
421
_merge_type_registry, value_switches=True,
567
422
title='Merge algorithm')
568
423
_global_option('pattern', type=str)
424
_global_option('quiet', short_name='q')
569
425
_global_option('remember', help='Remember the specified location as a'
571
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
427
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
572
428
_global_option('kind', type=str)
573
429
_global_option('dry-run',
574
help="Show what would be done, but don't actually do anything.")
430
help="show what would be done, but don't actually do anything")
575
431
_global_option('name-from-revision', help='The path name in the old tree.')
576
_global_option('directory', short_name='d', type=unicode,
577
help='Branch to operate on, instead of working directory')
579
diff_writer_registry = _mod_registry.Registry()
580
diff_writer_registry.register('plain', lambda x: x, 'Plaintext diff output.')
581
diff_writer_registry.default_key = 'plain'
434
# prior to 0.14 these were always globally registered; the old dict is
435
# available for plugins that use it but it should not be used.
436
Option.SHORT_OPTIONS = symbol_versioning.DeprecatedDict(
437
symbol_versioning.zero_fourteen,
440
'F': Option.OPTIONS['file'],
441
'h': Option.OPTIONS['help'],
442
'm': Option.OPTIONS['message'],
443
'r': Option.OPTIONS['revision'],
444
'v': Option.OPTIONS['verbose'],
445
'l': Option.OPTIONS['long'],
446
'q': Option.OPTIONS['quiet'],
448
'Set the short option name when constructing the Option.',