← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/option.py

  • Committer: Jamie Wilkinson
  • Date: 2006-03-27 12:44:47 UTC
  • mto: This revision was merged to the branch mainline in revision 1874.
  • Revision ID: jaq@spacepants.org-20060327124447-96b90762e112e280
test that revision accessors act idempotently

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/option.py
1
 
# Copyright (C) 2004, 2005, 2006 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
 
        else:
156
 
            # remove this when SHORT_OPTIONS is removed
157
 
            # XXX: This is accessing a DeprecatedDict, so we call the super 
158
 
            # method to avoid warnings
159
 
            for (k, v) in dict.iteritems(Option.SHORT_OPTIONS):
160
 
                if v == self:
161
 
                    return k
162
 
 
163
 
    def set_short_name(self, short_name):
164
 
        self._short_name = short_name
165
 
 
166
 
    def get_negation_name(self):
167
 
        if self.name.startswith('no-'):
168
 
            return self.name[3:]
169
 
        else:
170
 
            return 'no-' + self.name
171
 
 
172
 
    def add_option(self, parser, short_name):
173
 
        """Add this option to an Optparse parser"""
174
 
        option_strings = ['--%s' % self.name]
175
 
        if short_name is not None:
176
 
            option_strings.append('-%s' % short_name)
177
 
        optargfn = self.type
178
 
        if optargfn is None:
179
 
            parser.add_option(action='store_true', dest=self.name, 
180
 
                              help=self.help,
181
 
                              default=OptionParser.DEFAULT_VALUE,
182
 
                              *option_strings)
183
 
            negation_strings = ['--%s' % self.get_negation_name()]
184
 
            parser.add_option(action='store_false', dest=self.name, 
185
 
                              help=optparse.SUPPRESS_HELP, *negation_strings)
186
 
        else:
187
 
            parser.add_option(action='callback', 
188
 
                              callback=self._optparse_callback, 
189
 
                              type='string', metavar=self.argname.upper(),
190
 
                              help=self.help,
191
 
                              default=OptionParser.DEFAULT_VALUE, 
192
 
                              *option_strings)
193
 
 
194
 
    def _optparse_callback(self, option, opt, value, parser):
195
 
        setattr(parser.values, self.name, self.type(value))
196
 
 
197
 
    def iter_switches(self):
198
 
        """Iterate through the list of switches provided by the option
199
 
        
200
 
        :return: an iterator of (name, short_name, argname, help)
201
 
        """
202
 
        argname =  self.argname
203
 
        if argname is not None:
204
 
            argname = argname.upper()
205
 
        yield self.name, self.short_name(), argname, self.help
206
 
 
207
 
 
208
 
class ListOption(Option):
209
 
    """Option used to provide a list of values.
210
 
 
211
 
    On the command line, arguments are specified by a repeated use of the
212
 
    option. '-' is a special argument that resets the list. For example,
213
 
      --foo=a --foo=b
214
 
    sets the value of the 'foo' option to ['a', 'b'], and
215
 
      --foo=a --foo=b --foo=- --foo=c
216
 
    sets the value of the 'foo' option to ['c'].
217
 
    """
218
 
 
219
 
    def add_option(self, parser, short_name):
220
 
        """Add this option to an Optparse parser."""
221
 
        option_strings = ['--%s' % self.name]
222
 
        if short_name is not None:
223
 
            option_strings.append('-%s' % short_name)
224
 
        parser.add_option(action='callback',
225
 
                          callback=self._optparse_callback,
226
 
                          type='string', metavar=self.argname.upper(),
227
 
                          help=self.help, default=[],
228
 
                          *option_strings)
229
 
 
230
 
    def _optparse_callback(self, option, opt, value, parser):
231
 
        values = getattr(parser.values, self.name)
232
 
        if value == '-':
233
 
            del values[:]
234
 
        else:
235
 
            values.append(self.type(value))
236
 
 
237
 
 
238
 
class RegistryOption(Option):
239
 
    """Option based on a registry
240
 
 
241
 
    The values for the options correspond to entries in the registry.  Input
242
 
    must be a registry key.  After validation, it is converted into an object
243
 
    using Registry.get or a caller-provided converter.
244
 
    """
245
 
 
246
 
    def validate_value(self, value):
247
 
        """Validate a value name"""
