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 ObjectNotLocked(LockError):
304
"""%(obj)r is not locked"""
305
# this can indicate that any particular object is not locked; see also
306
# LockNotHeld which means that a particular *lock* object is not held by
307
# the caller -- perhaps they should be unified.
308
def __init__(self, obj):
312
class ReadOnlyObjectDirtiedError(ReadOnlyError):
313
"""Cannot change object %(obj)r in read only transaction"""
314
def __init__(self, obj):
318
class UnlockableTransport(LockError):
319
"""Cannot lock: transport is read only: %(transport)s"""
320
def __init__(self, transport):
321
self.transport = transport
324
class LockContention(LockError):
325
"""Could not acquire lock %(lock)s"""
326
# TODO: show full url for lock, combining the transport and relative bits?
327
def __init__(self, lock):
331
class LockBroken(LockError):
332
"""Lock was broken while still open: %(lock)s - check storage consistency!"""
333
def __init__(self, lock):
337
class LockBreakMismatch(LockError):
338
"""Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
339
def __init__(self, lock, holder, target):
345
class LockNotHeld(LockError):
346
"""Lock not held: %(lock)s"""
347
def __init__(self, lock):
351
class PointlessCommit(BzrNewError):
352
"""No changes to commit"""
355
class UpgradeReadonly(BzrNewError):
356
"""Upgrade URL cannot work with readonly URL's."""
359
class UpToDateFormat(BzrNewError):
360
"""The branch format %(format)s is already at the most recent format."""
362
def __init__(self, format):
363
BzrNewError.__init__(self)
368
class StrictCommitFailed(Exception):
369
"""Commit refused because there are unknowns in the tree."""
372
class NoSuchRevision(BzrError):
373
def __init__(self, branch, revision):
375
self.revision = revision
376
msg = "Branch %s has no revision %s" % (branch, revision)
377
BzrError.__init__(self, msg)
380
class HistoryMissing(BzrError):
381
def __init__(self, branch, object_type, object_id):
383
BzrError.__init__(self,
384
'%s is missing %s {%s}'
385
% (branch, object_type, object_id))
388
class DivergedBranches(BzrError):
389
def __init__(self, branch1, branch2):
390
BzrError.__init__(self, "These branches have diverged. Try merge.")
391
self.branch1 = branch1
392
self.branch2 = branch2
395
class UnrelatedBranches(BzrCommandError):
397
msg = "Branches have no common ancestor, and no base revision"\
399
BzrCommandError.__init__(self, msg)
402
class NoCommonAncestor(BzrError):
403
def __init__(self, revision_a, revision_b):
404
msg = "Revisions have no common ancestor: %s %s." \
405
% (revision_a, revision_b)
406
BzrError.__init__(self, msg)
409
class NoCommonRoot(BzrError):
410
def __init__(self, revision_a, revision_b):
411
msg = "Revisions are not derived from the same root: %s %s." \
412
% (revision_a, revision_b)
413
BzrError.__init__(self, msg)
417
class NotAncestor(BzrError):
418
def __init__(self, rev_id, not_ancestor_id):
419
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
421
BzrError.__init__(self, msg)
423
self.not_ancestor_id = not_ancestor_id
426
class InstallFailed(BzrError):
427
def __init__(self, revisions):
428
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
429
BzrError.__init__(self, msg)
430
self.revisions = revisions
433
class AmbiguousBase(BzrError):
434
def __init__(self, bases):
435
msg = "The correct base is unclear, becase %s are all equally close" %\
437
BzrError.__init__(self, msg)
441
class NoCommits(BzrError):
442
def __init__(self, branch):
443
msg = "Branch %s has no commits." % branch
444
BzrError.__init__(self, msg)
447
class UnlistableStore(BzrError):
448
def __init__(self, store):
449
BzrError.__init__(self, "Store %s is not listable" % store)
453
class UnlistableBranch(BzrError):
454
def __init__(self, br):
455
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
458
class BoundBranchOutOfDate(BzrNewError):
459
"""Bound branch %(branch)s is out of date with master branch %(master)s."""
460
def __init__(self, branch, master):
461
BzrNewError.__init__(self)
466
class CommitToDoubleBoundBranch(BzrNewError):
467
"""Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
468
def __init__(self, branch, master, remote):
469
BzrNewError.__init__(self)
475
class OverwriteBoundBranch(BzrNewError):
476
"""Cannot pull --overwrite to a branch which is bound %(branch)s"""
477
def __init__(self, branch):
478
BzrNewError.__init__(self)
482
class BoundBranchConnectionFailure(BzrNewError):
483
"""Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
484
def __init__(self, branch, target, error):
485
BzrNewError.__init__(self)
491
class WeaveError(BzrNewError):
492
"""Error in processing weave: %(message)s"""
494
def __init__(self, message=None):
495
BzrNewError.__init__(self)
496
self.message = message
499
class WeaveRevisionAlreadyPresent(WeaveError):
500
"""Revision {%(revision_id)s} already present in %(weave)s"""
501
def __init__(self, revision_id, weave):
503
WeaveError.__init__(self)
504
self.revision_id = revision_id
508
class WeaveRevisionNotPresent(WeaveError):
509
"""Revision {%(revision_id)s} not present in %(weave)s"""
511
def __init__(self, revision_id, weave):
512
WeaveError.__init__(self)
513
self.revision_id = revision_id
517
class WeaveFormatError(WeaveError):
518
"""Weave invariant violated: %(what)s"""
520
def __init__(self, what):
521
WeaveError.__init__(self)
525
class WeaveParentMismatch(WeaveError):
526
"""Parents are mismatched between two revisions."""
529
class WeaveInvalidChecksum(WeaveError):
530
"""Text did not match it's checksum: %(message)s"""
533
class WeaveTextDiffers(WeaveError):
534
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
536
def __init__(self, revision_id, weave_a, weave_b):
537
WeaveError.__init__(self)
538
self.revision_id = revision_id
539
self.weave_a = weave_a
540
self.weave_b = weave_b
543
class WeaveTextDiffers(WeaveError):
544
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
546
def __init__(self, revision_id, weave_a, weave_b):
547
WeaveError.__init__(self)
548
self.revision_id = revision_id
549
self.weave_a = weave_a
550
self.weave_b = weave_b
553
class VersionedFileError(BzrNewError):
554
"""Versioned file error."""
557
class RevisionNotPresent(VersionedFileError):
558
"""Revision {%(revision_id)s} not present in %(file_id)s."""
560
def __init__(self, revision_id, file_id):
561
VersionedFileError.__init__(self)
562
self.revision_id = revision_id
563
self.file_id = file_id
566
class RevisionAlreadyPresent(VersionedFileError):
567
"""Revision {%(revision_id)s} already present in %(file_id)s."""
569
def __init__(self, revision_id, file_id):
570
VersionedFileError.__init__(self)
571
self.revision_id = revision_id
572
self.file_id = file_id
575
class KnitError(BzrNewError):
579
class KnitHeaderError(KnitError):
580
"""Knit header error: %(badline)r unexpected"""
582
def __init__(self, badline):
583
KnitError.__init__(self)
584
self.badline = badline
587
class KnitCorrupt(KnitError):
588
"""Knit %(filename)s corrupt: %(how)s"""
590
def __init__(self, filename, how):
591
KnitError.__init__(self)
592
self.filename = filename
596
class NoSuchExportFormat(BzrNewError):
597
"""Export format %(format)r not supported"""
598
def __init__(self, format):
599
BzrNewError.__init__(self)
603
class TransportError(BzrError):
604
"""All errors thrown by Transport implementations should derive
607
def __init__(self, msg=None, orig_error=None):
608
if msg is None and orig_error is not None:
609
msg = str(orig_error)
610
BzrError.__init__(self, msg)
612
self.orig_error = orig_error
615
# A set of semi-meaningful errors which can be thrown
616
class TransportNotPossible(TransportError):
617
"""This is for transports where a specific function is explicitly not
618
possible. Such as pushing files to an HTTP server.
623
class ConnectionError(TransportError):
624
"""A connection problem prevents file retrieval.
625
This does not indicate whether the file exists or not; it indicates that a
626
precondition for requesting the file was not met.
628
def __init__(self, msg=None, orig_error=None):
629
TransportError.__init__(self, msg=msg, orig_error=orig_error)
632
class ConnectionReset(TransportError):
633
"""The connection has been closed."""
637
class ConflictsInTree(BzrError):
639
BzrError.__init__(self, "Working tree has conflicts.")
642
class ParseConfigError(BzrError):
643
def __init__(self, errors, filename):
646
message = "Error(s) parsing config file %s:\n%s" % \
647
(filename, ('\n'.join(e.message for e in errors)))
648
BzrError.__init__(self, message)
651
class SigningFailed(BzrError):
652
def __init__(self, command_line):
653
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
657
class WorkingTreeNotRevision(BzrError):
658
def __init__(self, tree):
659
BzrError.__init__(self, "The working tree for %s has changed since"
660
" last commit, but weave merge requires that it be"
661
" unchanged." % tree.basedir)
664
class CantReprocessAndShowBase(BzrNewError):
665
"""Can't reprocess and show base.
666
Reprocessing obscures relationship of conflicting lines to base."""
669
class GraphCycleError(BzrNewError):
670
"""Cycle in graph %(graph)r"""
671
def __init__(self, graph):
672
BzrNewError.__init__(self)
676
class NotConflicted(BzrNewError):
677
"""File %(filename)s is not conflicted."""
679
def __init__(self, filename):
680
BzrNewError.__init__(self)
681
self.filename = filename
684
class MustUseDecorated(Exception):
685
"""A decorating function has requested its original command be used.
687
This should never escape bzr, so does not need to be printable.
691
class MissingText(BzrNewError):
692
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
694
def __init__(self, branch, text_revision, file_id):
695
BzrNewError.__init__(self)
697
self.base = branch.base
698
self.text_revision = text_revision
699
self.file_id = file_id
702
class DuplicateKey(BzrNewError):
703
"""Key %(key)s is already present in map"""
706
class MalformedTransform(BzrNewError):
707
"""Tree transform is malformed %(conflicts)r"""
710
class BzrBadParameter(BzrNewError):
711
"""A bad parameter : %(param)s is not usable.
713
This exception should never be thrown, but it is a base class for all
714
parameter-to-function errors.
716
def __init__(self, param):
717
BzrNewError.__init__(self)
721
class BzrBadParameterNotUnicode(BzrBadParameter):
722
"""Parameter %(param)s is neither unicode nor utf8."""
725
class ReusingTransform(BzrNewError):
726
"""Attempt to reuse a transform that has already been applied."""
729
class CantMoveRoot(BzrNewError):
730
"""Moving the root directory is not supported at this time"""
733
class BzrBadParameterNotString(BzrBadParameter):
734
"""Parameter %(param)s is not a string or unicode string."""
737
class BzrBadParameterMissing(BzrBadParameter):
738
"""Parameter $(param)s is required but not present."""
741
class DependencyNotPresent(BzrNewError):
742
"""Unable to import library: %(library)s, %(error)s"""
744
def __init__(self, library, error):
745
BzrNewError.__init__(self, library=library, error=error)
748
class ParamikoNotPresent(DependencyNotPresent):
749
"""Unable to import paramiko (required for sftp support): %(error)s"""
751
def __init__(self, error):
752
DependencyNotPresent.__init__(self, 'paramiko', error)
755
class UninitializableFormat(BzrNewError):
756
"""Format %(format)s cannot be initialised by this version of bzr."""
758
def __init__(self, format):
759
BzrNewError.__init__(self)
763
class NoDiff3(BzrNewError):
764
"""Diff3 is not installed on this machine."""
767
class ExistingLimbo(BzrNewError):
768
"""This tree contains left-over files from a failed operation.
769
Please examine %(limbo_dir)s to see if it contains any files you wish to
770
keep, and delete it when you are done.
772
def __init__(self, limbo_dir):
773
BzrNewError.__init__(self)
774
self.limbo_dir = limbo_dir
777
class ImmortalLimbo(BzrNewError):
778
"""Unable to delete transform temporary directory $(limbo_dir)s.
779
Please examine %(limbo_dir)s to see if it contains any files you wish to
780
keep, and delete it when you are done.
782
def __init__(self, limbo_dir):
783
BzrNewError.__init__(self)
784
self.limbo_dir = limbo_dir
787
class OutOfDateTree(BzrNewError):
788
"""Working tree is out of date, please run 'bzr update'."""
790
def __init__(self, tree):
791
BzrNewError.__init__(self)
795
class MergeModifiedFormatError(BzrNewError):
796
"""Error in merge modified format"""
799
class CorruptRepository(BzrNewError):
800
"""An error has been detected in the repository %(repo_path)s.
801
Please run bzr reconcile on this repository."""
803
def __init__(self, repo):
804
BzrNewError.__init__(self)
805
self.repo_path = repo.bzrdir.root_transport.base
808
class UpgradeRequired(BzrNewError):
809
"""To use this feature you must upgrade your branch at %(path)s."""
811
def __init__(self, path):
812
BzrNewError.__init__(self)
816
class LocalRequiresBoundBranch(BzrNewError):
817
"""Cannot perform local-only commits on unbound branches."""
820
class MissingProgressBarFinish(BzrNewError):
821
"""A nested progress bar was not 'finished' correctly."""
added
removed
bzrlib/errors.py
