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: %(msg)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
        # Python 2.5 uses a slot for StandardError.message,
 
 
661
        # so use a different variable name
 
 
662
        # so it is exposed in self.__dict__
 
 
666
class LockActive(LockError):
 
 
668
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
 
670
    internal_error = False
 
 
672
    def __init__(self, lock_description):
 
 
673
        self.lock_description = lock_description
 
 
676
class CommitNotPossible(LockError):
 
 
678
    _fmt = "A commit was attempted but we do not have a write lock open."
 
 
684
class AlreadyCommitted(LockError):
 
 
686
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
 
692
class ReadOnlyError(LockError):
 
 
694
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
 
696
    # TODO: There should also be an error indicating that you need a write
 
 
697
    # lock and don't have any lock at all... mbp 20070226
 
 
699
    def __init__(self, obj):
 
 
703
class ReadOnlyLockError(LockError):
 
 
705
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
 
707
    def __init__(self, fname, msg):
 
 
708
        LockError.__init__(self, '')
 
 
713
class OutSideTransaction(BzrError):
 
 
715
    _fmt = ("A transaction related operation was attempted after"
 
 
716
            " the transaction finished.")
 
 
719
class ObjectNotLocked(LockError):
 
 
721
    _fmt = "%(obj)r is not locked"
 
 
723
    # this can indicate that any particular object is not locked; see also
 
 
724
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
725
    # the caller -- perhaps they should be unified.
 
 
726
    def __init__(self, obj):
 
 
730
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
732
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
 
734
    def __init__(self, obj):
 
 
738
class UnlockableTransport(LockError):
 
 
740
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
 
742
    def __init__(self, transport):
 
 
743
        self.transport = transport
 
 
746
class LockContention(LockError):
 
 
748
    _fmt = "Could not acquire lock %(lock)s"
 
 
749
    # TODO: show full url for lock, combining the transport and relative
 
 
752
    internal_error = False
 
 
754
    def __init__(self, lock):
 
 
758
class LockBroken(LockError):
 
 
760
    _fmt = ("Lock was broken while still open: %(lock)s"
 
 
761
            " - check storage consistency!")
 
 
763
    internal_error = False
 
 
765
    def __init__(self, lock):
 
 
769
class LockBreakMismatch(LockError):
 
 
771
    _fmt = ("Lock was released and re-acquired before being broken:"
 
 
772
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
 
774
    internal_error = False
 
 
776
    def __init__(self, lock, holder, target):
 
 
782
class LockNotHeld(LockError):
 
 
784
    _fmt = "Lock not held: %(lock)s"
 
 
786
    internal_error = False
 
 
788
    def __init__(self, lock):
 
 
792
class PointlessCommit(BzrError):
 
 
794
    _fmt = "No changes to commit"
 
 
797
class UpgradeReadonly(BzrError):
 
 
799
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
 
802
class UpToDateFormat(BzrError):
 
 
804
    _fmt = "The branch format %(format)s is already at the most recent format."
 
 
806
    def __init__(self, format):
 
 
807
        BzrError.__init__(self)
 
 
811
class StrictCommitFailed(Exception):
 
 
813
    _fmt = "Commit refused because there are unknowns in the tree."
 
 
816
class NoSuchRevision(BzrError):
 
 
818
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
 
820
    internal_error = True
 
 
822
    def __init__(self, branch, revision):
 
 
823
        BzrError.__init__(self, branch=branch, revision=revision)
 
 
826
class NotLeftParentDescendant(BzrError):
 
 
828
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
 
829
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
 
831
    internal_error = True
 
 
833
    def __init__(self, branch, old_revision, new_revision):
 
 
834
        BzrError.__init__(self, branch_location=branch.base,
 
 
835
                          old_revision=old_revision,
 
 
836
                          new_revision=new_revision)
 
 
839
class NoSuchRevisionSpec(BzrError):
 
 
841
    _fmt = "No namespace registered for string: %(spec)r"
 
 
843
    def __init__(self, spec):
 
 
844
        BzrError.__init__(self, spec=spec)
 
 
847
class NoSuchRevisionInTree(NoSuchRevision):
 
 
848
    """When using Tree.revision_tree, and the revision is not accessible."""
 
 
850
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
 
 
852
    def __init__(self, tree, revision_id):
 
 
853
        BzrError.__init__(self)
 
 
855
        self.revision_id = revision_id
 
 
858
class InvalidRevisionSpec(BzrError):
 
 
860
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
 
861
            " %(branch)s%(extra)s")
 
 
