1
# Copyright (C) 2005, 2006 Canonical Ltd
 
 
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.
 
 
21
from bzrlib import symbol_versioning
 
 
22
from bzrlib.patches import (PatchSyntax, 
 
 
29
# TODO: is there any value in providing the .args field used by standard
 
 
30
# python exceptions?   A list of values with no names seems less useful 
 
 
33
# TODO: Perhaps convert the exception to a string at the moment it's 
 
 
34
# constructed to make sure it will succeed.  But that says nothing about
 
 
35
# exceptions that are never raised.
 
 
37
# TODO: selftest assertRaises should probably also check that every error
 
 
38
# raised can be formatted as a string successfully, and without giving
 
 
42
class BzrError(StandardError):
 
 
44
    Base class for errors raised by bzrlib.
 
 
46
    :cvar internal_error: if true (or absent) this was probably caused by a
 
 
47
    bzr bug and should be displayed with a traceback; if False this was
 
 
48
    probably a user or environment error and they don't need the gory details.
 
 
49
    (That can be overridden by -Derror on the command line.)
 
 
51
    :cvar _fmt: Format string to display the error; this is expanded
 
 
52
    by the instance's dict.
 
 
55
    internal_error = False
 
 
57
    def __init__(self, msg=None, **kwds):
 
 
58
        """Construct a new BzrError.
 
 
60
        There are two alternative forms for constructing these objects.
 
 
61
        Either a preformatted string may be passed, or a set of named
 
 
62
        arguments can be given.  The first is for generic "user" errors which
 
 
63
        are not intended to be caught and so do not need a specific subclass.
 
 
64
        The second case is for use with subclasses that provide a _fmt format
 
 
65
        string to print the arguments.  
 
 
67
        Keyword arguments are taken as parameters to the error, which can 
 
 
68
        be inserted into the format string template.  It's recommended 
 
 
69
        that subclasses override the __init__ method to require specific 
 
 
72
        :param msg: If given, this is the literal complete text for the error,
 
 
73
        not subject to expansion.
 
 
75
        StandardError.__init__(self)
 
 
77
            # I was going to deprecate this, but it actually turns out to be
 
 
78
            # quite handy - mbp 20061103.
 
 
79
            self._preformatted_string = msg
 
 
81
            self._preformatted_string = None
 
 
82
            for key, value in kwds.items():
 
 
83
                setattr(self, key, value)
 
 
86
        s = getattr(self, '_preformatted_string', None)
 
 
88
            # contains a preformatted message; must be cast to plain str
 
 
91
            fmt = self._get_format_string()
 
 
93
                s = fmt % self.__dict__
 
 
94
                # __str__() should always return a 'str' object
 
 
95
                # never a 'unicode' object.
 
 
96
                if isinstance(s, unicode):
 
 
97
                    return s.encode('utf8')
 
 
99
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
 
 
100
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%s' \
 
 
101
                % (self.__class__.__name__,
 
 
103
                   getattr(self, '_fmt', None),
 
 
106
    def _get_format_string(self):
 
 
107
        """Return format string for this exception or None"""
 
 
108
        fmt = getattr(self, '_fmt', None)
 
 
111
        fmt = getattr(self, '__doc__', None)
 
 
113
            symbol_versioning.warn("%s uses its docstring as a format, "
 
 
114
                    "it should use _fmt instead" % self.__class__.__name__,
 
 
117
        return 'Unprintable exception %s: dict=%r, fmt=%r' \
 
 
118
            % (self.__class__.__name__,
 
 
120
               getattr(self, '_fmt', None),
 
 
124
class BzrNewError(BzrError):
 
 
125
    """Deprecated error base class."""
 
 
126
    # base classes should override the docstring with their human-
 
 
127
    # readable explanation
 
 
129
    def __init__(self, *args, **kwds):
 
 
130
        # XXX: Use the underlying BzrError to always generate the args attribute
 
 
131
        # if it doesn't exist.  We can't use super here, because exceptions are
 
 
132
        # old-style classes in python2.4 (but new in 2.5).  --bmc, 20060426
 
 
133
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
 
 
134
             'please convert %s to use BzrError instead' 
 
 
135
             % self.__class__.__name__,
 
 
138
        BzrError.__init__(self, *args)
 
 
139
        for key, value in kwds.items():
 
 
140
            setattr(self, key, value)
 
 
144
            # __str__() should always return a 'str' object
 
 
145
            # never a 'unicode' object.
 
 
146
            s = self.__doc__ % self.__dict__
 
 
147
            if isinstance(s, unicode):
 
 
148
                return s.encode('utf8')
 
 
150
        except (TypeError, NameError, ValueError, KeyError), e:
 
 
151
            return 'Unprintable exception %s(%r): %s' \
 
 
152
                % (self.__class__.__name__,
 
 
153
                   self.__dict__, str(e))
 
 
156
class AlreadyBuilding(BzrError):
 
 
158
    _fmt = "The tree builder is already building a tree."
 
 
161
class BzrCheckError(BzrError):
 
 
163
    _fmt = "Internal check failed: %(message)s"
 
 
165
    internal_error = True
 
 
167
    def __init__(self, message):
 
 
168
        BzrError.__init__(self)
 
 
169
        self.message = message
 
 
172
class InvalidEntryName(BzrError):
 
 
174
    _fmt = "Invalid entry name: %(name)s"
 
 
176
    internal_error = True
 
 
178
    def __init__(self, name):
 
 
179
        BzrError.__init__(self)
 
 
183
class InvalidRevisionNumber(BzrError):
 
 
185
    _fmt = "Invalid revision number %(revno)s"
 
 
187
    def __init__(self, revno):
 
 
188
        BzrError.__init__(self)
 
 
192
class InvalidRevisionId(BzrError):
 
 
194
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
 
196
    def __init__(self, revision_id, branch):
 
 
197
        # branch can be any string or object with __str__ defined
 
 
198
        BzrError.__init__(self)
 
 
199
        self.revision_id = revision_id
 
 
203
class NoSuchId(BzrError):
 
 
205
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
 
207
    def __init__(self, tree, file_id):
 
 
208
        BzrError.__init__(self)
 
 
209
        self.file_id = file_id
 
 
213
class InventoryModified(BzrError):
 
 
215
    _fmt = ("The current inventory for the tree %(tree)r has been modified, "
 
 
216
            "so a clean inventory cannot be read without data loss.")
 
 
218
    internal_error = True
 
 
220
    def __init__(self, tree):
 
 
224
class NoWorkingTree(BzrError):
 
 
226
    _fmt = "No WorkingTree exists for %(base)s."
 
 
228
    def __init__(self, base):
 
 
229
        BzrError.__init__(self)
 
 
233
class NotBuilding(BzrError):
 
 
235
    _fmt = "Not currently building a tree."
 
 
238
class NotLocalUrl(BzrError):
 
 
240
    _fmt = "%(url)s is not a local path."
 
 
242
    def __init__(self, url):
 
 
246
class WorkingTreeAlreadyPopulated(BzrError):
 
 
248
    _fmt = """Working tree already populated in %(base)s"""
 
 
250
    internal_error = True
 
 
252
    def __init__(self, base):
 
 
255
class BzrCommandError(BzrError):
 
 
256
    """Error from user command"""
 
 
258
    internal_error = False
 
 
260
    # Error from malformed user command; please avoid raising this as a
 
 
261
    # generic exception not caused by user input.
 
 
263
    # I think it's a waste of effort to differentiate between errors that
 
 
264
    # are not intended to be caught anyway.  UI code need not subclass
 
 
265
    # BzrCommandError, and non-UI code should not throw a subclass of
 
 
266
    # BzrCommandError.  ADHB 20051211
 
 
267
    def __init__(self, msg):
 
 
268
        # Object.__str__() must return a real string
 
 
269
        # returning a Unicode string is a python error.
 
 
270
        if isinstance(msg, unicode):
 
 
271
            self.msg = msg.encode('utf8')
 
 
279
class NotWriteLocked(BzrError):
 
 
281
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
 
283
    def __init__(self, not_locked):
 
 
284
        self.not_locked = not_locked
 
 
287
class BzrOptionError(BzrCommandError):
 
 
289
    _fmt = "Error in command line options"
 
 
292
class StrictCommitFailed(BzrError):
 
 
294
    _fmt = "Commit refused because there are unknown files in the tree"
 
 
297
# XXX: Should be unified with TransportError; they seem to represent the
 
 
299
class PathError(BzrError):
 
 
301
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
 
303
    def __init__(self, path, extra=None):
 
 
304
        BzrError.__init__(self)
 
 
307
            self.extra = ': ' + str(extra)
 
 
312
class NoSuchFile(PathError):
 
 
314
    _fmt = "No such file: %(path)r%(extra)s"
 
 
317
class FileExists(PathError):
 
 
319
    _fmt = "File exists: %(path)r%(extra)s"
 
 
322
class DirectoryNotEmpty(PathError):
 
 
324
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
 
327
class ReadingCompleted(BzrError):
 
 
329
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
 
330
            "called upon it - the request has been completed and no more "
 
 
333
    internal_error = True
 
 
335
    def __init__(self, request):
 
 
336
        self.request = request
 
 
339
class ResourceBusy(PathError):
 
 
341
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
 
344
class PermissionDenied(PathError):
 
 
346
    _fmt = "Permission denied: %(path)r%(extra)s"
 
 
349
class InvalidURL(PathError):
 
 
351
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
 
354
class InvalidURLJoin(PathError):
 
 
356
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
 
358
    def __init__(self, msg, base, args):
 
 
359
        PathError.__init__(self, base, msg)
 
 
360
        self.args = [base] + list(args)
 
 
363
class UnsupportedProtocol(PathError):
 
 
365
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
 
367
    def __init__(self, url, extra):
 
 
368
        PathError.__init__(self, url, extra=extra)
 
 
371
class ShortReadvError(PathError):
 
 
373
    _fmt = "readv() read %(actual)s bytes rather than %(length)s bytes at %(offset)s for %(path)s%(extra)s"
 
 
375
    internal_error = True
 
 
377
    def __init__(self, path, offset, length, actual, extra=None):
 
 
378
        PathError.__init__(self, path, extra=extra)
 
 
384
class PathNotChild(BzrError):
 
 
386
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
 
388
    internal_error = True
 
 
390
    def __init__(self, path, base, extra=None):
 
 
391
        BzrError.__init__(self)
 
 
395
            self.extra = ': ' + str(extra)
 
 
400
class InvalidNormalization(PathError):
 
 
402
    _fmt = "Path %(path)r is not unicode normalized"
 
 
405
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
406
# the exception object is a bit undesirable.
 
 
407
# TODO: Probably this behavior of should be a common superclass 
 
 
408
class NotBranchError(PathError):
 
 
410
    _fmt = "Not a branch: %(path)s"
 
 
412
    def __init__(self, path):
 
 
413
       import bzrlib.urlutils as urlutils
 
 
414
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
417
class AlreadyBranchError(PathError):
 
 
419
    _fmt = "Already a branch: %(path)s."
 
 
422
class BranchExistsWithoutWorkingTree(PathError):
 
 
424
    _fmt = "Directory contains a branch, but no working tree \
 
 
425
(use bzr checkout if you wish to build a working tree): %(path)s"
 
 
428
class AtomicFileAlreadyClosed(PathError):
 
 
430
    _fmt = "'%(function)s' called on an AtomicFile after it was closed: %(path)s"
 
 
432
    def __init__(self, path, function):
 
 
433
        PathError.__init__(self, path=path, extra=None)
 
 
434
        self.function = function
 
 
437
class InaccessibleParent(PathError):
 
 
439
    _fmt = "Parent not accessible given base %(base)s and relative path %(path)s"
 
 
441
    def __init__(self, path, base):
 
 
442
        PathError.__init__(self, path)
 
 
446
class NoRepositoryPresent(BzrError):
 
 
448
    _fmt = "No repository present: %(path)r"
 
 
449
    def __init__(self, bzrdir):
 
 
450
        BzrError.__init__(self)
 
 
451
        self.path = bzrdir.transport.clone('..').base
 
 
454
class FileInWrongBranch(BzrError):
 
 
456
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
 
458
    def __init__(self, branch, path):
 
 
459
        BzrError.__init__(self)
 
 
461
        self.branch_base = branch.base
 
 
465
class UnsupportedFormatError(BzrError):
 
 
467
    _fmt = "Unsupported branch format: %(format)s"
 
 
470
class UnknownFormatError(BzrError):
 
 
472
    _fmt = "Unknown branch format: %(format)r"
 
 
475
class IncompatibleFormat(BzrError):
 
 
477
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
 
479
    def __init__(self, format, bzrdir_format):
 
 
480
        BzrError.__init__(self)
 
 
482
        self.bzrdir = bzrdir_format
 
 
485
class IncompatibleRevision(BzrError):
 
 
487
    _fmt = "Revision is not compatible with %(repo_format)s"
 
 
489
    def __init__(self, repo_format):
 
 
490
        BzrError.__init__(self)
 
 
491
        self.repo_format = repo_format
 
 
494
class NotVersionedError(BzrError):
 
 
496
    _fmt = "%(path)s is not versioned"
 
 
498
    def __init__(self, path):
 
 
499
        BzrError.__init__(self)
 
 
503
class PathsNotVersionedError(BzrError):
 
 
504
    # used when reporting several paths are not versioned
 
 
506
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
 
508
    def __init__(self, paths):
 
 
509
        from bzrlib.osutils import quotefn
 
 
510
        BzrError.__init__(self)
 
 
512
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
515
class PathsDoNotExist(BzrError):
 
 
517
    _fmt = "Path(s) do not exist: %(paths_as_string)s"
 
 
519
    # used when reporting that paths are neither versioned nor in the working
 
 
522
    def __init__(self, paths):
 
 
524
        from bzrlib.osutils import quotefn
 
 
525
        BzrError.__init__(self)
 
 
527
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
530
class BadFileKindError(BzrError):
 
 
532
    _fmt = "Cannot operate on %(filename)s of unsupported kind %(kind)s"
 
 
535
class ForbiddenControlFileError(BzrError):
 
 
537
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
 
540
class LockError(BzrError):
 
 
542
    _fmt = "Lock error: %(message)s"
 
 
544
    # All exceptions from the lock/unlock functions should be from
 
 
545
    # this exception class.  They will be translated as necessary. The
 
 
546
    # original exception is available as e.original_error
 
 
548
    # New code should prefer to raise specific subclasses
 
 
549
    def __init__(self, message):
 
 
550
        self.message = message
 
 
553
class CommitNotPossible(LockError):
 
 
555
    _fmt = "A commit was attempted but we do not have a write lock open."
 
 
561
class AlreadyCommitted(LockError):
 
 
563
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
 
569
class ReadOnlyError(LockError):
 
 
571
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
 
573
    def __init__(self, obj):
 
 
577
class OutSideTransaction(BzrError):
 
 
579
    _fmt = "A transaction related operation was attempted after the transaction finished."
 
 
582
class ObjectNotLocked(LockError):
 
 
584
    _fmt = "%(obj)r is not locked"
 
 
586
    internal_error = True
 
 
588
    # this can indicate that any particular object is not locked; see also
 
 
589
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
590
    # the caller -- perhaps they should be unified.
 
 
591
    def __init__(self, obj):
 
 
595
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
597
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
 
599
    def __init__(self, obj):
 
 
603
class UnlockableTransport(LockError):
 
 
605
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
 
607
    def __init__(self, transport):
 
 
608
        self.transport = transport
 
 
611
class LockContention(LockError):
 
 
613
    _fmt = "Could not acquire lock %(lock)s"
 
 
614
    # TODO: show full url for lock, combining the transport and relative bits?
 
 
616
    def __init__(self, lock):
 
 
620
class LockBroken(LockError):
 
 
622
    _fmt = "Lock was broken while still open: %(lock)s - check storage consistency!"
 
 
624
    def __init__(self, lock):
 
 
628
class LockBreakMismatch(LockError):
 
 
630
    _fmt = "Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"
 
 
632
    def __init__(self, lock, holder, target):
 
 
638
class LockNotHeld(LockError):
 
 
640
    _fmt = "Lock not held: %(lock)s"
 
 
642
    def __init__(self, lock):
 
 
646
class PointlessCommit(BzrError):
 
 
648
    _fmt = "No changes to commit"
 
 
651
class UpgradeReadonly(BzrError):
 
 
653
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
 
656
class UpToDateFormat(BzrError):
 
 
658
    _fmt = "The branch format %(format)s is already at the most recent format."
 
 
660
    def __init__(self, format):
 
 
661
        BzrError.__init__(self)
 
 
665
class StrictCommitFailed(Exception):
 
 
667
    _fmt = "Commit refused because there are unknowns in the tree."
 
 
670
class NoSuchRevision(BzrError):
 
 
672
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
 
674
    internal_error = True
 
 
676
    def __init__(self, branch, revision):
 
 
677
        BzrError.__init__(self, branch=branch, revision=revision)
 
 
680
class NoSuchRevisionSpec(BzrError):
 
 
682
    _fmt = "No namespace registered for string: %(spec)r"
 
 
684
    def __init__(self, spec):
 
 
685
        BzrError.__init__(self, spec=spec)
 
 
688
class InvalidRevisionSpec(BzrError):
 
 
690
    _fmt = "Requested revision: %(spec)r does not exist in branch: %(branch)s%(extra)s"
 
 
692
    def __init__(self, spec, branch, extra=None):
 
 
693
        BzrError.__init__(self, branch=branch, spec=spec)
 
 
695
            self.extra = '\n' + str(extra)
 
 
700
class HistoryMissing(BzrError):
 
 
702
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
 
705
class DivergedBranches(BzrError):
 
 
707
    _fmt = "These branches have diverged.  Use the merge command to reconcile them."""
 
 
709
    internal_error = False
 
 
711
    def __init__(self, branch1, branch2):
 
 
712
        self.branch1 = branch1
 
 
713
        self.branch2 = branch2
 
 
716
class UnrelatedBranches(BzrError):
 
 
718
    _fmt = "Branches have no common ancestor, and no merge base revision was specified."
 
 
720
    internal_error = False
 
 
723
class NoCommonAncestor(BzrError):
 
 
725
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
727
    def __init__(self, revision_a, revision_b):
 
 
728
        self.revision_a = revision_a
 
 
729
        self.revision_b = revision_b
 
 
732
class NoCommonRoot(BzrError):
 
 
734
    _fmt = "Revisions are not derived from the same root: " \
 
 
735
           "%(revision_a)s %(revision_b)s."
 
 
737
    def __init__(self, revision_a, revision_b):
 
 
738
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
 
741
class NotAncestor(BzrError):
 
 
743
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
 
745
    def __init__(self, rev_id, not_ancestor_id):
 
 
746
        BzrError.__init__(self, rev_id=rev_id,
 
 
747
            not_ancestor_id=not_ancestor_id)
 
 
750
class InstallFailed(BzrError):
 
 
752
    def __init__(self, revisions):
 
 
753
        revision_str = ", ".join(str(r) for r in revisions)
 
 
754
        msg = "Could not install revisions:\n%s" % revision_str
 
 
755
        BzrError.__init__(self, msg)
 
 
756
        self.revisions = revisions
 
 
759
class AmbiguousBase(BzrError):
 
 
761
    def __init__(self, bases):
 
 
762
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
764
        msg = "The correct base is unclear, because %s are all equally close" %\
 
 
766
        BzrError.__init__(self, msg)
 
 
770
class NoCommits(BzrError):
 
 
772
    _fmt = "Branch %(branch)s has no commits."
 
 
774
    def __init__(self, branch):
 
 
775
        BzrError.__init__(self, branch=branch)
 
 
778
class UnlistableStore(BzrError):
 
 
780
    def __init__(self, store):
 
 
781
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
785
class UnlistableBranch(BzrError):
 
 
787
    def __init__(self, br):
 
 
788
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
791
class BoundBranchOutOfDate(BzrError):
 
 
793
    _fmt = "Bound branch %(branch)s is out of date with master branch %(master)s."
 
 
795
    def __init__(self, branch, master):
 
 
796
        BzrError.__init__(self)
 
 
801
class CommitToDoubleBoundBranch(BzrError):
 
 
803
    _fmt = "Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."
 
 
805
    def __init__(self, branch, master, remote):
 
 
806
        BzrError.__init__(self)
 
 
812
class OverwriteBoundBranch(BzrError):
 
 
814
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
 
816
    def __init__(self, branch):
 
 
817
        BzrError.__init__(self)
 
 
821
class BoundBranchConnectionFailure(BzrError):
 
 
823
    _fmt = "Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"
 
 
825
    def __init__(self, branch, target, error):
 
 
826
        BzrError.__init__(self)
 
 
832
class WeaveError(BzrError):
 
 
834
    _fmt = "Error in processing weave: %(message)s"
 
 
836
    def __init__(self, message=None):
 
 
837
        BzrError.__init__(self)
 
 
838
        self.message = message
 
 
841
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
843
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
 
845
    def __init__(self, revision_id, weave):
 
 
847
        WeaveError.__init__(self)
 
 
848
        self.revision_id = revision_id
 
 
852
class WeaveRevisionNotPresent(WeaveError):
 
 
854
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
 
856
    def __init__(self, revision_id, weave):
 
 
857
        WeaveError.__init__(self)
 
 
858
        self.revision_id = revision_id
 
 
862
class WeaveFormatError(WeaveError):
 
 
864
    _fmt = "Weave invariant violated: %(what)s"
 
 
866
    def __init__(self, what):
 
 
867
        WeaveError.__init__(self)
 
 
871
class WeaveParentMismatch(WeaveError):
 
 
873
    _fmt = "Parents are mismatched between two revisions."
 
 
876
class WeaveInvalidChecksum(WeaveError):
 
 
878
    _fmt = "Text did not match it's checksum: %(message)s"
 
 
881
class WeaveTextDiffers(WeaveError):
 
 
883
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
 
885
    def __init__(self, revision_id, weave_a, weave_b):
 
 
886
        WeaveError.__init__(self)
 
 
887
        self.revision_id = revision_id
 
 
888
        self.weave_a = weave_a
 
 
889
        self.weave_b = weave_b
 
 
892
class WeaveTextDiffers(WeaveError):
 
 
894
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
 
896
    def __init__(self, revision_id, weave_a, weave_b):
 
 
897
        WeaveError.__init__(self)
 
 
898
        self.revision_id = revision_id
 
 
899
        self.weave_a = weave_a
 
 
900
        self.weave_b = weave_b
 
 
903
class VersionedFileError(BzrError):
 
 
905
    _fmt = "Versioned file error"
 
 
908
class RevisionNotPresent(VersionedFileError):
 
 
910
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
 
912
    def __init__(self, revision_id, file_id):
 
 
913
        VersionedFileError.__init__(self)
 
 
914
        self.revision_id = revision_id
 
 
915
        self.file_id = file_id
 
 
918
class RevisionAlreadyPresent(VersionedFileError):
 
 
920
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
 
922
    def __init__(self, revision_id, file_id):
 
 
923
        VersionedFileError.__init__(self)
 
 
924
        self.revision_id = revision_id
 
 
925
        self.file_id = file_id
 
 
928
class KnitError(BzrError):
 
 
933
class KnitHeaderError(KnitError):
 
 
935
    _fmt = "Knit header error: %(badline)r unexpected"
 
 
937
    def __init__(self, badline):
 
 
938
        KnitError.__init__(self)
 
 
939
        self.badline = badline
 
 
942
class KnitCorrupt(KnitError):
 
 
944
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
 
946
    def __init__(self, filename, how):
 
 
947
        KnitError.__init__(self)
 
 
948
        self.filename = filename
 
 
952
class NoSuchExportFormat(BzrError):
 
 
954
    _fmt = "Export format %(format)r not supported"
 
 
956
    def __init__(self, format):
 
 
957
        BzrError.__init__(self)
 
 
961
class TransportError(BzrError):
 
 
963
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
 
965
    def __init__(self, msg=None, orig_error=None):
 
 
966
        if msg is None and orig_error is not None:
 
 
967
            msg = str(orig_error)
 
 
968
        if orig_error is None:
 
 
973
        self.orig_error = orig_error
 
 
974
        BzrError.__init__(self)
 
 
977
class TooManyConcurrentRequests(BzrError):
 
 
979
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit. "
 
 
980
            "Be sure to finish_writing and finish_reading on the "
 
 
981
            "current request that is open.")
 
 
