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.
 
 
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 attribute
 
 
136
        # if it doesn't exist.  We can't use super here, because exceptions are
 
 
137
        # old-style classes in python2.4 (but new in 2.5).  --bmc, 20060426
 
 
138
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
 
 
139
             'please convert %s to use BzrError instead' 
 
 
140
             % self.__class__.__name__,
 
 
143
        BzrError.__init__(self, *args)
 
 
144
        for key, value in kwds.items():
 
 
145
            setattr(self, key, value)
 
 
149
            # __str__() should always return a 'str' object
 
 
150
            # never a 'unicode' object.
 
 
151
            s = self.__doc__ % self.__dict__
 
 
152
            if isinstance(s, unicode):
 
 
153
                return s.encode('utf8')
 
 
155
        except (TypeError, NameError, ValueError, KeyError), e:
 
 
156
            return 'Unprintable exception %s(%r): %s' \
 
 
157
                % (self.__class__.__name__,
 
 
158
                   self.__dict__, str(e))
 
 
161
class AlreadyBuilding(BzrError):
 
 
163
    _fmt = "The tree builder is already building a tree."
 
 
166
class BzrCheckError(BzrError):
 
 
168
    _fmt = "Internal check failed: %(message)s"
 
 
170
    internal_error = True
 
 
172
    def __init__(self, message):
 
 
173
        BzrError.__init__(self)
 
 
174
        self.message = message
 
 
177
class InvalidEntryName(BzrError):
 
 
179
    _fmt = "Invalid entry name: %(name)s"
 
 
181
    internal_error = True
 
 
183
    def __init__(self, name):
 
 
184
        BzrError.__init__(self)
 
 
188
class InvalidRevisionNumber(BzrError):
 
 
190
    _fmt = "Invalid revision number %(revno)s"
 
 
192
    def __init__(self, revno):
 
 
193
        BzrError.__init__(self)
 
 
197
class InvalidRevisionId(BzrError):
 
 
199
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
 
201
    def __init__(self, revision_id, branch):
 
 
202
        # branch can be any string or object with __str__ defined
 
 
203
        BzrError.__init__(self)
 
 
204
        self.revision_id = revision_id
 
 
207
class ReservedId(BzrError):
 
 
209
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
 
211
    def __init__(self, revision_id):
 
 
212
        self.revision_id = revision_id
 
 
214
class NoSuchId(BzrError):
 
 
216
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
 
218
    def __init__(self, tree, file_id):
 
 
219
        BzrError.__init__(self)
 
 
220
        self.file_id = file_id
 
 
224
class InventoryModified(BzrError):
 
 
226
    _fmt = ("The current inventory for the tree %(tree)r has been modified, "
 
 
227
            "so a clean inventory cannot be read without data loss.")
 
 
229
    internal_error = True
 
 
231
    def __init__(self, tree):
 
 
235
class NoWorkingTree(BzrError):
 
 
237
    _fmt = "No WorkingTree exists for %(base)s."
 
 
239
    def __init__(self, base):
 
 
240
        BzrError.__init__(self)
 
 
244
class NotBuilding(BzrError):
 
 
246
    _fmt = "Not currently building a tree."
 
 
249
class NotLocalUrl(BzrError):
 
 
251
    _fmt = "%(url)s is not a local path."
 
 
253
    def __init__(self, url):
 
 
257
class WorkingTreeAlreadyPopulated(BzrError):
 
 
259
    _fmt = """Working tree already populated in %(base)s"""
 
 
261
    internal_error = True
 
 
263
    def __init__(self, base):
 
 
266
class BzrCommandError(BzrError):
 
 
267
    """Error from user command"""
 
 
269
    internal_error = False
 
 
271
    # Error from malformed user command; please avoid raising this as a
 
 
272
    # generic exception not caused by user input.
 
 
274
    # I think it's a waste of effort to differentiate between errors that
 
 
275
    # are not intended to be caught anyway.  UI code need not subclass
 
 
276
    # BzrCommandError, and non-UI code should not throw a subclass of
 
 
277
    # BzrCommandError.  ADHB 20051211
 
 
278
    def __init__(self, msg):
 
 
279
        # Object.__str__() must return a real string
 
 
280
        # returning a Unicode string is a python error.
 
 
281
        if isinstance(msg, unicode):
 
 
282
            self.msg = msg.encode('utf8')
 
 
290
class NotWriteLocked(BzrError):
 
 
292
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
 
294
    def __init__(self, not_locked):
 
 
295
        self.not_locked = not_locked
 
 
298
class BzrOptionError(BzrCommandError):
 
 
300
    _fmt = "Error in command line options"
 
 
303
class BadOptionValue(BzrError):
 
 
305
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
 
307
    def __init__(self, name, value):
 
 
308
        BzrError.__init__(self, name=name, value=value)
 
 
311
class StrictCommitFailed(BzrError):
 
 
313
    _fmt = "Commit refused because there are unknown files in the tree"
 
 
316
# XXX: Should be unified with TransportError; they seem to represent the
 
 
318
class PathError(BzrError):
 
 
320
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
 
322
    def __init__(self, path, extra=None):
 
 
323
        BzrError.__init__(self)
 
 
326
            self.extra = ': ' + str(extra)
 
 
