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
51
# based on Scott James Remnant's hct error classes
53
# TODO: is there any value in providing the .args field used by standard
54
# python exceptions? A list of values with no names seems less useful
57
# TODO: Perhaps convert the exception to a string at the moment it's
58
# constructed to make sure it will succeed. But that says nothing about
59
# exceptions that are never raised.
61
# 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>"
22
######################################################################
65
24
class BzrError(StandardError):
67
26
# XXX: Should we show the exception class in
81
40
return n + `self.args`
84
class BzrNewError(BzrError):
86
# base classes should override the docstring with their human-
87
# readable explanation
89
def __init__(self, **kwds):
90
for key, value in kwds.items():
91
setattr(self, key, value)
43
class BzrCheckError(BzrError):
47
class InvalidRevisionNumber(BzrError):
95
return self.__doc__ % self.__dict__
96
except (NameError, ValueError, KeyError), e:
97
return 'Unprintable exception %s: %s' \
98
% (self.__class__.__name__, str(e))
101
class BzrCheckError(BzrNewError):
102
"""Internal check failed: %(message)s"""
103
def __init__(self, message):
104
self.message = message
107
class InvalidEntryName(BzrNewError):
108
"""Invalid entry name: %(name)s"""
109
def __init__(self, name):
113
class InvalidRevisionNumber(BzrNewError):
114
"""Invalid revision number %(revno)d"""
115
def __init__(self, revno):
119
class InvalidRevisionId(BzrNewError):
120
"""Invalid revision-id"""
49
return 'invalid revision number: %r' % self.args[0]
52
class InvalidRevisionId(BzrError):
123
56
class BzrCommandError(BzrError):
125
58
def __str__(self):
126
59
return self.args[0]
128
class StrictCommitFailed(Exception):
129
"""Commit refused because there are unknowns in the tree."""
131
class NotBranchError(BzrNewError):
132
"""Not a branch: %(path)s"""
133
def __init__(self, path):
134
BzrNewError.__init__(self)
138
class UnsupportedFormatError(BzrError):
139
"""Specified path is a bzr branch that we cannot read."""
62
class NotBranchError(BzrError):
63
"""Specified path is not in a branch"""
140
64
def __str__(self):
141
return 'unsupported branch format: %s' % self.args[0]
144
class NotVersionedError(BzrNewError):
145
"""%(path)s is not versioned"""
146
def __init__(self, path):
147
BzrNewError.__init__(self)
65
return 'not a branch: %s' % self.args[0]
68
class NotVersionedError(BzrError):
69
"""Specified object is not versioned."""
151
72
class BadFileKindError(BzrError):
152
73
"""Specified file is of a kind that cannot be added.
154
75
(For example a symlink or device file.)"""
157
79
class ForbiddenFileError(BzrError):
158
80
"""Cannot operate on a file because it is a control file."""
161
84
class LockError(Exception):
163
# All exceptions from the lock/unlock functions should be from
164
# this exception class. They will be translated as necessary. The
165
# original exception is available as e.original_error
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)
168
97
class CommitNotPossible(LockError):
177
106
"""A write attempt was made in a read only transaction."""
180
class PointlessCommit(BzrNewError):
181
"""No changes to commit"""
109
class PointlessCommit(Exception):
110
"""Commit failed because nothing was changed."""
184
113
class NoSuchRevision(BzrError):
330
259
class ConflictsInTree(BzrError):
331
260
def __init__(self):
332
261
BzrError.__init__(self, "Working tree has conflicts.")
334
class SigningFailed(BzrError):
335
def __init__(self, command_line):
336
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"