983
    internal_error = True
 
 
985
    def __init__(self, medium):
 
 
989
class SmartProtocolError(TransportError):
 
 
991
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
 
993
    def __init__(self, details):
 
 
994
        self.details = details
 
 
997
# A set of semi-meaningful errors which can be thrown
 
 
998
class TransportNotPossible(TransportError):
 
 
1000
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
 
1003
class ConnectionError(TransportError):
 
 
1005
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
 
1008
class SocketConnectionError(ConnectionError):
 
 
1010
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
 
1012
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
1014
            msg = 'Failed to connect to'
 
 
1015
        if orig_error is None:
 
 
1018
            orig_error = '; ' + str(orig_error)
 
 
1019
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
1024
            self.port = ':%s' % port
 
 
1027
class ConnectionReset(TransportError):
 
 
1029
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
 
1032
class InvalidRange(TransportError):
 
 
1034
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
 
1036
    def __init__(self, path, offset):
 
 
1037
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
 
1040
        self.offset = offset
 
 
1043
class InvalidHttpResponse(TransportError):
 
 
1045
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
 
1047
    def __init__(self, path, msg, orig_error=None):
 
 
1049
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
1052
class InvalidHttpRange(InvalidHttpResponse):
 
 
1054
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
 
1056
    def __init__(self, path, range, msg):
 
 