863
    def __init__(self, spec, branch, extra=None):
 
 
864
        BzrError.__init__(self, branch=branch, spec=spec)
 
 
866
            self.extra = '\n' + str(extra)
 
 
871
class HistoryMissing(BzrError):
 
 
873
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
 
876
class AppendRevisionsOnlyViolation(BzrError):
 
 
878
    _fmt = ('Operation denied because it would change the main history,'
 
 
879
           ' which is not permitted by the append_revisions_only setting on'
 
 
880
           ' branch "%(location)s".')
 
 
882
    def __init__(self, location):
 
 
883
       import bzrlib.urlutils as urlutils
 
 
884
       location = urlutils.unescape_for_display(location, 'ascii')
 
 
885
       BzrError.__init__(self, location=location)
 
 
888
class DivergedBranches(BzrError):
 
 
890
    _fmt = ("These branches have diverged."
 
 
891
            " Use the merge command to reconcile them.")
 
 
893
    internal_error = False
 
 
895
    def __init__(self, branch1, branch2):
 
 
896
        self.branch1 = branch1
 
 
897
        self.branch2 = branch2
 
 
900
class NotLefthandHistory(BzrError):
 
 
902
    _fmt = "Supplied history does not follow left-hand parents"
 
 
904
    internal_error = True
 
 
906
    def __init__(self, history):
 
 
907
        BzrError.__init__(self, history=history)
 
 
910
class UnrelatedBranches(BzrError):
 
 
912
    _fmt = ("Branches have no common ancestor, and"
 
 
913
            " no merge base revision was specified.")
 
 
915
    internal_error = False
 
 
918
class NoCommonAncestor(BzrError):
 
 
920
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
922
    def __init__(self, revision_a, revision_b):
 
 
923
        self.revision_a = revision_a
 
 
924
        self.revision_b = revision_b
 
 
927
class NoCommonRoot(BzrError):
 
 
929
    _fmt = ("Revisions are not derived from the same root: "
 
 
930
           "%(revision_a)s %(revision_b)s.")
 
 
932
    def __init__(self, revision_a, revision_b):
 
 
933
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
 
936
class NotAncestor(BzrError):
 
 
938
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
 
940
    def __init__(self, rev_id, not_ancestor_id):
 
 
941
        BzrError.__init__(self, rev_id=rev_id,
 
 
942
            not_ancestor_id=not_ancestor_id)
 
 
945
class InstallFailed(BzrError):
 
 
947
    def __init__(self, revisions):
 
 
948
        revision_str = ", ".join(str(r) for r in revisions)
 
 
949
        msg = "Could not install revisions:\n%s" % revision_str
 
 
950
        BzrError.__init__(self, msg)
 
 
951
        self.revisions = revisions
 
 
954
class AmbiguousBase(BzrError):
 
 
956
    def __init__(self, bases):
 
 
