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=%r' \
 
 
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): %r' \
 
 
158
                % (self.__class__.__name__,
 
 
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 DisabledMethod(BzrError):
 
 
180
    _fmt = "The smart server method '%(class_name)s' is disabled."
 
 
182
    internal_error = True
 
 
184
    def __init__(self, class_name):
 
 
185
        BzrError.__init__(self)
 
 
186
        self.class_name = class_name
 
 
189
class InvalidEntryName(BzrError):
 
 
191
    _fmt = "Invalid entry name: %(name)s"
 
 
193
    internal_error = True
 
 
195
    def __init__(self, name):
 
 
196
        BzrError.__init__(self)
 
 
200
class InvalidRevisionNumber(BzrError):
 
 
202
    _fmt = "Invalid revision number %(revno)s"
 
 
204
    def __init__(self, revno):
 
 
205
        BzrError.__init__(self)
 
 
209
class InvalidRevisionId(BzrError):
 
 
211
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
 
213
    def __init__(self, revision_id, branch):
 
 
214
        # branch can be any string or object with __str__ defined
 
 
215
        BzrError.__init__(self)
 
 
216
        self.revision_id = revision_id
 
 
219
class ReservedId(BzrError):
 
 
221
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
 
223
    def __init__(self, revision_id):
 
 
224
        self.revision_id = revision_id
 
 
227
class NoHelpTopic(BzrError):
 
 
229
    _fmt = ("No help could be found for '%(topic)s'. "
 
 
230
        "Please use 'bzr help topics' to obtain a list of topics.")
 
 
232
    def __init__(self, topic):
 
 
236
class NoSuchId(BzrError):
 
 
238
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
 
240
    def __init__(self, tree, file_id):
 
 
241
        BzrError.__init__(self)
 
 
242
        self.file_id = file_id
 
 
246
class InventoryModified(BzrError):
 
 
248
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
 
249
            " so a clean inventory cannot be read without data loss.")
 
 
251
    internal_error = True
 
 
253
    def __init__(self, tree):
 
 
257
class NoWorkingTree(BzrError):
 
 
259
    _fmt = "No WorkingTree exists for %(base)s."
 
 
261
    def __init__(self, base):
 
 
262
        BzrError.__init__(self)
 
 
266
class NotBuilding(BzrError):
 
 
268
    _fmt = "Not currently building a tree."
 
 
271
class NotLocalUrl(BzrError):
 
 
273
    _fmt = "%(url)s is not a local path."
 
 
275
    def __init__(self, url):
 
 
279
class WorkingTreeAlreadyPopulated(BzrError):
 
 
281
    _fmt = """Working tree already populated in %(base)s"""
 
 
283
    internal_error = True
 
 
285
    def __init__(self, base):
 
 
288
class BzrCommandError(BzrError):
 
 
289
    """Error from user command"""
 
 
291
    internal_error = False
 
 
293
    # Error from malformed user command; please avoid raising this as a
 
 
294
    # generic exception not caused by user input.
 
 
296
    # I think it's a waste of effort to differentiate between errors that
 
 
297
    # are not intended to be caught anyway.  UI code need not subclass
 
 
298
    # BzrCommandError, and non-UI code should not throw a subclass of
 
 
299
    # BzrCommandError.  ADHB 20051211
 
 
300
    def __init__(self, msg):
 
 
301
        # Object.__str__() must return a real string
 
 
302
        # returning a Unicode string is a python error.
 
 
303
        if isinstance(msg, unicode):
 
 
304
            self.msg = msg.encode('utf8')
 
 
312
class NotWriteLocked(BzrError):
 
 
314
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
 
316
    def __init__(self, not_locked):
 
 
317
        self.not_locked = not_locked
 
 
320
class BzrOptionError(BzrCommandError):
 
 
322
    _fmt = "Error in command line options"
 
 
325
class BadOptionValue(BzrError):
 
 
327
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
 
329
    def __init__(self, name, value):
 
 
330
        BzrError.__init__(self, name=name, value=value)
 
 
333
class StrictCommitFailed(BzrError):
 
 
335
    _fmt = "Commit refused because there are unknown files in the tree"
 
 
338
# XXX: Should be unified with TransportError; they seem to represent the
 
 
340
class PathError(BzrError):
 
 
342
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
 
344
    def __init__(self, path, extra=None):
 
 
345
        BzrError.__init__(self)
 
 
348
            self.extra = ': ' + str(extra)
 
 
353
class NoSuchFile(PathError):
 
 
355
    _fmt = "No such file: %(path)r%(extra)s"
 
 
358
class FileExists(PathError):
 
 
360
    _fmt = "File exists: %(path)r%(extra)s"
 
 
363
class RenameFailedFilesExist(BzrError):
 
 
364
    """Used when renaming and both source and dest exist."""
 
 
366
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
 
369
    def __init__(self, source, dest, extra=None):
 
 
370
        BzrError.__init__(self)
 
 
371
        self.source = str(source)
 
 
372
        self.dest = str(dest)
 
 
374
            self.extra = ' ' + str(extra)
 
 
379
class NotADirectory(PathError):
 
 
381
    _fmt = "%(path)r is not a directory %(extra)s"
 
 
384
class NotInWorkingDirectory(PathError):
 
 
386
    _fmt = "%(path)r is not in the working directory %(extra)s"
 
 
389
class DirectoryNotEmpty(PathError):
 
 
391
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
 
394
class ReadingCompleted(BzrError):
 
 
396
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
 
397
            "called upon it - the request has been completed and no more "
 
 
400
    internal_error = True
 
 
402
    def __init__(self, request):
 
 
403
        self.request = request
 
 
406
class ResourceBusy(PathError):
 
 
408
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
 
411
class PermissionDenied(PathError):
 
 
413
    _fmt = "Permission denied: %(path)r%(extra)s"
 
 
416
class InvalidURL(PathError):
 
 
418
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
 
421
class InvalidURLJoin(PathError):
 
 
423
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
 
425
    def __init__(self, msg, base, args):
 
 
426
        PathError.__init__(self, base, msg)
 
 
427
        self.args = [base] + list(args)
 
 
430
class UnknownHook(BzrError):
 
 
432
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
 
