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 this was probably caused by a bzr bug and
 
 
52
    should be displayed with a traceback; if False (or absent) 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 IncompatibleAPI(BzrError):
 
 
191
    _fmt = 'The API for "%(api)s" is not compatible with "%(wanted)s". '\
 
 
192
        'It supports versions "%(minimum)s" to "%(current)s".'
 
 
194
    def __init__(self, api, wanted, minimum, current):
 
 
197
        self.minimum = minimum
 
 
198
        self.current = current
 
 
201
class InProcessTransport(BzrError):
 
 
203
    _fmt = "The transport '%(transport)s' is only accessible within this " \
 
 
206
    def __init__(self, transport):
 
 
207
        self.transport = transport
 
 
210
class InvalidEntryName(BzrError):
 
 
212
    _fmt = "Invalid entry name: %(name)s"
 
 
214
    internal_error = True
 
 
216
    def __init__(self, name):
 
 
217
        BzrError.__init__(self)
 
 
221
class InvalidRevisionNumber(BzrError):
 
 
223
    _fmt = "Invalid revision number %(revno)s"
 
 
225
    def __init__(self, revno):
 
 
226
        BzrError.__init__(self)
 
 
230
class InvalidRevisionId(BzrError):
 
 
232
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
 
234
    def __init__(self, revision_id, branch):
 
 
235
        # branch can be any string or object with __str__ defined
 
 
236
        BzrError.__init__(self)
 
 
237
        self.revision_id = revision_id
 
 
240
class ReservedId(BzrError):
 
 
242
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
 
244
    def __init__(self, revision_id):
 
 
245
        self.revision_id = revision_id
 
 
248
class NoHelpTopic(BzrError):
 
 
250
    _fmt = ("No help could be found for '%(topic)s'. "
 
 
251
        "Please use 'bzr help topics' to obtain a list of topics.")
 
 
253
    def __init__(self, topic):
 
 
257
class NoSuchId(BzrError):
 
 
259
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
 
261
    def __init__(self, tree, file_id):
 
 
262
        BzrError.__init__(self)
 
 
263
        self.file_id = file_id
 
 
267
class InventoryModified(BzrError):
 
 
269
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
 
270
            " so a clean inventory cannot be read without data loss.")
 
 
272
    internal_error = True
 
 
274
    def __init__(self, tree):
 
 
278
class NoWorkingTree(BzrError):
 
 
280
    _fmt = "No WorkingTree exists for %(base)s."
 
 
282
    def __init__(self, base):
 
 
283
        BzrError.__init__(self)
 
 
287
class NotBuilding(BzrError):
 
 
289
    _fmt = "Not currently building a tree."
 
 
292
class NotLocalUrl(BzrError):
 
 
294
    _fmt = "%(url)s is not a local path."
 
 
296
    def __init__(self, url):
 
 
300
class WorkingTreeAlreadyPopulated(BzrError):
 
 
302
    _fmt = """Working tree already populated in %(base)s"""
 
 
304
    internal_error = True
 
 
306
    def __init__(self, base):
 
 
309
class BzrCommandError(BzrError):
 
 
310
    """Error from user command"""
 
 
312
    internal_error = False
 
 
314
    # Error from malformed user command; please avoid raising this as a
 
 
315
    # generic exception not caused by user input.
 
 
317
    # I think it's a waste of effort to differentiate between errors that
 
 
318
    # are not intended to be caught anyway.  UI code need not subclass
 
 
319
    # BzrCommandError, and non-UI code should not throw a subclass of
 
 
320
    # BzrCommandError.  ADHB 20051211
 
 
321
    def __init__(self, msg):
 
 
322
        # Object.__str__() must return a real string
 
 
323
        # returning a Unicode string is a python error.
 
 
324
        if isinstance(msg, unicode):
 
 
325
            self.msg = msg.encode('utf8')
 
 
333
class NotWriteLocked(BzrError):
 
 
335
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
 
337
    def __init__(self, not_locked):
 
 
338
        self.not_locked = not_locked
 
 
341
class BzrOptionError(BzrCommandError):
 
 
343
    _fmt = "Error in command line options"
 
 
346
class BadIndexFormatSignature(BzrError):
 
 
348
    _fmt = "%(value)s is not an index of type %(_type)s."
 
 
350
    def __init__(self, value, _type):
 
 
351
        BzrError.__init__(self)
 
 
356
class BadIndexData(BzrError):
 
 
358
    _fmt = "Error in data for index %(value)s."
 
 
360
    def __init__(self, value):
 
 
361
        BzrError.__init__(self)
 
 
365
class BadIndexDuplicateKey(BzrError):
 
 
367
    _fmt = "The key '%(key)s' is already in index '%(index)s'."
 
 
369
    def __init__(self, key, index):
 
 
370
        BzrError.__init__(self)
 
 
375
class BadIndexKey(BzrError):
 
 
377
    _fmt = "The key '%(key)s' is not a valid key."
 
 
379
    def __init__(self, key):
 
 
380
        BzrError.__init__(self)
 
 
384
class BadIndexOptions(BzrError):
 
 
386
    _fmt = "Could not parse options for index %(value)s."
 
 
388
    def __init__(self, value):
 
 
389
        BzrError.__init__(self)
 
 
393
class BadIndexValue(BzrError):
 
 
395
    _fmt = "The value '%(value)s' is not a valid value."
 
 
397
    def __init__(self, value):
 
 
398
        BzrError.__init__(self)
 
 
402
class BadOptionValue(BzrError):
 
 
404
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
 
406
    def __init__(self, name, value):
 
 
407
        BzrError.__init__(self, name=name, value=value)
 
 
410
class StrictCommitFailed(BzrError):
 
 
412
    _fmt = "Commit refused because there are unknown files in the tree"
 
 
415
# XXX: Should be unified with TransportError; they seem to represent the
 
 
417
# RBC 20060929: I think that unifiying with TransportError would be a mistake
 
 
418
# - this is finer than a TransportError - and more useful as such. It 
 
 
419
# differentiates between 'transport has failed' and 'operation on a transport
 
 
421
class PathError(BzrError):
 
 
423
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
 
425
    def __init__(self, path, extra=None):
 
 
426
        BzrError.__init__(self)
 
 
429
            self.extra = ': ' + str(extra)
 
 
434
class NoSuchFile(PathError):
 
 
436
    _fmt = "No such file: %(path)r%(extra)s"
 
 
439
class FileExists(PathError):
 
 
441
    _fmt = "File exists: %(path)r%(extra)s"
 
 
444
class RenameFailedFilesExist(BzrError):
 
 
445
    """Used when renaming and both source and dest exist."""
 
 
447
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
 
450
    def __init__(self, source, dest, extra=None):
 
 
451
        BzrError.__init__(self)
 
 
