← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/option.py

[merge] Hermann Kraus: updates to Bundle exceptions

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/option.py
1
 
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006 by Canonical Ltd
2
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
19
19
 
20
20
import re
21
21
 
22
 
from bzrlib.lazy_import import lazy_import
23
 
lazy_import(globals(), """
24
 
import optparse
25
 
 
26
 
from bzrlib import (
27
 
    errors,
28
 
    revisionspec,
29
 
    )
30
 
""")
31
22
from bzrlib.trace import warning
 
23
from bzrlib.revisionspec import RevisionSpec
 
24
from bzrlib.errors import BzrCommandError
32
25
 
33
26
 
34
27
def _parse_revision_str(revstr):
38
31
    each revision specifier supplied.
39
32
 
40
33
    >>> _parse_revision_str('234')
41
 
    [<RevisionSpec_revno 234>]
 
34
    [<RevisionSpec_int 234>]
42
35
    >>> _parse_revision_str('234..567')
43
 
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
 
36
    [<RevisionSpec_int 234>, <RevisionSpec_int 567>]
44
37
    >>> _parse_revision_str('..')
45
38
    [<RevisionSpec None>, <RevisionSpec None>]
46
39
    >>> _parse_revision_str('..234')
47
 
    [<RevisionSpec None>, <RevisionSpec_revno 234>]
 
40
    [<RevisionSpec None>, <RevisionSpec_int 234>]
48
41
    >>> _parse_revision_str('234..')
49
 
    [<RevisionSpec_revno 234>, <RevisionSpec None>]
 
42
    [<RevisionSpec_int 234>, <RevisionSpec None>]
50
43
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
51
 
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
 