331
class NoSuchFile(PathError):
 
 
333
    _fmt = "No such file: %(path)r%(extra)s"
 
 
336
class FileExists(PathError):
 
 
338
    _fmt = "File exists: %(path)r%(extra)s"
 
 
341
class RenameFailedFilesExist(BzrError):
 
 
342
    """Used when renaming and both source and dest exist."""
 
 
344
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
 
347
    def __init__(self, source, dest, extra=None):
 
 
348
        BzrError.__init__(self)
 
 
349
        self.source = str(source)
 
 
350
        self.dest = str(dest)
 
 
352
            self.extra = ' ' + str(extra)
 
 
357
class NotADirectory(PathError):
 
 
359
    _fmt = "%(path)r is not a directory %(extra)s"
 
 
362
class NotInWorkingDirectory(PathError):
 
 
364
    _fmt = "%(path)r is not in the working directory %(extra)s"
 
 
367
class DirectoryNotEmpty(PathError):
 
 
369
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
 
372
class ReadingCompleted(BzrError):
 
 
374
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
 
375
            "called upon it - the request has been completed and no more "
 
 
378
    internal_error = True
 
 
380
    def __init__(self, request):
 
 
381
        self.request = request
 
 
384
class ResourceBusy(PathError):
 
 
386
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
 
389
class PermissionDenied(PathError):
 
 
391
    _fmt = "Permission denied: %(path)r%(extra)s"
 
 
394
class InvalidURL(PathError):
 
 
396
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
 
399
class InvalidURLJoin(PathError):
 
 
401
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
 
403
    def __init__(self, msg, base, args):
 
 
404
        PathError.__init__(self, base, msg)
 
 
405
        self.args = [base] + list(args)
 
 
408
class UnknownHook(BzrError):
 
 
410
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
 
412
    def __init__(self, hook_type, hook_name):
 
 
413
        BzrError.__init__(self)
 
 
414
        self.type = hook_type
 
 
415
        self.hook = hook_name
 
 
418
class UnsupportedProtocol(PathError):
 
 
420
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
 
422
    def __init__(self, url, extra):
 
 
423
        PathError.__init__(self, url, extra=extra)
 
 
426
class ShortReadvError(PathError):
 
 
428
    _fmt = "readv() read %(actual)s bytes rather than %(length)s bytes at %(offset)s for %(path)s%(extra)s"
 
 
430
    internal_error = True
 
 
432
    def __init__(self, path, offset, length, actual, extra=None):
 
 
433
        PathError.__init__(self, path, extra=extra)
 
 
439
class PathNotChild(BzrError):
 
 
441
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
 
443
    internal_error = True
 
 
445
    def __init__(self, path, base, extra=None):
 
 
446
        BzrError.__init__(self)
 
 
450
            self.extra = ': ' + str(extra)
 
 
455
class InvalidNormalization(PathError):
 
 
457
    _fmt = "Path %(path)r is not unicode normalized"
 
 
460
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
461
# the exception object is a bit undesirable.
 
 
462
# TODO: Probably this behavior of should be a common superclass 
 
 
463
class NotBranchError(PathError):
 
 
465
    _fmt = "Not a branch: %(path)s"
 
 
467
    def __init__(self, path):
 
 
468
       import bzrlib.urlutils as urlutils
 
 
469
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
472
class AlreadyBranchError(PathError):
 
 
474
    _fmt = "Already a branch: %(path)s."
 
 
477
class BranchExistsWithoutWorkingTree(PathError):
 
 
479
    _fmt = "Directory contains a branch, but no working tree \
 
 
480
(use bzr checkout if you wish to build a working tree): %(path)s"
 
 
483
class AtomicFileAlreadyClosed(PathError):
 
 
485
    _fmt = "'%(function)s' called on an AtomicFile after it was closed: %(path)s"
 
 
487
    def __init__(self, path, function):
 
 
488
        PathError.__init__(self, path=path, extra=None)
 
 
489
        self.function = function
 
 
492
class InaccessibleParent(PathError):
 
 
494
    _fmt = "Parent not accessible given base %(base)s and relative path %(path)s"
 
 
496
    def __init__(self, path, base):
 
 
497
        PathError.__init__(self, path)
 
 
501
class NoRepositoryPresent(BzrError):
 
 
503
    _fmt = "No repository present: %(path)r"
 
 
504
    def __init__(self, bzrdir):
 
 
505
        BzrError.__init__(self)
 
 
506
        self.path = bzrdir.transport.clone('..').base
 
 
509
class FileInWrongBranch(BzrError):
 
 
511
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
 
513
    def __init__(self, branch, path):
 
 
514
        BzrError.__init__(self)
 
 
516
        self.branch_base = branch.base
 
 
520
class UnsupportedFormatError(BzrError):
 
 
522
    _fmt = "Unsupported branch format: %(format)s"
 
 
525
class UnknownFormatError(BzrError):
 
 
527
    _fmt = "Unknown branch format: %(format)r"
 
 
530
class IncompatibleFormat(BzrError):
 
 
532
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
 
534
    def __init__(self, format, bzrdir_format):
 
 
535
        BzrError.__init__(self)
 
 
537
        self.bzrdir = bzrdir_format
 
 
540
class IncompatibleRevision(BzrError):
 
 
542
    _fmt = "Revision is not compatible with %(repo_format)s"
 
 
