1
# Copyright (C) 2005, 2006, 2007 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.
 
 
25
from bzrlib.patches import (
 
 
34
# TODO: is there any value in providing the .args field used by standard
 
 
35
# python exceptions?   A list of values with no names seems less useful 
 
 
38
# TODO: Perhaps convert the exception to a string at the moment it's 
 
 
39
# constructed to make sure it will succeed.  But that says nothing about
 
 
40
# exceptions that are never raised.
 
 
42
# TODO: selftest assertRaises should probably also check that every error
 
 
43
# raised can be formatted as a string successfully, and without giving
 
 
47
class BzrError(StandardError):
 
 
49
    Base class for errors raised by bzrlib.
 
 
51
    :cvar internal_error: if true (or absent) this was probably caused by a
 
 
52
    bzr bug and should be displayed with a traceback; if False this was
 
 
53
    probably a user or environment error and they don't need the gory details.
 
 
54
    (That can be overridden by -Derror on the command line.)
 
 
56
    :cvar _fmt: Format string to display the error; this is expanded
 
 
57
    by the instance's dict.
 
 
60
    internal_error = False
 
 
62
    def __init__(self, msg=None, **kwds):
 
 
63
        """Construct a new BzrError.
 
 
65
        There are two alternative forms for constructing these objects.
 
 
66
        Either a preformatted string may be passed, or a set of named
 
 
67
        arguments can be given.  The first is for generic "user" errors which
 
 
68
        are not intended to be caught and so do not need a specific subclass.
 
 
69
        The second case is for use with subclasses that provide a _fmt format
 
 
70
        string to print the arguments.  
 
 
72
        Keyword arguments are taken as parameters to the error, which can 
 
 
73
        be inserted into the format string template.  It's recommended 
 
 
74
        that subclasses override the __init__ method to require specific 
 
 
77
        :param msg: If given, this is the literal complete text for the error,
 
 
78
        not subject to expansion.
 
 
80
        StandardError.__init__(self)
 
 
82
            # I was going to deprecate this, but it actually turns out to be
 
 
83
            # quite handy - mbp 20061103.
 
 
84
            self._preformatted_string = msg
 
 
86
            self._preformatted_string = None
 
 
87
            for key, value in kwds.items():
 
 
88
                setattr(self, key, value)
 
 
91
        s = getattr(self, '_preformatted_string', None)
 
 
93
            # contains a preformatted message; must be cast to plain str
 
 
96
            fmt = self._get_format_string()
 
 
98
                s = fmt % self.__dict__
 
 
99
                # __str__() should always return a 'str' object
 
 
100
                # never a 'unicode' object.
 
 
101
                if isinstance(s, unicode):
 
 
102
                    return s.encode('utf8')
 
 
104
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
 
 
105
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%s' \
 
 
106
                % (self.__class__.__name__,
 
 
108
                   getattr(self, '_fmt', None),
 
 
111
    def _get_format_string(self):
 
 
112
        """Return format string for this exception or None"""
 
 
113
        fmt = getattr(self, '_fmt', None)
 
 
116
        fmt = getattr(self, '__doc__', None)
 
 
118
            symbol_versioning.warn("%s uses its docstring as a format, "
 
 
119
                    "it should use _fmt instead" % self.__class__.__name__,
 
 
122
        return 'Unprintable exception %s: dict=%r, fmt=%r' \
 
 
123
            % (self.__class__.__name__,
 
 
125
               getattr(self, '_fmt', None),
 
 
129
class BzrNewError(BzrError):
 
 
130
    """Deprecated error base class."""
 
 
131
    # base classes should override the docstring with their human-
 
 
132
    # readable explanation
 
 
134
    def __init__(self, *args, **kwds):
 
 
135
        # XXX: Use the underlying BzrError to always generate the args
 
 
136
        # attribute if it doesn't exist.  We can't use super here, because
 
 
137
        # exceptions are old-style classes in python2.4 (but new in 2.5).
 
 
139
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
 
 
140
             'please convert %s to use BzrError instead'
 
 
141
             % self.__class__.__name__,
 
 
144
        BzrError.__init__(self, *args)
 
 
145
        for key, value in kwds.items():
 
 
146
            setattr(self, key, value)
 
 
150
            # __str__() should always return a 'str' object
 
 
151
            # never a 'unicode' object.
 
 
152
            s = self.__doc__ % self.__dict__
 
 
153
            if isinstance(s, unicode):
 
 
154
                return s.encode('utf8')
 
 
156
        except (TypeError, NameError, ValueError, KeyError), e:
 
 
157
            return 'Unprintable exception %s(%r): %s' \
 
 
158
                % (self.__class__.__name__,
 
 
159
                   self.__dict__, str(e))
 
 
162
class AlreadyBuilding(BzrError):
 
 
164
    _fmt = "The tree builder is already building a tree."
 
 
167
class BzrCheckError(BzrError):
 
 
169
    _fmt = "Internal check failed: %(message)s"
 
 
171
    internal_error = True
 
 
173
    def __init__(self, message):
 
 
174
        BzrError.__init__(self)
 
 
175
        self.message = message
 
 
178
class InvalidEntryName(BzrError):
 
 
180
    _fmt = "Invalid entry name: %(name)s"
 
 
182
    internal_error = True
 
 
184
    def __init__(self, name):
 
 
185
        BzrError.__init__(self)
 
 
189
class InvalidRevisionNumber(BzrError):
 
 
191
    _fmt = "Invalid revision number %(revno)s"
 
 
193
    def __init__(self, revno):
 
 
194
        BzrError.__init__(self)
 
 
198
class InvalidRevisionId(BzrError):
 
 
200
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
 
202
    def __init__(self, revision_id, branch):
 
 
203
        # branch can be any string or object with __str__ defined
 
 
204
        BzrError.__init__(self)
 
 
205
        self.revision_id = revision_id
 
 
208
class ReservedId(BzrError):
 
 
210
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
 
212
    def __init__(self, revision_id):
 
 
213
        self.revision_id = revision_id
 
 
215
class NoSuchId(BzrError):
 
 
217
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
 
219
    def __init__(self, tree, file_id):
 
 
220
        BzrError.__init__(self)
 
 
221
        self.file_id = file_id
 
 
225
class InventoryModified(BzrError):
 
 
227
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
 
228
            " so a clean inventory cannot be read without data loss.")
 
 
230
    internal_error = True
 
 
232
    def __init__(self, tree):
 
 
236
class NoWorkingTree(BzrError):
 
 
238
    _fmt = "No WorkingTree exists for %(base)s."
 
 
240
    def __init__(self, base):
 
 
241
        BzrError.__init__(self)
 
 
245
class NotBuilding(BzrError):
 
 
247
    _fmt = "Not currently building a tree."
 
 
250
class NotLocalUrl(BzrError):
 
 
252
    _fmt = "%(url)s is not a local path."
 
 
254
    def __init__(self, url):
 
 
258
class WorkingTreeAlreadyPopulated(BzrError):
 
 
260
    _fmt = """Working tree already populated in %(base)s"""
 
 
262
    internal_error = True
 
 
264
    def __init__(self, base):
 
 
267
class BzrCommandError(BzrError):
 
 
268
    """Error from user command"""
 
 
270
    internal_error = False
 
 
272
    # Error from malformed user command; please avoid raising this as a
 
 
273
    # generic exception not caused by user input.
 
 
275
    # I think it's a waste of effort to differentiate between errors that
 
 
276
    # are not intended to be caught anyway.  UI code need not subclass
 
 
277
    # BzrCommandError, and non-UI code should not throw a subclass of
 
 
278
    # BzrCommandError.  ADHB 20051211
 
 
279
    def __init__(self, msg):
 
 
280
        # Object.__str__() must return a real string
 
 
281
        # returning a Unicode string is a python error.
 
 
282
        if isinstance(msg, unicode):
 
 
283
            self.msg = msg.encode('utf8')
 
 
291
class NotWriteLocked(BzrError):
 
 
293
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
 
295
    def __init__(self, not_locked):
 
 
296
        self.not_locked = not_locked
 
 
299
class BzrOptionError(BzrCommandError):
 
 
301
    _fmt = "Error in command line options"
 
 
304
class BadOptionValue(BzrError):
 
 
306
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
 
308
    def __init__(self, name, value):
 
 
309
        BzrError.__init__(self, name=name, value=value)
 
 
312
class StrictCommitFailed(BzrError):
 
 
314
    _fmt = "Commit refused because there are unknown files in the tree"
 
 
317
# XXX: Should be unified with TransportError; they seem to represent the
 
 
319
class PathError(BzrError):
 
 
321
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
 
323
    def __init__(self, path, extra=None):
 
 
324
        BzrError.__init__(self)
 
 
327
            self.extra = ': ' + str(extra)
 
 
332
class NoSuchFile(PathError):
 
 
334
    _fmt = "No such file: %(path)r%(extra)s"
 
 
337
class FileExists(PathError):
 
 
339
    _fmt = "File exists: %(path)r%(extra)s"
 
 
342
class RenameFailedFilesExist(BzrError):
 
 
343
    """Used when renaming and both source and dest exist."""
 
 
345
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
 
348
    def __init__(self, source, dest, extra=None):
 
 
349
        BzrError.__init__(self)
 
 
350
        self.source = str(source)
 
 
351
        self.dest = str(dest)
 
 
353
            self.extra = ' ' + str(extra)
 
 
358
class NotADirectory(PathError):
 
 
360
    _fmt = "%(path)r is not a directory %(extra)s"
 
 
363
class NotInWorkingDirectory(PathError):
 
 
365
    _fmt = "%(path)r is not in the working directory %(extra)s"
 
 
368
class DirectoryNotEmpty(PathError):
 
 
370
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
 
373
class ReadingCompleted(BzrError):
 
 
375
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
 
376
            "called upon it - the request has been completed and no more "
 
 
379
    internal_error = True
 
 
381
    def __init__(self, request):
 
 
382
        self.request = request
 
 
385
class ResourceBusy(PathError):
 
 
387
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
 
390
class PermissionDenied(PathError):
 
 
392
    _fmt = "Permission denied: %(path)r%(extra)s"
 
 
395
class InvalidURL(PathError):
 
 
397
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
 
400
class InvalidURLJoin(PathError):
 
 
402
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
 
404
    def __init__(self, msg, base, args):
 
 
405
        PathError.__init__(self, base, msg)
 
 
406
        self.args = [base] + list(args)
 
 
409
class UnknownHook(BzrError):
 
 
411
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
 
413
    def __init__(self, hook_type, hook_name):
 
 
414
        BzrError.__init__(self)
 
 
415
        self.type = hook_type
 
 
416
        self.hook = hook_name
 
 
419
class UnsupportedProtocol(PathError):
 
 
421
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
 
423
    def __init__(self, url, extra):
 
 
424
        PathError.__init__(self, url, extra=extra)
 
 
427
class ShortReadvError(PathError):
 
 
429
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
 
 
430
            " at %(offset)s for %(path)s%(extra)s")
 
 
432
    internal_error = True
 
 
434
    def __init__(self, path, offset, length, actual, extra=None):
 
 
435
        PathError.__init__(self, path, extra=extra)
 
 
441
class PathNotChild(BzrError):
 
 
443
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
 
445
    internal_error = True
 
 
447
    def __init__(self, path, base, extra=None):
 
 
448
        BzrError.__init__(self)
 
 
452
            self.extra = ': ' + str(extra)
 
 
457
class InvalidNormalization(PathError):
 
 
459
    _fmt = "Path %(path)r is not unicode normalized"
 
 
462
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
463
# the exception object is a bit undesirable.
 
 
464
# TODO: Probably this behavior of should be a common superclass 
 
 
465
class NotBranchError(PathError):
 
 
467
    _fmt = "Not a branch: %(path)s"
 
 
469
    def __init__(self, path):
 
 
470
       import bzrlib.urlutils as urlutils
 
 
471
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
474
class NoSubmitBranch(PathError):
 
 
476
    _fmt = 'No submit branch available for branch "%(path)s"'
 
 
478
    def __init__(self, branch):
 
 
479
       import bzrlib.urlutils as urlutils
 
 
480
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
 
483
class AlreadyBranchError(PathError):
 
 
485
    _fmt = "Already a branch: %(path)s."
 
 
488
class BranchExistsWithoutWorkingTree(PathError):
 
 
490
    _fmt = "Directory contains a branch, but no working tree \
 
 
491
(use bzr checkout if you wish to build a working tree): %(path)s"
 
 
494
class AtomicFileAlreadyClosed(PathError):
 
 
496
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
 
499
    def __init__(self, path, function):
 
 
500
        PathError.__init__(self, path=path, extra=None)
 
 
501
        self.function = function
 
 
504
class InaccessibleParent(PathError):
 
 
506
    _fmt = ("Parent not accessible given base %(base)s and"
 
 
507
            " relative path %(path)s")
 
 
509
    def __init__(self, path, base):
 
 
510
        PathError.__init__(self, path)
 
 
514
class NoRepositoryPresent(BzrError):
 
 
516
    _fmt = "No repository present: %(path)r"
 
 
517
    def __init__(self, bzrdir):
 
 
518
        BzrError.__init__(self)
 
 
519
        self.path = bzrdir.transport.clone('..').base
 
 
522
class FileInWrongBranch(BzrError):
 
 
524
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
 
526
    def __init__(self, branch, path):
 
 
527
        BzrError.__init__(self)
 
 
529
        self.branch_base = branch.base
 
 
533
class UnsupportedFormatError(BzrError):
 
 
535
    _fmt = "Unsupported branch format: %(format)s"
 
 
538
class UnknownFormatError(BzrError):
 
 
540
    _fmt = "Unknown branch format: %(format)r"
 
 
543
class IncompatibleFormat(BzrError):
 
 
545
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
 
547
    def __init__(self, format, bzrdir_format):
 
 
548
        BzrError.__init__(self)
 
 
550
        self.bzrdir = bzrdir_format
 
 
553
class IncompatibleRevision(BzrError):
 
 
555
    _fmt = "Revision is not compatible with %(repo_format)s"
 
 
557
    def __init__(self, repo_format):
 
 
558
        BzrError.__init__(self)
 
 
559
        self.repo_format = repo_format
 
 
562
class AlreadyVersionedError(BzrError):
 
 
563
    """Used when a path is expected not to be versioned, but it is."""
 
 
565
    _fmt = "%(context_info)s%(path)s is already versioned"
 
 
567
    def __init__(self, path, context_info=None):
 
 
568
        """Construct a new AlreadyVersionedError.
 
 
570
        :param path: This is the path which is versioned,
 
 
571
        which should be in a user friendly form.
 
 
572
        :param context_info: If given, this is information about the context,
 
 
573
        which could explain why this is expected to not be versioned.
 
 
575
        BzrError.__init__(self)
 
 
577
        if context_info is None:
 
 
578
            self.context_info = ''
 
 
580
            self.context_info = context_info + ". "
 
 
583
class NotVersionedError(BzrError):
 
 
584
    """Used when a path is expected to be versioned, but it is not."""
 
 
586
    _fmt = "%(context_info)s%(path)s is not versioned"
 
 
588
    def __init__(self, path, context_info=None):
 
 
589
        """Construct a new NotVersionedError.
 
 
591
        :param path: This is the path which is not versioned,
 
 
592
        which should be in a user friendly form.
 
 
593
        :param context_info: If given, this is information about the context,
 
 
594
        which could explain why this is expected to be versioned.
 
 
596
        BzrError.__init__(self)
 
 
598
        if context_info is None:
 
 
599
            self.context_info = ''
 
 
601
            self.context_info = context_info + ". "
 
 
604
class PathsNotVersionedError(BzrError):
 
 
605
    """Used when reporting several paths which are not versioned"""
 
 
607
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
 
609
    def __init__(self, paths):
 
 
610
        from bzrlib.osutils import quotefn
 
 
611
        BzrError.__init__(self)
 
 
613
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
616
class PathsDoNotExist(BzrError):
 
 
618
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
 
620
    # used when reporting that paths are neither versioned nor in the working
 
 
623
    def __init__(self, paths, extra=None):
 
 
625
        from bzrlib.osutils import quotefn
 
 
626
        BzrError.__init__(self)
 
 
628
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
630
            self.extra = ': ' + str(extra)
 
 
635
class BadFileKindError(BzrError):
 
 
637
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
 
639
    def __init__(self, filename, kind):
 
 
640
        BzrError.__init__(self, filename=filename, kind=kind)
 
 
643
class ForbiddenControlFileError(BzrError):
 
 
645
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
 
648
class LockError(BzrError):
 
 
650
    _fmt = "Lock error: %(message)s"
 
 
652
    internal_error = True
 
 
654
    # All exceptions from the lock/unlock functions should be from
 
 
655
    # this exception class.  They will be translated as necessary. The
 
 
656
    # original exception is available as e.original_error
 
 
658
    # New code should prefer to raise specific subclasses
 
 
659
    def __init__(self, message):
 
 
660
        self.message = message
 
 
663
class LockActive(LockError):
 
 
665
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
 
667
    internal_error = False
 
 
669
    def __init__(self, lock_description):
 
 
670
        self.lock_description = lock_description
 
 
673
class CommitNotPossible(LockError):
 
 
675
    _fmt = "A commit was attempted but we do not have a write lock open."
 
 
681
class AlreadyCommitted(LockError):
 
 
683
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
 
689
class ReadOnlyError(LockError):
 
 
691
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
 
693
    # TODO: There should also be an error indicating that you need a write
 
 
694
    # lock and don't have any lock at all... mbp 20070226
 
 
696
    def __init__(self, obj):
 
 
700
class OutSideTransaction(BzrError):
 
 
702
    _fmt = ("A transaction related operation was attempted after"
 
 
703
            " the transaction finished.")
 
 
706
class ObjectNotLocked(LockError):
 
 
708
    _fmt = "%(obj)r is not locked"
 
 
710
    # this can indicate that any particular object is not locked; see also
 
 
711
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
712
    # the caller -- perhaps they should be unified.
 
 
713
    def __init__(self, obj):
 
 
717
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
719
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
 
721
    def __init__(self, obj):
 
 
725
class UnlockableTransport(LockError):
 
 
727
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
 
729
    def __init__(self, transport):
 
 
730
        self.transport = transport
 
 
733
class LockContention(LockError):
 
 
735
    _fmt = "Could not acquire lock %(lock)s"
 
 
736
    # TODO: show full url for lock, combining the transport and relative
 
 
739
    internal_error = False
 
 
741
    def __init__(self, lock):
 
 
745
class LockBroken(LockError):
 
 
747
    _fmt = ("Lock was broken while still open: %(lock)s"
 
 
748
            " - check storage consistency!")
 
 
750
    internal_error = False
 
 
752
    def __init__(self, lock):
 
 
756
class LockBreakMismatch(LockError):
 
 
758
    _fmt = ("Lock was released and re-acquired before being broken:"
 
 
759
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
 
761
    internal_error = False
 
 
763
    def __init__(self, lock, holder, target):
 
 
769
class LockNotHeld(LockError):
 
 
771
    _fmt = "Lock not held: %(lock)s"
 
 
773
    internal_error = False
 
 
775
    def __init__(self, lock):
 
 
779
class PointlessCommit(BzrError):
 
 
781
    _fmt = "No changes to commit"
 
 
784
class UpgradeReadonly(BzrError):
 
 
786
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
 
789
class UpToDateFormat(BzrError):
 
 
791
    _fmt = "The branch format %(format)s is already at the most recent format."
 
 
793
    def __init__(self, format):
 
 
794
        BzrError.__init__(self)
 
 
798
class StrictCommitFailed(Exception):
 
 
800
    _fmt = "Commit refused because there are unknowns in the tree."
 
 
803
class NoSuchRevision(BzrError):
 
 
805
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
 
807
    internal_error = True
 
 
809
    def __init__(self, branch, revision):
 
 
810
        BzrError.__init__(self, branch=branch, revision=revision)
 
 
813
class NotLeftParentDescendant(BzrError):
 
 
815
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
 
816
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
 
818
    internal_error = True
 
 
820
    def __init__(self, branch, old_revision, new_revision):
 
 
821
        BzrError.__init__(self, branch_location=branch.base,
 
 
822
                          old_revision=old_revision,
 
 
823
                          new_revision=new_revision)
 
 
826
class NoSuchRevisionSpec(BzrError):
 
 
828
    _fmt = "No namespace registered for string: %(spec)r"
 
 
830
    def __init__(self, spec):
 
 
831
        BzrError.__init__(self, spec=spec)
 
 
834
class NoSuchRevisionInTree(NoSuchRevision):
 
 
835
    """When using Tree.revision_tree, and the revision is not accessible."""
 
 
837
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
 
 
839
    def __init__(self, tree, revision_id):
 
 
840
        BzrError.__init__(self)
 
 
842
        self.revision_id = revision_id
 
 
845
class InvalidRevisionSpec(BzrError):
 
 
847
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
 
848
            " %(branch)s%(extra)s")
 
 
850
    def __init__(self, spec, branch, extra=None):
 
 
851
        BzrError.__init__(self, branch=branch, spec=spec)
 
 
853
            self.extra = '\n' + str(extra)
 
 
858
class HistoryMissing(BzrError):
 
 
860
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
 
863
class AppendRevisionsOnlyViolation(BzrError):
 
 
865
    _fmt = ('Operation denied because it would change the main history,'
 
 
866
           ' which is not permitted by the append_revisions_only setting on'
 
 
867
           ' branch "%(location)s".')
 
 
869
    def __init__(self, location):
 
 
870
       import bzrlib.urlutils as urlutils
 
 
871
       location = urlutils.unescape_for_display(location, 'ascii')
 
 
872
       BzrError.__init__(self, location=location)
 
 
875
class DivergedBranches(BzrError):
 
 
877
    _fmt = ("These branches have diverged."
 
 
878
            " Use the merge command to reconcile them.")
 
 
880
    internal_error = False
 
 
882
    def __init__(self, branch1, branch2):
 
 
883
        self.branch1 = branch1
 
 
884
        self.branch2 = branch2
 
 
887
class NotLefthandHistory(BzrError):
 
 
889
    _fmt = "Supplied history does not follow left-hand parents"
 
 
891
    internal_error = True
 
 
893
    def __init__(self, history):
 
 
894
        BzrError.__init__(self, history=history)
 
 
897
class UnrelatedBranches(BzrError):
 
 
899
    _fmt = ("Branches have no common ancestor, and"
 
 
900
            " no merge base revision was specified.")
 
 
902
    internal_error = False
 
 
905
class NoCommonAncestor(BzrError):
 
 
907
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
909
    def __init__(self, revision_a, revision_b):
 
 
910
        self.revision_a = revision_a
 
 
911
        self.revision_b = revision_b
 
 
914
class NoCommonRoot(BzrError):
 
 
916
    _fmt = ("Revisions are not derived from the same root: "
 
 
917
           "%(revision_a)s %(revision_b)s.")
 
 
919
    def __init__(self, revision_a, revision_b):
 
 
920
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
 
923
class NotAncestor(BzrError):
 
 
925
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
 
927
    def __init__(self, rev_id, not_ancestor_id):
 
 
928
        BzrError.__init__(self, rev_id=rev_id,
 
 
929
            not_ancestor_id=not_ancestor_id)
 
 
932
class InstallFailed(BzrError):
 
 
934
    def __init__(self, revisions):
 
 
935
        revision_str = ", ".join(str(r) for r in revisions)
 
 
936
        msg = "Could not install revisions:\n%s" % revision_str
 
 
937
        BzrError.__init__(self, msg)
 
 
938
        self.revisions = revisions
 
 
941
class AmbiguousBase(BzrError):
 
 
943
    def __init__(self, bases):
 
 
944
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
946
        msg = ("The correct base is unclear, because %s are all equally close"
 
 
948
        BzrError.__init__(self, msg)
 
 
952
class NoCommits(BzrError):
 
 
954
    _fmt = "Branch %(branch)s has no commits."
 
 
956
    def __init__(self, branch):
 
 
957
        BzrError.__init__(self, branch=branch)
 
 
960
class UnlistableStore(BzrError):
 
 
962
    def __init__(self, store):
 
 
963
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
967
class UnlistableBranch(BzrError):
 
 
969
    def __init__(self, br):
 
 
970
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
973
class BoundBranchOutOfDate(BzrError):
 
 
975
    _fmt = ("Bound branch %(branch)s is out of date"
 
 
976
            " with master branch %(master)s.")
 
 
978
    def __init__(self, branch, master):
 
 
979
        BzrError.__init__(self)
 
 
984
class CommitToDoubleBoundBranch(BzrError):
 
 
986
    _fmt = ("Cannot commit to branch %(branch)s."
 
 
987
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
 
989
    def __init__(self, branch, master, remote):
 
 
990
        BzrError.__init__(self)
 
 
996
class OverwriteBoundBranch(BzrError):
 
 
998
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
 
1000
    def __init__(self, branch):
 
 
1001
        BzrError.__init__(self)
 
 
1002
        self.branch = branch
 
 
1005
class BoundBranchConnectionFailure(BzrError):
 
 
1007
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
 
1008
            " => %(target)s: %(error)s")
 
 
1010
    def __init__(self, branch, target, error):
 
 
1011
        BzrError.__init__(self)
 
 
1012
        self.branch = branch
 
 
1013
        self.target = target
 
 
1017
class WeaveError(BzrError):
 
 
1019
    _fmt = "Error in processing weave: %(message)s"
 
 
1021
    def __init__(self, message=None):
 
 
1022
        BzrError.__init__(self)
 
 
1023
        self.message = message
 
 
1026
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
1028
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
 
1030
    def __init__(self, revision_id, weave):
 
 
1032
        WeaveError.__init__(self)
 
 
1033
        self.revision_id = revision_id
 
 
1037
class WeaveRevisionNotPresent(WeaveError):
 
 
1039
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
 
1041
    def __init__(self, revision_id, weave):
 
 
1042
        WeaveError.__init__(self)
 
 
1043
        self.revision_id = revision_id
 
 
1047
class WeaveFormatError(WeaveError):
 
 
1049
    _fmt = "Weave invariant violated: %(what)s"
 
 
1051
    def __init__(self, what):
 
 
1052
        WeaveError.__init__(self)
 
 
1056
class WeaveParentMismatch(WeaveError):
 
 
1058
    _fmt = "Parents are mismatched between two revisions."
 
 
1061
class WeaveInvalidChecksum(WeaveError):
 
 
1063
    _fmt = "Text did not match it's checksum: %(message)s"
 
 
1066
class WeaveTextDiffers(WeaveError):
 
 
1068
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1069
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1071
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1072
        WeaveError.__init__(self)
 
 
1073
        self.revision_id = revision_id
 
 
1074
        self.weave_a = weave_a
 
 
1075
        self.weave_b = weave_b
 
 
1078
class WeaveTextDiffers(WeaveError):
 
 
1080
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1081
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1083
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1084
        WeaveError.__init__(self)
 
 
1085
        self.revision_id = revision_id
 
 
1086
        self.weave_a = weave_a
 
 
1087
        self.weave_b = weave_b
 
 
1090
class VersionedFileError(BzrError):
 
 
1092
    _fmt = "Versioned file error"
 
 
1095
class RevisionNotPresent(VersionedFileError):
 
 
1097
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
 
1099
    def __init__(self, revision_id, file_id):
 
 
1100
        VersionedFileError.__init__(self)
 
 
1101
        self.revision_id = revision_id
 
 
1102
        self.file_id = file_id
 
 
1105
class RevisionAlreadyPresent(VersionedFileError):
 
 
1107
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
 
1109
    def __init__(self, revision_id, file_id):
 
 
1110
        VersionedFileError.__init__(self)
 
 
1111
        self.revision_id = revision_id
 
 
1112
        self.file_id = file_id
 
 
1115
class KnitError(BzrError):
 
 
1119
    internal_error = True
 
 
1122
class KnitHeaderError(KnitError):
 
 
1124
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
 
1126
    def __init__(self, badline, filename):
 
 
1127
        KnitError.__init__(self)
 
 
1128
        self.badline = badline
 
 
1129
        self.filename = filename
 
 
1132
class KnitCorrupt(KnitError):
 
 
1134
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
 
1136
    def __init__(self, filename, how):
 
 
1137
        KnitError.__init__(self)
 
 
1138
        self.filename = filename
 
 
1142
class KnitIndexUnknownMethod(KnitError):
 
 
1143
    """Raised when we don't understand the storage method.
 
 
1145
    Currently only 'fulltext' and 'line-delta' are supported.
 
 
1148
    _fmt = ("Knit index %(filename)s does not have a known method"
 
 
1149
            " in options: %(options)r")
 
 
1151
    def __init__(self, filename, options):
 
 
1152
        KnitError.__init__(self)
 
 
1153
        self.filename = filename
 
 
1154
        self.options = options
 
 
1157
class NoSuchExportFormat(BzrError):
 
 
1159
    _fmt = "Export format %(format)r not supported"
 
 
1161
    def __init__(self, format):
 
 
1162
        BzrError.__init__(self)
 
 
1163
        self.format = format
 
 
1166
class TransportError(BzrError):
 
 
1168
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
 
1170
    def __init__(self, msg=None, orig_error=None):
 
 
1171
        if msg is None and orig_error is not None:
 
 
1172
            msg = str(orig_error)
 
 
1173
        if orig_error is None:
 
 
1178
        self.orig_error = orig_error
 
 
1179
        BzrError.__init__(self)
 
 
1182
class TooManyConcurrentRequests(BzrError):
 
 
1184
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
 
1185
            " Be sure to finish_writing and finish_reading on the"
 
 
1186
            " current request that is open.")
 
 
