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(), """
32
from bzrlib.trace import warning
35
def _parse_revision_str(revstr):
36
"""This handles a revision string -> revno.
38
This always returns a list. The list will have one element for
39
each revision specifier supplied.
41
>>> _parse_revision_str('234')
42
[<RevisionSpec_revno 234>]
43
>>> _parse_revision_str('234..567')
44
[<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
45
>>> _parse_revision_str('..')
46
[<RevisionSpec None>, <RevisionSpec None>]
47
>>> _parse_revision_str('..234')
48
[<RevisionSpec None>, <RevisionSpec_revno 234>]
49
>>> _parse_revision_str('234..')
50
[<RevisionSpec_revno 234>, <RevisionSpec None>]
51
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
52
[<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
53
>>> _parse_revision_str('234....789') #Error ?
54
[<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
55
>>> _parse_revision_str('revid:test@other.com-234234')
56
[<RevisionSpec_revid revid:test@other.com-234234>]
57
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
58
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
59
>>> _parse_revision_str('revid:test@other.com-234234..23')
60
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
61
>>> _parse_revision_str('date:2005-04-12')
62
[<RevisionSpec_date date:2005-04-12>]
63
>>> _parse_revision_str('date:2005-04-12 12:24:33')
64
[<RevisionSpec_date date:2005-04-12 12:24:33>]
65
>>> _parse_revision_str('date:2005-04-12T12:24:33')
66
[<RevisionSpec_date date:2005-04-12T12:24:33>]
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('-5..23')
70
[<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
71
>>> _parse_revision_str('-5')
72
[<RevisionSpec_revno -5>]
73
>>> _parse_revision_str('123a')
74
Traceback (most recent call last):
76
NoSuchRevisionSpec: No namespace registered for string: '123a'
77
>>> _parse_revision_str('abc')
78
Traceback (most recent call last):
80
NoSuchRevisionSpec: No namespace registered for string: 'abc'
81
>>> _parse_revision_str('branch:../branch2')
82
[<RevisionSpec_branch branch:../branch2>]
83
>>> _parse_revision_str('branch:../../branch2')
84
[<RevisionSpec_branch branch:../../branch2>]
85
>>> _parse_revision_str('branch:../../branch2..23')
86
[<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
88
# TODO: Maybe move this into revisionspec.py
90
# split on the first .. that is not followed by a / ?
91
sep = re.compile("\\.\\.(?!/)")
92
for x in sep.split(revstr):
93
revs.append(revisionspec.RevisionSpec.from_string(x or None))
97
def _parse_merge_type(typestring):
98
return get_merge_type(typestring)
100
def get_merge_type(typestring):
101
"""Attempt to find the merge class/factory associated with a string."""
102
from merge import merge_types
104
return merge_types[typestring][0]
106
templ = '%s%%7s: %%s' % (' '*12)
107
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
108
type_list = '\n'.join(lines)
109
msg = "No known merge type %s. Supported types are:\n%s" %\
110
(typestring, type_list)
111
raise errors.BzrCommandError(msg)
114
class Option(object):
115
"""Description of a command line option
117
:ivar _short_name: If this option has a single-letter name, this is it.
121
# TODO: Some way to show in help a description of the option argument
125
def __init__(self, name, help='', type=None, argname=None,
127
"""Make a new command option.
129
name -- regular name of the command, used in the double-dash
130
form and also as the parameter to the command's run()
133
help -- help message displayed in command help
135
type -- function called to parse the option argument, or
136
None (default) if this option doesn't take an argument.
138
argname -- name of option argument, if any
143
self._short_name = short_name
145
assert argname is None
146
elif argname is None:
148
self.argname = argname
150
def short_name(self):
152
return self._short_name
154
# remove this when SHORT_OPTIONS is removed
155
# XXX: This is accessing a DeprecatedDict, so we call the super
156
# method to avoid warnings
157
for (k, v) in dict.iteritems(Option.SHORT_OPTIONS):
161
def set_short_name(self, short_name):
162
self._short_name = short_name
164
def get_negation_name(self):
165
if self.name.startswith('no-'):
168
return 'no-' + self.name
170
def add_option(self, parser, short_name):
171
"""Add this option to an Optparse parser"""
172
option_strings = ['--%s' % self.name]
173
if short_name is not None:
174
option_strings.append('-%s' % short_name)
177
parser.add_option(action='store_true', dest=self.name,
179
default=OptionParser.DEFAULT_VALUE,
181
negation_strings = ['--%s' % self.get_negation_name()]
182
parser.add_option(action='store_false', dest=self.name,
183
help=optparse.SUPPRESS_HELP, *negation_strings)
185
parser.add_option(action='callback',
186
callback=self._optparse_callback,
187
type='string', metavar=self.argname.upper(),
189
default=OptionParser.DEFAULT_VALUE,
192
def _optparse_callback(self, option, opt, value, parser):
193
setattr(parser.values, self.name, self.type(value))
195
def iter_switches(self):
196
"""Iterate through the list of switches provided by the option
198
:return: an iterator of (name, short_name, argname, help)
200
argname = self.argname
201
if argname is not None:
202
argname = argname.upper()
203
yield self.name, self.short_name(), argname, self.help
206
class RegistryOption(Option):
207
"""Option based on a registry
209
The values for the options correspond to entries in the registry. Input
210
must be a registry key. After validation, it is converted into an object
211
using Registry.get or a caller-provided converter.
214
def validate_value(self, value):
215
"""Validate a value name"""
216
if value not in self.registry:
217
raise errors.BadOptionValue(self.name, value)
219
def convert(self, value):
220
"""Convert a value name into an output type"""
221
self.validate_value(value)
222
if self.converter is None:
223
return self.registry.get(value)
225
return self.converter(value)
227
def __init__(self, name, help, registry, converter=None,
228
value_switches=False):
232
:param name: The option name.
233
:param help: Help for the option.
234
:param registry: A Registry containing the values
235
:param converter: Callable to invoke with the value name to produce
236
the value. If not supplied, self.registry.get is used.
237
:param value_switches: If true, each possible value is assigned its
238
own switch. For example, instead of '--format metaweave',
239
'--metaweave' can be used interchangeably.
241
Option.__init__(self, name, help, type=self.convert)
242
self.registry = registry
244
self.converter = converter
245
self.value_switches = value_switches
247
def add_option(self, parser, short_name):
248
"""Add this option to an Optparse parser"""
249
Option.add_option(self, parser, short_name)
250
if self.value_switches:
251
for key in self.registry.keys():
252
option_strings = ['--%s' % key]
253
parser.add_option(action='callback',
254
callback=self._optparse_value_callback(key),
255
help=self.registry.get_help(key),
258
def _optparse_value_callback(self, cb_value):
259
def cb(option, opt, value, parser):
260
setattr(parser.values, self.name, self.type(cb_value))
263
def iter_switches(self):
264
"""Iterate through the list of switches provided by the option
266
:return: an iterator of (name, short_name, argname, help)
268
for value in Option.iter_switches(self):
270
if self.value_switches:
271
for key in sorted(self.registry.keys()):
272
yield key, None, None, self.registry.get_help(key)
275
class OptionParser(optparse.OptionParser):
276
"""OptionParser that raises exceptions instead of exiting"""
278
DEFAULT_VALUE = object()
280
def error(self, message):
281
raise errors.BzrCommandError(message)
284
def get_optparser(options):
285
"""Generate an optparse parser for bzrlib-style options"""
287
parser = OptionParser()
288
parser.remove_option('--help')
289
for option in options.itervalues():
290
option.add_option(parser, option.short_name())
294
def _global_option(name, **kwargs):
295
"""Register o as a global option."""
296
Option.OPTIONS[name] = Option(name, **kwargs)
298
_global_option('all')
299
_global_option('overwrite', help='Ignore differences between branches and '
300
'overwrite unconditionally')
301
_global_option('basis', type=str)
302
_global_option('bound')
303
_global_option('diff-options', type=str)
304
_global_option('help',
305
help='show help message',
307
_global_option('file', type=unicode, short_name='F')
308
_global_option('force')
309
_global_option('format', type=unicode)
310
_global_option('forward')
311
_global_option('message', type=unicode,
313
_global_option('no-recurse')
314
_global_option('profile',
315
help='show performance profiling information')
316
_global_option('revision',
317
type=_parse_revision_str,
319
help='See \'help revisionspec\' for details')
320
_global_option('show-ids',
321
help='show internal object ids')
322
_global_option('timezone',
324
help='display timezone as local, original, or utc')
325
_global_option('unbound')
326
_global_option('verbose',
327
help='display more information',
329
_global_option('version')
330
_global_option('email')
331
_global_option('update')
332
_global_option('log-format', type=str, help="Use this log format")
333
_global_option('long', help='Use detailed log format. Same as --log-format long',
335
_global_option('short', help='Use moderately short log format. Same as --log-format short')
336
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
337
_global_option('root', type=str)
338
_global_option('no-backup')
339
_global_option('merge-type', type=_parse_merge_type,
340
help='Select a particular merge algorithm')
341
_global_option('pattern', type=str)
342
_global_option('quiet', short_name='q')
343
_global_option('remember', help='Remember the specified location as a'
345
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
346
_global_option('kind', type=str)
347
_global_option('dry-run',
348
help="show what would be done, but don't actually do anything")
349
_global_option('name-from-revision', help='The path name in the old tree.')
352
# prior to 0.14 these were always globally registered; the old dict is
353
# available for plugins that use it but it should not be used.
354
Option.SHORT_OPTIONS = symbol_versioning.DeprecatedDict(
355
symbol_versioning.zero_fourteen,
358
'F': Option.OPTIONS['file'],
359
'h': Option.OPTIONS['help'],
360
'm': Option.OPTIONS['message'],
361
'r': Option.OPTIONS['revision'],
362
'v': Option.OPTIONS['verbose'],
363
'l': Option.OPTIONS['long'],
364
'q': Option.OPTIONS['quiet'],
366
'Set the short option name when constructing the Option.',
added
removed
bzrlib/option.py