1058
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1061
class InvalidHttpContentType(InvalidHttpResponse):
 
 
1063
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
 
1065
    def __init__(self, path, ctype, msg):
 
 
1067
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1070
class ConflictsInTree(BzrError):
 
 
1072
    _fmt = "Working tree has conflicts."
 
 
1075
class ParseConfigError(BzrError):
 
 
1077
    def __init__(self, errors, filename):
 
 
1078
        if filename is None:
 
 
1080
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
1081
            (filename, ('\n'.join(e.message for e in errors)))
 
 
1082
        BzrError.__init__(self, message)
 
 
1085
class NoEmailInUsername(BzrError):
 
 
1087
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
 
1089
    def __init__(self, username):
 
 
1090
        BzrError.__init__(self)
 
 
1091
        self.username = username
 
 
1094
class SigningFailed(BzrError):
 
 
1096
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
 
1098
    def __init__(self, command_line):
 
 
1099
        BzrError.__init__(self, command_line=command_line)
 
 
1102
class WorkingTreeNotRevision(BzrError):
 
 
1104
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
 
1105
            " the last commit, but weave merge requires that it be"
 
 
1108
    def __init__(self, tree):
 
 
1109
        BzrError.__init__(self, basedir=tree.basedir)
 
 
1112
class CantReprocessAndShowBase(BzrError):
 
 
1114
    _fmt = "Can't reprocess and show base, because reprocessing obscures " \
 
 
