14
14
# along with this program; if not, write to the Free Software
15
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', None)
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
from warnings import warn
58
from bzrlib.patches import (PatchSyntax,
65
# based on Scott James Remnant's hct error classes
67
# TODO: is there any value in providing the .args field used by standard
68
# python exceptions? A list of values with no names seems less useful
71
# TODO: Perhaps convert the exception to a string at the moment it's
72
# constructed to make sure it will succeed. But that says nothing about
73
# exceptions that are never raised.
75
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
78
# TODO: The pattern (from hct) of using classes docstrings as message
79
# templates is cute but maybe not such a great idea - perhaps should have a
80
# separate static message_template.
18
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
19
__author__ = "Martin Pool <mbp@canonical.com>"
22
######################################################################
83
24
class BzrError(StandardError):
85
# XXX: Should we show the exception class in
86
# exceptions that don't provide their own message?
87
# maybe it should be done at a higher level
88
## n = self.__class__.__name__ + ': '
90
if len(self.args) == 1:
91
return str(self.args[0])
92
elif len(self.args) == 2:
93
# further explanation or suggestions
95
return n + '\n '.join([self.args[0]] + self.args[1])
97
return n + "%r" % self
99
return n + `self.args`
102
class BzrNewError(BzrError):
104
# base classes should override the docstring with their human-
105
# readable explanation
107
def __init__(self, **kwds):
108
for key, value in kwds.items():
109
setattr(self, key, value)
113
return self.__doc__ % self.__dict__
114
except (NameError, ValueError, KeyError), e:
115
return 'Unprintable exception %s: %s' \
116
% (self.__class__.__name__, str(e))
119
class BzrCheckError(BzrNewError):
120
"""Internal check failed: %(message)s"""
122
def __init__(self, message):
123
BzrNewError.__init__(self)
124
self.message = message
127
class InvalidEntryName(BzrNewError):
128
"""Invalid entry name: %(name)s"""
129
def __init__(self, name):
130
BzrNewError.__init__(self)
134
class InvalidRevisionNumber(BzrNewError):
135
"""Invalid revision number %(revno)d"""
28
class BzrCheckError(BzrError):
32
class InvalidRevisionNumber(BzrError):
136
33
def __init__(self, revno):
137
BzrNewError.__init__(self)
141
class InvalidRevisionId(BzrNewError):
142
"""Invalid revision-id {%(revision_id)s} in %(branch)s"""
143
def __init__(self, revision_id, branch):
144
# branch can be any string or object with __str__ defined
145
BzrNewError.__init__(self)
146
self.revision_id = revision_id
150
class NoWorkingTree(BzrNewError):
151
"""No WorkingTree exists for %(base)s."""
153
def __init__(self, base):
154
BzrNewError.__init__(self)
158
class NotLocalUrl(BzrNewError):
159
"""%(url)s is not a local path."""
161
def __init__(self, url):
162
BzrNewError.__init__(self)
37
return 'invalid revision number: %r' % self.args[0]
40
class InvalidRevisionId(BzrError):
166
44
class BzrCommandError(BzrError):
167
45
# Error from malformed user command
168
# This is being misused as a generic exception
169
# please subclass. RBC 20051030
171
# I think it's a waste of effort to differentiate between errors that
172
# are not intended to be caught anyway. UI code need not subclass
173
# BzrCommandError, and non-UI code should not throw a subclass of
174
# BzrCommandError. ADHB 20051211
179
class BzrOptionError(BzrCommandError):
180
"""Some missing or otherwise incorrect option was supplied."""
183
class StrictCommitFailed(Exception):
184
"""Commit refused because there are unknowns in the tree."""
187
# XXX: Should be unified with TransportError; they seem to represent the
189
class PathError(BzrNewError):
190
"""Generic path error: %(path)r%(extra)s)"""
192
def __init__(self, path, extra=None):
193
BzrNewError.__init__(self)
196
self.extra = ': ' + str(extra)
201
class NoSuchFile(PathError):
202
"""No such file: %(path)r%(extra)s"""
205
class FileExists(PathError):
206
"""File exists: %(path)r%(extra)s"""
209
class DirectoryNotEmpty(PathError):
210
"""Directory not empty: %(path)r%(extra)s"""
213
class ResourceBusy(PathError):
214
"""Device or resource busy: %(path)r%(extra)s"""
217
class PermissionDenied(PathError):
218
"""Permission denied: %(path)r%(extra)s"""
221
class InvalidURL(PathError):
222
"""Invalid url supplied to transport: %(path)r%(extra)s"""
225
class InvalidURLJoin(PathError):
226
"""Invalid URL join request: %(args)s%(extra)s"""
228
def __init__(self, msg, base, args):
229
PathError.__init__(self, base, msg)
231
self.args.extend(args)
234
class PathNotChild(BzrNewError):
235
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
236
def __init__(self, path, base, extra=None):
237
BzrNewError.__init__(self)
241
self.extra = ': ' + str(extra)
246
# TODO: This is given a URL; we try to unescape it but doing that from inside
247
# the exception object is a bit undesirable.
248
# TODO: Probably this behavior of should be a common superclass
249
class NotBranchError(PathError):
250
"""Not a branch: %(path)s"""
252
def __init__(self, path):
253
import bzrlib.urlutils as urlutils
254
self.path = urlutils.unescape_for_display(path, 'ascii')
257
class AlreadyBranchError(PathError):
258
"""Already a branch: %(path)s."""
261
class BranchExistsWithoutWorkingTree(PathError):
262
"""Directory contains a branch, but no working tree \
263
(use bzr checkout if you wish to build a working tree): %(path)s"""
266
class NoRepositoryPresent(BzrNewError):
267
"""No repository present: %(path)r"""
268
def __init__(self, bzrdir):
269
BzrNewError.__init__(self)
270
self.path = bzrdir.transport.clone('..').base
273
class FileInWrongBranch(BzrNewError):
274
"""File %(path)s in not in branch %(branch_base)s."""
276
def __init__(self, branch, path):
277
BzrNewError.__init__(self)
279
self.branch_base = branch.base
283
class UnsupportedFormatError(BzrError):
284
"""Specified path is a bzr branch that we recognize but cannot read."""
286
return 'unsupported branch format: %s' % self.args[0]
289
class UnknownFormatError(BzrError):
290
"""Specified path is a bzr branch whose format we do not recognize."""
292
return 'unknown branch format: %s' % self.args[0]
295
class IncompatibleFormat(BzrNewError):
296
"""Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
298
def __init__(self, format, bzrdir_format):
299
BzrNewError.__init__(self)
301
self.bzrdir = bzrdir_format
304
class NotVersionedError(BzrNewError):
305
"""%(path)s is not versioned"""
306
def __init__(self, path):
307
BzrNewError.__init__(self)
311
class PathsNotVersionedError(BzrNewError):
312
# used when reporting several paths are not versioned
313
"""Path(s) are not versioned: %(paths_as_string)s"""
315
def __init__(self, paths):
316
from bzrlib.osutils import quotefn
317
BzrNewError.__init__(self)
319
self.paths_as_string = ' '.join([quotefn(p) for p in paths])
322
class PathsDoNotExist(BzrNewError):
323
"""Path(s) do not exist: %(paths_as_string)s"""
325
# used when reporting that paths are neither versioned nor in the working
328
def __init__(self, paths):
330
from bzrlib.osutils import quotefn
331
BzrNewError.__init__(self)
333
self.paths_as_string = ' '.join([quotefn(p) for p in paths])
49
class NotBranchError(BzrError):
50
"""Specified path is not in a branch"""
54
class NotVersionedError(BzrError):
55
"""Specified object is not versioned."""
336
58
class BadFileKindError(BzrError):
337
59
"""Specified file is of a kind that cannot be added.
339
61
(For example a symlink or device file.)"""
342
65
class ForbiddenFileError(BzrError):
343
66
"""Cannot operate on a file because it is a control file."""
346
class LockError(BzrNewError):
347
"""Lock error: %(message)s"""
348
# All exceptions from the lock/unlock functions should be from
349
# this exception class. They will be translated as necessary. The
350
# original exception is available as e.original_error
352
# New code should prefer to raise specific subclasses
353
def __init__(self, message):
354
self.message = message
357
class CommitNotPossible(LockError):
358
"""A commit was attempted but we do not have a write lock open."""
363
class AlreadyCommitted(LockError):
364
"""A rollback was requested, but is not able to be accomplished."""
369
class ReadOnlyError(LockError):
370
"""A write attempt was made in a read only transaction on %(obj)s"""
371
def __init__(self, obj):
375
class OutSideTransaction(BzrNewError):
376
"""A transaction related operation was attempted after the transaction finished."""
379
class ObjectNotLocked(LockError):
380
"""%(obj)r is not locked"""
381
# this can indicate that any particular object is not locked; see also
382
# LockNotHeld which means that a particular *lock* object is not held by
383
# the caller -- perhaps they should be unified.
384
def __init__(self, obj):
388
class ReadOnlyObjectDirtiedError(ReadOnlyError):
389
"""Cannot change object %(obj)r in read only transaction"""
390
def __init__(self, obj):
394
class UnlockableTransport(LockError):
395
"""Cannot lock: transport is read only: %(transport)s"""
396
def __init__(self, transport):
397
self.transport = transport
400
class LockContention(LockError):
401
"""Could not acquire lock %(lock)s"""
402
# TODO: show full url for lock, combining the transport and relative bits?
403
def __init__(self, lock):
407
class LockBroken(LockError):
408
"""Lock was broken while still open: %(lock)s - check storage consistency!"""
409
def __init__(self, lock):
413
class LockBreakMismatch(LockError):
414
"""Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
415
def __init__(self, lock, holder, target):
421
class LockNotHeld(LockError):
422
"""Lock not held: %(lock)s"""
423
def __init__(self, lock):
427
class PointlessCommit(BzrNewError):
428
"""No changes to commit"""
431
class UpgradeReadonly(BzrNewError):
432
"""Upgrade URL cannot work with readonly URL's."""
435
class UpToDateFormat(BzrNewError):
436
"""The branch format %(format)s is already at the most recent format."""
438
def __init__(self, format):
439
BzrNewError.__init__(self)
444
class StrictCommitFailed(Exception):
445
"""Commit refused because there are unknowns in the tree."""
70
class LockError(Exception):
71
"""All exceptions from the lock/unlock functions should be from
72
this exception class. They will be translated as necessary. The
73
original exception is available as e.original_error
75
def __init__(self, e=None):
76
self.original_error = e
78
Exception.__init__(self, e)
80
Exception.__init__(self)
83
class PointlessCommit(Exception):
84
"""Commit failed because nothing was changed."""
448
87
class NoSuchRevision(BzrError):
510
135
class AmbiguousBase(BzrError):
511
136
def __init__(self, bases):
512
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
514
msg = "The correct base is unclear, because %s are all equally close" %\
137
msg = "The correct base is unclear, becase %s are all equally close" %\
516
139
BzrError.__init__(self, msg)
517
140
self.bases = bases
520
142
class NoCommits(BzrError):
521
143
def __init__(self, branch):
522
144
msg = "Branch %s has no commits." % branch
523
145
BzrError.__init__(self, msg)
526
class UnlistableStore(BzrError):
527
def __init__(self, store):
528
BzrError.__init__(self, "Store %s is not listable" % store)
532
class UnlistableBranch(BzrError):
533
def __init__(self, br):
534
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
537
class BoundBranchOutOfDate(BzrNewError):
538
"""Bound branch %(branch)s is out of date with master branch %(master)s."""
539
def __init__(self, branch, master):
540
BzrNewError.__init__(self)
545
class CommitToDoubleBoundBranch(BzrNewError):
546
"""Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
547
def __init__(self, branch, master, remote):
548
BzrNewError.__init__(self)
554
class OverwriteBoundBranch(BzrNewError):
555
"""Cannot pull --overwrite to a branch which is bound %(branch)s"""
556
def __init__(self, branch):
557
BzrNewError.__init__(self)
561
class BoundBranchConnectionFailure(BzrNewError):
562
"""Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
563
def __init__(self, branch, target, error):
564
BzrNewError.__init__(self)
570
class WeaveError(BzrNewError):
571
"""Error in processing weave: %(message)s"""
573
def __init__(self, message=None):
574
BzrNewError.__init__(self)
575
self.message = message
578
class WeaveRevisionAlreadyPresent(WeaveError):
579
"""Revision {%(revision_id)s} already present in %(weave)s"""
580
def __init__(self, revision_id, weave):
582
WeaveError.__init__(self)
583
self.revision_id = revision_id
587
class WeaveRevisionNotPresent(WeaveError):
588
"""Revision {%(revision_id)s} not present in %(weave)s"""
590
def __init__(self, revision_id, weave):
591
WeaveError.__init__(self)
592
self.revision_id = revision_id
596
class WeaveFormatError(WeaveError):
597
"""Weave invariant violated: %(what)s"""
599
def __init__(self, what):
600
WeaveError.__init__(self)
604
class WeaveParentMismatch(WeaveError):
605
"""Parents are mismatched between two revisions."""
608
class WeaveInvalidChecksum(WeaveError):
609
"""Text did not match it's checksum: %(message)s"""
612
class WeaveTextDiffers(WeaveError):
613
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
615
def __init__(self, revision_id, weave_a, weave_b):
616
WeaveError.__init__(self)
617
self.revision_id = revision_id
618
self.weave_a = weave_a
619
self.weave_b = weave_b
622
class WeaveTextDiffers(WeaveError):
623
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
625
def __init__(self, revision_id, weave_a, weave_b):
626
WeaveError.__init__(self)
627
self.revision_id = revision_id
628
self.weave_a = weave_a
629
self.weave_b = weave_b
632
class VersionedFileError(BzrNewError):
633
"""Versioned file error."""
636
class RevisionNotPresent(VersionedFileError):
637
"""Revision {%(revision_id)s} not present in %(file_id)s."""
639
def __init__(self, revision_id, file_id):
640
VersionedFileError.__init__(self)
641
self.revision_id = revision_id
642
self.file_id = file_id
645
class RevisionAlreadyPresent(VersionedFileError):
646
"""Revision {%(revision_id)s} already present in %(file_id)s."""
648
def __init__(self, revision_id, file_id):
649
VersionedFileError.__init__(self)
650
self.revision_id = revision_id
651
self.file_id = file_id
654
class KnitError(BzrNewError):
658
class KnitHeaderError(KnitError):
659
"""Knit header error: %(badline)r unexpected"""
661
def __init__(self, badline):
662
KnitError.__init__(self)
663
self.badline = badline
666
class KnitCorrupt(KnitError):
667
"""Knit %(filename)s corrupt: %(how)s"""
669
def __init__(self, filename, how):
670
KnitError.__init__(self)
671
self.filename = filename
675
class NoSuchExportFormat(BzrNewError):
676
"""Export format %(format)r not supported"""
677
def __init__(self, format):
678
BzrNewError.__init__(self)
682
class TransportError(BzrError):
683
"""All errors thrown by Transport implementations should derive
686
def __init__(self, msg=None, orig_error=None):
687
if msg is None and orig_error is not None:
688
msg = str(orig_error)
689
BzrError.__init__(self, msg)
691
self.orig_error = orig_error
694
# A set of semi-meaningful errors which can be thrown
695
class TransportNotPossible(TransportError):
696
"""This is for transports where a specific function is explicitly not
697
possible. Such as pushing files to an HTTP server.
702
class ConnectionError(TransportError):
703
"""A connection problem prevents file retrieval.
704
This does not indicate whether the file exists or not; it indicates that a
705
precondition for requesting the file was not met.
707
def __init__(self, msg=None, orig_error=None):
708
TransportError.__init__(self, msg=msg, orig_error=orig_error)
711
class ConnectionReset(TransportError):
712
"""The connection has been closed."""
716
class ConflictsInTree(BzrError):
718
BzrError.__init__(self, "Working tree has conflicts.")
721
class ParseConfigError(BzrError):
722
def __init__(self, errors, filename):
725
message = "Error(s) parsing config file %s:\n%s" % \
726
(filename, ('\n'.join(e.message for e in errors)))
727
BzrError.__init__(self, message)
730
class SigningFailed(BzrError):
731
def __init__(self, command_line):
732
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
736
class WorkingTreeNotRevision(BzrError):
737
def __init__(self, tree):
738
BzrError.__init__(self, "The working tree for %s has changed since"
739
" last commit, but weave merge requires that it be"
740
" unchanged." % tree.basedir)
743
class CantReprocessAndShowBase(BzrNewError):
744
"""Can't reprocess and show base.
745
Reprocessing obscures relationship of conflicting lines to base."""
748
class GraphCycleError(BzrNewError):
749
"""Cycle in graph %(graph)r"""
750
def __init__(self, graph):
751
BzrNewError.__init__(self)
755
class NotConflicted(BzrNewError):
756
"""File %(filename)s is not conflicted."""
758
def __init__(self, filename):
759
BzrNewError.__init__(self)
760
self.filename = filename
763
class MustUseDecorated(Exception):
764
"""A decorating function has requested its original command be used.
766
This should never escape bzr, so does not need to be printable.
770
class NoBundleFound(BzrNewError):
771
"""No bundle was found in %(filename)s"""
772
def __init__(self, filename):
773
BzrNewError.__init__(self)
774
self.filename = filename
777
class BundleNotSupported(BzrNewError):
778
"""Unable to handle bundle version %(version)s: %(msg)s"""
779
def __init__(self, version, msg):
780
BzrNewError.__init__(self)
781
self.version = version
785
class MissingText(BzrNewError):
786
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
788
def __init__(self, branch, text_revision, file_id):
789
BzrNewError.__init__(self)
791
self.base = branch.base
792
self.text_revision = text_revision
793
self.file_id = file_id
796
class DuplicateKey(BzrNewError):
797
"""Key %(key)s is already present in map"""
800
class MalformedTransform(BzrNewError):
801
"""Tree transform is malformed %(conflicts)r"""
804
class BzrBadParameter(BzrNewError):
805
"""A bad parameter : %(param)s is not usable.
807
This exception should never be thrown, but it is a base class for all
808
parameter-to-function errors.
810
def __init__(self, param):
811
BzrNewError.__init__(self)
815
class BzrBadParameterNotUnicode(BzrBadParameter):
816
"""Parameter %(param)s is neither unicode nor utf8."""
819
class ReusingTransform(BzrNewError):
820
"""Attempt to reuse a transform that has already been applied."""
823
class CantMoveRoot(BzrNewError):
824
"""Moving the root directory is not supported at this time"""
827
class BzrBadParameterNotString(BzrBadParameter):
828
"""Parameter %(param)s is not a string or unicode string."""
831
class BzrBadParameterMissing(BzrBadParameter):
832
"""Parameter $(param)s is required but not present."""
835
class BzrBadParameterUnicode(BzrBadParameter):
836
"""Parameter %(param)s is unicode but only byte-strings are permitted."""
839
class BzrBadParameterContainsNewline(BzrBadParameter):
840
"""Parameter %(param)s contains a newline."""
843
class DependencyNotPresent(BzrNewError):
844
"""Unable to import library "%(library)s": %(error)s"""
846
def __init__(self, library, error):
847
BzrNewError.__init__(self, library=library, error=error)
850
class ParamikoNotPresent(DependencyNotPresent):
851
"""Unable to import paramiko (required for sftp support): %(error)s"""
853
def __init__(self, error):
854
DependencyNotPresent.__init__(self, 'paramiko', error)
857
class UninitializableFormat(BzrNewError):
858
"""Format %(format)s cannot be initialised by this version of bzr."""
860
def __init__(self, format):
861
BzrNewError.__init__(self)
865
class NoDiff3(BzrNewError):
866
"""Diff3 is not installed on this machine."""
869
class ExistingLimbo(BzrNewError):
870
"""This tree contains left-over files from a failed operation.
871
Please examine %(limbo_dir)s to see if it contains any files you wish to
872
keep, and delete it when you are done.
874
def __init__(self, limbo_dir):
875
BzrNewError.__init__(self)
876
self.limbo_dir = limbo_dir
879
class ImmortalLimbo(BzrNewError):
880
"""Unable to delete transform temporary directory $(limbo_dir)s.
881
Please examine %(limbo_dir)s to see if it contains any files you wish to
882
keep, and delete it when you are done.
884
def __init__(self, limbo_dir):
885
BzrNewError.__init__(self)
886
self.limbo_dir = limbo_dir
889
class OutOfDateTree(BzrNewError):
890
"""Working tree is out of date, please run 'bzr update'."""
892
def __init__(self, tree):
893
BzrNewError.__init__(self)
897
class MergeModifiedFormatError(BzrNewError):
898
"""Error in merge modified format"""
901
class ConflictFormatError(BzrNewError):
902
"""Format error in conflict listings"""
905
class CorruptRepository(BzrNewError):
906
"""An error has been detected in the repository %(repo_path)s.
907
Please run bzr reconcile on this repository."""
909
def __init__(self, repo):
910
BzrNewError.__init__(self)
911
self.repo_path = repo.bzrdir.root_transport.base
914
class UpgradeRequired(BzrNewError):
915
"""To use this feature you must upgrade your branch at %(path)s."""
917
def __init__(self, path):
918
BzrNewError.__init__(self)
922
class LocalRequiresBoundBranch(BzrNewError):
923
"""Cannot perform local-only commits on unbound branches."""
926
class MissingProgressBarFinish(BzrNewError):
927
"""A nested progress bar was not 'finished' correctly."""
930
class UnsupportedOperation(BzrNewError):
931
"""The method %(mname)s is not supported on objects of type %(tname)s."""
932
def __init__(self, method, method_self):
934
self.mname = method.__name__
935
self.tname = type(method_self).__name__
938
class BinaryFile(BzrNewError):
939
"""File is binary but should be text."""
942
class IllegalPath(BzrNewError):
943
"""The path %(path)s is not permitted on this platform"""
945
def __init__(self, path):
946
BzrNewError.__init__(self)
950
class TestamentMismatch(BzrNewError):
951
"""Testament did not match expected value.
952
For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
955
def __init__(self, revision_id, expected, measured):
956
self.revision_id = revision_id
957
self.expected = expected
958
self.measured = measured
961
class NotABundle(BzrNewError):
962
"""Not a bzr revision-bundle: %(text)r"""
964
def __init__(self, text):
968
class BadBundle(Exception): pass
971
class MalformedHeader(BadBundle): pass
974
class MalformedPatches(BadBundle): pass
977
class MalformedFooter(BadBundle): pass
added
removed
bzrlib/errors.py