434
    def __init__(self, hook_type, hook_name):
 
 
435
        BzrError.__init__(self)
 
 
436
        self.type = hook_type
 
 
437
        self.hook = hook_name
 
 
440
class UnsupportedProtocol(PathError):
 
 
442
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
 
444
    def __init__(self, url, extra):
 
 
445
        PathError.__init__(self, url, extra=extra)
 
 
448
class ShortReadvError(PathError):
 
 
450
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
 
 
451
            " at %(offset)s for %(path)s%(extra)s")
 
 
453
    internal_error = True
 
 
455
    def __init__(self, path, offset, length, actual, extra=None):
 
 
456
        PathError.__init__(self, path, extra=extra)
 
 
462
class PathNotChild(BzrError):
 
 
464
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
 
466
    internal_error = True
 
 
468
    def __init__(self, path, base, extra=None):
 
 
469
        BzrError.__init__(self)
 
 
473
            self.extra = ': ' + str(extra)
 
 
478
class InvalidNormalization(PathError):
 
 
480
    _fmt = "Path %(path)r is not unicode normalized"
 
 
483
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
484
# the exception object is a bit undesirable.
 
 
485
# TODO: Probably this behavior of should be a common superclass 
 
 
486
class NotBranchError(PathError):
 
 
488
    _fmt = "Not a branch: %(path)s"
 
 
490
    def __init__(self, path):
 
 
491
       import bzrlib.urlutils as urlutils
 
 
492
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
495
class NoSubmitBranch(PathError):
 
 
497
    _fmt = 'No submit branch available for branch "%(path)s"'
 
 
499
    def __init__(self, branch):
 
 
500
       import bzrlib.urlutils as urlutils
 
 
501
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
 
504
class AlreadyBranchError(PathError):
 
 
506
    _fmt = "Already a branch: %(path)s."
 
 
509
class BranchExistsWithoutWorkingTree(PathError):
 
 
511
    _fmt = "Directory contains a branch, but no working tree \
 
 
512
(use bzr checkout if you wish to build a working tree): %(path)s"
 
 
515
class AtomicFileAlreadyClosed(PathError):
 
 
517
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
 
520
    def __init__(self, path, function):
 
 
521
        PathError.__init__(self, path=path, extra=None)
 
 
522
        self.function = function
 
 
525
class InaccessibleParent(PathError):
 
 
527
    _fmt = ("Parent not accessible given base %(base)s and"
 
 
528
            " relative path %(path)s")
 
 
530
    def __init__(self, path, base):
 
 
531
        PathError.__init__(self, path)
 
 
535
class NoRepositoryPresent(BzrError):
 
 
537
    _fmt = "No repository present: %(path)r"
 
 
538
    def __init__(self, bzrdir):
 
 
539
        BzrError.__init__(self)
 
 
540
        self.path = bzrdir.transport.clone('..').base
 
 
543
class FileInWrongBranch(BzrError):
 
 
545
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
 
547
    def __init__(self, branch, path):
 
 
548
        BzrError.__init__(self)
 
 
550
        self.branch_base = branch.base
 
 
554
class UnsupportedFormatError(BzrError):
 
 
556
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
 
 
559
class UnknownFormatError(BzrError):
 
 
561
    _fmt = "Unknown branch format: %(format)r"
 
 
564
class IncompatibleFormat(BzrError):
 
 
566
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
 
568
    def __init__(self, format, bzrdir_format):
 
 
569
        BzrError.__init__(self)
 
 
571
        self.bzrdir = bzrdir_format
 
 
574
class IncompatibleRepositories(BzrError):
 
 
576
    _fmt = "Repository %(target)s is not compatible with repository"\
 
 
579
    def __init__(self, source, target):
 
 
580
        BzrError.__init__(self, target=target, source=source)
 
 
583
class IncompatibleRevision(BzrError):
 
 
585
    _fmt = "Revision is not compatible with %(repo_format)s"
 
 
587
    def __init__(self, repo_format):
 
 
588
        BzrError.__init__(self)
 
 
589
        self.repo_format = repo_format
 
 
592
class AlreadyVersionedError(BzrError):
 
 
593
    """Used when a path is expected not to be versioned, but it is."""
 
 
595
    _fmt = "%(context_info)s%(path)s is already versioned"
 
 
597
    def __init__(self, path, context_info=None):
 
 
598
        """Construct a new AlreadyVersionedError.
 
 
600
        :param path: This is the path which is versioned,
 
 
601
        which should be in a user friendly form.
 
 
602
        :param context_info: If given, this is information about the context,
 
 
603
        which could explain why this is expected to not be versioned.
 
 
605
        BzrError.__init__(self)
 
 
607
        if context_info is None:
 
 
608
            self.context_info = ''
 
 
610
            self.context_info = context_info + ". "
 
 
613
class NotVersionedError(BzrError):
 
 
614
    """Used when a path is expected to be versioned, but it is not."""
 
 
616
    _fmt = "%(context_info)s%(path)s is not versioned"
 
 
618
    def __init__(self, path, context_info=None):
 
 
619
        """Construct a new NotVersionedError.
 
 
621
        :param path: This is the path which is not versioned,
 
 
622
        which should be in a user friendly form.
 
 
623
        :param context_info: If given, this is information about the context,
 
 
624
        which could explain why this is expected to be versioned.
 
 
626
        BzrError.__init__(self)
 
 
628
        if context_info is None:
 
 
629
            self.context_info = ''
 
 
631
            self.context_info = context_info + ". "
 
 
634
class PathsNotVersionedError(BzrError):
 
 
635
    """Used when reporting several paths which are not versioned"""
 
 
637
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
 
639
    def __init__(self, paths):
 
 
640
        from bzrlib.osutils import quotefn
 
 
641
        BzrError.__init__(self)
 
 
643
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
646
class PathsDoNotExist(BzrError):
 
 
648
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
 
650
    # used when reporting that paths are neither versioned nor in the working
 
 
653
    def __init__(self, paths, extra=None):
 
 
655
        from bzrlib.osutils import quotefn
 
 
656
        BzrError.__init__(self)
 
 
658
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
660
            self.extra = ': ' + str(extra)
 
 
