← 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-04-12 20:36:40 UTC
  • mfrom: (2413 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2566.
  • Revision ID: john@arbash-meinel.com-20070412203640-z1jld315288moxvy
[merge] bzr.dev 2413

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 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
 
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
23
35
 
24
36
 
25
37
def _parse_revision_str(revstr):
29
41
    each revision specifier supplied.
30
42
 
31
43
    >>> _parse_revision_str('234')
32
 
    [<RevisionSpec_int 234>]
 
44
    [<RevisionSpec_revno 234>]
33
45
    >>> _parse_revision_str('234..567')
34
 
    [<RevisionSpec_int 234>, <RevisionSpec_int 567>]
 
46
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
35
47
    >>> _parse_revision_str('..')
36
48
    [<RevisionSpec None>, <RevisionSpec None>]
37
49
    >>> _parse_revision_str('..234')
38
 
    [<RevisionSpec None>, <RevisionSpec_int 234>]
 
50
    [<RevisionSpec None>, <RevisionSpec_revno 234>]
39
51
    >>> _parse_revision_str('234..')
40
 
    [<RevisionSpec_int 234>, <RevisionSpec None>]
 
52
    [<RevisionSpec_revno 234>, <RevisionSpec None>]
41
53
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
42
 
    [<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
 
54
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
43
55
    >>> _parse_revision_str('234....789') #Error ?
44
 
    [<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
 
56
    [<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
45
57
    >>> _parse_revision_str('revid:test@other.com-234234')
46
58
    [<RevisionSpec_revid revid:test@other.com-234234>]
47
59
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
48
60
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
49
61
    >>> _parse_revision_str('revid:test@other.com-234234..23')
50
 
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
 
62
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
51
63
    >>> _parse_revision_str('date:2005-04-12')
52
64
    [<RevisionSpec_date date:2005-04-12>]
53
65
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
57
69
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
58
70
    [<RevisionSpec_date date:2005-04-12,12:24:33>]
59
71
    >>> _parse_revision_str('-5..23')
60
 
    [<RevisionSpec_int -5>, <RevisionSpec_int 23>]
 
72
    [<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
61
73
    >>> _parse_revision_str('-5')
62
 
    [<RevisionSpec_int -5>]
 
74
    [<RevisionSpec_revno -5>]
63
75
    >>> _parse_revision_str('123a')
64
76
    Traceback (most recent call last):
65
77
      ...
66
 
    BzrError: No namespace registered for string: '123a'
 
78
    NoSuchRevisionSpec: No namespace registered for string: '123a'
67
79
    >>> _parse_revision_str('abc')
68
80
    Traceback (most recent call last):
69
81
      ...
70
 
    BzrError: No namespace registered for string: 'abc'
 
82
    NoSuchRevisionSpec: No namespace registered for string: 'abc'
71
83
    >>> _parse_revision_str('branch:../branch2')
72
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>]
73
89
    """
74
90
    # TODO: Maybe move this into revisionspec.py
75
 
    old_format_re = re.compile('\d*:\d*')
76
 
    m = old_format_re.match(revstr)
77
91
    revs = []
78
 
    if m:
79
 
        warning('Colon separator for revision numbers is deprecated.'
80
 
                ' Use .. instead')
81
 
        for rev in revstr.split(':'):
82
 
            if rev:
83
 
                revs.append(RevisionSpec(int(rev)))
84
 
            else:
85
 
                revs.append(RevisionSpec(None))
86
 
    else:
87
 
        next_prefix = None
88
 
        for x in revstr.split('..'):
89
 
            if not x:
90
 
                revs.append(RevisionSpec(None))
91
 
            elif x[-1] == ':':
92
 
                # looks like a namespace:.. has happened
93
 
                next_prefix = x + '..'
94
 
            else:
95
 
                if next_prefix is not None:
96
 
                    x = next_prefix + x
97
 
                revs.append(RevisionSpec(x))
98
 
                next_prefix = None
99
 
        if next_prefix is not None:
100
 
            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))
101
96
    return revs
102
97
 
103
98
 
104
99
def _parse_merge_type(typestring):
105
 
    return bzrlib.commands.get_merge_type(typestring)
 
100
    return get_merge_type(typestring)
 
101
 
 
102
def get_merge_type(typestring):
 
103
    """Attempt to find the merge class/factory associated with a string."""
 
104
    from merge import merge_types
 
105
    try:
 
106
        return merge_types[typestring][0]
 
107
    except KeyError:
 
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)
106
114
 
107
115
 
108
116
class Option(object):
109
 
    """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
 
110
123
    # TODO: Some way to show in help a description of the option argument
111
124
 
112
125
    OPTIONS = {}
113
 
    SHORT_OPTIONS = {}
114
126
 
115
 
    def __init__(self, name, help='', type=None, argname=None):
 
127
    def __init__(self, name, help='', type=None, argname=None,
 
128
                 short_name=None):
116
129
        """Make a new command option.
117
130
 
118
131
        name -- regular name of the command, used in the double-dash
126
139
 
127
140
        argname -- name of option argument, if any
128
141
        """
129
 
        # TODO: perhaps a subclass that automatically does 
130
 
        # --option, --no-option for reversable booleans
131
142
        self.name = name
132
143
        self.help = help
133
144
        self.type = type
 
145
        self._short_name = short_name
134
146
        if type is None:
135
147
            assert argname is None
136
148
        elif argname is None:
138
150
        self.argname = argname
139
151
 
140
152
    def short_name(self):
141
 
        """Return the single character option for this command, if any.
142
 
 
143
 
        Short options are globally registered.
144
 
        """
145
 
        return Option.SHORT_OPTIONS.get(self.name)
 
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 RegistryOption(Option):
 
209
    """Option based on a registry
 
210
 
 
211
    The values for the options correspond to entries in the registry.  Input
 
212
    must be a registry key.  After validation, it is converted into an object
 
213
    using Registry.get or a caller-provided converter.
 
214
    """
 
215
 
 
216
    def validate_value(self, value):
 
217
        """Validate a value name"""
 
218
        if value not in self.registry:
 
219
            raise errors.BadOptionValue(self.name, value)
 
220
 
 
221
    def convert(self, value):
 
222
        """Convert a value name into an output type"""
 
223
        self.validate_value(value)
 
224
        if self.converter is None:
 
225
            return self.registry.get(value)
 
226
        else:
 
227
            return self.converter(value)
 
228
 
 
229
    def __init__(self, name, help, registry, converter=None,
 
230
        value_switches=False, title=None, enum_switch=True):
 
231
        """
 
232
        Constructor.
 
233
 
 
234
        :param name: The option name.
 
235
        :param help: Help for the option.
 
236
        :param registry: A Registry containing the values
 
237
        :param converter: Callable to invoke with the value name to produce
 
238
            the value.  If not supplied, self.registry.get is used.
 
239
        :param value_switches: If true, each possible value is assigned its
 
240
            own switch.  For example, instead of '--format knit',
 
241
            '--knit' can be used interchangeably.
 
242
        :param enum_switch: If true, a switch is provided with the option name,
 
243
            which takes a value.
 
244
        """
 
245
        Option.__init__(self, name, help, type=self.convert)
 
246
        self.registry = registry
 
247
        self.name = name
 
248
        self.converter = converter
 
249
        self.value_switches = value_switches
 
250
        self.enum_switch = enum_switch
 
251
        self.title = title
 
252
        if self.title is None:
 
253
            self.title = name
 
254
 
 
255
    @staticmethod
 
256
    def from_kwargs(name_, help=None, title=None, value_switches=False,
 
257
                    enum_switch=True, **kwargs):
 
258
        """Convenience method to generate string-map registry options
 
259
 
 
260
        name, help, value_switches and enum_switch are passed to the
 
261
        RegistryOption constructor.  Any other keyword arguments are treated
 
262
        as values for the option, and they value is treated as the help.
 
263
        """
 
264
        reg = registry.Registry()
 
265
        for name, help in kwargs.iteritems():
 
266
            name = name.replace('_', '-')
 
267
            reg.register(name, name, help=help)
 
268
        return RegistryOption(name_, help, reg, title=title,
 
269
            value_switches=value_switches, enum_switch=enum_switch)
 
270
 
 
271
    def add_option(self, parser, short_name):
 
272
        """Add this option to an Optparse parser"""
 
273
        if self.value_switches:
 
274
            parser = parser.add_option_group(self.title)
 
275
        if self.enum_switch:
 
276
            Option.add_option(self, parser, short_name)
 
277
        if self.value_switches:
 
278
            for key in self.registry.keys():
 
279
                option_strings = ['--%s' % key]
 
280
                if getattr(self.registry.get_info(key), 'hidden', False):
 
281
                    help = optparse.SUPPRESS_HELP
 
282
                else:
 
283
                    help = self.registry.get_help(key)
 
284
                parser.add_option(action='callback',
 
285
                              callback=self._optparse_value_callback(key),
 
286
                                  help=help,
 
287
                                  *option_strings)
 
288
 
 
289
    def _optparse_value_callback(self, cb_value):
 
290
        def cb(option, opt, value, parser):
 
291
            setattr(parser.values, self.name, self.type(cb_value))
 
292
        return cb
 
293
 
 
294
    def iter_switches(self):
 
295
        """Iterate through the list of switches provided by the option
 
296
 
 
297
        :return: an iterator of (name, short_name, argname, help)
 
298
        """
 
299
        for value in Option.iter_switches(self):
 
300
            yield value
 
301
        if self.value_switches:
 
302
            for key in sorted(self.registry.keys()):
 
303
                yield key, None, None, self.registry.get_help(key)
 
304
 
 
305
 
 
306
class OptionParser(optparse.OptionParser):
 
307
    """OptionParser that raises exceptions instead of exiting"""
 
308
 
 
309
    DEFAULT_VALUE = object()
 
310
 
 
311
    def error(self, message):
 
312
        raise errors.BzrCommandError(message)
 
313
 
 
314
 
 
315
def get_optparser(options):
 
316
    """Generate an optparse parser for bzrlib-style options"""
 
317
 
 
318
    parser = OptionParser()
 
319
    parser.remove_option('--help')
 
320
    for option in options.itervalues():
 
321
        option.add_option(parser, option.short_name())
 
322
    return parser
146
323
 
147
324
 
148
325
def _global_option(name, **kwargs):
149
326
    """Register o as a global option."""
150
327
    Option.OPTIONS[name] = Option(name, **kwargs)
151
328
 
 
329
 
 
330
def _global_registry_option(name, help, registry, **kwargs):
 
331
    Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
 
332
 
 
333
 
 
334
class MergeTypeRegistry(registry.Registry):
 
335
 
 
336
    pass
 
337
 
 
338
 
 
339
_merge_type_registry = MergeTypeRegistry()
 
340
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
 
341
                                   "Native diff3-style merge")
 
342
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
 
343
                                   "Merge using external diff3")
 
344
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
 
345
                                   "Weave-based merge")
 
346
 
152
347
_global_option('all')
153
 
_global_option('clobber')
 
348
_global_option('overwrite', help='Ignore differences between branches and '
 
349
               'overwrite unconditionally')
154
350
_global_option('basis', type=str)
 
351
_global_option('bound')
155
352
_global_option('diff-options', type=str)
156
353
_global_option('help',
157
 
               help='show help message')
158
 
_global_option('file', type=unicode)
 
354
               help='show help message',
 
355
               short_name='h')
 