1188
    internal_error = True
 
 
1190
    def __init__(self, medium):
 
 
1191
        self.medium = medium
 
 
1194
class SmartProtocolError(TransportError):
 
 
1196
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
 
1198
    def __init__(self, details):
 
 
1199
        self.details = details
 
 
1202
# A set of semi-meaningful errors which can be thrown
 
 
1203
class TransportNotPossible(TransportError):
 
 
1205
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
 
1208
class ConnectionError(TransportError):
 
 
1210
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
 
1213
class SocketConnectionError(ConnectionError):
 
 
1215
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
 
1217
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
1219
            msg = 'Failed to connect to'
 
 
1220
        if orig_error is None:
 
 
1223
            orig_error = '; ' + str(orig_error)
 
 
1224
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
1229
            self.port = ':%s' % port
 
 
1232
class ConnectionReset(TransportError):
 
 
1234
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
 
1237
class InvalidRange(TransportError):
 
 
1239
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
 
1241
    def __init__(self, path, offset):
 
 
1242
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
 
1245
        self.offset = offset
 
 
1248
class InvalidHttpResponse(TransportError):
 
 
1250
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
 
1252
    def __init__(self, path, msg, orig_error=None):
 
 
1254
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
1257
class InvalidHttpRange(InvalidHttpResponse):
 
 
1259
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
 
