← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/option.py

  • Committer: Martin Pool
  • Date: 2006-03-20 23:09:42 UTC
  • mto: This revision was merged to the branch mainline in revision 1621.
  • Revision ID: mbp@sourcefrog.net-20060320230942-152767f76202f543
doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/option.py
1
 
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2004, 2005 by Canonical Ltd
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
# TODO: For things like --diff-prefix, we want a way to customize the display
18
 
# of the option argument.
19
17
 
20
18
import re
21
19
 
22
 
from bzrlib.lazy_import import lazy_import
23
 
lazy_import(globals(), """
24
 
import optparse
25
 
 
26
 
from bzrlib import (
27
 
    errors,
28
 
    log,
29
 
    registry,
30
 
    revisionspec,
31
 
    symbol_versioning,
32
 
    )
33
 
""")
34
 
from bzrlib.trace import warning
 
20
import bzrlib.commands
 
21
from bzrlib.trace import warning, mutter
 
22
from bzrlib.revisionspec import RevisionSpec
 
23
from bzrlib.errors import BzrCommandError
35
24
 
36
25
 
37
26
def _parse_revision_str(revstr):
41
30
    each revision specifier supplied.
42
31
 
43
32
    >>> _parse_revision_str('234')
44
 
    [<RevisionSpec_revno 234>]
 
33
    [<RevisionSpec_int 234>]
45
34
    >>> _parse_revision_str('234..567')
46
 
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
 
35
    [<RevisionSpec_int 234>, <RevisionSpec_int 567>]
47
36
    >>> _parse_revision_str('..')
48
37
    [<RevisionSpec None>, <RevisionSpec None>]
49
38
    >>> _parse_revision_str('..234')
50
 
    [<RevisionSpec None>, <RevisionSpec_revno 234>]
 
39
    [<RevisionSpec None>, <RevisionSpec_int 234>]
51
40
    >>> _parse_revision_str('234..')
52
 
    [<RevisionSpec_revno 234>, <RevisionSpec None>]
 
41
    [<RevisionSpec_int 234>, <RevisionSpec None>]
53
42
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
54
 
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
 
