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(BzrNewError):
145
"""%(path)s is not versioned"""
146
def __init__(self, path):
147
BzrNewError.__init__(self)
151
class BadFileKindError(BzrError):
152
"""Specified file is of a kind that cannot be added.
154
(For example a symlink or device file.)"""
157
class ForbiddenFileError(BzrError):
158
"""Cannot operate on a file because it is a control file."""
161
class LockError(Exception):
163
# All exceptions from the lock/unlock functions should be from
164
# this exception class. They will be translated as necessary. The
165
# original exception is available as e.original_error
168
class CommitNotPossible(LockError):
169
"""A commit was attempted but we do not have a write lock open."""
172
class AlreadyCommitted(LockError):
173
"""A rollback was requested, but is not able to be accomplished."""
176
class ReadOnlyError(LockError):
177
"""A write attempt was made in a read only transaction."""
180
class PointlessCommit(BzrNewError):
181
"""No changes to commit"""
184
class NoSuchRevision(BzrError):
185
def __init__(self, branch, revision):
187
self.revision = revision
188
msg = "Branch %s has no revision %s" % (branch, revision)
189
BzrError.__init__(self, msg)
192
class HistoryMissing(BzrError):
193
def __init__(self, branch, object_type, object_id):
195
BzrError.__init__(self,
196
'%s is missing %s {%s}'
197
% (branch, object_type, object_id))
200
class DivergedBranches(BzrError):
201
def __init__(self, branch1, branch2):
202
BzrError.__init__(self, "These branches have diverged.")
203
self.branch1 = branch1
204
self.branch2 = branch2
207
class UnrelatedBranches(BzrCommandError):
209
msg = "Branches have no common ancestor, and no base revision"\
211
BzrCommandError.__init__(self, msg)
213
class NoCommonAncestor(BzrError):
214
def __init__(self, revision_a, revision_b):
215
msg = "Revisions have no common ancestor: %s %s." \
216
% (revision_a, revision_b)
217
BzrError.__init__(self, msg)
219
class NoCommonRoot(BzrError):
220
def __init__(self, revision_a, revision_b):
221
msg = "Revisions are not derived from the same root: %s %s." \
222
% (revision_a, revision_b)
223
BzrError.__init__(self, msg)
225
class NotAncestor(BzrError):
226
def __init__(self, rev_id, not_ancestor_id):
227
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
229
BzrError.__init__(self, msg)
231
self.not_ancestor_id = not_ancestor_id
234
class NotAncestor(BzrError):
235
def __init__(self, rev_id, not_ancestor_id):
237
self.not_ancestor_id = not_ancestor_id
238
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
240
BzrError.__init__(self, msg)
243
class InstallFailed(BzrError):
244
def __init__(self, revisions):
245
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
246
BzrError.__init__(self, msg)
247
self.revisions = revisions
250
class AmbiguousBase(BzrError):
251
def __init__(self, bases):
252
msg = "The correct base is unclear, becase %s are all equally close" %\
254
BzrError.__init__(self, msg)
257
class NoCommits(BzrError):
258
def __init__(self, branch):
259
msg = "Branch %s has no commits." % branch
260
BzrError.__init__(self, msg)
262
class UnlistableStore(BzrError):
263
def __init__(self, store):
264
BzrError.__init__(self, "Store %s is not listable" % store)
266
class UnlistableBranch(BzrError):
267
def __init__(self, br):
268
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
271
from bzrlib.weave import WeaveError, WeaveParentMismatch
273
class TransportError(BzrError):
274
"""All errors thrown by Transport implementations should derive
277
def __init__(self, msg=None, orig_error=None):
278
if msg is None and orig_error is not None:
279
msg = str(orig_error)
280
BzrError.__init__(self, msg)
282
self.orig_error = orig_error
284
# A set of semi-meaningful errors which can be thrown
285
class TransportNotPossible(TransportError):
286
"""This is for transports where a specific function is explicitly not
287
possible. Such as pushing files to an HTTP server.
291
class NonRelativePath(TransportError):
292
"""An absolute path was supplied, that could not be decoded into
297
class NoSuchFile(TransportError, IOError):
298
"""A get() was issued for a file that doesn't exist."""
300
# XXX: Is multiple inheritance for exceptions really needed?
303
return 'no such file: ' + self.msg
305
def __init__(self, msg=None, orig_error=None):
307
TransportError.__init__(self, msg=msg, orig_error=orig_error)
308
IOError.__init__(self, errno.ENOENT, self.msg)
310
class FileExists(TransportError, OSError):
311
"""An operation was attempted, which would overwrite an entry,
312
but overwritting is not supported.
314
mkdir() can throw this, but put() just overwites existing files.
316
# XXX: Is multiple inheritance for exceptions really needed?
317
def __init__(self, msg=None, orig_error=None):
319
TransportError.__init__(self, msg=msg, orig_error=orig_error)
320
OSError.__init__(self, errno.EEXIST, self.msg)
322
class PermissionDenied(TransportError):
323
"""An operation cannot succeed because of a lack of permissions."""
326
class ConnectionReset(TransportError):
327
"""The connection has been closed."""
330
class ConflictsInTree(BzrError):
332
BzrError.__init__(self, "Working tree has conflicts.")
334
class SigningFailed(BzrError):
335
def __init__(self, command_line):
336
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
added
removed
bzrlib/errors.py