1261
    def __init__(self, path, range, msg):
 
 
1263
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1266
class InvalidHttpContentType(InvalidHttpResponse):
 
 
1268
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
 
1270
    def __init__(self, path, ctype, msg):
 
 
1272
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1275
class ConflictsInTree(BzrError):
 
 
1277
    _fmt = "Working tree has conflicts."
 
 
1280
class ParseConfigError(BzrError):
 
 
1282
    def __init__(self, errors, filename):
 
 
1283
        if filename is None:
 
 
1285
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
1286
            (filename, ('\n'.join(e.message for e in errors)))
 
 
1287
        BzrError.__init__(self, message)
 
 
1290
class NoEmailInUsername(BzrError):
 
 
1292
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
 
1294
    def __init__(self, username):
 
 
1295
        BzrError.__init__(self)
 
 
1296
        self.username = username
 
 
1299
class SigningFailed(BzrError):
 
 
1301
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
 
1303
    def __init__(self, command_line):
 
 
1304
        BzrError.__init__(self, command_line=command_line)
 
 
1307
class WorkingTreeNotRevision(BzrError):
 
 
1309
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
 
1310
            " the last commit, but weave merge requires that it be"
 
 
1313
    def __init__(self, tree):
 
 
1314
        BzrError.__init__(self, basedir=tree.basedir)
 
 
