1
# Copyright (C) 2004, 2005, 2006, 2007 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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(), """
33
from bzrlib.trace import warning
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_revno 234>]
47
>>> _parse_revision_str('234..567')
48
[<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
49
>>> _parse_revision_str('..')
50
[<RevisionSpec None>, <RevisionSpec None>]
51
>>> _parse_revision_str('..234')
52
[<RevisionSpec None>, <RevisionSpec_revno 234>]
53
>>> _parse_revision_str('234..')
54
[<RevisionSpec_revno 234>, <RevisionSpec None>]
55
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
56
[<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
57
>>> _parse_revision_str('234....789') #Error ?
58
[<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 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_revno 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_revno -5>, <RevisionSpec_revno 23>]
75
>>> _parse_revision_str('-5')
76
[<RevisionSpec_revno -5>]
77
>>> _parse_revision_str('123a')
78
Traceback (most recent call last):
80
NoSuchRevisionSpec: No namespace registered for string: '123a'
81
>>> _parse_revision_str('abc')
82
Traceback (most recent call last):
84
NoSuchRevisionSpec: No namespace registered for string: '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_revno 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_revno 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_revno 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)
126
def get_merge_type(typestring):
127
"""Attempt to find the merge class/factory associated with a string."""
128
from merge import merge_types
130
return merge_types[typestring][0]
132
templ = '%s%%7s: %%s' % (' '*12)
133
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
134
type_list = '\n'.join(lines)
135
msg = "No known merge type %s. Supported types are:\n%s" %\
136
(typestring, type_list)
137
raise errors.BzrCommandError(msg)
140
class Option(object):
141
"""Description of a command line option
143
:ivar _short_name: If this option has a single-letter name, this is it.
147
# The dictionary of standard options. These are always legal.
150
# The dictionary of commonly used options. these are only legal
151
# if a command explicitly references them by name in the list
152
# of supported options.
155
def __init__(self, name, help='', type=None, argname=None,
156
short_name=None, param_name=None, custom_callback=None):
157
"""Make a new command option.
159
:param name: regular name of the command, used in the double-dash
160
form and also as the parameter to the command's run()
161
method (unless param_name is specified).
163
:param help: help message displayed in command help
165
:param type: function called to parse the option argument, or
166
None (default) if this option doesn't take an argument.
168
:param argname: name of option argument, if any
170
:param short_name: short option code for use with a single -, e.g.
171
short_name="v" to enable parsing of -v.
173
:param param_name: name of the parameter which will be passed to
174
the command's run() method.
176
:param custom_callback: a callback routine to be called after normal
177
processing. The signature of the callback routine is
178
(option, name, new_value, parser).
183
self._short_name = short_name
185
assert argname is None
186
elif argname is None:
188
self.argname = argname
189
if param_name is None:
190
self._param_name = self.name
192
self._param_name = param_name
193
self.custom_callback = custom_callback
195
def short_name(self):
197
return self._short_name
199
def set_short_name(self, short_name):
200
self._short_name = short_name
202
def get_negation_name(self):
203
if self.name.startswith('no-'):
206
return 'no-' + self.name
208
def add_option(self, parser, short_name):
209
"""Add this option to an Optparse parser"""
210
option_strings = ['--%s' % self.name]
211
if short_name is not None:
212
option_strings.append('-%s' % short_name)
215
parser.add_option(action='callback',
216
callback=self._optparse_bool_callback,
217
callback_args=(True,),
220
negation_strings = ['--%s' % self.get_negation_name()]
221
parser.add_option(action='callback',
222
callback=self._optparse_bool_callback,
223
callback_args=(False,),
224
help=optparse.SUPPRESS_HELP, *negation_strings)
226
parser.add_option(action='callback',
227
callback=self._optparse_callback,
228
type='string', metavar=self.argname.upper(),
230
default=OptionParser.DEFAULT_VALUE,
233
def _optparse_bool_callback(self, option, opt_str, value, parser, bool_v):
234
setattr(parser.values, self._param_name, bool_v)
235
if self.custom_callback is not None:
236
self.custom_callback(option, self._param_name, bool_v, parser)
238
def _optparse_callback(self, option, opt, value, parser):
240
setattr(parser.values, self._param_name, v)
241
if self.custom_callback is not None:
242
self.custom_callback(option, self.name, v, parser)
244
def iter_switches(self):
245
"""Iterate through the list of switches provided by the option
247
:return: an iterator of (name, short_name, argname, help)
249
argname = self.argname
250
if argname is not None:
251
argname = argname.upper()
252
yield self.name, self.short_name(), argname, self.help
254
def is_hidden(self, name):
258
class ListOption(Option):
259
"""Option used to provide a list of values.
261
On the command line, arguments are specified by a repeated use of the
262
option. '-' is a special argument that resets the list. For example,
264
sets the value of the 'foo' option to ['a', 'b'], and
265
--foo=a --foo=b --foo=- --foo=c
266
sets the value of the 'foo' option to ['c'].
269
def add_option(self, parser, short_name):
270
"""Add this option to an Optparse parser."""
271
option_strings = ['--%s' % self.name]
272
if short_name is not None:
273
option_strings.append('-%s' % short_name)
274
parser.add_option(action='callback',
275
callback=self._optparse_callback,
276
type='string', metavar=self.argname.upper(),
277
help=self.help, default=[],
280
def _optparse_callback(self, option, opt, value, parser):
281
values = getattr(parser.values, self._param_name)
285
values.append(self.type(value))
286
if self.custom_callback is not None:
287
self.custom_callback(option, self._param_name, values, parser)
290
class RegistryOption(Option):
291
"""Option based on a registry
293
The values for the options correspond to entries in the registry. Input
294
must be a registry key. After validation, it is converted into an object
295
using Registry.get or a caller-provided converter.
298
def validate_value(self, value):
299
"""Validate a value name"""
300
if value not in self.registry:
301
raise errors.BadOptionValue(self.name, value)
303
def convert(self, value):
304
"""Convert a value name into an output type"""
305
self.validate_value(value)
306
if self.converter is None:
307
return self.registry.get(value)
309
return self.converter(value)
311
def __init__(self, name, help, registry=None, converter=None,
312
value_switches=False, title=None, enum_switch=True,
317
:param name: The option name.
318
:param help: Help for the option.
319
:param registry: A Registry containing the values
320
:param converter: Callable to invoke with the value name to produce
321
the value. If not supplied, self.registry.get is used.
322
:param value_switches: If true, each possible value is assigned its
323
own switch. For example, instead of '--format knit',
324
'--knit' can be used interchangeably.
325
:param enum_switch: If true, a switch is provided with the option name,
327
:param lazy_registry: A tuple of (module name, attribute name) for a
328
registry to be lazily loaded.
330
Option.__init__(self, name, help, type=self.convert)
331
self._registry = registry
333
assert lazy_registry is not None, (
334
'One of registry or lazy_registry must be given.')
335
self._lazy_registry = _mod_registry._LazyObjectGetter(
338
self.converter = converter
339
self.value_switches = value_switches
340
self.enum_switch = enum_switch
342
if self.title is None:
347
if self._registry is not None:
348
return self._registry
350
return self._lazy_registry.get_obj()
353
def from_kwargs(name_, help=None, title=None, value_switches=False,
354
enum_switch=True, **kwargs):
355
"""Convenience method to generate string-map registry options
357
name, help, value_switches and enum_switch are passed to the
358
RegistryOption constructor. Any other keyword arguments are treated
359
as values for the option, and they value is treated as the help.
361
reg = _mod_registry.Registry()
362
for name, switch_help in kwargs.iteritems():
363
name = name.replace('_', '-')
364
reg.register(name, name, help=switch_help)
365
return RegistryOption(name_, help, reg, title=title,
366
value_switches=value_switches, enum_switch=enum_switch)
368
def add_option(self, parser, short_name):
369
"""Add this option to an Optparse parser"""
370
if self.value_switches:
371
parser = parser.add_option_group(self.title)
373
Option.add_option(self, parser, short_name)
374
if self.value_switches:
375
for key in self.registry.keys():
376
option_strings = ['--%s' % key]
377
if self.is_hidden(key):
378
help = optparse.SUPPRESS_HELP
380
help = self.registry.get_help(key)
381
parser.add_option(action='callback',
382
callback=self._optparse_value_callback(key),
386
def _optparse_value_callback(self, cb_value):
387
def cb(option, opt, value, parser):
388
v = self.type(cb_value)
389
setattr(parser.values, self._param_name, v)
390
if self.custom_callback is not None:
391
self.custom_callback(option, self._param_name, v, parser)
394
def iter_switches(self):
395
"""Iterate through the list of switches provided by the option
397
:return: an iterator of (name, short_name, argname, help)
399
for value in Option.iter_switches(self):
401
if self.value_switches:
402
for key in sorted(self.registry.keys()):
403
yield key, None, None, self.registry.get_help(key)
405
def is_hidden(self, name):
406
if name == self.name:
407
return Option.is_hidden(self, name)
408
return getattr(self.registry.get_info(name), 'hidden', False)
411
class OptionParser(optparse.OptionParser):
412
"""OptionParser that raises exceptions instead of exiting"""
414
DEFAULT_VALUE = object()
416
def error(self, message):
417
raise errors.BzrCommandError(message)
420
def get_optparser(options):
421
"""Generate an optparse parser for bzrlib-style options"""
423
parser = OptionParser()
424
parser.remove_option('--help')
425
for option in options.itervalues():
426
option.add_option(parser, option.short_name())
430
def custom_help(name, help):
431
"""Clone a common option overriding the help."""
433
o = copy.copy(Option.OPTIONS[name])
438
def _standard_option(name, **kwargs):
439
"""Register a standard option."""
440
# All standard options are implicitly 'global' ones
441
Option.STD_OPTIONS[name] = Option(name, **kwargs)
442
Option.OPTIONS[name] = Option.STD_OPTIONS[name]
445
def _global_option(name, **kwargs):
446
"""Register a global option."""
447
Option.OPTIONS[name] = Option(name, **kwargs)
450
def _global_registry_option(name, help, registry=None, **kwargs):
451
Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
454
class MergeTypeRegistry(_mod_registry.Registry):
459
# This is the verbosity level detected during command line parsing.
460
# Note that the final value is dependent on the order in which the
461
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
462
# The final value will be one of the following:
470
def _verbosity_level_callback(option, opt_str, value, parser):
471
global _verbosity_level
473
# Either --no-verbose or --no-quiet was specified
475
elif opt_str == "verbose":
476
if _verbosity_level > 0:
477
_verbosity_level += 1
481
if _verbosity_level < 0:
482
_verbosity_level -= 1
484
_verbosity_level = -1
487
_merge_type_registry = MergeTypeRegistry()
488
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
489
"Native diff3-style merge")
490
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
491
"Merge using external diff3")
492
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
494
_merge_type_registry.register_lazy('lca', 'bzrlib.merge', 'LCAMerger',
497
# Declare the standard options
498
_standard_option('help', short_name='h',
499
help='Show help message.')
500
_standard_option('verbose', short_name='v',
501
help='Display more information.',
502
custom_callback=_verbosity_level_callback)
503
_standard_option('quiet', short_name='q',
504
help="Only display errors and warnings.",
505
custom_callback=_verbosity_level_callback)
507
# Declare commonly used options
508
_global_option('all')
509
_global_option('overwrite', help='Ignore differences between branches and '
510
'overwrite unconditionally.')
511
_global_option('basis', type=str)
512
_global_option('bound')
513
_global_option('diff-options', type=str)
514
_global_option('file', type=unicode, short_name='F')
515
_global_option('force')
516
_global_option('format', type=unicode)
517
_global_option('forward')
518
_global_option('message', type=unicode,
520
help='Message string.')
521
_global_option('no-recurse')
522
_global_option('profile',
523
help='Show performance profiling information.')
524
_global_option('revision',
525
type=_parse_revision_str,
527
help='See "help revisionspec" for details.')
528
_global_option('change',
529
type=_parse_change_str,
531
param_name='revision',
532
help='Select changes introduced by the specified revision. See also "help revisionspec".')
533
_global_option('show-ids',
534
help='Show internal object ids.')
535
_global_option('timezone',
537
help='display timezone as local, original, or utc')
538
_global_option('unbound')
539
_global_option('version')
540
_global_option('email')
541
_global_option('update')
542
_global_registry_option('log-format', "Use specified log format.",
543
lazy_registry=('bzrlib.log', 'log_formatter_registry'),
544
value_switches=True, title='Log format')
545
_global_option('long', help='Use detailed log format. Same as --log-format long',
547
_global_option('short', help='Use moderately short log format. Same as --log-format short')
548
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
549
_global_option('root', type=str)
550
_global_option('no-backup')
551
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
552
_merge_type_registry, value_switches=True,
553
title='Merge algorithm')
554
_global_option('pattern', type=str)
555
_global_option('remember', help='Remember the specified location as a'
557
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
558
_global_option('kind', type=str)
559
_global_option('dry-run',
560
help="Show what would be done, but don't actually do anything.")
561
_global_option('name-from-revision', help='The path name in the old tree.')
added
removed
bzrlib/option.py