1115
           "the relationship of conflicting lines to the base"
 
 
1118
class GraphCycleError(BzrError):
 
 
1120
    _fmt = "Cycle in graph %(graph)r"
 
 
1122
    def __init__(self, graph):
 
 
1123
        BzrError.__init__(self)
 
 
1127
class WritingCompleted(BzrError):
 
 
1129
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
 
1130
            "called upon it - accept bytes may not be called anymore.")
 
 
1132
    internal_error = True
 
 
1134
    def __init__(self, request):
 
 
1135
        self.request = request
 
 
1138
class WritingNotComplete(BzrError):
 
 
1140
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
 
1141
            "called upon it - until the write phase is complete no "
 
 
1142
            "data may be read.")
 
 
1144
    internal_error = True
 
 
1146
    def __init__(self, request):
 
 
1147
        self.request = request
 
 
1150
class NotConflicted(BzrError):
 
 
1152
    _fmt = "File %(filename)s is not conflicted."
 
 
1154
    def __init__(self, filename):
 
 
1155
        BzrError.__init__(self)
 
 
1156
        self.filename = filename
 
 
1159
class MediumNotConnected(BzrError):
 
 
1161
    _fmt = """The medium '%(medium)s' is not connected."""
 
 
1163
    internal_error = True
 
 