1317
class CantReprocessAndShowBase(BzrError):
 
 
1319
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
 
1320
           "the relationship of conflicting lines to the base")
 
 
1323
class GraphCycleError(BzrError):
 
 
1325
    _fmt = "Cycle in graph %(graph)r"
 
 
1327
    def __init__(self, graph):
 
 
1328
        BzrError.__init__(self)
 
 
1332
class WritingCompleted(BzrError):
 
 
1334
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
 
1335
            "called upon it - accept bytes may not be called anymore.")
 
 
1337
    internal_error = True
 
 
1339
    def __init__(self, request):
 
 
1340
        self.request = request
 
 
1343
class WritingNotComplete(BzrError):
 
 
1345
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
 
1346
            "called upon it - until the write phase is complete no "
 
 
1347
            "data may be read.")
 
 
1349
    internal_error = True
 
 
1351
    def __init__(self, request):
 
 
1352
        self.request = request
 
 
1355
class NotConflicted(BzrError):
 
 
1357
    _fmt = "File %(filename)s is not conflicted."
 
 
1359
    def __init__(self, filename):
 
 
1360
        BzrError.__init__(self)
 
 
1361
        self.filename = filename
 
 
1364
class MediumNotConnected(BzrError):
 
 
1366
    _fmt = """The medium '%(medium)s' is not connected."""
 
 