248
 
        if value not in self.registry:
249
 
            raise errors.BadOptionValue(self.name, value)
250
 
 
251
 
    def convert(self, value):
252
 
        """Convert a value name into an output type"""
253
 
        self.validate_value(value)
254
 
        if self.converter is None:
255
 
            return self.registry.get(value)
256
 
        else:
257
 
            return self.converter(value)
258
 
 
259
 
    def __init__(self, name, help, registry, converter=None,
260
 
        value_switches=False, title=None, enum_switch=True):
261
 
        """
262
 
        Constructor.
263
 
 
264
 
        :param name: The option name.
265
 
        :param help: Help for the option.
266
 
        :param registry: A Registry containing the values
267
 
        :param converter: Callable to invoke with the value name to produce
268
 
            the value.  If not supplied, self.registry.get is used.
269
 
        :param value_switches: If true, each possible value is assigned its
270
 
            own switch.  For example, instead of '--format knit',
271
 
            '--knit' can be used interchangeably.
272
 
        :param enum_switch: If true, a switch is provided with the option name,
273
 
            which takes a value.
274
 
        """
275
 
        Option.__init__(self, name, help, type=self.convert)
276
 
        self.registry = registry
277
 
        self.name = name
278
 
        self.converter = converter
279
 
        self.value_switches = value_switches
280
 
        self.enum_switch = enum_switch
281
 
        self.title = title
282
 
        if self.title is None:
283
 
            self.title = name
284
 
 
285
 
    @staticmethod
286
 
    def from_kwargs(name_, help=None, title=None, value_switches=False,
287
 
                    enum_switch=True, **kwargs):
288
 
        """Convenience method to generate string-map registry options
289
 
 
290
 
        name, help, value_switches and enum_switch are passed to the
291
 
        RegistryOption constructor.  Any other keyword arguments are treated
292
 
        as values for the option, and they value is treated as the help.
293
 
        """
294
 
        reg = registry.Registry()
295
 
        for name, help in kwargs.iteritems():
296
 
            name = name.replace('_', '-')
297
 
            reg.register(name, name, help=help)
298
 
        return RegistryOption(name_, help, reg, title=title,
299
 
            value_switches=value_switches, enum_switch=enum_switch)
300
 
 
301
 
    def add_option(self, parser, short_name):
302
 
        """Add this option to an Optparse parser"""
303
 
        if self.value_switches:
304
 
            parser = parser.add_option_group(self.title)
305
 
        if self.enum_switch:
306
 
            Option.add_option(self, parser, short_name)
307
 
        if self.value_switches:
308
 
            for key in self.registry.keys():
309
 
                option_strings = ['--%s' % key]
310
 
                if getattr(self.registry.get_info(key), 'hidden', False):
311
 
                    help = optparse.SUPPRESS_HELP
312
 
                else:
313
 
                    help = self.registry.get_help(key)
314
 
                parser.add_option(action='callback',
315
 
                              callback=self._optparse_value_callback(key),
316
 
                                  help=help,
317
 
                                  *option_strings)
318
 
 
319
 
    def _optparse_value_callback(self, cb_value):
320
 
        def cb(option, opt, value, parser):
321
 
            setattr(parser.values, self.name, self.type(cb_value))
322
 
        return cb
323
 
 
324
 
    def iter_switches(self):
325
 
        """Iterate through the list of switches provided by the option
326
 
 
327
 
        :return: an iterator of (name, short_name, argname, help)
328
 
        """
329
 
        for value in Option.iter_switches(self):
330
 
            yield value
331
 
        if self.value_switches:
332
 
            for key in sorted(self.registry.keys()):
333
 
                yield key, None, None, self.registry.get_help(key)
334
 
 
335
 
 
336
 
class OptionParser(optparse.OptionParser):
337
 
    """OptionParser that raises exceptions instead of exiting"""
338
 
 
339
 
    DEFAULT_VALUE = object()
340
 
 
341
 
    def error(self, message):
342
 
        raise errors.BzrCommandError(message)
343
 
 
344
 
 
345
 
def get_optparser(options):
346
 
    """Generate an optparse parser for bzrlib-style options"""
347
 
 
348
 
    parser = OptionParser()
349
 
    parser.remove_option('--help')
350
 
    for option in options.itervalues():
