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
    internal_error = True
 
 
546
    # All exceptions from the lock/unlock functions should be from
 
 
547
    # this exception class.  They will be translated as necessary. The
 
 
548
    # original exception is available as e.original_error
 
 
550
    # New code should prefer to raise specific subclasses
 
 
551
    def __init__(self, message):
 
 
552
        self.message = message
 
 
555
class CommitNotPossible(LockError):
 
 
557
    _fmt = "A commit was attempted but we do not have a write lock open."
 
 
563
class AlreadyCommitted(LockError):
 
 
565
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
 
571
class ReadOnlyError(LockError):
 
 
573
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
 
575
    def __init__(self, obj):
 
 
579
class OutSideTransaction(BzrError):
 
 
581
    _fmt = "A transaction related operation was attempted after the transaction finished."
 
 
584
class ObjectNotLocked(LockError):
 
 
586
    _fmt = "%(obj)r is not locked"
 
 
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
 
 
617
    internal_error = False
 
 
619
    def __init__(self, lock):
 
 
623
class LockBroken(LockError):
 
 
625
    _fmt = "Lock was broken while still open: %(lock)s - check storage consistency!"
 
 
627
    internal_error = False
 
 
629
    def __init__(self, lock):
 
 
633
class LockBreakMismatch(LockError):
 
 
635
    _fmt = "Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"
 
 
637
    internal_error = False
 
 
639
    def __init__(self, lock, holder, target):
 
 
645
class LockNotHeld(LockError):
 
 
647
    _fmt = "Lock not held: %(lock)s"
 
 
649
    internal_error = False
 
 
651
    def __init__(self, lock):
 
 
655
class PointlessCommit(BzrError):
 
 
657
    _fmt = "No changes to commit"
 
 
660
class UpgradeReadonly(BzrError):
 
 
662
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
 
665
class UpToDateFormat(BzrError):
 
 
667
    _fmt = "The branch format %(format)s is already at the most recent format."
 
 
669
    def __init__(self, format):
 
 
670
        BzrError.__init__(self)
 
 
674
class StrictCommitFailed(Exception):
 
 
676
    _fmt = "Commit refused because there are unknowns in the tree."
 
 
679
class NoSuchRevision(BzrError):
 
 
681
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
 
683
    internal_error = True
 
 
685
    def __init__(self, branch, revision):
 
 
686
        BzrError.__init__(self, branch=branch, revision=revision)
 
 
689
class NoSuchRevisionSpec(BzrError):
 
 
691
    _fmt = "No namespace registered for string: %(spec)r"
 
 
693
    def __init__(self, spec):
 
 
694
        BzrError.__init__(self, spec=spec)
 
 
697
class InvalidRevisionSpec(BzrError):
 
 
699
    _fmt = "Requested revision: %(spec)r does not exist in branch: %(branch)s%(extra)s"
 
 
701
    def __init__(self, spec, branch, extra=None):
 
 
702
        BzrError.__init__(self, branch=branch, spec=spec)
 
 
704
            self.extra = '\n' + str(extra)
 
 
709
class HistoryMissing(BzrError):
 
 
711
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
 
714
class DivergedBranches(BzrError):
 
 
716
    _fmt = "These branches have diverged.  Use the merge command to reconcile them."""
 
 
718
    internal_error = False
 
 
720
    def __init__(self, branch1, branch2):
 
 
721
        self.branch1 = branch1
 
 
722
        self.branch2 = branch2
 
 
725
class UnrelatedBranches(BzrError):
 
 
727
    _fmt = "Branches have no common ancestor, and no merge base revision was specified."
 
 
729
    internal_error = False
 
 
732
class NoCommonAncestor(BzrError):
 
 
734
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
736
    def __init__(self, revision_a, revision_b):
 
 
737
        self.revision_a = revision_a
 
 
738
        self.revision_b = revision_b
 
 
741
class NoCommonRoot(BzrError):
 
 
743
    _fmt = "Revisions are not derived from the same root: " \
 
 
744
           "%(revision_a)s %(revision_b)s."
 
 
746
    def __init__(self, revision_a, revision_b):
 
 
747
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
 
750
class NotAncestor(BzrError):
 
 
752
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
 