1368
    internal_error = True
 
 
1370
    def __init__(self, medium):
 
 
1371
        self.medium = medium
 
 
1374
class MustUseDecorated(Exception):
 
 
1376
    _fmt = "A decorating function has requested its original command be used."
 
 
1379
class NoBundleFound(BzrError):
 
 
1381
    _fmt = "No bundle was found in %(filename)s"
 
 
1383
    def __init__(self, filename):
 
 
1384
        BzrError.__init__(self)
 
 
1385
        self.filename = filename
 
 
1388
class BundleNotSupported(BzrError):
 
 
1390
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
 
1392
    def __init__(self, version, msg):
 
 
1393
        BzrError.__init__(self)
 
 
1394
        self.version = version
 
 
1398
class MissingText(BzrError):
 
 
1400
    _fmt = ("Branch %(base)s is missing revision"
 
 
1401
            " %(text_revision)s of %(file_id)s")
 
 
1403
    def __init__(self, branch, text_revision, file_id):
 
 
1404
        BzrError.__init__(self)
 
 
1405
        self.branch = branch
 
 
1406
        self.base = branch.base
 
 
1407
        self.text_revision = text_revision
 
 
1408
        self.file_id = file_id
 
 
1411
class DuplicateFileId(BzrError):
 
 
1413
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
 
