131
110
type_list = '\n'.join(lines)
132
111
msg = "No known merge type %s. Supported types are:\n%s" %\
133
112
(typestring, type_list)
134
raise errors.BzrCommandError(msg)
113
raise BzrCommandError(msg)
137
115
class Option(object):
138
"""Description of a command line option
140
:ivar _short_name: If this option has a single-letter name, this is it.
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.
116
"""Description of a command line option"""
117
# TODO: Some way to show in help a description of the option argument
152
def __init__(self, name, help='', type=None, argname=None,
153
short_name=None, param_name=None, custom_callback=None,
122
def __init__(self, name, help='', type=None, argname=None):
155
123
"""Make a new command option.
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
125
name -- regular name of the command, used in the double-dash
126
form and also as the parameter to the command's run()
129
help -- help message displayed in command help
131
type -- function called to parse the option argument, or
164
132
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).
177
:param hidden: If True, the option should be hidden in help and
134
argname -- name of option argument, if any
136
# TODO: perhaps a subclass that automatically does
137
# --option, --no-option for reversible booleans
183
self._short_name = short_name
186
raise ValueError('argname not valid for booleans')
142
assert argname is None
187
143
elif argname is None:
189
145
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
197
147
def short_name(self):
199
return self._short_name
201
def set_short_name(self, short_name):
202
self._short_name = short_name
204
def get_negation_name(self):
205
if self.name.startswith('no-'):
208
return 'no-' + self.name
210
def add_option(self, parser, short_name):
211
"""Add this option to an Optparse parser"""
212
option_strings = ['--%s' % self.name]
213
if short_name is not None:
214
option_strings.append('-%s' % short_name)
216
help = optparse.SUPPRESS_HELP
221
parser.add_option(action='callback',
222
callback=self._optparse_bool_callback,
223
callback_args=(True,),
226
negation_strings = ['--%s' % self.get_negation_name()]
227
parser.add_option(action='callback',
228
callback=self._optparse_bool_callback,
229
callback_args=(False,),
230
help=optparse.SUPPRESS_HELP, *negation_strings)
232
parser.add_option(action='callback',
233
callback=self._optparse_callback,
234
type='string', metavar=self.argname.upper(),
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)
244
def _optparse_callback(self, option, opt, value, parser):
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)
250
def iter_switches(self):
251
"""Iterate through the list of switches provided by the option
253
:return: an iterator of (name, short_name, argname, help)
255
argname = self.argname
256
if argname is not None:
257
argname = argname.upper()
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)
296
class RegistryOption(Option):
297
"""Option based on a registry
299
The values for the options correspond to entries in the registry. Input
300
must be a registry key. After validation, it is converted into an object
301
using Registry.get or a caller-provided converter.
304
def validate_value(self, value):
305
"""Validate a value name"""
306
if value not in self.registry:
307
raise errors.BadOptionValue(self.name, value)
309
def convert(self, value):
310
"""Convert a value name into an output type"""
311
self.validate_value(value)
312
if self.converter is None:
313
return self.registry.get(value)
315
return self.converter(value)
317
def __init__(self, name, help, registry=None, converter=None,
318
value_switches=False, title=None, enum_switch=True,
323
:param name: The option name.
324
:param help: Help for the option.
325
:param registry: A Registry containing the values
326
:param converter: Callable to invoke with the value name to produce
327
the value. If not supplied, self.registry.get is used.
328
:param value_switches: If true, each possible value is assigned its
329
own switch. For example, instead of '--format knit',
330
'--knit' can be used interchangeably.
331
:param enum_switch: If true, a switch is provided with the option name,
333
:param lazy_registry: A tuple of (module name, attribute name) for a
334
registry to be lazily loaded.
336
Option.__init__(self, name, help, type=self.convert)
337
self._registry = registry
339
if lazy_registry is None:
340
raise AssertionError(
341
'One of registry or lazy_registry must be given.')
342
self._lazy_registry = _mod_registry._LazyObjectGetter(
344
if registry is not None and lazy_registry is not None:
345
raise AssertionError(
346
'registry and lazy_registry are mutually exclusive')
348
self.converter = converter
349
self.value_switches = value_switches
350
self.enum_switch = enum_switch
352
if self.title is None:
357
if self._registry is None:
358
self._registry = self._lazy_registry.get_obj()
359
return self._registry
362
def from_kwargs(name_, help=None, title=None, value_switches=False,
363
enum_switch=True, **kwargs):
364
"""Convenience method to generate string-map registry options
366
name, help, value_switches and enum_switch are passed to the
367
RegistryOption constructor. Any other keyword arguments are treated
368
as values for the option, and they value is treated as the help.
370
reg = _mod_registry.Registry()
371
for name, switch_help in kwargs.iteritems():
372
name = name.replace('_', '-')
373
reg.register(name, name, help=switch_help)
374
if not value_switches:
375
help = help + ' "' + name + '": ' + switch_help
376
if not help.endswith("."):
378
return RegistryOption(name_, help, reg, title=title,
379
value_switches=value_switches, enum_switch=enum_switch)
381
def add_option(self, parser, short_name):
382
"""Add this option to an Optparse parser"""
383
if self.value_switches:
384
parser = parser.add_option_group(self.title)
386
Option.add_option(self, parser, short_name)
387
if self.value_switches:
388
for key in self.registry.keys():
389
option_strings = ['--%s' % key]
390
if self.is_hidden(key):
391
help = optparse.SUPPRESS_HELP
393
help = self.registry.get_help(key)
394
parser.add_option(action='callback',
395
callback=self._optparse_value_callback(key),
399
def _optparse_value_callback(self, cb_value):
400
def cb(option, opt, value, parser):
401
v = self.type(cb_value)
402
setattr(parser.values, self._param_name, v)
403
if self.custom_callback is not None:
404
self.custom_callback(option, self._param_name, v, parser)
407
def iter_switches(self):
408
"""Iterate through the list of switches provided by the option
410
:return: an iterator of (name, short_name, argname, help)
412
for value in Option.iter_switches(self):
414
if self.value_switches:
415
for key in sorted(self.registry.keys()):
416
yield key, None, None, self.registry.get_help(key)
418
def is_hidden(self, name):
419
if name == self.name:
420
return Option.is_hidden(self, name)
421
return getattr(self.registry.get_info(name), 'hidden', False)
424
class OptionParser(optparse.OptionParser):
425
"""OptionParser that raises exceptions instead of exiting"""
427
DEFAULT_VALUE = object()
429
def error(self, message):
430
raise errors.BzrCommandError(message)
433
def get_optparser(options):
434
"""Generate an optparse parser for bzrlib-style options"""
436
parser = OptionParser()
437
parser.remove_option('--help')
438
for option in options.itervalues():
439
option.add_option(parser, option.short_name())
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]
148
"""Return the single character option for this command, if any.
150
Short options are globally registered.
152
for short, option in Option.SHORT_OPTIONS.iteritems():
458
157
def _global_option(name, **kwargs):
459
"""Register a global option."""
158
"""Register o as a global option."""
460
159
Option.OPTIONS[name] = Option(name, **kwargs)
463
def _global_registry_option(name, help, registry=None, **kwargs):
464
Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
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):
500
_merge_type_registry = MergeTypeRegistry()
501
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
502
"Native diff3-style merge")
503
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
504
"Merge using external diff3")
505
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
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
523
161
_global_option('all')
524
162
_global_option('overwrite', help='Ignore differences between branches and '
525
'overwrite unconditionally.')
163
'overwrite unconditionally')
526
164
_global_option('basis', type=str)
527
165
_global_option('bound')
528
166
_global_option('diff-options', type=str)
529
_global_option('file', type=unicode, short_name='F')
167
_global_option('help',
168
help='show help message')
169
_global_option('file', type=unicode)
530
170
_global_option('force')
531
171
_global_option('format', type=unicode)
532
172
_global_option('forward')
533
_global_option('message', type=unicode,
535
help='Message string.')
173
_global_option('message', type=unicode)
536
174
_global_option('no-recurse')
175
_global_option('prefix', type=str,
176
help='Set prefixes to added to old and new filenames, as '
177
'two values separated by a colon.')
537
178
_global_option('profile',
538
help='Show performance profiling information.')
539
_global_option('revision',
540
type=_parse_revision_str,
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',
179
help='show performance profiling information')
180
_global_option('revision', type=_parse_revision_str)
181
_global_option('show-ids',
182
help='show internal object ids')
183
_global_option('timezone',
552
help='Display timezone as local, original, or utc.')
185
help='display timezone as local, original, or utc')
553
186
_global_option('unbound')
187
_global_option('verbose',
188
help='display more information')
554
189
_global_option('version')
555
190
_global_option('email')
556
191
_global_option('update')
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')
560
_global_option('long', help='Use detailed log format. Same as --log-format long',
192
_global_option('log-format', type=str, help="Use this log format")
193
_global_option('long', help='Use detailed log format. Same as --log-format long')
562
194
_global_option('short', help='Use moderately short log format. Same as --log-format short')
563
195
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
564
196
_global_option('root', type=str)
565
197
_global_option('no-backup')
566
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
567
_merge_type_registry, value_switches=True,
568
title='Merge algorithm')
198
_global_option('merge-type', type=_parse_merge_type,
199
help='Select a particular merge algorithm')
569
200
_global_option('pattern', type=str)
201
_global_option('quiet')
570
202
_global_option('remember', help='Remember the specified location as a'
572
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
204
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
573
205
_global_option('kind', type=str)
574
206
_global_option('dry-run',
575
help="Show what would be done, but don't actually do anything.")
576
_global_option('name-from-revision', help='The path name in the old tree.')
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'
207
help="show what would be done, but don't actually do anything")
210
def _global_short(short_name, long_name):
211
assert short_name not in Option.SHORT_OPTIONS
212
Option.SHORT_OPTIONS[short_name] = Option.OPTIONS[long_name]
215
Option.SHORT_OPTIONS['F'] = Option.OPTIONS['file']
216
Option.SHORT_OPTIONS['h'] = Option.OPTIONS['help']
217
Option.SHORT_OPTIONS['m'] = Option.OPTIONS['message']
218
Option.SHORT_OPTIONS['r'] = Option.OPTIONS['revision']
219
Option.SHORT_OPTIONS['v'] = Option.OPTIONS['verbose']
220
Option.SHORT_OPTIONS['l'] = Option.OPTIONS['long']
221
Option.SHORT_OPTIONS['q'] = Option.OPTIONS['quiet']
222
Option.SHORT_OPTIONS['p'] = Option.OPTIONS['prefix']
added
removed
bzrlib/option.py