1165
    def __init__(self, medium):
 
 
1166
        self.medium = medium
 
 
1169
class MustUseDecorated(Exception):
 
 
1171
    _fmt = """A decorating function has requested its original command be used."""
 
 
1174
class NoBundleFound(BzrError):
 
 
1176
    _fmt = "No bundle was found in %(filename)s"
 
 
1178
    def __init__(self, filename):
 
 
1179
        BzrError.__init__(self)
 
 
1180
        self.filename = filename
 
 
1183
class BundleNotSupported(BzrError):
 
 
1185
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
 
1187
    def __init__(self, version, msg):
 
 
1188
        BzrError.__init__(self)
 
 
1189
        self.version = version
 
 
1193
class MissingText(BzrError):
 
 
1195
    _fmt = "Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"
 
 
1197
    def __init__(self, branch, text_revision, file_id):
 
 
1198
        BzrError.__init__(self)
 
 
1199
        self.branch = branch
 
 
1200
        self.base = branch.base
 
 
1201
        self.text_revision = text_revision
 
 
1202
        self.file_id = file_id
 
 
1205
class DuplicateKey(BzrError):
 
 
1207
    _fmt = "Key %(key)s is already present in map"
 
 
1210
class MalformedTransform(BzrError):
 
 
1212
    _fmt = "Tree transform is malformed %(conflicts)r"
 
 