1415
    def __init__(self, file_id, entry):
 
 
1416
        BzrError.__init__(self)
 
 
1417
        self.file_id = file_id
 
 
1421
class DuplicateKey(BzrError):
 
 
1423
    _fmt = "Key %(key)s is already present in map"
 
 
1426
class MalformedTransform(BzrError):
 
 
1428
    _fmt = "Tree transform is malformed %(conflicts)r"
 
 
1431
class NoFinalPath(BzrError):
 
 
1433
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
 
1434
            "file-id: %(file_id)r\n"
 
 
1435
            "root trans-id: %(root_trans_id)r\n")
 
 
1437
    def __init__(self, trans_id, transform):
 
 
1438
        self.trans_id = trans_id
 
 
1439
        self.file_id = transform.final_file_id(trans_id)
 
 
1440
        self.root_trans_id = transform.root
 
 
1443
class BzrBadParameter(BzrError):
 
 
1445
    _fmt = "Bad parameter: %(param)r"
 
 
1447
    # This exception should never be thrown, but it is a base class for all
 
 
1448
    # parameter-to-function errors.
 
 
1450
    def __init__(self, param):
 
 
1451
        BzrError.__init__(self)
 
 
1455
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1457
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
 
1460
class ReusingTransform(BzrError):
 
 
1462
    _fmt = "Attempt to reuse a transform that has already been applied."
 
 
