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.
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
def set_short_name(self, short_name):
157
self._short_name = short_name
159
def get_negation_name(self):
160
if self.name.startswith('no-'):
163
return 'no-' + self.name
165
def add_option(self, parser, short_name):
166
"""Add this option to an Optparse parser"""
167
option_strings = ['--%s' % self.name]
168
if short_name is not None:
169
option_strings.append('-%s' % short_name)
172
parser.add_option(action='store_true', dest=self.name,
174
default=OptionParser.DEFAULT_VALUE,
176
negation_strings = ['--%s' % self.get_negation_name()]
177
parser.add_option(action='store_false', dest=self.name,
178
help=optparse.SUPPRESS_HELP, *negation_strings)
180
parser.add_option(action='callback',
181
callback=self._optparse_callback,
182
type='string', metavar=self.argname.upper(),
184
default=OptionParser.DEFAULT_VALUE,
187
def _optparse_callback(self, option, opt, value, parser):
188
setattr(parser.values, self.name, self.type(value))
190
def iter_switches(self):
191
"""Iterate through the list of switches provided by the option
193
:return: an iterator of (name, short_name, argname, help)
195
argname = self.argname
196
if argname is not None:
197
argname = argname.upper()
198
yield self.name, self.short_name(), argname, self.help
201
class ListOption(Option):
202
"""Option used to provide a list of values.
204
On the command line, arguments are specified by a repeated use of the
205
option. '-' is a special argument that resets the list. For example,
207
sets the value of the 'foo' option to ['a', 'b'], and
208
--foo=a --foo=b --foo=- --foo=c
209
sets the value of the 'foo' option to ['c'].
212
def add_option(self, parser, short_name):
213
"""Add this option to an Optparse parser."""
214
option_strings = ['--%s' % self.name]
215
if short_name is not None:
216
option_strings.append('-%s' % short_name)
217
parser.add_option(action='callback',
218
callback=self._optparse_callback,
219
type='string', metavar=self.argname.upper(),
220
help=self.help, default=[],
223
def _optparse_callback(self, option, opt, value, parser):
224
values = getattr(parser.values, self.name)
228
values.append(self.type(value))
231
class RegistryOption(Option):
232
"""Option based on a registry
234
The values for the options correspond to entries in the registry. Input
235
must be a registry key. After validation, it is converted into an object
236
using Registry.get or a caller-provided converter.
239
def validate_value(self, value):
240
"""Validate a value name"""
241
if value not in self.registry:
242
raise errors.BadOptionValue(self.name, value)
244
def convert(self, value):
245
"""Convert a value name into an output type"""
246
self.validate_value(value)
247
if self.converter is None:
248
return self.registry.get(value)
250
return self.converter(value)
252
def __init__(self, name, help, registry, converter=None,
253
value_switches=False, title=None, enum_switch=True):
257
:param name: The option name.
258
:param help: Help for the option.
259
:param registry: A Registry containing the values
260
:param converter: Callable to invoke with the value name to produce
261
the value. If not supplied, self.registry.get is used.
262
:param value_switches: If true, each possible value is assigned its
263
own switch. For example, instead of '--format knit',
264
'--knit' can be used interchangeably.
265
:param enum_switch: If true, a switch is provided with the option name,
268
Option.__init__(self, name, help, type=self.convert)
269
self.registry = registry
271
self.converter = converter
272
self.value_switches = value_switches
273
self.enum_switch = enum_switch
275
if self.title is None:
279
def from_kwargs(name_, help=None, title=None, value_switches=False,
280
enum_switch=True, **kwargs):
281
"""Convenience method to generate string-map registry options
283
name, help, value_switches and enum_switch are passed to the
284
RegistryOption constructor. Any other keyword arguments are treated
285
as values for the option, and they value is treated as the help.
287
reg = registry.Registry()
288
for name, switch_help in kwargs.iteritems():
289
name = name.replace('_', '-')
290
reg.register(name, name, help=switch_help)
291
return RegistryOption(name_, help, reg, title=title,
292
value_switches=value_switches, enum_switch=enum_switch)
294
def add_option(self, parser, short_name):
295
"""Add this option to an Optparse parser"""
296
if self.value_switches:
297
parser = parser.add_option_group(self.title)
299
Option.add_option(self, parser, short_name)
300
if self.value_switches:
301
for key in self.registry.keys():
302
option_strings = ['--%s' % key]
303
if getattr(self.registry.get_info(key), 'hidden', False):
304
help = optparse.SUPPRESS_HELP
306
help = self.registry.get_help(key)
307
parser.add_option(action='callback',
308
callback=self._optparse_value_callback(key),
312
def _optparse_value_callback(self, cb_value):
313
def cb(option, opt, value, parser):
314
setattr(parser.values, self.name, self.type(cb_value))
317
def iter_switches(self):
318
"""Iterate through the list of switches provided by the option
320
:return: an iterator of (name, short_name, argname, help)
322
for value in Option.iter_switches(self):
324
if self.value_switches:
325
for key in sorted(self.registry.keys()):
326
yield key, None, None, self.registry.get_help(key)
329
class OptionParser(optparse.OptionParser):
330
"""OptionParser that raises exceptions instead of exiting"""
332
DEFAULT_VALUE = object()
334
def error(self, message):
335
raise errors.BzrCommandError(message)
338
def get_optparser(options):
339
"""Generate an optparse parser for bzrlib-style options"""
341
parser = OptionParser()
342
parser.remove_option('--help')
343
for option in options.itervalues():
344
option.add_option(parser, option.short_name())
348
def _global_option(name, **kwargs):
349
"""Register o as a global option."""
350
Option.OPTIONS[name] = Option(name, **kwargs)
353
def _global_registry_option(name, help, registry, **kwargs):
354
Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
357
class MergeTypeRegistry(registry.Registry):
362
_merge_type_registry = MergeTypeRegistry()
363
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
364
"Native diff3-style merge")
365
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
366
"Merge using external diff3")
367
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
370
_global_option('all')
371
_global_option('overwrite', help='Ignore differences between branches and '
372
'overwrite unconditionally.')
373
_global_option('basis', type=str)
374
_global_option('bound')
375
_global_option('diff-options', type=str)
376
_global_option('file', type=unicode, short_name='F')
377
_global_option('force')
378
_global_option('format', type=unicode)
379
_global_option('forward')
380
_global_option('message', type=unicode,
382
help='Message string.')
383
_global_option('no-recurse')
384
_global_option('profile',
385
help='Show performance profiling information.')
386
_global_option('revision',
387
type=_parse_revision_str,
389
help='See \'help revisionspec\' for details.')
390
_global_option('show-ids',
391
help='Show internal object ids.')
392
_global_option('timezone',
394
help='display timezone as local, original, or utc')
395
_global_option('unbound')
396
_global_option('verbose',
397
help='Display more information.',
399
_global_option('version')
400
_global_option('email')
401
_global_option('update')
402
_global_registry_option('log-format', "Use specified log format.",
403
log.log_formatter_registry, value_switches=True,
405
_global_option('long', help='Use detailed log format. Same as --log-format long',
407
_global_option('short', help='Use moderately short log format. Same as --log-format short')
408
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
409
_global_option('root', type=str)
410
_global_option('no-backup')
411
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
412
_merge_type_registry, value_switches=True,
413
title='Merge algorithm')
414
_global_option('pattern', type=str)
415
_global_option('quiet', short_name='q')
416
_global_option('remember', help='Remember the specified location as a'
418
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
419
_global_option('kind', type=str)
420
_global_option('dry-run',
421
help="Show what would be done, but don't actually do anything.")
422
_global_option('name-from-revision', help='The path name in the old tree.')
424
_help_option = Option('help',
425
help='Show help message.',
added
removed
bzrlib/option.py
