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
... path = getattr(sys.exc_value, 'path')
38
... if path is not None:
40
bzrlib.errors.NotBranchError
41
Not a branch: /foo/bar
46
* create a new exception class for any class of error that can be
47
usefully distinguished.
49
* the printable form of an exception is generated by the base class
52
Exception strings should start with a capital letter and not have a final
56
# based on Scott James Remnant's hct error classes
58
# TODO: is there any value in providing the .args field used by standard
59
# python exceptions? A list of values with no names seems less useful
62
# TODO: Perhaps convert the exception to a string at the moment it's
63
# constructed to make sure it will succeed. But that says nothing about
64
# exceptions that are never raised.
66
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
24
70
class BzrError(StandardError):
26
72
# XXX: Should we show the exception class in
40
86
return n + `self.args`
43
class BzrCheckError(BzrError):
47
class InvalidRevisionNumber(BzrError):
89
class BzrNewError(BzrError):
91
# base classes should override the docstring with their human-
92
# readable explanation
94
def __init__(self, **kwds):
95
for key, value in kwds.items():
96
setattr(self, key, value)
49
return 'invalid revision number: %r' % self.args[0]
52
class InvalidRevisionId(BzrError):
100
return self.__doc__ % self.__dict__
101
except (NameError, ValueError, KeyError), e:
102
return 'Unprintable exception %s: %s' \
103
% (self.__class__.__name__, str(e))
106
class BzrCheckError(BzrNewError):
107
"""Internal check failed: %(message)s"""
108
def __init__(self, message):
109
BzrNewError.__init__(self)
110
self.message = message
113
class InvalidEntryName(BzrNewError):
114
"""Invalid entry name: %(name)s"""
115
def __init__(self, name):
116
BzrNewError.__init__(self)
120
class InvalidRevisionNumber(BzrNewError):
121
"""Invalid revision number %(revno)d"""
122
def __init__(self, revno):
123
BzrNewError.__init__(self)
127
class InvalidRevisionId(BzrNewError):
128
"""Invalid revision-id {%(revision_id)s} in %(branch)s"""
129
def __init__(self, revision_id, branch):
130
BzrNewError.__init__(self)
131
self.revision_id = revision_id
135
class NoWorkingTree(BzrNewError):
136
"""No WorkingTree exists for %s(base)."""
138
def __init__(self, base):
139
BzrNewError.__init__(self)
56
143
class BzrCommandError(BzrError):
57
144
# Error from malformed user command
145
# This is being misused as a generic exception
146
# pleae subclass. RBC 20051030
148
# I think it's a waste of effort to differentiate between errors that
149
# are not intended to be caught anyway. UI code need not subclass
150
# BzrCommandError, and non-UI code should not throw a subclass of
151
# BzrCommandError. ADHB 20051211
58
152
def __str__(self):
59
153
return self.args[0]
62
class NotBranchError(BzrError):
63
"""Specified path is not in a branch"""
156
class BzrOptionError(BzrCommandError):
157
"""Some missing or otherwise incorrect option was supplied."""
160
class StrictCommitFailed(Exception):
161
"""Commit refused because there are unknowns in the tree."""
164
class PathError(BzrNewError):
165
"""Generic path error: %(path)r%(extra)s)"""
166
def __init__(self, path, extra=None):
167
BzrNewError.__init__(self)
170
self.extra = ': ' + str(extra)
175
class NoSuchFile(PathError):
176
"""No such file: %(path)r%(extra)s"""
179
class FileExists(PathError):
180
"""File exists: %(path)r%(extra)s"""
183
class PermissionDenied(PathError):
184
"""Permission denied: %(path)r%(extra)s"""
187
class PathNotChild(BzrNewError):
188
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
189
def __init__(self, path, base, extra=None):
190
BzrNewError.__init__(self)
194
self.extra = ': ' + str(extra)
199
class NotBranchError(BzrNewError):
200
"""Not a branch: %(path)s"""
201
def __init__(self, path):
202
BzrNewError.__init__(self)
206
class FileInWrongBranch(BzrNewError):
207
"""File %(path)s in not in branch %(branch_base)s."""
208
def __init__(self, branch, path):
209
BzrNewError.__init__(self)
211
self.branch_base = branch.base
215
class UnsupportedFormatError(BzrError):
216
"""Specified path is a bzr branch that we cannot read."""
64
217
def __str__(self):
65
return 'not a branch: %s' % self.args[0]
68
class NotVersionedError(BzrError):
69
"""Specified object is not versioned."""
218
return 'unsupported branch format: %s' % self.args[0]
221
class NotVersionedError(BzrNewError):
222
"""%(path)s is not versioned"""
223
def __init__(self, path):
224
BzrNewError.__init__(self)
72
228
class BadFileKindError(BzrError):
73
229
"""Specified file is of a kind that cannot be added.
75
231
(For example a symlink or device file.)"""
79
234
class ForbiddenFileError(BzrError):
80
235
"""Cannot operate on a file because it is a control file."""
84
238
class LockError(Exception):
85
"""All exceptions from the lock/unlock functions should be from
86
this exception class. They will be translated as necessary. The
87
original exception is available as e.original_error
89
def __init__(self, e=None):
90
self.original_error = e
92
Exception.__init__(self, e)
94
Exception.__init__(self)
97
class PointlessCommit(Exception):
98
"""Commit failed because nothing was changed."""
240
# All exceptions from the lock/unlock functions should be from
241
# this exception class. They will be translated as necessary. The
242
# original exception is available as e.original_error
245
class CommitNotPossible(LockError):
246
"""A commit was attempted but we do not have a write lock open."""
249
class AlreadyCommitted(LockError):
250
"""A rollback was requested, but is not able to be accomplished."""
253
class ReadOnlyError(LockError):
254
"""A write attempt was made in a read only transaction."""
257
class PointlessCommit(BzrNewError):
258
"""No changes to commit"""
261
class StrictCommitFailed(Exception):
262
"""Commit refused because there are unknowns in the tree."""
101
265
class NoSuchRevision(BzrError):
128
292
BzrCommandError.__init__(self, msg)
130
295
class NoCommonAncestor(BzrError):
131
296
def __init__(self, revision_a, revision_b):
132
297
msg = "Revisions have no common ancestor: %s %s." \
133
298
% (revision_a, revision_b)
134
299
BzrError.__init__(self, msg)
136
302
class NoCommonRoot(BzrError):
137
303
def __init__(self, revision_a, revision_b):
138
304
msg = "Revisions are not derived from the same root: %s %s." \
139
305
% (revision_a, revision_b)
140
306
BzrError.__init__(self, msg)
142
class NotAncestor(BzrError):
143
def __init__(self, rev_id, not_ancestor_id):
144
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
146
BzrError.__init__(self, msg)
148
self.not_ancestor_id = not_ancestor_id
151
class NotAncestor(BzrError):
152
def __init__(self, rev_id, not_ancestor_id):
154
self.not_ancestor_id = not_ancestor_id
155
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
157
BzrError.__init__(self, msg)
309
class NotAncestor(BzrError):
310
def __init__(self, rev_id, not_ancestor_id):
311
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
313
BzrError.__init__(self, msg)
315
self.not_ancestor_id = not_ancestor_id
160
318
class InstallFailed(BzrError):
171
329
BzrError.__init__(self, msg)
172
330
self.bases = bases
174
333
class NoCommits(BzrError):
175
334
def __init__(self, branch):
176
335
msg = "Branch %s has no commits." % branch
177
336
BzrError.__init__(self, msg)
179
339
class UnlistableStore(BzrError):
180
340
def __init__(self, store):
181
341
BzrError.__init__(self, "Store %s is not listable" % store)
183
344
class UnlistableBranch(BzrError):
184
345
def __init__(self, br):
185
346
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
188
from bzrlib.weave import WeaveError
349
class BoundBranchOutOfDate(BzrNewError):
350
"""Bound branch %(branch)s is out of date with master branch %(master)s."""
351
def __init__(self, branch, master):
352
BzrNewError.__init__(self)
357
class CommitToDoubleBoundBranch(BzrNewError):
358
"""Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
359
def __init__(self, branch, master, remote):
360
BzrNewError.__init__(self)
366
class OverwriteBoundBranch(BzrNewError):
367
"""Cannot pull --overwrite to a branch which is bound %(branch)s"""
368
def __init__(self, branch):
369
BzrNewError.__init__(self)
373
class BoundBranchConnectionFailure(BzrNewError):
374
"""Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
375
def __init__(self, branch, target, error):
376
BzrNewError.__init__(self)
382
class WeaveError(BzrNewError):
383
"""Error in processing weave: %(message)s"""
384
def __init__(self, message=None):
385
BzrNewError.__init__(self)
386
self.message = message
389
class WeaveRevisionAlreadyPresent(WeaveError):
390
"""Revision {%(revision_id)s} already present in %(weave)s"""
391
def __init__(self, revision_id, weave):
392
WeaveError.__init__(self)
393
self.revision_id = revision_id
397
class WeaveRevisionNotPresent(WeaveError):
398
"""Revision {%(revision_id)s} not present in %(weave)s"""
399
def __init__(self, revision_id, weave):
400
WeaveError.__init__(self)
401
self.revision_id = revision_id
405
class WeaveFormatError(WeaveError):
406
"""Weave invariant violated: %(what)s"""
407
def __init__(self, what):
408
WeaveError.__init__(self)
412
class WeaveParentMismatch(WeaveError):
413
"""Parents are mismatched between two revisions."""
416
class WeaveInvalidChecksum(WeaveError):
417
"""Text did not match it's checksum: %(message)s"""
420
class NoSuchExportFormat(BzrNewError):
421
"""Export format %(format)r not supported"""
422
def __init__(self, format):
423
BzrNewError.__init__(self)
190
427
class TransportError(BzrError):
191
428
"""All errors thrown by Transport implementations should derive
208
class NonRelativePath(TransportError):
209
"""An absolute path was supplied, that could not be decoded into
214
class NoSuchFile(TransportError, IOError):
215
"""A get() was issued for a file that doesn't exist."""
217
# XXX: Is multiple inheritance for exceptions really needed?
220
return 'no such file: ' + self.msg
222
def __init__(self, msg=None, orig_error=None):
224
TransportError.__init__(self, msg=msg, orig_error=orig_error)
225
IOError.__init__(self, errno.ENOENT, self.msg)
227
class FileExists(TransportError, OSError):
228
"""An operation was attempted, which would overwrite an entry,
229
but overwritting is not supported.
231
mkdir() can throw this, but put() just overwites existing files.
233
# XXX: Is multiple inheritance for exceptions really needed?
234
def __init__(self, msg=None, orig_error=None):
236
TransportError.__init__(self, msg=msg, orig_error=orig_error)
237
OSError.__init__(self, errno.EEXIST, self.msg)
239
class PermissionDenied(TransportError):
240
"""An operation cannot succeed because of a lack of permissions."""
447
class ConnectionError(TransportError):
448
"""A connection problem prevents file retrieval.
449
This does not indicate whether the file exists or not; it indicates that a
450
precondition for requesting the file was not met.
452
def __init__(self, msg=None, orig_error=None):
453
TransportError.__init__(self, msg=msg, orig_error=orig_error)
243
456
class ConnectionReset(TransportError):
244
457
"""The connection has been closed."""
247
461
class ConflictsInTree(BzrError):
248
462
def __init__(self):
249
463
BzrError.__init__(self, "Working tree has conflicts.")
466
class ParseConfigError(BzrError):
467
def __init__(self, errors, filename):
470
message = "Error(s) parsing config file %s:\n%s" % \
471
(filename, ('\n'.join(e.message for e in errors)))
472
BzrError.__init__(self, message)
475
class SigningFailed(BzrError):
476
def __init__(self, command_line):
477
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
481
class WorkingTreeNotRevision(BzrError):
482
def __init__(self, tree):
483
BzrError.__init__(self, "The working tree for %s has changed since"
484
" last commit, but weave merge requires that it be"
485
" unchanged." % tree.basedir)
488
class CantReprocessAndShowBase(BzrNewError):
489
"""Can't reprocess and show base.
490
Reprocessing obscures relationship of conflicting lines to base."""
493
class GraphCycleError(BzrNewError):
494
"""Cycle in graph %(graph)r"""
495
def __init__(self, graph):
496
BzrNewError.__init__(self)
500
class NotConflicted(BzrNewError):
501
"""File %(filename)s is not conflicted."""
502
def __init__(self, filename):
503
BzrNewError.__init__(self)
504
self.filename = filename
507
class MustUseDecorated(Exception):
508
"""A decorating function has requested its original command be used.
510
This should never escape bzr, so does not need to be printable.
514
class MissingText(BzrNewError):
515
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
516
def __init__(self, branch, text_revision, file_id):
518
self.base = branch.base
519
self.text_revision = text_revision
520
self.file_id = file_id
added
removed
bzrlib/errors.py
