1
# -*- coding: UTF-8 -*-
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
self.message = message
107
class InvalidEntryName(BzrNewError):
108
"""Invalid entry name: %(name)s"""
109
def __init__(self, name):
113
class InvalidRevisionNumber(BzrNewError):
114
"""Invalid revision number %(revno)d"""
115
def __init__(self, revno):
119
class InvalidRevisionId(BzrNewError):
120
"""Invalid revision-id"""
123
class BzrCommandError(BzrError):
124
# Error from malformed user command
128
class StrictCommitFailed(Exception):
129
"""Commit refused because there are unknowns in the tree."""
131
class NotBranchError(BzrNewError):
132
"""Not a branch: %(path)s"""
133
def __init__(self, path):
134
BzrNewError.__init__(self)
138
class UnsupportedFormatError(BzrError):
139
"""Specified path is a bzr branch that we cannot read."""
141
return 'unsupported branch format: %s' % self.args[0]
144
class NotVersionedError(BzrError):
145
"""Specified object is not versioned."""
148
class BadFileKindError(BzrError):
149
"""Specified file is of a kind that cannot be added.
151
(For example a symlink or device file.)"""
154
class ForbiddenFileError(BzrError):
155
"""Cannot operate on a file because it is a control file."""
158
class LockError(Exception):
160
# All exceptions from the lock/unlock functions should be from
161
# this exception class. They will be translated as necessary. The
162
# original exception is available as e.original_error
165
class CommitNotPossible(LockError):
166
"""A commit was attempted but we do not have a write lock open."""
169
class AlreadyCommitted(LockError):
170
"""A rollback was requested, but is not able to be accomplished."""
173
class ReadOnlyError(LockError):
174
"""A write attempt was made in a read only transaction."""
177
class PointlessCommit(BzrNewError):
178
"""No changes to commit"""
181
class NoSuchRevision(BzrError):
182
def __init__(self, branch, revision):
184
self.revision = revision
185
msg = "Branch %s has no revision %s" % (branch, revision)
186
BzrError.__init__(self, msg)
189
class HistoryMissing(BzrError):
190
def __init__(self, branch, object_type, object_id):
192
BzrError.__init__(self,
193
'%s is missing %s {%s}'
194
% (branch, object_type, object_id))
197
class DivergedBranches(BzrError):
198
def __init__(self, branch1, branch2):
199
BzrError.__init__(self, "These branches have diverged.")
200
self.branch1 = branch1
201
self.branch2 = branch2
204
class UnrelatedBranches(BzrCommandError):
206
msg = "Branches have no common ancestor, and no base revision"\
208
BzrCommandError.__init__(self, msg)
210
class NoCommonAncestor(BzrError):
211
def __init__(self, revision_a, revision_b):
212
msg = "Revisions have no common ancestor: %s %s." \
213
% (revision_a, revision_b)
214
BzrError.__init__(self, msg)
216
class NoCommonRoot(BzrError):
217
def __init__(self, revision_a, revision_b):
218
msg = "Revisions are not derived from the same root: %s %s." \
219
% (revision_a, revision_b)
220
BzrError.__init__(self, msg)
222
class NotAncestor(BzrError):
223
def __init__(self, rev_id, not_ancestor_id):
224
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
226
BzrError.__init__(self, msg)
228
self.not_ancestor_id = not_ancestor_id
231
class NotAncestor(BzrError):
232
def __init__(self, rev_id, not_ancestor_id):
234
self.not_ancestor_id = not_ancestor_id
235
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
237
BzrError.__init__(self, msg)
240
class InstallFailed(BzrError):
241
def __init__(self, revisions):
242
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
243
BzrError.__init__(self, msg)
244
self.revisions = revisions
247
class AmbiguousBase(BzrError):
248
def __init__(self, bases):
249
msg = "The correct base is unclear, becase %s are all equally close" %\
251
BzrError.__init__(self, msg)
254
class NoCommits(BzrError):
255
def __init__(self, branch):
256
msg = "Branch %s has no commits." % branch
257
BzrError.__init__(self, msg)
259
class UnlistableStore(BzrError):
260
def __init__(self, store):
261
BzrError.__init__(self, "Store %s is not listable" % store)
263
class UnlistableBranch(BzrError):
264
def __init__(self, br):
265
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
268
from bzrlib.weave import WeaveError, WeaveParentMismatch
270
class TransportError(BzrError):
271
"""All errors thrown by Transport implementations should derive
274
def __init__(self, msg=None, orig_error=None):
275
if msg is None and orig_error is not None:
276
msg = str(orig_error)
277
BzrError.__init__(self, msg)
279
self.orig_error = orig_error
281
# A set of semi-meaningful errors which can be thrown
282
class TransportNotPossible(TransportError):
283
"""This is for transports where a specific function is explicitly not
284
possible. Such as pushing files to an HTTP server.
288
class NonRelativePath(TransportError):
289
"""An absolute path was supplied, that could not be decoded into
294
class NoSuchFile(TransportError, IOError):
295
"""A get() was issued for a file that doesn't exist."""
297
# XXX: Is multiple inheritance for exceptions really needed?
300
return 'no such file: ' + self.msg
302
def __init__(self, msg=None, orig_error=None):
304
TransportError.__init__(self, msg=msg, orig_error=orig_error)
305
IOError.__init__(self, errno.ENOENT, self.msg)
307
class FileExists(TransportError, OSError):
308
"""An operation was attempted, which would overwrite an entry,
309
but overwritting is not supported.
311
mkdir() can throw this, but put() just overwites existing files.
313
# XXX: Is multiple inheritance for exceptions really needed?
314
def __init__(self, msg=None, orig_error=None):
316
TransportError.__init__(self, msg=msg, orig_error=orig_error)
317
OSError.__init__(self, errno.EEXIST, self.msg)
319
class PermissionDenied(TransportError):
320
"""An operation cannot succeed because of a lack of permissions."""
323
class ConnectionReset(TransportError):
324
"""The connection has been closed."""
327
class ConflictsInTree(BzrError):
329
BzrError.__init__(self, "Working tree has conflicts.")
added
removed
bzrlib/errors.py
