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)"""
176
def __init__(self, path, extra=None):
177
BzrNewError.__init__(self)
180
self.extra = ': ' + str(extra)
185
class NoSuchFile(PathError):
186
"""No such file: %(path)r%(extra)s"""
189
class FileExists(PathError):
190
"""File exists: %(path)r%(extra)s"""
193
class DirectoryNotEmpty(PathError):
194
"""Directory not empty: %(path)r%(extra)s"""
197
class ResourceBusy(PathError):
198
"""Device or resource busy: %(path)r%(extra)s"""
201
class PermissionDenied(PathError):
202
"""Permission denied: %(path)r%(extra)s"""
205
class PathNotChild(BzrNewError):
206
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
207
def __init__(self, path, base, extra=None):
208
BzrNewError.__init__(self)
212
self.extra = ': ' + str(extra)
217
class NotBranchError(PathError):
218
"""Not a branch: %(path)s"""
221
class AlreadyBranchError(PathError):
222
"""Already a branch: %(path)s. Use `bzr checkout` to build a working tree."""
225
class NoRepositoryPresent(BzrNewError):
226
"""Not repository present: %(path)r"""
227
def __init__(self, bzrdir):
228
BzrNewError.__init__(self)
229
self.path = bzrdir.transport.clone('..').base
232
class FileInWrongBranch(BzrNewError):
233
"""File %(path)s in not in branch %(branch_base)s."""
235
def __init__(self, branch, path):
236
BzrNewError.__init__(self)
238
self.branch_base = branch.base
242
class UnsupportedFormatError(BzrError):
243
"""Specified path is a bzr branch that we recognize but cannot read."""
245
return 'unsupported branch format: %s' % self.args[0]
248
class UnknownFormatError(BzrError):
249
"""Specified path is a bzr branch whose format we do not recognize."""
251
return 'unknown branch format: %s' % self.args[0]
254
class IncompatibleFormat(BzrNewError):
255
"""Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
257
def __init__(self, format, bzrdir_format):
258
BzrNewError.__init__(self)
260
self.bzrdir = bzrdir_format
263
class NotVersionedError(BzrNewError):
264
"""%(path)s is not versioned"""
265
def __init__(self, path):
266
BzrNewError.__init__(self)
270
class BadFileKindError(BzrError):
271
"""Specified file is of a kind that cannot be added.
273
(For example a symlink or device file.)"""
276
class ForbiddenFileError(BzrError):
277
"""Cannot operate on a file because it is a control file."""
280
class LockError(BzrNewError):
281
"""Lock error: %(message)s"""
282
# All exceptions from the lock/unlock functions should be from
283
# this exception class. They will be translated as necessary. The
284
# original exception is available as e.original_error
286
# New code should prefer to raise specific subclasses
287
def __init__(self, message):
288
self.message = message
291
class CommitNotPossible(LockError):
292
"""A commit was attempted but we do not have a write lock open."""
297
class AlreadyCommitted(LockError):
298
"""A rollback was requested, but is not able to be accomplished."""
303
class ReadOnlyError(LockError):
304
"""A write attempt was made in a read only transaction on %(obj)s"""
305
def __init__(self, obj):
309
class OutSideTransaction(BzrNewError):
310
"""A transaction related operation was attempted after the transaction finished."""
313
class ObjectNotLocked(LockError):
314
"""%(obj)r is not locked"""
315
# this can indicate that any particular object is not locked; see also
316
# LockNotHeld which means that a particular *lock* object is not held by
317
# the caller -- perhaps they should be unified.
318
def __init__(self, obj):
322
class ReadOnlyObjectDirtiedError(ReadOnlyError):
323
"""Cannot change object %(obj)r in read only transaction"""
324
def __init__(self, obj):
328
class UnlockableTransport(LockError):
329
"""Cannot lock: transport is read only: %(transport)s"""
330
def __init__(self, transport):
331
self.transport = transport
334
class LockContention(LockError):
335
"""Could not acquire lock %(lock)s"""
336
# TODO: show full url for lock, combining the transport and relative bits?
337
def __init__(self, lock):
341
class LockBroken(LockError):
342
"""Lock was broken while still open: %(lock)s - check storage consistency!"""
343
def __init__(self, lock):
347
class LockBreakMismatch(LockError):
348
"""Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
349
def __init__(self, lock, holder, target):
355
class LockNotHeld(LockError):
356
"""Lock not held: %(lock)s"""
357
def __init__(self, lock):
361
class PointlessCommit(BzrNewError):
362
"""No changes to commit"""
365
class UpgradeReadonly(BzrNewError):
366
"""Upgrade URL cannot work with readonly URL's."""
369
class UpToDateFormat(BzrNewError):
370
"""The branch format %(format)s is already at the most recent format."""
372
def __init__(self, format):
373
BzrNewError.__init__(self)
378
class StrictCommitFailed(Exception):
379
"""Commit refused because there are unknowns in the tree."""
382
class NoSuchRevision(BzrError):
383
def __init__(self, branch, revision):
385
self.revision = revision
386
msg = "Branch %s has no revision %s" % (branch, revision)
387
BzrError.__init__(self, msg)
390
class HistoryMissing(BzrError):
391
def __init__(self, branch, object_type, object_id):
393
BzrError.__init__(self,
394
'%s is missing %s {%s}'
395
% (branch, object_type, object_id))
398
class DivergedBranches(BzrError):
400
def __init__(self, branch1, branch2):
401
BzrError.__init__(self, "These branches have diverged. Try merge.")
402
self.branch1 = branch1
403
self.branch2 = branch2
406
class UnrelatedBranches(BzrCommandError):
408
msg = "Branches have no common ancestor, and no base revision"\
410
BzrCommandError.__init__(self, msg)
413
class NoCommonAncestor(BzrError):
414
def __init__(self, revision_a, revision_b):
415
msg = "Revisions have no common ancestor: %s %s." \
416
% (revision_a, revision_b)
417
BzrError.__init__(self, msg)
420
class NoCommonRoot(BzrError):
421
def __init__(self, revision_a, revision_b):
422
msg = "Revisions are not derived from the same root: %s %s." \
423
% (revision_a, revision_b)
424
BzrError.__init__(self, msg)
428
class NotAncestor(BzrError):
429
def __init__(self, rev_id, not_ancestor_id):
430
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
432
BzrError.__init__(self, msg)
434
self.not_ancestor_id = not_ancestor_id
437
class InstallFailed(BzrError):
438
def __init__(self, revisions):
439
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
440
BzrError.__init__(self, msg)
441
self.revisions = revisions
444
class AmbiguousBase(BzrError):
445
def __init__(self, bases):
446
msg = "The correct base is unclear, becase %s are all equally close" %\
448
BzrError.__init__(self, msg)
452
class NoCommits(BzrError):
453
def __init__(self, branch):
454
msg = "Branch %s has no commits." % branch
455
BzrError.__init__(self, msg)
458
class UnlistableStore(BzrError):
459
def __init__(self, store):
460
BzrError.__init__(self, "Store %s is not listable" % store)
464
class UnlistableBranch(BzrError):
465
def __init__(self, br):
466
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
469
class BoundBranchOutOfDate(BzrNewError):
470
"""Bound branch %(branch)s is out of date with master branch %(master)s."""
471
def __init__(self, branch, master):
472
BzrNewError.__init__(self)
477
class CommitToDoubleBoundBranch(BzrNewError):
478
"""Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
479
def __init__(self, branch, master, remote):
480
BzrNewError.__init__(self)
486
class OverwriteBoundBranch(BzrNewError):
487
"""Cannot pull --overwrite to a branch which is bound %(branch)s"""
488
def __init__(self, branch):
489
BzrNewError.__init__(self)
493
class BoundBranchConnectionFailure(BzrNewError):
494
"""Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
495
def __init__(self, branch, target, error):
496
BzrNewError.__init__(self)
502
class WeaveError(BzrNewError):
503
"""Error in processing weave: %(message)s"""
505
def __init__(self, message=None):
506
BzrNewError.__init__(self)
507
self.message = message
510
class WeaveRevisionAlreadyPresent(WeaveError):
511
"""Revision {%(revision_id)s} already present in %(weave)s"""
512
def __init__(self, revision_id, weave):
514
WeaveError.__init__(self)
515
self.revision_id = revision_id
519
class WeaveRevisionNotPresent(WeaveError):
520
"""Revision {%(revision_id)s} not present in %(weave)s"""
522
def __init__(self, revision_id, weave):
523
WeaveError.__init__(self)
524
self.revision_id = revision_id
528
class WeaveFormatError(WeaveError):
529
"""Weave invariant violated: %(what)s"""
531
def __init__(self, what):
532
WeaveError.__init__(self)
536
class WeaveParentMismatch(WeaveError):
537
"""Parents are mismatched between two revisions."""
540
class WeaveInvalidChecksum(WeaveError):
541
"""Text did not match it's checksum: %(message)s"""
544
class WeaveTextDiffers(WeaveError):
545
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
547
def __init__(self, revision_id, weave_a, weave_b):
548
WeaveError.__init__(self)
549
self.revision_id = revision_id
550
self.weave_a = weave_a
551
self.weave_b = weave_b
554
class WeaveTextDiffers(WeaveError):
555
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
557
def __init__(self, revision_id, weave_a, weave_b):
558
WeaveError.__init__(self)
559
self.revision_id = revision_id
560
self.weave_a = weave_a
561
self.weave_b = weave_b
564
class VersionedFileError(BzrNewError):
565
"""Versioned file error."""
568
class RevisionNotPresent(VersionedFileError):
569
"""Revision {%(revision_id)s} not present in %(file_id)s."""
571
def __init__(self, revision_id, file_id):
572
VersionedFileError.__init__(self)
573
self.revision_id = revision_id
574
self.file_id = file_id
577
class RevisionAlreadyPresent(VersionedFileError):
578
"""Revision {%(revision_id)s} already present in %(file_id)s."""
580
def __init__(self, revision_id, file_id):
581
VersionedFileError.__init__(self)
582
self.revision_id = revision_id
583
self.file_id = file_id
586
class KnitError(BzrNewError):
590
class KnitHeaderError(KnitError):
591
"""Knit header error: %(badline)r unexpected"""
593
def __init__(self, badline):
594
KnitError.__init__(self)
595
self.badline = badline
598
class KnitCorrupt(KnitError):
599
"""Knit %(filename)s corrupt: %(how)s"""
601
def __init__(self, filename, how):
602
KnitError.__init__(self)
603
self.filename = filename
607
class NoSuchExportFormat(BzrNewError):
608
"""Export format %(format)r not supported"""
609
def __init__(self, format):
610
BzrNewError.__init__(self)
614
class TransportError(BzrError):
615
"""All errors thrown by Transport implementations should derive
618
def __init__(self, msg=None, orig_error=None):
619
if msg is None and orig_error is not None:
620
msg = str(orig_error)
621
BzrError.__init__(self, msg)
623
self.orig_error = orig_error
626
# A set of semi-meaningful errors which can be thrown
627
class TransportNotPossible(TransportError):
628
"""This is for transports where a specific function is explicitly not
629
possible. Such as pushing files to an HTTP server.
634
class ConnectionError(TransportError):
635
"""A connection problem prevents file retrieval.
636
This does not indicate whether the file exists or not; it indicates that a
637
precondition for requesting the file was not met.
639
def __init__(self, msg=None, orig_error=None):
640
TransportError.__init__(self, msg=msg, orig_error=orig_error)
643
class ConnectionReset(TransportError):
644
"""The connection has been closed."""
648
class ConflictsInTree(BzrError):
650
BzrError.__init__(self, "Working tree has conflicts.")
653
class ParseConfigError(BzrError):
654
def __init__(self, errors, filename):
657
message = "Error(s) parsing config file %s:\n%s" % \
658
(filename, ('\n'.join(e.message for e in errors)))
659
BzrError.__init__(self, message)
662
class SigningFailed(BzrError):
663
def __init__(self, command_line):
664
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
668
class WorkingTreeNotRevision(BzrError):
669
def __init__(self, tree):
670
BzrError.__init__(self, "The working tree for %s has changed since"
671
" last commit, but weave merge requires that it be"
672
" unchanged." % tree.basedir)
675
class CantReprocessAndShowBase(BzrNewError):
676
"""Can't reprocess and show base.
677
Reprocessing obscures relationship of conflicting lines to base."""
680
class GraphCycleError(BzrNewError):
681
"""Cycle in graph %(graph)r"""
682
def __init__(self, graph):
683
BzrNewError.__init__(self)
687
class NotConflicted(BzrNewError):
688
"""File %(filename)s is not conflicted."""
690
def __init__(self, filename):
691
BzrNewError.__init__(self)
692
self.filename = filename
695
class MustUseDecorated(Exception):
696
"""A decorating function has requested its original command be used.
698
This should never escape bzr, so does not need to be printable.
702
class MissingText(BzrNewError):
703
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
705
def __init__(self, branch, text_revision, file_id):
706
BzrNewError.__init__(self)
708
self.base = branch.base
709
self.text_revision = text_revision
710
self.file_id = file_id
713
class DuplicateKey(BzrNewError):
714
"""Key %(key)s is already present in map"""
717
class MalformedTransform(BzrNewError):
718
"""Tree transform is malformed %(conflicts)r"""
721
class BzrBadParameter(BzrNewError):
722
"""A bad parameter : %(param)s is not usable.
724
This exception should never be thrown, but it is a base class for all
725
parameter-to-function errors.
727
def __init__(self, param):
728
BzrNewError.__init__(self)
732
class BzrBadParameterNotUnicode(BzrBadParameter):
733
"""Parameter %(param)s is neither unicode nor utf8."""
736
class ReusingTransform(BzrNewError):
737
"""Attempt to reuse a transform that has already been applied."""
740
class CantMoveRoot(BzrNewError):
741
"""Moving the root directory is not supported at this time"""
744
class BzrBadParameterNotString(BzrBadParameter):
745
"""Parameter %(param)s is not a string or unicode string."""
748
class BzrBadParameterMissing(BzrBadParameter):
749
"""Parameter $(param)s is required but not present."""
752
class DependencyNotPresent(BzrNewError):
753
"""Unable to import library "%(library)s": %(error)s"""
755
def __init__(self, library, error):
756
BzrNewError.__init__(self, library=library, error=error)
759
class ParamikoNotPresent(DependencyNotPresent):
760
"""Unable to import paramiko (required for sftp support): %(error)s"""
762
def __init__(self, error):
763
DependencyNotPresent.__init__(self, 'paramiko', error)
766
class UninitializableFormat(BzrNewError):
767
"""Format %(format)s cannot be initialised by this version of bzr."""
769
def __init__(self, format):
770
BzrNewError.__init__(self)
774
class NoDiff3(BzrNewError):
775
"""Diff3 is not installed on this machine."""
778
class ExistingLimbo(BzrNewError):
779
"""This tree contains left-over files from a failed operation.
780
Please examine %(limbo_dir)s to see if it contains any files you wish to
781
keep, and delete it when you are done.
783
def __init__(self, limbo_dir):
784
BzrNewError.__init__(self)
785
self.limbo_dir = limbo_dir
788
class ImmortalLimbo(BzrNewError):
789
"""Unable to delete transform temporary directory $(limbo_dir)s.
790
Please examine %(limbo_dir)s to see if it contains any files you wish to
791
keep, and delete it when you are done.
793
def __init__(self, limbo_dir):
794
BzrNewError.__init__(self)
795
self.limbo_dir = limbo_dir
798
class OutOfDateTree(BzrNewError):
799
"""Working tree is out of date, please run 'bzr update'."""
801
def __init__(self, tree):
802
BzrNewError.__init__(self)
806
class MergeModifiedFormatError(BzrNewError):
807
"""Error in merge modified format"""
810
class ConflictFormatError(BzrNewError):
811
"""Format error in conflict listings"""
814
class CorruptRepository(BzrNewError):
815
"""An error has been detected in the repository %(repo_path)s.
816
Please run bzr reconcile on this repository."""
818
def __init__(self, repo):
819
BzrNewError.__init__(self)
820
self.repo_path = repo.bzrdir.root_transport.base
823
class UpgradeRequired(BzrNewError):
824
"""To use this feature you must upgrade your branch at %(path)s."""
826
def __init__(self, path):
827
BzrNewError.__init__(self)
831
class LocalRequiresBoundBranch(BzrNewError):
832
"""Cannot perform local-only commits on unbound branches."""
835
class MissingProgressBarFinish(BzrNewError):
836
"""A nested progress bar was not 'finished' correctly."""
839
class UnsupportedOperation(BzrNewError):
840
"""The method %(mname)s is not supported on objects of type %(tname)s."""
841
def __init__(self, method, method_self):
843
self.mname = method.__name__
844
self.tname = type(method_self).__name__
added
removed
bzrlib/errors.py