544
    def __init__(self, repo_format):
 
 
545
        BzrError.__init__(self)
 
 
546
        self.repo_format = repo_format
 
 
549
class AlreadyVersionedError(BzrError):
 
 
550
    """Used when a path is expected not to be versioned, but it is."""
 
 
552
    _fmt = "%(context_info)s%(path)s is already versioned"
 
 
554
    def __init__(self, path, context_info=None):
 
 
555
        """Construct a new AlreadyVersionedError.
 
 
557
        :param path: This is the path which is versioned,
 
 
558
        which should be in a user friendly form.
 
 
559
        :param context_info: If given, this is information about the context,
 
 
560
        which could explain why this is expected to not be versioned.
 
 
562
        BzrError.__init__(self)
 
 
564
        if context_info is None:
 
 
565
            self.context_info = ''
 
 
567
            self.context_info = context_info + ". "
 
 
570
class NotVersionedError(BzrError):
 
 
571
    """Used when a path is expected to be versioned, but it is not."""
 
 
573
    _fmt = "%(context_info)s%(path)s is not versioned"
 
 
575
    def __init__(self, path, context_info=None):
 
 
576
        """Construct a new NotVersionedError.
 
 
578
        :param path: This is the path which is not versioned,
 
 
579
        which should be in a user friendly form.
 
 
580
        :param context_info: If given, this is information about the context,
 
 
581
        which could explain why this is expected to be versioned.
 
 
583
        BzrError.__init__(self)
 
 
585
        if context_info is None:
 
 
586
            self.context_info = ''
 
 
588
            self.context_info = context_info + ". "
 
 
591
class PathsNotVersionedError(BzrError):
 
 
592
    """Used when reporting several paths which are not versioned"""
 
 
594
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
 
596
    def __init__(self, paths):
 
 
597
        from bzrlib.osutils import quotefn
 
 
598
        BzrError.__init__(self)
 
 
600
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
603
class PathsDoNotExist(BzrError):
 
 
605
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
 
607
    # used when reporting that paths are neither versioned nor in the working
 
 
610
    def __init__(self, paths, extra=None):
 
 
612
        from bzrlib.osutils import quotefn
 
 
613
        BzrError.__init__(self)
 
 
615
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
617
            self.extra = ': ' + str(extra)
 
 
622
class BadFileKindError(BzrError):
 
 
624
    _fmt = "Cannot operate on %(filename)s of unsupported kind %(kind)s"
 
 
627
class ForbiddenControlFileError(BzrError):
 
 
629
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
 
632
class LockError(BzrError):
 
 
634
    _fmt = "Lock error: %(message)s"
 
 
636
    internal_error = True
 
 
638
    # All exceptions from the lock/unlock functions should be from
 
 
639
    # this exception class.  They will be translated as necessary. The
 
 
640
    # original exception is available as e.original_error
 
 
642
    # New code should prefer to raise specific subclasses
 
 
643
    def __init__(self, message):
 
 
644
        self.message = message
 
 
647
class LockActive(LockError):
 
 
649
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
 
651
    internal_error = False
 
 
653
    def __init__(self, lock_description):
 
 
654
        self.lock_description = lock_description
 
 
657
class CommitNotPossible(LockError):
 
 
659
    _fmt = "A commit was attempted but we do not have a write lock open."
 
 
665
class AlreadyCommitted(LockError):
 
 
667
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
 
673
class ReadOnlyError(LockError):
 
 
675
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
 
677
    def __init__(self, obj):
 
 
681
class OutSideTransaction(BzrError):
 
 
683
    _fmt = "A transaction related operation was attempted after the transaction finished."
 
 
686
class ObjectNotLocked(LockError):
 
 
688
    _fmt = "%(obj)r is not locked"
 
 
690
    # this can indicate that any particular object is not locked; see also
 
 
691
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
692
    # the caller -- perhaps they should be unified.
 
 
693
    def __init__(self, obj):
 
 
697
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
699
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
 
701
    def __init__(self, obj):
 
 
705
class UnlockableTransport(LockError):
 
 
707
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
 
709
    def __init__(self, transport):
 
 
710
        self.transport = transport
 
 
713
class LockContention(LockError):
 
 
715
    _fmt = "Could not acquire lock %(lock)s"
 
 
716
    # TODO: show full url for lock, combining the transport and relative
 
 
719
    internal_error = False
 
 
721
    def __init__(self, lock):
 
 
725
class LockBroken(LockError):
 
 
727
    _fmt = "Lock was broken while still open: %(lock)s - check storage consistency!"
 
 
729
    internal_error = False
 
 
731
    def __init__(self, lock):
 
 
735
class LockBreakMismatch(LockError):
 
 
737
    _fmt = "Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"
 
 
739
    internal_error = False
 
 
741
    def __init__(self, lock, holder, target):
 
 
747
class LockNotHeld(LockError):
 
 
749
    _fmt = "Lock not held: %(lock)s"
 
 
751
    internal_error = False
 
 
753
    def __init__(self, lock):
 
 
757
class PointlessCommit(BzrError):
 
 
759
    _fmt = "No changes to commit"
 
 
762
class UpgradeReadonly(BzrError):
 
 
764
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
 
