41
43
each revision specifier supplied.
43
45
>>> _parse_revision_str('234')
44
[<RevisionSpec_revno 234>]
46
[<RevisionSpec_dwim 234>]
45
47
>>> _parse_revision_str('234..567')
46
[<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
48
[<RevisionSpec_dwim 234>, <RevisionSpec_dwim 567>]
47
49
>>> _parse_revision_str('..')
48
50
[<RevisionSpec None>, <RevisionSpec None>]
49
51
>>> _parse_revision_str('..234')
50
[<RevisionSpec None>, <RevisionSpec_revno 234>]
52
[<RevisionSpec None>, <RevisionSpec_dwim 234>]
51
53
>>> _parse_revision_str('234..')
52
[<RevisionSpec_revno 234>, <RevisionSpec None>]
54
[<RevisionSpec_dwim 234>, <RevisionSpec None>]
53
55
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
54
[<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
56
[<RevisionSpec_dwim 234>, <RevisionSpec_dwim 456>, <RevisionSpec_dwim 789>]
55
57
>>> _parse_revision_str('234....789') #Error ?
56
[<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
58
[<RevisionSpec_dwim 234>, <RevisionSpec None>, <RevisionSpec_dwim 789>]
57
59
>>> _parse_revision_str('revid:test@other.com-234234')
58
60
[<RevisionSpec_revid revid:test@other.com-234234>]
59
61
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
60
62
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
61
63
>>> _parse_revision_str('revid:test@other.com-234234..23')
62
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
64
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_dwim 23>]
63
65
>>> _parse_revision_str('date:2005-04-12')
64
66
[<RevisionSpec_date date:2005-04-12>]
65
67
>>> _parse_revision_str('date:2005-04-12 12:24:33')
69
71
>>> _parse_revision_str('date:2005-04-12,12:24:33')
70
72
[<RevisionSpec_date date:2005-04-12,12:24:33>]
71
73
>>> _parse_revision_str('-5..23')
72
[<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
74
[<RevisionSpec_dwim -5>, <RevisionSpec_dwim 23>]
73
75
>>> _parse_revision_str('-5')
74
[<RevisionSpec_revno -5>]
76
[<RevisionSpec_dwim -5>]
75
77
>>> _parse_revision_str('123a')
76
Traceback (most recent call last):
78
NoSuchRevisionSpec: No namespace registered for string: '123a'
78
[<RevisionSpec_dwim 123a>]
79
79
>>> _parse_revision_str('abc')
80
Traceback (most recent call last):
82
NoSuchRevisionSpec: No namespace registered for string: 'abc'
80
[<RevisionSpec_dwim abc>]
83
81
>>> _parse_revision_str('branch:../branch2')
84
82
[<RevisionSpec_branch branch:../branch2>]
85
83
>>> _parse_revision_str('branch:../../branch2')
86
84
[<RevisionSpec_branch branch:../../branch2>]
87
85
>>> _parse_revision_str('branch:../../branch2..23')
88
[<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
86
[<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_dwim 23>]
87
>>> _parse_revision_str('branch:..\\\\branch2')
88
[<RevisionSpec_branch branch:..\\branch2>]
89
>>> _parse_revision_str('branch:..\\\\..\\\\branch2..23')
90
[<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_dwim 23>]
90
92
# TODO: Maybe move this into revisionspec.py
92
# split on the first .. that is not followed by a / ?
93
sep = re.compile("\\.\\.(?!/)")
94
# split on .. that is not followed by a / or \
95
sep = re.compile(r'\.\.(?![\\/])')
94
96
for x in sep.split(revstr):
95
97
revs.append(revisionspec.RevisionSpec.from_string(x or None))
101
def _parse_change_str(revstr):
102
"""Parse the revision string and return a tuple with left-most
103
parent of the revision.
105
>>> _parse_change_str('123')
106
(<RevisionSpec_before before:123>, <RevisionSpec_dwim 123>)
107
>>> _parse_change_str('123..124')
108
Traceback (most recent call last):
110
RangeInChangeOption: Option --change does not accept revision ranges
112
revs = _parse_revision_str(revstr)
114
raise errors.RangeInChangeOption()
115
return (revisionspec.RevisionSpec.from_string('before:' + revstr),
99
119
def _parse_merge_type(typestring):
100
120
return get_merge_type(typestring)
116
136
class Option(object):
117
137
"""Description of a command line option
119
139
: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
143
# The dictionary of standard options. These are always legal.
146
# The dictionary of commonly used options. these are only legal
147
# if a command explicitly references them by name in the list
148
# of supported options.
127
151
def __init__(self, name, help='', type=None, argname=None,
152
short_name=None, param_name=None, custom_callback=None,
129
154
"""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
156
:param name: regular name of the command, used in the double-dash
157
form and also as the parameter to the command's run()
158
method (unless param_name is specified).
160
:param help: help message displayed in command help
162
:param type: function called to parse the option argument, or
138
163
None (default) if this option doesn't take an argument.
140
argname -- name of option argument, if any
165
:param argname: name of option argument, if any
167
:param short_name: short option code for use with a single -, e.g.
168
short_name="v" to enable parsing of -v.
170
:param param_name: name of the parameter which will be passed to
171
the command's run() method.
173
:param custom_callback: a callback routine to be called after normal
174
processing. The signature of the callback routine is
175
(option, name, new_value, parser).
176
:param hidden: If True, the option should be hidden in help and
145
182
self._short_name = short_name
147
assert argname is None
185
raise ValueError('argname not valid for booleans')
148
186
elif argname is None:
150
188
self.argname = argname
189
if param_name is None:
190
self._param_name = self.name.replace('-', '_')
192
self._param_name = param_name
193
self.custom_callback = custom_callback
152
196
def short_name(self):
153
197
if self._short_name:
154
198
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
200
def set_short_name(self, short_name):
164
201
self._short_name = short_name
174
211
option_strings = ['--%s' % self.name]
175
212
if short_name is not None:
176
213
option_strings.append('-%s' % short_name)
215
help = optparse.SUPPRESS_HELP
177
218
optargfn = self.type
178
219
if optargfn is None:
179
parser.add_option(action='store_true', dest=self.name,
181
default=OptionParser.DEFAULT_VALUE,
220
parser.add_option(action='callback',
221
callback=self._optparse_bool_callback,
222
callback_args=(True,),
183
225
negation_strings = ['--%s' % self.get_negation_name()]
184
parser.add_option(action='store_false', dest=self.name,
226
parser.add_option(action='callback',
227
callback=self._optparse_bool_callback,
228
callback_args=(False,),
185
229
help=optparse.SUPPRESS_HELP, *negation_strings)
187
parser.add_option(action='callback',
188
callback=self._optparse_callback,
231
parser.add_option(action='callback',
232
callback=self._optparse_callback,
189
233
type='string', metavar=self.argname.upper(),
191
default=OptionParser.DEFAULT_VALUE,
235
default=OptionParser.DEFAULT_VALUE,
238
def _optparse_bool_callback(self, option, opt_str, value, parser, bool_v):
239
setattr(parser.values, self._param_name, bool_v)
240
if self.custom_callback is not None:
241
self.custom_callback(option, self._param_name, bool_v, parser)
194
243
def _optparse_callback(self, option, opt, value, parser):
195
setattr(parser.values, self.name, self.type(value))
245
setattr(parser.values, self._param_name, v)
246
if self.custom_callback is not None:
247
self.custom_callback(option, self.name, v, parser)
197
249
def iter_switches(self):
198
250
"""Iterate through the list of switches provided by the option
200
252
:return: an iterator of (name, short_name, argname, help)
202
254
argname = self.argname
204
256
argname = argname.upper()
205
257
yield self.name, self.short_name(), argname, self.help
259
def is_hidden(self, name):
263
class ListOption(Option):
264
"""Option used to provide a list of values.
266
On the command line, arguments are specified by a repeated use of the
267
option. '-' is a special argument that resets the list. For example,
269
sets the value of the 'foo' option to ['a', 'b'], and
270
--foo=a --foo=b --foo=- --foo=c
271
sets the value of the 'foo' option to ['c'].
274
def add_option(self, parser, short_name):
275
"""Add this option to an Optparse parser."""
276
option_strings = ['--%s' % self.name]
277
if short_name is not None:
278
option_strings.append('-%s' % short_name)
279
parser.add_option(action='callback',
280
callback=self._optparse_callback,
281
type='string', metavar=self.argname.upper(),
282
help=self.help, dest=self._param_name, default=[],
285
def _optparse_callback(self, option, opt, value, parser):
286
values = getattr(parser.values, self._param_name)
290
values.append(self.type(value))
291
if self.custom_callback is not None:
292
self.custom_callback(option, self._param_name, values, parser)
208
295
class RegistryOption(Option):
209
296
"""Option based on a registry
466
def custom_help(name, help):
467
"""Clone a common option overriding the help."""
469
o = copy.copy(Option.OPTIONS[name])
474
def _standard_option(name, **kwargs):
475
"""Register a standard option."""
476
# All standard options are implicitly 'global' ones
477
Option.STD_OPTIONS[name] = Option(name, **kwargs)
478
Option.OPTIONS[name] = Option.STD_OPTIONS[name]
480
def _standard_list_option(name, **kwargs):
481
"""Register a standard option."""
482
# All standard options are implicitly 'global' ones
483
Option.STD_OPTIONS[name] = ListOption(name, **kwargs)
484
Option.OPTIONS[name] = Option.STD_OPTIONS[name]
325
487
def _global_option(name, **kwargs):
326
"""Register o as a global option."""
488
"""Register a global option."""
327
489
Option.OPTIONS[name] = Option(name, **kwargs)
330
def _global_registry_option(name, help, registry, **kwargs):
492
def _global_registry_option(name, help, registry=None, **kwargs):
331
493
Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
334
class MergeTypeRegistry(registry.Registry):
339
_merge_type_registry = MergeTypeRegistry()
340
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
341
"Native diff3-style merge")
342
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
343
"Merge using external diff3")
344
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
347
_global_option('all')
348
_global_option('overwrite', help='Ignore differences between branches and '
349
'overwrite unconditionally')
350
_global_option('basis', type=str)
351
_global_option('bound')
352
_global_option('diff-options', type=str)
353
_global_option('help',
354
help='show help message',
496
# This is the verbosity level detected during command line parsing.
497
# Note that the final value is dependent on the order in which the
498
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
499
# The final value will be one of the following:
507
def _verbosity_level_callback(option, opt_str, value, parser):
508
global _verbosity_level
510
# Either --no-verbose or --no-quiet was specified
512
elif opt_str == "verbose":
513
if _verbosity_level > 0:
514
_verbosity_level += 1
518
if _verbosity_level < 0:
519
_verbosity_level -= 1
521
_verbosity_level = -1
524
# Declare the standard options
525
_standard_option('help', short_name='h',
526
help='Show help message.')
527
_standard_option('quiet', short_name='q',
528
help="Only display errors and warnings.",
529
custom_callback=_verbosity_level_callback)
530
_standard_option('usage',
531
help='Show usage message and options.')
532
_standard_option('verbose', short_name='v',
533
help='Display more information.',
534
custom_callback=_verbosity_level_callback)
536
# Declare commonly used options
537
_global_option('change',
538
type=_parse_change_str,
540
param_name='revision',
541
help='Select changes introduced by the specified revision. See also "help revisionspec".')
542
_global_option('directory', short_name='d', type=unicode,
543
help='Branch to operate on, instead of working directory.')
356
544
_global_option('file', type=unicode, short_name='F')
357
_global_option('force')
358
_global_option('format', type=unicode)
359
_global_option('forward')
545
_global_registry_option('log-format', "Use specified log format.",
546
lazy_registry=('bzrlib.log', 'log_formatter_registry'),
547
value_switches=True, title='Log format',
548
short_value_switches={'short': 'S'})
549
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
550
lazy_registry=('bzrlib.merge', 'merge_type_registry'),
551
value_switches=True, title='Merge algorithm')
360
552
_global_option('message', type=unicode,
362
_global_option('no-recurse')
363
_global_option('profile',
364
help='show performance profiling information')
554
help='Message string.')
555
_global_option('null', short_name='0',
556
help='Use an ASCII NUL (\\0) separator rather than '
558
_global_option('overwrite', help='Ignore differences between branches and '
559
'overwrite unconditionally.')
560
_global_option('remember', help='Remember the specified location as a'
562
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
365
563
_global_option('revision',
366
564
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',
566
help='See "help revisionspec" for details.')
567
_global_option('show-ids',
568
help='Show internal object ids.')
569
_global_option('timezone',
373
help='display timezone as local, original, or utc')
374
_global_option('unbound')
375
_global_option('verbose',
376
help='display more information',
378
_global_option('version')
379
_global_option('email')
380
_global_option('update')
381
_global_registry_option('log-format', "Use this log format",
382
log.log_formatter_registry, value_switches=True,
384
_global_option('long', help='Use detailed log format. Same as --log-format long',
386
_global_option('short', help='Use moderately short log format. Same as --log-format short')
387
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
388
_global_option('root', type=str)
389
_global_option('no-backup')
390
_global_registry_option('merge-type', 'Select a particular merge algorithm',
391
_merge_type_registry, value_switches=True,
392
title='Merge algorithm')
393
_global_option('pattern', type=str)
394
_global_option('quiet', short_name='q')
395
_global_option('remember', help='Remember the specified location as a'
397
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
398
_global_option('kind', type=str)
399
_global_option('dry-run',
400
help="show what would be done, but don't actually do anything")
401
_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.',
571
help='Display timezone as local, original, or utc.')
573
diff_writer_registry = _mod_registry.Registry()
574
diff_writer_registry.register('plain', lambda x: x, 'Plaintext diff output.')
575
diff_writer_registry.default_key = 'plain'