452
        self.source = str(source)
 
 
453
        self.dest = str(dest)
 
 
455
            self.extra = ' ' + str(extra)
 
 
460
class NotADirectory(PathError):
 
 
462
    _fmt = "%(path)r is not a directory %(extra)s"
 
 
465
class NotInWorkingDirectory(PathError):
 
 
467
    _fmt = "%(path)r is not in the working directory %(extra)s"
 
 
470
class DirectoryNotEmpty(PathError):
 
 
472
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
 
475
class ReadingCompleted(BzrError):
 
 
477
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
 
478
            "called upon it - the request has been completed and no more "
 
 
481
    internal_error = True
 
 
483
    def __init__(self, request):
 
 
484
        self.request = request
 
 
487
class ResourceBusy(PathError):
 
 
489
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
 
492
class PermissionDenied(PathError):
 
 
494
    _fmt = "Permission denied: %(path)r%(extra)s"
 
 
497
class InvalidURL(PathError):
 
 
499
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
 
502
class InvalidURLJoin(PathError):
 
 
504
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
 
506
    def __init__(self, msg, base, args):
 
 
507
        PathError.__init__(self, base, msg)
 
 
508
        self.args = [base] + list(args)
 
 
511
class UnknownHook(BzrError):
 
 
513
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
 
515
    def __init__(self, hook_type, hook_name):
 
 
516
        BzrError.__init__(self)
 
 
517
        self.type = hook_type
 
 
518
        self.hook = hook_name
 
 
521
class UnsupportedProtocol(PathError):
 
 
523
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
 
525
    def __init__(self, url, extra):
 
 
526
        PathError.__init__(self, url, extra=extra)
 
 
529
class ReadError(PathError):
 
 
531
    _fmt = """Error reading from %(path)r."""
 
 
534
class ShortReadvError(PathError):
 
 
536
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
 
 
537
            " at %(offset)s for %(path)s%(extra)s")
 
 
539
    internal_error = True
 
 
541
    def __init__(self, path, offset, length, actual, extra=None):
 
 
542
        PathError.__init__(self, path, extra=extra)
 
 
548
class PathNotChild(PathError):
 
 
550
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
 
552
    internal_error = True
 
 
554
    def __init__(self, path, base, extra=None):
 
 
555
        BzrError.__init__(self)
 
 
559
            self.extra = ': ' + str(extra)
 
 
564
class InvalidNormalization(PathError):
 
 
566
    _fmt = "Path %(path)r is not unicode normalized"
 
 
569
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
570
# the exception object is a bit undesirable.
 
 
571
# TODO: Probably this behavior of should be a common superclass 
 
 
572
class NotBranchError(PathError):
 
 
574
    _fmt = "Not a branch: %(path)s"
 
 
576
    def __init__(self, path):
 
 
577
       import bzrlib.urlutils as urlutils
 
 
578
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
581
class NoSubmitBranch(PathError):
 
 
583
    _fmt = 'No submit branch available for branch "%(path)s"'
 
 
585
    def __init__(self, branch):
 
 
586
       import bzrlib.urlutils as urlutils
 
 
587
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
 
590
class AlreadyBranchError(PathError):
 
 
592
    _fmt = "Already a branch: %(path)s."
 
 
595
class BranchExistsWithoutWorkingTree(PathError):
 
 
597
    _fmt = "Directory contains a branch, but no working tree \
 
 
598
(use bzr checkout if you wish to build a working tree): %(path)s"
 
 
601
class AtomicFileAlreadyClosed(PathError):
 
 
603
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
 
606
    def __init__(self, path, function):
 
 
607
        PathError.__init__(self, path=path, extra=None)
 
 
608
        self.function = function
 
 
611
class InaccessibleParent(PathError):
 
 
613
    _fmt = ("Parent not accessible given base %(base)s and"
 
 
614
            " relative path %(path)s")
 
 
616
    def __init__(self, path, base):
 
 
617
        PathError.__init__(self, path)
 
 
621
class NoRepositoryPresent(BzrError):
 
 
623
    _fmt = "No repository present: %(path)r"
 
 
624
    def __init__(self, bzrdir):
 
 
625
        BzrError.__init__(self)
 
 
626
        self.path = bzrdir.transport.clone('..').base
 
 
629
class FileInWrongBranch(BzrError):
 
 
631
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
 
633
    def __init__(self, branch, path):
 
 
634
        BzrError.__init__(self)
 
 
636
        self.branch_base = branch.base
 
 
640
class UnsupportedFormatError(BzrError):
 
 
642
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
 
 
645
class UnknownFormatError(BzrError):
 
 
647
    _fmt = "Unknown branch format: %(format)r"
 
 
650
class IncompatibleFormat(BzrError):
 
 
652
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
 
654
    def __init__(self, format, bzrdir_format):
 
 
655
        BzrError.__init__(self)
 
 
657
        self.bzrdir = bzrdir_format
 
 
660
class IncompatibleRepositories(BzrError):
 
 
662
    _fmt = "Repository %(target)s is not compatible with repository"\
 
 
665
    def __init__(self, source, target):
 
 
666
        BzrError.__init__(self, target=target, source=source)
 
 
669
class IncompatibleRevision(BzrError):
 
 
671
    _fmt = "Revision is not compatible with %(repo_format)s"
 
 
673
    def __init__(self, repo_format):
 
 
674
        BzrError.__init__(self)
 
 
675
        self.repo_format = repo_format
 
 
678
class AlreadyVersionedError(BzrError):
 
 
679
    """Used when a path is expected not to be versioned, but it is."""
 
 
681
    _fmt = "%(context_info)s%(path)s is already versioned"
 
 
683
    def __init__(self, path, context_info=None):
 
 
684
        """Construct a new AlreadyVersionedError.
 
 
686
        :param path: This is the path which is versioned,
 
 
687
        which should be in a user friendly form.
 
 
688
        :param context_info: If given, this is information about the context,
 
 
689
        which could explain why this is expected to not be versioned.
 
 
691
        BzrError.__init__(self)
 
 
693
        if context_info is None:
 
 
694
            self.context_info = ''
 
 
696
            self.context_info = context_info + ". "
 
 
699
class NotVersionedError(BzrError):
 
 
700
    """Used when a path is expected to be versioned, but it is not."""
 
 
702
    _fmt = "%(context_info)s%(path)s is not versioned"
 
 
704
    def __init__(self, path, context_info=None):
 
 
705
        """Construct a new NotVersionedError.
 
 
707
        :param path: This is the path which is not versioned,
 
 
708
        which should be in a user friendly form.
 
 
709
        :param context_info: If given, this is information about the context,
 
 
710
        which could explain why this is expected to be versioned.
 
 
712
        BzrError.__init__(self)
 
 
714
        if context_info is None:
 
 