767
class UpToDateFormat(BzrError):
 
 
769
    _fmt = "The branch format %(format)s is already at the most recent format."
 
 
771
    def __init__(self, format):
 
 
772
        BzrError.__init__(self)
 
 
776
class StrictCommitFailed(Exception):
 
 
778
    _fmt = "Commit refused because there are unknowns in the tree."
 
 
781
class NoSuchRevision(BzrError):
 
 
783
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
 
785
    internal_error = True
 
 
787
    def __init__(self, branch, revision):
 
 
788
        BzrError.__init__(self, branch=branch, revision=revision)
 
 
791
class NotLeftParentDescendant(BzrError):
 
 
793
    _fmt = "Revision %(old_revision)s is not the left parent of"\
 
 
794
        " %(new_revision)s, but branch %(branch_location)s expects this"
 
 
796
    internal_error = True
 
 
798
    def __init__(self, branch, old_revision, new_revision):
 
 
799
        BzrError.__init__(self, branch_location=branch.base,
 
 
800
                          old_revision=old_revision,
 
 
801
                          new_revision=new_revision)
 
 
804
class NoSuchRevisionSpec(BzrError):
 
 
806
    _fmt = "No namespace registered for string: %(spec)r"
 
 
808
    def __init__(self, spec):
 
 
809
        BzrError.__init__(self, spec=spec)
 
 
812
class NoSuchRevisionInTree(NoSuchRevision):
 
 
813
    """When using Tree.revision_tree, and the revision is not accessible."""
 
 
815
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
 
 
817
    def __init__(self, tree, revision_id):
 
 
818
        BzrError.__init__(self)
 
 
820
        self.revision_id = revision_id
 
 
823
class InvalidRevisionSpec(BzrError):
 
 
825
    _fmt = "Requested revision: %(spec)r does not exist in branch: %(branch)s%(extra)s"
 
 
827
    def __init__(self, spec, branch, extra=None):
 
 
828
        BzrError.__init__(self, branch=branch, spec=spec)
 
 
830
            self.extra = '\n' + str(extra)
 
 
835
class HistoryMissing(BzrError):
 
 
837
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
 
840
class AppendRevisionsOnlyViolation(BzrError):
 
 
842
    _fmt = 'Operation denied because it would change the main history, '\
 
 
843
           'which is not permitted by the append_revisions_only setting on'\
 
 
844
           ' branch "%(location)s".'
 
 
846
    def __init__(self, location):
 
 
847
       import bzrlib.urlutils as urlutils
 
 
848
       location = urlutils.unescape_for_display(location, 'ascii')
 
 
849
       BzrError.__init__(self, location=location)
 
 
852
class DivergedBranches(BzrError):
 
 
854
    _fmt = "These branches have diverged.  Use the merge command to reconcile them."""
 
 
856
    internal_error = False
 
 
858
    def __init__(self, branch1, branch2):
 
 
859
        self.branch1 = branch1
 
 
860
        self.branch2 = branch2
 
 
863
class NotLefthandHistory(BzrError):
 
 
865
    _fmt = "Supplied history does not follow left-hand parents"
 
 
867
    internal_error = True
 
 
869
    def __init__(self, history):
 
 
870
        BzrError.__init__(self, history=history)
 
 
873
class UnrelatedBranches(BzrError):
 
 
875
    _fmt = "Branches have no common ancestor, and no merge base revision was specified."
 
 
877
    internal_error = False
 
 
880
class NoCommonAncestor(BzrError):
 
 
882
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
884
    def __init__(self, revision_a, revision_b):
 
 
885
        self.revision_a = revision_a
 
 
886
        self.revision_b = revision_b
 
 
889
class NoCommonRoot(BzrError):
 
 
891
    _fmt = "Revisions are not derived from the same root: " \
 
 
892
           "%(revision_a)s %(revision_b)s."
 
 
894
    def __init__(self, revision_a, revision_b):
 
 
895
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
 
898
class NotAncestor(BzrError):
 
 
900
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
 
902
    def __init__(self, rev_id, not_ancestor_id):
 
 
903
        BzrError.__init__(self, rev_id=rev_id,
 
 
904
            not_ancestor_id=not_ancestor_id)
 
 
907
class InstallFailed(BzrError):
 
 
909
    def __init__(self, revisions):
 
 
910
        revision_str = ", ".join(str(r) for r in revisions)
 
 
911
        msg = "Could not install revisions:\n%s" % revision_str
 
 
912
        BzrError.__init__(self, msg)
 
 
913
        self.revisions = revisions
 
 
916
class AmbiguousBase(BzrError):
 
 
918
    def __init__(self, bases):
 
 
919
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
921
        msg = "The correct base is unclear, because %s are all equally close" %\
 
 
923
        BzrError.__init__(self, msg)
 
 
927
class NoCommits(BzrError):
 
 
929
    _fmt = "Branch %(branch)s has no commits."
 
 
931
    def __init__(self, branch):
 
 
932
        BzrError.__init__(self, branch=branch)
 
 
935
class UnlistableStore(BzrError):
 
 
937
    def __init__(self, store):
 
 
938
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
942
class UnlistableBranch(BzrError):
 
 
944
    def __init__(self, br):
 
 
