15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
20
__author__ = "Martin Pool <mbp@canonical.com>"
23
######################################################################
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
50
Exception strings should start with a capital letter and not have a final
54
# based on Scott James Remnant's hct error classes
56
# TODO: is there any value in providing the .args field used by standard
57
# python exceptions? A list of values with no names seems less useful
60
# TODO: Perhaps convert the exception to a string at the moment it's
61
# constructed to make sure it will succeed. But that says nothing about
62
# exceptions that are never raised.
64
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
25
68
class BzrError(StandardError):
70
# XXX: Should we show the exception class in
71
# exceptions that don't provide their own message?
72
# maybe it should be done at a higher level
73
## n = self.__class__.__name__ + ': '
27
75
if len(self.args) == 1:
76
return str(self.args[0])
29
77
elif len(self.args) == 2:
30
78
# further explanation or suggestions
31
return '\n '.join([self.args[0]] + self.args[1])
80
return n + '\n '.join([self.args[0]] + self.args[1])
82
return n + "%r" % self
36
class BzrCheckError(BzrError):
40
class InvalidRevisionNumber(BzrError):
84
return n + `self.args`
87
class BzrNewError(BzrError):
89
# base classes should override the docstring with their human-
90
# readable explanation
92
def __init__(self, **kwds):
93
for key, value in kwds.items():
94
setattr(self, key, value)
98
return self.__doc__ % self.__dict__
99
except (NameError, ValueError, KeyError), e:
100
return 'Unprintable exception %s: %s' \
101
% (self.__class__.__name__, str(e))
104
class BzrCheckError(BzrNewError):
105
"""Internal check failed: %(message)s"""
106
def __init__(self, message):
107
BzrNewError.__init__(self)
108
self.message = message
111
class InvalidEntryName(BzrNewError):
112
"""Invalid entry name: %(name)s"""
113
def __init__(self, name):
114
BzrNewError.__init__(self)
118
class InvalidRevisionNumber(BzrNewError):
119
"""Invalid revision number %(revno)d"""
41
120
def __init__(self, revno):
45
return 'invalid revision number: %r' % self.args[0]
48
class InvalidRevisionId(BzrError):
121
BzrNewError.__init__(self)
125
class InvalidRevisionId(BzrNewError):
126
"""Invalid revision-id {%(revision_id)s} in %(branch)s"""
127
def __init__(self, revision_id, branch):
128
BzrNewError.__init__(self)
129
self.revision_id = revision_id
133
class NoWorkingTree(BzrNewError):
134
"""No WorkingTree exists for %s(base)."""
136
def __init__(self, base):
137
BzrNewError.__init__(self)
52
141
class BzrCommandError(BzrError):
53
142
# Error from malformed user command
57
class NotBranchError(BzrError):
58
"""Specified path is not in a branch"""
62
class NotVersionedError(BzrError):
63
"""Specified object is not versioned."""
143
# This is being misused as a generic exception
144
# pleae subclass. RBC 20051030
149
class BzrOptionError(BzrCommandError):
150
"""Some missing or otherwise incorrect option was supplied."""
153
class StrictCommitFailed(Exception):
154
"""Commit refused because there are unknowns in the tree."""
156
class NotBranchError(BzrNewError):
157
"""Not a branch: %(path)s"""
158
def __init__(self, path):
159
BzrNewError.__init__(self)
163
class FileInWrongBranch(BzrNewError):
164
"""File %(path)s in not in branch %(branch_base)s."""
165
def __init__(self, branch, path):
166
BzrNewError.__init__(self)
168
self.branch_base = branch.base
172
class UnsupportedFormatError(BzrError):
173
"""Specified path is a bzr branch that we cannot read."""
175
return 'unsupported branch format: %s' % self.args[0]
178
class NotVersionedError(BzrNewError):
179
"""%(path)s is not versioned"""
180
def __init__(self, path):
181
BzrNewError.__init__(self)
66
185
class BadFileKindError(BzrError):
67
186
"""Specified file is of a kind that cannot be added.
69
188
(For example a symlink or device file.)"""
73
191
class ForbiddenFileError(BzrError):
74
192
"""Cannot operate on a file because it is a control file."""
78
195
class LockError(Exception):
79
"""All exceptions from the lock/unlock functions should be from
80
this exception class. They will be translated as necessary. The
81
original exception is available as e.original_error
83
def __init__(self, e=None):
84
self.original_error = e
86
Exception.__init__(self, e)
88
Exception.__init__(self)
91
class PointlessCommit(Exception):
92
"""Commit failed because nothing was changed."""
197
# All exceptions from the lock/unlock functions should be from
198
# this exception class. They will be translated as necessary. The
199
# original exception is available as e.original_error
202
class CommitNotPossible(LockError):
203
"""A commit was attempted but we do not have a write lock open."""
206
class AlreadyCommitted(LockError):
207
"""A rollback was requested, but is not able to be accomplished."""
210
class ReadOnlyError(LockError):
211
"""A write attempt was made in a read only transaction."""
214
class PointlessCommit(BzrNewError):
215
"""No changes to commit"""
217
class StrictCommitFailed(Exception):
218
"""Commit refused because there are unknowns in the tree."""
95
220
class NoSuchRevision(BzrError):
96
221
def __init__(self, branch, revision):
108
233
% (branch, object_type, object_id))
236
class DivergedBranches(BzrError):
237
def __init__(self, branch1, branch2):
238
BzrError.__init__(self, "These branches have diverged.")
239
self.branch1 = branch1
240
self.branch2 = branch2
111
243
class UnrelatedBranches(BzrCommandError):
112
244
def __init__(self):
113
245
msg = "Branches have no common ancestor, and no base revision"\
115
247
BzrCommandError.__init__(self, msg)
249
class NoCommonAncestor(BzrError):
250
def __init__(self, revision_a, revision_b):
251
msg = "Revisions have no common ancestor: %s %s." \
252
% (revision_a, revision_b)
253
BzrError.__init__(self, msg)
255
class NoCommonRoot(BzrError):
256
def __init__(self, revision_a, revision_b):
257
msg = "Revisions are not derived from the same root: %s %s." \
258
% (revision_a, revision_b)
259
BzrError.__init__(self, msg)
261
class NotAncestor(BzrError):
262
def __init__(self, rev_id, not_ancestor_id):
263
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
265
BzrError.__init__(self, msg)
267
self.not_ancestor_id = not_ancestor_id
118
270
class NotAncestor(BzrError):
119
271
def __init__(self, rev_id, not_ancestor_id):
138
290
BzrError.__init__(self, msg)
139
291
self.bases = bases
293
class NoCommits(BzrError):
294
def __init__(self, branch):
295
msg = "Branch %s has no commits." % branch
296
BzrError.__init__(self, msg)
298
class UnlistableStore(BzrError):
299
def __init__(self, store):
300
BzrError.__init__(self, "Store %s is not listable" % store)
302
class UnlistableBranch(BzrError):
303
def __init__(self, br):
304
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
307
class WeaveError(BzrNewError):
308
"""Error in processing weave: %(message)s"""
309
def __init__(self, message=None):
310
BzrNewError.__init__(self)
311
self.message = message
314
class WeaveRevisionAlreadyPresent(WeaveError):
315
"""Revision {%(revision_id)s} already present in %(weave)s"""
316
def __init__(self, revision_id, weave):
317
WeaveError.__init__(self)
318
self.revision_id = revision_id
322
class WeaveRevisionNotPresent(WeaveError):
323
"""Revision {%(revision_id)s} not present in %(weave)s"""
324
def __init__(self, revision_id, weave):
325
WeaveError.__init__(self)
326
self.revision_id = revision_id
330
class WeaveFormatError(WeaveError):
331
"""Weave invariant violated: %(what)s"""
332
def __init__(self, what):
333
WeaveError.__init__(self)
337
class WeaveParentMismatch(WeaveError):
338
"""Parents are mismatched between two revisions."""
341
class TransportError(BzrError):
342
"""All errors thrown by Transport implementations should derive
345
def __init__(self, msg=None, orig_error=None):
346
if msg is None and orig_error is not None:
347
msg = str(orig_error)
348
BzrError.__init__(self, msg)
350
self.orig_error = orig_error
352
# A set of semi-meaningful errors which can be thrown
353
class TransportNotPossible(TransportError):
354
"""This is for transports where a specific function is explicitly not
355
possible. Such as pushing files to an HTTP server.
359
class NonRelativePath(TransportError):
360
"""An absolute path was supplied, that could not be decoded into
365
class NoSuchFile(TransportError, IOError):
366
"""A get() was issued for a file that doesn't exist."""
368
# XXX: Is multiple inheritance for exceptions really needed?
371
return 'no such file: ' + self.msg
373
def __init__(self, msg=None, orig_error=None):
375
TransportError.__init__(self, msg=msg, orig_error=orig_error)
376
IOError.__init__(self, errno.ENOENT, self.msg)
378
class ConnectionError(TransportError, IOError):
380
A connection problem prevents file retrieval.
381
This does not indicate whether the file exists or not; it indicates that a
382
precondition for requesting the file was not met.
385
# XXX: Is multiple inheritance for exceptions really needed?
388
return 'connection error: ' + self.msg
390
def __init__(self, msg=None, orig_error=None):
392
TransportError.__init__(self, msg=msg, orig_error=orig_error)
393
IOError.__init__(self, errno.ENOENT, self.msg)
396
class FileExists(TransportError, OSError):
397
"""An operation was attempted, which would overwrite an entry,
398
but overwritting is not supported.
400
mkdir() can throw this, but put() just overwites existing files.
402
# XXX: Is multiple inheritance for exceptions really needed?
403
def __init__(self, msg=None, orig_error=None):
405
TransportError.__init__(self, msg=msg, orig_error=orig_error)
406
OSError.__init__(self, errno.EEXIST, self.msg)
408
class PermissionDenied(TransportError):
409
"""An operation cannot succeed because of a lack of permissions."""
412
class ConnectionReset(TransportError):
413
"""The connection has been closed."""
416
class ConflictsInTree(BzrError):
418
BzrError.__init__(self, "Working tree has conflicts.")
420
class ParseConfigError(BzrError):
421
def __init__(self, errors, filename):
424
message = "Error(s) parsing config file %s:\n%s" % \
425
(filename, ('\n'.join(e.message for e in errors)))
426
BzrError.__init__(self, message)
428
class SigningFailed(BzrError):
429
def __init__(self, command_line):
430
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
433
class WorkingTreeNotRevision(BzrError):
434
def __init__(self, tree):
435
BzrError.__init__(self, "The working tree for %s has changed since"
436
" last commit, but weave merge requires that it be"
437
" unchanged." % tree.basedir)
439
class CantReprocessAndShowBase(BzrNewError):
440
"""Can't reprocess and show base.
441
Reprocessing obscures relationship of conflicting lines to base."""
443
class GraphCycleError(BzrNewError):
444
"""Cycle in graph %(graph)r"""
445
def __init__(self, graph):
446
BzrNewError.__init__(self)
449
class NotConflicted(BzrNewError):
450
"""File %(filename)s is not conflicted."""
451
def __init__(self, filename):
452
BzrNewError.__init__(self)
453
self.filename = filename
455
class MustUseDecorated(Exception):
456
"""A decorating function has requested its original command be used.
458
This should never escape bzr, so does not need to be printable.
added
removed
bzrlib/errors.py