715
            self.context_info = ''
 
 
717
            self.context_info = context_info + ". "
 
 
720
class PathsNotVersionedError(BzrError):
 
 
721
    """Used when reporting several paths which are not versioned"""
 
 
723
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
 
725
    def __init__(self, paths):
 
 
726
        from bzrlib.osutils import quotefn
 
 
727
        BzrError.__init__(self)
 
 
729
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
732
class PathsDoNotExist(BzrError):
 
 
734
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
 
736
    # used when reporting that paths are neither versioned nor in the working
 
 
739
    def __init__(self, paths, extra=None):
 
 
741
        from bzrlib.osutils import quotefn
 
 
742
        BzrError.__init__(self)
 
 
744
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
746
            self.extra = ': ' + str(extra)
 
 
751
class BadFileKindError(BzrError):
 
 
753
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
 
755
    def __init__(self, filename, kind):
 
 
756
        BzrError.__init__(self, filename=filename, kind=kind)
 
 
759
class ForbiddenControlFileError(BzrError):
 
 
761
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
 
764
class LockError(BzrError):
 
 
766
    _fmt = "Lock error: %(msg)s"
 
 
768
    internal_error = True
 
 
770
    # All exceptions from the lock/unlock functions should be from
 
 
771
    # this exception class.  They will be translated as necessary. The
 
 
772
    # original exception is available as e.original_error
 
 
774
    # New code should prefer to raise specific subclasses
 
 
775
    def __init__(self, message):
 
 
776
        # Python 2.5 uses a slot for StandardError.message,
 
 
777
        # so use a different variable name
 
 
778
        # so it is exposed in self.__dict__
 
 
782
class LockActive(LockError):
 
 
784
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
 
786
    internal_error = False
 
 
788
    def __init__(self, lock_description):
 
 
789
        self.lock_description = lock_description
 
 
792
class CommitNotPossible(LockError):
 
 
794
    _fmt = "A commit was attempted but we do not have a write lock open."
 
 
800
class AlreadyCommitted(LockError):
 
 
802
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
 
808
class ReadOnlyError(LockError):
 
 
810
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
 
812
    # TODO: There should also be an error indicating that you need a write
 
 
813
    # lock and don't have any lock at all... mbp 20070226
 
 
815
    def __init__(self, obj):
 
 
819
class ReadOnlyLockError(LockError):
 
 
821
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
 
823
    def __init__(self, fname, msg):
 
 
824
        LockError.__init__(self, '')
 
 
829
class OutSideTransaction(BzrError):
 
 
831
    _fmt = ("A transaction related operation was attempted after"
 
 
832
            " the transaction finished.")
 
 
835
class ObjectNotLocked(LockError):
 
 
837
    _fmt = "%(obj)r is not locked"
 
 
839
    # this can indicate that any particular object is not locked; see also
 
 
840
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
841
    # the caller -- perhaps they should be unified.
 
 
842
    def __init__(self, obj):
 
 
846
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
848
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
 
850
    def __init__(self, obj):
 
 
854
class UnlockableTransport(LockError):
 
 
856
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
 
858
    def __init__(self, transport):
 
 
859
        self.transport = transport
 
 
862
class LockContention(LockError):
 
 
864
    _fmt = "Could not acquire lock %(lock)s"
 
 
865
    # TODO: show full url for lock, combining the transport and relative
 
 
868
    internal_error = False
 
 
870
    def __init__(self, lock):
 
 
874
class LockBroken(LockError):
 
 
876
    _fmt = ("Lock was broken while still open: %(lock)s"
 
 
877
            " - check storage consistency!")
 
 
879
    internal_error = False
 
 
881
    def __init__(self, lock):
 
 
885
class LockBreakMismatch(LockError):
 
 
887
    _fmt = ("Lock was released and re-acquired before being broken:"
 
 
888
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
 
890
    internal_error = False
 
 
892
    def __init__(self, lock, holder, target):
 
 
898
class LockNotHeld(LockError):
 
 
900
    _fmt = "Lock not held: %(lock)s"
 
 
902
    internal_error = False
 
 
904
    def __init__(self, lock):
 
 
908
class TokenLockingNotSupported(LockError):
 
 
910
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
 
912
    internal_error = True
 
 
914
    def __init__(self, obj):
 
 
918
class TokenMismatch(LockBroken):
 
 
920
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
 
922
    internal_error = True
 
 
924
    def __init__(self, given_token, lock_token):
 
 
925
        self.given_token = given_token
 
 
926
        self.lock_token = lock_token
 
 
929
class PointlessCommit(BzrError):
 
 
931
    _fmt = "No changes to commit"
 
 
934
class CannotCommitSelectedFileMerge(BzrError):
 
 
936
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
 
937
        ' files %(files_str)s'
 
 
939
    def __init__(self, files):
 
 
940
        files_str = ', '.join(files)
 
 
941
        BzrError.__init__(self, files=files, files_str=files_str)
 
 
944
class UpgradeReadonly(BzrError):
 
 
946
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
 
949
class UpToDateFormat(BzrError):
 
 
951
    _fmt = "The branch format %(format)s is already at the most recent format."
 
 
953
    def __init__(self, format):
 
 
954
        BzrError.__init__(self)
 
 
958
class StrictCommitFailed(Exception):
 
 
960
    _fmt = "Commit refused because there are unknowns in the tree."
 
 
963
class NoSuchRevision(BzrError):
 
 
965
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
 
967
    internal_error = True
 
 
969
    def __init__(self, branch, revision):
 
 
970
        BzrError.__init__(self, branch=branch, revision=revision)
 
 
973
class NotLeftParentDescendant(BzrError):
 
 
975
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
 
976
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
 
978
    internal_error = True
 
 
980
    def __init__(self, branch, old_revision, new_revision):
 
 
981
        BzrError.__init__(self, branch_location=branch.base,
 
 
982
                          old_revision=old_revision,
 
 
983
                          new_revision=new_revision)
 
 
986
class NoSuchRevisionSpec(BzrError):
 
 
988
    _fmt = "No namespace registered for string: %(spec)r"
 
 
990
    def __init__(self, spec):
 
 
991
        BzrError.__init__(self, spec=spec)
 
 
994
class NoSuchRevisionInTree(NoSuchRevision):
 
 
995
    """When using Tree.revision_tree, and the revision is not accessible."""
 
 
997
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
 
 
999
    def __init__(self, tree, revision_id):
 
 
1000
        BzrError.__init__(self)
 
 
1002
        self.revision_id = revision_id
 
 
1005
class InvalidRevisionSpec(BzrError):
 
 
1007
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
 
1008
            " %(branch)s%(extra)s")
 
 
1010
    def __init__(self, spec, branch, extra=None):
 
 
1011
        BzrError.__init__(self, branch=branch, spec=spec)
 
 