945
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
948
class BoundBranchOutOfDate(BzrError):
 
 
950
    _fmt = "Bound branch %(branch)s is out of date with master branch %(master)s."
 
 
952
    def __init__(self, branch, master):
 
 
953
        BzrError.__init__(self)
 
 
958
class CommitToDoubleBoundBranch(BzrError):
 
 
960
    _fmt = "Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."
 
 
962
    def __init__(self, branch, master, remote):
 
 
963
        BzrError.__init__(self)
 
 
969
class OverwriteBoundBranch(BzrError):
 
 
971
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
 
973
    def __init__(self, branch):
 
 
974
        BzrError.__init__(self)
 
 
978
class BoundBranchConnectionFailure(BzrError):
 
 
980
    _fmt = "Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"
 
 
982
    def __init__(self, branch, target, error):
 
 
983
        BzrError.__init__(self)
 
 
989
class WeaveError(BzrError):
 
 
991
    _fmt = "Error in processing weave: %(message)s"
 
 
993
    def __init__(self, message=None):
 
 
994
        BzrError.__init__(self)
 
 
995
        self.message = message
 
 
998
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
1000
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
 
1002
    def __init__(self, revision_id, weave):
 
 
1004
        WeaveError.__init__(self)
 
 
1005
        self.revision_id = revision_id
 
 
1009
class WeaveRevisionNotPresent(WeaveError):
 
 
1011
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
 
1013
    def __init__(self, revision_id, weave):
 
 
1014
        WeaveError.__init__(self)
 
 
1015
        self.revision_id = revision_id
 
 
1019
class WeaveFormatError(WeaveError):
 
 
1021
    _fmt = "Weave invariant violated: %(what)s"
 
 
1023
    def __init__(self, what):
 
 
1024
        WeaveError.__init__(self)
 
 
1028
class WeaveParentMismatch(WeaveError):
 
 
1030
    _fmt = "Parents are mismatched between two revisions."
 
 
1033
class WeaveInvalidChecksum(WeaveError):
 
 
1035
    _fmt = "Text did not match it's checksum: %(message)s"
 
 
1038
class WeaveTextDiffers(WeaveError):
 
 
1040
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
 
1042
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1043
        WeaveError.__init__(self)
 
 
1044
        self.revision_id = revision_id
 
 
1045
        self.weave_a = weave_a
 
 
1046
        self.weave_b = weave_b
 
 
1049
class WeaveTextDiffers(WeaveError):
 
 
1051
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
 
1053
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1054
        WeaveError.__init__(self)
 
 
1055
        self.revision_id = revision_id
 
 
1056
        self.weave_a = weave_a
 
 
1057
        self.weave_b = weave_b
 
 
1060
class VersionedFileError(BzrError):
 
 
1062
    _fmt = "Versioned file error"
 
 
1065
class RevisionNotPresent(VersionedFileError):
 
 
1067
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
 
1069
    def __init__(self, revision_id, file_id):
 
 
1070
        VersionedFileError.__init__(self)
 
 
1071
        self.revision_id = revision_id
 
 
1072
        self.file_id = file_id
 
 
1075
class RevisionAlreadyPresent(VersionedFileError):
 
 
1077
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
 
1079
    def __init__(self, revision_id, file_id):
 
 
1080
        VersionedFileError.__init__(self)
 
 
1081
        self.revision_id = revision_id
 
 
1082
        self.file_id = file_id
 
 
1085
class KnitError(BzrError):
 
 
1089
    internal_error = True
 
 
1092
class KnitHeaderError(KnitError):
 
 
1094
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
 
1096
    def __init__(self, badline, filename):
 
 
1097
        KnitError.__init__(self)
 
 
1098
        self.badline = badline
 
 
1099
        self.filename = filename
 
 
1102
class KnitCorrupt(KnitError):
 
 
1104
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
 
1106
    def __init__(self, filename, how):
 
 
1107
        KnitError.__init__(self)
 
 
1108
        self.filename = filename
 
 