44
    [<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
52
45
    >>> _parse_revision_str('234....789') #Error ?
53
 
    [<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
 
46
    [<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
54
47
    >>> _parse_revision_str('revid:test@other.com-234234')
55
48
    [<RevisionSpec_revid revid:test@other.com-234234>]
56
49
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
57
50
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
58
51
    >>> _parse_revision_str('revid:test@other.com-234234..23')
59
 
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
 
52
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
60
53
    >>> _parse_revision_str('date:2005-04-12')
61
54
    [<RevisionSpec_date date:2005-04-12>]
62
55
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
66
59
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
67
60
    [<RevisionSpec_date date:2005-04-12,12:24:33>]
68
61
    >>> _parse_revision_str('-5..23')
69
 
    [<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
 
62
    [<RevisionSpec_int -5>, <RevisionSpec_int 23>]
70
63
    >>> _parse_revision_str('-5')
71
 
    [<RevisionSpec_revno -5>]
 
64
    [<RevisionSpec_int -5>]
72
65
    >>> _parse_revision_str('123a')
73
66
    Traceback (most recent call last):
74
67
      ...
75
 
    NoSuchRevisionSpec: No namespace registered for string: '123a'
 
68
    BzrError: No namespace registered for string: '123a'
76
69
    >>> _parse_revision_str('abc')
77
70
    Traceback (most recent call last):
78
71
      ...
79
 
    NoSuchRevisionSpec: No namespace registered for string: 'abc'
 
72
    BzrError: No namespace registered for string: 'abc'
80
73
    >>> _parse_revision_str('branch:../branch2')
81
74
    [<RevisionSpec_branch branch:../branch2>]
82
75
    >>> _parse_revision_str('branch:../../branch2')
83
76
    [<RevisionSpec_branch branch:../../branch2>]
84
77
    >>> _parse_revision_str('branch:../../branch2..23')
85
 
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
 
78
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_int 23>]
86
79
    """
87
80
    # TODO: Maybe move this into revisionspec.py
 
81
    old_format_re = re.compile('\d*:\d*')
 
82
    m = old_format_re.match(revstr)
88
83
    revs = []
89
 
    # split on the first .. that is not followed by a / ?
90
 
    sep = re.compile("\\.\\.(?!/)")
91
 
    for x in sep.split(revstr):
92
 
        revs.append(revisionspec.RevisionSpec.from_string(x or None))
 
84
    if m:
 
85
        warning('Colon separator for revision numbers is deprecated.'
 
86
                ' Use .. instead')
 
87
        for rev in revstr.split(':'):
 
88
            if rev:
 
89
                revs.append(RevisionSpec(int(rev)))
 
90
            else:
 
91
                revs.append(RevisionSpec(None))
 
92
    else:
 
93
        sep = re.compile("\\.\\.(?!/)")
 
94
        for x in sep.split(revstr):
 
95
            revs.append(RevisionSpec(x or None))
93
96
    return revs
94
97
 
95
98
 
107
110
        type_list = '\n'.join(lines)
108
111
        msg = "No known merge type %s. Supported types are:\n%s" %\
109
112
            (typestring, type_list)
110
 
        raise errors.BzrCommandError(msg)
 
113
        raise BzrCommandError(msg)
111
114
 
112
115
class Option(object):
113
116
    """Description of a command line option"""
150
153
            if option is self:
151
154
                return short
152
155
 
153
 
    def get_negation_name(self):
154
 
        if self.name.startswith('no-'):
155
 
            return self.name[3:]
156
 
        else:
157
 
            return 'no-' + self.name
158
 
 
159
 
    def add_option(self, parser, short_name):
160
 
        """Add this option to an Optparse parser"""
161
 
        option_strings = ['--%s' % self.name]
162
 
        if short_name is not None:
163
 
            option_strings.append('-%s' % short_name)
164
 
        optargfn = self.type
165
 
        if optargfn is None:
166
 
            parser.add_option(action='store_true', dest=self.name, 
167
 
                              help=self.help,
168
 
                              default=OptionParser.DEFAULT_VALUE,
169
 
                              *option_strings)
170
 
            negation_strings = ['--%s' % self.get_negation_name()]
171
 
            parser.add_option(action='store_false', dest=self.name, 
172
 
                              help=optparse.SUPPRESS_HELP, *negation_strings)
173
 
        else:
174
 
            parser.add_option(action='callback', 
175
 
                              callback=self._optparse_callback, 
176
 
                              type='string', metavar=self.argname.upper(),
177
 
                              help=self.help,
178
 
                              default=OptionParser.DEFAULT_VALUE, 
179
 
                              *option_strings)
180
 
 
181
 
    def _optparse_callback(self, option, opt, value, parser):
182
 
        setattr(parser.values, self.name, self.type(value))
183
 
 
184
 
    def iter_switches(self):
185
 
        """Iterate through the list of switches provided by the option
186
 
        
187
 
        :return: an iterator of (name, short_name, argname, help)
188
 
        """
189
 
        argname =  self.argname
190
 
        if argname is not None:
191
 
            argname = argname.upper()
192
 
        yield self.name, self.short_name(), argname, self.help
193
 
 
194
 
 
195
 
class OptionParser(optparse.OptionParser):
196
 
    """OptionParser that raises exceptions instead of exiting"""
197
 
 
198
 
    DEFAULT_VALUE = object()
199
 
 
200
 
    def error(self, message):
201
 
        raise errors.BzrCommandError(message)
202
 
 
203
 
 
204
 
def get_optparser(options):
205
 
    """Generate an optparse parser for bzrlib-style options"""
206
 
 
207
 
    parser = OptionParser()
208
 
    parser.remove_option('--help')
209
 
    short_options = dict((k.name, v) for v, k in 
210
 
                         Option.SHORT_OPTIONS.iteritems())
211
 
    for option in options.itervalues():
212
 
        option.add_option(parser, short_options.get(option.name))
213
 
    return parser
214
 
 
215
156
 
216
157
def _global_option(name, **kwargs):
217
158
    """Register o as a global option."""