/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

Fix up all calls to InvalidRevisionId() to specify parameters.

Pointed out by Jelmer.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
 
1
# (C) 2005 Canonical
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""Exceptions for bzr, and reporting of them.
 
18
 
 
19
Exceptions are caught at a high level to report errors to the user, and
 
20
might also be caught inside the program.  Therefore it needs to be
 
21
possible to convert them to a meaningful string, and also for them to be
 
22
interrogated by the program.
 
23
 
 
24
Exceptions are defined such that the arguments given to the constructor
 
25
are stored in the object as properties of the same name.  When the
 
26
object is printed as a string, the doc string of the class is used as
 
27
a format string with the property dictionary available to it.
 
28
 
 
29
This means that exceptions can used like this:
 
30
 
 
31
>>> import sys
 
32
>>> try:
 
33
...   raise NotBranchError(path='/foo/bar')
 
34
... except:
 
35
...   print sys.exc_type
 
36
...   print sys.exc_value
 
37
...   print sys.exc_value.path
 
38
bzrlib.errors.NotBranchError
 
39
Not a branch: /foo/bar
 
40
/foo/bar
 
41
 
 
42
Therefore:
 
43
 
 
44
 * create a new exception class for any class of error that can be
 
45
   usefully distinguished.
 
46
 
 
47
 * the printable form of an exception is generated by the base class
 
48
   __str__ method
 
49
"""
 
50
 
 
51
# based on Scott James Remnant's hct error classes
 
52
 
 
53
# TODO: is there any value in providing the .args field used by standard
 
54
# python exceptions?   A list of values with no names seems less useful 
 
55
# to me.
 
56
 
 
57
# TODO: Perhaps convert the exception to a string at the moment it's 
 
58
# constructed to make sure it will succeed.  But that says nothing about
 
59
# exceptions that are never raised.
 
60
 
 
61
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
 
62
# the old one.
 
63
 
 
64
 
 
65
class BzrError(StandardError):
 
66
    def __str__(self):
 
67
        # XXX: Should we show the exception class in 
 
68
        # exceptions that don't provide their own message?  
 
69
        # maybe it should be done at a higher level
 
70
        ## n = self.__class__.__name__ + ': '
 
71
        n = ''
 
72
        if len(self.args) == 1:
 
73
            return str(self.args[0])
 
74
        elif len(self.args) == 2:
 
75
            # further explanation or suggestions
 
76
            try:
 
77
                return n + '\n  '.join([self.args[0]] + self.args[1])
 
78
            except TypeError:
 
79
                return n + "%r" % self
 
80
        else:
 
81
            return n + `self.args`
 
82
 
 
83
 
 
84
class BzrNewError(BzrError):
 
85
    """bzr error"""
 
86
    # base classes should override the docstring with their human-
 
87
    # readable explanation
 
88
 
 
89
    def __init__(self, **kwds):
 
90
        for key, value in kwds.items():
 
91
            setattr(self, key, value)
 
92
 
 
93
    def __str__(self):
 
94
        try:
 
95
            return self.__doc__ % self.__dict__
 
96
        except (NameError, ValueError, KeyError), e:
 
97
            return 'Unprintable exception %s: %s' \
 
98
                % (self.__class__.__name__, str(e))
 
99
 
 
100
 
 
101
class BzrCheckError(BzrNewError):
 
102
    """Internal check failed: %(message)s"""
 
103
    def __init__(self, message):
 
104
        BzrNewError.__init__(self)
 
105
        self.message = message
 
106
 
 
107
 
 
108
class InvalidEntryName(BzrNewError):
 
109
    """Invalid entry name: %(name)s"""
 
110
    def __init__(self, name):
 
111
        BzrNewError.__init__(self)
 
112
        self.name = name
 
113
 
 
114
 
 
115
class InvalidRevisionNumber(BzrNewError):
 
116
    """Invalid revision number %(revno)d"""
 
117
    def __init__(self, revno):
 
118
        BzrNewError.__init__(self)
 
119
        self.revno = revno
 
120
 
 
121
 
 
122
class InvalidRevisionId(BzrNewError):
 
123
    """Invalid revision-id {%(revision_id)s} in %(branch)s"""
 
124
    def __init__(self, revision_id, branch):
 
125
        BzrNewError.__init__(self)
 
126
        self.revision_id = revision_id
 
127
        self.branch = branch
 
128
 
 
129
 
 
130
class BzrCommandError(BzrError):
 
131
    # Error from malformed user command
 
132
    def __str__(self):
 
133
        return self.args[0]
 
134
 
 
135
class StrictCommitFailed(Exception):
 
136
    """Commit refused because there are unknowns in the tree."""
 
137
 
 
138
class NotBranchError(BzrNewError):
 
139
    """Not a branch: %(path)s"""
 
140
    def __init__(self, path):
 
141
        BzrNewError.__init__(self)
 
142
        self.path = path
 
143
 
 
144
 
 
145
class UnsupportedFormatError(BzrError):
 
146
    """Specified path is a bzr branch that we cannot read."""
 
147
    def __str__(self):
 
148
        return 'unsupported branch format: %s' % self.args[0]
 
149
 
 
150
 
 
151
class NotVersionedError(BzrNewError):
 
152
    """%(path)s is not versioned"""
 
153
    def __init__(self, path):
 
154
        BzrNewError.__init__(self)
 
155
        self.path = path
 
156
 
 
157
 
 
158
class BadFileKindError(BzrError):
 
159
    """Specified file is of a kind that cannot be added.
 
