← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/option.py

  • Committer: John Arbash Meinel
  • Date: 2007-08-14 19:29:56 UTC
  • mto: This revision was merged to the branch mainline in revision 2698.
  • Revision ID: john@arbash-meinel.com-20070814192956-34h336i5q3m34ods
Switch bzr.dev to 0.91 development

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/option.py
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2004, 2005, 2006, 2007 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.
17
19
 
18
20
import re
19
21
 
20
 
import bzrlib.commands
21
 
from bzrlib.trace import warning, mutter
22
 
from bzrlib.revisionspec import RevisionSpec
23
 
from bzrlib.errors import BzrCommandError
 
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
24
35
 
25
36
 
26
37
def _parse_revision_str(revstr):
30
41
    each revision specifier supplied.
31
42
 
32
43
    >>> _parse_revision_str('234')
33
 
    [<RevisionSpec_int 234>]
 
44
    [<RevisionSpec_revno 234>]
34
45
    >>> _parse_revision_str('234..567')
35
 
    [<RevisionSpec_int 234>, <RevisionSpec_int 567>]
 
46
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
36
47
    >>> _parse_revision_str('..')
37
48
    [<RevisionSpec None>, <RevisionSpec None>]
38
49
    >>> _parse_revision_str('..234')
39
 
    [<RevisionSpec None>, <RevisionSpec_int 234>]
 
50
    [<RevisionSpec None>, <RevisionSpec_revno 234>]
40
51
    >>> _parse_revision_str('234..')
41
 
    [<RevisionSpec_int 234>, <RevisionSpec None>]
 
52
    [<RevisionSpec_revno 234>, <RevisionSpec None>]