665
class BadFileKindError(BzrError):
 
 
667
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
 
669
    def __init__(self, filename, kind):
 
 
670
        BzrError.__init__(self, filename=filename, kind=kind)
 
 
673
class ForbiddenControlFileError(BzrError):
 
 
675
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
 
678
class LockError(BzrError):
 
 
680
    _fmt = "Lock error: %(msg)s"
 
 
682
    internal_error = True
 
 
684
    # All exceptions from the lock/unlock functions should be from
 
 
685
    # this exception class.  They will be translated as necessary. The
 
 
686
    # original exception is available as e.original_error
 
 
688
    # New code should prefer to raise specific subclasses
 
 
689
    def __init__(self, message):
 
 
690
        # Python 2.5 uses a slot for StandardError.message,
 
 
691
        # so use a different variable name
 
 
692
        # so it is exposed in self.__dict__
 
 
696
class LockActive(LockError):
 
 
698
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
 
700
    internal_error = False
 
 
702
    def __init__(self, lock_description):
 
 
703
        self.lock_description = lock_description
 
 
706
class CommitNotPossible(LockError):
 
 
708
    _fmt = "A commit was attempted but we do not have a write lock open."
 
 
714
class AlreadyCommitted(LockError):
 
 
716
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
 
722
class ReadOnlyError(LockError):
 
 
724
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
 
726
    # TODO: There should also be an error indicating that you need a write
 
 
727
    # lock and don't have any lock at all... mbp 20070226
 
 
729
    def __init__(self, obj):
 
 
733
class ReadOnlyLockError(LockError):
 
 
735
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
 
737
    def __init__(self, fname, msg):
 
 
738
        LockError.__init__(self, '')
 
 
743
class OutSideTransaction(BzrError):
 
 
745
    _fmt = ("A transaction related operation was attempted after"
 
 
746
            " the transaction finished.")
 
 
749
class ObjectNotLocked(LockError):
 
 
751
    _fmt = "%(obj)r is not locked"
 
 
753
    # this can indicate that any particular object is not locked; see also
 
 
754
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
755
    # the caller -- perhaps they should be unified.
 
 
756
    def __init__(self, obj):
 
 
760
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
762
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
 
764
    def __init__(self, obj):
 
 
768
class UnlockableTransport(LockError):
 
 
770
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
 
772
    def __init__(self, transport):
 
 
773
        self.transport = transport
 
 
776
class LockContention(LockError):
 
 
778
    _fmt = "Could not acquire lock %(lock)s"
 
 
779
    # TODO: show full url for lock, combining the transport and relative
 
 
782
    internal_error = False
 
 
784
    def __init__(self, lock):
 
 
788
class LockBroken(LockError):
 
 
790
    _fmt = ("Lock was broken while still open: %(lock)s"
 
 
791
            " - check storage consistency!")
 
 
793
    internal_error = False
 
 
795
    def __init__(self, lock):
 
 
799
class LockBreakMismatch(LockError):
 
 
801
    _fmt = ("Lock was released and re-acquired before being broken:"
 
 
802
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
 
804
    internal_error = False
 
 
806
    def __init__(self, lock, holder, target):
 
 
812
class LockNotHeld(LockError):
 
 
814
    _fmt = "Lock not held: %(lock)s"
 
 
816
    internal_error = False
 
 
818
    def __init__(self, lock):
 
 
822
class TokenLockingNotSupported(LockError):
 
 
824
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
 
826
    internal_error = True
 
 
828
    def __init__(self, obj):
 
 
832
class TokenMismatch(LockBroken):
 
 
834
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
 
836
    internal_error = True
 
 
838
    def __init__(self, given_token, lock_token):
 
 
839
        self.given_token = given_token
 
 
840
        self.lock_token = lock_token
 
 
843
class PointlessCommit(BzrError):
 
 
845
    _fmt = "No changes to commit"
 
 
848
class UpgradeReadonly(BzrError):
 
 
850
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
 
853
class UpToDateFormat(BzrError):
 
 
855
    _fmt = "The branch format %(format)s is already at the most recent format."
 
 
857
    def __init__(self, format):
 
 
858
        BzrError.__init__(self)
 
 
862
class StrictCommitFailed(Exception):
 
 
864
    _fmt = "Commit refused because there are unknowns in the tree."
 
 
867
class NoSuchRevision(BzrError):
 
 
869
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
 
871
    internal_error = True
 
 
873
    def __init__(self, branch, revision):
 
 
874
        BzrError.__init__(self, branch=branch, revision=revision)
 
 
877
class NotLeftParentDescendant(BzrError):
 
 
879
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
 
880
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
 
882
    internal_error = True
 
 
884
    def __init__(self, branch, old_revision, new_revision):
 
 
885
        BzrError.__init__(self, branch_location=branch.base,
 
 
886
                          old_revision=old_revision,
 
 
887
                          new_revision=new_revision)
 
 
890
class NoSuchRevisionSpec(BzrError):
 
 
892
    _fmt = "No namespace registered for string: %(spec)r"
 
 
894
    def __init__(self, spec):
 
 
895
        BzrError.__init__(self, spec=spec)
 
 
898
class NoSuchRevisionInTree(NoSuchRevision):
 
 
899
    """When using Tree.revision_tree, and the revision is not accessible."""
 
 
901
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
 
 
903
    def __init__(self, tree, revision_id):
 
 
904
        BzrError.__init__(self)
 
 
906
        self.revision_id = revision_id
 
 
909
class InvalidRevisionSpec(BzrError):
 
 
911
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
 
912
            " %(branch)s%(extra)s")
 
 
914
    def __init__(self, spec, branch, extra=None):
 
 
915
        BzrError.__init__(self, branch=branch, spec=spec)
 
 
917
            self.extra = '\n' + str(extra)
 
 
922
class HistoryMissing(BzrError):
 
 
924
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
 
927
class AppendRevisionsOnlyViolation(BzrError):
 
 
929
    _fmt = ('Operation denied because it would change the main history,'
 
 
930
           ' which is not permitted by the append_revisions_only setting on'
 
 
931
           ' branch "%(location)s".')
 
 
933
    def __init__(self, location):
 
 
934
       import bzrlib.urlutils as urlutils
 
 