356
_global_option('file', type=unicode, short_name='F')
159
357
_global_option('force')
160
358
_global_option('format', type=unicode)
161
359
_global_option('forward')
162
 
_global_option('message', type=unicode)
 
360
_global_option('message', type=unicode,
 
361
               short_name='m')
163
362
_global_option('no-recurse')
164
363
_global_option('profile',
165
364
               help='show performance profiling information')
166
 
_global_option('revision', type=_parse_revision_str)
167
 
_global_option('short')
 
365
_global_option('revision',
 
366
               type=_parse_revision_str,
 
367
               short_name='r',
 
368
               help='See \'help revisionspec\' for details')
168
369
_global_option('show-ids', 
169
370
               help='show internal object ids')
170
371
_global_option('timezone', 
171
372
               type=str,
172
373
               help='display timezone as local, original, or utc')
 
374
_global_option('unbound')
173
375
_global_option('verbose',
174
 
               help='display more information')
 
376
               help='display more information',
 
377
               short_name='v')
175
378
_global_option('version')
176
379
_global_option('email')
177
380
_global_option('update')
178
 
_global_option('long')
 
381
_global_registry_option('log-format', "Use this log format",
 
382
                        log.log_formatter_registry, value_switches=True,
 
383
                        title='Log format')
 
384
_global_option('long', help='Use detailed log format. Same as --log-format long',
 
385
               short_name='l')
 
