← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/option.py

Update news and readme

- better explanation of dependencies

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
35
23
 
36
24
 
37
25
def _parse_revision_str(revstr):
41
29
    each revision specifier supplied.
42
30
 
43
31
    >>> _parse_revision_str('234')
44
 
    [<RevisionSpec_revno 234>]
 
32
    [<RevisionSpec_int 234>]
45
33
    >>> _parse_revision_str('234..567')
46
 
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
 
34
    [<RevisionSpec_int 234>, <RevisionSpec_int 567>]
47
35
    >>> _parse_revision_str('..')
48
36
    [<RevisionSpec None>, <RevisionSpec None>]
49
37
    >>> _parse_revision_str('..234')
50
 
    [<RevisionSpec None>, <RevisionSpec_revno 234>]
 
38
    [<RevisionSpec None>, <RevisionSpec_int 234>]
51
39
    >>> _parse_revision_str('234..')
52
 
    [<RevisionSpec_revno 234>, <RevisionSpec None>]
 
40
    [<RevisionSpec_int 234>, <RevisionSpec None>]
53
41
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
54
 
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
 
42
    [<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
55
43
    >>> _parse_revision_str('234....789') #Error ?
56
 
    [<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
 
44
    [<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
57
45
    >>> _parse_revision_str('revid:test@other.com-234234')
58
46
    [<RevisionSpec_revid revid:test@other.com-234234>]
59
47
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
60
48
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
61
49
    >>> _parse_revision_str('revid:test@other.com-234234..23')
62
 
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
 
50
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
63
51
    >>> _parse_revision_str('date:2005-04-12')
64
52
    [<RevisionSpec_date date:2005-04-12>]
65
53
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
69
57
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
70
58
    [<RevisionSpec_date date:2005-04-12,12:24:33>]
71
59
    >>> _parse_revision_str('-5..23')
72
 
    [<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
 
60
    [<RevisionSpec_int -5>, <RevisionSpec_int 23>]
73
61
    >>> _parse_revision_str('-5')
74
 
    [<RevisionSpec_revno -5>]
 
62
    [<RevisionSpec_int -5>]
75
63
    >>> _parse_revision_str('123a')
76
64
    Traceback (most recent call last):
77
65
      ...
78
 
    NoSuchRevisionSpec: No namespace registered for string: '123a'
 
66
    BzrError: No namespace registered for string: '123a'
79
67
    >>> _parse_revision_str('abc')
80
68
    Traceback (most recent call last):
81
69
      ...
82
 
    NoSuchRevisionSpec: No namespace registered for string: 'abc'
 
70
    BzrError: No namespace registered for string: 'abc'
83
71
    >>> _parse_revision_str('branch:../branch2')
84
72
    [<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>]
89
73
    """
90
74
    # TODO: Maybe move this into revisionspec.py
 
75
    old_format_re = re.compile('\d*:\d*')
 
76
    m = old_format_re.match(revstr)
91
77
    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))
 
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))
96
101
    return revs
97
102
 
98
103
 
99
104
def _parse_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)
 
105
    return bzrlib.commands.get_merge_type(typestring)
114
106
 
115
107
 
116
108
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
 
 
 
109
    """Description of a command line option"""
123
110
    # TODO: Some way to show in help a description of the option argument
124
111
 
125
112
    OPTIONS = {}
 
113
    SHORT_OPTIONS = {}
126
114
 
127
 
    def __init__(self, name, help='', type=None, argname=None,
128
 
                 short_name=None):
 
115
    def __init__(self, name, help='', type=None, argname=None):
129
116
        """Make a new command option.
130
117
 
131
118
        name -- regular name of the command, used in the double-dash
139
126
 
140
127
        argname -- name of option argument, if any
141
128
        """
 
129
        # TODO: perhaps a subclass that automatically does 
 
130
        # --option, --no-option for reversable booleans
142
131
        self.name = name
143
132
        self.help = help
144
133
        self.type = type
145
 
        self._short_name = short_name
146
134
        if type is None:
147
135
            assert argname is None
148
136
        elif argname is None:
150
138
        self.argname = argname
151
139
 
152
140
    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
 
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)
346
146
 
347
147
 
348
148
def _global_option(name, **kwargs):
349
149
    """Register o as a global option."""
350
150
    Option.OPTIONS[name] = Option(name, **kwargs)
351
151
 
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
 
 
370
152
_global_option('all')
371
 
_global_option('overwrite', help='Ignore differences between branches and '
372
 
               'overwrite unconditionally.')
373
153
_global_option('basis', type=str)
374
 
_global_option('bound')
375
154
_global_option('diff-options', type=str)
376
 
_global_option('file', type=unicode, short_name='F')
 
155
_global_option('help',
 
156
               help='show help message')
 
157
_global_option('file', type=unicode)
377
158
_global_option('force')
378
159
_global_option('format', type=unicode)
379
160
_global_option('forward')
380
 
_global_option('message', type=unicode,
381
 
               short_name='m',
382
 
               help='Message string.')
 
161
_global_option('message', type=unicode)
383
162
_global_option('no-recurse')
384
163
_global_option('profile',
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.')
 
164
               help='show performance profiling information')
 
165
_global_option('revision', type=_parse_revision_str)
 
166
_global_option('short')
 
167
_global_option('show-ids', 
 
168
               help='show internal object ids')
392
169
_global_option('timezone', 
393
170
               type=str,
394
171
               help='display timezone as local, original, or utc')
395
 
_global_option('unbound')
396
172
_global_option('verbose',
397
 
               help='Display more information.',
398
 
               short_name='v')
 
173
               help='display more information')
399
174
_global_option('version')
400
175
_global_option('email')
401
176
_global_option('update')
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')
 
177
_global_option('long')
409
178
_global_option('root', type=str)
410
179
_global_option('no-backup')
411
 
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
412
 
                        _merge_type_registry, value_switches=True,
413
 
                        title='Merge algorithm')
 
180
_global_option('merge-type', type=_parse_merge_type)
414
181
_global_option('pattern', type=str)
415
 
_global_option('quiet', short_name='q')
416
 
_global_option('remember', help='Remember the specified location as a'
417
 
               ' default.')
418
 
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
419
 
_global_option('kind', type=str)
420
 
_global_option('dry-run',
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')
 
182
_global_option('quiet')
 
183
_global_option('remember')
 
184
 
 
185
 
 
186
def _global_short(short_name, long_name):
 
187
    assert short_name not in Option.SHORT_OPTIONS
 
188
    Option.SHORT_OPTIONS[short_name] = Option.OPTIONS[long_name]
 
189
    
 
190
 
 
191
Option.SHORT_OPTIONS['F'] = Option.OPTIONS['file']
 
192
Option.SHORT_OPTIONS['h'] = Option.OPTIONS['help']
 
193
Option.SHORT_OPTIONS['m'] = Option.OPTIONS['message']
 
194
Option.SHORT_OPTIONS['r'] = Option.OPTIONS['revision']
 
195
Option.SHORT_OPTIONS['v'] = Option.OPTIONS['verbose']
 
196
Option.SHORT_OPTIONS['l'] = Option.OPTIONS['long']
 
197
Option.SHORT_OPTIONS['q'] = Option.OPTIONS['quiet']