957
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
959
        msg = ("The correct base is unclear, because %s are all equally close"
 
 
961
        BzrError.__init__(self, msg)
 
 
965
class NoCommits(BzrError):
 
 
967
    _fmt = "Branch %(branch)s has no commits."
 
 
969
    def __init__(self, branch):
 
 
970
        BzrError.__init__(self, branch=branch)
 
 
973
class UnlistableStore(BzrError):
 
 
975
    def __init__(self, store):
 
 
976
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
980
class UnlistableBranch(BzrError):
 
 
982
    def __init__(self, br):
 
 
983
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
986
class BoundBranchOutOfDate(BzrError):
 
 
988
    _fmt = ("Bound branch %(branch)s is out of date"
 
 
989
            " with master branch %(master)s.")
 
 
991
    def __init__(self, branch, master):
 
 
992
        BzrError.__init__(self)
 
 
997
class CommitToDoubleBoundBranch(BzrError):
 
 
999
    _fmt = ("Cannot commit to branch %(branch)s."
 
 
1000
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
 
1002
    def __init__(self, branch, master, remote):
 
 
1003
        BzrError.__init__(self)
 
 
1004
        self.branch = branch
 
 
1005
        self.master = master
 
 
1006
        self.remote = remote
 
 
1009
class OverwriteBoundBranch(BzrError):
 
 
1011
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
 
1013
    def __init__(self, branch):
 
 
1014
        BzrError.__init__(self)
 
 
1015
        self.branch = branch
 
 
1018
class BoundBranchConnectionFailure(BzrError):
 
 
1020
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
 
1021
            " => %(target)s: %(error)s")
 
 
1023
    def __init__(self, branch, target, error):
 
 
1024
        BzrError.__init__(self)
 
 
1025
        self.branch = branch
 
 
1026
        self.target = target
 
 
1030
class WeaveError(BzrError):
 
 
1032
    _fmt = "Error in processing weave: %(message)s"
 
 
1034
    def __init__(self, message=None):
 
 
1035
        BzrError.__init__(self)
 
 
1036
        self.message = message
 
 
1039
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
1041
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
 
1043
    def __init__(self, revision_id, weave):
 
 
1045
        WeaveError.__init__(self)
 
 
1046
        self.revision_id = revision_id
 
 
1050
class WeaveRevisionNotPresent(WeaveError):
 
 
1052
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
 
1054
    def __init__(self, revision_id, weave):
 
 
1055
        WeaveError.__init__(self)
 
 
1056
        self.revision_id = revision_id
 
 
1060
class WeaveFormatError(WeaveError):
 
 
1062
    _fmt = "Weave invariant violated: %(what)s"
 
 
1064
    def __init__(self, what):
 
 
1065
        WeaveError.__init__(self)
 
 
1069
class WeaveParentMismatch(WeaveError):
 
 
1071
    _fmt = "Parents are mismatched between two revisions."
 
 
1074
class WeaveInvalidChecksum(WeaveError):
 
 
1076
    _fmt = "Text did not match it's checksum: %(message)s"
 
 
1079
class WeaveTextDiffers(WeaveError):
 
 
1081
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1082
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1084
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1085
        WeaveError.__init__(self)
 
 
1086
        self.revision_id = revision_id
 
 
1087
        self.weave_a = weave_a
 
 
1088
        self.weave_b = weave_b
 
 
1091
class WeaveTextDiffers(WeaveError):
 
 
1093
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1094
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1096
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1097
        WeaveError.__init__(self)
 
 
1098
        self.revision_id = revision_id
 
 
1099
        self.weave_a = weave_a
 
 
1100
        self.weave_b = weave_b
 
 
1103
class VersionedFileError(BzrError):
 
 
1105
    _fmt = "Versioned file error"
 
 
1108
class RevisionNotPresent(VersionedFileError):
 
 
1110
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
 
1112
    def __init__(self, revision_id, file_id):
 
 
1113
        VersionedFileError.__init__(self)
 
 
1114
        self.revision_id = revision_id
 
 
1115
        self.file_id = file_id
 
 
1118
class RevisionAlreadyPresent(VersionedFileError):
 
 
1120
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
 
1122
    def __init__(self, revision_id, file_id):
 
 
1123
        VersionedFileError.__init__(self)
 
 
1124
        self.revision_id = revision_id
 
 
1125
        self.file_id = file_id
 
 
1128
class KnitError(BzrError):
 
 
1132
    internal_error = True
 
 
1135
class KnitHeaderError(KnitError):
 
 
1137
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
 
1139
    def __init__(self, badline, filename):
 
 
1140
        KnitError.__init__(self)
 
 
1141
        self.badline = badline
 
 
1142
        self.filename = filename
 
 
1145
class KnitCorrupt(KnitError):
 
 
1147
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
 
1149
    def __init__(self, filename, how):
 
 
1150
        KnitError.__init__(self)
 
 
1151
        self.filename = filename
 
 
1155
class KnitIndexUnknownMethod(KnitError):
 
 
1156
    """Raised when we don't understand the storage method.
 
 
1158
    Currently only 'fulltext' and 'line-delta' are supported.
 
 
1161
    _fmt = ("Knit index %(filename)s does not have a known method"
 
 
1162
            " in options: %(options)r")
 
 
1164
    def __init__(self, filename, options):
 
 
1165
        KnitError.__init__(self)
 
 
1166
        self.filename = filename
 
 
1167
        self.options = options
 
 
1170
class NoSuchExportFormat(BzrError):
 
 
1172
    _fmt = "Export format %(format)r not supported"
 
 
1174
    def __init__(self, format):
 
 
1175
        BzrError.__init__(self)
 
 
1176
        self.format = format
 
 
1179
class TransportError(BzrError):
 
 
1181
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
 
1183
    def __init__(self, msg=None, orig_error=None):
 
 
1184
        if msg is None and orig_error is not None:
 
 
1185
            msg = str(orig_error)
 
 
1186
        if orig_error is None:
 
 
1191
        self.orig_error = orig_error
 
 
1192
        BzrError.__init__(self)
 
 
1195
class TooManyConcurrentRequests(BzrError):
 
 
1197
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
 
1198
            " Be sure to finish_writing and finish_reading on the"
 
 
1199
            " current request that is open.")
 
 
1201
    internal_error = True
 
 
1203
    def __init__(self, medium):
 
 
1204
        self.medium = medium
 
 
1207
class SmartProtocolError(TransportError):
 
 
1209
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
 
1211
    def __init__(self, details):
 
 
1212
        self.details = details
 
 
1215
# A set of semi-meaningful errors which can be thrown
 
 
1216
class TransportNotPossible(TransportError):
 
 
1218
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
 
1221
class ConnectionError(TransportError):
 
 
1223
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
 
1226
class SocketConnectionError(ConnectionError):
 
 
1228
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
 
1230
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
1232
            msg = 'Failed to connect to'
 
 
1233
        if orig_error is None:
 
 
1236
            orig_error = '; ' + str(orig_error)
 
 
1237
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
1242
            self.port = ':%s' % port
 
 
1245
class ConnectionReset(TransportError):
 
 
1247
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
 
1250
class InvalidRange(TransportError):
 
 
1252
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
 
1254
    def __init__(self, path, offset):
 
 
1255
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
 
1258
        self.offset = offset
 
 
1261
class InvalidHttpResponse(TransportError):
 
 
1263
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
 
1265
    def __init__(self, path, msg, orig_error=None):
 
 
1267
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
1270
class InvalidHttpRange(InvalidHttpResponse):
 
 
1272
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
 
1274
    def __init__(self, path, range, msg):
 
 
1276
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1279
class InvalidHttpContentType(InvalidHttpResponse):
 
 
1281
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
 
1283
    def __init__(self, path, ctype, msg):
 
 
1285
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1288
class ConflictsInTree(BzrError):
 
 
1290
    _fmt = "Working tree has conflicts."
 
 
1293
class ParseConfigError(BzrError):
 
 
1295
    def __init__(self, errors, filename):
 
 
1296
        if filename is None:
 
 
1298
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
1299
            (filename, ('\n'.join(e.message for e in errors)))
 
 
1300
        BzrError.__init__(self, message)
 
 
1303
class NoEmailInUsername(BzrError):
 
 
1305
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
 
1307
    def __init__(self, username):
 
 
1308
        BzrError.__init__(self)
 
 
1309
        self.username = username
 
 
1312
class SigningFailed(BzrError):
 
 
1314
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
 
1316
    def __init__(self, command_line):
 
 
1317
        BzrError.__init__(self, command_line=command_line)
 
 
1320
class WorkingTreeNotRevision(BzrError):
 
 
1322
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
 
1323
            " the last commit, but weave merge requires that it be"
 
 
1326
    def __init__(self, tree):
 
 
1327
        BzrError.__init__(self, basedir=tree.basedir)
 
 
1330
class CantReprocessAndShowBase(BzrError):
 
 
1332
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
 
1333
           "the relationship of conflicting lines to the base")
 
 
1336
class GraphCycleError(BzrError):
 
 
1338
    _fmt = "Cycle in graph %(graph)r"
 
 
1340
    def __init__(self, graph):
 
 
1341
        BzrError.__init__(self)
 
 
1345
class WritingCompleted(BzrError):
 
 
1347
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
 
1348
            "called upon it - accept bytes may not be called anymore.")
 
 
1350
    internal_error = True
 
 
1352
    def __init__(self, request):
 
 
1353
        self.request = request
 
 
1356
class WritingNotComplete(BzrError):
 
 
1358
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
 
1359
            "called upon it - until the write phase is complete no "
 
 
1360
            "data may be read.")
 
 
1362
    internal_error = True
 
 
1364
    def __init__(self, request):
 
 
1365
        self.request = request
 
 
1368
class NotConflicted(BzrError):
 
 
1370
    _fmt = "File %(filename)s is not conflicted."
 
 
1372
    def __init__(self, filename):
 
 
1373
        BzrError.__init__(self)
 
 
1374
        self.filename = filename
 
 
1377
class MediumNotConnected(BzrError):
 
 
1379
    _fmt = """The medium '%(medium)s' is not connected."""
 
 
1381
    internal_error = True
 
 
1383
    def __init__(self, medium):
 
 
1384
        self.medium = medium
 
 
1387
class MustUseDecorated(Exception):
 
 
1389
    _fmt = "A decorating function has requested its original command be used."
 
 
1392
class NoBundleFound(BzrError):
 
 
1394
    _fmt = "No bundle was found in %(filename)s"
 
 
1396
    def __init__(self, filename):
 
 
1397
        BzrError.__init__(self)
 
 
1398
        self.filename = filename
 
 
1401
class BundleNotSupported(BzrError):
 
 
1403
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
 
1405
    def __init__(self, version, msg):
 
 
1406
        BzrError.__init__(self)
 
 
1407
        self.version = version
 
 
1411
class MissingText(BzrError):
 
 
1413
    _fmt = ("Branch %(base)s is missing revision"
 
 
1414
            " %(text_revision)s of %(file_id)s")
 
 
1416
    def __init__(self, branch, text_revision, file_id):
 
 
1417
        BzrError.__init__(self)
 
 
1418
        self.branch = branch
 
 
1419
        self.base = branch.base
 
 
1420
        self.text_revision = text_revision
 
 
1421
        self.file_id = file_id
 
 
1424
class DuplicateFileId(BzrError):
 
 
1426
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
 
1428
    def __init__(self, file_id, entry):
 
 
1429
        BzrError.__init__(self)
 
 
1430
        self.file_id = file_id
 
 
1434
class DuplicateKey(BzrError):
 
 
1436
    _fmt = "Key %(key)s is already present in map"
 
 
1439
class MalformedTransform(BzrError):
 
 
1441
    _fmt = "Tree transform is malformed %(conflicts)r"
 
 
1444
class NoFinalPath(BzrError):
 
 
1446
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
 
1447
            "file-id: %(file_id)r\n"
 
 
1448
            "root trans-id: %(root_trans_id)r\n")
 
 
1450
    def __init__(self, trans_id, transform):
 
 
1451
        self.trans_id = trans_id
 
 
1452
        self.file_id = transform.final_file_id(trans_id)
 
 
1453
        self.root_trans_id = transform.root
 
 
1456
class BzrBadParameter(BzrError):
 
 
1458
    _fmt = "Bad parameter: %(param)r"
 
 
1460
    # This exception should never be thrown, but it is a base class for all
 
 
1461
    # parameter-to-function errors.
 
 
1463
    def __init__(self, param):
 
 
1464
        BzrError.__init__(self)
 
 
1468
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1470
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
 
1473
class ReusingTransform(BzrError):
 
 
1475
    _fmt = "Attempt to reuse a transform that has already been applied."
 
 
1478
class CantMoveRoot(BzrError):
 
 
1480
    _fmt = "Moving the root directory is not supported at this time"
 
 
1483
class BzrMoveFailedError(BzrError):
 
 
1485
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1487
    def __init__(self, from_path='', to_path='', extra=None):
 
 
1488
        BzrError.__init__(self)
 
 
1490
            self.extra = ': ' + str(extra)
 
 
1494
        has_from = len(from_path) > 0
 
 
1495
        has_to = len(to_path) > 0
 
 
1497
            self.from_path = osutils.splitpath(from_path)[-1]
 
 
1502
            self.to_path = osutils.splitpath(to_path)[-1]
 
 
1507
        if has_from and has_to:
 
 
1508
            self.operator = " =>"
 
 
1510
            self.from_path = "from " + from_path
 
 
1512
            self.operator = "to"
 
 
1514
            self.operator = "file"
 
 
1517
class BzrRenameFailedError(BzrMoveFailedError):
 
 
1519
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1521
    def __init__(self, from_path, to_path, extra=None):
 
 
1522
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
 
1525
class BzrBadParameterNotString(BzrBadParameter):
 
 
1527
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
 
1530
class BzrBadParameterMissing(BzrBadParameter):
 
 
1532
    _fmt = "Parameter $(param)s is required but not present."
 
 
1535
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1537
    _fmt = ("Parameter %(param)s is unicode but"
 
 
1538
            " only byte-strings are permitted.")
 
 
1541
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1543
    _fmt = "Parameter %(param)s contains a newline."
 
 
1546
class DependencyNotPresent(BzrError):
 
 
1548
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
 
1550
    def __init__(self, library, error):
 
 
1551
        BzrError.__init__(self, library=library, error=error)
 
 
1554
class ParamikoNotPresent(DependencyNotPresent):
 
 
1556
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
 
1558
    def __init__(self, error):
 
 
1559
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1562
class PointlessMerge(BzrError):
 
 
1564
    _fmt = "Nothing to merge."
 
 
1567
class UninitializableFormat(BzrError):
 
 
1569
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
 
1571
    def __init__(self, format):
 
 
1572
        BzrError.__init__(self)
 
 
1573
        self.format = format
 
 
1576
class BadConversionTarget(BzrError):
 
 
1578
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
 
1580
    def __init__(self, problem, format):
 
 
1581
        BzrError.__init__(self)
 
 
1582
        self.problem = problem
 
 
1583
        self.format = format
 
 
1586
class NoDiff(BzrError):
 
 
1588
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
 
1590
    def __init__(self, msg):
 
 
1591
        BzrError.__init__(self, msg=msg)
 
 
1594
class NoDiff3(BzrError):
 
 
1596
    _fmt = "Diff3 is not installed on this machine."
 
 
1599
class ExistingLimbo(BzrError):
 
 
1601
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1602
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1603
    keep, and delete it when you are done."""
 
 
1605
    def __init__(self, limbo_dir):
 
 
1606
       BzrError.__init__(self)
 
 
1607
       self.limbo_dir = limbo_dir
 
 
1610
class ImmortalLimbo(BzrError):
 
 
1612
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
 
1613
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1614
    keep, and delete it when you are done."""
 
 
1616
    def __init__(self, limbo_dir):
 
 
1617
       BzrError.__init__(self)
 
 
1618
       self.limbo_dir = limbo_dir
 
 
1621
class OutOfDateTree(BzrError):
 
 
1623
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
 
1625
    def __init__(self, tree):
 
 
1626
        BzrError.__init__(self)
 
 
1630
class PublicBranchOutOfDate(BzrError):
 
 
1632
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
 
1635
    def __init__(self, public_location, revstring):
 
 
1636
        import bzrlib.urlutils as urlutils
 
 
1637
        public_location = urlutils.unescape_for_display(public_location,
 
 
1639
        BzrError.__init__(self, public_location=public_location,
 
 
1640
                          revstring=revstring)
 
 
1643
class MergeModifiedFormatError(BzrError):
 
 
1645
    _fmt = "Error in merge modified format"
 
 
1648
class ConflictFormatError(BzrError):
 
 
1650
    _fmt = "Format error in conflict listings"
 
 
1653
class CorruptRepository(BzrError):
 
 
1655
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
 
1656
            "Please run bzr reconcile on this repository.")
 
 
1658
    def __init__(self, repo):
 
 
1659
        BzrError.__init__(self)
 
 
1660
        self.repo_path = repo.bzrdir.root_transport.base
 
 
1663
class UpgradeRequired(BzrError):
 
 
1665
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
 
1667
    def __init__(self, path):
 
 
1668
        BzrError.__init__(self)
 
 
1672
class LocalRequiresBoundBranch(BzrError):
 
 
1674
    _fmt = "Cannot perform local-only commits on unbound branches."
 
 
1677
class MissingProgressBarFinish(BzrError):
 
 
1679
    _fmt = "A nested progress bar was not 'finished' correctly."
 
 
1682
class InvalidProgressBarType(BzrError):
 
 
1684
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
 
1685
            " is not a supported type Select one of: %(valid_types)s")
 
 
1687
    def __init__(self, bar_type, valid_types):
 
 
1688
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
1691
class UnsupportedOperation(BzrError):
 
 
1693
    _fmt = ("The method %(mname)s is not supported on"
 
 
1694
            " objects of type %(tname)s.")
 
 
1696
    def __init__(self, method, method_self):
 
 
1697
        self.method = method
 
 
1698
        self.mname = method.__name__
 
 
1699
        self.tname = type(method_self).__name__
 
 
1702
class CannotSetRevisionId(UnsupportedOperation):
 
 
1703
    """Raised when a commit is attempting to set a revision id but cant."""
 
 
1706
class NonAsciiRevisionId(UnsupportedOperation):
 
 
1707
    """Raised when a commit is attempting to set a non-ascii revision id
 
 
1712
class BinaryFile(BzrError):
 
 
1714
    _fmt = "File is binary but should be text."
 
 
1717
class IllegalPath(BzrError):
 
 
1719
    _fmt = "The path %(path)s is not permitted on this platform"
 
 
1721
    def __init__(self, path):
 
 
1722
        BzrError.__init__(self)
 
 
1726
class TestamentMismatch(BzrError):
 
 
1728
    _fmt = """Testament did not match expected value.
 
 
1729
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
 
1732
    def __init__(self, revision_id, expected, measured):
 
 
1733
        self.revision_id = revision_id
 
 
1734
        self.expected = expected
 
 
1735
        self.measured = measured
 
 
1738
class NotABundle(BzrError):
 
 
1740
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
 
1742
    def __init__(self, text):
 
 
1743
        BzrError.__init__(self)
 
 
1747
class BadBundle(BzrError): 
 
 
1749
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
 
1751
    def __init__(self, text):
 
 
1752
        BzrError.__init__(self)
 
 
1756
class MalformedHeader(BadBundle): 
 
 
1758
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
 
1761
class MalformedPatches(BadBundle): 
 
 
1763
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
 
1766
class MalformedFooter(BadBundle): 
 
 
1768
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
 
1771
class UnsupportedEOLMarker(BadBundle):
 
 
1773
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
 
1776
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
 
1777
        # but for this there is not
 
 
1778
        BzrError.__init__(self)
 
 
1781
class IncompatibleBundleFormat(BzrError):
 
 
1783
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
 
1785
    def __init__(self, bundle_format, other):
 
 
1786
        BzrError.__init__(self)
 
 
1787
        self.bundle_format = bundle_format
 
 
1791
class BadInventoryFormat(BzrError):
 
 
1793
    _fmt = "Root class for inventory serialization errors"
 
 
1796
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
1798
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
 
1800
    def __init__(self, msg):
 
 
1801
        BadInventoryFormat.__init__(self, msg=msg)
 
 
1804
class RootNotRich(BzrError):
 
 
1806
    _fmt = """This operation requires rich root data storage"""
 
 
1809
class NoSmartMedium(BzrError):
 
 
1811
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
 
1813
    internal_error = True
 
 
1815
    def __init__(self, transport):
 
 
1816
        self.transport = transport
 
 
1819
class NoSmartServer(NotBranchError):
 
 
1821
    _fmt = "No smart server available at %(url)s"
 
 
1823
    def __init__(self, url):
 
 
1827
class UnknownSSH(BzrError):
 
 
1829
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
 
1831
    def __init__(self, vendor):
 
 
1832
        BzrError.__init__(self)
 
 
1833
        self.vendor = vendor
 
 
1836
class SSHVendorNotFound(BzrError):
 
 
1838
    _fmt = ("Don't know how to handle SSH connections."
 
 
1839
            " Please set BZR_SSH environment variable.")
 
 
1842
class GhostRevisionUnusableHere(BzrError):
 
 
1844
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
 
1846
    def __init__(self, revision_id):
 
 
1847
        BzrError.__init__(self)
 
 
1848
        self.revision_id = revision_id
 
 
1851
class IllegalUseOfScopeReplacer(BzrError):
 
 
1853
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
 
1854
            " %(msg)s%(extra)s")
 
 
1856
    internal_error = True
 
 
1858
    def __init__(self, name, msg, extra=None):
 
 
1859
        BzrError.__init__(self)
 
 
1863
            self.extra = ': ' + str(extra)
 
 
1868
class InvalidImportLine(BzrError):
 
 
1870
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
 
1872
    internal_error = True
 
 
1874
    def __init__(self, text, msg):
 
 
1875
        BzrError.__init__(self)
 
 
1880
class ImportNameCollision(BzrError):
 
 
1882
    _fmt = ("Tried to import an object to the same name as"
 
 
1883
            " an existing object. %(name)s")
 
 
1885
    internal_error = True
 
 
1887
    def __init__(self, name):
 
 
1888
        BzrError.__init__(self)
 
 
1892
class NotAMergeDirective(BzrError):
 
 
1893
    """File starting with %(firstline)r is not a merge directive"""
 
 
1894
    def __init__(self, firstline):
 
 
1895
        BzrError.__init__(self, firstline=firstline)
 
 
1898
class NoMergeSource(BzrError):
 
 
1899
    """Raise if no merge source was specified for a merge directive"""
 
 
1901
    _fmt = "A merge directive must provide either a bundle or a public"\
 
 
1905
class PatchMissing(BzrError):
 
 
1906
    """Raise a patch type was specified but no patch supplied"""
 
 
1908
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
 
1910
    def __init__(self, patch_type):
 
 
1911
        BzrError.__init__(self)
 
 
1912
        self.patch_type = patch_type
 
 
1915
class UnsupportedInventoryKind(BzrError):
 
 
1917
    _fmt = """Unsupported entry kind %(kind)s"""
 
 
1919
    def __init__(self, kind):
 
 
1923
class BadSubsumeSource(BzrError):
 
 
1925
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
 
 
1927
    def __init__(self, tree, other_tree, reason):
 
 
1929
        self.other_tree = other_tree
 
 
1930
        self.reason = reason
 
 
1933
class SubsumeTargetNeedsUpgrade(BzrError):
 
 
1935
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
 
1937
    def __init__(self, other_tree):
 
 
1938
        self.other_tree = other_tree
 
 
1941
class BadReferenceTarget(BzrError):
 
 
1943
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
 
1945
    internal_error = True
 
 
1947
    def __init__(self, tree, other_tree, reason):
 
 
1949
        self.other_tree = other_tree
 
 
1950
        self.reason = reason
 
 
1953
class NoSuchTag(BzrError):
 
 
1955
    _fmt = "No such tag: %(tag_name)s"
 
 
1957
    def __init__(self, tag_name):
 
 
1958
        self.tag_name = tag_name
 
 
1961
class TagsNotSupported(BzrError):
 
 
1963
    _fmt = ("Tags not supported by %(branch)s;"
 
 
1964
            " you may be able to use bzr upgrade.")
 
 
1966
    def __init__(self, branch):
 
 
1967
        self.branch = branch
 
 
1970
class TagAlreadyExists(BzrError):
 
 
1972
    _fmt = "Tag %(tag_name)s already exists."
 
 
1974
    def __init__(self, tag_name):
 
 
1975
        self.tag_name = tag_name