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"""
65
return 'not a branch: %s' % self.args[0]
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
68
215
class UnsupportedFormatError(BzrError):
71
218
return 'unsupported branch format: %s' % self.args[0]
74
class NotVersionedError(BzrError):
75
"""Specified object is not versioned."""
221
class NotVersionedError(BzrNewError):
222
"""%(path)s is not versioned"""
223
def __init__(self, path):
224
BzrNewError.__init__(self)
78
228
class BadFileKindError(BzrError):
79
229
"""Specified file is of a kind that cannot be added.
81
231
(For example a symlink or device file.)"""
85
234
class ForbiddenFileError(BzrError):
86
235
"""Cannot operate on a file because it is a control file."""
90
238
class LockError(Exception):
91
"""All exceptions from the lock/unlock functions should be from
92
this exception class. They will be translated as necessary. The
93
original exception is available as e.original_error
95
def __init__(self, e=None):
96
self.original_error = e
98
Exception.__init__(self, e)
100
Exception.__init__(self)
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
103
245
class CommitNotPossible(LockError):
203
338
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
206
from bzrlib.weave import WeaveError, WeaveParentMismatch
341
class WeaveError(BzrNewError):
342
"""Error in processing weave: %(message)s"""
343
def __init__(self, message=None):
344
BzrNewError.__init__(self)
345
self.message = message
348
class WeaveRevisionAlreadyPresent(WeaveError):
349
"""Revision {%(revision_id)s} already present in %(weave)s"""
350
def __init__(self, revision_id, weave):
351
WeaveError.__init__(self)
352
self.revision_id = revision_id
356
class WeaveRevisionNotPresent(WeaveError):
357
"""Revision {%(revision_id)s} not present in %(weave)s"""
358
def __init__(self, revision_id, weave):
359
WeaveError.__init__(self)
360
self.revision_id = revision_id
364
class WeaveFormatError(WeaveError):
365
"""Weave invariant violated: %(what)s"""
366
def __init__(self, what):
367
WeaveError.__init__(self)
371
class WeaveParentMismatch(WeaveError):
372
"""Parents are mismatched between two revisions."""
375
class WeaveInvalidChecksum(WeaveError):
376
"""Text did not match it's checksum: %(message)s"""
379
class NoSuchExportFormat(BzrNewError):
380
"""Export format %(format)r not supported"""
381
def __init__(self, format):
382
BzrNewError.__init__(self)
208
386
class TransportError(BzrError):
209
387
"""All errors thrown by Transport implementations should derive
226
class NonRelativePath(TransportError):
227
"""An absolute path was supplied, that could not be decoded into
232
class NoSuchFile(TransportError, IOError):
233
"""A get() was issued for a file that doesn't exist."""
235
# XXX: Is multiple inheritance for exceptions really needed?
238
return 'no such file: ' + self.msg
240
def __init__(self, msg=None, orig_error=None):
242
TransportError.__init__(self, msg=msg, orig_error=orig_error)
243
IOError.__init__(self, errno.ENOENT, self.msg)
245
class FileExists(TransportError, OSError):
246
"""An operation was attempted, which would overwrite an entry,
247
but overwritting is not supported.
249
mkdir() can throw this, but put() just overwites existing files.
251
# XXX: Is multiple inheritance for exceptions really needed?
252
def __init__(self, msg=None, orig_error=None):
254
TransportError.__init__(self, msg=msg, orig_error=orig_error)
255
OSError.__init__(self, errno.EEXIST, self.msg)
257
class PermissionDenied(TransportError):
258
"""An operation cannot succeed because of a lack of permissions."""
405
class ConnectionError(TransportError):
406
"""A connection problem prevents file retrieval.
407
This does not indicate whether the file exists or not; it indicates that a
408
precondition for requesting the file was not met.
410
def __init__(self, msg=None, orig_error=None):
411
TransportError.__init__(self, msg=msg, orig_error=orig_error)
261
414
class ConnectionReset(TransportError):
262
415
"""The connection has been closed."""
265
418
class ConflictsInTree(BzrError):
266
419
def __init__(self):
267
420
BzrError.__init__(self, "Working tree has conflicts.")
422
class ParseConfigError(BzrError):
423
def __init__(self, errors, filename):
426
message = "Error(s) parsing config file %s:\n%s" % \
427
(filename, ('\n'.join(e.message for e in errors)))
428
BzrError.__init__(self, message)
430
class SigningFailed(BzrError):
431
def __init__(self, command_line):
432
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
435
class WorkingTreeNotRevision(BzrError):
436
def __init__(self, tree):
437
BzrError.__init__(self, "The working tree for %s has changed since"
438
" last commit, but weave merge requires that it be"
439
" unchanged." % tree.basedir)
441
class CantReprocessAndShowBase(BzrNewError):
442
"""Can't reprocess and show base.
443
Reprocessing obscures relationship of conflicting lines to base."""
445
class GraphCycleError(BzrNewError):
446
"""Cycle in graph %(graph)r"""
447
def __init__(self, graph):
448
BzrNewError.__init__(self)
452
class NotConflicted(BzrNewError):
453
"""File %(filename)s is not conflicted."""
455
def __init__(self, filename):
456
BzrNewError.__init__(self)
457
self.filename = filename
460
class MustUseDecorated(Exception):
461
"""A decorating function has requested its original command be used.
463
This should never escape bzr, so does not need to be printable.
467
class MissingText(BzrNewError):
468
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
470
def __init__(self, branch, text_revision, file_id):
471
BzrNewError.__init__(self)
473
self.base = branch.base
474
self.text_revision = text_revision
475
self.file_id = file_id
478
class BzrBadParameter(BzrNewError):
479
"""A bad parameter : %(param)s is not usable.
481
This exception should never be thrown, but it is a base class for all
482
parameter-to-function errors.
484
def __init__(self, param):
485
BzrNewError.__init__(self)
489
class BzrBadParameterNotUnicode(BzrBadParameter):
490
"""Parameter %(param)s is neither unicode nor utf8."""
493
class BzrBadParameterNotString(BzrBadParameter):
494
"""Parameter %(param)s is not a string or unicode string."""
added
removed
bzrlib/errors.py