386
_global_option('short', help='Use moderately short log format. Same as --log-format short')
 
387
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
179
388
_global_option('root', type=str)
180
389
_global_option('no-backup')
181
 
_global_option('merge-type', type=_parse_merge_type)
 
390
_global_registry_option('merge-type', 'Select a particular merge algorithm',
 
391
                        _merge_type_registry, value_switches=True,
 
392
                        title='Merge algorithm')
182
393
_global_option('pattern', type=str)
183
 
_global_option('quiet')
184
 
_global_option('remember')
185
 
 
186
 
 
187
 
def _global_short(short_name, long_name):
188
 
    assert short_name not in Option.SHORT_OPTIONS
189
 
    Option.SHORT_OPTIONS[short_name] = Option.OPTIONS[long_name]
190
 
    
191
 
 
192
 
Option.SHORT_OPTIONS['F'] = Option.OPTIONS['file']
193
 
Option.SHORT_OPTIONS['h'] = Option.OPTIONS['help']
194
 
Option.SHORT_OPTIONS['m'] = Option.OPTIONS['message']
195
 
Option.SHORT_OPTIONS['r'] = Option.OPTIONS['revision']
196
 
Option.SHORT_OPTIONS['v'] = Option.OPTIONS['verbose']
197
 
Option.SHORT_OPTIONS['l'] = Option.OPTIONS['long']
198
 