1112
class KnitIndexUnknownMethod(KnitError):
 
 
1113
    """Raised when we don't understand the storage method.
 
 
1115
    Currently only 'fulltext' and 'line-delta' are supported.
 
 
1118
    _fmt = ("Knit index %(filename)s does not have a known method"
 
 
1119
            " in options: %(options)r")
 
 
1121
    def __init__(self, filename, options):
 
 
1122
        KnitError.__init__(self)
 
 
1123
        self.filename = filename
 
 
1124
        self.options = options
 
 
1127
class NoSuchExportFormat(BzrError):
 
 
1129
    _fmt = "Export format %(format)r not supported"
 
 
1131
    def __init__(self, format):
 
 
1132
        BzrError.__init__(self)
 
 
1133
        self.format = format
 
 
1136
class TransportError(BzrError):
 
 
1138
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
 
1140
    def __init__(self, msg=None, orig_error=None):
 
 
1141
        if msg is None and orig_error is not None:
 
 
1142
            msg = str(orig_error)
 
 
1143
        if orig_error is None:
 
 
1148
        self.orig_error = orig_error
 
 
1149
        BzrError.__init__(self)
 
 
1152
class TooManyConcurrentRequests(BzrError):
 
 
1154
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit. "
 
 
1155
            "Be sure to finish_writing and finish_reading on the "
 
 
1156
            "current request that is open.")
 
 
1158
    internal_error = True
 
 
1160
    def __init__(self, medium):
 
 
1161
        self.medium = medium
 
 
1164
class SmartProtocolError(TransportError):
 
 
1166
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
 
1168
    def __init__(self, details):
 
 
1169
        self.details = details
 
 
1172
# A set of semi-meaningful errors which can be thrown
 
 
1173
class TransportNotPossible(TransportError):
 
 
1175
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
 
1178
class ConnectionError(TransportError):
 
 
1180
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
 
1183
class SocketConnectionError(ConnectionError):
 
 
1185
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
 
1187
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
1189
            msg = 'Failed to connect to'
 
 
1190
        if orig_error is None:
 
 
1193
            orig_error = '; ' + str(orig_error)
 
 
1194
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
1199
            self.port = ':%s' % port
 
 
1202
class ConnectionReset(TransportError):
 
 
1204
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
 
1207
class InvalidRange(TransportError):
 
 
1209
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
 
1211
    def __init__(self, path, offset):
 
 
1212
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
 
1215
        self.offset = offset
 
 
1218
class InvalidHttpResponse(TransportError):
 
 
1220
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
 
1222
    def __init__(self, path, msg, orig_error=None):
 
 
1224
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
1227
class InvalidHttpRange(InvalidHttpResponse):
 
 
1229
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
 
1231
    def __init__(self, path, range, msg):
 
 
1233
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1236
class InvalidHttpContentType(InvalidHttpResponse):
 
 
1238
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
 
1240
    def __init__(self, path, ctype, msg):
 
 
1242
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1245
class ConflictsInTree(BzrError):
 
 
1247
    _fmt = "Working tree has conflicts."
 
 
1250
class ParseConfigError(BzrError):
 
 
1252
    def __init__(self, errors, filename):
 
 
1253
        if filename is None:
 
 
1255
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
1256
            (filename, ('\n'.join(e.message for e in errors)))
 
 
1257
        BzrError.__init__(self, message)
 
 
1260
class NoEmailInUsername(BzrError):
 
 
1262
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
 
1264
    def __init__(self, username):
 
 
1265
        BzrError.__init__(self)
 
 
1266
        self.username = username
 
 
1269
class SigningFailed(BzrError):
 
 
1271
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
 
1273
    def __init__(self, command_line):
 
 
1274
        BzrError.__init__(self, command_line=command_line)
 
 
1277
class WorkingTreeNotRevision(BzrError):
 
 
1279
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
 
1280
            " the last commit, but weave merge requires that it be"
 
 
1283
    def __init__(self, tree):
 
 
1284
        BzrError.__init__(self, basedir=tree.basedir)
 
 
1287
class CantReprocessAndShowBase(BzrError):
 
 
1289
    _fmt = "Can't reprocess and show base, because reprocessing obscures " \
 
 
1290
           "the relationship of conflicting lines to the base"
 
 
1293
class GraphCycleError(BzrError):
 
 
1295
    _fmt = "Cycle in graph %(graph)r"
 
 
1297
    def __init__(self, graph):
 
 
1298
        BzrError.__init__(self)
 
 
1302
class WritingCompleted(BzrError):
 
 
1304
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
 
1305
            "called upon it - accept bytes may not be called anymore.")
 
 
1307
    internal_error = True
 
 
1309
    def __init__(self, request):
 
 
1310
        self.request = request
 
 
1313
class WritingNotComplete(BzrError):
 
 
1315
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
 
1316
            "called upon it - until the write phase is complete no "
 
 
1317
            "data may be read.")
 
 
1319
    internal_error = True
 
 
1321
    def __init__(self, request):
 
 
1322
        self.request = request
 
 
1325
class NotConflicted(BzrError):
 
 
1327
    _fmt = "File %(filename)s is not conflicted."
 
 
1329
    def __init__(self, filename):
 
 
1330
        BzrError.__init__(self)
 
 
1331
        self.filename = filename
 
 
1334
class MediumNotConnected(BzrError):
 
 
1336
    _fmt = """The medium '%(medium)s' is not connected."""
 
 
1338
    internal_error = True
 
 
1340
    def __init__(self, medium):
 
 
1341
        self.medium = medium
 
 
1344
class MustUseDecorated(Exception):
 
 
1346
    _fmt = """A decorating function has requested its original command be used."""
 
 
1349
class NoBundleFound(BzrError):
 
 
1351
    _fmt = "No bundle was found in %(filename)s"
 
 
1353
    def __init__(self, filename):
 
 
1354
        BzrError.__init__(self)
 
 
1355
        self.filename = filename
 
 
1358
class BundleNotSupported(BzrError):
 
 
1360
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
 
1362
    def __init__(self, version, msg):
 
 
1363
        BzrError.__init__(self)
 
 
1364
        self.version = version
 
 
1368
class MissingText(BzrError):
 
 
1370
    _fmt = "Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"
 
 
1372
    def __init__(self, branch, text_revision, file_id):
 
 
1373
        BzrError.__init__(self)
 
 
1374
        self.branch = branch
 
 
1375
        self.base = branch.base
 
 
1376
        self.text_revision = text_revision
 
 
1377
        self.file_id = file_id
 
 
1380
class DuplicateFileId(BzrError):
 
 
1382
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
 
1384
    def __init__(self, file_id, entry):
 
 
1385
        BzrError.__init__(self)
 
 
1386
        self.file_id = file_id
 
 
1390
class DuplicateKey(BzrError):
 
 
1392
    _fmt = "Key %(key)s is already present in map"
 
 
1395
class MalformedTransform(BzrError):
 
 
1397
    _fmt = "Tree transform is malformed %(conflicts)r"
 
 
1400
class NoFinalPath(BzrError):
 
 
1402
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
 
1403
            "file-id: %(file_id)r\n"
 
 
1404
            "root trans-id: %(root_trans_id)r\n")
 
 
1406
    def __init__(self, trans_id, transform):
 
 
1407
        self.trans_id = trans_id
 
 
1408
        self.file_id = transform.final_file_id(trans_id)
 
 
1409
        self.root_trans_id = transform.root
 
 
1412
class BzrBadParameter(BzrError):
 
 
1414
    _fmt = "Bad parameter: %(param)r"
 
 
1416
    # This exception should never be thrown, but it is a base class for all
 
 
1417
    # parameter-to-function errors.
 
 
1419
    def __init__(self, param):
 
 
1420
        BzrError.__init__(self)
 
 
1424
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1426
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
 
1429
class ReusingTransform(BzrError):
 
 
1431
    _fmt = "Attempt to reuse a transform that has already been applied."
 
 
1434
class CantMoveRoot(BzrError):
 
 
1436
    _fmt = "Moving the root directory is not supported at this time"
 
 
1439
class BzrMoveFailedError(BzrError):
 
 
1441
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1443
    def __init__(self, from_path='', to_path='', extra=None):
 
 
1444
        BzrError.__init__(self)
 
 
1446
            self.extra = ': ' + str(extra)
 
 
1450
        has_from = len(from_path) > 0
 
 
1451
        has_to = len(to_path) > 0
 
 
1453
            self.from_path = osutils.splitpath(from_path)[-1]
 
 
1458
            self.to_path = osutils.splitpath(to_path)[-1]
 
 
1463
        if has_from and has_to:
 
 
1464
            self.operator = " =>"
 
 
1466
            self.from_path = "from " + from_path
 
 
1468
            self.operator = "to"
 
 
1470
            self.operator = "file"
 
 
1473
class BzrRenameFailedError(BzrMoveFailedError):
 
 
1475
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1477
    def __init__(self, from_path, to_path, extra=None):
 
 
1478
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
 
1481
class BzrBadParameterNotString(BzrBadParameter):
 
 
1483
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
 
1486
class BzrBadParameterMissing(BzrBadParameter):
 
 
1488
    _fmt = "Parameter $(param)s is required but not present."
 
 
1491
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1493
    _fmt = "Parameter %(param)s is unicode but only byte-strings are permitted."
 
 
1496
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1498
    _fmt = "Parameter %(param)s contains a newline."
 
 
1501
class DependencyNotPresent(BzrError):
 
 
1503
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
 
1505
    def __init__(self, library, error):
 
 
1506
        BzrError.__init__(self, library=library, error=error)
 
 
1509
class ParamikoNotPresent(DependencyNotPresent):
 
 
1511
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
 
1513
    def __init__(self, error):
 
 
1514
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1517
class PointlessMerge(BzrError):
 
 
1519
    _fmt = "Nothing to merge."
 
 
1522
class UninitializableFormat(BzrError):
 
 
1524
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
 
1526
    def __init__(self, format):
 
 
1527
        BzrError.__init__(self)
 
 
1528
        self.format = format
 
 
1531
class BadConversionTarget(BzrError):
 
 
1533
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
 
1535
    def __init__(self, problem, format):
 
 
1536
        BzrError.__init__(self)
 
 
1537
        self.problem = problem
 
 
1538
        self.format = format
 
 
1541
class NoDiff(BzrError):
 
 
1543
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
 
1545
    def __init__(self, msg):
 
 
1546
        BzrError.__init__(self, msg=msg)
 
 
1549
class NoDiff3(BzrError):
 
 
1551
    _fmt = "Diff3 is not installed on this machine."
 
 
1554
class ExistingLimbo(BzrError):
 
 
1556
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1557
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1558
    keep, and delete it when you are done."""
 
 