43
    [<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
55
44
    >>> _parse_revision_str('234....789') #Error ?
56
 
    [<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
 
45
    [<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
57
46
    >>> _parse_revision_str('revid:test@other.com-234234')
58
47
    [<RevisionSpec_revid revid:test@other.com-234234>]
59
48
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
60
49
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
61
50
    >>> _parse_revision_str('revid:test@other.com-234234..23')
62
 
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
 
51
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
63
52
    >>> _parse_revision_str('date:2005-04-12')
64
53
    [<RevisionSpec_date date:2005-04-12>]
65
54
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
69
58
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
70
59
    [<RevisionSpec_date date:2005-04-12,12:24:33>]
71
60
    >>> _parse_revision_str('-5..23')
72
 
    [<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
 
61
    [<RevisionSpec_int -5>, <RevisionSpec_int 23>]
73
62
    >>> _parse_revision_str('-5')
74
 
    [<RevisionSpec_revno -5>]
 
63
    [<RevisionSpec_int -5>]
75
64
    >>> _parse_revision_str('123a')
76
65
    Traceback (most recent call last):
77
66
      ...
78
 
    NoSuchRevisionSpec: No namespace registered for string: '123a'
 
67
    BzrError: No namespace registered for string: '123a'
79
68
    >>> _parse_revision_str('abc')
80
69
    Traceback (most recent call last):
81
70
      ...
82
 
    NoSuchRevisionSpec: No namespace registered for string: 'abc'
 
71
    BzrError: No namespace registered for string: 'abc'
83
72
    >>> _parse_revision_str('branch:../branch2')
84
73
    [<RevisionSpec_branch branch:../branch2>]
85
74
    >>> _parse_revision_str('branch:../../branch2')
86
75
    [<RevisionSpec_branch branch:../../branch2>]
87
76
    >>> _parse_revision_str('branch:../../branch2..23')
88
 
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
 
77
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_int 23>]
89
78
    """
90
79
    # TODO: Maybe move this into revisionspec.py
 
80
    old_format_re = re.compile('\d*:\d*')
 
81
    m = old_format_re.match(revstr)
91
82
    revs = []
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))
 
83
    if m:
 
84
        warning('Colon separator for revision numbers is deprecated.'
 
85
                ' Use .. instead')
 
86
        for rev in revstr.split(':'):
 
87
            if rev:
 
88
                revs.append(RevisionSpec(int(rev)))
 
89
            else:
 
90
                revs.append(RevisionSpec(None))
 
91
    else:
 
92
        sep = re.compile("\\.\\.(?!/)")
 
93
        for x in sep.split(revstr):
 
94
            revs.append(RevisionSpec(x or None))
96
95
    return revs
97
96
 
98
97
 
110
109
        type_list = '\n'.join(lines)
111
110
        msg = "No known merge type %s. Supported types are:\n%s" %\
112
111
            (typestring, type_list)
113
 
        raise errors.BzrCommandError(msg)
114
 
 
 
112
        raise BzrCommandError(msg)
115
113
 
116
114
class Option(object):
117
 
    """Description of a command line option
118
 
    
119
 
    :ivar _short_name: If this option has a single-letter name, this is it.
120
 
    Otherwise None.
121
 
    """
122
 
 
 
115
    """Description of a command line option"""
123
116
    # TODO: Some way to show in help a description of the option argument
124
117
 
125
118
    OPTIONS = {}
 
119
    SHORT_OPTIONS = {}
126
120
 
127
 
    def __init__(self, name, help='', type=None, argname=None,
128
 
                 short_name=None):
 
121
    def __init__(self, name, help='', type=None, argname=None):
129
122
        """Make a new command option.
130
123
 
131
124
        name -- regular name of the command, used in the double-dash
139
132
 
140
133
        argname -- name of option argument, if any
141
134
        """
 
135
        # TODO: perhaps a subclass that automatically does 
 
136
        # --option, --no-option for reversable booleans
142
137
        self.name = name
143
138
        self.help = help
144
139
        self.type = type
145
 
        self._short_name = short_name
146
140
        if type is None:
147
141
            assert argname is None
148
142
        elif argname is None:
150
144
        self.argname = argname
151
145
 
152
146
    def short_name(self):
153
 
        if self._short_name:
154
 
            return self._short_name
155
 
 
156
 
    def set_short_name(self, short_name):
157
 
        self._short_name = short_name
158
 
 
159
 
    def get_negation_name(self):
160
 
        if self.name.startswith('no-'):
161
 
            return self.name[3:]
162
 
        else:
163
 
            return 'no-' + self.name
164
 
 
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)
170
 
        optargfn = self.type
171
 
        if optargfn is None:
172
 
            parser.add_option(action='store_true', dest=self.name, 
173
 
                              help=self.help,
174
 
                              default=OptionParser.DEFAULT_VALUE,
175
 
                              *option_strings)
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)
179
 
        else:
180
 
            parser.add_option(action='callback', 
181
 
                              callback=self._optparse_callback, 
182
 
                              type='string', metavar=self.argname.upper(),
183
 
                              help=self.help,
184
 
                              default=OptionParser.DEFAULT_VALUE, 
185
 
                              *option_strings)
186
 
 
187
 
    def _optparse_callback(self, option, opt, value, parser):
188
 
        setattr(parser.values, self.name, self.type(value))
189
 
 
190
 
    def iter_switches(self):
191
 
        """Iterate through the list of switches provided by the option
192
 
        
193
 
        :return: an iterator of (name, short_name, argname, help)
194
 
        """
195
 
        argname =  self.argname
196
 
        if argname is not None:
197
 
            argname = argname.upper()
198
 
        yield self.name, self.short_name(), argname, self.help
199
 
 
200
 
 
201
 
class ListOption(Option):
202
 
    """Option used to provide a list of values.
203
 
 
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,
206
 
      --foo=a --foo=b
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'].
210
 
    """
211
 
 
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=[],
221
 
                          *option_strings)
222
 
 
223
 
    def _optparse_callback(self, option, opt, value, parser):
224
 
        values = getattr(parser.values, self.name)
225
 
        if value == '-':
226
 
            del values[:]
227
 
        else:
228
 
            values.append(self.type(value))
229
 
 
230
 
 
231
 
class RegistryOption(Option):
232
 
    """Option based on a registry
233
 
 
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.
237
 
    """
238
 
 
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)
243
 
 
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)
249
 
        else:
250
 
            return self.converter(value)
251
 
 
252
 
    def __init__(self, name, help, registry, converter=None,
253
 
        value_switches=False, title=None, enum_switch=True):
254
 
        """
255
 
        Constructor.
256
 
 
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,
266
 
            which takes a value.
267
 
        """
268
 
        Option.__init__(self, name, help, type=self.convert)
269
 
        self.registry = registry
270
 
        self.name = name
271
 
        self.converter = converter
272
 
        self.value_switches = value_switches
273
 
        self.enum_switch = enum_switch
274
 
        self.title = title
275
 
        if self.title is None:
276
 
            self.title = name
277
 
 
278
 
    @staticmethod
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
282
 
 
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.
286
 
        """
287
 
        reg = registry.Registry()
288
 
        for name, help in kwargs.iteritems():
289
 
            name = name.replace('_', '-')
290
 
            reg.register(name, name, help=help)
291
 
        return RegistryOption(name_, help, reg, title=title,
292
 
            value_switches=value_switches, enum_switch=enum_switch)
293
 
 
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)
298
 
        if self.enum_switch:
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
305
 
                else:
306
 
                    help = self.registry.get_help(key)
307
 
                parser.add_option(action='callback',
308
 
                              callback=self._optparse_value_callback(key),
309
 
                                  help=help,
310
 
                                  *option_strings)
311
 
 
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))
315
 
        return cb
316
 
 
317
 
    def iter_switches(self):
318
 
        """Iterate through the list of switches provided by the option
319
 
 
320
 
        :return: an iterator of (name, short_name, argname, help)
321
 
        """
322
 
        for value in Option.iter_switches(self):
323
 
            yield value