1215
class NoFinalPath(BzrError):
 
 
1217
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
 
1218
            "file-id: %(file_id)r\n"
 
 
1219
            "root trans-id: %(root_trans_id)r\n")
 
 
1221
    def __init__(self, trans_id, transform):
 
 
1222
        self.trans_id = trans_id
 
 
1223
        self.file_id = transform.final_file_id(trans_id)
 
 
1224
        self.root_trans_id = transform.root
 
 
1227
class BzrBadParameter(BzrError):
 
 
1229
    _fmt = "Bad parameter: %(param)r"
 
 
1231
    # This exception should never be thrown, but it is a base class for all
 
 
1232
    # parameter-to-function errors.
 
 
1234
    def __init__(self, param):
 
 
1235
        BzrError.__init__(self)
 
 
1239
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1241
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
 
1244
class ReusingTransform(BzrError):
 
 
1246
    _fmt = "Attempt to reuse a transform that has already been applied."
 
 
1249
class CantMoveRoot(BzrError):
 
 
1251
    _fmt = "Moving the root directory is not supported at this time"
 
 
1254
class BzrBadParameterNotString(BzrBadParameter):
 
 
1256
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
 
1259
class BzrBadParameterMissing(BzrBadParameter):
 
 
1261
    _fmt = "Parameter $(param)s is required but not present."
 
 
