1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
# TODO: For things like --diff-prefix, we want a way to customize the display
18
# of the option argument.
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
32
registry as _mod_registry,
36
def _parse_revision_str(revstr):
37
"""This handles a revision string -> revno.
39
This always returns a list. The list will have one element for
40
each revision specifier supplied.
42
>>> _parse_revision_str('234')
43
[<RevisionSpec_dwim 234>]
44
>>> _parse_revision_str('234..567')
45
[<RevisionSpec_dwim 234>, <RevisionSpec_dwim 567>]
46
>>> _parse_revision_str('..')
47
[<RevisionSpec None>, <RevisionSpec None>]
48
>>> _parse_revision_str('..234')
49
[<RevisionSpec None>, <RevisionSpec_dwim 234>]
50
>>> _parse_revision_str('234..')
51
[<RevisionSpec_dwim 234>, <RevisionSpec None>]
52
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
53
[<RevisionSpec_dwim 234>, <RevisionSpec_dwim 456>, <RevisionSpec_dwim 789>]
54
>>> _parse_revision_str('234....789') #Error ?
55
[<RevisionSpec_dwim 234>, <RevisionSpec None>, <RevisionSpec_dwim 789>]
56
>>> _parse_revision_str('revid:test@other.com-234234')
57
[<RevisionSpec_revid revid:test@other.com-234234>]
58
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
59
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
60
>>> _parse_revision_str('revid:test@other.com-234234..23')
61
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_dwim 23>]
62
>>> _parse_revision_str('date:2005-04-12')
63
[<RevisionSpec_date date:2005-04-12>]
64
>>> _parse_revision_str('date:2005-04-12 12:24:33')
65
[<RevisionSpec_date date:2005-04-12 12:24:33>]
66
>>> _parse_revision_str('date:2005-04-12T12:24:33')
67
[<RevisionSpec_date date:2005-04-12T12:24:33>]
68
>>> _parse_revision_str('date:2005-04-12,12:24:33')
69
[<RevisionSpec_date date:2005-04-12,12:24:33>]
70
>>> _parse_revision_str('-5..23')
71
[<RevisionSpec_dwim -5>, <RevisionSpec_dwim 23>]
72
>>> _parse_revision_str('-5')
73
[<RevisionSpec_dwim -5>]
74
>>> _parse_revision_str('123a')
75
[<RevisionSpec_dwim 123a>]
76
>>> _parse_revision_str('abc')
77
[<RevisionSpec_dwim abc>]
78
>>> _parse_revision_str('branch:../branch2')
79
[<RevisionSpec_branch branch:../branch2>]
80
>>> _parse_revision_str('branch:../../branch2')
81
[<RevisionSpec_branch branch:../../branch2>]
82
>>> _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>]
89
# TODO: Maybe move this into revisionspec.py
91
# split on .. that is not followed by a / or \
92
sep = re.compile(r'\.\.(?![\\/])')
93
for x in sep.split(revstr):
94
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
def _parse_merge_type(typestring):
117
return get_merge_type(typestring)
119
def get_merge_type(typestring):
120
"""Attempt to find the merge class/factory associated with a string."""
121
from merge import merge_types
123
return merge_types[typestring][0]
125
templ = '%s%%7s: %%s' % (' '*12)
126
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
127
type_list = '\n'.join(lines)
128
msg = "No known merge type %s. Supported types are:\n%s" %\
129
(typestring, type_list)
130
raise errors.BzrCommandError(msg)
133
class Option(object):
134
"""Description of a command line option
136
:ivar _short_name: If this option has a single-letter name, this is it.
140
# The dictionary of standard options. These are always legal.
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
def __init__(self, name, help='', type=None, argname=None,
149
short_name=None, param_name=None, custom_callback=None,
151
"""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
160
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
179
self._short_name = short_name
182
raise ValueError('argname not valid for booleans')
183
elif argname is None:
185
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
def short_name(self):
195
return self._short_name
197
def set_short_name(self, short_name):
198
self._short_name = short_name
200
def get_negation_name(self):
201
if self.name.startswith('no-'):
204
return 'no-' + self.name
206
def add_option(self, parser, short_name):
207
"""Add this option to an Optparse parser"""
208
option_strings = ['--%s' % self.name]
209
if short_name is not None:
210
option_strings.append('-%s' % short_name)
212
help = optparse.SUPPRESS_HELP
217
parser.add_option(action='callback',
218
callback=self._optparse_bool_callback,
219
callback_args=(True,),
222
negation_strings = ['--%s' % self.get_negation_name()]
223
parser.add_option(action='callback',
224
callback=self._optparse_bool_callback,
225
callback_args=(False,),
226
help=optparse.SUPPRESS_HELP, *negation_strings)
228
parser.add_option(action='callback',
229
callback=self._optparse_callback,
230
type='string', metavar=self.argname.upper(),
232
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
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)
246
def iter_switches(self):
247
"""Iterate through the list of switches provided by the option
249
:return: an iterator of (name, short_name, argname, help)
251
argname = self.argname
252
if argname is not None:
253
argname = argname.upper()
254
yield self.name, self.short_name(), argname, self.help
256
def is_hidden(self, name):
260
class ListOption(Option):
261
"""Option used to provide a list of values.
263
On the command line, arguments are specified by a repeated use of the
264
option. '-' is a special argument that resets the list. For example,
266
sets the value of the 'foo' option to ['a', 'b'], and
267
--foo=a --foo=b --foo=- --foo=c
268
sets the value of the 'foo' option to ['c'].
271
def add_option(self, parser, short_name):
272
"""Add this option to an Optparse parser."""
273
option_strings = ['--%s' % self.name]
274
if short_name is not None:
275
option_strings.append('-%s' % short_name)
276
parser.add_option(action='callback',
277
callback=self._optparse_callback,
278
type='string', metavar=self.argname.upper(),
279
help=self.help, dest=self._param_name, default=[],
282
def _optparse_callback(self, option, opt, value, parser):
283
values = getattr(parser.values, self._param_name)
287
values.append(self.type(value))
288
if self.custom_callback is not None:
289
self.custom_callback(option, self._param_name, values, parser)
292
class RegistryOption(Option):
293
"""Option based on a registry
295
The values for the options correspond to entries in the registry. Input
296
must be a registry key. After validation, it is converted into an object
297
using Registry.get or a caller-provided converter.
300
def validate_value(self, value):
301
"""Validate a value name"""
302
if value not in self.registry:
303
raise errors.BadOptionValue(self.name, value)
305
def convert(self, value):
306
"""Convert a value name into an output type"""
307
self.validate_value(value)
308
if self.converter is None:
309
return self.registry.get(value)
311
return self.converter(value)
313
def __init__(self, name, help, registry=None, converter=None,
314
value_switches=False, title=None, enum_switch=True,
315
lazy_registry=None, short_name=None, short_value_switches=None):
319
:param name: The option name.
320
:param help: Help for the option.
321
:param registry: A Registry containing the values
322
:param converter: Callable to invoke with the value name to produce
323
the value. If not supplied, self.registry.get is used.
324
:param value_switches: If true, each possible value is assigned its
325
own switch. For example, instead of '--format knit',
326
'--knit' can be used interchangeably.
327
:param enum_switch: If true, a switch is provided with the option name,
329
:param lazy_registry: A tuple of (module name, attribute name) for a
330
registry to be lazily loaded.
331
:param short_name: The short name for the enum switch, if any
332
:param short_value_switches: A dict mapping values to short names
334
Option.__init__(self, name, help, type=self.convert, short_name=short_name)
335
self._registry = registry
337
if lazy_registry is None:
338
raise AssertionError(
339
'One of registry or lazy_registry must be given.')
340
self._lazy_registry = _mod_registry._LazyObjectGetter(
342
if registry is not None and lazy_registry is not None:
343
raise AssertionError(
344
'registry and lazy_registry are mutually exclusive')
346
self.converter = converter
347
self.value_switches = value_switches
348
self.enum_switch = enum_switch
349
self.short_value_switches = short_value_switches
351
if self.title is None:
356
if self._registry is None:
357
self._registry = self._lazy_registry.get_obj()
358
return self._registry
361
def from_kwargs(name_, help=None, title=None, value_switches=False,
362
enum_switch=True, **kwargs):
363
"""Convenience method to generate string-map registry options
365
name, help, value_switches and enum_switch are passed to the
366
RegistryOption constructor. Any other keyword arguments are treated
367
as values for the option, and their value is treated as the help.
369
reg = _mod_registry.Registry()
370
for name, switch_help in sorted(kwargs.items()):
371
name = name.replace('_', '-')
372
reg.register(name, name, help=switch_help)
373
if not value_switches:
374
help = help + ' "' + name + '": ' + switch_help
375
if not help.endswith("."):
377
return RegistryOption(name_, help, reg, title=title,
378
value_switches=value_switches, enum_switch=enum_switch)
380
def add_option(self, parser, short_name):
381
"""Add this option to an Optparse parser"""
382
if self.value_switches:
383
parser = parser.add_option_group(self.title)
385
Option.add_option(self, parser, short_name)
386
if self.value_switches:
387
for key in self.registry.keys():
388
option_strings = ['--%s' % key]
389
if self.is_hidden(key):
390
help = optparse.SUPPRESS_HELP
392
help = self.registry.get_help(key)
393
if (self.short_value_switches and
394
key in self.short_value_switches):
395
option_strings.append('-%s' %
396
self.short_value_switches[key])
397
parser.add_option(action='callback',
398
callback=self._optparse_value_callback(key),
402
def _optparse_value_callback(self, cb_value):
403
def cb(option, opt, value, parser):
404
v = self.type(cb_value)
405
setattr(parser.values, self._param_name, v)
406
if self.custom_callback is not None:
407
self.custom_callback(option, self._param_name, v, parser)
410
def iter_switches(self):
411
"""Iterate through the list of switches provided by the option
413
:return: an iterator of (name, short_name, argname, help)
415
for value in Option.iter_switches(self):
417
if self.value_switches:
418
for key in sorted(self.registry.keys()):
419
yield key, None, None, self.registry.get_help(key)
421
def is_hidden(self, name):
422
if name == self.name:
423
return Option.is_hidden(self, name)
424
return getattr(self.registry.get_info(name), 'hidden', False)
427
class OptionParser(optparse.OptionParser):
428
"""OptionParser that raises exceptions instead of exiting"""
430
DEFAULT_VALUE = object()
432
def error(self, message):
433
raise errors.BzrCommandError(message)
436
def get_optparser(options):
437
"""Generate an optparse parser for bzrlib-style options"""
439
parser = OptionParser()
440
parser.remove_option('--help')
441
for option in options.itervalues():
442
option.add_option(parser, option.short_name())
446
def custom_help(name, help):
447
"""Clone a common option overriding the help."""
449
o = copy.copy(Option.OPTIONS[name])
454
def _standard_option(name, **kwargs):
455
"""Register a standard option."""
456
# All standard options are implicitly 'global' ones
457
Option.STD_OPTIONS[name] = Option(name, **kwargs)
458
Option.OPTIONS[name] = Option.STD_OPTIONS[name]
461
def _global_option(name, **kwargs):
462
"""Register a global option."""
463
Option.OPTIONS[name] = Option(name, **kwargs)
466
def _global_registry_option(name, help, registry=None, **kwargs):
467
Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
470
# This is the verbosity level detected during command line parsing.
471
# Note that the final value is dependent on the order in which the
472
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
473
# The final value will be one of the following:
481
def _verbosity_level_callback(option, opt_str, value, parser):
482
global _verbosity_level
484
# Either --no-verbose or --no-quiet was specified
486
elif opt_str == "verbose":
487
if _verbosity_level > 0:
488
_verbosity_level += 1
492
if _verbosity_level < 0:
493
_verbosity_level -= 1
495
_verbosity_level = -1
498
class MergeTypeRegistry(_mod_registry.Registry):
503
_merge_type_registry = MergeTypeRegistry()
504
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
505
"Native diff3-style merge")
506
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
507
"Merge using external diff3")
508
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
510
_merge_type_registry.register_lazy('lca', 'bzrlib.merge', 'LCAMerger',
513
# Declare the standard options
514
_standard_option('help', short_name='h',
515
help='Show help message.')
516
_standard_option('usage',
517
help='Show usage message and options.')
518
_standard_option('verbose', short_name='v',
519
help='Display more information.',
520
custom_callback=_verbosity_level_callback)
521
_standard_option('quiet', short_name='q',
522
help="Only display errors and warnings.",
523
custom_callback=_verbosity_level_callback)
525
# Declare commonly used options
526
_global_option('all')
527
_global_option('overwrite', help='Ignore differences between branches and '
528
'overwrite unconditionally.')
529
_global_option('basis', type=str)
530
_global_option('bound')
531
_global_option('diff-options', type=str)
532
_global_option('file', type=unicode, short_name='F')
533
_global_option('force')
534
_global_option('format', type=unicode)
535
_global_option('forward')
536
_global_option('message', type=unicode,
538
help='Message string.')
539
_global_option('no-recurse')
540
_global_option('null', short_name='0',
541
help='Use an ASCII NUL (\\0) separator rather than '
543
_global_option('profile',
544
help='Show performance profiling information.')
545
_global_option('revision',
546
type=_parse_revision_str,
548
help='See "help revisionspec" for details.')
549
_global_option('change',
550
type=_parse_change_str,
552
param_name='revision',
553
help='Select changes introduced by the specified revision. See also "help revisionspec".')
554
_global_option('show-ids',
555
help='Show internal object ids.')
556
_global_option('timezone',
558
help='Display timezone as local, original, or utc.')
559
_global_option('unbound')
560
_global_option('version')
561
_global_option('email')
562
_global_option('update')
563
_global_registry_option('log-format', "Use specified log format.",
564
lazy_registry=('bzrlib.log', 'log_formatter_registry'),
565
value_switches=True, title='Log format',
566
short_value_switches={'short': 'S'})
567
_global_option('long', help='Use detailed log format. Same as --log-format long',
569
_global_option('short', help='Use moderately short log format. Same as --log-format short')
570
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
571
_global_option('root', type=str)
572
_global_option('no-backup')
573
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
574
_merge_type_registry, value_switches=True,
575
title='Merge algorithm')
576
_global_option('pattern', type=str)
577
_global_option('remember', help='Remember the specified location as a'
579
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
580
_global_option('kind', type=str)
581
_global_option('dry-run',
582
help="Show what would be done, but don't actually do anything.")
583
_global_option('name-from-revision', help='The path name in the old tree.')
584
_global_option('directory', short_name='d', type=unicode,
585
help='Branch to operate on, instead of working directory')
587
diff_writer_registry = _mod_registry.Registry()
588
diff_writer_registry.register('plain', lambda x: x, 'Plaintext diff output.')
589
diff_writer_registry.default_key = 'plain'
added
removed
bzrlib/option.py