1560
    def __init__(self, limbo_dir):
 
 
1561
       BzrError.__init__(self)
 
 
1562
       self.limbo_dir = limbo_dir
 
 
1565
class ImmortalLimbo(BzrError):
 
 
1567
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
 
1568
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1569
    keep, and delete it when you are done."""
 
 
1571
    def __init__(self, limbo_dir):
 
 
1572
       BzrError.__init__(self)
 
 
1573
       self.limbo_dir = limbo_dir
 
 
1576
class OutOfDateTree(BzrError):
 
 
1578
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
 
1580
    def __init__(self, tree):
 
 
1581
        BzrError.__init__(self)
 
 
1585
class MergeModifiedFormatError(BzrError):
 
 
1587
    _fmt = "Error in merge modified format"
 
 
1590
class ConflictFormatError(BzrError):
 
 
1592
    _fmt = "Format error in conflict listings"
 
 
1595
class CorruptRepository(BzrError):
 
 
1597
    _fmt = """An error has been detected in the repository %(repo_path)s.
 
 
1598
Please run bzr reconcile on this repository."""
 
 
1600
    def __init__(self, repo):
 
 
1601
        BzrError.__init__(self)
 
 
1602
        self.repo_path = repo.bzrdir.root_transport.base
 
 
1605
class UpgradeRequired(BzrError):
 
 
1607
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
 
1609
    def __init__(self, path):
 
 
1610
        BzrError.__init__(self)
 
 
1614
class LocalRequiresBoundBranch(BzrError):
 
 
1616
    _fmt = "Cannot perform local-only commits on unbound branches."
 
 
1619
class MissingProgressBarFinish(BzrError):
 
 
1621
    _fmt = "A nested progress bar was not 'finished' correctly."
 
 
1624
class InvalidProgressBarType(BzrError):
 
 
1626
    _fmt = """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
 
