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"""
190
class StrictCommitFailed(Exception):
191
"""Commit refused because there are unknowns in the tree."""
193
class NoSuchRevision(BzrError):
194
def __init__(self, branch, revision):
196
self.revision = revision
197
msg = "Branch %s has no revision %s" % (branch, revision)
198
BzrError.__init__(self, msg)
201
class HistoryMissing(BzrError):
202
def __init__(self, branch, object_type, object_id):
204
BzrError.__init__(self,
205
'%s is missing %s {%s}'
206
% (branch, object_type, object_id))
209
class DivergedBranches(BzrError):
210
def __init__(self, branch1, branch2):
211
BzrError.__init__(self, "These branches have diverged.")
212
self.branch1 = branch1
213
self.branch2 = branch2
216
class UnrelatedBranches(BzrCommandError):
218
msg = "Branches have no common ancestor, and no base revision"\
220
BzrCommandError.__init__(self, msg)
222
class NoCommonAncestor(BzrError):
223
def __init__(self, revision_a, revision_b):
224
msg = "Revisions have no common ancestor: %s %s." \
225
% (revision_a, revision_b)
226
BzrError.__init__(self, msg)
228
class NoCommonRoot(BzrError):
229
def __init__(self, revision_a, revision_b):
230
msg = "Revisions are not derived from the same root: %s %s." \
231
% (revision_a, revision_b)
232
BzrError.__init__(self, msg)
234
class NotAncestor(BzrError):
235
def __init__(self, rev_id, not_ancestor_id):
236
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
238
BzrError.__init__(self, msg)
240
self.not_ancestor_id = not_ancestor_id
243
class NotAncestor(BzrError):
244
def __init__(self, rev_id, not_ancestor_id):
246
self.not_ancestor_id = not_ancestor_id
247
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
249
BzrError.__init__(self, msg)
252
class InstallFailed(BzrError):
253
def __init__(self, revisions):
254
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
255
BzrError.__init__(self, msg)
256
self.revisions = revisions
259
class AmbiguousBase(BzrError):
260
def __init__(self, bases):
261
msg = "The correct base is unclear, becase %s are all equally close" %\
263
BzrError.__init__(self, msg)
266
class NoCommits(BzrError):
267
def __init__(self, branch):
268
msg = "Branch %s has no commits." % branch
269
BzrError.__init__(self, msg)
271
class UnlistableStore(BzrError):
272
def __init__(self, store):
273
BzrError.__init__(self, "Store %s is not listable" % store)
275
class UnlistableBranch(BzrError):
276
def __init__(self, br):
277
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
280
class WeaveError(BzrNewError):
281
"""Error in processing weave: %(message)s"""
282
def __init__(self, message=None):
283
BzrNewError.__init__(self)
284
self.message = message
287
class WeaveRevisionAlreadyPresent(WeaveError):
288
"""Revision {%(revision_id)s} already present in %(weave)s"""
289
def __init__(self, revision_id, weave):
290
WeaveError.__init__(self)
291
self.revision_id = revision_id
295
class WeaveRevisionNotPresent(WeaveError):
296
"""Revision {%(revision_id)s} not present in %(weave)s"""
297
def __init__(self, revision_id, weave):
298
WeaveError.__init__(self)
299
self.revision_id = revision_id
303
class WeaveFormatError(WeaveError):
304
"""Weave invariant violated: %(what)s"""
305
def __init__(self, what):
306
WeaveError.__init__(self)
310
class WeaveParentMismatch(WeaveError):
311
"""Parents are mismatched between two revisions."""
314
class TransportError(BzrError):
315
"""All errors thrown by Transport implementations should derive
318
def __init__(self, msg=None, orig_error=None):
319
if msg is None and orig_error is not None:
320
msg = str(orig_error)
321
BzrError.__init__(self, msg)
323
self.orig_error = orig_error
325
# A set of semi-meaningful errors which can be thrown
326
class TransportNotPossible(TransportError):
327
"""This is for transports where a specific function is explicitly not
328
possible. Such as pushing files to an HTTP server.
332
class NonRelativePath(TransportError):
333
"""An absolute path was supplied, that could not be decoded into
338
class NoSuchFile(TransportError, IOError):
339
"""A get() was issued for a file that doesn't exist."""
341
# XXX: Is multiple inheritance for exceptions really needed?
344
return 'no such file: ' + self.msg
346
def __init__(self, msg=None, orig_error=None):
348
TransportError.__init__(self, msg=msg, orig_error=orig_error)
349
IOError.__init__(self, errno.ENOENT, self.msg)
351
class FileExists(TransportError, OSError):
352
"""An operation was attempted, which would overwrite an entry,
353
but overwritting is not supported.
355
mkdir() can throw this, but put() just overwites existing files.
357
# XXX: Is multiple inheritance for exceptions really needed?
358
def __init__(self, msg=None, orig_error=None):
360
TransportError.__init__(self, msg=msg, orig_error=orig_error)
361
OSError.__init__(self, errno.EEXIST, self.msg)
363
class PermissionDenied(TransportError):
364
"""An operation cannot succeed because of a lack of permissions."""
367
class ConnectionReset(TransportError):
368
"""The connection has been closed."""
371
class ConflictsInTree(BzrError):
373
BzrError.__init__(self, "Working tree has conflicts.")
375
class ParseConfigError(BzrError):
376
def __init__(self, errors, filename):
379
message = "Error(s) parsing config file %s:\n%s" % \
380
(filename, ('\n'.join(e.message for e in errors)))
381
BzrError.__init__(self, message)
383
class SigningFailed(BzrError):
384
def __init__(self, command_line):
385
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
388
class WorkingTreeNotRevision(BzrError):
389
def __init__(self, tree):
390
BzrError.__init__(self, "The working tree for %s has changed since"
391
" last commit, but weave merge requires that it be"
392
" unchanged." % tree.basedir)
394
class GraphCycleError(BzrNewError):
395
"""Cycle in graph %(graph)r"""
396
def __init__(self, graph):
397
BzrNewError.__init__(self)
added
removed
bzrlib/errors.py