160
 
 
161
    (For example a symlink or device file.)"""
 
162
 
 
163
 
 
164
class ForbiddenFileError(BzrError):
 
165
    """Cannot operate on a file because it is a control file."""
 
166
 
 
167
 
 
168
class LockError(Exception):
 
169
    """Lock error"""
 
170
    # All exceptions from the lock/unlock functions should be from
 
171
    # this exception class.  They will be translated as necessary. The
 
172
    # original exception is available as e.original_error
 
173
 
 
174
 
 
175
class CommitNotPossible(LockError):
 
176
    """A commit was attempted but we do not have a write lock open."""
 
177
 
 
178
 
 
179
class AlreadyCommitted(LockError):
 
180
    """A rollback was requested, but is not able to be accomplished."""
 
181
 
 
182
 
 
183
class ReadOnlyError(LockError):
 
184
    """A write attempt was made in a read only transaction."""
 
185
 
 
186
 
 
187
class PointlessCommit(BzrNewError):
 
188
    """No changes to commit"""
 
189
 
 
190
 
 
191
class NoSuchRevision(BzrError):
 
192
    def __init__(self, branch, revision):
 
193
        self.branch = branch
 
194
        self.revision = revision
 
195
        msg = "Branch %s has no revision %s" % (branch, revision)
 
196
        BzrError.__init__(self, msg)
 
197
 
 
198
 
 
199
class HistoryMissing(BzrError):
 
200
    def __init__(self, branch, object_type, object_id):
 
201
        self.branch = branch
 
202
        BzrError.__init__(self,
 
203
                          '%s is missing %s {%s}'
 
204
                          % (branch, object_type, object_id))
 
205
 
 
206
 
 
207
class DivergedBranches(BzrError):
 
208
    def __init__(self, branch1, branch2):
 
209
        BzrError.__init__(self, "These branches have diverged.")
 
210
        self.branch1 = branch1
 
211
        self.branch2 = branch2
 
212
 
 
213
 
 
214
class UnrelatedBranches(BzrCommandError):
 
215
    def __init__(self):
 
216
        msg = "Branches have no common ancestor, and no base revision"\
 
217
            " specified."
 
218
        BzrCommandError.__init__(self, msg)
 
219
 
 
220
class NoCommonAncestor(BzrError):
 
221
    def __init__(self, revision_a, revision_b):
 
222
        msg = "Revisions have no common ancestor: %s %s." \
 
223
            % (revision_a, revision_b) 
 
224
        BzrError.__init__(self, msg)
 
225
 
 
226
class NoCommonRoot(BzrError):
 
227
    def __init__(self, revision_a, revision_b):
 
228
        msg = "Revisions are not derived from the same root: %s %s." \
 
229
            % (revision_a, revision_b) 
 
230
        BzrError.__init__(self, msg)
 
231
 
 
232
class NotAncestor(BzrError):
 
233
    def __init__(self, rev_id, not_ancestor_id):
 
234
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
235
                                                        rev_id)
 
236
        BzrError.__init__(self, msg)
 
237
        self.rev_id = rev_id
 
238
        self.not_ancestor_id = not_ancestor_id
 
239
 
 
240
 
 
241
class NotAncestor(BzrError):
 
242
    def __init__(self, rev_id, not_ancestor_id):
 
243
        self.rev_id = rev_id
 
244
        self.not_ancestor_id = not_ancestor_id
 
245
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
246
                                                        rev_id)
 
247
        BzrError.__init__(self, msg)
 
248
 
 
249
 
 
250
class InstallFailed(BzrError):
 
251
    def __init__(self, revisions):
 
252
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
 
253
        BzrError.__init__(self, msg)
 
254
        self.revisions = revisions
 
255
 
 
256
 
 
257
class AmbiguousBase(BzrError):
 
258
    def __init__(self, bases):
 
259
        msg = "The correct base is unclear, becase %s are all equally close" %\
 
260
            ", ".join(bases)
 
261
        BzrError.__init__(self, msg)
 
262
        self.bases = bases
 
263
 
 
264
class NoCommits(BzrError):
 
265
    def __init__(self, branch):
 
266
        msg = "Branch %s has no commits." % branch
 
267
        BzrError.__init__(self, msg)
 
268
 
 
269
class UnlistableStore(BzrError):
 
270
    def __init__(self, store):
 
271
        BzrError.__init__(self, "Store %s is not listable" % store)
 
272
 
 
273
class UnlistableBranch(BzrError):
 
274
    def __init__(self, br):
 
275
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
276
 
 
277
 
 
278
from bzrlib.weave import WeaveError, WeaveParentMismatch
 
279
 
 
280
class TransportError(BzrError):
 
281
    """All errors thrown by Transport implementations should derive
 
