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
... 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
70
class BzrError(StandardError):
72
# XXX: Should we show the exception class in
73
# exceptions that don't provide their own message?
74
# maybe it should be done at a higher level
75
## n = self.__class__.__name__ + ': '
77
if len(self.args) == 1:
78
return str(self.args[0])
79
elif len(self.args) == 2:
80
# further explanation or suggestions
82
return n + '\n '.join([self.args[0]] + self.args[1])
84
return n + "%r" % self
86
return n + `self.args`
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)
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)
143
class BzrCommandError(BzrError):
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
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
215
class UnsupportedFormatError(BzrError):
216
"""Specified path is a bzr branch that we cannot read."""
218
return 'unsupported branch format: %s' % self.args[0]
221
class NotVersionedError(BzrNewError):
222
"""%(path)s is not versioned"""
223
def __init__(self, path):
224
BzrNewError.__init__(self)
228
class BadFileKindError(BzrError):
229
"""Specified file is of a kind that cannot be added.
231
(For example a symlink or device file.)"""
234
class ForbiddenFileError(BzrError):
235
"""Cannot operate on a file because it is a control file."""
238
class LockError(Exception):
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
245
class CommitNotPossible(LockError):
246
"""A commit was attempted but we do not have a write lock open."""
249
class AlreadyCommitted(LockError):
250
"""A rollback was requested, but is not able to be accomplished."""
253
class ReadOnlyError(LockError):
254
"""A write attempt was made in a read only transaction."""
257
class PointlessCommit(BzrNewError):
258
"""No changes to commit"""
260
class StrictCommitFailed(Exception):
261
"""Commit refused because there are unknowns in the tree."""
263
class NoSuchRevision(BzrError):
264
def __init__(self, branch, revision):
266
self.revision = revision
267
msg = "Branch %s has no revision %s" % (branch, revision)
268
BzrError.__init__(self, msg)
271
class HistoryMissing(BzrError):
272
def __init__(self, branch, object_type, object_id):
274
BzrError.__init__(self,
275
'%s is missing %s {%s}'
276
% (branch, object_type, object_id))
279
class DivergedBranches(BzrError):
280
def __init__(self, branch1, branch2):
281
BzrError.__init__(self, "These branches have diverged. Try merge.")
282
self.branch1 = branch1
283
self.branch2 = branch2
286
class UnrelatedBranches(BzrCommandError):
288
msg = "Branches have no common ancestor, and no base revision"\
290
BzrCommandError.__init__(self, msg)
292
class NoCommonAncestor(BzrError):
293
def __init__(self, revision_a, revision_b):
294
msg = "Revisions have no common ancestor: %s %s." \
295
% (revision_a, revision_b)
296
BzrError.__init__(self, msg)
298
class NoCommonRoot(BzrError):
299
def __init__(self, revision_a, revision_b):
300
msg = "Revisions are not derived from the same root: %s %s." \
301
% (revision_a, revision_b)
302
BzrError.__init__(self, msg)
304
class NotAncestor(BzrError):
305
def __init__(self, rev_id, not_ancestor_id):
306
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
308
BzrError.__init__(self, msg)
310
self.not_ancestor_id = not_ancestor_id
313
class InstallFailed(BzrError):
314
def __init__(self, revisions):
315
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
316
BzrError.__init__(self, msg)
317
self.revisions = revisions
320
class AmbiguousBase(BzrError):
321
def __init__(self, bases):
322
msg = "The correct base is unclear, becase %s are all equally close" %\
324
BzrError.__init__(self, msg)
327
class NoCommits(BzrError):
328
def __init__(self, branch):
329
msg = "Branch %s has no commits." % branch
330
BzrError.__init__(self, msg)
332
class UnlistableStore(BzrError):
333
def __init__(self, store):
334
BzrError.__init__(self, "Store %s is not listable" % store)
336
class UnlistableBranch(BzrError):
337
def __init__(self, br):
338
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
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)
386
class TransportError(BzrError):
387
"""All errors thrown by Transport implementations should derive
390
def __init__(self, msg=None, orig_error=None):
391
if msg is None and orig_error is not None:
392
msg = str(orig_error)
393
BzrError.__init__(self, msg)
395
self.orig_error = orig_error
397
# A set of semi-meaningful errors which can be thrown
398
class TransportNotPossible(TransportError):
399
"""This is for transports where a specific function is explicitly not
400
possible. Such as pushing files to an HTTP server.
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)
414
class ConnectionReset(TransportError):
415
"""The connection has been closed."""
418
class ConflictsInTree(BzrError):
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)
451
class NotConflicted(BzrNewError):
452
"""File %(filename)s is not conflicted."""
453
def __init__(self, filename):
454
BzrNewError.__init__(self)
455
self.filename = filename
457
class MustUseDecorated(Exception):
458
"""A decorating function has requested its original command be used.
460
This should never escape bzr, so does not need to be printable.
463
class MissingText(BzrNewError):
464
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
465
def __init__(self, branch, text_revision, file_id):
467
self.base = branch.base
468
self.text_revision = text_revision
469
self.file_id = file_id
added
removed
bzrlib/errors.py