351
 
        option.add_option(parser, option.short_name())
352
 
    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
353
154
 
354
155
 
355
156
def _global_option(name, **kwargs):
356
157
    """Register o as a global option."""
357
158
    Option.OPTIONS[name] = Option(name, **kwargs)
358
159
 
359
 
 
360
 
def _global_registry_option(name, help, registry, **kwargs):
361
 
    Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
362
 
 
363
 
 
364
 
class MergeTypeRegistry(registry.Registry):
365
 
 
366
 
    pass
367
 
 
368
 
 
369
 
_merge_type_registry = MergeTypeRegistry()
370
 
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
371
 
                                   "Native diff3-style merge")
372
 
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
373
 
                                   "Merge using external diff3")
374
 
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
375
 
                                   "Weave-based merge")
376
 
 
377
160
_global_option('all')
378
161
_global_option('overwrite', help='Ignore differences between branches and '
379
162
               'overwrite unconditionally')
381
164
_global_option('bound')
382
165
_global_option('diff-options', type=str)
383
166
_global_option('help',
384
 
               help='show help message',
385
 
               short_name='h')
386
 
_global_option('file', type=unicode, short_name='F')
 
167
               help='show help message')
 
168
_global_option('file', type=unicode)
387
169
_global_option('force')
388
170
_global_option('format', type=unicode)
389
171
_global_option('forward')
390
 
_global_option('message', type=unicode,
391
 
               short_name='m')
 
172
_global_option('message', type=unicode)
392
173
_global_option('no-recurse')
393
174
_global_option('profile',
394
175
               help='show performance profiling information')
395
 
_global_option('revision',
396
 
               type=_parse_revision_str,
397
 
               short_name='r',
398
 
               help='See \'help revisionspec\' for details')
 
176
_global_option('revision', type=_parse_revision_str)
 
177
_global_option('short')
399
178
_global_option('show-ids', 
400
179
               help='show internal object ids')
401
180
_global_option('timezone', 
403
182
               help='display timezone as local, original, or utc')
404
183
_global_option('unbound')
405
184
_global_option('verbose',
406
 
               help='display more information',
407
 
               short_name='v')
 
185
               help='display more information')
408
186
_global_option('version')
409
187
_global_option('email')
410
188
_global_option('update')
411
 
_global_registry_option('log-format', "Use this log format",
412
 
                        log.log_formatter_registry, value_switches=True,
413
 
                        title='Log format')
414
 
_global_option('long', help='Use detailed log format. Same as --log-format long',
415
 
               short_name='l')
 
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')
416
191
_global_option('short', help='Use moderately short log format. Same as --log-format short')
417
192
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
418
193
_global_option('root', type=str)
419
194
_global_option('no-backup')
420
 
_global_registry_option('merge-type', 'Select a particular merge algorithm',
421
 
                        _merge_type_registry, value_switches=True,
422
 
                        title='Merge algorithm')
 
195
_global_option('merge-type', type=_parse_merge_type)
423
196
_global_option('pattern', type=str)
424
 
_global_option('quiet', short_name='q')
 
197
_global_option('quiet')
425
198
_global_option('remember', help='Remember the specified location as a'
426
199
               ' default.')
427
200
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
428
201
_global_option('kind', type=str)
429
202
_global_option('dry-run',
430
203
               help="show what would be done, but don't actually do anything")
431
 
_global_option('name-from-revision', help='The path name in the old tree.')
432
 
 
433
 
 
434
 
# prior to 0.14 these were always globally registered; the old dict is
435
 
# available for plugins that use it but it should not be used.
436
 
Option.SHORT_OPTIONS = symbol_versioning.DeprecatedDict(
437
 
    symbol_versioning.zero_fourteen,
438
 
    'SHORT_OPTIONS',
439
 
    {
440
 
        'F': Option.OPTIONS['file'],
441
 
        'h': Option.OPTIONS['help'],
442
 
        'm': Option.OPTIONS['message'],
443
 
        'r': Option.OPTIONS['revision'],
444
 
        'v': Option.OPTIONS['verbose'],
445
 
        'l': Option.OPTIONS['long'],
446
 
        'q': Option.OPTIONS['quiet'],
447
 
    },
448
 
    'Set the short option name when constructing the Option.',
449
 
    )
 
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']