754
    def __init__(self, rev_id, not_ancestor_id):
 
 
755
        BzrError.__init__(self, rev_id=rev_id,
 
 
756
            not_ancestor_id=not_ancestor_id)
 
 
759
class InstallFailed(BzrError):
 
 
761
    def __init__(self, revisions):
 
 
762
        revision_str = ", ".join(str(r) for r in revisions)
 
 
763
        msg = "Could not install revisions:\n%s" % revision_str
 
 
764
        BzrError.__init__(self, msg)
 
 
765
        self.revisions = revisions
 
 
768
class AmbiguousBase(BzrError):
 
 
770
    def __init__(self, bases):
 
 
771
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
773
        msg = "The correct base is unclear, because %s are all equally close" %\
 
 
775
        BzrError.__init__(self, msg)
 
 
779
class NoCommits(BzrError):
 
 
781
    _fmt = "Branch %(branch)s has no commits."
 
 
783
    def __init__(self, branch):
 
 
784
        BzrError.__init__(self, branch=branch)
 
 
787
class UnlistableStore(BzrError):
 
 
789
    def __init__(self, store):
 
 
790
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
794
class UnlistableBranch(BzrError):
 
 
796
    def __init__(self, br):
 
 
797
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
800
class BoundBranchOutOfDate(BzrError):
 
 
802
    _fmt = "Bound branch %(branch)s is out of date with master branch %(master)s."
 
 
804
    def __init__(self, branch, master):
 
 
805
        BzrError.__init__(self)
 
 
810
class CommitToDoubleBoundBranch(BzrError):
 
 
812
    _fmt = "Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."
 
 
814
    def __init__(self, branch, master, remote):
 
 
815
        BzrError.__init__(self)
 
 
821
class OverwriteBoundBranch(BzrError):
 
 
823
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
 
825
    def __init__(self, branch):
 
 
826
        BzrError.__init__(self)
 
 
830
class BoundBranchConnectionFailure(BzrError):
 
 
832
    _fmt = "Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"
 
 
834
    def __init__(self, branch, target, error):
 
 
835
        BzrError.__init__(self)
 
 
841
class WeaveError(BzrError):
 
 
843
    _fmt = "Error in processing weave: %(message)s"
 
 
845
    def __init__(self, message=None):
 
 
846
        BzrError.__init__(self)
 
 
847
        self.message = message
 
 
850
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
852
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
 
854
    def __init__(self, revision_id, weave):
 
 
856
        WeaveError.__init__(self)
 
 
857
        self.revision_id = revision_id
 
 
861
class WeaveRevisionNotPresent(WeaveError):
 
 
863
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
 
865
    def __init__(self, revision_id, weave):
 
 
866
        WeaveError.__init__(self)
 
 
867
        self.revision_id = revision_id
 
 
871
class WeaveFormatError(WeaveError):
 
 
873
    _fmt = "Weave invariant violated: %(what)s"
 
 
875
    def __init__(self, what):
 
 
876
        WeaveError.__init__(self)
 
 
880
class WeaveParentMismatch(WeaveError):
 
 
882
    _fmt = "Parents are mismatched between two revisions."
 
 
885
class WeaveInvalidChecksum(WeaveError):
 
 
887
    _fmt = "Text did not match it's checksum: %(message)s"
 
 
890
class WeaveTextDiffers(WeaveError):
 
 
892
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
 
894
    def __init__(self, revision_id, weave_a, weave_b):
 
 
895
        WeaveError.__init__(self)
 
 
896
        self.revision_id = revision_id
 
 
897
        self.weave_a = weave_a
 
 
898
        self.weave_b = weave_b
 
 
901
class WeaveTextDiffers(WeaveError):
 
 
903
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
 
905
    def __init__(self, revision_id, weave_a, weave_b):
 
 
906
        WeaveError.__init__(self)
 
 
907
        self.revision_id = revision_id
 
 
908
        self.weave_a = weave_a
 
 
909
        self.weave_b = weave_b
 
 
912
class VersionedFileError(BzrError):
 
 
914
    _fmt = "Versioned file error"
 
 
917
class RevisionNotPresent(VersionedFileError):
 
 
919
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
 
921
    def __init__(self, revision_id, file_id):
 
 
