41
32
each revision specifier supplied.
43
34
>>> _parse_revision_str('234')
44
[<RevisionSpec_revno 234>]
35
[<RevisionSpec_int 234>]
45
36
>>> _parse_revision_str('234..567')
46
[<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
37
[<RevisionSpec_int 234>, <RevisionSpec_int 567>]
47
38
>>> _parse_revision_str('..')
48
39
[<RevisionSpec None>, <RevisionSpec None>]
49
40
>>> _parse_revision_str('..234')
50
[<RevisionSpec None>, <RevisionSpec_revno 234>]
41
[<RevisionSpec None>, <RevisionSpec_int 234>]
51
42
>>> _parse_revision_str('234..')
52
[<RevisionSpec_revno 234>, <RevisionSpec None>]
43
[<RevisionSpec_int 234>, <RevisionSpec None>]
53
44
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
54
[<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
45
[<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
55
46
>>> _parse_revision_str('234....789') #Error ?
56
[<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
47
[<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
57
48
>>> _parse_revision_str('revid:test@other.com-234234')
58
49
[<RevisionSpec_revid revid:test@other.com-234234>]
59
50
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
60
51
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
61
52
>>> _parse_revision_str('revid:test@other.com-234234..23')
62
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
53
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
63
54
>>> _parse_revision_str('date:2005-04-12')
64
55
[<RevisionSpec_date date:2005-04-12>]
65
56
>>> _parse_revision_str('date:2005-04-12 12:24:33')
69
60
>>> _parse_revision_str('date:2005-04-12,12:24:33')
70
61
[<RevisionSpec_date date:2005-04-12,12:24:33>]
71
62
>>> _parse_revision_str('-5..23')
72
[<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
63
[<RevisionSpec_int -5>, <RevisionSpec_int 23>]
73
64
>>> _parse_revision_str('-5')
74
[<RevisionSpec_revno -5>]
65
[<RevisionSpec_int -5>]
75
66
>>> _parse_revision_str('123a')
76
67
Traceback (most recent call last):
78
NoSuchRevisionSpec: No namespace registered for string: '123a'
69
BzrError: No namespace registered for string: '123a'
79
70
>>> _parse_revision_str('abc')
80
71
Traceback (most recent call last):
82
NoSuchRevisionSpec: No namespace registered for string: 'abc'
73
BzrError: No namespace registered for string: 'abc'
83
74
>>> _parse_revision_str('branch:../branch2')
84
75
[<RevisionSpec_branch branch:../branch2>]
85
76
>>> _parse_revision_str('branch:../../branch2')
86
77
[<RevisionSpec_branch branch:../../branch2>]
87
78
>>> _parse_revision_str('branch:../../branch2..23')
88
[<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
89
>>> _parse_revision_str('branch:..\\\\branch2')
90
[<RevisionSpec_branch branch:..\\branch2>]
91
>>> _parse_revision_str('branch:..\\\\..\\\\branch2..23')
92
[<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_revno 23>]
79
[<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_int 23>]
94
81
# TODO: Maybe move this into revisionspec.py
82
old_format_re = re.compile('\d*:\d*')
83
m = old_format_re.match(revstr)
96
# split on .. that is not followed by a / or \
97
sep = re.compile(r'\.\.(?![\\/])')
98
for x in sep.split(revstr):
99
revs.append(revisionspec.RevisionSpec.from_string(x or None))
86
warning('Colon separator for revision numbers is deprecated.'
88
for rev in revstr.split(':'):
90
revs.append(RevisionSpec(int(rev)))
92
revs.append(RevisionSpec(None))
94
sep = re.compile("\\.\\.(?!/)")
95
for x in sep.split(revstr):
96
revs.append(RevisionSpec(x or None))
103
def _parse_change_str(revstr):
104
"""Parse the revision string and return a tuple with left-most
105
parent of the revision.
107
>>> _parse_change_str('123')
108
(<RevisionSpec_before before:123>, <RevisionSpec_revno 123>)
109
>>> _parse_change_str('123..124')
110
Traceback (most recent call last):
112
RangeInChangeOption: Option --change does not accept revision ranges
114
revs = _parse_revision_str(revstr)
116
raise errors.RangeInChangeOption()
117
return (revisionspec.RevisionSpec.from_string('before:' + revstr),
121
100
def _parse_merge_type(typestring):
122
101
return get_merge_type(typestring)
132
111
type_list = '\n'.join(lines)
133
112
msg = "No known merge type %s. Supported types are:\n%s" %\
134
113
(typestring, type_list)
135
raise errors.BzrCommandError(msg)
114
raise BzrCommandError(msg)
138
116
class Option(object):
139
"""Description of a command line option
141
:ivar _short_name: If this option has a single-letter name, this is it.
145
# The dictionary of standard options. These are always legal.
148
# The dictionary of commonly used options. these are only legal
149
# if a command explicitly references them by name in the list
150
# of supported options.
117
"""Description of a command line option"""
118
# TODO: Some way to show in help a description of the option argument
153
def __init__(self, name, help='', type=None, argname=None,
154
short_name=None, param_name=None, custom_callback=None):
123
def __init__(self, name, help='', type=None, argname=None):
155
124
"""Make a new command option.
157
:param name: regular name of the command, used in the double-dash
126
name -- regular name of the command, used in the double-dash
158
127
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
130
help -- help message displayed in command help
132
type -- function called to parse the option argument, or
164
133
None (default) if this option doesn't take an argument.
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).
135
argname -- name of option argument, if any
137
# TODO: perhaps a subclass that automatically does
138
# --option, --no-option for reversible booleans
181
self._short_name = short_name
183
143
assert argname is None
184
144
elif argname is None:
186
146
self.argname = argname
187
if param_name is None:
188
self._param_name = self.name
190
self._param_name = param_name
191
self.custom_callback = custom_callback
193
148
def short_name(self):
195
return self._short_name
149
"""Return the single character option for this command, if any.
197
def set_short_name(self, short_name):
198
self._short_name = short_name
151
Short options are globally registered.
153
for short, option in Option.SHORT_OPTIONS.iteritems():
200
157
def get_negation_name(self):
201
158
if self.name.startswith('no-'):
249
195
argname = argname.upper()
250
196
yield self.name, self.short_name(), argname, self.help
252
def is_hidden(self, name):
256
class ListOption(Option):
257
"""Option used to provide a list of values.
259
On the command line, arguments are specified by a repeated use of the
260
option. '-' is a special argument that resets the list. For example,
262
sets the value of the 'foo' option to ['a', 'b'], and
263
--foo=a --foo=b --foo=- --foo=c
264
sets the value of the 'foo' option to ['c'].
267
def add_option(self, parser, short_name):
268
"""Add this option to an Optparse parser."""
269
option_strings = ['--%s' % self.name]
270
if short_name is not None:
271
option_strings.append('-%s' % short_name)
272
parser.add_option(action='callback',
273
callback=self._optparse_callback,
274
type='string', metavar=self.argname.upper(),
275
help=self.help, default=[],
278
def _optparse_callback(self, option, opt, value, parser):
279
values = getattr(parser.values, self._param_name)
283
values.append(self.type(value))
284
if self.custom_callback is not None:
285
self.custom_callback(option, self._param_name, values, parser)
288
class RegistryOption(Option):
289
"""Option based on a registry
291
The values for the options correspond to entries in the registry. Input
292
must be a registry key. After validation, it is converted into an object
293
using Registry.get or a caller-provided converter.
296
def validate_value(self, value):
297
"""Validate a value name"""
298
if value not in self.registry:
299
raise errors.BadOptionValue(self.name, value)
301
def convert(self, value):
302
"""Convert a value name into an output type"""
303
self.validate_value(value)
304
if self.converter is None:
305
return self.registry.get(value)
307
return self.converter(value)
309
def __init__(self, name, help, registry, converter=None,
310
value_switches=False, title=None, enum_switch=True):
314
:param name: The option name.
315
:param help: Help for the option.
316
:param registry: A Registry containing the values
317
:param converter: Callable to invoke with the value name to produce
318
the value. If not supplied, self.registry.get is used.
319
:param value_switches: If true, each possible value is assigned its
320
own switch. For example, instead of '--format knit',
321
'--knit' can be used interchangeably.
322
:param enum_switch: If true, a switch is provided with the option name,
325
Option.__init__(self, name, help, type=self.convert)
326
self.registry = registry
328
self.converter = converter
329
self.value_switches = value_switches
330
self.enum_switch = enum_switch
332
if self.title is None:
336
def from_kwargs(name_, help=None, title=None, value_switches=False,
337
enum_switch=True, **kwargs):
338
"""Convenience method to generate string-map registry options
340
name, help, value_switches and enum_switch are passed to the
341
RegistryOption constructor. Any other keyword arguments are treated
342
as values for the option, and they value is treated as the help.
344
reg = registry.Registry()
345
for name, switch_help in kwargs.iteritems():
346
name = name.replace('_', '-')
347
reg.register(name, name, help=switch_help)
348
return RegistryOption(name_, help, reg, title=title,
349
value_switches=value_switches, enum_switch=enum_switch)
351
def add_option(self, parser, short_name):
352
"""Add this option to an Optparse parser"""
353
if self.value_switches:
354
parser = parser.add_option_group(self.title)
356
Option.add_option(self, parser, short_name)
357
if self.value_switches:
358
for key in self.registry.keys():
359
option_strings = ['--%s' % key]
360
if self.is_hidden(key):
361
help = optparse.SUPPRESS_HELP
363
help = self.registry.get_help(key)
364
parser.add_option(action='callback',
365
callback=self._optparse_value_callback(key),
369
def _optparse_value_callback(self, cb_value):
370
def cb(option, opt, value, parser):
371
v = self.type(cb_value)
372
setattr(parser.values, self._param_name, v)
373
if self.custom_callback is not None:
374
self.custom_callback(option, self._param_name, v, parser)
377
def iter_switches(self):
378
"""Iterate through the list of switches provided by the option
380
:return: an iterator of (name, short_name, argname, help)
382
for value in Option.iter_switches(self):
384
if self.value_switches:
385
for key in sorted(self.registry.keys()):
386
yield key, None, None, self.registry.get_help(key)
388
def is_hidden(self, name):
389
if name == self.name:
390
return Option.is_hidden(self, name)
391
return getattr(self.registry.get_info(name), 'hidden', False)
394
199
class OptionParser(optparse.OptionParser):
395
200
"""OptionParser that raises exceptions instead of exiting"""
406
211
parser = OptionParser()
407
212
parser.remove_option('--help')
213
short_options = dict((k.name, v) for v, k in
214
Option.SHORT_OPTIONS.iteritems())
408
215
for option in options.itervalues():
409
option.add_option(parser, option.short_name())
216
option.add_option(parser, short_options.get(option.name))
413
def custom_help(name, help):
414
"""Clone a common option overriding the help."""
416
o = copy.copy(Option.OPTIONS[name])
421
def _standard_option(name, **kwargs):
422
"""Register a standard option."""
423
# All standard options are implicitly 'global' ones
424
Option.STD_OPTIONS[name] = Option(name, **kwargs)
425
Option.OPTIONS[name] = Option.STD_OPTIONS[name]
428
220
def _global_option(name, **kwargs):
429
"""Register a global option."""
221
"""Register o as a global option."""
430
222
Option.OPTIONS[name] = Option(name, **kwargs)
433
def _global_registry_option(name, help, registry, **kwargs):
434
Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
437
class MergeTypeRegistry(registry.Registry):
442
# This is the verbosity level detected during command line parsing.
443
# Note that the final value is dependent on the order in which the
444
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
445
# The final value will be one of the following:
453
def _verbosity_level_callback(option, opt_str, value, parser):
454
global _verbosity_level
456
# Either --no-verbose or --no-quiet was specified
458
elif opt_str == "verbose":
459
if _verbosity_level > 0:
460
_verbosity_level += 1
464
if _verbosity_level < 0:
465
_verbosity_level -= 1
467
_verbosity_level = -1
470
_merge_type_registry = MergeTypeRegistry()
471
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
472
"Native diff3-style merge")
473
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
474
"Merge using external diff3")
475
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
478
# Declare the standard options
479
_standard_option('help', short_name='h',
480
help='Show help message.')
481
_standard_option('verbose', short_name='v',
482
help='Display more information.',
483
custom_callback=_verbosity_level_callback)
484
_standard_option('quiet', short_name='q',
485
help="Only display errors and warnings.",
486
custom_callback=_verbosity_level_callback)
488
# Declare commonly used options
489
224
_global_option('all')
490
225
_global_option('overwrite', help='Ignore differences between branches and '
491
'overwrite unconditionally.')
226
'overwrite unconditionally')
492
227
_global_option('basis', type=str)
493
228
_global_option('bound')
494
229
_global_option('diff-options', type=str)
495
_global_option('file', type=unicode, short_name='F')
230
_global_option('help',
231
help='show help message')
232
_global_option('file', type=unicode)
496
233
_global_option('force')
497
234
_global_option('format', type=unicode)
498
235
_global_option('forward')
499
_global_option('message', type=unicode,
501
help='Message string.')
236
_global_option('message', type=unicode)
502
237
_global_option('no-recurse')
238
_global_option('prefix', type=str,
239
help='Set prefixes to added to old and new filenames, as '
240
'two values separated by a colon.')
503
241
_global_option('profile',
504
help='Show performance profiling information.')
505
_global_option('revision',
506
type=_parse_revision_str,
508
help='See "help revisionspec" for details.')
509
_global_option('change',
510
type=_parse_change_str,
512
param_name='revision',
513
help='Select changes introduced by the specified revision. See also "help revisionspec".')
514
_global_option('show-ids',
515
help='Show internal object ids.')
242
help='show performance profiling information')
243
_global_option('revision', type=_parse_revision_str)
244
_global_option('show-ids',
245
help='show internal object ids')
516
246
_global_option('timezone',
518
248
help='display timezone as local, original, or utc')
519
249
_global_option('unbound')
250
_global_option('verbose',
251
help='display more information')
520
252
_global_option('version')
521
253
_global_option('email')
522
254
_global_option('update')
523
_global_registry_option('log-format', "Use specified log format.",
524
log.log_formatter_registry, value_switches=True,
526
_global_option('long', help='Use detailed log format. Same as --log-format long',
255
_global_option('log-format', type=str, help="Use this log format")
256
_global_option('long', help='Use detailed log format. Same as --log-format long')
528
257
_global_option('short', help='Use moderately short log format. Same as --log-format short')
529
258
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
530
259
_global_option('root', type=str)
531
260
_global_option('no-backup')
532
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
533
_merge_type_registry, value_switches=True,
534
title='Merge algorithm')
261
_global_option('merge-type', type=_parse_merge_type,
262
help='Select a particular merge algorithm')
535
263
_global_option('pattern', type=str)
264
_global_option('quiet')
536
265
_global_option('remember', help='Remember the specified location as a'
538
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
267
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
539
268
_global_option('kind', type=str)
540
269
_global_option('dry-run',
541
help="Show what would be done, but don't actually do anything.")
542
_global_option('name-from-revision', help='The path name in the old tree.')
270
help="show what would be done, but don't actually do anything")
273
def _global_short(short_name, long_name):
274
assert short_name not in Option.SHORT_OPTIONS
275
Option.SHORT_OPTIONS[short_name] = Option.OPTIONS[long_name]
278
Option.SHORT_OPTIONS['F'] = Option.OPTIONS['file']
279
Option.SHORT_OPTIONS['h'] = Option.OPTIONS['help']
280
Option.SHORT_OPTIONS['m'] = Option.OPTIONS['message']
281
Option.SHORT_OPTIONS['r'] = Option.OPTIONS['revision']
282
Option.SHORT_OPTIONS['v'] = Option.OPTIONS['verbose']
283
Option.SHORT_OPTIONS['l'] = Option.OPTIONS['long']
284
Option.SHORT_OPTIONS['q'] = Option.OPTIONS['quiet']
285
Option.SHORT_OPTIONS['p'] = Option.OPTIONS['prefix']
added
removed
bzrlib/option.py
