1
# Copyright (C) 2004, 2005, 2006 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.
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
34
from bzrlib.trace import warning
37
def _parse_revision_str(revstr):
38
"""This handles a revision string -> revno.
40
This always returns a list. The list will have one element for
41
each revision specifier supplied.
43
>>> _parse_revision_str('234')
44
[<RevisionSpec_revno 234>]
45
>>> _parse_revision_str('234..567')
46
[<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
47
>>> _parse_revision_str('..')
48
[<RevisionSpec None>, <RevisionSpec None>]
49
>>> _parse_revision_str('..234')
50
[<RevisionSpec None>, <RevisionSpec_revno 234>]
51
>>> _parse_revision_str('234..')
52
[<RevisionSpec_revno 234>, <RevisionSpec None>]
53
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
54
[<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
55
>>> _parse_revision_str('234....789') #Error ?
56
[<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
57
>>> _parse_revision_str('revid:test@other.com-234234')
58
[<RevisionSpec_revid revid:test@other.com-234234>]
59
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
60
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
61
>>> _parse_revision_str('revid:test@other.com-234234..23')
62
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
63
>>> _parse_revision_str('date:2005-04-12')
64
[<RevisionSpec_date date:2005-04-12>]
65
>>> _parse_revision_str('date:2005-04-12 12:24:33')
66
[<RevisionSpec_date date:2005-04-12 12:24:33>]
67
>>> _parse_revision_str('date:2005-04-12T12:24:33')
68
[<RevisionSpec_date date:2005-04-12T12:24:33>]
69
>>> _parse_revision_str('date:2005-04-12,12:24:33')
70
[<RevisionSpec_date date:2005-04-12,12:24:33>]
71
>>> _parse_revision_str('-5..23')
72
[<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
73
>>> _parse_revision_str('-5')
74
[<RevisionSpec_revno -5>]
75
>>> _parse_revision_str('123a')
76
Traceback (most recent call last):
78
NoSuchRevisionSpec: No namespace registered for string: '123a'
79
>>> _parse_revision_str('abc')
80
Traceback (most recent call last):
82
NoSuchRevisionSpec: No namespace registered for string: 'abc'
83
>>> _parse_revision_str('branch:../branch2')
84
[<RevisionSpec_branch branch:../branch2>]
85
>>> _parse_revision_str('branch:../../branch2')
86
[<RevisionSpec_branch branch:../../branch2>]
87
>>> _parse_revision_str('branch:../../branch2..23')
88
[<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
90
# TODO: Maybe move this into revisionspec.py
92
# split on the first .. that is not followed by a / ?
93
sep = re.compile("\\.\\.(?!/)")
94
for x in sep.split(revstr):
95
revs.append(revisionspec.RevisionSpec.from_string(x or None))
99
def _parse_merge_type(typestring):
100
return get_merge_type(typestring)
102
def get_merge_type(typestring):
103
"""Attempt to find the merge class/factory associated with a string."""
104
from merge import merge_types
106
return merge_types[typestring][0]
108
templ = '%s%%7s: %%s' % (' '*12)
109
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
110
type_list = '\n'.join(lines)
111
msg = "No known merge type %s. Supported types are:\n%s" %\
112
(typestring, type_list)
113
raise errors.BzrCommandError(msg)
116
class Option(object):
117
"""Description of a command line option
119
:ivar _short_name: If this option has a single-letter name, this is it.
123
# TODO: Some way to show in help a description of the option argument
127
def __init__(self, name, help='', type=None, argname=None,
129
"""Make a new command option.
131
name -- regular name of the command, used in the double-dash
132
form and also as the parameter to the command's run()
135
help -- help message displayed in command help
137
type -- function called to parse the option argument, or
138
None (default) if this option doesn't take an argument.
140
argname -- name of option argument, if any
145
self._short_name = short_name
147
assert argname is None
148
elif argname is None:
150
self.argname = argname
152
def short_name(self):
154
return self._short_name
156
# remove this when SHORT_OPTIONS is removed
157
# XXX: This is accessing a DeprecatedDict, so we call the super
158
# method to avoid warnings
159
for (k, v) in dict.iteritems(Option.SHORT_OPTIONS):
163
def set_short_name(self, short_name):
164
self._short_name = short_name
166
def get_negation_name(self):
167
if self.name.startswith('no-'):
170
return 'no-' + self.name
172
def add_option(self, parser, short_name):
173
"""Add this option to an Optparse parser"""
174
option_strings = ['--%s' % self.name]
175
if short_name is not None:
176
option_strings.append('-%s' % short_name)
179
parser.add_option(action='store_true', dest=self.name,
181
default=OptionParser.DEFAULT_VALUE,
183
negation_strings = ['--%s' % self.get_negation_name()]
184
parser.add_option(action='store_false', dest=self.name,
185
help=optparse.SUPPRESS_HELP, *negation_strings)
187
parser.add_option(action='callback',
188
callback=self._optparse_callback,
189
type='string', metavar=self.argname.upper(),
191
default=OptionParser.DEFAULT_VALUE,
194
def _optparse_callback(self, option, opt, value, parser):
195
setattr(parser.values, self.name, self.type(value))
197
def iter_switches(self):
198
"""Iterate through the list of switches provided by the option
200
:return: an iterator of (name, short_name, argname, help)
202
argname = self.argname
203
if argname is not None:
204
argname = argname.upper()
205
yield self.name, self.short_name(), argname, self.help
208
class ListOption(Option):
209
"""Option used to provide a list of values.
211
On the command line, arguments are specified by a repeated use of the
212
option. '-' is a special argument that resets the list. For example,
214
sets the value of the 'foo' option to ['a', 'b'], and
215
--foo=a --foo=b --foo=- --foo=c
216
sets the value of the 'foo' option to ['c'].
219
def add_option(self, parser, short_name):
220
"""Add this option to an Optparse parser."""
221
option_strings = ['--%s' % self.name]
222
if short_name is not None:
223
option_strings.append('-%s' % short_name)
224
parser.add_option(action='callback',
225
callback=self._optparse_callback,
226
type='string', metavar=self.argname.upper(),
227
help=self.help, default=[],
230
def _optparse_callback(self, option, opt, value, parser):
231
values = getattr(parser.values, self.name)
235
values.append(self.type(value))
238
class RegistryOption(Option):
239
"""Option based on a registry
241
The values for the options correspond to entries in the registry. Input
242
must be a registry key. After validation, it is converted into an object
243
using Registry.get or a caller-provided converter.
246
def validate_value(self, value):
247
"""Validate a value name"""
248
if value not in self.registry:
249
raise errors.BadOptionValue(self.name, value)
251
def convert(self, value):
252
"""Convert a value name into an output type"""
253
self.validate_value(value)
254
if self.converter is None:
255
return self.registry.get(value)
257
return self.converter(value)
259
def __init__(self, name, help, registry, converter=None,
260
value_switches=False, title=None, enum_switch=True):
264
:param name: The option name.
265
:param help: Help for the option.
266
:param registry: A Registry containing the values
267
:param converter: Callable to invoke with the value name to produce
268
the value. If not supplied, self.registry.get is used.
269
:param value_switches: If true, each possible value is assigned its
270
own switch. For example, instead of '--format knit',
271
'--knit' can be used interchangeably.
272
:param enum_switch: If true, a switch is provided with the option name,
275
Option.__init__(self, name, help, type=self.convert)
276
self.registry = registry
278
self.converter = converter
279
self.value_switches = value_switches
280
self.enum_switch = enum_switch
282
if self.title is None:
286
def from_kwargs(name_, help=None, title=None, value_switches=False,
287
enum_switch=True, **kwargs):
288
"""Convenience method to generate string-map registry options
290
name, help, value_switches and enum_switch are passed to the
291
RegistryOption constructor. Any other keyword arguments are treated
292
as values for the option, and they value is treated as the help.
294
reg = registry.Registry()
295
for name, help in kwargs.iteritems():
296
name = name.replace('_', '-')
297
reg.register(name, name, help=help)
298
return RegistryOption(name_, help, reg, title=title,
299
value_switches=value_switches, enum_switch=enum_switch)
301
def add_option(self, parser, short_name):
302
"""Add this option to an Optparse parser"""
303
if self.value_switches:
304
parser = parser.add_option_group(self.title)
306
Option.add_option(self, parser, short_name)
307
if self.value_switches:
308
for key in self.registry.keys():
309
option_strings = ['--%s' % key]
310
if getattr(self.registry.get_info(key), 'hidden', False):
311
help = optparse.SUPPRESS_HELP
313
help = self.registry.get_help(key)
314
parser.add_option(action='callback',
315
callback=self._optparse_value_callback(key),
319
def _optparse_value_callback(self, cb_value):
320
def cb(option, opt, value, parser):
321
setattr(parser.values, self.name, self.type(cb_value))
324
def iter_switches(self):
325
"""Iterate through the list of switches provided by the option
327
:return: an iterator of (name, short_name, argname, help)
329
for value in Option.iter_switches(self):
331
if self.value_switches:
332
for key in sorted(self.registry.keys()):
333
yield key, None, None, self.registry.get_help(key)
336
class OptionParser(optparse.OptionParser):
337
"""OptionParser that raises exceptions instead of exiting"""
339
DEFAULT_VALUE = object()
341
def error(self, message):
342
raise errors.BzrCommandError(message)
345
def get_optparser(options):
346
"""Generate an optparse parser for bzrlib-style options"""
348
parser = OptionParser()
349
parser.remove_option('--help')
350
for option in options.itervalues():
351
option.add_option(parser, option.short_name())
355
def _global_option(name, **kwargs):
356
"""Register o as a global option."""
357
Option.OPTIONS[name] = Option(name, **kwargs)
360
def _global_registry_option(name, help, registry, **kwargs):
361
Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
364
class MergeTypeRegistry(registry.Registry):
369
_merge_type_registry = MergeTypeRegistry()
370
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
371
"Native diff3-style merge")
372
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
373
"Merge using external diff3")
374
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
377
_global_option('all')
378
_global_option('overwrite', help='Ignore differences between branches and '
379
'overwrite unconditionally')
380
_global_option('basis', type=str)
381
_global_option('bound')
382
_global_option('diff-options', type=str)
383
_global_option('help',
384
help='show help message',
386
_global_option('file', type=unicode, short_name='F')
387
_global_option('force')
388
_global_option('format', type=unicode)
389
_global_option('forward')
390
_global_option('message', type=unicode,
392
_global_option('no-recurse')
393
_global_option('profile',
394
help='show performance profiling information')
395
_global_option('revision',
396
type=_parse_revision_str,
398
help='See \'help revisionspec\' for details')
399
_global_option('show-ids',
400
help='show internal object ids')
401
_global_option('timezone',
403
help='display timezone as local, original, or utc')
404
_global_option('unbound')
405
_global_option('verbose',
406
help='display more information',
408
_global_option('version')
409
_global_option('email')
410
_global_option('update')
411
_global_registry_option('log-format', "Use this log format",
412
log.log_formatter_registry, value_switches=True,
414
_global_option('long', help='Use detailed log format. Same as --log-format long',
416
_global_option('short', help='Use moderately short log format. Same as --log-format short')
417
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
418
_global_option('root', type=str)
419
_global_option('no-backup')
420
_global_registry_option('merge-type', 'Select a particular merge algorithm',
421
_merge_type_registry, value_switches=True,
422
title='Merge algorithm')
423
_global_option('pattern', type=str)
424
_global_option('quiet', short_name='q')
425
_global_option('remember', help='Remember the specified location as a'
427
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
428
_global_option('kind', type=str)
429
_global_option('dry-run',
430
help="show what would be done, but don't actually do anything")
431
_global_option('name-from-revision', help='The path name in the old tree.')
434
# prior to 0.14 these were always globally registered; the old dict is
435
# available for plugins that use it but it should not be used.
436
Option.SHORT_OPTIONS = symbol_versioning.DeprecatedDict(
437
symbol_versioning.zero_fourteen,
440
'F': Option.OPTIONS['file'],
441
'h': Option.OPTIONS['help'],
442
'm': Option.OPTIONS['message'],
443
'r': Option.OPTIONS['revision'],
444
'v': Option.OPTIONS['verbose'],
445
'l': Option.OPTIONS['long'],
446
'q': Option.OPTIONS['quiet'],
448
'Set the short option name when constructing the Option.',
added
removed
bzrlib/option.py