922
        VersionedFileError.__init__(self)
 
 
923
        self.revision_id = revision_id
 
 
924
        self.file_id = file_id
 
 
927
class RevisionAlreadyPresent(VersionedFileError):
 
 
929
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
 
931
    def __init__(self, revision_id, file_id):
 
 
932
        VersionedFileError.__init__(self)
 
 
933
        self.revision_id = revision_id
 
 
934
        self.file_id = file_id
 
 
937
class KnitError(BzrError):
 
 
941
    internal_error = True
 
 
944
class KnitHeaderError(KnitError):
 
 
946
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
 
948
    def __init__(self, badline, filename):
 
 
949
        KnitError.__init__(self)
 
 
950
        self.badline = badline
 
 
951
        self.filename = filename
 
 
954
class KnitCorrupt(KnitError):
 
 
956
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
 
958
    def __init__(self, filename, how):
 
 
959
        KnitError.__init__(self)
 
 
960
        self.filename = filename
 
 
964
class KnitIndexUnknownMethod(KnitError):
 
 
965
    """Raised when we don't understand the storage method.
 
 
967
    Currently only 'fulltext' and 'line-delta' are supported.
 
 
970
    _fmt = ("Knit index %(filename)s does not have a known method"
 
 
971
            " in options: %(options)r")
 
 
973
    def __init__(self, filename, options):
 
 
974
        KnitError.__init__(self)
 
 
975
        self.filename = filename
 
 
976
        self.options = options
 
 
979
class NoSuchExportFormat(BzrError):
 
 
981
    _fmt = "Export format %(format)r not supported"
 
 
983
    def __init__(self, format):
 
 
984
        BzrError.__init__(self)
 
 
988
class TransportError(BzrError):
 
 
990
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
 
992
    def __init__(self, msg=None, orig_error=None):
 
 
993
        if msg is None and orig_error is not None:
 
 
994
            msg = str(orig_error)
 
 
995
        if orig_error is None:
 
 
1000
        self.orig_error = orig_error
 
 
1001
        BzrError.__init__(self)
 
 
1004
class TooManyConcurrentRequests(BzrError):
 
 
1006
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit. "
 
 
1007
            "Be sure to finish_writing and finish_reading on the "
 
 
1008
            "current request that is open.")
 
 
1010
    internal_error = True
 
 
1012
    def __init__(self, medium):
 
 
1013
        self.medium = medium
 
 
1016
class SmartProtocolError(TransportError):
 
 
1018
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
 
1020
    def __init__(self, details):
 
 
1021
        self.details = details
 
 
1024
# A set of semi-meaningful errors which can be thrown
 
 
1025
class TransportNotPossible(TransportError):
 
 
1027
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
 
1030
class ConnectionError(TransportError):
 
 
1032
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
 
1035
class SocketConnectionError(ConnectionError):
 
 
1037
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
 
1039
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
1041
            msg = 'Failed to connect to'
 
 
1042
        if orig_error is None:
 
 
1045
            orig_error = '; ' + str(orig_error)
 
 
1046
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
1051
            self.port = ':%s' % port
 
 
1054
class ConnectionReset(TransportError):
 
 
1056
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
 
1059
class InvalidRange(TransportError):
 
 
1061
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
 
1063
    def __init__(self, path, offset):
 
 
1064
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
 
1067
        self.offset = offset
 
 
1070
class InvalidHttpResponse(TransportError):
 
 
1072
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
 
1074
    def __init__(self, path, msg, orig_error=None):
 
 
1076
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
1079
class InvalidHttpRange(InvalidHttpResponse):
 
 
1081
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
 
1083
    def __init__(self, path, range, msg):
 
 
1085
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1088
class InvalidHttpContentType(InvalidHttpResponse):
 
 
1090
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
 
1092
    def __init__(self, path, ctype, msg):
 
 
1094
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1097
class ConflictsInTree(BzrError):
 
 
1099
    _fmt = "Working tree has conflicts."
 
 
1102
class ParseConfigError(BzrError):
 
 
1104
    def __init__(self, errors, filename):
 
 
1105
        if filename is None:
 
 
1107
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
1108
            (filename, ('\n'.join(e.message for e in errors)))
 
 
1109
        BzrError.__init__(self, message)
 
 
1112
class NoEmailInUsername(BzrError):
 
 
1114
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
 
1116
    def __init__(self, username):
 
 
1117
        BzrError.__init__(self)
 
 
1118
        self.username = username
 
 
1121
class SigningFailed(BzrError):
 
 
1123
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
 
1125
    def __init__(self, command_line):
 
 
1126
        BzrError.__init__(self, command_line=command_line)
 
 
1129
class WorkingTreeNotRevision(BzrError):
 
 
1131
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
 
1132
            " the last commit, but weave merge requires that it be"
 
 
1135
    def __init__(self, tree):
 
 
1136
        BzrError.__init__(self, basedir=tree.basedir)
 
 
1139
class CantReprocessAndShowBase(BzrError):
 
 
1141
    _fmt = "Can't reprocess and show base, because reprocessing obscures " \
 
 
1142
           "the relationship of conflicting lines to the base"
 
 
1145
class GraphCycleError(BzrError):
 
 
1147
    _fmt = "Cycle in graph %(graph)r"
 
 
1149
    def __init__(self, graph):
 
 
1150
        BzrError.__init__(self)
 
 
1154
class WritingCompleted(BzrError):
 
 
1156
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
 
1157
            "called upon it - accept bytes may not be called anymore.")
 
 
1159
    internal_error = True
 
 
1161
    def __init__(self, request):
 
 
1162
        self.request = request
 
 
1165
class WritingNotComplete(BzrError):
 
 
1167
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
 
1168
            "called upon it - until the write phase is complete no "
 
 
1169
            "data may be read.")
 
 
1171
    internal_error = True
 
 
1173
    def __init__(self, request):
 
 
1174
        self.request = request
 
 
1177
class NotConflicted(BzrError):
 
 
1179
    _fmt = "File %(filename)s is not conflicted."
 
 
1181
    def __init__(self, filename):
 
 
1182
        BzrError.__init__(self)
 
 
1183
        self.filename = filename
 
 
1186
class MediumNotConnected(BzrError):
 
 
1188
    _fmt = """The medium '%(medium)s' is not connected."""
 
 
1190
    internal_error = True
 
 
1192
    def __init__(self, medium):
 
 
1193
        self.medium = medium
 
 
1196
class MustUseDecorated(Exception):
 
 
1198
    _fmt = """A decorating function has requested its original command be used."""
 
 
1201
class NoBundleFound(BzrError):
 
 
1203
    _fmt = "No bundle was found in %(filename)s"
 
 
1205
    def __init__(self, filename):
 
 
1206
        BzrError.__init__(self)
 
 
1207
        self.filename = filename
 
 
1210
class BundleNotSupported(BzrError):
 
 
1212
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
 
1214
    def __init__(self, version, msg):
 
 
1215
        BzrError.__init__(self)
 
 
1216
        self.version = version
 
 
1220
class MissingText(BzrError):
 
 
1222
    _fmt = "Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"
 
 
1224
    def __init__(self, branch, text_revision, file_id):
 
 
1225
        BzrError.__init__(self)
 
 
1226
        self.branch = branch
 
 
1227
        self.base = branch.base
 
 
1228
        self.text_revision = text_revision
 
 
1229
        self.file_id = file_id
 
 
1232
class DuplicateKey(BzrError):
 
 
1234
    _fmt = "Key %(key)s is already present in map"
 
 
1237
class MalformedTransform(BzrError):
 
 
1239
    _fmt = "Tree transform is malformed %(conflicts)r"
 
 
1242
class NoFinalPath(BzrError):
 
 
1244
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
 
1245
            "file-id: %(file_id)r\n"
 
 
1246
            "root trans-id: %(root_trans_id)r\n")
 
 
1248
    def __init__(self, trans_id, transform):
 
 
1249
        self.trans_id = trans_id
 
 
1250
        self.file_id = transform.final_file_id(trans_id)
 
 
1251
        self.root_trans_id = transform.root
 
 
1254
class BzrBadParameter(BzrError):
 
 
1256
    _fmt = "Bad parameter: %(param)r"
 
 
1258
    # This exception should never be thrown, but it is a base class for all
 
 
1259
    # parameter-to-function errors.
 
 
1261
    def __init__(self, param):
 
 
1262
        BzrError.__init__(self)
 
 
1266
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1268
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
 
1271
class ReusingTransform(BzrError):
 
 
1273
    _fmt = "Attempt to reuse a transform that has already been applied."
 
 
1276
class CantMoveRoot(BzrError):
 
 
1278
    _fmt = "Moving the root directory is not supported at this time"
 
 
1281
class BzrBadParameterNotString(BzrBadParameter):
 
 
1283
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
 
1286
class BzrBadParameterMissing(BzrBadParameter):
 
 
1288
    _fmt = "Parameter $(param)s is required but not present."
 
 
1291
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1293
    _fmt = "Parameter %(param)s is unicode but only byte-strings are permitted."
 
 
1296
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1298
    _fmt = "Parameter %(param)s contains a newline."
 
 
1301
class DependencyNotPresent(BzrError):
 
 
1303
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
 
1305
    def __init__(self, library, error):
 
 
1306
        BzrError.__init__(self, library=library, error=error)
 
 
1309
class ParamikoNotPresent(DependencyNotPresent):
 
 
1311
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
 
1313
    def __init__(self, error):
 
 
1314
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1317
class PointlessMerge(BzrError):
 
 
1319
    _fmt = "Nothing to merge."
 
 
1322
class UninitializableFormat(BzrError):
 
 
1324
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
 
1326
    def __init__(self, format):
 
 
1327
        BzrError.__init__(self)
 
 
1328
        self.format = format
 
 
1331
class BadConversionTarget(BzrError):
 
 
1333
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
 
1335
    def __init__(self, problem, format):
 
 
1336
        BzrError.__init__(self)
 
 
1337
        self.problem = problem
 
 
1338
        self.format = format
 
 
1341
class NoDiff(BzrError):
 
 
1343
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
 
1345
    def __init__(self, msg):
 
 
1346
        BzrError.__init__(self, msg=msg)
 
 
1349
class NoDiff3(BzrError):
 
 
1351
    _fmt = "Diff3 is not installed on this machine."
 
 
1354
class ExistingLimbo(BzrError):
 
 
1356
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1357
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1358
    keep, and delete it when you are done."""
 
 
