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(), """
33
from bzrlib.trace import warning
36
def _parse_revision_str(revstr):
37
"""This handles a revision string -> revno.
39
This always returns a list. The list will have one element for
40
each revision specifier supplied.
42
>>> _parse_revision_str('234')
43
[<RevisionSpec_revno 234>]
44
>>> _parse_revision_str('234..567')
45
[<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
46
>>> _parse_revision_str('..')
47
[<RevisionSpec None>, <RevisionSpec None>]
48
>>> _parse_revision_str('..234')
49
[<RevisionSpec None>, <RevisionSpec_revno 234>]
50
>>> _parse_revision_str('234..')
51
[<RevisionSpec_revno 234>, <RevisionSpec None>]
52
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
53
[<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
54
>>> _parse_revision_str('234....789') #Error ?
55
[<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
56
>>> _parse_revision_str('revid:test@other.com-234234')
57
[<RevisionSpec_revid revid:test@other.com-234234>]
58
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
59
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
60
>>> _parse_revision_str('revid:test@other.com-234234..23')
61
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
62
>>> _parse_revision_str('date:2005-04-12')
63
[<RevisionSpec_date date:2005-04-12>]
64
>>> _parse_revision_str('date:2005-04-12 12:24:33')
65
[<RevisionSpec_date date:2005-04-12 12:24:33>]
66
>>> _parse_revision_str('date:2005-04-12T12:24:33')
67
[<RevisionSpec_date date:2005-04-12T12:24:33>]
68
>>> _parse_revision_str('date:2005-04-12,12:24:33')
69
[<RevisionSpec_date date:2005-04-12,12:24:33>]
70
>>> _parse_revision_str('-5..23')
71
[<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
72
>>> _parse_revision_str('-5')
73
[<RevisionSpec_revno -5>]
74
>>> _parse_revision_str('123a')
75
Traceback (most recent call last):
77
NoSuchRevisionSpec: No namespace registered for string: '123a'
78
>>> _parse_revision_str('abc')
79
Traceback (most recent call last):
81
NoSuchRevisionSpec: No namespace registered for string: 'abc'
82
>>> _parse_revision_str('branch:../branch2')
83
[<RevisionSpec_branch branch:../branch2>]
84
>>> _parse_revision_str('branch:../../branch2')
85
[<RevisionSpec_branch branch:../../branch2>]
86
>>> _parse_revision_str('branch:../../branch2..23')
87
[<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
89
# TODO: Maybe move this into revisionspec.py
91
# split on the first .. that is not followed by a / ?
92
sep = re.compile("\\.\\.(?!/)")
93
for x in sep.split(revstr):
94
revs.append(revisionspec.RevisionSpec.from_string(x or None))
98
def _parse_merge_type(typestring):
99
return get_merge_type(typestring)
101
def get_merge_type(typestring):
102
"""Attempt to find the merge class/factory associated with a string."""
103
from merge import merge_types
105
return merge_types[typestring][0]
107
templ = '%s%%7s: %%s' % (' '*12)
108
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
109
type_list = '\n'.join(lines)
110
msg = "No known merge type %s. Supported types are:\n%s" %\
111
(typestring, type_list)
112
raise errors.BzrCommandError(msg)
115
class Option(object):
116
"""Description of a command line option
118
:ivar _short_name: If this option has a single-letter name, this is it.
122
# TODO: Some way to show in help a description of the option argument
126
def __init__(self, name, help='', type=None, argname=None,
128
"""Make a new command option.
130
name -- regular name of the command, used in the double-dash
131
form and also as the parameter to the command's run()
134
help -- help message displayed in command help
136
type -- function called to parse the option argument, or
137
None (default) if this option doesn't take an argument.
139
argname -- name of option argument, if any
144
self._short_name = short_name
146
assert argname is None
147
elif argname is None:
149
self.argname = argname
151
def short_name(self):
153
return self._short_name
155
# remove this when SHORT_OPTIONS is removed
156
# XXX: This is accessing a DeprecatedDict, so we call the super
157
# method to avoid warnings
158
for (k, v) in dict.iteritems(Option.SHORT_OPTIONS):
162
def set_short_name(self, short_name):
163
self._short_name = short_name
165
def get_negation_name(self):
166
if self.name.startswith('no-'):
169
return 'no-' + self.name
171
def add_option(self, parser, short_name):
172
"""Add this option to an Optparse parser"""
173
option_strings = ['--%s' % self.name]
174
if short_name is not None:
175
option_strings.append('-%s' % short_name)
178
parser.add_option(action='store_true', dest=self.name,
180
default=OptionParser.DEFAULT_VALUE,
182
negation_strings = ['--%s' % self.get_negation_name()]
183
parser.add_option(action='store_false', dest=self.name,
184
help=optparse.SUPPRESS_HELP, *negation_strings)
186
parser.add_option(action='callback',
187
callback=self._optparse_callback,
188
type='string', metavar=self.argname.upper(),
190
default=OptionParser.DEFAULT_VALUE,
193
def _optparse_callback(self, option, opt, value, parser):
194
setattr(parser.values, self.name, self.type(value))
196
def iter_switches(self):
197
"""Iterate through the list of switches provided by the option
199
:return: an iterator of (name, short_name, argname, help)
201
argname = self.argname
202
if argname is not None:
203
argname = argname.upper()
204
yield self.name, self.short_name(), argname, self.help
207
class RegistryOption(Option):
208
"""Option based on a registry
210
The values for the options correspond to entries in the registry. Input
211
must be a registry key. After validation, it is converted into an object
212
using Registry.get or a caller-provided converter.
215
def validate_value(self, value):
216
"""Validate a value name"""
217
if value not in self.registry:
218
raise errors.BadOptionValue(self.name, value)
220
def convert(self, value):
221
"""Convert a value name into an output type"""
222
self.validate_value(value)
223
if self.converter is None:
224
return self.registry.get(value)
226
return self.converter(value)
228
def __init__(self, name, help, registry, converter=None,
229
value_switches=False, title=None):
233
:param name: The option name.
234
:param help: Help for the option.
235
:param registry: A Registry containing the values
236
:param converter: Callable to invoke with the value name to produce
237
the value. If not supplied, self.registry.get is used.
238
:param value_switches: If true, each possible value is assigned its
239
own switch. For example, instead of '--format metaweave',
240
'--metaweave' can be used interchangeably.
242
Option.__init__(self, name, help, type=self.convert)
243
self.registry = registry
245
self.converter = converter
246
self.value_switches = value_switches
248
if self.title is None:
251
def add_option(self, parser, short_name):
252
"""Add this option to an Optparse parser"""
253
if self.value_switches:
254
parser = parser.add_option_group(self.title)
255
Option.add_option(self, parser, short_name)
256
if self.value_switches:
257
for key in self.registry.keys():
258
option_strings = ['--%s' % key]
259
parser.add_option(action='callback',
260
callback=self._optparse_value_callback(key),
261
help=self.registry.get_help(key),
264
def _optparse_value_callback(self, cb_value):
265
def cb(option, opt, value, parser):
266
setattr(parser.values, self.name, self.type(cb_value))
269
def iter_switches(self):
270
"""Iterate through the list of switches provided by the option
272
:return: an iterator of (name, short_name, argname, help)
274
for value in Option.iter_switches(self):
276
if self.value_switches:
277
for key in sorted(self.registry.keys()):
278
yield key, None, None, self.registry.get_help(key)
281
class OptionParser(optparse.OptionParser):
282
"""OptionParser that raises exceptions instead of exiting"""
284
DEFAULT_VALUE = object()
286
def error(self, message):
287
raise errors.BzrCommandError(message)
290
def get_optparser(options):
291
"""Generate an optparse parser for bzrlib-style options"""
293
parser = OptionParser()
294
parser.remove_option('--help')
295
for option in options.itervalues():
296
option.add_option(parser, option.short_name())
300
def _global_option(name, **kwargs):
301
"""Register o as a global option."""
302
Option.OPTIONS[name] = Option(name, **kwargs)
305
def _global_registry_option(name, help, registry, **kwargs):
306
Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
309
_global_option('all')
310
_global_option('overwrite', help='Ignore differences between branches and '
311
'overwrite unconditionally')
312
_global_option('basis', type=str)
313
_global_option('bound')
314
_global_option('diff-options', type=str)
315
_global_option('help',
316
help='show help message',
318
_global_option('file', type=unicode, short_name='F')
319
_global_option('force')
320
_global_option('format', type=unicode)
321
_global_option('forward')
322
_global_option('message', type=unicode,
324
_global_option('no-recurse')
325
_global_option('profile',
326
help='show performance profiling information')
327
_global_option('revision',
328
type=_parse_revision_str,
330
help='See \'help revisionspec\' for details')
331
_global_option('show-ids',
332
help='show internal object ids')
333
_global_option('timezone',
335
help='display timezone as local, original, or utc')
336
_global_option('unbound')
337
_global_option('verbose',
338
help='display more information',
340
_global_option('version')
341
_global_option('email')
342
_global_option('update')
343
_global_registry_option('log-format', "Use this log format",
344
log.log_formatter_registry, value_switches=True,
346
_global_option('long', help='Use detailed log format. Same as --log-format long',
348
_global_option('short', help='Use moderately short log format. Same as --log-format short')
349
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
350
_global_option('root', type=str)
351
_global_option('no-backup')
352
_global_option('merge-type', type=_parse_merge_type,
353
help='Select a particular merge algorithm')
354
_global_option('pattern', type=str)
355
_global_option('quiet', short_name='q')
356
_global_option('remember', help='Remember the specified location as a'
358
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
359
_global_option('kind', type=str)
360
_global_option('dry-run',
361
help="show what would be done, but don't actually do anything")
362
_global_option('name-from-revision', help='The path name in the old tree.')
365
# prior to 0.14 these were always globally registered; the old dict is
366
# available for plugins that use it but it should not be used.
367
Option.SHORT_OPTIONS = symbol_versioning.DeprecatedDict(
368
symbol_versioning.zero_fourteen,
371
'F': Option.OPTIONS['file'],
372
'h': Option.OPTIONS['help'],
373
'm': Option.OPTIONS['message'],
374
'r': Option.OPTIONS['revision'],
375
'v': Option.OPTIONS['verbose'],
376
'l': Option.OPTIONS['long'],
377
'q': Option.OPTIONS['quiet'],
379
'Set the short option name when constructing the Option.',
added
removed
bzrlib/option.py
