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):
28
class BzrCheckError(BzrError):
32
class InvalidRevisionNumber(BzrError):
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__ + ': '
75
if len(self.args) == 1:
76
return str(self.args[0])
77
elif len(self.args) == 2:
78
# further explanation or suggestions
80
return n + '\n '.join([self.args[0]] + self.args[1])
82
return n + "%r" % self
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"""
33
120
def __init__(self, revno):
37
return 'invalid revision number: %r' % self.args[0]
40
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)
44
141
class BzrCommandError(BzrError):
45
142
# 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."""
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 UnsupportedFormatError(BzrError):
164
"""Specified path is a bzr branch that we cannot read."""
166
return 'unsupported branch format: %s' % self.args[0]
169
class NotVersionedError(BzrNewError):
170
"""%(path)s is not versioned"""
171
def __init__(self, path):
172
BzrNewError.__init__(self)
58
176
class BadFileKindError(BzrError):
59
177
"""Specified file is of a kind that cannot be added.
61
179
(For example a symlink or device file.)"""
65
182
class ForbiddenFileError(BzrError):
66
183
"""Cannot operate on a file because it is a control file."""
70
186
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."""
188
# All exceptions from the lock/unlock functions should be from
189
# this exception class. They will be translated as necessary. The
190
# original exception is available as e.original_error
193
class CommitNotPossible(LockError):
194
"""A commit was attempted but we do not have a write lock open."""
197
class AlreadyCommitted(LockError):
198
"""A rollback was requested, but is not able to be accomplished."""
201
class ReadOnlyError(LockError):
202
"""A write attempt was made in a read only transaction."""
205
class PointlessCommit(BzrNewError):
206
"""No changes to commit"""
208
class StrictCommitFailed(Exception):
209
"""Commit refused because there are unknowns in the tree."""
211
class CannotBind(BzrNewError):
212
"""Cannot bind: %(msg)s"""
213
def __init__(self, msg):
214
BzrNewError.__init__(self)
217
class CannotInstallRevisions(BzrNewError):
218
"""Cannot install revisions: %(msg)s"""
219
def __init__(self, msg):
220
BzrNewError.__init__(self)
87
223
class NoSuchRevision(BzrError):
88
224
def __init__(self, branch, revision):
92
228
BzrError.__init__(self, msg)
231
class HistoryMissing(BzrError):
232
def __init__(self, branch, object_type, object_id):
234
BzrError.__init__(self,
235
'%s is missing %s {%s}'
236
% (branch, object_type, object_id))
239
class DivergedBranches(BzrError):
240
def __init__(self, branch1, branch2):
241
BzrError.__init__(self, "These branches have diverged.")
242
self.branch1 = branch1
243
self.branch2 = branch2
95
246
class UnrelatedBranches(BzrCommandError):
96
247
def __init__(self):
97
248
msg = "Branches have no common ancestor, and no base revision"\
99
250
BzrCommandError.__init__(self, msg)
252
class NoCommonAncestor(BzrError):
253
def __init__(self, revision_a, revision_b):
254
msg = "Revisions have no common ancestor: %s %s." \
255
% (revision_a, revision_b)
256
BzrError.__init__(self, msg)
258
class NoCommonRoot(BzrError):
259
def __init__(self, revision_a, revision_b):
260
msg = "Revisions are not derived from the same root: %s %s." \
261
% (revision_a, revision_b)
262
BzrError.__init__(self, msg)
264
class NotAncestor(BzrError):
265
def __init__(self, rev_id, not_ancestor_id):
266
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
268
BzrError.__init__(self, msg)
270
self.not_ancestor_id = not_ancestor_id
102
273
class NotAncestor(BzrError):
103
274
def __init__(self, rev_id, not_ancestor_id):
122
293
BzrError.__init__(self, msg)
123
294
self.bases = bases
296
class NoCommits(BzrError):
297
def __init__(self, branch):
298
msg = "Branch %s has no commits." % branch
299
BzrError.__init__(self, msg)
301
class UnlistableStore(BzrError):
302
def __init__(self, store):
303
BzrError.__init__(self, "Store %s is not listable" % store)
305
class UnlistableBranch(BzrError):
306
def __init__(self, br):
307
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
310
class WeaveError(BzrNewError):
311
"""Error in processing weave: %(message)s"""
312
def __init__(self, message=None):
313
BzrNewError.__init__(self)
314
self.message = message
317
class WeaveRevisionAlreadyPresent(WeaveError):
318
"""Revision {%(revision_id)s} already present in %(weave)s"""
319
def __init__(self, revision_id, weave):
320
WeaveError.__init__(self)
321
self.revision_id = revision_id
325
class WeaveRevisionNotPresent(WeaveError):
326
"""Revision {%(revision_id)s} not present in %(weave)s"""
327
def __init__(self, revision_id, weave):
328
WeaveError.__init__(self)
329
self.revision_id = revision_id
333
class WeaveFormatError(WeaveError):
334
"""Weave invariant violated: %(what)s"""
335
def __init__(self, what):
336
WeaveError.__init__(self)
340
class WeaveParentMismatch(WeaveError):
341
"""Parents are mismatched between two revisions."""
344
class NoSuchExportFormat(BzrNewError):
345
"""Export format %(format)r not supported"""
346
def __init__(self, format):
347
BzrNewError.__init__(self)
351
class TransportError(BzrError):
352
"""All errors thrown by Transport implementations should derive
355
def __init__(self, msg=None, orig_error=None):
356
if msg is None and orig_error is not None:
357
msg = str(orig_error)
358
BzrError.__init__(self, msg)
360
self.orig_error = orig_error
362
# A set of semi-meaningful errors which can be thrown
363
class TransportNotPossible(TransportError):
364
"""This is for transports where a specific function is explicitly not
365
possible. Such as pushing files to an HTTP server.
369
class NonRelativePath(TransportError):
370
"""An absolute path was supplied, that could not be decoded into
375
class NoSuchFile(TransportError, IOError):
376
"""A get() was issued for a file that doesn't exist."""
378
# XXX: Is multiple inheritance for exceptions really needed?
381
return 'no such file: ' + self.msg
383
def __init__(self, msg=None, orig_error=None):
385
TransportError.__init__(self, msg=msg, orig_error=orig_error)
386
IOError.__init__(self, errno.ENOENT, self.msg)
388
class ConnectionError(TransportError, IOError):
390
A connection problem prevents file retrieval.
391
This does not indicate whether the file exists or not; it indicates that a
392
precondition for requesting the file was not met.
395
# XXX: Is multiple inheritance for exceptions really needed?
398
return 'connection error: ' + self.msg
400
def __init__(self, msg=None, orig_error=None):
402
TransportError.__init__(self, msg=msg, orig_error=orig_error)
403
IOError.__init__(self, errno.ENOENT, self.msg)
406
class FileExists(TransportError, OSError):
407
"""An operation was attempted, which would overwrite an entry,
408
but overwritting is not supported.
410
mkdir() can throw this, but put() just overwites existing files.
412
# XXX: Is multiple inheritance for exceptions really needed?
413
def __init__(self, msg=None, orig_error=None):
415
TransportError.__init__(self, msg=msg, orig_error=orig_error)
416
OSError.__init__(self, errno.EEXIST, self.msg)
418
class PermissionDenied(TransportError):
419
"""An operation cannot succeed because of a lack of permissions."""
422
class ConnectionReset(TransportError):
423
"""The connection has been closed."""
426
class ConflictsInTree(BzrError):
428
BzrError.__init__(self, "Working tree has conflicts.")
430
class ParseConfigError(BzrError):
431
def __init__(self, errors, filename):
434
message = "Error(s) parsing config file %s:\n%s" % \
435
(filename, ('\n'.join(e.message for e in errors)))
436
BzrError.__init__(self, message)
438
class SigningFailed(BzrError):
439
def __init__(self, command_line):
440
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
443
class WorkingTreeNotRevision(BzrError):
444
def __init__(self, tree):
445
BzrError.__init__(self, "The working tree for %s has changed since"
446
" last commit, but weave merge requires that it be"
447
" unchanged." % tree.basedir)
449
class CantReprocessAndShowBase(BzrNewError):
450
"""Can't reprocess and show base.
451
Reprocessing obscures relationship of conflicting lines to base."""
453
class GraphCycleError(BzrNewError):
454
"""Cycle in graph %(graph)r"""
455
def __init__(self, graph):
456
BzrNewError.__init__(self)
459
class NotConflicted(BzrNewError):
460
"""File %(filename)s is not conflicted."""
461
def __init__(self, filename):
462
BzrNewError.__init__(self)
463
self.filename = filename
465
class MustUseDecorated(Exception):
466
"""A decorating function has requested its original command be used.
468
This should never escape bzr, so does not need to be printable.
added
removed
bzrlib/errors.py