1465
class CantMoveRoot(BzrError):
 
 
1467
    _fmt = "Moving the root directory is not supported at this time"
 
 
1470
class BzrMoveFailedError(BzrError):
 
 
1472
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1474
    def __init__(self, from_path='', to_path='', extra=None):
 
 
1475
        BzrError.__init__(self)
 
 
1477
            self.extra = ': ' + str(extra)
 
 
1481
        has_from = len(from_path) > 0
 
 
1482
        has_to = len(to_path) > 0
 
 
1484
            self.from_path = osutils.splitpath(from_path)[-1]
 
 
1489
            self.to_path = osutils.splitpath(to_path)[-1]
 
 
1494
        if has_from and has_to:
 
 
1495
            self.operator = " =>"
 
 
1497
            self.from_path = "from " + from_path
 
 
1499
            self.operator = "to"
 
 
1501
            self.operator = "file"
 
 
1504
class BzrRenameFailedError(BzrMoveFailedError):
 
 
1506
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1508
    def __init__(self, from_path, to_path, extra=None):
 
 
1509
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
 
1512
class BzrBadParameterNotString(BzrBadParameter):
 
 
1514
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
 
1517
class BzrBadParameterMissing(BzrBadParameter):
 
 
1519
    _fmt = "Parameter $(param)s is required but not present."
 
 
1522
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1524
    _fmt = ("Parameter %(param)s is unicode but"
 
 
1525
            " only byte-strings are permitted.")
 
 
1528
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1530
    _fmt = "Parameter %(param)s contains a newline."
 
 
1533
class DependencyNotPresent(BzrError):
 
 
1535
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
 
1537
    def __init__(self, library, error):
 
 
1538
        BzrError.__init__(self, library=library, error=error)
 
 
1541
class ParamikoNotPresent(DependencyNotPresent):
 
 
1543
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
 
1545
    def __init__(self, error):
 
 
1546
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1549
class PointlessMerge(BzrError):
 
 
1551
    _fmt = "Nothing to merge."
 
 
1554
class UninitializableFormat(BzrError):
 
 
1556
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
 
1558
    def __init__(self, format):
 
 
1559
        BzrError.__init__(self)
 
 
1560
        self.format = format
 
 
1563
class BadConversionTarget(BzrError):
 
 
1565
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
 
1567
    def __init__(self, problem, format):
 
 
1568
        BzrError.__init__(self)
 
 
1569
        self.problem = problem
 
 
1570
        self.format = format
 
 
1573
class NoDiff(BzrError):
 
 
1575
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
 
1577
    def __init__(self, msg):
 
 
1578
        BzrError.__init__(self, msg=msg)
 
 
1581
class NoDiff3(BzrError):
 
 
1583
    _fmt = "Diff3 is not installed on this machine."
 
 
1586
class ExistingLimbo(BzrError):
 
 
1588
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1589
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1590
    keep, and delete it when you are done."""
 
 
1592
    def __init__(self, limbo_dir):
 
 
1593
       BzrError.__init__(self)
 
 
1594
       self.limbo_dir = limbo_dir
 
 
1597
class ImmortalLimbo(BzrError):
 
 
1599
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
 
1600
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1601
    keep, and delete it when you are done."""
 
 
1603
    def __init__(self, limbo_dir):
 
 
1604
       BzrError.__init__(self)
 
 
1605
       self.limbo_dir = limbo_dir
 
 
1608
class OutOfDateTree(BzrError):
 
 
1610
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
 
1612
    def __init__(self, tree):
 
 
1613
        BzrError.__init__(self)
 
 
1617
class PublicBranchOutOfDate(BzrError):
 
 
1619
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
 
1622
    def __init__(self, public_location, revstring):
 
 
1623
        import bzrlib.urlutils as urlutils
 
 
1624
        public_location = urlutils.unescape_for_display(public_location,
 
 
1626
        BzrError.__init__(self, public_location=public_location,
 
 
1627
                          revstring=revstring)
 
 
1630
class MergeModifiedFormatError(BzrError):
 
 
1632
    _fmt = "Error in merge modified format"
 
 
1635
class ConflictFormatError(BzrError):
 
 
1637
    _fmt = "Format error in conflict listings"
 
 
1640
class CorruptRepository(BzrError):
 
 
1642
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
 
1643
            "Please run bzr reconcile on this repository.")
 
 
1645
    def __init__(self, repo):
 
 
1646
        BzrError.__init__(self)
 
 
1647
        self.repo_path = repo.bzrdir.root_transport.base
 
 
1650
class UpgradeRequired(BzrError):
 
 
1652
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
 
1654
    def __init__(self, path):
 
 
1655
        BzrError.__init__(self)
 
 
1659
class LocalRequiresBoundBranch(BzrError):
 
 
1661
    _fmt = "Cannot perform local-only commits on unbound branches."
 
 
1664
class MissingProgressBarFinish(BzrError):
 
 
1666
    _fmt = "A nested progress bar was not 'finished' correctly."
 
 
1669
class InvalidProgressBarType(BzrError):
 
 
1671
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
 
1672
            " is not a supported type Select one of: %(valid_types)s")
 
 
1674
    def __init__(self, bar_type, valid_types):
 
 
1675
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
1678
class UnsupportedOperation(BzrError):
 
 
1680
    _fmt = ("The method %(mname)s is not supported on"
 
 
1681
            " objects of type %(tname)s.")
 
 
1683
    def __init__(self, method, method_self):
 
 
1684
        self.method = method
 
 
1685
        self.mname = method.__name__
 
 
1686
        self.tname = type(method_self).__name__
 
 
1689
class CannotSetRevisionId(UnsupportedOperation):
 
 
1690
    """Raised when a commit is attempting to set a revision id but cant."""
 
 