42
53
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
43
 
    [<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
 
54
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
44
55
    >>> _parse_revision_str('234....789') #Error ?
45
 
    [<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
 
56
    [<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
46
57
    >>> _parse_revision_str('revid:test@other.com-234234')
47
58
    [<RevisionSpec_revid revid:test@other.com-234234>]
48
59
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
49
60
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
50
61
    >>> _parse_revision_str('revid:test@other.com-234234..23')
51
 
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
 
62
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
52
63
    >>> _parse_revision_str('date:2005-04-12')
53
64
    [<RevisionSpec_date date:2005-04-12>]
54
65
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
58
69
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
59
70
    [<RevisionSpec_date date:2005-04-12,12:24:33>]
60
71
    >>> _parse_revision_str('-5..23')
61
 
    [<RevisionSpec_int -5>, <RevisionSpec_int 23>]
 
72
    [<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
62
73
    >>> _parse_revision_str('-5')
63
 
    [<RevisionSpec_int -5>]
 
74
    [<RevisionSpec_revno -5>]
64
75
    >>> _parse_revision_str('123a')
65
76
    Traceback (most recent call last):
66
77
      ...
67
 
    BzrError: No namespace registered for string: '123a'
 
78
    NoSuchRevisionSpec: No namespace registered for string: '123a'
68
79
    >>> _parse_revision_str('abc')
69
80
    Traceback (most recent call last):
70
81
      ...
71
 
    BzrError: No namespace registered for string: 'abc'
 
82
    NoSuchRevisionSpec: No namespace registered for string: 'abc'
72
83
    >>> _parse_revision_str('branch:../branch2')
73
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>]
74
89
    """
75
90
    # TODO: Maybe move this into revisionspec.py
76
 
    old_format_re = re.compile('\d*:\d*')
77
 
    m = old_format_re.match(revstr)
78
91
    revs = []
79
 
    if m:
80
 
        warning('Colon separator for revision numbers is deprecated.'
81
 
                ' Use .. instead')
82
 
        for rev in revstr.split(':'):
83
 
            if rev:
84
 
                revs.append(RevisionSpec(int(rev)))
85
 
            else:
86
 
                revs.append(RevisionSpec(None))
87
 
    else:
88
 
        next_prefix = None
89
 
        for x in revstr.split('..'):
90
 
            if not x:
91
 
                revs.append(RevisionSpec(None))
92
 
            elif x[-1] == ':':
93
 
                # looks like a namespace:.. has happened
94
 
                next_prefix = x + '..'
95
 
            else:
96
 
                if next_prefix is not None:
97
 
                    x = next_prefix + x
98
 
                revs.append(RevisionSpec(x))
99
 
                next_prefix = None
100
 
        if next_prefix is not None:
101
 
            revs.append(RevisionSpec(next_prefix))
 
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))
102
96
    return revs
103
97
 
104
98
 
116
110
        type_list = '\n'.join(lines)
117
111
        msg = "No known merge type %s. Supported types are:\n%s" %\
118
112
            (typestring, type_list)
119
 
        raise BzrCommandError(msg)
 
113
        raise errors.BzrCommandError(msg)
 
114
 
120
115
 
121
116
class Option(object):
122
 
    """Description of a command line option"""
 
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
 
123
123
    # TODO: Some way to show in help a description of the option argument
124
124
 
125
125
    OPTIONS = {}
126
 
    SHORT_OPTIONS = {}
127
126
 
128
 
    def __init__(self, name, help='', type=None, argname=None):
 
127
    def __init__(self, name, help='', type=None, argname=None,
 
128
                 short_name=None):
129
129
        """Make a new command option.
130
130
 
131
131
        name -- regular name of the command, used in the double-dash
139
139
 
140
140
        argname -- name of option argument, if any
141
141
        """
142
 
        # TODO: perhaps a subclass that automatically does 
143
 
        # --option, --no-option for reversable booleans
144
142
        self.name = name
145
143
        self.help = help
146
144
        self.type = type
 
145
        self._short_name = short_name
147
146
        if type is None:
148
147
            assert argname is None
149
148
        elif argname is None:
151
150
        self.argname = argname
152
151
 
153
152
    def short_name(self):
154
 
        """Return the single character option for this command, if any.
155
 
 
156
 
        Short options are globally registered.
157
 
        """
158
 
        for short, option in Option.SHORT_OPTIONS.iteritems():
159
 
            if option is self:
160
 
                return short
 
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, 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)
 
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
161
346
 
162
347
 
163
348
def _global_option(name, **kwargs):
164
349
    """Register o as a global option."""
165
350
    Option.OPTIONS[name] = Option(name, **kwargs)
166
351
 
 
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
 
167
370
_global_option('all')
168
371
_global_option('overwrite', help='Ignore differences between branches and '
169
 
               'overwrite unconditionally')
 
372
               'overwrite unconditionally.')
170
373
_global_option('basis', type=str)
 
374
_global_option('bound')
171
375
_global_option('diff-options', type=str)
172
 
_global_option('help',
173
 
               help='show help message')
174
 
_global_option('file', type=unicode)
 
376
_global_option('file', type=unicode, short_name='F')
175
377
_global_option('force')
176
378
_global_option('format', type=unicode)
177
379
_global_option('forward')
178
 
_global_option('message', type=unicode)
 
380
_global_option('message', type=unicode,
 
381
               short_name='m',
 
382
               help='Message string.')
179
383
_global_option('no-recurse')
180
384
_global_option('profile',
181
 
               help='show performance profiling information')
182
 
_global_option('revision', type=_parse_revision_str)
183
 
_global_option('short')
184
 
_global_option('show-ids', 
185
 
               help='show internal object ids')
 
385
               help='Show performance profiling information.')
 
386
_global_option('revision',
 
387
               type=_parse_revision_str,
 
388
               short_name='r',
 
389
               help='See \'help revisionspec\' for details.')
 
390
_global_option('show-ids',
 
391
               help='Show internal object ids.')
186
392
_global_option('timezone', 
187
393
               type=str,
188
394
               help='display timezone as local, original, or utc')
 
395
_global_option('unbound')
189
396
_global_option('verbose',
190
 
               help='display more information')
 
397
               help='Display more information.',
 
398
               short_name='v')
191
399
_global_option('version')
192
400
_global_option('email')
193
401
_global_option('update')
194
 
_global_option('long', help='Use detailed log format')
195
 
_global_option('short', help='Use moderately short log format')
196
 
_global_option('line', help='Use log format with one line per revision')
 
402
_global_registry_option('log-format', "Use specified log format.",
 
403
                        log.log_formatter_registry, value_switches=True,
 
404
                        title='Log format')
 
405
_global_option('long', help='Use detailed log format. Same as --log-format long',
 
406
               short_name='l')
 
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')
197
409
_global_option('root', type=str)
198
410
_global_option('no-backup')
199
 
_global_option('merge-type', type=_parse_merge_type)
 
411
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
 
412
                        _merge_type_registry, value_switches=True,
 
413
                        title='Merge algorithm')
200
414
_global_option('pattern', type=str)
201
 
_global_option('quiet')
 
415
_global_option('quiet', short_name='q')
202
416
_global_option('remember', help='Remember the specified location as a'
203
417
               ' default.')
204
 
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
 
418
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
205
419
_global_option('kind', type=str)
206
420
_global_option('dry-run',
207
 
               help="show what would be done, but don't actually do anything")
208
 
 
209
 
 
210
 
def _global_short(short_name, long_name):
211
 
    assert short_name not in Option.SHORT_OPTIONS
212
 
    Option.SHORT_OPTIONS[short_name] = Option.OPTIONS[long_name]
213
 
    
214
 
 
215
 
Option.SHORT_OPTIONS['F'] = Option.OPTIONS['file']
216
 
Option.SHORT_OPTIONS['h'] = Option.OPTIONS['help']
217
 
Option.SHORT_OPTIONS['m'] = Option.OPTIONS['message']
218
 
Option.SHORT_OPTIONS['r'] = Option.OPTIONS['revision']
219
 
Option.SHORT_OPTIONS['v'] = Option.OPTIONS['verbose']
220
 
Option.SHORT_OPTIONS['l'] = Option.OPTIONS['long']
221
 
Option.SHORT_OPTIONS['q'] = Option.OPTIONS['quiet']
 
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.')
 
423
 
 
424
_help_option = Option('help',
 
425
                      help='Show help message.',
 
426
                      short_name='h')