1264
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1266
    _fmt = "Parameter %(param)s is unicode but only byte-strings are permitted."
 
 
1269
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1271
    _fmt = "Parameter %(param)s contains a newline."
 
 
1274
class DependencyNotPresent(BzrError):
 
 
1276
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
 
1278
    def __init__(self, library, error):
 
 
1279
        BzrError.__init__(self, library=library, error=error)
 
 
1282
class ParamikoNotPresent(DependencyNotPresent):
 
 
1284
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
 
1286
    def __init__(self, error):
 
 
1287
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1290
class PointlessMerge(BzrError):
 
 
1292
    _fmt = "Nothing to merge."
 
 
1295
class UninitializableFormat(BzrError):
 
 
1297
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
 
1299
    def __init__(self, format):
 
 
1300
        BzrError.__init__(self)
 
 
1301
        self.format = format
 
 
1304
class BadConversionTarget(BzrError):
 
 
1306
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
 
1308
    def __init__(self, problem, format):
 
 
1309
        BzrError.__init__(self)
 
 
1310
        self.problem = problem
 
 
1311
        self.format = format
 
 
1314
class NoDiff(BzrError):
 
 
1316
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
 
1318
    def __init__(self, msg):
 
 
1319
        BzrError.__init__(self, msg=msg)
 
 
1322
class NoDiff3(BzrError):
 
 
1324
    _fmt = "Diff3 is not installed on this machine."
 
 
1327
class ExistingLimbo(BzrError):
 
 
1329
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1330
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1331
    keep, and delete it when you are done."""
 
 
1333
    def __init__(self, limbo_dir):
 
 
1334
       BzrError.__init__(self)
 
 
1335
       self.limbo_dir = limbo_dir
 
 
1338
class ImmortalLimbo(BzrError):
 
 
1340
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
 
1341
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1342
    keep, and delete it when you are done."""
 
 
1344
    def __init__(self, limbo_dir):
 
 
1345
       BzrError.__init__(self)
 
 
1346
       self.limbo_dir = limbo_dir
 
 
1349
class OutOfDateTree(BzrError):
 
 
1351
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
 
1353
    def __init__(self, tree):
 
 
1354
        BzrError.__init__(self)
 
 
1358
class MergeModifiedFormatError(BzrError):
 
 
1360
    _fmt = "Error in merge modified format"
 
 
1363
class ConflictFormatError(BzrError):
 
 
1365
    _fmt = "Format error in conflict listings"
 
 
