3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
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
65
class BzrError(StandardError):
67
# XXX: Should we show the exception class in
68
# exceptions that don't provide their own message?
69
# maybe it should be done at a higher level
70
## n = self.__class__.__name__ + ': '
72
if len(self.args) == 1:
73
return str(self.args[0])
74
elif len(self.args) == 2:
75
# further explanation or suggestions
77
return n + '\n '.join([self.args[0]] + self.args[1])
79
return n + "%r" % self
81
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)
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
BzrNewError.__init__(self)
105
self.message = message
108
class InvalidEntryName(BzrNewError):
109
"""Invalid entry name: %(name)s"""
110
def __init__(self, name):
111
BzrNewError.__init__(self)
115
class InvalidRevisionNumber(BzrNewError):
116
"""Invalid revision number %(revno)d"""
117
def __init__(self, revno):
118
BzrNewError.__init__(self)
122
class InvalidRevisionId(BzrNewError):
123
"""Invalid revision-id {%(revision_id)s} in %(branch)s"""
124
def __init__(self, revision_id, branch):
125
BzrNewError.__init__(self)
126
self.revision_id = revision_id
130
class NoWorkingTree(BzrNewError):
131
"""No WorkingTree exists for %s(base)."""
133
def __init__(self, base):
134
BzrNewError.__init__(self)
137
class BzrCommandError(BzrError):
138
# Error from malformed user command
139
# This is being misused as a generic exception
140
# pleae subclass. RBC 20051030
145
class BzrOptionError(BzrCommandError):
146
"""Some missing or otherwise incorrect option was supplied."""
149
class StrictCommitFailed(Exception):
150
"""Commit refused because there are unknowns in the tree."""
152
class NotBranchError(BzrNewError):
153
"""Not a branch: %(path)s"""
154
def __init__(self, path):
155
BzrNewError.__init__(self)
159
class UnsupportedFormatError(BzrError):
160
"""Specified path is a bzr branch that we cannot read."""
162
return 'unsupported branch format: %s' % self.args[0]
165
class NotVersionedError(BzrNewError):
166
"""%(path)s is not versioned"""
167
def __init__(self, path):
168
BzrNewError.__init__(self)
172
class BadFileKindError(BzrError):
173
"""Specified file is of a kind that cannot be added.
175
(For example a symlink or device file.)"""
178
class ForbiddenFileError(BzrError):
179
"""Cannot operate on a file because it is a control file."""
182
class LockError(Exception):
184
# All exceptions from the lock/unlock functions should be from
185
# this exception class. They will be translated as necessary. The
186
# original exception is available as e.original_error
189
class CommitNotPossible(LockError):
190
"""A commit was attempted but we do not have a write lock open."""
193
class AlreadyCommitted(LockError):
194
"""A rollback was requested, but is not able to be accomplished."""
197
class ReadOnlyError(LockError):
198
"""A write attempt was made in a read only transaction."""
201
class PointlessCommit(BzrNewError):
202
"""No changes to commit"""
204
class StrictCommitFailed(Exception):
205
"""Commit refused because there are unknowns in the tree."""
207
class NoSuchRevision(BzrError):
208
def __init__(self, branch, revision):
210
self.revision = revision
211
msg = "Branch %s has no revision %s" % (branch, revision)
212
BzrError.__init__(self, msg)
215
class HistoryMissing(BzrError):
216
def __init__(self, branch, object_type, object_id):
218
BzrError.__init__(self,
219
'%s is missing %s {%s}'
220
% (branch, object_type, object_id))
223
class DivergedBranches(BzrError):
224
def __init__(self, branch1, branch2):
225
BzrError.__init__(self, "These branches have diverged.")
226
self.branch1 = branch1
227
self.branch2 = branch2
230
class UnrelatedBranches(BzrCommandError):
232
msg = "Branches have no common ancestor, and no base revision"\
234
BzrCommandError.__init__(self, msg)
236
class NoCommonAncestor(BzrError):
237
def __init__(self, revision_a, revision_b):
238
msg = "Revisions have no common ancestor: %s %s." \
239
% (revision_a, revision_b)
240
BzrError.__init__(self, msg)
242
class NoCommonRoot(BzrError):
243
def __init__(self, revision_a, revision_b):
244
msg = "Revisions are not derived from the same root: %s %s." \
245
% (revision_a, revision_b)
246
BzrError.__init__(self, msg)
248
class NotAncestor(BzrError):
249
def __init__(self, rev_id, not_ancestor_id):
250
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
252
BzrError.__init__(self, msg)
254
self.not_ancestor_id = not_ancestor_id
257
class NotAncestor(BzrError):
258
def __init__(self, rev_id, not_ancestor_id):
260
self.not_ancestor_id = not_ancestor_id
261
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
263
BzrError.__init__(self, msg)
266
class InstallFailed(BzrError):
267
def __init__(self, revisions):
268
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
269
BzrError.__init__(self, msg)
270
self.revisions = revisions
273
class AmbiguousBase(BzrError):
274
def __init__(self, bases):
275
msg = "The correct base is unclear, becase %s are all equally close" %\
277
BzrError.__init__(self, msg)
280
class NoCommits(BzrError):
281
def __init__(self, branch):
282
msg = "Branch %s has no commits." % branch
283
BzrError.__init__(self, msg)
285
class UnlistableStore(BzrError):
286
def __init__(self, store):
287
BzrError.__init__(self, "Store %s is not listable" % store)
289
class UnlistableBranch(BzrError):
290
def __init__(self, br):
291
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
294
class WeaveError(BzrNewError):
295
"""Error in processing weave: %(message)s"""
296
def __init__(self, message=None):
297
BzrNewError.__init__(self)
298
self.message = message
301
class WeaveRevisionAlreadyPresent(WeaveError):
302
"""Revision {%(revision_id)s} already present in %(weave)s"""
303
def __init__(self, revision_id, weave):
304
WeaveError.__init__(self)
305
self.revision_id = revision_id
309
class WeaveRevisionNotPresent(WeaveError):
310
"""Revision {%(revision_id)s} not present in %(weave)s"""
311
def __init__(self, revision_id, weave):
312
WeaveError.__init__(self)
313
self.revision_id = revision_id
317
class WeaveFormatError(WeaveError):
318
"""Weave invariant violated: %(what)s"""
319
def __init__(self, what):
320
WeaveError.__init__(self)
324
class WeaveParentMismatch(WeaveError):
325
"""Parents are mismatched between two revisions."""
328
class NoSuchExportFormat(BzrNewError):
329
"""Export format %(format)r not supported"""
330
def __init__(self, format):
331
BzrNewError.__init__(self)
335
class TransportError(BzrError):
336
"""All errors thrown by Transport implementations should derive
339
def __init__(self, msg=None, orig_error=None):
340
if msg is None and orig_error is not None:
341
msg = str(orig_error)
342
BzrError.__init__(self, msg)
344
self.orig_error = orig_error
346
# A set of semi-meaningful errors which can be thrown
347
class TransportNotPossible(TransportError):
348
"""This is for transports where a specific function is explicitly not
349
possible. Such as pushing files to an HTTP server.
353
class NonRelativePath(TransportError):
354
"""An absolute path was supplied, that could not be decoded into
359
class NoSuchFile(TransportError, IOError):
360
"""A get() was issued for a file that doesn't exist."""
362
# XXX: Is multiple inheritance for exceptions really needed?
365
return 'no such file: ' + self.msg
367
def __init__(self, msg=None, orig_error=None):
369
TransportError.__init__(self, msg=msg, orig_error=orig_error)
370
IOError.__init__(self, errno.ENOENT, self.msg)
372
class FileExists(TransportError, OSError):
373
"""An operation was attempted, which would overwrite an entry,
374
but overwritting is not supported.
376
mkdir() can throw this, but put() just overwites existing files.
378
# XXX: Is multiple inheritance for exceptions really needed?
379
def __init__(self, msg=None, orig_error=None):
381
TransportError.__init__(self, msg=msg, orig_error=orig_error)
382
OSError.__init__(self, errno.EEXIST, self.msg)
384
class PermissionDenied(TransportError):
385
"""An operation cannot succeed because of a lack of permissions."""
388
class ConnectionReset(TransportError):
389
"""The connection has been closed."""
392
class ConflictsInTree(BzrError):
394
BzrError.__init__(self, "Working tree has conflicts.")
396
class ParseConfigError(BzrError):
397
def __init__(self, errors, filename):
400
message = "Error(s) parsing config file %s:\n%s" % \
401
(filename, ('\n'.join(e.message for e in errors)))
402
BzrError.__init__(self, message)
404
class SigningFailed(BzrError):
405
def __init__(self, command_line):
406
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
409
class WorkingTreeNotRevision(BzrError):
410
def __init__(self, tree):
411
BzrError.__init__(self, "The working tree for %s has changed since"
412
" last commit, but weave merge requires that it be"
413
" unchanged." % tree.basedir)
415
class CantReprocessAndShowBase(BzrNewError):
416
"""Can't reprocess and show base.
417
Reprocessing obscures relationship of conflicting lines to base."""
419
class GraphCycleError(BzrNewError):
420
"""Cycle in graph %(graph)r"""
421
def __init__(self, graph):
422
BzrNewError.__init__(self)
425
class MustUseDecorated(Exception):
426
"""A decorating function has requested its original command be used.
428
This should never escape bzr, so does not need to be printable.
added
removed
bzrlib/errors.py