1360
    def __init__(self, limbo_dir):
 
 
1361
       BzrError.__init__(self)
 
 
1362
       self.limbo_dir = limbo_dir
 
 
1365
class ImmortalLimbo(BzrError):
 
 
1367
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
 
1368
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1369
    keep, and delete it when you are done."""
 
 
1371
    def __init__(self, limbo_dir):
 
 
1372
       BzrError.__init__(self)
 
 
1373
       self.limbo_dir = limbo_dir
 
 
1376
class OutOfDateTree(BzrError):
 
 
1378
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
 
1380
    def __init__(self, tree):
 
 
1381
        BzrError.__init__(self)
 
 
1385
class MergeModifiedFormatError(BzrError):
 
 
1387
    _fmt = "Error in merge modified format"
 
 
1390
class ConflictFormatError(BzrError):
 
 
1392
    _fmt = "Format error in conflict listings"
 
 
1395
class CorruptRepository(BzrError):
 
 
1397
    _fmt = """An error has been detected in the repository %(repo_path)s.
 
 
1398
Please run bzr reconcile on this repository."""
 
 
1400
    def __init__(self, repo):
 
 
1401
        BzrError.__init__(self)
 
 
1402
        self.repo_path = repo.bzrdir.root_transport.base
 
 
1405
class UpgradeRequired(BzrError):
 
 
1407
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
 
1409
    def __init__(self, path):
 
 
1410
        BzrError.__init__(self)
 
 
1414
class LocalRequiresBoundBranch(BzrError):
 
 
1416
    _fmt = "Cannot perform local-only commits on unbound branches."
 
 
1419
class MissingProgressBarFinish(BzrError):
 
 
1421
    _fmt = "A nested progress bar was not 'finished' correctly."
 
 
1424
class InvalidProgressBarType(BzrError):
 
 
1426
    _fmt = """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
 
