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
27
registry as _mod_registry,
35
class BadOptionValue(errors.BzrError):
37
_fmt = """Bad value "%(value)s" for option "%(name)s"."""
39
def __init__(self, name, value):
40
errors.BzrError.__init__(self, name=name, value=value)
43
def _parse_revision_str(revstr):
44
"""This handles a revision string -> revno.
46
This always returns a list. The list will have one element for
47
each revision specifier supplied.
49
>>> _parse_revision_str('234')
50
[<RevisionSpec_dwim 234>]
51
>>> _parse_revision_str('234..567')
52
[<RevisionSpec_dwim 234>, <RevisionSpec_dwim 567>]
53
>>> _parse_revision_str('..')
54
[<RevisionSpec None>, <RevisionSpec None>]
55
>>> _parse_revision_str('..234')
56
[<RevisionSpec None>, <RevisionSpec_dwim 234>]
57
>>> _parse_revision_str('234..')
58
[<RevisionSpec_dwim 234>, <RevisionSpec None>]
59
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
60
[<RevisionSpec_dwim 234>, <RevisionSpec_dwim 456>, <RevisionSpec_dwim 789>]
61
>>> _parse_revision_str('234....789') #Error ?
62
[<RevisionSpec_dwim 234>, <RevisionSpec None>, <RevisionSpec_dwim 789>]
63
>>> _parse_revision_str('revid:test@other.com-234234')
64
[<RevisionSpec_revid revid:test@other.com-234234>]
65
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
66
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
67
>>> _parse_revision_str('revid:test@other.com-234234..23')
68
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_dwim 23>]
69
>>> _parse_revision_str('date:2005-04-12')
70
[<RevisionSpec_date date:2005-04-12>]
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('date:2005-04-12T12:24:33')
74
[<RevisionSpec_date date:2005-04-12T12:24:33>]
75
>>> _parse_revision_str('date:2005-04-12,12:24:33')
76
[<RevisionSpec_date date:2005-04-12,12:24:33>]
77
>>> _parse_revision_str('-5..23')
78
[<RevisionSpec_dwim -5>, <RevisionSpec_dwim 23>]
79
>>> _parse_revision_str('-5')
80
[<RevisionSpec_dwim -5>]
81
>>> _parse_revision_str('123a')
82
[<RevisionSpec_dwim 123a>]
83
>>> _parse_revision_str('abc')
84
[<RevisionSpec_dwim abc>]
85
>>> _parse_revision_str('branch:../branch2')
86
[<RevisionSpec_branch branch:../branch2>]
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>]
91
>>> _parse_revision_str('branch:..\\\\branch2')
92
[<RevisionSpec_branch branch:..\\branch2>]
93
>>> _parse_revision_str('branch:..\\\\..\\\\branch2..23')
94
[<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_dwim 23>]
96
# TODO: Maybe move this into revisionspec.py
98
# split on .. that is not followed by a / or \
99
sep = re.compile(r'\.\.(?![\\/])')
100
for x in sep.split(revstr):
101
revs.append(revisionspec.RevisionSpec.from_string(x or None))
105
def _parse_change_str(revstr):
106
"""Parse the revision string and return a tuple with left-most
107
parent of the revision.
109
>>> _parse_change_str('123')
110
(<RevisionSpec_before before:123>, <RevisionSpec_dwim 123>)
111
>>> _parse_change_str('123..124')
112
Traceback (most recent call last):
114
RangeInChangeOption: Option --change does not accept revision ranges
116
revs = _parse_revision_str(revstr)
118
raise errors.RangeInChangeOption()
119
return (revisionspec.RevisionSpec.from_string('before:' + revstr),
123
def _parse_merge_type(typestring):
124
return get_merge_type(typestring)
127
def get_merge_type(typestring):
128
"""Attempt to find the merge class/factory associated with a string."""
129
from merge import merge_types
131
return merge_types[typestring][0]
133
templ = '%s%%7s: %%s' % (' ' * 12)
134
lines = [templ % (f[0], f[1][1]) for f in merge_types.items()]
135
type_list = '\n'.join(lines)
136
msg = "No known merge type %s. Supported types are:\n%s" %\
137
(typestring, type_list)
138
raise errors.BzrCommandError(msg)
141
class Option(object):
142
"""Description of a command line option
144
:ivar _short_name: If this option has a single-letter name, this is it.
148
# The dictionary of standard options. These are always legal.
151
# The dictionary of commonly used options. these are only legal
152
# if a command explicitly references them by name in the list
153
# of supported options.
156
def __init__(self, name, help='', type=None, argname=None,
157
short_name=None, param_name=None, custom_callback=None,
159
"""Make a new command option.
161
:param name: regular name of the command, used in the double-dash
162
form and also as the parameter to the command's run()
163
method (unless param_name is specified).
165
:param help: help message displayed in command help
167
:param type: function called to parse the option argument, or
168
None (default) if this option doesn't take an argument.
170
:param argname: name of option argument, if any
172
:param short_name: short option code for use with a single -, e.g.
173
short_name="v" to enable parsing of -v.
175
:param param_name: name of the parameter which will be passed to
176
the command's run() method.
178
:param custom_callback: a callback routine to be called after normal
179
processing. The signature of the callback routine is
180
(option, name, new_value, parser).
181
:param hidden: If True, the option should be hidden in help and
187
self._short_name = short_name
190
raise ValueError('argname not valid for booleans')
191
elif argname is None:
193
self.argname = argname
194
if param_name is None:
195
self._param_name = self.name.replace('-', '_')
197
self._param_name = param_name
198
self.custom_callback = custom_callback
201
def short_name(self):
203
return self._short_name
205
def set_short_name(self, short_name):
206
self._short_name = short_name
208
def get_negation_name(self):
209
if self.name.startswith('no-'):
212
return 'no-' + self.name
214
def add_option(self, parser, short_name):
215
"""Add this option to an Optparse parser"""
216
option_strings = ['--%s' % self.name]
217
if short_name is not None:
218
option_strings.append('-%s' % short_name)
220
help = optparse.SUPPRESS_HELP
225
parser.add_option(action='callback',
226
callback=self._optparse_bool_callback,
227
callback_args=(True,),
230
negation_strings = ['--%s' % self.get_negation_name()]
231
parser.add_option(action='callback',
232
callback=self._optparse_bool_callback,
233
callback_args=(False,),
234
help=optparse.SUPPRESS_HELP, *negation_strings)
236
parser.add_option(action='callback',
237
callback=self._optparse_callback,
238
type='string', metavar=self.argname.upper(),
240
default=OptionParser.DEFAULT_VALUE,
243
def _optparse_bool_callback(self, option, opt_str, value, parser, bool_v):
244
setattr(parser.values, self._param_name, bool_v)
245
if self.custom_callback is not None:
246
self.custom_callback(option, self._param_name, bool_v, parser)
248
def _optparse_callback(self, option, opt, value, parser):
251
except ValueError as e:
252
raise optparse.OptionValueError(
253
'invalid value for option %s: %s' % (option, value))
254
setattr(parser.values, self._param_name, v)
255
if self.custom_callback is not None:
256
self.custom_callback(option, self.name, v, parser)
258
def iter_switches(self):
259
"""Iterate through the list of switches provided by the option
261
:return: an iterator of (name, short_name, argname, help)
263
argname = self.argname
264
if argname is not None:
265
argname = argname.upper()
266
yield self.name, self.short_name(), argname, self.help
268
def is_hidden(self, name):
272
class ListOption(Option):
273
"""Option used to provide a list of values.
275
On the command line, arguments are specified by a repeated use of the
276
option. '-' is a special argument that resets the list. For example,
278
sets the value of the 'foo' option to ['a', 'b'], and
279
--foo=a --foo=b --foo=- --foo=c
280
sets the value of the 'foo' option to ['c'].
283
def add_option(self, parser, short_name):
284
"""Add this option to an Optparse parser."""
285
option_strings = ['--%s' % self.name]
286
if short_name is not None:
287
option_strings.append('-%s' % short_name)
288
parser.add_option(action='callback',
289
callback=self._optparse_callback,
290
type='string', metavar=self.argname.upper(),
291
help=self.help, dest=self._param_name, default=[],
294
def _optparse_callback(self, option, opt, value, parser):
295
values = getattr(parser.values, self._param_name)
299
values.append(self.type(value))
300
if self.custom_callback is not None:
301
self.custom_callback(option, self._param_name, values, parser)
304
class RegistryOption(Option):
305
"""Option based on a registry
307
The values for the options correspond to entries in the registry. Input
308
must be a registry key. After validation, it is converted into an object
309
using Registry.get or a caller-provided converter.
312
def validate_value(self, value):
313
"""Validate a value name"""
314
if value not in self.registry:
315
raise BadOptionValue(self.name, value)
317
def convert(self, value):
318
"""Convert a value name into an output type"""
319
self.validate_value(value)
320
if self.converter is None:
321
return self.registry.get(value)
323
return self.converter(value)
325
def __init__(self, name, help, registry=None, converter=None,
326
value_switches=False, title=None, enum_switch=True,
327
lazy_registry=None, short_name=None, short_value_switches=None):
331
:param name: The option name.
332
:param help: Help for the option.
333
:param registry: A Registry containing the values
334
:param converter: Callable to invoke with the value name to produce
335
the value. If not supplied, self.registry.get is used.
336
:param value_switches: If true, each possible value is assigned its
337
own switch. For example, instead of '--format knit',
338
'--knit' can be used interchangeably.
339
:param enum_switch: If true, a switch is provided with the option name,
341
:param lazy_registry: A tuple of (module name, attribute name) for a
342
registry to be lazily loaded.
343
:param short_name: The short name for the enum switch, if any
344
:param short_value_switches: A dict mapping values to short names
346
Option.__init__(self, name, help, type=self.convert,
347
short_name=short_name)
348
self._registry = registry
350
if lazy_registry is None:
351
raise AssertionError(
352
'One of registry or lazy_registry must be given.')
353
self._lazy_registry = _mod_registry._LazyObjectGetter(
355
if registry is not None and lazy_registry is not None:
356
raise AssertionError(
357
'registry and lazy_registry are mutually exclusive')
359
self.converter = converter
360
self.value_switches = value_switches
361
self.enum_switch = enum_switch
362
self.short_value_switches = short_value_switches
364
if self.title is None:
369
if self._registry is None:
370
self._registry = self._lazy_registry.get_obj()
371
return self._registry
374
def from_kwargs(name_, help=None, title=None, value_switches=False,
375
enum_switch=True, **kwargs):
376
"""Convenience method to generate string-map registry options
378
name, help, value_switches and enum_switch are passed to the
379
RegistryOption constructor. Any other keyword arguments are treated
380
as values for the option, and their value is treated as the help.
382
reg = _mod_registry.Registry()
383
for name, switch_help in sorted(kwargs.items()):
384
name = name.replace('_', '-')
385
reg.register(name, name, help=switch_help)
386
if not value_switches:
387
help = help + ' "' + name + '": ' + switch_help
388
if not help.endswith("."):
390
return RegistryOption(name_, help, reg, title=title,
391
value_switches=value_switches, enum_switch=enum_switch)
393
def add_option(self, parser, short_name):
394
"""Add this option to an Optparse parser"""
395
if self.value_switches:
396
parser = parser.add_option_group(self.title)
398
Option.add_option(self, parser, short_name)
399
if self.value_switches:
400
alias_map = self.registry.alias_map()
401
for key in self.registry.keys():
402
if key in self.registry.aliases():
407
[alias for alias in alias_map.get(key, [])
408
if not self.is_hidden(alias)]]
409
if self.is_hidden(key):
410
help = optparse.SUPPRESS_HELP
412
help = self.registry.get_help(key)
413
if (self.short_value_switches and
414
key in self.short_value_switches):
415
option_strings.append('-%s' %
416
self.short_value_switches[key])
417
parser.add_option(action='callback',
418
callback=self._optparse_value_callback(key),
422
def _optparse_value_callback(self, cb_value):
423
def cb(option, opt, value, parser):
424
v = self.type(cb_value)
425
setattr(parser.values, self._param_name, v)
426
if self.custom_callback is not None:
427
self.custom_callback(option, self._param_name, v, parser)
430
def iter_switches(self):
431
"""Iterate through the list of switches provided by the option
433
:return: an iterator of (name, short_name, argname, help)
435
for value in Option.iter_switches(self):
437
if self.value_switches:
438
for key in sorted(self.registry.keys()):
439
yield key, None, None, self.registry.get_help(key)
441
def is_alias(self, name):
442
"""Check whether a particular format is an alias."""
443
if name == self.name:
445
return name in self.registry.aliases()
447
def is_hidden(self, name):
448
if name == self.name:
449
return Option.is_hidden(self, name)
450
return getattr(self.registry.get_info(name), 'hidden', False)
453
class OptionParser(optparse.OptionParser):
454
"""OptionParser that raises exceptions instead of exiting"""
456
DEFAULT_VALUE = object()
459
optparse.OptionParser.__init__(self)
460
self.formatter = GettextIndentedHelpFormatter()
462
def error(self, message):
463
raise errors.BzrCommandError(message)
466
class GettextIndentedHelpFormatter(optparse.IndentedHelpFormatter):
467
"""Adds gettext() call to format_option()"""
470
optparse.IndentedHelpFormatter.__init__(self)
472
def format_option(self, option):
473
"""code taken from Python's optparse.py"""
475
from .i18n import gettext
476
option.help = gettext(option.help)
477
return optparse.IndentedHelpFormatter.format_option(self, option)
480
def get_optparser(options):
481
"""Generate an optparse parser for breezy-style options"""
483
parser = OptionParser()
484
parser.remove_option('--help')
485
for option in options:
486
option.add_option(parser, option.short_name())
490
def custom_help(name, help):
491
"""Clone a common option overriding the help."""
493
o = copy.copy(Option.OPTIONS[name])
498
def _standard_option(name, **kwargs):
499
"""Register a standard option."""
500
# All standard options are implicitly 'global' ones
501
Option.STD_OPTIONS[name] = Option(name, **kwargs)
502
Option.OPTIONS[name] = Option.STD_OPTIONS[name]
505
def _standard_list_option(name, **kwargs):
506
"""Register a standard option."""
507
# All standard options are implicitly 'global' ones
508
Option.STD_OPTIONS[name] = ListOption(name, **kwargs)
509
Option.OPTIONS[name] = Option.STD_OPTIONS[name]
512
def _global_option(name, **kwargs):
513
"""Register a global option."""
514
Option.OPTIONS[name] = Option(name, **kwargs)
517
def _global_registry_option(name, help, registry=None, **kwargs):
518
Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
521
# This is the verbosity level detected during command line parsing.
522
# Note that the final value is dependent on the order in which the
523
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
524
# The final value will be one of the following:
532
def _verbosity_level_callback(option, opt_str, value, parser):
533
global _verbosity_level
535
# Either --no-verbose or --no-quiet was specified
537
elif opt_str == "verbose":
538
if _verbosity_level > 0:
539
_verbosity_level += 1
543
if _verbosity_level < 0:
544
_verbosity_level -= 1
546
_verbosity_level = -1
549
# Declare the standard options
550
_standard_option('help', short_name='h',
551
help='Show help message.')
552
_standard_option('quiet', short_name='q',
553
help="Only display errors and warnings.",
554
custom_callback=_verbosity_level_callback)
555
_standard_option('usage',
556
help='Show usage message and options.')
557
_standard_option('verbose', short_name='v',
558
help='Display more information.',
559
custom_callback=_verbosity_level_callback)
561
# Declare commonly used options
562
_global_option('change',
563
type=_parse_change_str,
565
param_name='revision',
566
help='Select changes introduced by the specified revision. See also "help revisionspec".')
567
_global_option('directory', short_name='d', type=text_type,
568
help='Branch to operate on, instead of working directory.')
569
_global_option('file', type=text_type, short_name='F')
570
_global_registry_option('log-format', "Use specified log format.",
571
lazy_registry=('breezy.log', 'log_formatter_registry'),
572
value_switches=True, title='Log format',
573
short_value_switches={'short': 'S'})
574
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
575
lazy_registry=('breezy.merge', 'merge_type_registry'),
576
value_switches=True, title='Merge algorithm')
577
_global_option('message', type=text_type,
579
help='Message string.')
580
_global_option('null', short_name='0',
581
help='Use an ASCII NUL (\\0) separator rather than '
583
_global_option('overwrite', help='Ignore differences between branches and '
584
'overwrite unconditionally.')
585
_global_option('remember', help='Remember the specified location as a'
587
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
588
_global_option('revision',
589
type=_parse_revision_str,
591
help='See "help revisionspec" for details.')
592
_global_option('show-ids',
593
help='Show internal object ids.')
594
_global_option('timezone',
596
help='Display timezone as local, original, or utc.')
598
diff_writer_registry = _mod_registry.Registry()
599
diff_writer_registry.register('plain', lambda x: x, 'Plaintext diff output.')
600
diff_writer_registry.default_key = 'plain'
added
removed
breezy/option.py
