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.
20
from __future__ import absolute_import
25
from bzrlib.lazy_import import lazy_import
26
lazy_import(globals(), """
35
registry as _mod_registry,
39
def _parse_revision_str(revstr):
40
"""This handles a revision string -> revno.
42
This always returns a list. The list will have one element for
43
each revision specifier supplied.
45
>>> _parse_revision_str('234')
46
[<RevisionSpec_dwim 234>]
47
>>> _parse_revision_str('234..567')
48
[<RevisionSpec_dwim 234>, <RevisionSpec_dwim 567>]
49
>>> _parse_revision_str('..')
50
[<RevisionSpec None>, <RevisionSpec None>]
51
>>> _parse_revision_str('..234')
52
[<RevisionSpec None>, <RevisionSpec_dwim 234>]
53
>>> _parse_revision_str('234..')
54
[<RevisionSpec_dwim 234>, <RevisionSpec None>]
55
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
56
[<RevisionSpec_dwim 234>, <RevisionSpec_dwim 456>, <RevisionSpec_dwim 789>]
57
>>> _parse_revision_str('234....789') #Error ?
58
[<RevisionSpec_dwim 234>, <RevisionSpec None>, <RevisionSpec_dwim 789>]
59
>>> _parse_revision_str('revid:test@other.com-234234')
60
[<RevisionSpec_revid revid:test@other.com-234234>]
61
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
62
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
63
>>> _parse_revision_str('revid:test@other.com-234234..23')
64
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_dwim 23>]
65
>>> _parse_revision_str('date:2005-04-12')
66
[<RevisionSpec_date date:2005-04-12>]
67
>>> _parse_revision_str('date:2005-04-12 12:24:33')
68
[<RevisionSpec_date date:2005-04-12 12:24:33>]
69
>>> _parse_revision_str('date:2005-04-12T12:24:33')
70
[<RevisionSpec_date date:2005-04-12T12:24:33>]
71
>>> _parse_revision_str('date:2005-04-12,12:24:33')
72
[<RevisionSpec_date date:2005-04-12,12:24:33>]
73
>>> _parse_revision_str('-5..23')
74
[<RevisionSpec_dwim -5>, <RevisionSpec_dwim 23>]
75
>>> _parse_revision_str('-5')
76
[<RevisionSpec_dwim -5>]
77
>>> _parse_revision_str('123a')
78
[<RevisionSpec_dwim 123a>]
79
>>> _parse_revision_str('abc')
80
[<RevisionSpec_dwim abc>]
81
>>> _parse_revision_str('branch:../branch2')
82
[<RevisionSpec_branch branch:../branch2>]
83
>>> _parse_revision_str('branch:../../branch2')
84
[<RevisionSpec_branch branch:../../branch2>]
85
>>> _parse_revision_str('branch:../../branch2..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>]
92
# TODO: Maybe move this into revisionspec.py
94
# split on .. that is not followed by a / or \
95
sep = re.compile(r'\.\.(?![\\/])')
96
for x in sep.split(revstr):
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),
119
def _parse_merge_type(typestring):
120
return get_merge_type(typestring)
122
def get_merge_type(typestring):
123
"""Attempt to find the merge class/factory associated with a string."""
124
from merge import merge_types
126
return merge_types[typestring][0]
128
templ = '%s%%7s: %%s' % (' '*12)
129
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
130
type_list = '\n'.join(lines)
131
msg = "No known merge type %s. Supported types are:\n%s" %\
132
(typestring, type_list)
133
raise errors.BzrCommandError(msg)
136
class Option(object):
137
"""Description of a command line option
139
:ivar _short_name: If this option has a single-letter name, this is it.
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.
151
def __init__(self, name, help='', type=None, argname=None,
152
short_name=None, param_name=None, custom_callback=None,
154
"""Make a new command option.
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
163
None (default) if this option doesn't take an argument.
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
182
self._short_name = short_name
185
raise ValueError('argname not valid for booleans')
186
elif argname is None:
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
196
def short_name(self):
198
return self._short_name
200
def set_short_name(self, short_name):
201
self._short_name = short_name
203
def get_negation_name(self):
204
if self.name.startswith('no-'):
207
return 'no-' + self.name
209
def add_option(self, parser, short_name):
210
"""Add this option to an Optparse parser"""
211
option_strings = ['--%s' % self.name]
212
if short_name is not None:
213
option_strings.append('-%s' % short_name)
215
help = optparse.SUPPRESS_HELP
220
parser.add_option(action='callback',
221
callback=self._optparse_bool_callback,
222
callback_args=(True,),
225
negation_strings = ['--%s' % self.get_negation_name()]
226
parser.add_option(action='callback',
227
callback=self._optparse_bool_callback,
228
callback_args=(False,),
229
help=optparse.SUPPRESS_HELP, *negation_strings)
231
parser.add_option(action='callback',
232
callback=self._optparse_callback,
233
type='string', metavar=self.argname.upper(),
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)
243
def _optparse_callback(self, option, opt, value, parser):
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)
249
def iter_switches(self):
250
"""Iterate through the list of switches provided by the option
252
:return: an iterator of (name, short_name, argname, help)
254
argname = self.argname
255
if argname is not None:
256
argname = argname.upper()
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)
295
class RegistryOption(Option):
296
"""Option based on a registry
298
The values for the options correspond to entries in the registry. Input
299
must be a registry key. After validation, it is converted into an object
300
using Registry.get or a caller-provided converter.
303
def validate_value(self, value):
304
"""Validate a value name"""
305
if value not in self.registry:
306
raise errors.BadOptionValue(self.name, value)
308
def convert(self, value):
309
"""Convert a value name into an output type"""
310
self.validate_value(value)
311
if self.converter is None:
312
return self.registry.get(value)
314
return self.converter(value)
316
def __init__(self, name, help, registry=None, converter=None,
317
value_switches=False, title=None, enum_switch=True,
318
lazy_registry=None, short_name=None, short_value_switches=None):
322
:param name: The option name.
323
:param help: Help for the option.
324
:param registry: A Registry containing the values
325
:param converter: Callable to invoke with the value name to produce
326
the value. If not supplied, self.registry.get is used.
327
:param value_switches: If true, each possible value is assigned its
328
own switch. For example, instead of '--format knit',
329
'--knit' can be used interchangeably.
330
:param enum_switch: If true, a switch is provided with the option name,
332
:param lazy_registry: A tuple of (module name, attribute name) for a
333
registry to be lazily loaded.
334
:param short_name: The short name for the enum switch, if any
335
:param short_value_switches: A dict mapping values to short names
337
Option.__init__(self, name, help, type=self.convert,
338
short_name=short_name)
339
self._registry = registry
341
if lazy_registry is None:
342
raise AssertionError(
343
'One of registry or lazy_registry must be given.')
344
self._lazy_registry = _mod_registry._LazyObjectGetter(
346
if registry is not None and lazy_registry is not None:
347
raise AssertionError(
348
'registry and lazy_registry are mutually exclusive')
350
self.converter = converter
351
self.value_switches = value_switches
352
self.enum_switch = enum_switch
353
self.short_value_switches = short_value_switches
355
if self.title is None:
360
if self._registry is None:
361
self._registry = self._lazy_registry.get_obj()
362
return self._registry
365
def from_kwargs(name_, help=None, title=None, value_switches=False,
366
enum_switch=True, **kwargs):
367
"""Convenience method to generate string-map registry options
369
name, help, value_switches and enum_switch are passed to the
370
RegistryOption constructor. Any other keyword arguments are treated
371
as values for the option, and their value is treated as the help.
373
reg = _mod_registry.Registry()
374
for name, switch_help in sorted(kwargs.items()):
375
name = name.replace('_', '-')
376
reg.register(name, name, help=switch_help)
377
if not value_switches:
378
help = help + ' "' + name + '": ' + switch_help
379
if not help.endswith("."):
381
return RegistryOption(name_, help, reg, title=title,
382
value_switches=value_switches, enum_switch=enum_switch)
384
def add_option(self, parser, short_name):
385
"""Add this option to an Optparse parser"""
386
if self.value_switches:
387
parser = parser.add_option_group(self.title)
389
Option.add_option(self, parser, short_name)
390
if self.value_switches:
391
for key in self.registry.keys():
392
option_strings = ['--%s' % key]
393
if self.is_hidden(key):
394
help = optparse.SUPPRESS_HELP
396
help = self.registry.get_help(key)
397
if (self.short_value_switches and
398
key in self.short_value_switches):
399
option_strings.append('-%s' %
400
self.short_value_switches[key])
401
parser.add_option(action='callback',
402
callback=self._optparse_value_callback(key),
406
def _optparse_value_callback(self, cb_value):
407
def cb(option, opt, value, parser):
408
v = self.type(cb_value)
409
setattr(parser.values, self._param_name, v)
410
if self.custom_callback is not None:
411
self.custom_callback(option, self._param_name, v, parser)
414
def iter_switches(self):
415
"""Iterate through the list of switches provided by the option
417
:return: an iterator of (name, short_name, argname, help)
419
for value in Option.iter_switches(self):
421
if self.value_switches:
422
for key in sorted(self.registry.keys()):
423
yield key, None, None, self.registry.get_help(key)
425
def is_hidden(self, name):
426
if name == self.name:
427
return Option.is_hidden(self, name)
428
return getattr(self.registry.get_info(name), 'hidden', False)
431
class OptionParser(optparse.OptionParser):
432
"""OptionParser that raises exceptions instead of exiting"""
434
DEFAULT_VALUE = object()
437
optparse.OptionParser.__init__(self)
438
self.formatter = GettextIndentedHelpFormatter()
440
def error(self, message):
441
raise errors.BzrCommandError(message)
444
class GettextIndentedHelpFormatter(optparse.IndentedHelpFormatter):
445
"""Adds gettext() call to format_option()"""
447
optparse.IndentedHelpFormatter.__init__(self)
449
def format_option(self, option):
450
"""code taken from Python's optparse.py"""
452
option.help = i18n.gettext(option.help)
453
return optparse.IndentedHelpFormatter.format_option(self, option)
456
def get_optparser(options):
457
"""Generate an optparse parser for bzrlib-style options"""
459
parser = OptionParser()
460
parser.remove_option('--help')
461
for option in options.itervalues():
462
option.add_option(parser, option.short_name())
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]
487
def _global_option(name, **kwargs):
488
"""Register a global option."""
489
Option.OPTIONS[name] = Option(name, **kwargs)
492
def _global_registry_option(name, help, registry=None, **kwargs):
493
Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
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.')
544
_global_option('file', type=unicode, short_name='F')
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')
552
_global_option('message', type=unicode,
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.')
563
_global_option('revision',
564
type=_parse_revision_str,
566
help='See "help revisionspec" for details.')
567
_global_option('show-ids',
568
help='Show internal object ids.')
569
_global_option('timezone',
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'
added
removed
bzrlib/option.py