1368
class CorruptRepository(BzrError):
 
 
1370
    _fmt = """An error has been detected in the repository %(repo_path)s.
 
 
1371
Please run bzr reconcile on this repository."""
 
 
1373
    def __init__(self, repo):
 
 
1374
        BzrError.__init__(self)
 
 
1375
        self.repo_path = repo.bzrdir.root_transport.base
 
 
1378
class UpgradeRequired(BzrError):
 
 
1380
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
 
1382
    def __init__(self, path):
 
 
1383
        BzrError.__init__(self)
 
 
1387
class LocalRequiresBoundBranch(BzrError):
 
 
1389
    _fmt = "Cannot perform local-only commits on unbound branches."
 
 
1392
class MissingProgressBarFinish(BzrError):
 
 
1394
    _fmt = "A nested progress bar was not 'finished' correctly."
 
 
1397
class InvalidProgressBarType(BzrError):
 
 
1399
    _fmt = """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
 
1400
Select one of: %(valid_types)s"""
 
 
1402
    def __init__(self, bar_type, valid_types):
 
 
1403
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
1406
class UnsupportedOperation(BzrError):
 
 
1408
    _fmt = "The method %(mname)s is not supported on objects of type %(tname)s."
 
 
1410
    def __init__(self, method, method_self):
 
 
1411
        self.method = method
 
 
1412
        self.mname = method.__name__
 
 
1413
        self.tname = type(method_self).__name__
 
 
1416
class BinaryFile(BzrError):
 
 
1418
    _fmt = "File is binary but should be text."
 
 
1421
class IllegalPath(BzrError):
 
 
1423
    _fmt = "The path %(path)s is not permitted on this platform"
 
 
1425
    def __init__(self, path):
 
 
1426
        BzrError.__init__(self)
 
 
1430
class TestamentMismatch(BzrError):
 
 
1432
    _fmt = """Testament did not match expected value.  
 
 
1433
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
 
1436
    def __init__(self, revision_id, expected, measured):
 
 
1437
        self.revision_id = revision_id
 
 
1438
        self.expected = expected
 
 
1439
        self.measured = measured
 
 
1442
class NotABundle(BzrError):
 
 
1444
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
 
1446
    def __init__(self, text):
 
 
1447
        BzrError.__init__(self)
 
 
1451
class BadBundle(BzrError): 
 
 
1453
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
 
1455
    def __init__(self, text):
 
 
1456
        BzrError.__init__(self)
 
 
1460
class MalformedHeader(BadBundle): 
 
 
1462
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
 
1465
class MalformedPatches(BadBundle): 
 
 
1467
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
 
1470
class MalformedFooter(BadBundle): 
 
 
1472
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
 
1475
class UnsupportedEOLMarker(BadBundle):
 
 
1477
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
 
1480
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
 
1481
        # but for this there is not
 
 
1482
        BzrError.__init__(self)
 
 
1485
class IncompatibleBundleFormat(BzrError):
 
 
1487
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
 
1489
    def __init__(self, bundle_format, other):
 
 
1490
        BzrError.__init__(self)
 
 
1491
        self.bundle_format = bundle_format
 
 
1495
class BadInventoryFormat(BzrError):
 
 
1497
    _fmt = "Root class for inventory serialization errors"
 
 
1500
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
1502
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
 
1504
    def __init__(self, msg):
 
 
1505
        BadInventoryFormat.__init__(self, msg=msg)
 
 
1508
class NoSmartMedium(BzrError):
 
 
1510
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
 
1512
    def __init__(self, transport):
 
 
1513
        self.transport = transport
 
 
1516
class NoSmartServer(NotBranchError):
 
 
1518
    _fmt = "No smart server available at %(url)s"
 
 
1520
    def __init__(self, url):
 
 
1524
class UnknownSSH(BzrError):
 
 
1526
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
 
1528
    def __init__(self, vendor):
 
 
1529
        BzrError.__init__(self)
 
 
1530
        self.vendor = vendor
 
 
1533
class GhostRevisionUnusableHere(BzrError):
 
 
1535
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
 
1537
    def __init__(self, revision_id):
 
 
1538
        BzrError.__init__(self)
 
 
1539
        self.revision_id = revision_id
 
 
1542
class IllegalUseOfScopeReplacer(BzrError):
 
 
1544
    _fmt = "ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"
 
 
1546
    internal_error = True
 
 
1548
    def __init__(self, name, msg, extra=None):
 
 
1549
        BzrError.__init__(self)
 
 
1553
            self.extra = ': ' + str(extra)
 
 
1558
class InvalidImportLine(BzrError):
 
 
1560
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
 
1562
    internal_error = True
 
 
1564
    def __init__(self, text, msg):
 
 
1565
        BzrError.__init__(self)
 
 
1570
class ImportNameCollision(BzrError):
 
 
1572
    _fmt = "Tried to import an object to the same name as an existing object. %(name)s"
 
 
1574
    internal_error = True
 
 
1576
    def __init__(self, name):
 
 
1577
        BzrError.__init__(self)