14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
19
__author__ = "Martin Pool <mbp@canonical.com>"
22
######################################################################
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
24
65
class BzrError(StandardError):
28
class BzrCheckError(BzrError):
32
class InvalidRevisionNumber(BzrError):
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"""
33
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 NoWorkingTree(BzrNewError):
131
"""No WorkingTree exists for %s(base)."""
133
def __init__(self, base):
134
BzrNewError.__init__(self)
37
return 'invalid revision number: %r' % self.args[0]
40
class InvalidRevisionId(BzrError):
44
138
class BzrCommandError(BzrError):
45
139
# Error from malformed user command
49
class NotBranchError(BzrError):
50
"""Specified path is not in a branch"""
54
class NotVersionedError(BzrError):
55
"""Specified object is not versioned."""
140
# This is being misused as a generic exception
141
# pleae subclass. RBC 20051030
146
class BzrOptionError(BzrCommandError):
147
"""Some missing or otherwise incorrect option was supplied."""
150
class StrictCommitFailed(Exception):
151
"""Commit refused because there are unknowns in the tree."""
153
class NotBranchError(BzrNewError):
154
"""Not a branch: %(path)s"""
155
def __init__(self, path):
156
BzrNewError.__init__(self)
160
class UnsupportedFormatError(BzrError):
161
"""Specified path is a bzr branch that we cannot read."""
163
return 'unsupported branch format: %s' % self.args[0]
166
class NotVersionedError(BzrNewError):
167
"""%(path)s is not versioned"""
168
def __init__(self, path):
169
BzrNewError.__init__(self)
58
173
class BadFileKindError(BzrError):
59
174
"""Specified file is of a kind that cannot be added.
61
176
(For example a symlink or device file.)"""
65
179
class ForbiddenFileError(BzrError):
66
180
"""Cannot operate on a file because it is a control file."""
70
183
class LockError(Exception):
71
"""All exceptions from the lock/unlock functions should be from
72
this exception class. They will be translated as necessary. The
73
original exception is available as e.original_error
75
def __init__(self, e=None):
76
self.original_error = e
78
Exception.__init__(self, e)
80
Exception.__init__(self)
83
class PointlessCommit(Exception):
84
"""Commit failed because nothing was changed."""
185
# All exceptions from the lock/unlock functions should be from
186
# this exception class. They will be translated as necessary. The
187
# original exception is available as e.original_error
190
class CommitNotPossible(LockError):
191
"""A commit was attempted but we do not have a write lock open."""
194
class AlreadyCommitted(LockError):
195
"""A rollback was requested, but is not able to be accomplished."""
198
class ReadOnlyError(LockError):
199
"""A write attempt was made in a read only transaction."""
202
class PointlessCommit(BzrNewError):
203
"""No changes to commit"""
205
class StrictCommitFailed(Exception):
206
"""Commit refused because there are unknowns in the tree."""
87
208
class NoSuchRevision(BzrError):
88
209
def __init__(self, branch, revision):
143
282
def __init__(self, branch):
144
283
msg = "Branch %s has no commits." % branch
145
284
BzrError.__init__(self, msg)
286
class UnlistableStore(BzrError):
287
def __init__(self, store):
288
BzrError.__init__(self, "Store %s is not listable" % store)
290
class UnlistableBranch(BzrError):
291
def __init__(self, br):
292
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
295
class WeaveError(BzrNewError):
296
"""Error in processing weave: %(message)s"""
297
def __init__(self, message=None):
298
BzrNewError.__init__(self)
299
self.message = message
302
class WeaveRevisionAlreadyPresent(WeaveError):
303
"""Revision {%(revision_id)s} already present in %(weave)s"""
304
def __init__(self, revision_id, weave):
305
WeaveError.__init__(self)
306
self.revision_id = revision_id
310
class WeaveRevisionNotPresent(WeaveError):
311
"""Revision {%(revision_id)s} not present in %(weave)s"""
312
def __init__(self, revision_id, weave):
313
WeaveError.__init__(self)
314
self.revision_id = revision_id
318
class WeaveFormatError(WeaveError):
319
"""Weave invariant violated: %(what)s"""
320
def __init__(self, what):
321
WeaveError.__init__(self)
325
class WeaveParentMismatch(WeaveError):
326
"""Parents are mismatched between two revisions."""
329
class TransportError(BzrError):
330
"""All errors thrown by Transport implementations should derive
333
def __init__(self, msg=None, orig_error=None):
334
if msg is None and orig_error is not None:
335
msg = str(orig_error)
336
BzrError.__init__(self, msg)
338
self.orig_error = orig_error
340
# A set of semi-meaningful errors which can be thrown
341
class TransportNotPossible(TransportError):
342
"""This is for transports where a specific function is explicitly not
343
possible. Such as pushing files to an HTTP server.
347
class NonRelativePath(TransportError):
348
"""An absolute path was supplied, that could not be decoded into
353
class NoSuchFile(TransportError, IOError):
354
"""A get() was issued for a file that doesn't exist."""
356
# XXX: Is multiple inheritance for exceptions really needed?
359
return 'no such file: ' + self.msg
361
def __init__(self, msg=None, orig_error=None):
363
TransportError.__init__(self, msg=msg, orig_error=orig_error)
364
IOError.__init__(self, errno.ENOENT, self.msg)
366
class FileExists(TransportError, OSError):
367
"""An operation was attempted, which would overwrite an entry,
368
but overwritting is not supported.
370
mkdir() can throw this, but put() just overwites existing files.
372
# XXX: Is multiple inheritance for exceptions really needed?
373
def __init__(self, msg=None, orig_error=None):
375
TransportError.__init__(self, msg=msg, orig_error=orig_error)
376
OSError.__init__(self, errno.EEXIST, self.msg)
378
class PermissionDenied(TransportError):
379
"""An operation cannot succeed because of a lack of permissions."""
382
class ConnectionReset(TransportError):
383
"""The connection has been closed."""
386
class ConflictsInTree(BzrError):
388
BzrError.__init__(self, "Working tree has conflicts.")
390
class ParseConfigError(BzrError):
391
def __init__(self, errors, filename):
394
message = "Error(s) parsing config file %s:\n%s" % \
395
(filename, ('\n'.join(e.message for e in errors)))
396
BzrError.__init__(self, message)
398
class SigningFailed(BzrError):
399
def __init__(self, command_line):
400
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
403
class WorkingTreeNotRevision(BzrError):
404
def __init__(self, tree):
405
BzrError.__init__(self, "The working tree for %s has changed since"
406
" last commit, but weave merge requires that it be"
407
" unchanged." % tree.basedir)
409
class CantReprocessAndShowBase(BzrNewError):
410
"""Can't reprocess and show base.
411
Reprocessing obscures relationship of conflicting lines to base."""
413
class GraphCycleError(BzrNewError):
414
"""Cycle in graph %(graph)r"""
415
def __init__(self, graph):
416
BzrNewError.__init__(self)
419
class MustUseDecorated(Exception):
420
"""A decorating function has requested its original command be used.
422
This should never escape bzr, so does not need to be printable.
added
removed
bzrlib/errors.py