935
       location = urlutils.unescape_for_display(location, 'ascii')
 
 
936
       BzrError.__init__(self, location=location)
 
 
939
class DivergedBranches(BzrError):
 
 
941
    _fmt = ("These branches have diverged."
 
 
942
            " Use the merge command to reconcile them.")
 
 
944
    internal_error = False
 
 
946
    def __init__(self, branch1, branch2):
 
 
947
        self.branch1 = branch1
 
 
948
        self.branch2 = branch2
 
 
951
class NotLefthandHistory(BzrError):
 
 
953
    _fmt = "Supplied history does not follow left-hand parents"
 
 
955
    internal_error = True
 
 
957
    def __init__(self, history):
 
 
958
        BzrError.__init__(self, history=history)
 
 
961
class UnrelatedBranches(BzrError):
 
 
963
    _fmt = ("Branches have no common ancestor, and"
 
 
964
            " no merge base revision was specified.")
 
 
966
    internal_error = False
 
 
969
class NoCommonAncestor(BzrError):
 
 
971
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
973
    def __init__(self, revision_a, revision_b):
 
 
974
        self.revision_a = revision_a
 
 
975
        self.revision_b = revision_b
 
 
978
class NoCommonRoot(BzrError):
 
 
980
    _fmt = ("Revisions are not derived from the same root: "
 
 
981
           "%(revision_a)s %(revision_b)s.")
 
 
983
    def __init__(self, revision_a, revision_b):
 
 
984
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
 
987
class NotAncestor(BzrError):
 
 
989
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
 
991
    def __init__(self, rev_id, not_ancestor_id):
 
 
992
        BzrError.__init__(self, rev_id=rev_id,
 
 
993
            not_ancestor_id=not_ancestor_id)
 
 
996
class InstallFailed(BzrError):
 
 
998
    def __init__(self, revisions):
 
 
999
        revision_str = ", ".join(str(r) for r in revisions)
 
 
1000
        msg = "Could not install revisions:\n%s" % revision_str
 
 
1001
        BzrError.__init__(self, msg)
 
 
1002
        self.revisions = revisions
 
 
1005
class AmbiguousBase(BzrError):
 
 
1007
    def __init__(self, bases):
 
 
