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 %(revision_id)r"""
121
def __init__(self, revision_id):
122
self.revision_id = revision_id
124
class BzrCommandError(BzrError):
125
# Error from malformed user command
129
class StrictCommitFailed(Exception):
130
"""Commit refused because there are unknowns in the tree."""
132
class NotBranchError(BzrNewError):
133
"""Not a branch: %(path)s"""
134
def __init__(self, path):
135
BzrNewError.__init__(self)
139
class UnsupportedFormatError(BzrError):
140
"""Specified path is a bzr branch that we cannot read."""
142
return 'unsupported branch format: %s' % self.args[0]
145
class NotVersionedError(BzrNewError):
146
"""%(path)s is not versioned"""
147
def __init__(self, path):
148
BzrNewError.__init__(self)
152
class BadFileKindError(BzrError):
153
"""Specified file is of a kind that cannot be added.
155
(For example a symlink or device file.)"""
158
class ForbiddenFileError(BzrError):
159
"""Cannot operate on a file because it is a control file."""
162
class LockError(Exception):
164
# All exceptions from the lock/unlock functions should be from
165
# this exception class. They will be translated as necessary. The
166
# original exception is available as e.original_error
169
class CommitNotPossible(LockError):
170
"""A commit was attempted but we do not have a write lock open."""
173
class AlreadyCommitted(LockError):
174
"""A rollback was requested, but is not able to be accomplished."""
177
class ReadOnlyError(LockError):
178
"""A write attempt was made in a read only transaction."""
181
class PointlessCommit(BzrNewError):
182
"""No changes to commit"""
185
class NoSuchRevision(BzrError):
186
def __init__(self, branch, revision):
188
self.revision = revision
189
msg = "Branch %s has no revision %s" % (branch, revision)
190
BzrError.__init__(self, msg)
193
class HistoryMissing(BzrError):
194
def __init__(self, branch, object_type, object_id):
196
BzrError.__init__(self,
197
'%s is missing %s {%s}'
198
% (branch, object_type, object_id))
201
class DivergedBranches(BzrError):
202
def __init__(self, branch1, branch2):
203
BzrError.__init__(self, "These branches have diverged.")
204
self.branch1 = branch1
205
self.branch2 = branch2
208
class UnrelatedBranches(BzrCommandError):
210
msg = "Branches have no common ancestor, and no base revision"\
212
BzrCommandError.__init__(self, msg)
214
class NoCommonAncestor(BzrError):
215
def __init__(self, revision_a, revision_b):
216
msg = "Revisions have no common ancestor: %s %s." \
217
% (revision_a, revision_b)
218
BzrError.__init__(self, msg)
220
class NoCommonRoot(BzrError):
221
def __init__(self, revision_a, revision_b):
222
msg = "Revisions are not derived from the same root: %s %s." \
223
% (revision_a, revision_b)
224
BzrError.__init__(self, msg)
226
class NotAncestor(BzrError):
227
def __init__(self, rev_id, not_ancestor_id):
228
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
230
BzrError.__init__(self, msg)
232
self.not_ancestor_id = not_ancestor_id
235
class NotAncestor(BzrError):
236
def __init__(self, rev_id, not_ancestor_id):
238
self.not_ancestor_id = not_ancestor_id
239
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
241
BzrError.__init__(self, msg)
244
class InstallFailed(BzrError):
245
def __init__(self, revisions):
246
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
247
BzrError.__init__(self, msg)
248
self.revisions = revisions
251
class AmbiguousBase(BzrError):
252
def __init__(self, bases):
253
msg = "The correct base is unclear, becase %s are all equally close" %\
255
BzrError.__init__(self, msg)
258
class NoCommits(BzrError):
259
def __init__(self, branch):
260
msg = "Branch %s has no commits." % branch
261
BzrError.__init__(self, msg)
263
class UnlistableStore(BzrError):
264
def __init__(self, store):
265
BzrError.__init__(self, "Store %s is not listable" % store)
267
class UnlistableBranch(BzrError):
268
def __init__(self, br):
269
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
272
from bzrlib.weave import WeaveError, WeaveParentMismatch
274
class TransportError(BzrError):
275
"""All errors thrown by Transport implementations should derive
278
def __init__(self, msg=None, orig_error=None):
279
if msg is None and orig_error is not None:
280
msg = str(orig_error)
281
BzrError.__init__(self, msg)
283
self.orig_error = orig_error
285
# A set of semi-meaningful errors which can be thrown
286
class TransportNotPossible(TransportError):
287
"""This is for transports where a specific function is explicitly not
288
possible. Such as pushing files to an HTTP server.
292
class NonRelativePath(TransportError):
293
"""An absolute path was supplied, that could not be decoded into
298
class NoSuchFile(TransportError, IOError):
299
"""A get() was issued for a file that doesn't exist."""
301
# XXX: Is multiple inheritance for exceptions really needed?
304
return 'no such file: ' + self.msg
306
def __init__(self, msg=None, orig_error=None):
308
TransportError.__init__(self, msg=msg, orig_error=orig_error)
309
IOError.__init__(self, errno.ENOENT, self.msg)
311
class FileExists(TransportError, OSError):
312
"""An operation was attempted, which would overwrite an entry,
313
but overwritting is not supported.
315
mkdir() can throw this, but put() just overwites existing files.
317
# XXX: Is multiple inheritance for exceptions really needed?
318
def __init__(self, msg=None, orig_error=None):
320
TransportError.__init__(self, msg=msg, orig_error=orig_error)
321
OSError.__init__(self, errno.EEXIST, self.msg)
323
class PermissionDenied(TransportError):
324
"""An operation cannot succeed because of a lack of permissions."""
327
class ConnectionReset(TransportError):
328
"""The connection has been closed."""
331
class ConflictsInTree(BzrError):
333
BzrError.__init__(self, "Working tree has conflicts.")
335
class ParseConfigError(BzrError):
336
def __init__(self, errors, filename):
339
message = "Error(s) parsing config file %s:\n%s" % \
340
(filename, ('\n'.join(e.message for e in errors)))
341
BzrError.__init__(self, message)
343
class SigningFailed(BzrError):
344
def __init__(self, command_line):
345
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
348
class WorkingTreeNotRevision(BzrError):
349
def __init__(self, tree):
350
BzrError.__init__(self, "The working tree for %s has changed since"
351
" last commit, but weave merge requires that it be"
352
" unchanged." % tree.basedir)
354
class CantReprocessAndShowBase(BzrNewError):
355
"""Can't reprocess and show base.
356
Reprocessing obscures relationship of conflicting lines to base."""
added
removed
bzrlib/errors.py
