1
# Copyright (C) 2004, 2005, 2006 by 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.trace import warning
24
from bzrlib.revisionspec import RevisionSpec
25
from bzrlib.errors import BzrCommandError
28
def _parse_revision_str(revstr):
29
"""This handles a revision string -> revno.
31
This always returns a list. The list will have one element for
32
each revision specifier supplied.
34
>>> _parse_revision_str('234')
35
[<RevisionSpec_int 234>]
36
>>> _parse_revision_str('234..567')
37
[<RevisionSpec_int 234>, <RevisionSpec_int 567>]
38
>>> _parse_revision_str('..')
39
[<RevisionSpec None>, <RevisionSpec None>]
40
>>> _parse_revision_str('..234')
41
[<RevisionSpec None>, <RevisionSpec_int 234>]
42
>>> _parse_revision_str('234..')
43
[<RevisionSpec_int 234>, <RevisionSpec None>]
44
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
45
[<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
46
>>> _parse_revision_str('234....789') #Error ?
47
[<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
48
>>> _parse_revision_str('revid:test@other.com-234234')
49
[<RevisionSpec_revid revid:test@other.com-234234>]
50
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
51
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
52
>>> _parse_revision_str('revid:test@other.com-234234..23')
53
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
54
>>> _parse_revision_str('date:2005-04-12')
55
[<RevisionSpec_date date:2005-04-12>]
56
>>> _parse_revision_str('date:2005-04-12 12:24:33')
57
[<RevisionSpec_date date:2005-04-12 12:24:33>]
58
>>> _parse_revision_str('date:2005-04-12T12:24:33')
59
[<RevisionSpec_date date:2005-04-12T12:24:33>]
60
>>> _parse_revision_str('date:2005-04-12,12:24:33')
61
[<RevisionSpec_date date:2005-04-12,12:24:33>]
62
>>> _parse_revision_str('-5..23')
63
[<RevisionSpec_int -5>, <RevisionSpec_int 23>]
64
>>> _parse_revision_str('-5')
65
[<RevisionSpec_int -5>]
66
>>> _parse_revision_str('123a')
67
Traceback (most recent call last):
69
BzrError: No namespace registered for string: '123a'
70
>>> _parse_revision_str('abc')
71
Traceback (most recent call last):
73
BzrError: No namespace registered for string: 'abc'
74
>>> _parse_revision_str('branch:../branch2')
75
[<RevisionSpec_branch branch:../branch2>]
76
>>> _parse_revision_str('branch:../../branch2')
77
[<RevisionSpec_branch branch:../../branch2>]
78
>>> _parse_revision_str('branch:../../branch2..23')
79
[<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_int 23>]
81
# TODO: Maybe move this into revisionspec.py
82
old_format_re = re.compile('\d*:\d*')
83
m = old_format_re.match(revstr)
86
warning('Colon separator for revision numbers is deprecated.'
88
for rev in revstr.split(':'):
90
revs.append(RevisionSpec(int(rev)))
92
revs.append(RevisionSpec(None))
94
sep = re.compile("\\.\\.(?!/)")
95
for x in sep.split(revstr):
96
revs.append(RevisionSpec(x or None))
100
def _parse_merge_type(typestring):
101
return get_merge_type(typestring)
103
def get_merge_type(typestring):
104
"""Attempt to find the merge class/factory associated with a string."""
105
from merge import merge_types
107
return merge_types[typestring][0]
109
templ = '%s%%7s: %%s' % (' '*12)
110
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
111
type_list = '\n'.join(lines)
112
msg = "No known merge type %s. Supported types are:\n%s" %\
113
(typestring, type_list)
114
raise BzrCommandError(msg)
116
class Option(object):
117
"""Description of a command line option"""
118
# TODO: Some way to show in help a description of the option argument
123
def __init__(self, name, help='', type=None, argname=None):
124
"""Make a new command option.
126
name -- regular name of the command, used in the double-dash
127
form and also as the parameter to the command's run()
130
help -- help message displayed in command help
132
type -- function called to parse the option argument, or
133
None (default) if this option doesn't take an argument.
135
argname -- name of option argument, if any
137
# TODO: perhaps a subclass that automatically does
138
# --option, --no-option for reversible booleans
143
assert argname is None
144
elif argname is None:
146
self.argname = argname
148
def short_name(self):
149
"""Return the single character option for this command, if any.
151
Short options are globally registered.
153
for short, option in Option.SHORT_OPTIONS.iteritems():
157
def get_negation_name(self):
158
if self.name.startswith('no-'):
161
return 'no-' + self.name
163
def add_option(self, parser, short_name):
164
"""Add this option to an Optparse parser"""
165
option_strings = ['--%s' % self.name]
166
if short_name is not None:
167
option_strings.append('-%s' % short_name)
170
parser.add_option(action='store_true', dest=self.name,
172
default=OptionParser.DEFAULT_VALUE,
174
negation_strings = ['--%s' % self.get_negation_name()]
175
parser.add_option(action='store_false', dest=self.name,
176
help=optparse.SUPPRESS_HELP, *negation_strings)
178
parser.add_option(action='callback',
179
callback=self._optparse_callback,
180
type='string', metavar=self.argname.upper(),
182
default=OptionParser.DEFAULT_VALUE,
185
def _optparse_callback(self, option, opt, value, parser):
186
setattr(parser.values, self.name, self.type(value))
188
def iter_switches(self):
189
"""Iterate through the list of switches provided by the option
191
:return: an iterator of (name, short_name, argname, help)
193
argname = self.argname
194
if argname is not None:
195
argname = argname.upper()
196
yield self.name, self.short_name(), argname, self.help
199
class OptionParser(optparse.OptionParser):
200
"""OptionParser that raises exceptions instead of exiting"""
202
DEFAULT_VALUE = object()
204
def error(self, message):
205
raise BzrCommandError(message)
208
def get_optparser(options):
209
"""Generate an optparse parser for bzrlib-style options"""
211
parser = OptionParser()
212
parser.remove_option('--help')
213
short_options = dict((k.name, v) for v, k in
214
Option.SHORT_OPTIONS.iteritems())
215
for option in options.itervalues():
216
option.add_option(parser, short_options.get(option.name))
220
def _global_option(name, **kwargs):
221
"""Register o as a global option."""
222
Option.OPTIONS[name] = Option(name, **kwargs)
224
_global_option('all')
225
_global_option('overwrite', help='Ignore differences between branches and '
226
'overwrite unconditionally')
227
_global_option('basis', type=str)
228
_global_option('bound')
229
_global_option('diff-options', type=str)
230
_global_option('help',
231
help='show help message')
232
_global_option('file', type=unicode)
233
_global_option('force')
234
_global_option('format', type=unicode)
235
_global_option('forward')
236
_global_option('message', type=unicode)
237
_global_option('no-recurse')
238
_global_option('prefix', type=str,
239
help='Set prefixes to added to old and new filenames, as '
240
'two values separated by a colon.')
241
_global_option('profile',
242
help='show performance profiling information')
243
_global_option('revision', type=_parse_revision_str)
244
_global_option('show-ids',
245
help='show internal object ids')
246
_global_option('timezone',
248
help='display timezone as local, original, or utc')
249
_global_option('unbound')
250
_global_option('verbose',
251
help='display more information')
252
_global_option('version')
253
_global_option('email')
254
_global_option('update')
255
_global_option('log-format', type=str, help="Use this log format")
256
_global_option('long', help='Use detailed log format. Same as --log-format long')
257
_global_option('short', help='Use moderately short log format. Same as --log-format short')
258
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
259
_global_option('root', type=str)
260
_global_option('no-backup')
261
_global_option('merge-type', type=_parse_merge_type,
262
help='Select a particular merge algorithm')
263
_global_option('pattern', type=str)
264
_global_option('quiet')
265
_global_option('remember', help='Remember the specified location as a'
267
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
268
_global_option('kind', type=str)
269
_global_option('dry-run',
270
help="show what would be done, but don't actually do anything")
273
def _global_short(short_name, long_name):
274
assert short_name not in Option.SHORT_OPTIONS
275
Option.SHORT_OPTIONS[short_name] = Option.OPTIONS[long_name]
278
Option.SHORT_OPTIONS['F'] = Option.OPTIONS['file']
279
Option.SHORT_OPTIONS['h'] = Option.OPTIONS['help']
280
Option.SHORT_OPTIONS['m'] = Option.OPTIONS['message']
281
Option.SHORT_OPTIONS['r'] = Option.OPTIONS['revision']
282
Option.SHORT_OPTIONS['v'] = Option.OPTIONS['verbose']
283
Option.SHORT_OPTIONS['l'] = Option.OPTIONS['long']
284
Option.SHORT_OPTIONS['q'] = Option.OPTIONS['quiet']
285
Option.SHORT_OPTIONS['p'] = Option.OPTIONS['prefix']
added
removed
bzrlib/option.py
