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
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
68
class BzrError(StandardError):
70
# XXX: Should we show the exception class in
71
# exceptions that don't provide their own message?
72
# maybe it should be done at a higher level
73
## n = self.__class__.__name__ + ': '
75
if len(self.args) == 1:
76
return str(self.args[0])
77
elif len(self.args) == 2:
78
# further explanation or suggestions
80
return n + '\n '.join([self.args[0]] + self.args[1])
82
return n + "%r" % self
84
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)
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)
141
class BzrCommandError(BzrError):
142
# Error from malformed user command
143
# This is being misused as a generic exception
144
# pleae subclass. RBC 20051030
149
class BzrOptionError(BzrCommandError):
150
"""Some missing or otherwise incorrect option was supplied."""
153
class StrictCommitFailed(Exception):
154
"""Commit refused because there are unknowns in the tree."""
156
class NotBranchError(BzrNewError):
157
"""Not a branch: %(path)s"""
158
def __init__(self, path):
159
BzrNewError.__init__(self)
163
class UnsupportedFormatError(BzrError):
164
"""Specified path is a bzr branch that we cannot read."""
166
return 'unsupported branch format: %s' % self.args[0]
169
class NotVersionedError(BzrNewError):
170
"""%(path)s is not versioned"""
171
def __init__(self, path):
172
BzrNewError.__init__(self)
176
class BadFileKindError(BzrError):
177
"""Specified file is of a kind that cannot be added.
179
(For example a symlink or device file.)"""
182
class ForbiddenFileError(BzrError):
183
"""Cannot operate on a file because it is a control file."""
186
class LockError(Exception):
188
# All exceptions from the lock/unlock functions should be from
189
# this exception class. They will be translated as necessary. The
190
# original exception is available as e.original_error
193
class CommitNotPossible(LockError):
194
"""A commit was attempted but we do not have a write lock open."""
197
class AlreadyCommitted(LockError):
198
"""A rollback was requested, but is not able to be accomplished."""
201
class ReadOnlyError(LockError):
202
"""A write attempt was made in a read only transaction."""
205
class PointlessCommit(BzrNewError):
206
"""No changes to commit"""
208
class StrictCommitFailed(Exception):
209
"""Commit refused because there are unknowns in the tree."""
211
class NoSuchRevision(BzrError):
212
def __init__(self, branch, revision):
214
self.revision = revision
215
msg = "Branch %s has no revision %s" % (branch, revision)
216
BzrError.__init__(self, msg)
219
class HistoryMissing(BzrError):
220
def __init__(self, branch, object_type, object_id):
222
BzrError.__init__(self,
223
'%s is missing %s {%s}'
224
% (branch, object_type, object_id))
227
class DivergedBranches(BzrError):
228
def __init__(self, branch1, branch2):
229
BzrError.__init__(self, "These branches have diverged.")
230
self.branch1 = branch1
231
self.branch2 = branch2
234
class UnrelatedBranches(BzrCommandError):
236
msg = "Branches have no common ancestor, and no base revision"\
238
BzrCommandError.__init__(self, msg)
240
class NoCommonAncestor(BzrError):
241
def __init__(self, revision_a, revision_b):
242
msg = "Revisions have no common ancestor: %s %s." \
243
% (revision_a, revision_b)
244
BzrError.__init__(self, msg)
246
class NoCommonRoot(BzrError):
247
def __init__(self, revision_a, revision_b):
248
msg = "Revisions are not derived from the same root: %s %s." \
249
% (revision_a, revision_b)
250
BzrError.__init__(self, msg)
252
class NotAncestor(BzrError):
253
def __init__(self, rev_id, not_ancestor_id):
254
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
256
BzrError.__init__(self, msg)
258
self.not_ancestor_id = not_ancestor_id
261
class NotAncestor(BzrError):
262
def __init__(self, rev_id, not_ancestor_id):
264
self.not_ancestor_id = not_ancestor_id
265
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
267
BzrError.__init__(self, msg)
270
class InstallFailed(BzrError):
271
def __init__(self, revisions):
272
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
273
BzrError.__init__(self, msg)
274
self.revisions = revisions
277
class AmbiguousBase(BzrError):
278
def __init__(self, bases):
279
msg = "The correct base is unclear, becase %s are all equally close" %\
281
BzrError.__init__(self, msg)
284
class NoCommits(BzrError):
285
def __init__(self, branch):
286
msg = "Branch %s has no commits." % branch
287
BzrError.__init__(self, msg)
289
class UnlistableStore(BzrError):
290
def __init__(self, store):
291
BzrError.__init__(self, "Store %s is not listable" % store)
293
class UnlistableBranch(BzrError):
294
def __init__(self, br):
295
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
298
class WeaveError(BzrNewError):
299
"""Error in processing weave: %(message)s"""
300
def __init__(self, message=None):
301
BzrNewError.__init__(self)
302
self.message = message
305
class WeaveRevisionAlreadyPresent(WeaveError):
306
"""Revision {%(revision_id)s} already present in %(weave)s"""
307
def __init__(self, revision_id, weave):
308
WeaveError.__init__(self)
309
self.revision_id = revision_id
313
class WeaveRevisionNotPresent(WeaveError):
314
"""Revision {%(revision_id)s} not present in %(weave)s"""
315
def __init__(self, revision_id, weave):
316
WeaveError.__init__(self)
317
self.revision_id = revision_id
321
class WeaveFormatError(WeaveError):
322
"""Weave invariant violated: %(what)s"""
323
def __init__(self, what):
324
WeaveError.__init__(self)
328
class WeaveParentMismatch(WeaveError):
329
"""Parents are mismatched between two revisions."""
332
class TransportError(BzrError):
333
"""All errors thrown by Transport implementations should derive
336
def __init__(self, msg=None, orig_error=None):
337
if msg is None and orig_error is not None:
338
msg = str(orig_error)
339
BzrError.__init__(self, msg)
341
self.orig_error = orig_error
343
# A set of semi-meaningful errors which can be thrown
344
class TransportNotPossible(TransportError):
345
"""This is for transports where a specific function is explicitly not
346
possible. Such as pushing files to an HTTP server.
350
class NonRelativePath(TransportError):
351
"""An absolute path was supplied, that could not be decoded into
356
class NoSuchFile(TransportError, IOError):
357
"""A get() was issued for a file that doesn't exist."""
359
# XXX: Is multiple inheritance for exceptions really needed?
362
return 'no such file: ' + self.msg
364
def __init__(self, msg=None, orig_error=None):
366
TransportError.__init__(self, msg=msg, orig_error=orig_error)
367
IOError.__init__(self, errno.ENOENT, self.msg)
369
class ConnectionError(TransportError, IOError):
371
A connection problem prevents file retrieval.
372
This does not indicate whether the file exists or not; it indicates that a
373
precondition for requesting the file was not met.
376
# XXX: Is multiple inheritance for exceptions really needed?
379
return 'connection error: ' + self.msg
381
def __init__(self, msg=None, orig_error=None):
383
TransportError.__init__(self, msg=msg, orig_error=orig_error)
384
IOError.__init__(self, errno.ENOENT, self.msg)
387
class FileExists(TransportError, OSError):
388
"""An operation was attempted, which would overwrite an entry,
389
but overwritting is not supported.
391
mkdir() can throw this, but put() just overwites existing files.
393
# XXX: Is multiple inheritance for exceptions really needed?
394
def __init__(self, msg=None, orig_error=None):
396
TransportError.__init__(self, msg=msg, orig_error=orig_error)
397
OSError.__init__(self, errno.EEXIST, self.msg)
399
class PermissionDenied(TransportError):
400
"""An operation cannot succeed because of a lack of permissions."""
403
class ConnectionReset(TransportError):
404
"""The connection has been closed."""
407
class ConflictsInTree(BzrError):
409
BzrError.__init__(self, "Working tree has conflicts.")
411
class ParseConfigError(BzrError):
412
def __init__(self, errors, filename):
415
message = "Error(s) parsing config file %s:\n%s" % \
416
(filename, ('\n'.join(e.message for e in errors)))
417
BzrError.__init__(self, message)
419
class SigningFailed(BzrError):
420
def __init__(self, command_line):
421
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
424
class WorkingTreeNotRevision(BzrError):
425
def __init__(self, tree):
426
BzrError.__init__(self, "The working tree for %s has changed since"
427
" last commit, but weave merge requires that it be"
428
" unchanged." % tree.basedir)
430
class CantReprocessAndShowBase(BzrNewError):
431
"""Can't reprocess and show base.
432
Reprocessing obscures relationship of conflicting lines to base."""
434
class GraphCycleError(BzrNewError):
435
"""Cycle in graph %(graph)r"""
436
def __init__(self, graph):
437
BzrNewError.__init__(self)
440
class NotConflicted(BzrNewError):
441
"""File %(filename)s is not conflicted."""
442
def __init__(self, filename):
443
BzrNewError.__init__(self)
444
self.filename = filename
446
class MustUseDecorated(Exception):
447
"""A decorating function has requested its original command be used.
449
This should never escape bzr, so does not need to be printable.
added
removed
bzrlib/errors.py