1013
            self.extra = '\n' + str(extra)
 
 
1018
class HistoryMissing(BzrError):
 
 
1020
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
 
1023
class AppendRevisionsOnlyViolation(BzrError):
 
 
1025
    _fmt = ('Operation denied because it would change the main history,'
 
 
1026
           ' which is not permitted by the append_revisions_only setting on'
 
 
1027
           ' branch "%(location)s".')
 
 
1029
    def __init__(self, location):
 
 
1030
       import bzrlib.urlutils as urlutils
 
 
1031
       location = urlutils.unescape_for_display(location, 'ascii')
 
 
1032
       BzrError.__init__(self, location=location)
 
 
1035
class DivergedBranches(BzrError):
 
 
1037
    _fmt = ("These branches have diverged."
 
 
1038
            " Use the merge command to reconcile them.")
 
 
1040
    internal_error = False
 
 
1042
    def __init__(self, branch1, branch2):
 
 
1043
        self.branch1 = branch1
 
 
1044
        self.branch2 = branch2
 
 
1047
class NotLefthandHistory(BzrError):
 
 
1049
    _fmt = "Supplied history does not follow left-hand parents"
 
 
1051
    internal_error = True
 
 
1053
    def __init__(self, history):
 
 
1054
        BzrError.__init__(self, history=history)
 
 
1057
class UnrelatedBranches(BzrError):
 
 
1059
    _fmt = ("Branches have no common ancestor, and"
 
 
1060
            " no merge base revision was specified.")
 
 
1062
    internal_error = False
 
 
1065
class NoCommonAncestor(BzrError):
 
 
1067
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
1069
    def __init__(self, revision_a, revision_b):
 
 
1070
        self.revision_a = revision_a
 
 
1071
        self.revision_b = revision_b
 
 
1074
class NoCommonRoot(BzrError):
 
 
1076
    _fmt = ("Revisions are not derived from the same root: "
 
 
1077
           "%(revision_a)s %(revision_b)s.")
 
 
1079
    def __init__(self, revision_a, revision_b):
 
 
1080
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
 
1083
class NotAncestor(BzrError):
 
 
1085
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
 
1087
    def __init__(self, rev_id, not_ancestor_id):
 
 
1088
        BzrError.__init__(self, rev_id=rev_id,
 
 
1089
            not_ancestor_id=not_ancestor_id)
 
 
1092
class InstallFailed(BzrError):
 
 
1094
    def __init__(self, revisions):
 
 
1095
        revision_str = ", ".join(str(r) for r in revisions)
 
 
1096
        msg = "Could not install revisions:\n%s" % revision_str
 
 
1097
        BzrError.__init__(self, msg)
 
 
1098
        self.revisions = revisions
 
 
1101
class AmbiguousBase(BzrError):
 
 
1103
    def __init__(self, bases):
 
 
