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.
25
registry as _mod_registry,
30
class BadOptionValue(errors.BzrError):
32
_fmt = """Bad value "%(value)s" for option "%(name)s"."""
34
def __init__(self, name, value):
35
errors.BzrError.__init__(self, name=name, value=value)
38
def _parse_revision_str(revstr):
39
"""This handles a revision string -> revno.
41
This always returns a list. The list will have one element for
42
each revision specifier supplied.
44
>>> _parse_revision_str('234')
45
[<RevisionSpec_dwim 234>]
46
>>> _parse_revision_str('234..567')
47
[<RevisionSpec_dwim 234>, <RevisionSpec_dwim 567>]
48
>>> _parse_revision_str('..')
49
[<RevisionSpec None>, <RevisionSpec None>]
50
>>> _parse_revision_str('..234')
51
[<RevisionSpec None>, <RevisionSpec_dwim 234>]
52
>>> _parse_revision_str('234..')
53
[<RevisionSpec_dwim 234>, <RevisionSpec None>]
54
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
55
[<RevisionSpec_dwim 234>, <RevisionSpec_dwim 456>, <RevisionSpec_dwim 789>]
56
>>> _parse_revision_str('234....789') #Error ?
57
[<RevisionSpec_dwim 234>, <RevisionSpec None>, <RevisionSpec_dwim 789>]
58
>>> _parse_revision_str('revid:test@other.com-234234')
59
[<RevisionSpec_revid revid:test@other.com-234234>]
60
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
61
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
62
>>> _parse_revision_str('revid:test@other.com-234234..23')
63
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_dwim 23>]
64
>>> _parse_revision_str('date:2005-04-12')
65
[<RevisionSpec_date date:2005-04-12>]
66
>>> _parse_revision_str('date:2005-04-12 12:24:33')
67
[<RevisionSpec_date date:2005-04-12 12:24:33>]
68
>>> _parse_revision_str('date:2005-04-12T12:24:33')
69
[<RevisionSpec_date date:2005-04-12T12:24:33>]
70
>>> _parse_revision_str('date:2005-04-12,12:24:33')
71
[<RevisionSpec_date date:2005-04-12,12:24:33>]
72
>>> _parse_revision_str('-5..23')
73
[<RevisionSpec_dwim -5>, <RevisionSpec_dwim 23>]
74
>>> _parse_revision_str('-5')
75
[<RevisionSpec_dwim -5>]
76
>>> _parse_revision_str('123a')
77
[<RevisionSpec_dwim 123a>]
78
>>> _parse_revision_str('abc')
79
[<RevisionSpec_dwim abc>]
80
>>> _parse_revision_str('branch:../branch2')
81
[<RevisionSpec_branch branch:../branch2>]
82
>>> _parse_revision_str('branch:../../branch2')
83
[<RevisionSpec_branch branch:../../branch2>]
84
>>> _parse_revision_str('branch:../../branch2..23')
85
[<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_dwim 23>]
86
>>> _parse_revision_str('branch:..\\\\branch2')
87
[<RevisionSpec_branch branch:..\\branch2>]
88
>>> _parse_revision_str('branch:..\\\\..\\\\branch2..23')
89
[<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_dwim 23>]
91
# TODO: Maybe move this into revisionspec.py
93
# split on .. that is not followed by a / or \
94
sep = re.compile(r'\.\.(?![\\/])')
95
for x in sep.split(revstr):
96
revs.append(revisionspec.RevisionSpec.from_string(x or None))
100
def _parse_change_str(revstr):
101
"""Parse the revision string and return a tuple with left-most
102
parent of the revision.
104
>>> _parse_change_str('123')
105
(<RevisionSpec_before before:123>, <RevisionSpec_dwim 123>)
106
>>> _parse_change_str('123..124')
107
Traceback (most recent call last):
109
breezy.errors.RangeInChangeOption: Option --change does not accept revision ranges
111
revs = _parse_revision_str(revstr)
113
raise errors.RangeInChangeOption()
114
return (revisionspec.RevisionSpec.from_string('before:' + revstr),
118
def _parse_merge_type(typestring):
119
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.items()]
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.CommandError(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):
246
except ValueError as e:
247
raise optparse.OptionValueError(
248
'invalid value for option %s: %s' % (option, value))
249
setattr(parser.values, self._param_name, v)
250
if self.custom_callback is not None:
251
self.custom_callback(option, self.name, v, parser)
253
def iter_switches(self):
254
"""Iterate through the list of switches provided by the option
256
:return: an iterator of (name, short_name, argname, help)
258
argname = self.argname
259
if argname is not None:
260
argname = argname.upper()
261
yield self.name, self.short_name(), argname, self.help
263
def is_hidden(self, name):
267
class ListOption(Option):
268
"""Option used to provide a list of values.
270
On the command line, arguments are specified by a repeated use of the
271
option. '-' is a special argument that resets the list. For example,
273
sets the value of the 'foo' option to ['a', 'b'], and
274
--foo=a --foo=b --foo=- --foo=c
275
sets the value of the 'foo' option to ['c'].
278
def add_option(self, parser, short_name):
279
"""Add this option to an Optparse parser."""
280
option_strings = ['--%s' % self.name]
281
if short_name is not None:
282
option_strings.append('-%s' % short_name)
283
parser.add_option(action='callback',
284
callback=self._optparse_callback,
285
type='string', metavar=self.argname.upper(),
286
help=self.help, dest=self._param_name, default=[],
289
def _optparse_callback(self, option, opt, value, parser):
290
values = getattr(parser.values, self._param_name)
294
values.append(self.type(value))
295
if self.custom_callback is not None:
296
self.custom_callback(option, self._param_name, values, parser)
299
class RegistryOption(Option):
300
"""Option based on a registry
302
The values for the options correspond to entries in the registry. Input
303
must be a registry key. After validation, it is converted into an object
304
using Registry.get or a caller-provided converter.
307
def validate_value(self, value):
308
"""Validate a value name"""
309
if value not in self.registry:
310
raise BadOptionValue(self.name, value)
312
def convert(self, value):
313
"""Convert a value name into an output type"""
314
self.validate_value(value)
315
if self.converter is None:
316
return self.registry.get(value)
318
return self.converter(value)
320
def __init__(self, name, help, registry=None, converter=None,
321
value_switches=False, title=None, enum_switch=True,
322
lazy_registry=None, short_name=None, short_value_switches=None):
326
:param name: The option name.
327
:param help: Help for the option.
328
:param registry: A Registry containing the values
329
:param converter: Callable to invoke with the value name to produce
330
the value. If not supplied, self.registry.get is used.
331
:param value_switches: If true, each possible value is assigned its
332
own switch. For example, instead of '--format knit',
333
'--knit' can be used interchangeably.
334
:param enum_switch: If true, a switch is provided with the option name,
336
:param lazy_registry: A tuple of (module name, attribute name) for a
337
registry to be lazily loaded.
338
:param short_name: The short name for the enum switch, if any
339
:param short_value_switches: A dict mapping values to short names
341
Option.__init__(self, name, help, type=self.convert,
342
short_name=short_name)
343
self._registry = registry
345
if lazy_registry is None:
346
raise AssertionError(
347
'One of registry or lazy_registry must be given.')
348
self._lazy_registry = _mod_registry._LazyObjectGetter(
350
if registry is not None and lazy_registry is not None:
351
raise AssertionError(
352
'registry and lazy_registry are mutually exclusive')
354
self.converter = converter
355
self.value_switches = value_switches
356
self.enum_switch = enum_switch
357
self.short_value_switches = short_value_switches
359
if self.title is None:
364
if self._registry is None:
365
self._registry = self._lazy_registry.get_obj()
366
return self._registry
369
def from_kwargs(name_, help=None, title=None, value_switches=False,
370
enum_switch=True, **kwargs):
371
"""Convenience method to generate string-map registry options
373
name, help, value_switches and enum_switch are passed to the
374
RegistryOption constructor. Any other keyword arguments are treated
375
as values for the option, and their value is treated as the help.
377
reg = _mod_registry.Registry()
378
for name, switch_help in sorted(kwargs.items()):
379
name = name.replace('_', '-')
380
reg.register(name, name, help=switch_help)
381
if not value_switches:
382
help = help + ' "' + name + '": ' + switch_help
383
if not help.endswith("."):
385
return RegistryOption(name_, help, reg, title=title,
386
value_switches=value_switches, enum_switch=enum_switch)
388
def add_option(self, parser, short_name):
389
"""Add this option to an Optparse parser"""
390
if self.value_switches:
391
parser = parser.add_option_group(self.title)
393
Option.add_option(self, parser, short_name)
394
if self.value_switches:
395
alias_map = self.registry.alias_map()
396
for key in self.registry.keys():
397
if key in self.registry.aliases():
402
[alias for alias in alias_map.get(key, [])
403
if not self.is_hidden(alias)]]
404
if self.is_hidden(key):
405
help = optparse.SUPPRESS_HELP
407
help = self.registry.get_help(key)
408
if (self.short_value_switches and
409
key in self.short_value_switches):
410
option_strings.append('-%s' %
411
self.short_value_switches[key])
412
parser.add_option(action='callback',
413
callback=self._optparse_value_callback(key),
417
def _optparse_value_callback(self, cb_value):
418
def cb(option, opt, value, parser):
419
v = self.type(cb_value)
420
setattr(parser.values, self._param_name, v)
421
if self.custom_callback is not None:
422
self.custom_callback(option, self._param_name, v, parser)
425
def iter_switches(self):
426
"""Iterate through the list of switches provided by the option
428
:return: an iterator of (name, short_name, argname, help)
430
for value in Option.iter_switches(self):
432
if self.value_switches:
433
for key in sorted(self.registry.keys()):
434
yield key, None, None, self.registry.get_help(key)
436
def is_alias(self, name):
437
"""Check whether a particular format is an alias."""
438
if name == self.name:
440
return name in self.registry.aliases()
442
def is_hidden(self, name):
443
if name == self.name:
444
return Option.is_hidden(self, name)
445
return getattr(self.registry.get_info(name), 'hidden', False)
448
class OptionParser(optparse.OptionParser):
449
"""OptionParser that raises exceptions instead of exiting"""
451
DEFAULT_VALUE = object()
454
optparse.OptionParser.__init__(self)
455
self.formatter = GettextIndentedHelpFormatter()
457
def error(self, message):
458
raise errors.CommandError(message)
461
class GettextIndentedHelpFormatter(optparse.IndentedHelpFormatter):
462
"""Adds gettext() call to format_option()"""
465
optparse.IndentedHelpFormatter.__init__(self)
467
def format_option(self, option):
468
"""code taken from Python's optparse.py"""
470
from .i18n import gettext
471
option.help = gettext(option.help)
472
return optparse.IndentedHelpFormatter.format_option(self, option)
475
def get_optparser(options):
476
"""Generate an optparse parser for breezy-style options"""
478
parser = OptionParser()
479
parser.remove_option('--help')
480
for option in options:
481
option.add_option(parser, option.short_name())
485
def custom_help(name, help):
486
"""Clone a common option overriding the help."""
488
o = copy.copy(Option.OPTIONS[name])
493
def _standard_option(name, **kwargs):
494
"""Register a standard option."""
495
# All standard options are implicitly 'global' ones
496
Option.STD_OPTIONS[name] = Option(name, **kwargs)
497
Option.OPTIONS[name] = Option.STD_OPTIONS[name]
500
def _standard_list_option(name, **kwargs):
501
"""Register a standard option."""
502
# All standard options are implicitly 'global' ones
503
Option.STD_OPTIONS[name] = ListOption(name, **kwargs)
504
Option.OPTIONS[name] = Option.STD_OPTIONS[name]
507
def _global_option(name, **kwargs):
508
"""Register a global option."""
509
Option.OPTIONS[name] = Option(name, **kwargs)
512
def _global_registry_option(name, help, registry=None, **kwargs):
513
Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
516
# This is the verbosity level detected during command line parsing.
517
# Note that the final value is dependent on the order in which the
518
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
519
# The final value will be one of the following:
527
def _verbosity_level_callback(option, opt_str, value, parser):
528
global _verbosity_level
530
# Either --no-verbose or --no-quiet was specified
532
elif opt_str == "verbose":
533
if _verbosity_level > 0:
534
_verbosity_level += 1
538
if _verbosity_level < 0:
539
_verbosity_level -= 1
541
_verbosity_level = -1
544
# Declare the standard options
545
_standard_option('help', short_name='h',
546
help='Show help message.')
547
_standard_option('quiet', short_name='q',
548
help="Only display errors and warnings.",
549
custom_callback=_verbosity_level_callback)
550
_standard_option('usage',
551
help='Show usage message and options.')
552
_standard_option('verbose', short_name='v',
553
help='Display more information.',
554
custom_callback=_verbosity_level_callback)
556
# Declare commonly used options
557
_global_option('change',
558
type=_parse_change_str,
560
param_name='revision',
561
help='Select changes introduced by the specified revision. See also "help revisionspec".')
562
_global_option('directory', short_name='d', type=str,
563
help='Branch to operate on, instead of working directory.')
564
_global_option('file', type=str, short_name='F')
565
_global_registry_option('log-format', "Use specified log format.",
566
lazy_registry=('breezy.log', 'log_formatter_registry'),
567
value_switches=True, title='Log format',
568
short_value_switches={'short': 'S'})
569
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
570
lazy_registry=('breezy.merge', 'merge_type_registry'),
571
value_switches=True, title='Merge algorithm')
572
_global_option('message', type=str,
574
help='Message string.')
575
_global_option('null', short_name='0',
576
help='Use an ASCII NUL (\\0) separator rather than '
578
_global_option('overwrite', help='Ignore differences between branches and '
579
'overwrite unconditionally.')
580
_global_option('remember', help='Remember the specified location as a'
582
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
583
_global_option('revision',
584
type=_parse_revision_str,
586
help='See "help revisionspec" for details.')
587
_global_option('show-ids',
588
help='Show internal object ids.')
589
_global_option('timezone',
591
help='Display timezone as local, original, or utc.')
593
diff_writer_registry = _mod_registry.Registry()
594
diff_writer_registry.register('plain', lambda x: x, 'Plaintext diff output.')
595
diff_writer_registry.default_key = 'plain'
added
removed
breezy/option.py