324
 
        if self.value_switches:
325
 
            for key in sorted(self.registry.keys()):
326
 
                yield key, None, None, self.registry.get_help(key)
327
 
 
328
 
 
329
 
class OptionParser(optparse.OptionParser):
330
 
    """OptionParser that raises exceptions instead of exiting"""
331
 
 
332
 
    DEFAULT_VALUE = object()
333
 
 
334
 
    def error(self, message):
335
 
        raise errors.BzrCommandError(message)
336
 
 
337
 
 
338
 
def get_optparser(options):
339
 
    """Generate an optparse parser for bzrlib-style options"""
340
 
 
341
 
    parser = OptionParser()
342
 
    parser.remove_option('--help')
343
 
    for option in options.itervalues():
344
 
        option.add_option(parser, option.short_name())
345
 
    return parser
 
147
        """Return the single character option for this command, if any.
 
148
 
 
149
        Short options are globally registered.
 
150
        """
 
151
        for short, option in Option.SHORT_OPTIONS.iteritems():
 
152
            if option is self:
 
153
                return short
346
154
 
347
155
 
348
156
def _global_option(name, **kwargs):
349
157
    """Register o as a global option."""
350
158
    Option.OPTIONS[name] = Option(name, **kwargs)
351
159
 
352
 
 
353
 
def _global_registry_option(name, help, registry, **kwargs):
354
 
    Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
355
 
 
356
 
 
357
 
class MergeTypeRegistry(registry.Registry):
358
 
 
359
 
    pass
360
 
 
361
 
 
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',
368
 
                                   "Weave-based merge")
369
 
 
 
160
_global_option('all')
370
161
_global_option('overwrite', help='Ignore differences between branches and '
371
 
               'overwrite unconditionally.')
372
 
_global_option('revision',
373
 
               type=_parse_revision_str,
374
 
               short_name='r',
375
 
               help='See \'help revisionspec\' for details.')
376
 
_global_option('show-ids',
377
 
               help='Show internal object ids.')
 
162
               'overwrite unconditionally')
 
163
_global_option('basis', type=str)
 
164
_global_option('bound')
 
165
_global_option('diff-options', type=str)
 
166
_global_option('help',
 
167
               help='show help message')
 
168
_global_option('file', type=unicode)
 
169
_global_option('force')
 
170
_global_option('format', type=unicode)
 
171
_global_option('forward')
 
172
_global_option('message', type=unicode)
 
173
_global_option('no-recurse')
 
174
_global_option('profile',
 
175
               help='show performance profiling information')
 
176
_global_option('revision', type=_parse_revision_str)
 
177
_global_option('short')
 
178
_global_option('show-ids', 
 
179
               help='show internal object ids')
 
180
_global_option('timezone', 
 
181
               type=str,
 
182
               help='display timezone as local, original, or utc')
 
183
_global_option('unbound')
378
184
_global_option('verbose',
379
 
               help='Display more information.',
380
 
               short_name='v')
381
 
_global_registry_option('log-format', "Use specified log format.",
382
 
                        log.log_formatter_registry, value_switches=True,
383
 
                        title='Log format')
384
 
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
385
 
                        _merge_type_registry, value_switches=True,
386
 
                        title='Merge algorithm')
 
185
               help='display more information')
 
186
_global_option('version')
 
187
_global_option('email')
 
188
_global_option('update')
 
189
_global_option('log-format', type=str, help="Use this log format")
 
190
_global_option('long', help='Use detailed log format. Same as --log-format long')
 
191
_global_option('short', help='Use moderately short log format. Same as --log-format short')
 
192
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
 
193
_global_option('root', type=str)
 
194
_global_option('no-backup')
 
195
_global_option('merge-type', type=_parse_merge_type)
 
196
_global_option('pattern', type=str)
 
197
_global_option('quiet')
387
198
_global_option('remember', help='Remember the specified location as a'
388
199
               ' default.')
389
 
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
390
 
 
391
 
_help_option = Option('help',
392
 
                      help='Show help message.',
393
 
                      short_name='h')
 
200
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
 
201
_global_option('kind', type=str)
 
202
_global_option('dry-run',
 
203
               help="show what would be done, but don't actually do anything")
 
204
 
 
205
 
 
206
def _global_short(short_name, long_name):
 
207
    assert short_name not in Option.SHORT_OPTIONS
 
208
    Option.SHORT_OPTIONS[short_name] = Option.OPTIONS[long_name]
 
209
    
 
210
 
 
211
Option.SHORT_OPTIONS['F'] = Option.OPTIONS['file']
 
212
Option.SHORT_OPTIONS['h'] = Option.OPTIONS['help']
 
213
Option.SHORT_OPTIONS['m'] = Option.OPTIONS['message']
 
214
Option.SHORT_OPTIONS['r'] = Option.OPTIONS['revision']
 
215
Option.SHORT_OPTIONS['v'] = Option.OPTIONS['verbose']
 
216
Option.SHORT_OPTIONS['l'] = Option.OPTIONS['long']
 
217
Option.SHORT_OPTIONS['q'] = Option.OPTIONS['quiet']