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.
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.
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
17
"""Exceptions for bzr, and reporting of them.
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.
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.
29
This means that exceptions can used like this:
33
... raise NotBranchError(path='/foo/bar')
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
44
* create a new exception class for any class of error that can be
45
usefully distinguished.
47
* the printable form of an exception is generated by the base class
51
# based on Scott James Remnant's hct error classes
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
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.
61
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
65
class BzrError(StandardError):
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__ + ': '
72
if len(self.args) == 1:
73
return str(self.args[0])
74
elif len(self.args) == 2:
75
# further explanation or suggestions
77
return n + '\n '.join([self.args[0]] + self.args[1])
79
return n + "%r" % self
81
return n + `self.args`
84
class BzrNewError(BzrError):
86
# base classes should override the docstring with their human-
87
# readable explanation
89
def __init__(self, **kwds):
90
for key, value in kwds.items():
91
setattr(self, key, value)
95
return self.__doc__ % self.__dict__
96
except (NameError, ValueError, KeyError), e:
97
return 'Unprintable exception %s: %s' \
98
% (self.__class__.__name__, str(e))
101
class BzrCheckError(BzrNewError):
102
"""Internal check failed: %(message)s"""
103
def __init__(self, message):
104
BzrNewError.__init__(self)
105
self.message = message
108
class InvalidEntryName(BzrNewError):
109
"""Invalid entry name: %(name)s"""
110
def __init__(self, name):
111
BzrNewError.__init__(self)
115
class InvalidRevisionNumber(BzrNewError):
116
"""Invalid revision number %(revno)d"""
117
def __init__(self, revno):
118
BzrNewError.__init__(self)
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
130
class BzrCommandError(BzrError):
131
# Error from malformed user command
135
class StrictCommitFailed(Exception):
136
"""Commit refused because there are unknowns in the tree."""
138
class NotBranchError(BzrNewError):
139
"""Not a branch: %(path)s"""
140
def __init__(self, path):
141
BzrNewError.__init__(self)
145
class UnsupportedFormatError(BzrError):
146
"""Specified path is a bzr branch that we cannot read."""
148
return 'unsupported branch format: %s' % self.args[0]
151
class NotVersionedError(BzrNewError):
152
"""%(path)s is not versioned"""
153
def __init__(self, path):
154
BzrNewError.__init__(self)
158
class BadFileKindError(BzrError):
159
"""Specified file is of a kind that cannot be added.
161
(For example a symlink or device file.)"""
164
class ForbiddenFileError(BzrError):
165
"""Cannot operate on a file because it is a control file."""
168
class LockError(Exception):
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
175
class CommitNotPossible(LockError):
176
"""A commit was attempted but we do not have a write lock open."""
179
class AlreadyCommitted(LockError):
180
"""A rollback was requested, but is not able to be accomplished."""
183
class ReadOnlyError(LockError):
184
"""A write attempt was made in a read only transaction."""
187
class PointlessCommit(BzrNewError):
188
"""No changes to commit"""
191
class NoSuchRevision(BzrError):
192
def __init__(self, branch, revision):
194
self.revision = revision
195
msg = "Branch %s has no revision %s" % (branch, revision)
196
BzrError.__init__(self, msg)
199
class HistoryMissing(BzrError):
200
def __init__(self, branch, object_type, object_id):
202
BzrError.__init__(self,
203
'%s is missing %s {%s}'
204
% (branch, object_type, object_id))
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
214
class UnrelatedBranches(BzrCommandError):
216
msg = "Branches have no common ancestor, and no base revision"\
218
BzrCommandError.__init__(self, msg)
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)
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)
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,
236
BzrError.__init__(self, msg)
238
self.not_ancestor_id = not_ancestor_id
241
class NotAncestor(BzrError):
242
def __init__(self, rev_id, not_ancestor_id):
244
self.not_ancestor_id = not_ancestor_id
245
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
247
BzrError.__init__(self, msg)
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
257
class AmbiguousBase(BzrError):
258
def __init__(self, bases):
259
msg = "The correct base is unclear, becase %s are all equally close" %\
261
BzrError.__init__(self, msg)
264
class NoCommits(BzrError):
265
def __init__(self, branch):
266
msg = "Branch %s has no commits." % branch
267
BzrError.__init__(self, msg)
269
class UnlistableStore(BzrError):
270
def __init__(self, store):
271
BzrError.__init__(self, "Store %s is not listable" % store)
273
class UnlistableBranch(BzrError):
274
def __init__(self, br):
275
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
278
class WeaveError(BzrNewError):
279
"""Error in processing weave: %(message)s"""
280
def __init__(self, message=None):
281
BzrNewError.__init__(self)
282
self.message = message
285
class WeaveRevisionAlreadyPresent(WeaveError):
286
"""Revision {%(revision_id)s} already present in %(weave)s"""
287
def __init__(self, revision_id, weave):
288
WeaveError.__init__(self)
289
self.revision_id = revision_id
293
class WeaveRevisionNotPresent(WeaveError):
294
"""Revision {%(revision_id)s} not present in %(weave)s"""
295
def __init__(self, revision_id, weave):
296
WeaveError.__init__(self)
297
self.revision_id = revision_id
301
class WeaveFormatError(WeaveError):
302
"""Weave invariant violated: %(what)s"""
303
def __init__(self, what):
304
WeaveError.__init__(self)
308
class WeaveParentMismatch(WeaveError):
309
"""Parents are mismatched between two revisions."""
312
class TransportError(BzrError):
313
"""All errors thrown by Transport implementations should derive
316
def __init__(self, msg=None, orig_error=None):
317
if msg is None and orig_error is not None:
318
msg = str(orig_error)
319
BzrError.__init__(self, msg)
321
self.orig_error = orig_error
323
# A set of semi-meaningful errors which can be thrown
324
class TransportNotPossible(TransportError):
325
"""This is for transports where a specific function is explicitly not
326
possible. Such as pushing files to an HTTP server.
330
class NonRelativePath(TransportError):
331
"""An absolute path was supplied, that could not be decoded into
336
class NoSuchFile(TransportError, IOError):
337
"""A get() was issued for a file that doesn't exist."""
339
# XXX: Is multiple inheritance for exceptions really needed?
342
return 'no such file: ' + self.msg
344
def __init__(self, msg=None, orig_error=None):
346
TransportError.__init__(self, msg=msg, orig_error=orig_error)
347
IOError.__init__(self, errno.ENOENT, self.msg)
349
class FileExists(TransportError, OSError):
350
"""An operation was attempted, which would overwrite an entry,
351
but overwritting is not supported.
353
mkdir() can throw this, but put() just overwites existing files.
355
# XXX: Is multiple inheritance for exceptions really needed?
356
def __init__(self, msg=None, orig_error=None):
358
TransportError.__init__(self, msg=msg, orig_error=orig_error)
359
OSError.__init__(self, errno.EEXIST, self.msg)
361
class PermissionDenied(TransportError):
362
"""An operation cannot succeed because of a lack of permissions."""
365
class ConnectionReset(TransportError):
366
"""The connection has been closed."""
369
class ConflictsInTree(BzrError):
371
BzrError.__init__(self, "Working tree has conflicts.")
373
class ParseConfigError(BzrError):
374
def __init__(self, errors, filename):
377
message = "Error(s) parsing config file %s:\n%s" % \
378
(filename, ('\n'.join(e.message for e in errors)))
379
BzrError.__init__(self, message)
381
class SigningFailed(BzrError):
382
def __init__(self, command_line):
383
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
386
class WorkingTreeNotRevision(BzrError):
387
def __init__(self, tree):
388
BzrError.__init__(self, "The working tree for %s has changed since"
389
" last commit, but weave merge requires that it be"
390
" unchanged." % tree.basedir)
392
class GraphCycleError(BzrNewError):
393
"""Cycle in graph %(graph)r"""
394
def __init__(self, graph):
395
BzrNewError.__init__(self)
added
removed
bzrlib/errors.py
