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
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
18
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
19
__author__ = "Martin Pool <mbp@canonical.com>"
21
# TODO: Change to a standard exception pattern:
23
# - docstring of exceptions is a template for formatting the exception
24
# so the __str__ method can be defined only in the superclass
25
# - the arguments to the exception are interpolated into this string
27
# when printing the exception we'd then require special handling only
28
# for built-in exceptions with no decent __str__ method, such as
29
# ValueError and AssertionError. See
30
# scott@canonical.com--2005/hct--devel--0.10 util/errors.py
33
######################################################################
68
35
class BzrError(StandardError):
70
37
# XXX: Should we show the exception class in
84
51
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)
54
class BzrCheckError(BzrError):
58
class InvalidRevisionNumber(BzrError):
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"""
120
def __init__(self, revno):
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)
60
return 'invalid revision number: %r' % self.args[0]
63
class InvalidRevisionId(BzrError):
141
67
class BzrCommandError(BzrError):
142
68
# Error from malformed user command
143
# This is being misused as a generic exception
144
# pleae subclass. RBC 20051030
146
# I think it's a waste of effort to differentiate between errors that
147
# are not intended to be caught anyway. UI code need not subclass
148
# BzrCommandError, and non-UI code should not throw a subclass of
149
# BzrCommandError. ADHB 20051211
150
69
def __str__(self):
151
70
return self.args[0]
154
class BzrOptionError(BzrCommandError):
155
"""Some missing or otherwise incorrect option was supplied."""
158
class StrictCommitFailed(Exception):
159
"""Commit refused because there are unknowns in the tree."""
162
class PathError(BzrNewError):
163
"""Generic path error: %(path)r%(extra)s)"""
164
def __init__(self, path, extra=None):
165
BzrNewError.__init__(self)
168
self.extra = ': ' + str(extra)
173
class NoSuchFile(PathError):
174
"""No such file: %(path)r%(extra)s"""
177
class FileExists(PathError):
178
"""File exists: %(path)r%(extra)s"""
181
class PermissionDenied(PathError):
182
"""Permission denied: %(path)r%(extra)s"""
185
class PathNotChild(BzrNewError):
186
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
187
def __init__(self, path, base, extra=None):
188
BzrNewError.__init__(self)
192
self.extra = ': ' + str(extra)
197
class NotBranchError(BzrNewError):
198
"""Not a branch: %(path)s"""
199
def __init__(self, path):
200
BzrNewError.__init__(self)
204
class FileInWrongBranch(BzrNewError):
205
"""File %(path)s in not in branch %(branch_base)s."""
206
def __init__(self, branch, path):
207
BzrNewError.__init__(self)
209
self.branch_base = branch.base
73
class NotBranchError(BzrError):
74
"""Specified path is not in a branch"""
76
return 'not a branch: %s' % self.args[0]
213
79
class UnsupportedFormatError(BzrError):
216
82
return 'unsupported branch format: %s' % self.args[0]
219
class NotVersionedError(BzrNewError):
220
"""%(path)s is not versioned"""
221
def __init__(self, path):
222
BzrNewError.__init__(self)
85
class NotVersionedError(BzrError):
86
"""Specified object is not versioned."""
226
89
class BadFileKindError(BzrError):
227
90
"""Specified file is of a kind that cannot be added.
229
92
(For example a symlink or device file.)"""
232
96
class ForbiddenFileError(BzrError):
233
97
"""Cannot operate on a file because it is a control file."""
236
101
class LockError(Exception):
238
# All exceptions from the lock/unlock functions should be from
239
# this exception class. They will be translated as necessary. The
240
# original exception is available as e.original_error
102
"""All exceptions from the lock/unlock functions should be from
103
this exception class. They will be translated as necessary. The
104
original exception is available as e.original_error
106
def __init__(self, e=None):
107
self.original_error = e
109
Exception.__init__(self, e)
111
Exception.__init__(self)
243
114
class CommitNotPossible(LockError):
336
214
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
339
class WeaveError(BzrNewError):
340
"""Error in processing weave: %(message)s"""
341
def __init__(self, message=None):
342
BzrNewError.__init__(self)
343
self.message = message
346
class WeaveRevisionAlreadyPresent(WeaveError):
347
"""Revision {%(revision_id)s} already present in %(weave)s"""
348
def __init__(self, revision_id, weave):
349
WeaveError.__init__(self)
350
self.revision_id = revision_id
354
class WeaveRevisionNotPresent(WeaveError):
355
"""Revision {%(revision_id)s} not present in %(weave)s"""
356
def __init__(self, revision_id, weave):
357
WeaveError.__init__(self)
358
self.revision_id = revision_id
362
class WeaveFormatError(WeaveError):
363
"""Weave invariant violated: %(what)s"""
364
def __init__(self, what):
365
WeaveError.__init__(self)
369
class WeaveParentMismatch(WeaveError):
370
"""Parents are mismatched between two revisions."""
373
class NoSuchExportFormat(BzrNewError):
374
"""Export format %(format)r not supported"""
375
def __init__(self, format):
376
BzrNewError.__init__(self)
217
from bzrlib.weave import WeaveError, WeaveParentMismatch
380
219
class TransportError(BzrError):
381
220
"""All errors thrown by Transport implementations should derive
399
class ConnectionError(TransportError):
400
"""A connection problem prevents file retrieval.
401
This does not indicate whether the file exists or not; it indicates that a
402
precondition for requesting the file was not met.
404
def __init__(self, msg=None, orig_error=None):
405
TransportError.__init__(self, msg=msg, orig_error=orig_error)
237
class NonRelativePath(TransportError):
238
"""An absolute path was supplied, that could not be decoded into
243
class NoSuchFile(TransportError, IOError):
244
"""A get() was issued for a file that doesn't exist."""
246
# XXX: Is multiple inheritance for exceptions really needed?
249
return 'no such file: ' + self.msg
251
def __init__(self, msg=None, orig_error=None):
253
TransportError.__init__(self, msg=msg, orig_error=orig_error)
254
IOError.__init__(self, errno.ENOENT, self.msg)
256
class FileExists(TransportError, OSError):
257
"""An operation was attempted, which would overwrite an entry,
258
but overwritting is not supported.
260
mkdir() can throw this, but put() just overwites existing files.
262
# XXX: Is multiple inheritance for exceptions really needed?
263
def __init__(self, msg=None, orig_error=None):
265
TransportError.__init__(self, msg=msg, orig_error=orig_error)
266
OSError.__init__(self, errno.EEXIST, self.msg)
268
class PermissionDenied(TransportError):
269
"""An operation cannot succeed because of a lack of permissions."""
408
272
class ConnectionReset(TransportError):
409
273
"""The connection has been closed."""
413
277
def __init__(self):
414
278
BzrError.__init__(self, "Working tree has conflicts.")
416
class ParseConfigError(BzrError):
417
def __init__(self, errors, filename):
420
message = "Error(s) parsing config file %s:\n%s" % \
421
(filename, ('\n'.join(e.message for e in errors)))
422
BzrError.__init__(self, message)
424
280
class SigningFailed(BzrError):
425
281
def __init__(self, command_line):
426
282
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
429
class WorkingTreeNotRevision(BzrError):
430
def __init__(self, tree):
431
BzrError.__init__(self, "The working tree for %s has changed since"
432
" last commit, but weave merge requires that it be"
433
" unchanged." % tree.basedir)
435
class CantReprocessAndShowBase(BzrNewError):
436
"""Can't reprocess and show base.
437
Reprocessing obscures relationship of conflicting lines to base."""
439
class GraphCycleError(BzrNewError):
440
"""Cycle in graph %(graph)r"""
441
def __init__(self, graph):
442
BzrNewError.__init__(self)
445
class NotConflicted(BzrNewError):
446
"""File %(filename)s is not conflicted."""
447
def __init__(self, filename):
448
BzrNewError.__init__(self)
449
self.filename = filename
451
class MustUseDecorated(Exception):
452
"""A decorating function has requested its original command be used.
454
This should never escape bzr, so does not need to be printable.
457
class MissingText(BzrNewError):
458
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
459
def __init__(self, branch, text_revision, file_id):
461
self.base = branch.base
462
self.text_revision = text_revision
463
self.file_id = file_id
added
removed
bzrlib/errors.py