1627
Select one of: %(valid_types)s"""
 
 
1629
    def __init__(self, bar_type, valid_types):
 
 
1630
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
1633
class UnsupportedOperation(BzrError):
 
 
1635
    _fmt = "The method %(mname)s is not supported on objects of type %(tname)s."
 
 
1637
    def __init__(self, method, method_self):
 
 
1638
        self.method = method
 
 
1639
        self.mname = method.__name__
 
 
1640
        self.tname = type(method_self).__name__
 
 
1643
class CannotSetRevisionId(UnsupportedOperation):
 
 
1644
    """Raised when a commit is attempting to set a revision id but cant."""
 
 
1647
class NonAsciiRevisionId(UnsupportedOperation):
 
 
1648
    """Raised when a commit is attempting to set a non-ascii revision id but cant."""
 
 
1651
class BinaryFile(BzrError):
 
 
1653
    _fmt = "File is binary but should be text."
 
 
1656
class IllegalPath(BzrError):
 
 
1658
    _fmt = "The path %(path)s is not permitted on this platform"
 
 
1660
    def __init__(self, path):
 
 
1661
        BzrError.__init__(self)
 
 
1665
class TestamentMismatch(BzrError):
 
 
1667
    _fmt = """Testament did not match expected value.  
 
 
1668
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
 
1671
    def __init__(self, revision_id, expected, measured):
 
 
1672
        self.revision_id = revision_id
 
 
1673
        self.expected = expected
 
 
1674
        self.measured = measured
 
 
1677
class NotABundle(BzrError):
 
 
1679
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
 
1681
    def __init__(self, text):
 
 
1682
        BzrError.__init__(self)
 
 
1686
class BadBundle(BzrError): 
 
 
1688
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
 
1690
    def __init__(self, text):
 
 
1691
        BzrError.__init__(self)
 
 
1695
class MalformedHeader(BadBundle): 
 
 
1697
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
 
1700
class MalformedPatches(BadBundle): 
 
 
1702
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
 
1705
class MalformedFooter(BadBundle): 
 
 
1707
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
 
1710
class UnsupportedEOLMarker(BadBundle):
 
 
1712
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
 
1715
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
 
1716
        # but for this there is not
 
 
1717
        BzrError.__init__(self)
 
 
1720
class IncompatibleBundleFormat(BzrError):
 
 
1722
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
 
1724
    def __init__(self, bundle_format, other):
 
 
1725
        BzrError.__init__(self)
 
 
1726
        self.bundle_format = bundle_format
 
 
1730
class BadInventoryFormat(BzrError):
 
 
1732
    _fmt = "Root class for inventory serialization errors"
 
 
1735
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
1737
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
 
1739
    def __init__(self, msg):
 
 
1740
        BadInventoryFormat.__init__(self, msg=msg)
 
 
1743
class NoSmartMedium(BzrError):
 
 
1745
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
 
1746
    internal_error = True
 
 
1748
    def __init__(self, transport):
 
 
1749
        self.transport = transport
 
 
1752
class NoSmartServer(NotBranchError):
 
 
1754
    _fmt = "No smart server available at %(url)s"
 
 
1756
    def __init__(self, url):
 
 
1760
class UnknownSSH(BzrError):
 
 
1762
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
 
1764
    def __init__(self, vendor):
 
 
1765
        BzrError.__init__(self)
 
 
1766
        self.vendor = vendor
 
 
1769
class GhostRevisionUnusableHere(BzrError):
 
 
1771
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
 
1773
    def __init__(self, revision_id):
 
 
1774
        BzrError.__init__(self)
 
 
1775
        self.revision_id = revision_id
 
 
1778
class IllegalUseOfScopeReplacer(BzrError):
 
 
1780
    _fmt = "ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"
 
 
1782
    internal_error = True
 
 
1784
    def __init__(self, name, msg, extra=None):
 
 
1785
        BzrError.__init__(self)
 
 
1789
            self.extra = ': ' + str(extra)
 
 
1794
class InvalidImportLine(BzrError):
 
 
1796
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
 
1798
    internal_error = True
 
 
1800
    def __init__(self, text, msg):
 
 
1801
        BzrError.__init__(self)
 
 
1806
class ImportNameCollision(BzrError):
 
 
1808
    _fmt = "Tried to import an object to the same name as an existing object. %(name)s"
 
 
1810
    internal_error = True
 
 
1812
    def __init__(self, name):
 
 
1813
        BzrError.__init__(self)