1693
class NonAsciiRevisionId(UnsupportedOperation):
 
 
1694
    """Raised when a commit is attempting to set a non-ascii revision id
 
 
1699
class BinaryFile(BzrError):
 
 
1701
    _fmt = "File is binary but should be text."
 
 
1704
class IllegalPath(BzrError):
 
 
1706
    _fmt = "The path %(path)s is not permitted on this platform"
 
 
1708
    def __init__(self, path):
 
 
1709
        BzrError.__init__(self)
 
 
1713
class TestamentMismatch(BzrError):
 
 
1715
    _fmt = """Testament did not match expected value.
 
 
1716
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
 
1719
    def __init__(self, revision_id, expected, measured):
 
 
1720
        self.revision_id = revision_id
 
 
1721
        self.expected = expected
 
 
1722
        self.measured = measured
 
 
1725
class NotABundle(BzrError):
 
 
1727
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
 
1729
    def __init__(self, text):
 
 
1730
        BzrError.__init__(self)
 
 
1734
class BadBundle(BzrError): 
 
 
1736
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
 
1738
    def __init__(self, text):
 
 
1739
        BzrError.__init__(self)
 
 
1743
class MalformedHeader(BadBundle): 
 
 
1745
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
 
1748
class MalformedPatches(BadBundle): 
 
 
1750
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
 
1753
class MalformedFooter(BadBundle): 
 
 
1755
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
 
1758
class UnsupportedEOLMarker(BadBundle):
 
 
1760
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
 
1763
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
 
1764
        # but for this there is not
 
 
1765
        BzrError.__init__(self)
 
 
1768
class IncompatibleBundleFormat(BzrError):
 
 
1770
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
 
1772
    def __init__(self, bundle_format, other):
 
 
1773
        BzrError.__init__(self)
 
 
1774
        self.bundle_format = bundle_format
 
 
1778
class BadInventoryFormat(BzrError):
 
 
1780
    _fmt = "Root class for inventory serialization errors"
 
 
1783
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
1785
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
 
1787
    def __init__(self, msg):
 
 
1788
        BadInventoryFormat.__init__(self, msg=msg)
 
 
1791
class RootNotRich(BzrError):
 
 
1793
    _fmt = """This operation requires rich root data storage"""
 
 
1796
class NoSmartMedium(BzrError):
 
 
1798
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
 
1800
    internal_error = True
 
 
1802
    def __init__(self, transport):
 
 
1803
        self.transport = transport
 
 
1806
class NoSmartServer(NotBranchError):
 
 
1808
    _fmt = "No smart server available at %(url)s"
 
 
1810
    def __init__(self, url):
 
 
1814
class UnknownSSH(BzrError):
 
 
1816
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
 
1818
    def __init__(self, vendor):
 
 
1819
        BzrError.__init__(self)
 
 
1820
        self.vendor = vendor
 
 
1823
class SSHVendorNotFound(BzrError):
 
 
1825
    _fmt = ("Don't know how to handle SSH connections."
 
 
1826
            " Please set BZR_SSH environment variable.")
 
 
1829
class GhostRevisionUnusableHere(BzrError):
 
 
1831
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
 
1833
    def __init__(self, revision_id):
 
 
1834
        BzrError.__init__(self)
 
 
1835
        self.revision_id = revision_id
 
 
1838
class IllegalUseOfScopeReplacer(BzrError):
 
 
1840
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
 
1841
            " %(msg)s%(extra)s")
 
 
1843
    internal_error = True
 
 
1845
    def __init__(self, name, msg, extra=None):
 
 
1846
        BzrError.__init__(self)
 
 
1850
            self.extra = ': ' + str(extra)
 
 
1855
class InvalidImportLine(BzrError):
 
 
1857
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
 
1859
    internal_error = True
 
 
1861
    def __init__(self, text, msg):
 
 
1862
        BzrError.__init__(self)
 
 
1867
class ImportNameCollision(BzrError):
 
 
1869
    _fmt = ("Tried to import an object to the same name as"
 
 
1870
            " an existing object. %(name)s")
 
 
1872
    internal_error = True
 
 
1874
    def __init__(self, name):
 
 
1875
        BzrError.__init__(self)
 
 
1879
class NoMergeSource(BzrError):
 
 
1880
    """Raise if no merge source was specified for a merge directive"""
 
 
1882
    _fmt = "A merge directive must provide either a bundle or a public"\
 
 
1886
class PatchMissing(BzrError):
 
 
1887
    """Raise a patch type was specified but no patch supplied"""
 
 
1889
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
 
1891
    def __init__(self, patch_type):
 
 
1892
        BzrError.__init__(self)
 
 
1893
        self.patch_type = patch_type
 
 
1896
class UnsupportedInventoryKind(BzrError):
 
 
1898
    _fmt = """Unsupported entry kind %(kind)s"""
 
 
1900
    def __init__(self, kind):
 
 
1904
class BadSubsumeSource(BzrError):
 
 
1906
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
 
 
1908
    def __init__(self, tree, other_tree, reason):
 
 
1910
        self.other_tree = other_tree
 
 
1911
        self.reason = reason
 
 
1914
class SubsumeTargetNeedsUpgrade(BzrError):
 
 
1916
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
 
1918
    def __init__(self, other_tree):
 
 
1919
        self.other_tree = other_tree
 
 
1922
class BadReferenceTarget(BzrError):
 
 
1924
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
 
1926
    internal_error = True
 
 
1928
    def __init__(self, tree, other_tree, reason):
 
 
1930
        self.other_tree = other_tree
 
 
1931
        self.reason = reason
 
 
1934
class NoSuchTag(BzrError):
 
 
1936
    _fmt = "No such tag: %(tag_name)s"
 
 
1938
    def __init__(self, tag_name):
 
 
1939
        self.tag_name = tag_name
 
 
1942
class TagsNotSupported(BzrError):
 
 
1944
    _fmt = ("Tags not supported by %(branch)s;"
 
 
1945
            " you may be able to use bzr upgrade.")
 
 
1947
    def __init__(self, branch):
 
 
1948
        self.branch = branch
 
 
1951
class TagAlreadyExists(BzrError):
 
 
1953
    _fmt = "Tag %(tag_name)s already exists."
 
 
1955
    def __init__(self, tag_name):
 
 
1956
        self.tag_name = tag_name