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
from warnings import warn
58
# based on Scott James Remnant's hct error classes
60
# TODO: is there any value in providing the .args field used by standard
61
# python exceptions? A list of values with no names seems less useful
64
# TODO: Perhaps convert the exception to a string at the moment it's
65
# constructed to make sure it will succeed. But that says nothing about
66
# exceptions that are never raised.
68
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
72
class BzrError(StandardError):
74
# XXX: Should we show the exception class in
75
# exceptions that don't provide their own message?
76
# maybe it should be done at a higher level
77
## n = self.__class__.__name__ + ': '
79
if len(self.args) == 1:
80
return str(self.args[0])
81
elif len(self.args) == 2:
82
# further explanation or suggestions
84
return n + '\n '.join([self.args[0]] + self.args[1])
86
return n + "%r" % self
88
return n + `self.args`
91
class BzrNewError(BzrError):
93
# base classes should override the docstring with their human-
94
# readable explanation
96
def __init__(self, **kwds):
97
for key, value in kwds.items():
98
setattr(self, key, value)
102
return self.__doc__ % self.__dict__
103
except (NameError, ValueError, KeyError), e:
104
return 'Unprintable exception %s: %s' \
105
% (self.__class__.__name__, str(e))
108
class BzrCheckError(BzrNewError):
109
"""Internal check failed: %(message)s"""
111
def __init__(self, message):
112
BzrNewError.__init__(self)
113
self.message = message
116
class InvalidEntryName(BzrNewError):
117
"""Invalid entry name: %(name)s"""
118
def __init__(self, name):
119
BzrNewError.__init__(self)
123
class InvalidRevisionNumber(BzrNewError):
124
"""Invalid revision number %(revno)d"""
125
def __init__(self, revno):
126
BzrNewError.__init__(self)
130
class InvalidRevisionId(BzrNewError):
131
"""Invalid revision-id {%(revision_id)s} in %(branch)s"""
132
def __init__(self, revision_id, branch):
133
BzrNewError.__init__(self)
134
self.revision_id = revision_id
138
class NoWorkingTree(BzrNewError):
139
"""No WorkingTree exists for %s(base)."""
141
def __init__(self, base):
142
BzrNewError.__init__(self)
146
class NotLocalUrl(BzrNewError):
147
"""%s(url) is not a local path."""
149
def __init__(self, url):
150
BzrNewError.__init__(self)
154
class BzrCommandError(BzrError):
155
# Error from malformed user command
156
# This is being misused as a generic exception
157
# pleae subclass. RBC 20051030
159
# I think it's a waste of effort to differentiate between errors that
160
# are not intended to be caught anyway. UI code need not subclass
161
# BzrCommandError, and non-UI code should not throw a subclass of
162
# BzrCommandError. ADHB 20051211
167
class BzrOptionError(BzrCommandError):
168
"""Some missing or otherwise incorrect option was supplied."""
171
class StrictCommitFailed(Exception):
172
"""Commit refused because there are unknowns in the tree."""
175
class PathError(BzrNewError):
176
"""Generic path error: %(path)r%(extra)s)"""
177
def __init__(self, path, extra=None):
178
BzrNewError.__init__(self)
181
self.extra = ': ' + str(extra)
186
class NoSuchFile(PathError):
187
"""No such file: %(path)r%(extra)s"""
190
class FileExists(PathError):
191
"""File exists: %(path)r%(extra)s"""
194
class DirectoryNotEmpty(PathError):
195
"""Directory not empty: %(path)r%(extra)s"""
198
class PermissionDenied(PathError):
199
"""Permission denied: %(path)r%(extra)s"""
202
class PathNotChild(BzrNewError):
203
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
204
def __init__(self, path, base, extra=None):
205
BzrNewError.__init__(self)
209
self.extra = ': ' + str(extra)
214
class NotBranchError(BzrNewError):
215
"""Not a branch: %(path)s"""
216
def __init__(self, path):
217
BzrNewError.__init__(self)
221
class NoRepositoryPresent(BzrNewError):
222
"""Not repository present: %(path)r"""
223
def __init__(self, bzrdir):
224
BzrNewError.__init__(self)
225
self.path = bzrdir.transport.clone('..').base
228
class FileInWrongBranch(BzrNewError):
229
"""File %(path)s in not in branch %(branch_base)s."""
231
def __init__(self, branch, path):
232
BzrNewError.__init__(self)
234
self.branch_base = branch.base
238
class UnsupportedFormatError(BzrError):
239
"""Specified path is a bzr branch that we recognize but cannot read."""
241
return 'unsupported branch format: %s' % self.args[0]
244
class UnknownFormatError(BzrError):
245
"""Specified path is a bzr branch whose format we do not recognize."""
247
return 'unknown branch format: %s' % self.args[0]
250
class IncompatibleFormat(BzrNewError):
251
"""Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
253
def __init__(self, format, bzrdir_format):
254
BzrNewError.__init__(self)
256
self.bzrdir = bzrdir_format
259
class NotVersionedError(BzrNewError):
260
"""%(path)s is not versioned"""
261
def __init__(self, path):
262
BzrNewError.__init__(self)
266
class BadFileKindError(BzrError):
267
"""Specified file is of a kind that cannot be added.
269
(For example a symlink or device file.)"""
272
class ForbiddenFileError(BzrError):
273
"""Cannot operate on a file because it is a control file."""
276
class LockError(BzrNewError):
277
"""Lock error: %(message)s"""
278
# All exceptions from the lock/unlock functions should be from
279
# this exception class. They will be translated as necessary. The
280
# original exception is available as e.original_error
282
# New code should prefer to raise specific subclasses
283
def __init__(self, message):
284
self.message = message
287
class CommitNotPossible(LockError):
288
"""A commit was attempted but we do not have a write lock open."""
293
class AlreadyCommitted(LockError):
294
"""A rollback was requested, but is not able to be accomplished."""
299
class ReadOnlyError(LockError):
300
"""A write attempt was made in a read only transaction on %(obj)s"""
301
def __init__(self, obj):
305
class OutSideTransaction(BzrNewError):
306
"""A transaction related operation was attempted after the transaction finished."""
309
class ObjectNotLocked(LockError):
310
"""%(obj)r is not locked"""
311
# this can indicate that any particular object is not locked; see also
312
# LockNotHeld which means that a particular *lock* object is not held by
313
# the caller -- perhaps they should be unified.
314
def __init__(self, obj):
318
class ReadOnlyObjectDirtiedError(ReadOnlyError):
319
"""Cannot change object %(obj)r in read only transaction"""
320
def __init__(self, obj):
324
class UnlockableTransport(LockError):
325
"""Cannot lock: transport is read only: %(transport)s"""
326
def __init__(self, transport):
327
self.transport = transport
330
class LockContention(LockError):
331
"""Could not acquire lock %(lock)s"""
332
# TODO: show full url for lock, combining the transport and relative bits?
333
def __init__(self, lock):
337
class LockBroken(LockError):
338
"""Lock was broken while still open: %(lock)s - check storage consistency!"""
339
def __init__(self, lock):
343
class LockBreakMismatch(LockError):
344
"""Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
345
def __init__(self, lock, holder, target):
351
class LockNotHeld(LockError):
352
"""Lock not held: %(lock)s"""
353
def __init__(self, lock):
357
class PointlessCommit(BzrNewError):
358
"""No changes to commit"""
361
class UpgradeReadonly(BzrNewError):
362
"""Upgrade URL cannot work with readonly URL's."""
365
class UpToDateFormat(BzrNewError):
366
"""The branch format %(format)s is already at the most recent format."""
368
def __init__(self, format):
369
BzrNewError.__init__(self)
374
class StrictCommitFailed(Exception):
375
"""Commit refused because there are unknowns in the tree."""
378
class NoSuchRevision(BzrError):
379
def __init__(self, branch, revision):
381
self.revision = revision
382
msg = "Branch %s has no revision %s" % (branch, revision)
383
BzrError.__init__(self, msg)
386
class HistoryMissing(BzrError):
387
def __init__(self, branch, object_type, object_id):
389
BzrError.__init__(self,
390
'%s is missing %s {%s}'
391
% (branch, object_type, object_id))
394
class DivergedBranches(BzrError):
395
def __init__(self, branch1, branch2):
396
BzrError.__init__(self, "These branches have diverged. Try merge.")
397
self.branch1 = branch1
398
self.branch2 = branch2
401
class UnrelatedBranches(BzrCommandError):
403
msg = "Branches have no common ancestor, and no base revision"\
405
BzrCommandError.__init__(self, msg)
408
class NoCommonAncestor(BzrError):
409
def __init__(self, revision_a, revision_b):
410
msg = "Revisions have no common ancestor: %s %s." \
411
% (revision_a, revision_b)
412
BzrError.__init__(self, msg)
415
class NoCommonRoot(BzrError):
416
def __init__(self, revision_a, revision_b):
417
msg = "Revisions are not derived from the same root: %s %s." \
418
% (revision_a, revision_b)
419
BzrError.__init__(self, msg)
423
class NotAncestor(BzrError):
424
def __init__(self, rev_id, not_ancestor_id):
425
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
427
BzrError.__init__(self, msg)
429
self.not_ancestor_id = not_ancestor_id
432
class InstallFailed(BzrError):
433
def __init__(self, revisions):
434
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
435
BzrError.__init__(self, msg)
436
self.revisions = revisions
439
class AmbiguousBase(BzrError):
440
def __init__(self, bases):
441
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
443
msg = "The correct base is unclear, becase %s are all equally close" %\
445
BzrError.__init__(self, msg)
449
class NoCommits(BzrError):
450
def __init__(self, branch):
451
msg = "Branch %s has no commits." % branch
452
BzrError.__init__(self, msg)
455
class UnlistableStore(BzrError):
456
def __init__(self, store):
457
BzrError.__init__(self, "Store %s is not listable" % store)
461
class UnlistableBranch(BzrError):
462
def __init__(self, br):
463
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
466
class BoundBranchOutOfDate(BzrNewError):
467
"""Bound branch %(branch)s is out of date with master branch %(master)s."""
468
def __init__(self, branch, master):
469
BzrNewError.__init__(self)
474
class CommitToDoubleBoundBranch(BzrNewError):
475
"""Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
476
def __init__(self, branch, master, remote):
477
BzrNewError.__init__(self)
483
class OverwriteBoundBranch(BzrNewError):
484
"""Cannot pull --overwrite to a branch which is bound %(branch)s"""
485
def __init__(self, branch):
486
BzrNewError.__init__(self)
490
class BoundBranchConnectionFailure(BzrNewError):
491
"""Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
492
def __init__(self, branch, target, error):
493
BzrNewError.__init__(self)
499
class WeaveError(BzrNewError):
500
"""Error in processing weave: %(message)s"""
502
def __init__(self, message=None):
503
BzrNewError.__init__(self)
504
self.message = message
507
class WeaveRevisionAlreadyPresent(WeaveError):
508
"""Revision {%(revision_id)s} already present in %(weave)s"""
509
def __init__(self, revision_id, weave):
511
WeaveError.__init__(self)
512
self.revision_id = revision_id
516
class WeaveRevisionNotPresent(WeaveError):
517
"""Revision {%(revision_id)s} not present in %(weave)s"""
519
def __init__(self, revision_id, weave):
520
WeaveError.__init__(self)
521
self.revision_id = revision_id
525
class WeaveFormatError(WeaveError):
526
"""Weave invariant violated: %(what)s"""
528
def __init__(self, what):
529
WeaveError.__init__(self)
533
class WeaveParentMismatch(WeaveError):
534
"""Parents are mismatched between two revisions."""
537
class WeaveInvalidChecksum(WeaveError):
538
"""Text did not match it's checksum: %(message)s"""
541
class WeaveTextDiffers(WeaveError):
542
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
544
def __init__(self, revision_id, weave_a, weave_b):
545
WeaveError.__init__(self)
546
self.revision_id = revision_id
547
self.weave_a = weave_a
548
self.weave_b = weave_b
551
class WeaveTextDiffers(WeaveError):
552
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
554
def __init__(self, revision_id, weave_a, weave_b):
555
WeaveError.__init__(self)
556
self.revision_id = revision_id
557
self.weave_a = weave_a
558
self.weave_b = weave_b
561
class VersionedFileError(BzrNewError):
562
"""Versioned file error."""
565
class RevisionNotPresent(VersionedFileError):
566
"""Revision {%(revision_id)s} not present in %(file_id)s."""
568
def __init__(self, revision_id, file_id):
569
VersionedFileError.__init__(self)
570
self.revision_id = revision_id
571
self.file_id = file_id
574
class RevisionAlreadyPresent(VersionedFileError):
575
"""Revision {%(revision_id)s} already present in %(file_id)s."""
577
def __init__(self, revision_id, file_id):
578
VersionedFileError.__init__(self)
579
self.revision_id = revision_id
580
self.file_id = file_id
583
class KnitError(BzrNewError):
587
class KnitHeaderError(KnitError):
588
"""Knit header error: %(badline)r unexpected"""
590
def __init__(self, badline):
591
KnitError.__init__(self)
592
self.badline = badline
595
class KnitCorrupt(KnitError):
596
"""Knit %(filename)s corrupt: %(how)s"""
598
def __init__(self, filename, how):
599
KnitError.__init__(self)
600
self.filename = filename
604
class NoSuchExportFormat(BzrNewError):
605
"""Export format %(format)r not supported"""
606
def __init__(self, format):
607
BzrNewError.__init__(self)
611
class TransportError(BzrError):
612
"""All errors thrown by Transport implementations should derive
615
def __init__(self, msg=None, orig_error=None):
616
if msg is None and orig_error is not None:
617
msg = str(orig_error)
618
BzrError.__init__(self, msg)
620
self.orig_error = orig_error
623
# A set of semi-meaningful errors which can be thrown
624
class TransportNotPossible(TransportError):
625
"""This is for transports where a specific function is explicitly not
626
possible. Such as pushing files to an HTTP server.
631
class ConnectionError(TransportError):
632
"""A connection problem prevents file retrieval.
633
This does not indicate whether the file exists or not; it indicates that a
634
precondition for requesting the file was not met.
636
def __init__(self, msg=None, orig_error=None):
637
TransportError.__init__(self, msg=msg, orig_error=orig_error)
640
class ConnectionReset(TransportError):
641
"""The connection has been closed."""
645
class ConflictsInTree(BzrError):
647
BzrError.__init__(self, "Working tree has conflicts.")
650
class ParseConfigError(BzrError):
651
def __init__(self, errors, filename):
654
message = "Error(s) parsing config file %s:\n%s" % \
655
(filename, ('\n'.join(e.message for e in errors)))
656
BzrError.__init__(self, message)
659
class SigningFailed(BzrError):
660
def __init__(self, command_line):
661
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
665
class WorkingTreeNotRevision(BzrError):
666
def __init__(self, tree):
667
BzrError.__init__(self, "The working tree for %s has changed since"
668
" last commit, but weave merge requires that it be"
669
" unchanged." % tree.basedir)
672
class CantReprocessAndShowBase(BzrNewError):
673
"""Can't reprocess and show base.
674
Reprocessing obscures relationship of conflicting lines to base."""
677
class GraphCycleError(BzrNewError):
678
"""Cycle in graph %(graph)r"""
679
def __init__(self, graph):
680
BzrNewError.__init__(self)
684
class NotConflicted(BzrNewError):
685
"""File %(filename)s is not conflicted."""
687
def __init__(self, filename):
688
BzrNewError.__init__(self)
689
self.filename = filename
692
class MustUseDecorated(Exception):
693
"""A decorating function has requested its original command be used.
695
This should never escape bzr, so does not need to be printable.
699
class MissingText(BzrNewError):
700
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
702
def __init__(self, branch, text_revision, file_id):
703
BzrNewError.__init__(self)
705
self.base = branch.base
706
self.text_revision = text_revision
707
self.file_id = file_id
710
class DuplicateKey(BzrNewError):
711
"""Key %(key)s is already present in map"""
714
class MalformedTransform(BzrNewError):
715
"""Tree transform is malformed %(conflicts)r"""
718
class BzrBadParameter(BzrNewError):
719
"""A bad parameter : %(param)s is not usable.
721
This exception should never be thrown, but it is a base class for all
722
parameter-to-function errors.
724
def __init__(self, param):
725
BzrNewError.__init__(self)
729
class BzrBadParameterNotUnicode(BzrBadParameter):
730
"""Parameter %(param)s is neither unicode nor utf8."""
733
class ReusingTransform(BzrNewError):
734
"""Attempt to reuse a transform that has already been applied."""
737
class CantMoveRoot(BzrNewError):
738
"""Moving the root directory is not supported at this time"""
741
class BzrBadParameterNotString(BzrBadParameter):
742
"""Parameter %(param)s is not a string or unicode string."""
745
class BzrBadParameterMissing(BzrBadParameter):
746
"""Parameter $(param)s is required but not present."""
749
class DependencyNotPresent(BzrNewError):
750
"""Unable to import library "%(library)s": %(error)s"""
752
def __init__(self, library, error):
753
BzrNewError.__init__(self, library=library, error=error)
756
class ParamikoNotPresent(DependencyNotPresent):
757
"""Unable to import paramiko (required for sftp support): %(error)s"""
759
def __init__(self, error):
760
DependencyNotPresent.__init__(self, 'paramiko', error)
763
class UninitializableFormat(BzrNewError):
764
"""Format %(format)s cannot be initialised by this version of bzr."""
766
def __init__(self, format):
767
BzrNewError.__init__(self)
771
class NoDiff3(BzrNewError):
772
"""Diff3 is not installed on this machine."""
775
class ExistingLimbo(BzrNewError):
776
"""This tree contains left-over files from a failed operation.
777
Please examine %(limbo_dir)s to see if it contains any files you wish to
778
keep, and delete it when you are done.
780
def __init__(self, limbo_dir):
781
BzrNewError.__init__(self)
782
self.limbo_dir = limbo_dir
785
class ImmortalLimbo(BzrNewError):
786
"""Unable to delete transform temporary directory $(limbo_dir)s.
787
Please examine %(limbo_dir)s to see if it contains any files you wish to
788
keep, and delete it when you are done.
790
def __init__(self, limbo_dir):
791
BzrNewError.__init__(self)
792
self.limbo_dir = limbo_dir
795
class OutOfDateTree(BzrNewError):
796
"""Working tree is out of date, please run 'bzr update'."""
798
def __init__(self, tree):
799
BzrNewError.__init__(self)
803
class MergeModifiedFormatError(BzrNewError):
804
"""Error in merge modified format"""
807
class CorruptRepository(BzrNewError):
808
"""An error has been detected in the repository %(repo_path)s.
809
Please run bzr reconcile on this repository."""
811
def __init__(self, repo):
812
BzrNewError.__init__(self)
813
self.repo_path = repo.bzrdir.root_transport.base
816
class UpgradeRequired(BzrNewError):
817
"""To use this feature you must upgrade your branch at %(path)s."""
819
def __init__(self, path):
820
BzrNewError.__init__(self)
824
class LocalRequiresBoundBranch(BzrNewError):
825
"""Cannot perform local-only commits on unbound branches."""
828
class MissingProgressBarFinish(BzrNewError):
829
"""A nested progress bar was not 'finished' correctly."""
added
removed
bzrlib/errors.py
