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 recognize but cannot read."""
218
return 'unsupported branch format: %s' % self.args[0]
221
class UnknownFormatError(BzrError):
222
"""Specified path is a bzr branch whose format we do not recognize."""
224
return 'unknown branch format: %s' % self.args[0]
227
class NotVersionedError(BzrNewError):
228
"""%(path)s is not versioned"""
229
def __init__(self, path):
230
BzrNewError.__init__(self)
234
class BadFileKindError(BzrError):
235
"""Specified file is of a kind that cannot be added.
237
(For example a symlink or device file.)"""
240
class ForbiddenFileError(BzrError):
241
"""Cannot operate on a file because it is a control file."""
244
class LockError(Exception):
246
# All exceptions from the lock/unlock functions should be from
247
# this exception class. They will be translated as necessary. The
248
# original exception is available as e.original_error
251
class CommitNotPossible(LockError):
252
"""A commit was attempted but we do not have a write lock open."""
255
class AlreadyCommitted(LockError):
256
"""A rollback was requested, but is not able to be accomplished."""
259
class ReadOnlyError(LockError):
260
"""A write attempt was made in a read only transaction."""
263
class PointlessCommit(BzrNewError):
264
"""No changes to commit"""
267
class UpgradeReadonly(BzrNewError):
268
"""Upgrade URL cannot work with readonly URL's."""
271
class StrictCommitFailed(Exception):
272
"""Commit refused because there are unknowns in the tree."""
275
class NoSuchRevision(BzrError):
276
def __init__(self, branch, revision):
278
self.revision = revision
279
msg = "Branch %s has no revision %s" % (branch, revision)
280
BzrError.__init__(self, msg)
283
class HistoryMissing(BzrError):
284
def __init__(self, branch, object_type, object_id):
286
BzrError.__init__(self,
287
'%s is missing %s {%s}'
288
% (branch, object_type, object_id))
291
class DivergedBranches(BzrError):
292
def __init__(self, branch1, branch2):
293
BzrError.__init__(self, "These branches have diverged. Try merge.")
294
self.branch1 = branch1
295
self.branch2 = branch2
298
class UnrelatedBranches(BzrCommandError):
300
msg = "Branches have no common ancestor, and no base revision"\
302
BzrCommandError.__init__(self, msg)
305
class NoCommonAncestor(BzrError):
306
def __init__(self, revision_a, revision_b):
307
msg = "Revisions have no common ancestor: %s %s." \
308
% (revision_a, revision_b)
309
BzrError.__init__(self, msg)
312
class NoCommonRoot(BzrError):
313
def __init__(self, revision_a, revision_b):
314
msg = "Revisions are not derived from the same root: %s %s." \
315
% (revision_a, revision_b)
316
BzrError.__init__(self, msg)
319
class NotAncestor(BzrError):
320
def __init__(self, rev_id, not_ancestor_id):
321
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
323
BzrError.__init__(self, msg)
325
self.not_ancestor_id = not_ancestor_id
328
class InstallFailed(BzrError):
329
def __init__(self, revisions):
330
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
331
BzrError.__init__(self, msg)
332
self.revisions = revisions
335
class AmbiguousBase(BzrError):
336
def __init__(self, bases):
337
msg = "The correct base is unclear, becase %s are all equally close" %\
339
BzrError.__init__(self, msg)
343
class NoCommits(BzrError):
344
def __init__(self, branch):
345
msg = "Branch %s has no commits." % branch
346
BzrError.__init__(self, msg)
349
class UnlistableStore(BzrError):
350
def __init__(self, store):
351
BzrError.__init__(self, "Store %s is not listable" % store)
354
class UnlistableBranch(BzrError):
355
def __init__(self, br):
356
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
359
class WeaveError(BzrNewError):
360
"""Error in processing weave: %(message)s"""
361
def __init__(self, message=None):
362
BzrNewError.__init__(self)
363
self.message = message
366
class WeaveRevisionAlreadyPresent(WeaveError):
367
"""Revision {%(revision_id)s} already present in %(weave)s"""
368
def __init__(self, revision_id, weave):
369
WeaveError.__init__(self)
370
self.revision_id = revision_id
374
class WeaveRevisionNotPresent(WeaveError):
375
"""Revision {%(revision_id)s} not present in %(weave)s"""
376
def __init__(self, revision_id, weave):
377
WeaveError.__init__(self)
378
self.revision_id = revision_id
382
class WeaveFormatError(WeaveError):
383
"""Weave invariant violated: %(what)s"""
384
def __init__(self, what):
385
WeaveError.__init__(self)
389
class WeaveParentMismatch(WeaveError):
390
"""Parents are mismatched between two revisions."""
393
class WeaveInvalidChecksum(WeaveError):
394
"""Text did not match it's checksum: %(message)s"""
397
class NoSuchExportFormat(BzrNewError):
398
"""Export format %(format)r not supported"""
399
def __init__(self, format):
400
BzrNewError.__init__(self)
404
class TransportError(BzrError):
405
"""All errors thrown by Transport implementations should derive
408
def __init__(self, msg=None, orig_error=None):
409
if msg is None and orig_error is not None:
410
msg = str(orig_error)
411
BzrError.__init__(self, msg)
413
self.orig_error = orig_error
416
# A set of semi-meaningful errors which can be thrown
417
class TransportNotPossible(TransportError):
418
"""This is for transports where a specific function is explicitly not
419
possible. Such as pushing files to an HTTP server.
424
class ConnectionError(TransportError):
425
"""A connection problem prevents file retrieval.
426
This does not indicate whether the file exists or not; it indicates that a
427
precondition for requesting the file was not met.
429
def __init__(self, msg=None, orig_error=None):
430
TransportError.__init__(self, msg=msg, orig_error=orig_error)
433
class ConnectionReset(TransportError):
434
"""The connection has been closed."""
438
class ConflictsInTree(BzrError):
440
BzrError.__init__(self, "Working tree has conflicts.")
443
class ParseConfigError(BzrError):
444
def __init__(self, errors, filename):
447
message = "Error(s) parsing config file %s:\n%s" % \
448
(filename, ('\n'.join(e.message for e in errors)))
449
BzrError.__init__(self, message)
452
class SigningFailed(BzrError):
453
def __init__(self, command_line):
454
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
458
class WorkingTreeNotRevision(BzrError):
459
def __init__(self, tree):
460
BzrError.__init__(self, "The working tree for %s has changed since"
461
" last commit, but weave merge requires that it be"
462
" unchanged." % tree.basedir)
465
class CantReprocessAndShowBase(BzrNewError):
466
"""Can't reprocess and show base.
467
Reprocessing obscures relationship of conflicting lines to base."""
470
class GraphCycleError(BzrNewError):
471
"""Cycle in graph %(graph)r"""
472
def __init__(self, graph):
473
BzrNewError.__init__(self)
477
class NotConflicted(BzrNewError):
478
"""File %(filename)s is not conflicted."""
480
def __init__(self, filename):
481
BzrNewError.__init__(self)
482
self.filename = filename
485
class MustUseDecorated(Exception):
486
"""A decorating function has requested its original command be used.
488
This should never escape bzr, so does not need to be printable.
492
class MissingText(BzrNewError):
493
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
495
def __init__(self, branch, text_revision, file_id):
496
BzrNewError.__init__(self)
498
self.base = branch.base
499
self.text_revision = text_revision
500
self.file_id = file_id
503
class BzrBadParameter(BzrNewError):
504
"""A bad parameter : %(param)s is not usable.
506
This exception should never be thrown, but it is a base class for all
507
parameter-to-function errors.
509
def __init__(self, param):
510
BzrNewError.__init__(self)
514
class BzrBadParameterNotUnicode(BzrBadParameter):
515
"""Parameter %(param)s is neither unicode nor utf8."""
518
class BzrBadParameterNotString(BzrBadParameter):
519
"""Parameter %(param)s is not a string or unicode string."""
522
class DependencyNotPresent(BzrNewError):
523
"""Unable to import library: %(library)s, %(error)s"""
525
def __init__(self, library, error):
526
BzrNewError.__init__(self, library=library, error=error)
529
class ParamikoNotPresent(DependencyNotPresent):
530
"""Unable to import paramiko (required for sftp support): %(error)s"""
532
def __init__(self, error):
533
DependencyNotPresent.__init__(self, 'paramiko', error)
536
class UninitializableFormat(BzrNewError):
537
"""Format %(format)s cannot be initialised by this version of bzr."""
539
def __init__(self, format):
540
BzrNewError.__init__(self)
added
removed
bzrlib/errors.py