282
    from this class.
 
283
    """
 
284
    def __init__(self, msg=None, orig_error=None):
 
285
        if msg is None and orig_error is not None:
 
286
            msg = str(orig_error)
 
287
        BzrError.__init__(self, msg)
 
288
        self.msg = msg
 
289
        self.orig_error = orig_error
 
290
 
 
291
# A set of semi-meaningful errors which can be thrown
 
292
class TransportNotPossible(TransportError):
 
293
    """This is for transports where a specific function is explicitly not
 
294
    possible. Such as pushing files to an HTTP server.
 
295
    """
 
296
    pass
 
297
 
 
298
class NonRelativePath(TransportError):
 
299
    """An absolute path was supplied, that could not be decoded into
 
300
    a relative path.
 
301
    """
 
302
    pass
 
303
 
 
304
class NoSuchFile(TransportError, IOError):
 
305
    """A get() was issued for a file that doesn't exist."""
 
306
 
 
307
    # XXX: Is multiple inheritance for exceptions really needed?
 
308
 
 
309
    def __str__(self):
 
310
        return 'no such file: ' + self.msg
 
311
 
 
312
    def __init__(self, msg=None, orig_error=None):
 
313
        import errno
 
314
        TransportError.__init__(self, msg=msg, orig_error=orig_error)
 
315
        IOError.__init__(self, errno.ENOENT, self.msg)
 
316
 
 
317
class FileExists(TransportError, OSError):
 
318
    """An operation was attempted, which would overwrite an entry,
 
319
    but overwritting is not supported.
 
320
 
 
321
    mkdir() can throw this, but put() just overwites existing files.
 
322
    """
 
323
    # XXX: Is multiple inheritance for exceptions really needed?
 
324
    def __init__(self, msg=None, orig_error=None):
 
325
        import errno
 
326
        TransportError.__init__(self, msg=msg, orig_error=orig_error)
 
327
        OSError.__init__(self, errno.EEXIST, self.msg)
 
328
 
 
329
class PermissionDenied(TransportError):
 
330
    """An operation cannot succeed because of a lack of permissions."""
 
331
    pass
 
332
 
 
333
class ConnectionReset(TransportError):
 
334
    """The connection has been closed."""
 
335
    pass
 
336
 
 
337
class ConflictsInTree(BzrError):
 
338
    def __init__(self):
 
339
        BzrError.__init__(self, "Working tree has conflicts.")
 
340
 
 
341
class ParseConfigError(BzrError):
 
342
    def __init__(self, errors, filename):
 
343
        if filename is None:
 
344
            filename = ""
 
345
        message = "Error(s) parsing config file %s:\n%s" % \
 
346
            (filename, ('\n'.join(e.message for e in errors)))
 
347
        BzrError.__init__(self, message)
 
348
 
 
349
class SigningFailed(BzrError):
 
350
    def __init__(self, command_line):
 
351
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
 
352
                               % command_line)