1427
Select one of: %(valid_types)s"""
 
 
1429
    def __init__(self, bar_type, valid_types):
 
 
1430
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
1433
class UnsupportedOperation(BzrError):
 
 
1435
    _fmt = "The method %(mname)s is not supported on objects of type %(tname)s."
 
 
1437
    def __init__(self, method, method_self):
 
 
1438
        self.method = method
 
 
1439
        self.mname = method.__name__
 
 
1440
        self.tname = type(method_self).__name__
 
 
1443
class CannotSetRevisionId(UnsupportedOperation):
 
 
1444
    """Raised when a commit is attempting to set a revision id but cant."""
 
 
1447
class NonAsciiRevisionId(UnsupportedOperation):
 
 
1448
    """Raised when a commit is attempting to set a non-ascii revision id but cant."""
 
 
1451
class BinaryFile(BzrError):
 
 
1453
    _fmt = "File is binary but should be text."
 
 
1456
class IllegalPath(BzrError):
 
 
1458
    _fmt = "The path %(path)s is not permitted on this platform"
 
 
1460
    def __init__(self, path):
 
 
1461
        BzrError.__init__(self)
 
 
1465
class TestamentMismatch(BzrError):
 
 
1467
    _fmt = """Testament did not match expected value.  
 
 
1468
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
 
