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 DirectoryNotEmpty(PathError):
184
"""Directory not empty: %(path)r%(extra)s"""
187
class PermissionDenied(PathError):
188
"""Permission denied: %(path)r%(extra)s"""
191
class PathNotChild(BzrNewError):
192
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
193
def __init__(self, path, base, extra=None):
194
BzrNewError.__init__(self)
198
self.extra = ': ' + str(extra)
203
class NotBranchError(BzrNewError):
204
"""Not a branch: %(path)s"""
205
def __init__(self, path):
206
BzrNewError.__init__(self)
210
class FileInWrongBranch(BzrNewError):
211
"""File %(path)s in not in branch %(branch_base)s."""
212
def __init__(self, branch, path):
213
BzrNewError.__init__(self)
215
self.branch_base = branch.base
219
class UnsupportedFormatError(BzrError):
220
"""Specified path is a bzr branch that we recognize but cannot read."""
222
return 'unsupported branch format: %s' % self.args[0]
225
class UnknownFormatError(BzrError):
226
"""Specified path is a bzr branch whose format we do not recognize."""
228
return 'unknown branch format: %s' % self.args[0]
231
class NotVersionedError(BzrNewError):
232
"""%(path)s is not versioned"""
233
def __init__(self, path):
234
BzrNewError.__init__(self)
238
class BadFileKindError(BzrError):
239
"""Specified file is of a kind that cannot be added.
241
(For example a symlink or device file.)"""
244
class ForbiddenFileError(BzrError):
245
"""Cannot operate on a file because it is a control file."""
248
class LockError(BzrNewError):
249
"""Lock error: %(message)s"""
250
# All exceptions from the lock/unlock functions should be from
251
# this exception class. They will be translated as necessary. The
252
# original exception is available as e.original_error
254
# New code should prefer to raise specific subclasses
255
def __init__(self, message):
256
self.message = message
259
class CommitNotPossible(LockError):
260
"""A commit was attempted but we do not have a write lock open."""
265
class AlreadyCommitted(LockError):
266
"""A rollback was requested, but is not able to be accomplished."""
271
class ReadOnlyError(LockError):
272
"""A write attempt was made in a read only transaction."""
277
class BranchNotLocked(LockError):
278
"""Branch %(branch)r is not locked"""
279
def __init__(self, branch):
280
# XXX: sometimes called with a LockableFiles instance not a Branch
284
class ReadOnlyObjectDirtiedError(ReadOnlyError):
285
"""Cannot change object %(obj)r in read only transaction"""
286
def __init__(self, obj):
290
class UnlockableTransport(LockError):
291
"""Cannot lock: transport is read only: %(transport)s"""
292
def __init__(self, transport):
293
self.transport = transport
296
class LockContention(LockError):
297
"""Could not acquire lock %(lock)s"""
298
# TODO: show full url for lock, combining the transport and relative bits?
299
def __init__(self, lock):
303
class LockNotHeld(LockError):
304
"""Lock not held: %(lock)s"""
305
def __init__(self, lock):
309
class BranchNotLocked(LockError):
310
"""Branch %(branch)r not locked"""
311
def __init__(self, branch):
315
class PointlessCommit(BzrNewError):
316
"""No changes to commit"""
319
class UpgradeReadonly(BzrNewError):
320
"""Upgrade URL cannot work with readonly URL's."""
323
class StrictCommitFailed(Exception):
324
"""Commit refused because there are unknowns in the tree."""
327
class NoSuchRevision(BzrError):
328
def __init__(self, branch, revision):
330
self.revision = revision
331
msg = "Branch %s has no revision %s" % (branch, revision)
332
BzrError.__init__(self, msg)
335
class HistoryMissing(BzrError):
336
def __init__(self, branch, object_type, object_id):
338
BzrError.__init__(self,
339
'%s is missing %s {%s}'
340
% (branch, object_type, object_id))
343
class DivergedBranches(BzrError):
344
def __init__(self, branch1, branch2):
345
BzrError.__init__(self, "These branches have diverged. Try merge.")
346
self.branch1 = branch1
347
self.branch2 = branch2
350
class UnrelatedBranches(BzrCommandError):
352
msg = "Branches have no common ancestor, and no base revision"\
354
BzrCommandError.__init__(self, msg)
356
class NoCommonAncestor(BzrError):
357
def __init__(self, revision_a, revision_b):
358
msg = "Revisions have no common ancestor: %s %s." \
359
% (revision_a, revision_b)
360
BzrError.__init__(self, msg)
362
class NoCommonRoot(BzrError):
363
def __init__(self, revision_a, revision_b):
364
msg = "Revisions are not derived from the same root: %s %s." \
365
% (revision_a, revision_b)
366
BzrError.__init__(self, msg)
368
class NotAncestor(BzrError):
369
def __init__(self, rev_id, not_ancestor_id):
370
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
372
BzrError.__init__(self, msg)
374
self.not_ancestor_id = not_ancestor_id
377
class InstallFailed(BzrError):
378
def __init__(self, revisions):
379
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
380
BzrError.__init__(self, msg)
381
self.revisions = revisions
384
class AmbiguousBase(BzrError):
385
def __init__(self, bases):
386
msg = "The correct base is unclear, becase %s are all equally close" %\
388
BzrError.__init__(self, msg)
391
class NoCommits(BzrError):
392
def __init__(self, branch):
393
msg = "Branch %s has no commits." % branch
394
BzrError.__init__(self, msg)
396
class UnlistableStore(BzrError):
397
def __init__(self, store):
398
BzrError.__init__(self, "Store %s is not listable" % store)
400
class UnlistableBranch(BzrError):
401
def __init__(self, br):
402
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
405
class WeaveError(BzrNewError):
406
"""Error in processing weave: %(message)s"""
407
def __init__(self, message=None):
408
BzrNewError.__init__(self)
409
self.message = message
412
class WeaveRevisionAlreadyPresent(WeaveError):
413
"""Revision {%(revision_id)s} already present in %(weave)s"""
414
def __init__(self, revision_id, weave):
415
WeaveError.__init__(self)
416
self.revision_id = revision_id
420
class WeaveRevisionNotPresent(WeaveError):
421
"""Revision {%(revision_id)s} not present in %(weave)s"""
422
def __init__(self, revision_id, weave):
423
WeaveError.__init__(self)
424
self.revision_id = revision_id
428
class WeaveFormatError(WeaveError):
429
"""Weave invariant violated: %(what)s"""
430
def __init__(self, what):
431
WeaveError.__init__(self)
435
class WeaveParentMismatch(WeaveError):
436
"""Parents are mismatched between two revisions."""
439
class WeaveInvalidChecksum(WeaveError):
440
"""Text did not match it's checksum: %(message)s"""
443
class WeaveTextDiffers(WeaveError):
444
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
446
def __init__(self, revision_id, weave_a, weave_b):
447
WeaveError.__init__(self)
448
self.revision_id = revision_id
449
self.weave_a = weave_a
450
self.weave_b = weave_b
453
class NoSuchExportFormat(BzrNewError):
454
"""Export format %(format)r not supported"""
455
def __init__(self, format):
456
BzrNewError.__init__(self)
460
class TransportError(BzrError):
461
"""All errors thrown by Transport implementations should derive
464
def __init__(self, msg=None, orig_error=None):
465
if msg is None and orig_error is not None:
466
msg = str(orig_error)
467
BzrError.__init__(self, msg)
469
self.orig_error = orig_error
471
# A set of semi-meaningful errors which can be thrown
472
class TransportNotPossible(TransportError):
473
"""This is for transports where a specific function is explicitly not
474
possible. Such as pushing files to an HTTP server.
479
class ConnectionError(TransportError):
480
"""A connection problem prevents file retrieval.
481
This does not indicate whether the file exists or not; it indicates that a
482
precondition for requesting the file was not met.
484
def __init__(self, msg=None, orig_error=None):
485
TransportError.__init__(self, msg=msg, orig_error=orig_error)
488
class ConnectionReset(TransportError):
489
"""The connection has been closed."""
492
class ConflictsInTree(BzrError):
494
BzrError.__init__(self, "Working tree has conflicts.")
496
class ParseConfigError(BzrError):
497
def __init__(self, errors, filename):
500
message = "Error(s) parsing config file %s:\n%s" % \
501
(filename, ('\n'.join(e.message for e in errors)))
502
BzrError.__init__(self, message)
504
class SigningFailed(BzrError):
505
def __init__(self, command_line):
506
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
509
class WorkingTreeNotRevision(BzrError):
510
def __init__(self, tree):
511
BzrError.__init__(self, "The working tree for %s has changed since"
512
" last commit, but weave merge requires that it be"
513
" unchanged." % tree.basedir)
515
class CantReprocessAndShowBase(BzrNewError):
516
"""Can't reprocess and show base.
517
Reprocessing obscures relationship of conflicting lines to base."""
519
class GraphCycleError(BzrNewError):
520
"""Cycle in graph %(graph)r"""
521
def __init__(self, graph):
522
BzrNewError.__init__(self)
526
class NotConflicted(BzrNewError):
527
"""File %(filename)s is not conflicted."""
529
def __init__(self, filename):
530
BzrNewError.__init__(self)
531
self.filename = filename
534
class MustUseDecorated(Exception):
535
"""A decorating function has requested its original command be used.
537
This should never escape bzr, so does not need to be printable.
541
class MissingText(BzrNewError):
542
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
544
def __init__(self, branch, text_revision, file_id):
545
BzrNewError.__init__(self)
547
self.base = branch.base
548
self.text_revision = text_revision
549
self.file_id = file_id
552
class BzrBadParameter(BzrNewError):
553
"""A bad parameter : %(param)s is not usable.
555
This exception should never be thrown, but it is a base class for all
556
parameter-to-function errors.
558
def __init__(self, param):
559
BzrNewError.__init__(self)
563
class BzrBadParameterNotUnicode(BzrBadParameter):
564
"""Parameter %(param)s is neither unicode nor utf8."""
567
class BzrBadParameterNotString(BzrBadParameter):
568
"""Parameter %(param)s is not a string or unicode string."""
571
class DependencyNotPresent(BzrNewError):
572
"""Unable to import library: %(library)s, %(error)s"""
574
def __init__(self, library, error):
575
BzrNewError.__init__(self, library=library, error=error)
578
class ParamikoNotPresent(DependencyNotPresent):
579
"""Unable to import paramiko (required for sftp support): %(error)s"""
581
def __init__(self, error):
582
DependencyNotPresent.__init__(self, 'paramiko', error)
585
class UninitializableFormat(BzrNewError):
586
"""Format %(format)s cannot be initialised by this version of bzr."""
588
def __init__(self, format):
589
BzrNewError.__init__(self)
added
removed
bzrlib/errors.py