1008
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
1010
        msg = ("The correct base is unclear, because %s are all equally close"
 
 
1012
        BzrError.__init__(self, msg)
 
 
1016
class NoCommits(BzrError):
 
 
1018
    _fmt = "Branch %(branch)s has no commits."
 
 
1020
    def __init__(self, branch):
 
 
1021
        BzrError.__init__(self, branch=branch)
 
 
1024
class UnlistableStore(BzrError):
 
 
1026
    def __init__(self, store):
 
 
1027
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
1031
class UnlistableBranch(BzrError):
 
 
1033
    def __init__(self, br):
 
 
1034
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
1037
class BoundBranchOutOfDate(BzrError):
 
 
1039
    _fmt = ("Bound branch %(branch)s is out of date"
 
 
1040
            " with master branch %(master)s.")
 
 
1042
    def __init__(self, branch, master):
 
 
1043
        BzrError.__init__(self)
 
 
1044
        self.branch = branch
 
 
1045
        self.master = master
 
 
1048
class CommitToDoubleBoundBranch(BzrError):
 
 
1050
    _fmt = ("Cannot commit to branch %(branch)s."
 
 
1051
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
 
1053
    def __init__(self, branch, master, remote):
 
 
1054
        BzrError.__init__(self)
 
 
1055
        self.branch = branch
 
 
1056
        self.master = master
 
 
1057
        self.remote = remote
 
 
1060
class OverwriteBoundBranch(BzrError):
 
 
1062
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
 
1064
    def __init__(self, branch):
 
 
1065
        BzrError.__init__(self)
 
 
1066
        self.branch = branch
 
 
1069
class BoundBranchConnectionFailure(BzrError):
 
 
1071
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
 
1072
            " => %(target)s: %(error)s")
 
 
1074
    def __init__(self, branch, target, error):
 
 
1075
        BzrError.__init__(self)
 
 
1076
        self.branch = branch
 
 
1077
        self.target = target
 
 
1081
class WeaveError(BzrError):
 
 
1083
    _fmt = "Error in processing weave: %(message)s"
 
 
1085
    def __init__(self, message=None):
 
 
1086
        BzrError.__init__(self)
 
 
1087
        self.message = message
 
 
1090
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
1092
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
 
1094
    def __init__(self, revision_id, weave):
 
 
1096
        WeaveError.__init__(self)
 
 
1097
        self.revision_id = revision_id
 
 
1101
class WeaveRevisionNotPresent(WeaveError):
 
 
1103
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
 
1105
    def __init__(self, revision_id, weave):
 
 
1106
        WeaveError.__init__(self)
 
 
1107
        self.revision_id = revision_id
 
 
1111
class WeaveFormatError(WeaveError):
 
 
1113
    _fmt = "Weave invariant violated: %(what)s"
 
 
1115
    def __init__(self, what):
 
 
1116
        WeaveError.__init__(self)
 
 
1120
class WeaveParentMismatch(WeaveError):
 
 
1122
    _fmt = "Parents are mismatched between two revisions."
 
 
1125
class WeaveInvalidChecksum(WeaveError):
 
 
1127
    _fmt = "Text did not match it's checksum: %(message)s"
 
 
1130
class WeaveTextDiffers(WeaveError):
 
 
1132
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1133
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1135
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1136
        WeaveError.__init__(self)
 
 
1137
        self.revision_id = revision_id
 
 
1138
        self.weave_a = weave_a
 
 
1139
        self.weave_b = weave_b
 
 
1142
class WeaveTextDiffers(WeaveError):
 
 
1144
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1145
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1147
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1148
        WeaveError.__init__(self)
 
 
1149
        self.revision_id = revision_id
 
 
1150
        self.weave_a = weave_a
 
 
1151
        self.weave_b = weave_b
 
 
1154
class VersionedFileError(BzrError):
 
 
1156
    _fmt = "Versioned file error"
 
 
1159
class RevisionNotPresent(VersionedFileError):
 
 
1161
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
 
1163
    def __init__(self, revision_id, file_id):
 
 
1164
        VersionedFileError.__init__(self)
 
 
1165
        self.revision_id = revision_id
 
 
1166
        self.file_id = file_id
 
 
1169
class RevisionAlreadyPresent(VersionedFileError):
 
 
1171
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
 
1173
    def __init__(self, revision_id, file_id):
 
 
1174
        VersionedFileError.__init__(self)
 
 
1175
        self.revision_id = revision_id
 
 
1176
        self.file_id = file_id
 
 
1179
class KnitError(BzrError):
 
 
1183
    internal_error = True
 
 
1186
class KnitHeaderError(KnitError):
 
 
1188
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
 
1190
    def __init__(self, badline, filename):
 
 
1191
        KnitError.__init__(self)
 
 
1192
        self.badline = badline
 
 
1193
        self.filename = filename
 
 
1196
class KnitCorrupt(KnitError):
 
 
1198
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
 
1200
    def __init__(self, filename, how):
 
 
1201
        KnitError.__init__(self)
 
 
1202
        self.filename = filename
 
 
1206
class KnitIndexUnknownMethod(KnitError):
 
 
1207
    """Raised when we don't understand the storage method.
 
 
1209
    Currently only 'fulltext' and 'line-delta' are supported.
 
 
1212
    _fmt = ("Knit index %(filename)s does not have a known method"
 
 
1213
            " in options: %(options)r")
 
 
1215
    def __init__(self, filename, options):
 
 
1216
        KnitError.__init__(self)
 
 
1217
        self.filename = filename
 
 
1218
        self.options = options
 
 
1221
class NoSuchExportFormat(BzrError):
 
 
1223
    _fmt = "Export format %(format)r not supported"
 
 
1225
    def __init__(self, format):
 
 
1226
        BzrError.__init__(self)
 
 
1227
        self.format = format
 
 
1230
class TransportError(BzrError):
 
 
1232
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
 
1234
    def __init__(self, msg=None, orig_error=None):
 
 
1235
        if msg is None and orig_error is not None:
 
 
1236
            msg = str(orig_error)
 
 
1237
        if orig_error is None:
 
 
1242
        self.orig_error = orig_error
 
 
1243
        BzrError.__init__(self)
 
 
1246
class TooManyConcurrentRequests(BzrError):
 
 
1248
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
 
1249
            " Be sure to finish_writing and finish_reading on the"
 
 
1250
            " currently open request.")
 
 
1252
    internal_error = True
 
 
1254
    def __init__(self, medium):
 
 
1255
        self.medium = medium
 
 
1258
class SmartProtocolError(TransportError):
 
 
1260
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
 
1262
    def __init__(self, details):
 
 
1263
        self.details = details
 
 
1266
# A set of semi-meaningful errors which can be thrown
 
 
1267
class TransportNotPossible(TransportError):
 
 
1269
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
 
1272
class ConnectionError(TransportError):
 
 
1274
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
 
1277
class SocketConnectionError(ConnectionError):
 
 
1279
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
 
1281
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
1283
            msg = 'Failed to connect to'
 
 
1284
        if orig_error is None:
 
 
1287
            orig_error = '; ' + str(orig_error)
 
 
1288
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
1293
            self.port = ':%s' % port
 
 
1296
class ConnectionReset(TransportError):
 
 
1298
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
 
1301
class InvalidRange(TransportError):
 
 
1303
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
 
1305
    def __init__(self, path, offset):
 
 
1306
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
 
1309
        self.offset = offset
 
 
1312
class InvalidHttpResponse(TransportError):
 
 
1314
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
 
1316
    def __init__(self, path, msg, orig_error=None):
 
 
1318
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
1321
class InvalidHttpRange(InvalidHttpResponse):
 
 
1323
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
 
1325
    def __init__(self, path, range, msg):
 
 
1327
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1330
class InvalidHttpContentType(InvalidHttpResponse):
 
 
1332
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
 
1334
    def __init__(self, path, ctype, msg):
 
 
1336
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1339
class RedirectRequested(TransportError):
 
 
1341
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
 
1343
    def __init__(self, source, target, is_permament=False, qual_proto=None):
 
 
1344
        self.source = source
 
 
1345
        self.target = target
 
 
1347
            self.permanently = ' permanently'
 
 
1349
            self.permanently = ''
 
 
1350
        self.is_permament = is_permament
 
 
1351
        self._qualified_proto = qual_proto
 
 
1352
        TransportError.__init__(self)
 
 
1354
    def _requalify_url(self, url):
 
 
1355
        """Restore the qualified proto in front of the url"""
 
 
1356
        # When this exception is raised, source and target are in
 
 
1357
        # user readable format. But some transports may use a
 
 
1358
        # different proto (http+urllib:// will present http:// to
 
 
1359
        # the user. If a qualified proto is specified, the code
 
 
1360
        # trapping the exception can get the qualified urls to
 
 
1361
        # properly handle the redirection themself (creating a
 
 
1362
        # new transport object from the target url for example).
 
 
1363
        # But checking that the scheme of the original and
 
 
1364
        # redirected urls are the same can be tricky. (see the
 
 
1365
        # FIXME in BzrDir.open_from_transport for the unique use
 
 
1367
        if self._qualified_proto is None:
 
 
1370
        # The TODO related to NotBranchError mention that doing
 
 
1371
        # that kind of manipulation on the urls may not be the
 
 
1372
        # exception object job. On the other hand, this object is
 
 
1373
        # the interface between the code and the user so
 
 
1374
        # presenting the urls in different ways is indeed its
 
 
1377
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
 
1378
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
 
1381
    def get_source_url(self):
 
 
1382
        return self._requalify_url(self.source)
 
 
1384
    def get_target_url(self):
 
 
1385
        return self._requalify_url(self.target)
 
 
1388
class TooManyRedirections(TransportError):
 
 
1390
    _fmt = "Too many redirections"
 
 
1392
class ConflictsInTree(BzrError):
 
 
1394
    _fmt = "Working tree has conflicts."
 
 
1397
class ParseConfigError(BzrError):
 
 
1399
    def __init__(self, errors, filename):
 
 
1400
        if filename is None:
 
 
1402
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
1403
            (filename, ('\n'.join(e.message for e in errors)))
 
 
1404
        BzrError.__init__(self, message)
 
 
1407
class NoEmailInUsername(BzrError):
 
 
1409
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
 
1411
    def __init__(self, username):
 
 
1412
        BzrError.__init__(self)
 
 
1413
        self.username = username
 
 
1416
class SigningFailed(BzrError):
 
 
1418
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
 
1420
    def __init__(self, command_line):
 
 
1421
        BzrError.__init__(self, command_line=command_line)
 
 
1424
class WorkingTreeNotRevision(BzrError):
 
 
1426
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
 
1427
            " the last commit, but weave merge requires that it be"
 
 
1430
    def __init__(self, tree):
 
 
1431
        BzrError.__init__(self, basedir=tree.basedir)
 
 
1434
class CantReprocessAndShowBase(BzrError):
 
 
1436
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
 
1437
           "the relationship of conflicting lines to the base")
 
 
1440
class GraphCycleError(BzrError):
 
 
1442
    _fmt = "Cycle in graph %(graph)r"
 
 
1444
    def __init__(self, graph):
 
 
1445
        BzrError.__init__(self)
 
 
1449
class WritingCompleted(BzrError):
 
 
1451
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
 
1452
            "called upon it - accept bytes may not be called anymore.")
 
 
1454
    internal_error = True
 
 
1456
    def __init__(self, request):
 
 
1457
        self.request = request
 
 
1460
class WritingNotComplete(BzrError):
 
 
1462
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
 
1463
            "called upon it - until the write phase is complete no "
 
 
1464
            "data may be read.")
 
 
1466
    internal_error = True
 
 
1468
    def __init__(self, request):
 
 
1469
        self.request = request
 
 
1472
class NotConflicted(BzrError):
 
 
1474
    _fmt = "File %(filename)s is not conflicted."
 
 
1476
    def __init__(self, filename):
 
 
1477
        BzrError.__init__(self)
 
 
1478
        self.filename = filename
 
 
1481
class MediumNotConnected(BzrError):
 
 
1483
    _fmt = """The medium '%(medium)s' is not connected."""
 
 
1485
    internal_error = True
 
 
1487
    def __init__(self, medium):
 
 
1488
        self.medium = medium
 
 
1491
class MustUseDecorated(Exception):
 
 
1493
    _fmt = "A decorating function has requested its original command be used."
 
 
1496
class NoBundleFound(BzrError):
 
 
1498
    _fmt = "No bundle was found in %(filename)s"
 
 
1500
    def __init__(self, filename):
 
 
1501
        BzrError.__init__(self)
 
 
1502
        self.filename = filename
 
 
1505
class BundleNotSupported(BzrError):
 
 
1507
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
 
1509
    def __init__(self, version, msg):
 
 
1510
        BzrError.__init__(self)
 
 
1511
        self.version = version
 
 
1515
class MissingText(BzrError):
 
 
1517
    _fmt = ("Branch %(base)s is missing revision"
 
 
1518
            " %(text_revision)s of %(file_id)s")
 
 
1520
    def __init__(self, branch, text_revision, file_id):
 
 
1521
        BzrError.__init__(self)
 
 
1522
        self.branch = branch
 
 
1523
        self.base = branch.base
 
 
1524
        self.text_revision = text_revision
 
 
1525
        self.file_id = file_id
 
 
1528
class DuplicateFileId(BzrError):
 
 
1530
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
 
1532
    def __init__(self, file_id, entry):
 
 
1533
        BzrError.__init__(self)
 
 
1534
        self.file_id = file_id
 
 
1538
class DuplicateKey(BzrError):
 
 
1540
    _fmt = "Key %(key)s is already present in map"
 
 
1543
class DuplicateHelpPrefix(BzrError):
 
 
1545
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
 
1547
    def __init__(self, prefix):
 
 
1548
        self.prefix = prefix
 
 
1551
class MalformedTransform(BzrError):
 
 
1553
    _fmt = "Tree transform is malformed %(conflicts)r"
 
 
1556
class NoFinalPath(BzrError):
 
 
1558
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
 
1559
            "file-id: %(file_id)r\n"
 
 
1560
            "root trans-id: %(root_trans_id)r\n")
 
 
1562
    def __init__(self, trans_id, transform):
 
 
1563
        self.trans_id = trans_id
 
 
1564
        self.file_id = transform.final_file_id(trans_id)
 
 
1565
        self.root_trans_id = transform.root
 
 
1568
class BzrBadParameter(BzrError):
 
 
1570
    _fmt = "Bad parameter: %(param)r"
 
 
1572
    # This exception should never be thrown, but it is a base class for all
 
 
1573
    # parameter-to-function errors.
 
 
1575
    def __init__(self, param):
 
 
1576
        BzrError.__init__(self)
 
 
1580
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1582
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
 
1585
class ReusingTransform(BzrError):
 
 
1587
    _fmt = "Attempt to reuse a transform that has already been applied."
 
 
1590
class CantMoveRoot(BzrError):
 
 
1592
    _fmt = "Moving the root directory is not supported at this time"
 
 
1595
class BzrMoveFailedError(BzrError):
 
 
1597
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1599
    def __init__(self, from_path='', to_path='', extra=None):
 
 
1600
        BzrError.__init__(self)
 
 
1602
            self.extra = ': ' + str(extra)
 
 
1606
        has_from = len(from_path) > 0
 
 
1607
        has_to = len(to_path) > 0
 
 
1609
            self.from_path = osutils.splitpath(from_path)[-1]
 
 
1614
            self.to_path = osutils.splitpath(to_path)[-1]
 
 
1619
        if has_from and has_to:
 
 
1620
            self.operator = " =>"
 
 
1622
            self.from_path = "from " + from_path
 
 
1624
            self.operator = "to"
 
 
1626
            self.operator = "file"
 
 
1629
class BzrRenameFailedError(BzrMoveFailedError):
 
 
1631
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1633
    def __init__(self, from_path, to_path, extra=None):
 
 
1634
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
 
1636
class BzrRemoveChangedFilesError(BzrError):
 
 
1637
    """Used when user is trying to remove changed files."""
 
 
1639
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
 
 
1640
        "Use --keep to not delete them, or --force to delete them regardless.")
 
 
1642
    def __init__(self, tree_delta):
 
 
1643
        BzrError.__init__(self)
 
 
1644
        self.changes_as_text = tree_delta.get_changes_as_text()
 
 
1645
        #self.paths_as_string = '\n'.join(changed_files)
 
 
1646
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
 
1649
class BzrBadParameterNotString(BzrBadParameter):
 
 
1651
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
 
1654
class BzrBadParameterMissing(BzrBadParameter):
 
 
1656
    _fmt = "Parameter $(param)s is required but not present."
 
 
1659
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1661
    _fmt = ("Parameter %(param)s is unicode but"
 
 
1662
            " only byte-strings are permitted.")
 
 
1665
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1667
    _fmt = "Parameter %(param)s contains a newline."
 
 
1670
class DependencyNotPresent(BzrError):
 
 
1672
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
 
1674
    def __init__(self, library, error):
 
 
1675
        BzrError.__init__(self, library=library, error=error)
 
 
1678
class ParamikoNotPresent(DependencyNotPresent):
 
 
1680
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
 
1682
    def __init__(self, error):
 
 
1683
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1686
class PointlessMerge(BzrError):
 
 
1688
    _fmt = "Nothing to merge."
 
 
1691
class UninitializableFormat(BzrError):
 
 
1693
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
 
1695
    def __init__(self, format):
 
 
1696
        BzrError.__init__(self)
 
 
1697
        self.format = format
 
 
1700
class BadConversionTarget(BzrError):
 
 
1702
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
 
1704
    def __init__(self, problem, format):
 
 
1705
        BzrError.__init__(self)
 
 
1706
        self.problem = problem
 
 
1707
        self.format = format
 
 
1710
class NoDiff(BzrError):
 
 
1712
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
 
1714
    def __init__(self, msg):
 
 
1715
        BzrError.__init__(self, msg=msg)
 
 
1718
class NoDiff3(BzrError):
 
 
1720
    _fmt = "Diff3 is not installed on this machine."
 
 
1723
class ExistingLimbo(BzrError):
 
 
1725
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1726
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1727
    keep, and delete it when you are done."""
 
 
1729
    def __init__(self, limbo_dir):
 
 
1730
       BzrError.__init__(self)
 
 
1731
       self.limbo_dir = limbo_dir
 
 
1734
class ImmortalLimbo(BzrError):
 
 
1736
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
 
1737
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1738
    keep, and delete it when you are done."""
 
 
1740
    def __init__(self, limbo_dir):
 
 
1741
       BzrError.__init__(self)
 
 
1742
       self.limbo_dir = limbo_dir
 
 
1745
class OutOfDateTree(BzrError):
 
 
1747
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
 
1749
    def __init__(self, tree):
 
 
1750
        BzrError.__init__(self)
 
 
1754
class PublicBranchOutOfDate(BzrError):
 
 
1756
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
 
1759
    def __init__(self, public_location, revstring):
 
 
1760
        import bzrlib.urlutils as urlutils
 
 
1761
        public_location = urlutils.unescape_for_display(public_location,
 
 
1763
        BzrError.__init__(self, public_location=public_location,
 
 
1764
                          revstring=revstring)
 
 
1767
class MergeModifiedFormatError(BzrError):
 
 
1769
    _fmt = "Error in merge modified format"
 
 
1772
class ConflictFormatError(BzrError):
 
 
1774
    _fmt = "Format error in conflict listings"
 
 
1777
class CorruptRepository(BzrError):
 
 
1779
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
 
1780
            "Please run bzr reconcile on this repository.")
 
 
1782
    def __init__(self, repo):
 
 
1783
        BzrError.__init__(self)
 
 
1784
        self.repo_path = repo.bzrdir.root_transport.base
 
 
1787
class UpgradeRequired(BzrError):
 
 
1789
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
 
1791
    def __init__(self, path):
 
 
1792
        BzrError.__init__(self)
 
 
1796
class LocalRequiresBoundBranch(BzrError):
 
 
1798
    _fmt = "Cannot perform local-only commits on unbound branches."
 
 
1801
class MissingProgressBarFinish(BzrError):
 
 
1803
    _fmt = "A nested progress bar was not 'finished' correctly."
 
 
1806
class InvalidProgressBarType(BzrError):
 
 
1808
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
 
1809
            " is not a supported type Select one of: %(valid_types)s")
 
 
1811
    def __init__(self, bar_type, valid_types):
 
 
1812
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
1815
class UnsupportedOperation(BzrError):
 
 
1817
    _fmt = ("The method %(mname)s is not supported on"
 
 
1818
            " objects of type %(tname)s.")
 
 
1820
    def __init__(self, method, method_self):
 
 
1821
        self.method = method
 
 
1822
        self.mname = method.__name__
 
 
1823
        self.tname = type(method_self).__name__
 
 
1826
class CannotSetRevisionId(UnsupportedOperation):
 
 
1827
    """Raised when a commit is attempting to set a revision id but cant."""
 
 
1830
class NonAsciiRevisionId(UnsupportedOperation):
 
 
1831
    """Raised when a commit is attempting to set a non-ascii revision id
 
 
1836
class BinaryFile(BzrError):
 
 
1838
    _fmt = "File is binary but should be text."
 
 
1841
class IllegalPath(BzrError):
 
 
1843
    _fmt = "The path %(path)s is not permitted on this platform"
 
 
1845
    def __init__(self, path):
 
 
1846
        BzrError.__init__(self)
 
 
1850
class TestamentMismatch(BzrError):
 
 
1852
    _fmt = """Testament did not match expected value.
 
 
1853
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
 
1856
    def __init__(self, revision_id, expected, measured):
 
 
1857
        self.revision_id = revision_id
 
 
1858
        self.expected = expected
 
 
1859
        self.measured = measured
 
 
1862
class NotABundle(BzrError):
 
 
1864
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
 
1866
    def __init__(self, text):
 
 
1867
        BzrError.__init__(self)
 
 
1871
class BadBundle(BzrError): 
 
 
1873
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
 
1875
    def __init__(self, text):
 
 
1876
        BzrError.__init__(self)
 
 
1880
class MalformedHeader(BadBundle): 
 
 
1882
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
 
1885
class MalformedPatches(BadBundle): 
 
 
1887
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
 
1890
class MalformedFooter(BadBundle): 
 
 
1892
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
 
1895
class UnsupportedEOLMarker(BadBundle):
 
 
1897
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
 
1900
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
 
1901
        # but for this there is not
 
 
1902
        BzrError.__init__(self)
 
 
1905
class IncompatibleBundleFormat(BzrError):
 
 
1907
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
 
1909
    def __init__(self, bundle_format, other):
 
 
1910
        BzrError.__init__(self)
 
 
1911
        self.bundle_format = bundle_format
 
 
1915
class BadInventoryFormat(BzrError):
 
 
1917
    _fmt = "Root class for inventory serialization errors"
 
 
1920
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
1922
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
 
1924
    def __init__(self, msg):
 
 
1925
        BadInventoryFormat.__init__(self, msg=msg)
 
 
1928
class RootNotRich(BzrError):
 
 
1930
    _fmt = """This operation requires rich root data storage"""
 
 
1933
class NoSmartMedium(BzrError):
 
 
1935
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
 
1937
    internal_error = True
 
 
1939
    def __init__(self, transport):
 
 
1940
        self.transport = transport
 
 
1943
class NoSmartServer(NotBranchError):
 
 
1945
    _fmt = "No smart server available at %(url)s"
 
 
1947
    def __init__(self, url):
 
 
1951
class UnknownSSH(BzrError):
 
 
1953
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
 
1955
    def __init__(self, vendor):
 
 
1956
        BzrError.__init__(self)
 
 
1957
        self.vendor = vendor
 
 
1960
class SSHVendorNotFound(BzrError):
 
 
1962
    _fmt = ("Don't know how to handle SSH connections."
 
 
1963
            " Please set BZR_SSH environment variable.")
 
 
1966
class GhostRevisionUnusableHere(BzrError):
 
 
1968
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
 
1970
    def __init__(self, revision_id):
 
 
1971
        BzrError.__init__(self)
 
 
1972
        self.revision_id = revision_id
 
 
1975
class IllegalUseOfScopeReplacer(BzrError):
 
 
1977
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
 
1978
            " %(msg)s%(extra)s")
 
 
1980
    internal_error = True
 
 
1982
    def __init__(self, name, msg, extra=None):
 
 
1983
        BzrError.__init__(self)
 
 
1987
            self.extra = ': ' + str(extra)
 
 
1992
class InvalidImportLine(BzrError):
 
 
1994
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
 
1996
    internal_error = True
 
 
1998
    def __init__(self, text, msg):
 
 
1999
        BzrError.__init__(self)
 
 
2004
class ImportNameCollision(BzrError):
 
 
2006
    _fmt = ("Tried to import an object to the same name as"
 
 
2007
            " an existing object. %(name)s")
 
 
2009
    internal_error = True
 
 
2011
    def __init__(self, name):
 
 
2012
        BzrError.__init__(self)
 
 
2016
class NotAMergeDirective(BzrError):
 
 
2017
    """File starting with %(firstline)r is not a merge directive"""
 
 
2018
    def __init__(self, firstline):
 
 
2019
        BzrError.__init__(self, firstline=firstline)
 
 
2022
class NoMergeSource(BzrError):
 
 
2023
    """Raise if no merge source was specified for a merge directive"""
 
 
2025
    _fmt = "A merge directive must provide either a bundle or a public"\
 
 
2029
class PatchMissing(BzrError):
 
 
2030
    """Raise a patch type was specified but no patch supplied"""
 
 
2032
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
 
2034
    def __init__(self, patch_type):
 
 
2035
        BzrError.__init__(self)
 
 
2036
        self.patch_type = patch_type
 
 
2039
class UnsupportedInventoryKind(BzrError):
 
 
2041
    _fmt = """Unsupported entry kind %(kind)s"""
 
 
2043
    def __init__(self, kind):
 
 
2047
class BadSubsumeSource(BzrError):
 
 
2049
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
 
 
2051
    def __init__(self, tree, other_tree, reason):
 
 
2053
        self.other_tree = other_tree
 
 
2054
        self.reason = reason
 
 
2057
class SubsumeTargetNeedsUpgrade(BzrError):
 
 
2059
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
 
2061
    def __init__(self, other_tree):
 
 
2062
        self.other_tree = other_tree
 
 
2065
class BadReferenceTarget(BzrError):
 
 
2067
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
 
2069
    internal_error = True
 
 
2071
    def __init__(self, tree, other_tree, reason):
 
 
2073
        self.other_tree = other_tree
 
 
2074
        self.reason = reason
 
 
2077
class NoSuchTag(BzrError):
 
 
2079
    _fmt = "No such tag: %(tag_name)s"
 
 
2081
    def __init__(self, tag_name):
 
 
2082
        self.tag_name = tag_name
 
 
2085
class TagsNotSupported(BzrError):
 
 
2087
    _fmt = ("Tags not supported by %(branch)s;"
 
 
2088
            " you may be able to use bzr upgrade --dirstate-tags.")
 
 
2090
    def __init__(self, branch):
 
 
2091
        self.branch = branch
 
 
2094
class TagAlreadyExists(BzrError):
 
 
2096
    _fmt = "Tag %(tag_name)s already exists."
 
 
2098
    def __init__(self, tag_name):
 
 
2099
        self.tag_name = tag_name
 
 
2102
class MalformedBugIdentifier(BzrError):
 
 
2104
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
 
2106
    def __init__(self, bug_id, reason):
 
 
2107
        self.bug_id = bug_id
 
 
2108
        self.reason = reason
 
 
2111
class UnknownBugTrackerAbbreviation(BzrError):
 
 
2113
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
 
2116
    def __init__(self, abbreviation, branch):
 
 
2117
        self.abbreviation = abbreviation
 
 
2118
        self.branch = branch
 
 
2121
class UnexpectedSmartServerResponse(BzrError):
 
 
2123
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
 
2125
    def __init__(self, response_tuple):
 
 
2126
        self.response_tuple = response_tuple