86
85
[<RevisionSpec_branch branch:../../branch2>]
87
86
>>> _parse_revision_str('branch:../../branch2..23')
88
87
[<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
88
>>> _parse_revision_str('branch:..\\\\branch2')
89
[<RevisionSpec_branch branch:..\\branch2>]
90
>>> _parse_revision_str('branch:..\\\\..\\\\branch2..23')
91
[<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_revno 23>]
90
93
# TODO: Maybe move this into revisionspec.py
92
# split on the first .. that is not followed by a / ?
93
sep = re.compile("\\.\\.(?!/)")
95
# split on .. that is not followed by a / or \
96
sep = re.compile(r'\.\.(?![\\/])')
94
97
for x in sep.split(revstr):
95
98
revs.append(revisionspec.RevisionSpec.from_string(x or None))
102
def _parse_change_str(revstr):
103
"""Parse the revision string and return a tuple with left-most
104
parent of the revision.
106
>>> _parse_change_str('123')
107
(<RevisionSpec_before before:123>, <RevisionSpec_revno 123>)
108
>>> _parse_change_str('123..124')
109
Traceback (most recent call last):
111
RangeInChangeOption: Option --change does not accept revision ranges
113
revs = _parse_revision_str(revstr)
115
raise errors.RangeInChangeOption()
116
return (revisionspec.RevisionSpec.from_string('before:' + revstr),
99
120
def _parse_merge_type(typestring):
100
121
return get_merge_type(typestring)
116
137
class Option(object):
117
138
"""Description of a command line option
119
140
:ivar _short_name: If this option has a single-letter name, this is it.
123
# TODO: Some way to show in help a description of the option argument
144
# The dictionary of standard options. These are always legal.
147
# The dictionary of commonly used options. these are only legal
148
# if a command explicitly references them by name in the list
149
# of supported options.
127
152
def __init__(self, name, help='', type=None, argname=None,
153
short_name=None, param_name=None, custom_callback=None,
129
155
"""Make a new command option.
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
157
:param name: regular name of the command, used in the double-dash
158
form and also as the parameter to the command's run()
159
method (unless param_name is specified).
161
:param help: help message displayed in command help
163
:param type: function called to parse the option argument, or
138
164
None (default) if this option doesn't take an argument.
140
argname -- name of option argument, if any
166
:param argname: name of option argument, if any
168
:param short_name: short option code for use with a single -, e.g.
169
short_name="v" to enable parsing of -v.
171
:param param_name: name of the parameter which will be passed to
172
the command's run() method.
174
:param custom_callback: a callback routine to be called after normal
175
processing. The signature of the callback routine is
176
(option, name, new_value, parser).
177
:param hidden: If True, the option should be hidden in help and
145
183
self._short_name = short_name
147
assert argname is None
186
raise ValueError('argname not valid for booleans')
148
187
elif argname is None:
150
189
self.argname = argname
190
if param_name is None:
191
self._param_name = self.name.replace('-', '_')
193
self._param_name = param_name
194
self.custom_callback = custom_callback
152
197
def short_name(self):
153
198
if self._short_name:
154
199
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):
163
201
def set_short_name(self, short_name):
164
202
self._short_name = short_name
174
212
option_strings = ['--%s' % self.name]
175
213
if short_name is not None:
176
214
option_strings.append('-%s' % short_name)
216
help = optparse.SUPPRESS_HELP
177
219
optargfn = self.type
178
220
if optargfn is None:
179
parser.add_option(action='store_true', dest=self.name,
181
default=OptionParser.DEFAULT_VALUE,
221
parser.add_option(action='callback',
222
callback=self._optparse_bool_callback,
223
callback_args=(True,),
183
226
negation_strings = ['--%s' % self.get_negation_name()]
184
parser.add_option(action='store_false', dest=self.name,
227
parser.add_option(action='callback',
228
callback=self._optparse_bool_callback,
229
callback_args=(False,),
185
230
help=optparse.SUPPRESS_HELP, *negation_strings)
187
parser.add_option(action='callback',
188
callback=self._optparse_callback,
232
parser.add_option(action='callback',
233
callback=self._optparse_callback,
189
234
type='string', metavar=self.argname.upper(),
191
default=OptionParser.DEFAULT_VALUE,
236
default=OptionParser.DEFAULT_VALUE,
239
def _optparse_bool_callback(self, option, opt_str, value, parser, bool_v):
240
setattr(parser.values, self._param_name, bool_v)
241
if self.custom_callback is not None:
242
self.custom_callback(option, self._param_name, bool_v, parser)
194
244
def _optparse_callback(self, option, opt, value, parser):
195
setattr(parser.values, self.name, self.type(value))
246
setattr(parser.values, self._param_name, v)
247
if self.custom_callback is not None:
248
self.custom_callback(option, self.name, v, parser)
197
250
def iter_switches(self):
198
251
"""Iterate through the list of switches provided by the option
200
253
:return: an iterator of (name, short_name, argname, help)
202
255
argname = self.argname
204
257
argname = argname.upper()
205
258
yield self.name, self.short_name(), argname, self.help
260
def is_hidden(self, name):
264
class ListOption(Option):
265
"""Option used to provide a list of values.
267
On the command line, arguments are specified by a repeated use of the
268
option. '-' is a special argument that resets the list. For example,
270
sets the value of the 'foo' option to ['a', 'b'], and
271
--foo=a --foo=b --foo=- --foo=c
272
sets the value of the 'foo' option to ['c'].
275
def add_option(self, parser, short_name):
276
"""Add this option to an Optparse parser."""
277
option_strings = ['--%s' % self.name]
278
if short_name is not None:
279
option_strings.append('-%s' % short_name)
280
parser.add_option(action='callback',
281
callback=self._optparse_callback,
282
type='string', metavar=self.argname.upper(),
283
help=self.help, default=[],
286
def _optparse_callback(self, option, opt, value, parser):
287
values = getattr(parser.values, self._param_name)
291
values.append(self.type(value))
292
if self.custom_callback is not None:
293
self.custom_callback(option, self._param_name, values, parser)
208
296
class RegistryOption(Option):
209
297
"""Option based on a registry
443
def custom_help(name, help):
444
"""Clone a common option overriding the help."""
446
o = copy.copy(Option.OPTIONS[name])
451
def _standard_option(name, **kwargs):
452
"""Register a standard option."""
453
# All standard options are implicitly 'global' ones
454
Option.STD_OPTIONS[name] = Option(name, **kwargs)
455
Option.OPTIONS[name] = Option.STD_OPTIONS[name]
325
458
def _global_option(name, **kwargs):
326
"""Register o as a global option."""
459
"""Register a global option."""
327
460
Option.OPTIONS[name] = Option(name, **kwargs)
330
def _global_registry_option(name, help, registry, **kwargs):
463
def _global_registry_option(name, help, registry=None, **kwargs):
331
464
Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
334
class MergeTypeRegistry(registry.Registry):
467
# This is the verbosity level detected during command line parsing.
468
# Note that the final value is dependent on the order in which the
469
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
470
# The final value will be one of the following:
478
def _verbosity_level_callback(option, opt_str, value, parser):
479
global _verbosity_level
481
# Either --no-verbose or --no-quiet was specified
483
elif opt_str == "verbose":
484
if _verbosity_level > 0:
485
_verbosity_level += 1
489
if _verbosity_level < 0:
490
_verbosity_level -= 1
492
_verbosity_level = -1
495
class MergeTypeRegistry(_mod_registry.Registry):
343
504
"Merge using external diff3")
344
505
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
345
506
"Weave-based merge")
507
_merge_type_registry.register_lazy('lca', 'bzrlib.merge', 'LCAMerger',
510
# Declare the standard options
511
_standard_option('help', short_name='h',
512
help='Show help message.')
513
_standard_option('usage',
514
help='Show usage message and options.')
515
_standard_option('verbose', short_name='v',
516
help='Display more information.',
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)
522
# Declare commonly used options
347
523
_global_option('all')
348
524
_global_option('overwrite', help='Ignore differences between branches and '
349
'overwrite unconditionally')
525
'overwrite unconditionally.')
350
526
_global_option('basis', type=str)
351
527
_global_option('bound')
352
528
_global_option('diff-options', type=str)
353
_global_option('help',
354
help='show help message',
356
529
_global_option('file', type=unicode, short_name='F')
357
530
_global_option('force')
358
531
_global_option('format', type=unicode)
359
532
_global_option('forward')
360
533
_global_option('message', type=unicode,
535
help='Message string.')
362
536
_global_option('no-recurse')
363
537
_global_option('profile',
364
help='show performance profiling information')
538
help='Show performance profiling information.')
365
539
_global_option('revision',
366
540
type=_parse_revision_str,
368
help='See \'help revisionspec\' for details')
369
_global_option('show-ids',
370
help='show internal object ids')
371
_global_option('timezone',
542
help='See "help revisionspec" for details.')
543
_global_option('change',
544
type=_parse_change_str,
546
param_name='revision',
547
help='Select changes introduced by the specified revision. See also "help revisionspec".')
548
_global_option('show-ids',
549
help='Show internal object ids.')
550
_global_option('timezone',
373
help='display timezone as local, original, or utc')
552
help='Display timezone as local, original, or utc.')
374
553
_global_option('unbound')
375
_global_option('verbose',
376
help='display more information',
378
554
_global_option('version')
379
555
_global_option('email')
380
556
_global_option('update')
381
_global_registry_option('log-format', "Use this log format",
382
log.log_formatter_registry, value_switches=True,
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')
384
560
_global_option('long', help='Use detailed log format. Same as --log-format long',
386
562
_global_option('short', help='Use moderately short log format. Same as --log-format short')
387
563
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
388
564
_global_option('root', type=str)
389
565
_global_option('no-backup')
390
_global_registry_option('merge-type', 'Select a particular merge algorithm',
566
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
391
567
_merge_type_registry, value_switches=True,
392
568
title='Merge algorithm')
393
569
_global_option('pattern', type=str)
394
_global_option('quiet', short_name='q')
395
570
_global_option('remember', help='Remember the specified location as a'
397
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
572
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
398
573
_global_option('kind', type=str)
399
574
_global_option('dry-run',
400
help="show what would be done, but don't actually do anything")
575
help="Show what would be done, but don't actually do anything.")
401
576
_global_option('name-from-revision', help='The path name in the old tree.')
404
# prior to 0.14 these were always globally registered; the old dict is
405
# available for plugins that use it but it should not be used.
406
Option.SHORT_OPTIONS = symbol_versioning.DeprecatedDict(
407
symbol_versioning.zero_fourteen,
410
'F': Option.OPTIONS['file'],
411
'h': Option.OPTIONS['help'],
412
'm': Option.OPTIONS['message'],
413
'r': Option.OPTIONS['revision'],
414
'v': Option.OPTIONS['verbose'],
415
'l': Option.OPTIONS['long'],
416
'q': Option.OPTIONS['quiet'],
418
'Set the short option name when constructing the Option.',
578
diff_writer_registry = _mod_registry.Registry()
579
diff_writer_registry.register('plain', lambda x: x, 'Plaintext diff output.')
580
diff_writer_registry.default_key = 'plain'