Option.SHORT_OPTIONS['q'] = Option.OPTIONS['quiet']
 
394
_global_option('quiet', short_name='q')
 
395
_global_option('remember', help='Remember the specified location as a'
 
396
               ' default.')
 
397
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
 
398
_global_option('kind', type=str)
 
399
_global_option('dry-run',
 
400
               help="show what would be done, but don't actually do anything")
 
401
_global_option('name-from-revision', help='The path name in the old tree.')
 
402
 
 
403
 
 
404
# prior to 0.14 these were always globally registered; the old dict is
 
405
# available for plugins that use it but it should not be used.
 
406
Option.SHORT_OPTIONS = symbol_versioning.DeprecatedDict(
 
407
    symbol_versioning.zero_fourteen,
 
408
    'SHORT_OPTIONS',
 
409
    {
 
410
        'F': Option.OPTIONS['file'],
 
411
        'h': Option.OPTIONS['help'],
 
412
        'm': Option.OPTIONS['message'],
 
413
        'r': Option.OPTIONS['revision'],
 
414
        'v': Option.OPTIONS['verbose'],
 
415
        'l': Option.OPTIONS['long'],
 
416
        'q': Option.OPTIONS['quiet'],
 
417
    },
 
418
    'Set the short option name when constructing the Option.',
 
419
    )