1471
    def __init__(self, revision_id, expected, measured):
 
 
1472
        self.revision_id = revision_id
 
 
1473
        self.expected = expected
 
 
1474
        self.measured = measured
 
 
1477
class NotABundle(BzrError):
 
 
1479
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
 
1481
    def __init__(self, text):
 
 
1482
        BzrError.__init__(self)
 
 
1486
class BadBundle(BzrError): 
 
 
1488
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
 
1490
    def __init__(self, text):
 
 
1491
        BzrError.__init__(self)
 
 
1495
class MalformedHeader(BadBundle): 
 
 
1497
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
 
1500
class MalformedPatches(BadBundle): 
 
 
1502
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
 
1505
class MalformedFooter(BadBundle): 
 
 
1507
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
 
1510
class UnsupportedEOLMarker(BadBundle):
 
 
1512
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
 
1515
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
 
1516
        # but for this there is not
 
 
1517
        BzrError.__init__(self)
 
 
1520
class IncompatibleBundleFormat(BzrError):
 
 
1522
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
 
1524
    def __init__(self, bundle_format, other):
 
 
1525
        BzrError.__init__(self)
 
 
1526
        self.bundle_format = bundle_format
 
 
1530
class BadInventoryFormat(BzrError):
 
 
1532
    _fmt = "Root class for inventory serialization errors"
 
 
1535
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
1537
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
 
1539
    def __init__(self, msg):
 
 
1540
        BadInventoryFormat.__init__(self, msg=msg)
 
 
1543
class NoSmartMedium(BzrError):
 
 
1545
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
 
1547
    def __init__(self, transport):
 
 
1548
        self.transport = transport
 
 
1551
class NoSmartServer(NotBranchError):
 
 
1553
    _fmt = "No smart server available at %(url)s"
 
 
1555
    def __init__(self, url):
 
 
1559
class UnknownSSH(BzrError):
 
 
1561
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
 
1563
    def __init__(self, vendor):
 
 
1564
        BzrError.__init__(self)
 
 
1565
        self.vendor = vendor
 
 
1568
class GhostRevisionUnusableHere(BzrError):
 
 
1570
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
 
1572
    def __init__(self, revision_id):
 
 
1573
        BzrError.__init__(self)
 
 
1574
        self.revision_id = revision_id
 
 
1577
class IllegalUseOfScopeReplacer(BzrError):
 
 
1579
    _fmt = "ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"
 
 
1581
    internal_error = True
 
 
1583
    def __init__(self, name, msg, extra=None):
 
 
1584
        BzrError.__init__(self)
 
 
1588
            self.extra = ': ' + str(extra)
 
 
1593
class InvalidImportLine(BzrError):
 
 
1595
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
 
1597
    internal_error = True
 
 
1599
    def __init__(self, text, msg):
 
 
1600
        BzrError.__init__(self)
 
 
1605
class ImportNameCollision(BzrError):
 
 
1607
    _fmt = "Tried to import an object to the same name as an existing object. %(name)s"
 
 
1609
    internal_error = True
 
 
1611
    def __init__(self, name):
 
 
1612
        BzrError.__init__(self)