1104
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
1106
        msg = ("The correct base is unclear, because %s are all equally close"
 
 
1108
        BzrError.__init__(self, msg)
 
 
1112
class NoCommits(BzrError):
 
 
1114
    _fmt = "Branch %(branch)s has no commits."
 
 
1116
    def __init__(self, branch):
 
 
1117
        BzrError.__init__(self, branch=branch)
 
 
1120
class UnlistableStore(BzrError):
 
 
1122
    def __init__(self, store):
 
 
1123
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
1127
class UnlistableBranch(BzrError):
 
 
1129
    def __init__(self, br):
 
 
1130
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
1133
class BoundBranchOutOfDate(BzrError):
 
 
1135
    _fmt = ("Bound branch %(branch)s is out of date"
 
 
1136
            " with master branch %(master)s.")
 
 
1138
    def __init__(self, branch, master):
 
 
1139
        BzrError.__init__(self)
 
 
1140
        self.branch = branch
 
 
1141
        self.master = master
 
 
1144
class CommitToDoubleBoundBranch(BzrError):
 
 
1146
    _fmt = ("Cannot commit to branch %(branch)s."
 
 
1147
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
 
1149
    def __init__(self, branch, master, remote):
 
 
1150
        BzrError.__init__(self)
 
 
1151
        self.branch = branch
 
 
1152
        self.master = master
 
 
1153
        self.remote = remote
 
 
1156
class OverwriteBoundBranch(BzrError):
 
 
1158
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
 
1160
    def __init__(self, branch):
 
 
1161
        BzrError.__init__(self)
 
 
1162
        self.branch = branch
 
 
1165
class BoundBranchConnectionFailure(BzrError):
 
 
1167
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
 
1168
            " => %(target)s: %(error)s")
 
 
1170
    def __init__(self, branch, target, error):
 
 
1171
        BzrError.__init__(self)
 
 
1172
        self.branch = branch
 
 
1173
        self.target = target
 
 
1177
class WeaveError(BzrError):
 
 
1179
    _fmt = "Error in processing weave: %(message)s"
 
 
1181
    def __init__(self, message=None):
 
 
1182
        BzrError.__init__(self)
 
 
1183
        self.message = message
 
 
1186
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
1188
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
 
1190
    def __init__(self, revision_id, weave):
 
 
1192
        WeaveError.__init__(self)
 
 
1193
        self.revision_id = revision_id
 
 
1197
class WeaveRevisionNotPresent(WeaveError):
 
 
1199
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
 
1201
    def __init__(self, revision_id, weave):
 
 
1202
        WeaveError.__init__(self)
 
 
1203
        self.revision_id = revision_id
 
 
1207
class WeaveFormatError(WeaveError):
 
 
1209
    _fmt = "Weave invariant violated: %(what)s"
 
 
1211
    def __init__(self, what):
 
 
1212
        WeaveError.__init__(self)
 
 
1216
class WeaveParentMismatch(WeaveError):
 
 
1218
    _fmt = "Parents are mismatched between two revisions."
 
 
1221
class WeaveInvalidChecksum(WeaveError):
 
 
1223
    _fmt = "Text did not match it's checksum: %(message)s"
 
 
1226
class WeaveTextDiffers(WeaveError):
 
 
1228
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1229
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1231
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1232
        WeaveError.__init__(self)
 
 
1233
        self.revision_id = revision_id
 
 
1234
        self.weave_a = weave_a
 
 
1235
        self.weave_b = weave_b
 
 
1238
class WeaveTextDiffers(WeaveError):
 
 
1240
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1241
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1243
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1244
        WeaveError.__init__(self)
 
 
1245
        self.revision_id = revision_id
 
 
1246
        self.weave_a = weave_a
 
 
1247
        self.weave_b = weave_b
 
 
1250
class VersionedFileError(BzrError):
 
 
1252
    _fmt = "Versioned file error"
 
 
1255
class RevisionNotPresent(VersionedFileError):
 
 
1257
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
 
1259
    def __init__(self, revision_id, file_id):
 
 
1260
        VersionedFileError.__init__(self)
 
 
1261
        self.revision_id = revision_id
 
 
1262
        self.file_id = file_id
 
 
1265
class RevisionAlreadyPresent(VersionedFileError):
 
 
1267
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
 
1269
    def __init__(self, revision_id, file_id):
 
 
1270
        VersionedFileError.__init__(self)
 
 
1271
        self.revision_id = revision_id
 
 
1272
        self.file_id = file_id
 
 
1275
class VersionedFileInvalidChecksum(VersionedFileError):
 
 
1277
    _fmt = "Text did not match its checksum: %(message)s"
 
 
1280
class KnitError(BzrError):
 
 
1284
    internal_error = True
 
 
1287
class KnitHeaderError(KnitError):
 
 
1289
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
 
1291
    def __init__(self, badline, filename):
 
 
1292
        KnitError.__init__(self)
 
 
1293
        self.badline = badline
 
 
1294
        self.filename = filename
 
 
1297
class KnitCorrupt(KnitError):
 
 
1299
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
 
1301
    def __init__(self, filename, how):
 
 
1302
        KnitError.__init__(self)
 
 
1303
        self.filename = filename
 
 
1307
class KnitIndexUnknownMethod(KnitError):
 
 
1308
    """Raised when we don't understand the storage method.
 
 
1310
    Currently only 'fulltext' and 'line-delta' are supported.
 
 
1313
    _fmt = ("Knit index %(filename)s does not have a known method"
 
 
1314
            " in options: %(options)r")
 
 
1316
    def __init__(self, filename, options):
 
 
1317
        KnitError.__init__(self)
 
 
1318
        self.filename = filename
 
 
1319
        self.options = options
 
 
1322
class NoSuchExportFormat(BzrError):
 
 
1324
    _fmt = "Export format %(format)r not supported"
 
 
1326
    def __init__(self, format):
 
 
1327
        BzrError.__init__(self)
 
 
1328
        self.format = format
 
 
1331
class TransportError(BzrError):
 
 
1333
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
 
1335
    def __init__(self, msg=None, orig_error=None):
 
 
1336
        if msg is None and orig_error is not None:
 
 
1337
            msg = str(orig_error)
 
 
1338
        if orig_error is None:
 
 
1343
        self.orig_error = orig_error
 
 
1344
        BzrError.__init__(self)
 
 
1347
class TooManyConcurrentRequests(BzrError):
 
 
1349
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
 
1350
            " Be sure to finish_writing and finish_reading on the"
 
 
1351
            " currently open request.")
 
 
1353
    internal_error = True
 
 
1355
    def __init__(self, medium):
 
 
1356
        self.medium = medium
 
 
1359
class SmartProtocolError(TransportError):
 
 
1361
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
 
1363
    def __init__(self, details):
 
 
1364
        self.details = details
 
 
1367
# A set of semi-meaningful errors which can be thrown
 
 
1368
class TransportNotPossible(TransportError):
 
 
1370
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
 
1373
class ConnectionError(TransportError):
 
 
1375
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
 
1378
class SocketConnectionError(ConnectionError):
 
 
1380
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
 
1382
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
1384
            msg = 'Failed to connect to'
 
 
1385
        if orig_error is None:
 
 
1388
            orig_error = '; ' + str(orig_error)
 
 
1389
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
1394
            self.port = ':%s' % port
 
 
1397
class ConnectionReset(TransportError):
 
 
1399
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
 
1402
class InvalidRange(TransportError):
 
 
1404
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
 
1406
    def __init__(self, path, offset):
 
 
1407
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
 
1410
        self.offset = offset
 
 
1413
class InvalidHttpResponse(TransportError):
 
 
1415
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
 
1417
    def __init__(self, path, msg, orig_error=None):
 
 
1419
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
1422
class InvalidHttpRange(InvalidHttpResponse):
 
 
1424
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
 
1426
    def __init__(self, path, range, msg):
 
 
1428
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1431
class InvalidHttpContentType(InvalidHttpResponse):
 
 
1433
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
 
1435
    def __init__(self, path, ctype, msg):
 
 
1437
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1440
class RedirectRequested(TransportError):
 
 
1442
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
 
1444
    def __init__(self, source, target, is_permament=False, qual_proto=None):
 
 
1445
        self.source = source
 
 
1446
        self.target = target
 
 
1448
            self.permanently = ' permanently'
 
 
1450
            self.permanently = ''
 
 
1451
        self.is_permament = is_permament
 
 
1452
        self._qualified_proto = qual_proto
 
 
1453
        TransportError.__init__(self)
 
 
1455
    def _requalify_url(self, url):
 
 
1456
        """Restore the qualified proto in front of the url"""
 
 
1457
        # When this exception is raised, source and target are in
 
 
1458
        # user readable format. But some transports may use a
 
 
1459
        # different proto (http+urllib:// will present http:// to
 
 
1460
        # the user. If a qualified proto is specified, the code
 
 
1461
        # trapping the exception can get the qualified urls to
 
 
1462
        # properly handle the redirection themself (creating a
 
 
1463
        # new transport object from the target url for example).
 
 
1464
        # But checking that the scheme of the original and
 
 
1465
        # redirected urls are the same can be tricky. (see the
 
 
1466
        # FIXME in BzrDir.open_from_transport for the unique use
 
 
1468
        if self._qualified_proto is None:
 
 
1471
        # The TODO related to NotBranchError mention that doing
 
 
1472
        # that kind of manipulation on the urls may not be the
 
 
1473
        # exception object job. On the other hand, this object is
 
 
1474
        # the interface between the code and the user so
 
 
1475
        # presenting the urls in different ways is indeed its
 
 
1478
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
 
1479
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
 
1482
    def get_source_url(self):
 
 
1483
        return self._requalify_url(self.source)
 
 
1485
    def get_target_url(self):
 
 
1486
        return self._requalify_url(self.target)
 
 
1489
class TooManyRedirections(TransportError):
 
 
1491
    _fmt = "Too many redirections"
 
 
1493
class ConflictsInTree(BzrError):
 
 
1495
    _fmt = "Working tree has conflicts."
 
 
1498
class ParseConfigError(BzrError):
 
 
1500
    def __init__(self, errors, filename):
 
 
1501
        if filename is None:
 
 
1503
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
1504
            (filename, ('\n'.join(e.message for e in errors)))
 
 
1505
        BzrError.__init__(self, message)
 
 
1508
class NoEmailInUsername(BzrError):
 
 
1510
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
 
1512
    def __init__(self, username):
 
 
1513
        BzrError.__init__(self)
 
 
1514
        self.username = username
 
 
1517
class SigningFailed(BzrError):
 
 
1519
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
 
1521
    def __init__(self, command_line):
 
 
1522
        BzrError.__init__(self, command_line=command_line)
 
 
1525
class WorkingTreeNotRevision(BzrError):
 
 
1527
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
 
1528
            " the last commit, but weave merge requires that it be"
 
 
1531
    def __init__(self, tree):
 
 
1532
        BzrError.__init__(self, basedir=tree.basedir)
 
 
1535
class CantReprocessAndShowBase(BzrError):
 
 
1537
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
 
1538
           "the relationship of conflicting lines to the base")
 
 
1541
class GraphCycleError(BzrError):
 
 
1543
    _fmt = "Cycle in graph %(graph)r"
 
 
1545
    def __init__(self, graph):
 
 
1546
        BzrError.__init__(self)
 
 
1550
class WritingCompleted(BzrError):
 
 
1552
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
 
1553
            "called upon it - accept bytes may not be called anymore.")
 
 
1555
    internal_error = True
 
 
1557
    def __init__(self, request):
 
 
1558
        self.request = request
 
 
1561
class WritingNotComplete(BzrError):
 
 
1563
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
 
1564
            "called upon it - until the write phase is complete no "
 
 
1565
            "data may be read.")
 
 
1567
    internal_error = True
 
 
1569
    def __init__(self, request):
 
 
1570
        self.request = request
 
 
1573
class NotConflicted(BzrError):
 
 
1575
    _fmt = "File %(filename)s is not conflicted."
 
 
1577
    def __init__(self, filename):
 
 
1578
        BzrError.__init__(self)
 
 
1579
        self.filename = filename
 
 
1582
class MediumNotConnected(BzrError):
 
 
1584
    _fmt = """The medium '%(medium)s' is not connected."""
 
 
1586
    internal_error = True
 
 
1588
    def __init__(self, medium):
 
 
1589
        self.medium = medium
 
 
1592
class MustUseDecorated(Exception):
 
 
1594
    _fmt = "A decorating function has requested its original command be used."
 
 
1597
class NoBundleFound(BzrError):
 
 
1599
    _fmt = "No bundle was found in %(filename)s"
 
 
1601
    def __init__(self, filename):
 
 
1602
        BzrError.__init__(self)
 
 
1603
        self.filename = filename
 
 
1606
class BundleNotSupported(BzrError):
 
 
1608
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
 
1610
    def __init__(self, version, msg):
 
 
1611
        BzrError.__init__(self)
 
 
1612
        self.version = version
 
 
1616
class MissingText(BzrError):
 
 
1618
    _fmt = ("Branch %(base)s is missing revision"
 
 
1619
            " %(text_revision)s of %(file_id)s")
 
 
1621
    def __init__(self, branch, text_revision, file_id):
 
 
1622
        BzrError.__init__(self)
 
 
1623
        self.branch = branch
 
 
1624
        self.base = branch.base
 
 
1625
        self.text_revision = text_revision
 
 
1626
        self.file_id = file_id
 
 
1628
class DuplicateFileId(BzrError):
 
 
1630
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
 
1632
    def __init__(self, file_id, entry):
 
 
1633
        BzrError.__init__(self)
 
 
1634
        self.file_id = file_id
 
 
1638
class DuplicateKey(BzrError):
 
 
1640
    _fmt = "Key %(key)s is already present in map"
 
 
1643
class DuplicateHelpPrefix(BzrError):
 
 
1645
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
 
1647
    def __init__(self, prefix):
 
 
1648
        self.prefix = prefix
 
 
1651
class MalformedTransform(BzrError):
 
 
1653
    _fmt = "Tree transform is malformed %(conflicts)r"
 
 
1656
class NoFinalPath(BzrError):
 
 
1658
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
 
1659
            "file-id: %(file_id)r\n"
 
 
1660
            "root trans-id: %(root_trans_id)r\n")
 
 
1662
    def __init__(self, trans_id, transform):
 
 
1663
        self.trans_id = trans_id
 
 
1664
        self.file_id = transform.final_file_id(trans_id)
 
 
1665
        self.root_trans_id = transform.root
 
 
1668
class BzrBadParameter(BzrError):
 
 
1670
    _fmt = "Bad parameter: %(param)r"
 
 
1672
    internal_error = True
 
 
1674
    # This exception should never be thrown, but it is a base class for all
 
 
1675
    # parameter-to-function errors.
 
 
1677
    def __init__(self, param):
 
 
1678
        BzrError.__init__(self)
 
 
1682
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1684
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
 
1687
class ReusingTransform(BzrError):
 
 
1689
    _fmt = "Attempt to reuse a transform that has already been applied."
 
 
1692
class CantMoveRoot(BzrError):
 
 
1694
    _fmt = "Moving the root directory is not supported at this time"
 
 
1697
class BzrMoveFailedError(BzrError):
 
 
1699
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1701
    def __init__(self, from_path='', to_path='', extra=None):
 
 
1702
        BzrError.__init__(self)
 
 
1704
            self.extra = ': ' + str(extra)
 
 
1708
        has_from = len(from_path) > 0
 
 
1709
        has_to = len(to_path) > 0
 
 
1711
            self.from_path = osutils.splitpath(from_path)[-1]
 
 
1716
            self.to_path = osutils.splitpath(to_path)[-1]
 
 
1721
        if has_from and has_to:
 
 
1722
            self.operator = " =>"
 
 
1724
            self.from_path = "from " + from_path
 
 
1726
            self.operator = "to"
 
 
1728
            self.operator = "file"
 
 
1731
class BzrRenameFailedError(BzrMoveFailedError):
 
 
1733
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1735
    def __init__(self, from_path, to_path, extra=None):
 
 
1736
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
 
1738
class BzrRemoveChangedFilesError(BzrError):
 
 
1739
    """Used when user is trying to remove changed files."""
 
 
1741
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
 
 
1742
        "Use --keep to not delete them, or --force to delete them regardless.")
 
 
1744
    def __init__(self, tree_delta):
 
 
1745
        BzrError.__init__(self)
 
 
1746
        self.changes_as_text = tree_delta.get_changes_as_text()
 
 
1747
        #self.paths_as_string = '\n'.join(changed_files)
 
 
1748
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
 
1751
class BzrBadParameterNotString(BzrBadParameter):
 
 
1753
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
 
1756
class BzrBadParameterMissing(BzrBadParameter):
 
 
1758
    _fmt = "Parameter $(param)s is required but not present."
 
 
1761
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1763
    _fmt = ("Parameter %(param)s is unicode but"
 
 
1764
            " only byte-strings are permitted.")
 
 
1767
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1769
    _fmt = "Parameter %(param)s contains a newline."
 
 
1772
class DependencyNotPresent(BzrError):
 
 
1774
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
 
1776
    def __init__(self, library, error):
 
 
1777
        BzrError.__init__(self, library=library, error=error)
 
 
1780
class ParamikoNotPresent(DependencyNotPresent):
 
 
1782
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
 
1784
    def __init__(self, error):
 
 
1785
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1788
class PointlessMerge(BzrError):
 
 
1790
    _fmt = "Nothing to merge."
 
 
1793
class UninitializableFormat(BzrError):
 
 
1795
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
 
1797
    def __init__(self, format):
 
 
1798
        BzrError.__init__(self)
 
 
1799
        self.format = format
 
 
1802
class BadConversionTarget(BzrError):
 
 
1804
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
 
1806
    def __init__(self, problem, format):
 
 
1807
        BzrError.__init__(self)
 
 
1808
        self.problem = problem
 
 
1809
        self.format = format
 
 
1812
class NoDiff(BzrError):
 
 
1814
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
 
1816
    def __init__(self, msg):
 
 
1817
        BzrError.__init__(self, msg=msg)
 
 
1820
class NoDiff3(BzrError):
 
 
1822
    _fmt = "Diff3 is not installed on this machine."
 
 
1825
class ExistingLimbo(BzrError):
 
 
1827
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1828
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1829
    keep, and delete it when you are done."""
 
 
1831
    def __init__(self, limbo_dir):
 
 
1832
       BzrError.__init__(self)
 
 
1833
       self.limbo_dir = limbo_dir
 
 
1836
class ImmortalLimbo(BzrError):
 
 
1838
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
 
1839
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1840
    keep, and delete it when you are done."""
 
 
1842
    def __init__(self, limbo_dir):
 
 
1843
       BzrError.__init__(self)
 
 
1844
       self.limbo_dir = limbo_dir
 
 
1847
class OutOfDateTree(BzrError):
 
 
1849
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
 
1851
    def __init__(self, tree):
 
 
1852
        BzrError.__init__(self)
 
 
1856
class PublicBranchOutOfDate(BzrError):
 
 
1858
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
 
1861
    def __init__(self, public_location, revstring):
 
 
1862
        import bzrlib.urlutils as urlutils
 
 
1863
        public_location = urlutils.unescape_for_display(public_location,
 
 
1865
        BzrError.__init__(self, public_location=public_location,
 
 
1866
                          revstring=revstring)
 
 
1869
class MergeModifiedFormatError(BzrError):
 
 
1871
    _fmt = "Error in merge modified format"
 
 
1874
class ConflictFormatError(BzrError):
 
 
1876
    _fmt = "Format error in conflict listings"
 
 
1879
class CorruptRepository(BzrError):
 
 
1881
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
 
1882
            "Please run bzr reconcile on this repository.")
 
 
1884
    def __init__(self, repo):
 
 
1885
        BzrError.__init__(self)
 
 
1886
        self.repo_path = repo.bzrdir.root_transport.base
 
 
1889
class UpgradeRequired(BzrError):
 
 
1891
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
 
1893
    def __init__(self, path):
 
 
1894
        BzrError.__init__(self)
 
 
1898
class LocalRequiresBoundBranch(BzrError):
 
 
1900
    _fmt = "Cannot perform local-only commits on unbound branches."
 
 
1903
class MissingProgressBarFinish(BzrError):
 
 
1905
    _fmt = "A nested progress bar was not 'finished' correctly."
 
 
1908
class InvalidProgressBarType(BzrError):
 
 
1910
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
 
1911
            " is not a supported type Select one of: %(valid_types)s")
 
 
1913
    def __init__(self, bar_type, valid_types):
 
 
1914
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
1917
class UnsupportedOperation(BzrError):
 
 
1919
    _fmt = ("The method %(mname)s is not supported on"
 
 
1920
            " objects of type %(tname)s.")
 
 
1922
    def __init__(self, method, method_self):
 
 
1923
        self.method = method
 
 
1924
        self.mname = method.__name__
 
 
1925
        self.tname = type(method_self).__name__
 
 
1928
class CannotSetRevisionId(UnsupportedOperation):
 
 
1929
    """Raised when a commit is attempting to set a revision id but cant."""
 
 
1932
class NonAsciiRevisionId(UnsupportedOperation):
 
 
1933
    """Raised when a commit is attempting to set a non-ascii revision id
 
 
1938
class BinaryFile(BzrError):
 
 
1940
    _fmt = "File is binary but should be text."
 
 
1943
class IllegalPath(BzrError):
 
 
1945
    _fmt = "The path %(path)s is not permitted on this platform"
 
 
1947
    def __init__(self, path):
 
 
1948
        BzrError.__init__(self)
 
 
1952
class TestamentMismatch(BzrError):
 
 
1954
    _fmt = """Testament did not match expected value.
 
 
1955
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
 
1958
    def __init__(self, revision_id, expected, measured):
 
 
1959
        self.revision_id = revision_id
 
 
1960
        self.expected = expected
 
 
1961
        self.measured = measured
 
 
1964
class NotABundle(BzrError):
 
 
1966
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
 
1968
    def __init__(self, text):
 
 
1969
        BzrError.__init__(self)
 
 
1973
class BadBundle(BzrError): 
 
 
1975
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
 
1977
    def __init__(self, text):
 
 
1978
        BzrError.__init__(self)
 
 
1982
class MalformedHeader(BadBundle): 
 
 
1984
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
 
1987
class MalformedPatches(BadBundle): 
 
 
1989
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
 
1992
class MalformedFooter(BadBundle): 
 
 
1994
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
 
1997
class UnsupportedEOLMarker(BadBundle):
 
 
1999
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
 
2002
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
 
2003
        # but for this there is not
 
 
2004
        BzrError.__init__(self)
 
 
2007
class IncompatibleBundleFormat(BzrError):
 
 
2009
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
 
2011
    def __init__(self, bundle_format, other):
 
 
2012
        BzrError.__init__(self)
 
 
2013
        self.bundle_format = bundle_format
 
 
2017
class BadInventoryFormat(BzrError):
 
 
2019
    _fmt = "Root class for inventory serialization errors"
 
 
2022
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
2024
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
 
2026
    def __init__(self, msg):
 
 
2027
        BadInventoryFormat.__init__(self, msg=msg)
 
 
2030
class RootNotRich(BzrError):
 
 
2032
    _fmt = """This operation requires rich root data storage"""
 
 
2035
class NoSmartMedium(BzrError):
 
 
2037
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
 
2039
    internal_error = True
 
 
2041
    def __init__(self, transport):
 
 
2042
        self.transport = transport
 
 
2045
class NoSmartServer(NotBranchError):
 
 
2047
    _fmt = "No smart server available at %(url)s"
 
 
2049
    def __init__(self, url):
 
 
2053
class UnknownSSH(BzrError):
 
 
2055
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
 
2057
    def __init__(self, vendor):
 
 
2058
        BzrError.__init__(self)
 
 
2059
        self.vendor = vendor
 
 
2062
class SSHVendorNotFound(BzrError):
 
 
2064
    _fmt = ("Don't know how to handle SSH connections."
 
 
2065
            " Please set BZR_SSH environment variable.")
 
 
2068
class GhostRevisionUnusableHere(BzrError):
 
 
2070
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
 
2072
    def __init__(self, revision_id):
 
 
2073
        BzrError.__init__(self)
 
 
2074
        self.revision_id = revision_id
 
 
2077
class IllegalUseOfScopeReplacer(BzrError):
 
 
2079
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
 
2080
            " %(msg)s%(extra)s")
 
 
2082
    internal_error = True
 
 
2084
    def __init__(self, name, msg, extra=None):
 
 
2085
        BzrError.__init__(self)
 
 
2089
            self.extra = ': ' + str(extra)
 
 
2094
class InvalidImportLine(BzrError):
 
 
2096
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
 
2098
    internal_error = True
 
 
2100
    def __init__(self, text, msg):
 
 
2101
        BzrError.__init__(self)
 
 
2106
class ImportNameCollision(BzrError):
 
 
2108
    _fmt = ("Tried to import an object to the same name as"
 
 
2109
            " an existing object. %(name)s")
 
 
2111
    internal_error = True
 
 
2113
    def __init__(self, name):
 
 
2114
        BzrError.__init__(self)
 
 
2118
class NotAMergeDirective(BzrError):
 
 
2119
    """File starting with %(firstline)r is not a merge directive"""
 
 
2120
    def __init__(self, firstline):
 
 
2121
        BzrError.__init__(self, firstline=firstline)
 
 
2124
class NoMergeSource(BzrError):
 
 
2125
    """Raise if no merge source was specified for a merge directive"""
 
 
2127
    _fmt = "A merge directive must provide either a bundle or a public"\
 
 
2131
class IllegalMergeDirectivePayload(BzrError):
 
 
2132
    """A merge directive contained something other than a patch or bundle"""
 
 
2134
    _fmt = "Bad merge directive payload %(start)r"
 
 
2136
    def __init__(self, start):
 
 
2141
class PatchVerificationFailed(BzrError):
 
 
2142
    """A patch from a merge directive could not be verified"""
 
 
2144
    _fmt = "Preview patch does not match requested changes."
 
 
2147
class PatchMissing(BzrError):
 
 
2148
    """Raise a patch type was specified but no patch supplied"""
 
 
2150
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
 
2152
    def __init__(self, patch_type):
 
 
2153
        BzrError.__init__(self)
 
 
2154
        self.patch_type = patch_type
 
 
2157
class UnsupportedInventoryKind(BzrError):
 
 
2159
    _fmt = """Unsupported entry kind %(kind)s"""
 
 
2161
    def __init__(self, kind):
 
 
2165
class BadSubsumeSource(BzrError):
 
 
2167
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
 
 
2169
    def __init__(self, tree, other_tree, reason):
 
 
2171
        self.other_tree = other_tree
 
 
2172
        self.reason = reason
 
 
2175
class SubsumeTargetNeedsUpgrade(BzrError):
 
 
2177
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
 
2179
    def __init__(self, other_tree):
 
 
2180
        self.other_tree = other_tree
 
 
2183
class BadReferenceTarget(BzrError):
 
 
2185
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
 
2187
    internal_error = True
 
 
2189
    def __init__(self, tree, other_tree, reason):
 
 
2191
        self.other_tree = other_tree
 
 
2192
        self.reason = reason
 
 
2195
class NoSuchTag(BzrError):
 
 
2197
    _fmt = "No such tag: %(tag_name)s"
 
 
2199
    def __init__(self, tag_name):
 
 
2200
        self.tag_name = tag_name
 
 
2203
class TagsNotSupported(BzrError):
 
 
2205
    _fmt = ("Tags not supported by %(branch)s;"
 
 
2206
            " you may be able to use bzr upgrade --dirstate-tags.")
 
 
2208
    def __init__(self, branch):
 
 
2209
        self.branch = branch
 
 
2212
class TagAlreadyExists(BzrError):
 
 
2214
    _fmt = "Tag %(tag_name)s already exists."
 
 
2216
    def __init__(self, tag_name):
 
 
2217
        self.tag_name = tag_name
 
 
2220
class MalformedBugIdentifier(BzrError):
 
 
2222
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
 
2224
    def __init__(self, bug_id, reason):
 
 
2225
        self.bug_id = bug_id
 
 
2226
        self.reason = reason
 
 
2229
class UnknownBugTrackerAbbreviation(BzrError):
 
 
2231
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
 
2234
    def __init__(self, abbreviation, branch):
 
 
2235
        self.abbreviation = abbreviation
 
 
2236
        self.branch = branch
 
 
2239
class UnexpectedSmartServerResponse(BzrError):
 
 
2241
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
 
2243
    def __init__(self, response_tuple):
 
 
2244
        self.response_tuple = response_tuple
 
 
2247
class ContainerError(BzrError):
 
 
2248
    """Base class of container errors."""
 
 
2251
class UnknownContainerFormatError(ContainerError):
 
 
2253
    _fmt = "Unrecognised container format: %(container_format)r"
 
 
2255
    def __init__(self, container_format):
 
 
2256
        self.container_format = container_format
 
 
2259
class UnexpectedEndOfContainerError(ContainerError):
 
 
2261
    _fmt = "Unexpected end of container stream"
 
 
2263
    internal_error = False
 
 
2266
class UnknownRecordTypeError(ContainerError):
 
 
2268
    _fmt = "Unknown record type: %(record_type)r"
 
 
2270
    def __init__(self, record_type):
 
 
2271
        self.record_type = record_type
 
 
2274
class InvalidRecordError(ContainerError):
 
 
2276
    _fmt = "Invalid record: %(reason)s"
 
 
2278
    def __init__(self, reason):
 
 
2279
        self.reason = reason
 
 
2282
class ContainerHasExcessDataError(ContainerError):
 
 
2284
    _fmt = "Container has data after end marker: %(excess)r"
 
 
2286
    def __init__(self, excess):
 
 
2287
        self.excess = excess
 
 
2290
class DuplicateRecordNameError(ContainerError):
 
 
2292
    _fmt = "Container has multiple records with the same name: \"%(name)s\""
 
 
2294
    def __init__(self, name):
 
 
2298
class NoDestinationAddress(BzrError):
 
 
2300
    _fmt = "Message does not have a destination address."
 
 
2302
    internal_error = True
 
 
2305
class SMTPError(BzrError):
 
 
2307
    _fmt = "SMTP error: %(error)s"
 
 
2309
    def __init__(self, error):