1
# Copyright (C) 2005, 2006 Canonical
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"""
109
def __init__(self, message):
110
BzrNewError.__init__(self)
111
self.message = message
114
class InvalidEntryName(BzrNewError):
115
"""Invalid entry name: %(name)s"""
116
def __init__(self, name):
117
BzrNewError.__init__(self)
121
class InvalidRevisionNumber(BzrNewError):
122
"""Invalid revision number %(revno)d"""
123
def __init__(self, revno):
124
BzrNewError.__init__(self)
128
class InvalidRevisionId(BzrNewError):
129
"""Invalid revision-id {%(revision_id)s} in %(branch)s"""
130
def __init__(self, revision_id, branch):
131
BzrNewError.__init__(self)
132
self.revision_id = revision_id
136
class NoWorkingTree(BzrNewError):
137
"""No WorkingTree exists for %s(base)."""
139
def __init__(self, base):
140
BzrNewError.__init__(self)
144
class NotLocalUrl(BzrNewError):
145
"""%s(url) is not a local path."""
147
def __init__(self, url):
148
BzrNewError.__init__(self)
152
class BzrCommandError(BzrError):
153
# Error from malformed user command
154
# This is being misused as a generic exception
155
# pleae subclass. RBC 20051030
157
# I think it's a waste of effort to differentiate between errors that
158
# are not intended to be caught anyway. UI code need not subclass
159
# BzrCommandError, and non-UI code should not throw a subclass of
160
# BzrCommandError. ADHB 20051211
165
class BzrOptionError(BzrCommandError):
166
"""Some missing or otherwise incorrect option was supplied."""
169
class StrictCommitFailed(Exception):
170
"""Commit refused because there are unknowns in the tree."""
173
class PathError(BzrNewError):
174
"""Generic path error: %(path)r%(extra)s)"""
175
def __init__(self, path, extra=None):
176
BzrNewError.__init__(self)
179
self.extra = ': ' + str(extra)
184
class NoSuchFile(PathError):
185
"""No such file: %(path)r%(extra)s"""
188
class FileExists(PathError):
189
"""File exists: %(path)r%(extra)s"""
192
class DirectoryNotEmpty(PathError):
193
"""Directory not empty: %(path)r%(extra)s"""
196
class PermissionDenied(PathError):
197
"""Permission denied: %(path)r%(extra)s"""
200
class PathNotChild(BzrNewError):
201
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
202
def __init__(self, path, base, extra=None):
203
BzrNewError.__init__(self)
207
self.extra = ': ' + str(extra)
212
class NotBranchError(BzrNewError):
213
"""Not a branch: %(path)s"""
214
def __init__(self, path):
215
BzrNewError.__init__(self)
219
class NoRepositoryPresent(BzrNewError):
220
"""Not repository present: %(path)r"""
221
def __init__(self, bzrdir):
222
BzrNewError.__init__(self)
223
self.path = bzrdir.transport.clone('..').base
226
class FileInWrongBranch(BzrNewError):
227
"""File %(path)s in not in branch %(branch_base)s."""
229
def __init__(self, branch, path):
230
BzrNewError.__init__(self)
232
self.branch_base = branch.base
236
class UnsupportedFormatError(BzrError):
237
"""Specified path is a bzr branch that we recognize but cannot read."""
239
return 'unsupported branch format: %s' % self.args[0]
242
class UnknownFormatError(BzrError):
243
"""Specified path is a bzr branch whose format we do not recognize."""
245
return 'unknown branch format: %s' % self.args[0]
248
class IncompatibleFormat(BzrNewError):
249
"""Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
251
def __init__(self, format, bzrdir_format):
252
BzrNewError.__init__(self)
254
self.bzrdir = bzrdir_format
257
class NotVersionedError(BzrNewError):
258
"""%(path)s is not versioned"""
259
def __init__(self, path):
260
BzrNewError.__init__(self)
264
class BadFileKindError(BzrError):
265
"""Specified file is of a kind that cannot be added.
267
(For example a symlink or device file.)"""
270
class ForbiddenFileError(BzrError):
271
"""Cannot operate on a file because it is a control file."""
274
class LockError(BzrNewError):
275
"""Lock error: %(message)s"""
276
# All exceptions from the lock/unlock functions should be from
277
# this exception class. They will be translated as necessary. The
278
# original exception is available as e.original_error
280
# New code should prefer to raise specific subclasses
281
def __init__(self, message):
282
self.message = message
285
class CommitNotPossible(LockError):
286
"""A commit was attempted but we do not have a write lock open."""
291
class AlreadyCommitted(LockError):
292
"""A rollback was requested, but is not able to be accomplished."""
297
class ReadOnlyError(LockError):
298
"""A write attempt was made in a read only transaction on %(obj)s"""
299
def __init__(self, obj):
303
class OutSideTransaction(BzrNewError):
304
"""A transaction related operation was attempted after the transaction finished."""
307
class ObjectNotLocked(LockError):
308
"""%(obj)r is not locked"""
309
# this can indicate that any particular object is not locked; see also
310
# LockNotHeld which means that a particular *lock* object is not held by
311
# the caller -- perhaps they should be unified.
312
def __init__(self, obj):
316
class ReadOnlyObjectDirtiedError(ReadOnlyError):
317
"""Cannot change object %(obj)r in read only transaction"""
318
def __init__(self, obj):
322
class UnlockableTransport(LockError):
323
"""Cannot lock: transport is read only: %(transport)s"""
324
def __init__(self, transport):
325
self.transport = transport
328
class LockContention(LockError):
329
"""Could not acquire lock %(lock)s"""
330
# TODO: show full url for lock, combining the transport and relative bits?
331
def __init__(self, lock):
335
class LockBroken(LockError):
336
"""Lock was broken while still open: %(lock)s - check storage consistency!"""
337
def __init__(self, lock):
341
class LockBreakMismatch(LockError):
342
"""Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
343
def __init__(self, lock, holder, target):
349
class LockNotHeld(LockError):
350
"""Lock not held: %(lock)s"""
351
def __init__(self, lock):
355
class PointlessCommit(BzrNewError):
356
"""No changes to commit"""
359
class UpgradeReadonly(BzrNewError):
360
"""Upgrade URL cannot work with readonly URL's."""
363
class UpToDateFormat(BzrNewError):
364
"""The branch format %(format)s is already at the most recent format."""
366
def __init__(self, format):
367
BzrNewError.__init__(self)
372
class StrictCommitFailed(Exception):
373
"""Commit refused because there are unknowns in the tree."""
376
class NoSuchRevision(BzrError):
377
def __init__(self, branch, revision):
379
self.revision = revision
380
msg = "Branch %s has no revision %s" % (branch, revision)
381
BzrError.__init__(self, msg)
384
class HistoryMissing(BzrError):
385
def __init__(self, branch, object_type, object_id):
387
BzrError.__init__(self,
388
'%s is missing %s {%s}'
389
% (branch, object_type, object_id))
392
class DivergedBranches(BzrError):
393
def __init__(self, branch1, branch2):
394
BzrError.__init__(self, "These branches have diverged. Try merge.")
395
self.branch1 = branch1
396
self.branch2 = branch2
399
class UnrelatedBranches(BzrCommandError):
401
msg = "Branches have no common ancestor, and no base revision"\
403
BzrCommandError.__init__(self, msg)
406
class NoCommonAncestor(BzrError):
407
def __init__(self, revision_a, revision_b):
408
msg = "Revisions have no common ancestor: %s %s." \
409
% (revision_a, revision_b)
410
BzrError.__init__(self, msg)
413
class NoCommonRoot(BzrError):
414
def __init__(self, revision_a, revision_b):
415
msg = "Revisions are not derived from the same root: %s %s." \
416
% (revision_a, revision_b)
417
BzrError.__init__(self, msg)
421
class NotAncestor(BzrError):
422
def __init__(self, rev_id, not_ancestor_id):
423
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
425
BzrError.__init__(self, msg)
427
self.not_ancestor_id = not_ancestor_id
430
class InstallFailed(BzrError):
431
def __init__(self, revisions):
432
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
433
BzrError.__init__(self, msg)
434
self.revisions = revisions
437
class AmbiguousBase(BzrError):
438
def __init__(self, bases):
439
msg = "The correct base is unclear, becase %s are all equally close" %\
441
BzrError.__init__(self, msg)
445
class NoCommits(BzrError):
446
def __init__(self, branch):
447
msg = "Branch %s has no commits." % branch
448
BzrError.__init__(self, msg)
451
class UnlistableStore(BzrError):
452
def __init__(self, store):
453
BzrError.__init__(self, "Store %s is not listable" % store)
457
class UnlistableBranch(BzrError):
458
def __init__(self, br):
459
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
462
class BoundBranchOutOfDate(BzrNewError):
463
"""Bound branch %(branch)s is out of date with master branch %(master)s."""
464
def __init__(self, branch, master):
465
BzrNewError.__init__(self)
470
class CommitToDoubleBoundBranch(BzrNewError):
471
"""Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
472
def __init__(self, branch, master, remote):
473
BzrNewError.__init__(self)
479
class OverwriteBoundBranch(BzrNewError):
480
"""Cannot pull --overwrite to a branch which is bound %(branch)s"""
481
def __init__(self, branch):
482
BzrNewError.__init__(self)
486
class BoundBranchConnectionFailure(BzrNewError):
487
"""Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
488
def __init__(self, branch, target, error):
489
BzrNewError.__init__(self)
495
class WeaveError(BzrNewError):
496
"""Error in processing weave: %(message)s"""
498
def __init__(self, message=None):
499
BzrNewError.__init__(self)
500
self.message = message
503
class WeaveRevisionAlreadyPresent(WeaveError):
504
"""Revision {%(revision_id)s} already present in %(weave)s"""
505
def __init__(self, revision_id, weave):
507
WeaveError.__init__(self)
508
self.revision_id = revision_id
512
class WeaveRevisionNotPresent(WeaveError):
513
"""Revision {%(revision_id)s} not present in %(weave)s"""
515
def __init__(self, revision_id, weave):
516
WeaveError.__init__(self)
517
self.revision_id = revision_id
521
class WeaveFormatError(WeaveError):
522
"""Weave invariant violated: %(what)s"""
524
def __init__(self, what):
525
WeaveError.__init__(self)
529
class WeaveParentMismatch(WeaveError):
530
"""Parents are mismatched between two revisions."""
533
class WeaveInvalidChecksum(WeaveError):
534
"""Text did not match it's checksum: %(message)s"""
537
class WeaveTextDiffers(WeaveError):
538
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
540
def __init__(self, revision_id, weave_a, weave_b):
541
WeaveError.__init__(self)
542
self.revision_id = revision_id
543
self.weave_a = weave_a
544
self.weave_b = weave_b
547
class WeaveTextDiffers(WeaveError):
548
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
550
def __init__(self, revision_id, weave_a, weave_b):
551
WeaveError.__init__(self)
552
self.revision_id = revision_id
553
self.weave_a = weave_a
554
self.weave_b = weave_b
557
class VersionedFileError(BzrNewError):
558
"""Versioned file error."""
561
class RevisionNotPresent(VersionedFileError):
562
"""Revision {%(revision_id)s} not present in %(file_id)s."""
564
def __init__(self, revision_id, file_id):
565
VersionedFileError.__init__(self)
566
self.revision_id = revision_id
567
self.file_id = file_id
570
class RevisionAlreadyPresent(VersionedFileError):
571
"""Revision {%(revision_id)s} already present in %(file_id)s."""
573
def __init__(self, revision_id, file_id):
574
VersionedFileError.__init__(self)
575
self.revision_id = revision_id
576
self.file_id = file_id
579
class KnitError(BzrNewError):
583
class KnitHeaderError(KnitError):
584
"""Knit header error: %(badline)r unexpected"""
586
def __init__(self, badline):
587
KnitError.__init__(self)
588
self.badline = badline
591
class KnitCorrupt(KnitError):
592
"""Knit %(filename)s corrupt: %(how)s"""
594
def __init__(self, filename, how):
595
KnitError.__init__(self)
596
self.filename = filename
600
class NoSuchExportFormat(BzrNewError):
601
"""Export format %(format)r not supported"""
602
def __init__(self, format):
603
BzrNewError.__init__(self)
607
class TransportError(BzrError):
608
"""All errors thrown by Transport implementations should derive
611
def __init__(self, msg=None, orig_error=None):
612
if msg is None and orig_error is not None:
613
msg = str(orig_error)
614
BzrError.__init__(self, msg)
616
self.orig_error = orig_error
619
# A set of semi-meaningful errors which can be thrown
620
class TransportNotPossible(TransportError):
621
"""This is for transports where a specific function is explicitly not
622
possible. Such as pushing files to an HTTP server.
627
class ConnectionError(TransportError):
628
"""A connection problem prevents file retrieval.
629
This does not indicate whether the file exists or not; it indicates that a
630
precondition for requesting the file was not met.
632
def __init__(self, msg=None, orig_error=None):
633
TransportError.__init__(self, msg=msg, orig_error=orig_error)
636
class ConnectionReset(TransportError):
637
"""The connection has been closed."""
641
class ConflictsInTree(BzrError):
643
BzrError.__init__(self, "Working tree has conflicts.")
646
class ParseConfigError(BzrError):
647
def __init__(self, errors, filename):
650
message = "Error(s) parsing config file %s:\n%s" % \
651
(filename, ('\n'.join(e.message for e in errors)))
652
BzrError.__init__(self, message)
655
class SigningFailed(BzrError):
656
def __init__(self, command_line):
657
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
661
class WorkingTreeNotRevision(BzrError):
662
def __init__(self, tree):
663
BzrError.__init__(self, "The working tree for %s has changed since"
664
" last commit, but weave merge requires that it be"
665
" unchanged." % tree.basedir)
668
class CantReprocessAndShowBase(BzrNewError):
669
"""Can't reprocess and show base.
670
Reprocessing obscures relationship of conflicting lines to base."""
673
class GraphCycleError(BzrNewError):
674
"""Cycle in graph %(graph)r"""
675
def __init__(self, graph):
676
BzrNewError.__init__(self)
680
class NotConflicted(BzrNewError):
681
"""File %(filename)s is not conflicted."""
683
def __init__(self, filename):
684
BzrNewError.__init__(self)
685
self.filename = filename
688
class MustUseDecorated(Exception):
689
"""A decorating function has requested its original command be used.
691
This should never escape bzr, so does not need to be printable.
695
class MissingText(BzrNewError):
696
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
698
def __init__(self, branch, text_revision, file_id):
699
BzrNewError.__init__(self)
701
self.base = branch.base
702
self.text_revision = text_revision
703
self.file_id = file_id
706
class DuplicateKey(BzrNewError):
707
"""Key %(key)s is already present in map"""
710
class MalformedTransform(BzrNewError):
711
"""Tree transform is malformed %(conflicts)r"""
714
class BzrBadParameter(BzrNewError):
715
"""A bad parameter : %(param)s is not usable.
717
This exception should never be thrown, but it is a base class for all
718
parameter-to-function errors.
720
def __init__(self, param):
721
BzrNewError.__init__(self)
725
class BzrBadParameterNotUnicode(BzrBadParameter):
726
"""Parameter %(param)s is neither unicode nor utf8."""
729
class ReusingTransform(BzrNewError):
730
"""Attempt to reuse a transform that has already been applied."""
733
class CantMoveRoot(BzrNewError):
734
"""Moving the root directory is not supported at this time"""
737
class BzrBadParameterNotString(BzrBadParameter):
738
"""Parameter %(param)s is not a string or unicode string."""
741
class BzrBadParameterMissing(BzrBadParameter):
742
"""Parameter $(param)s is required but not present."""
745
class DependencyNotPresent(BzrNewError):
746
"""Unable to import library: %(library)s, %(error)s"""
748
def __init__(self, library, error):
749
BzrNewError.__init__(self, library=library, error=error)
752
class ParamikoNotPresent(DependencyNotPresent):
753
"""Unable to import paramiko (required for sftp support): %(error)s"""
755
def __init__(self, error):
756
DependencyNotPresent.__init__(self, 'paramiko', error)
759
class UninitializableFormat(BzrNewError):
760
"""Format %(format)s cannot be initialised by this version of bzr."""
762
def __init__(self, format):
763
BzrNewError.__init__(self)
767
class NoDiff3(BzrNewError):
768
"""Diff3 is not installed on this machine."""
771
class ExistingLimbo(BzrNewError):
772
"""This tree contains left-over files from a failed operation.
773
Please examine %(limbo_dir)s to see if it contains any files you wish to
774
keep, and delete it when you are done.
776
def __init__(self, limbo_dir):
777
BzrNewError.__init__(self)
778
self.limbo_dir = limbo_dir
781
class ImmortalLimbo(BzrNewError):
782
"""Unable to delete transform temporary directory $(limbo_dir)s.
783
Please examine %(limbo_dir)s to see if it contains any files you wish to
784
keep, and delete it when you are done.
786
def __init__(self, limbo_dir):
787
BzrNewError.__init__(self)
788
self.limbo_dir = limbo_dir
791
class OutOfDateTree(BzrNewError):
792
"""Working tree is out of date, please run 'bzr update'."""
794
def __init__(self, tree):
795
BzrNewError.__init__(self)
799
class MergeModifiedFormatError(BzrNewError):
800
"""Error in merge modified format"""
803
class CorruptRepository(BzrNewError):
804
"""An error has been detected in the repository %(repo_path)s.
805
Please run bzr reconcile on this repository."""
807
def __init__(self, repo):
808
BzrNewError.__init__(self)
809
self.repo_path = repo.bzrdir.root_transport.base
812
class UpgradeRequired(BzrNewError):
813
"""To use this feature you must upgrade your branch at %(path)s."""
815
def __init__(self, path):
816
BzrNewError.__init__(self)
820
class LocalRequiresBoundBranch(BzrNewError):
821
"""Cannot perform local-only commits on unbound branches."""
824
class MissingProgressBarFinish(BzrNewError):
825
"""A nested progress bar was not 'finished' correctly."""
added
removed
bzrlib/errors.py
