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)s has no revision %(revision)s"
 
 
967
    internal_error = True
 
 
969
    def __init__(self, branch, revision):
 
 
970
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
 
 
971
        BzrError.__init__(self, branch=branch, revision=revision)
 
 
974
# zero_ninetyone: this exception is no longer raised and should be removed
 
 
975
class NotLeftParentDescendant(BzrError):
 
 
977
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
 
978
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
 
980
    internal_error = True
 
 
982
    def __init__(self, branch, old_revision, new_revision):
 
 
983
        BzrError.__init__(self, branch_location=branch.base,
 
 
984
                          old_revision=old_revision,
 
 
985
                          new_revision=new_revision)
 
 
988
class NoSuchRevisionSpec(BzrError):
 
 
990
    _fmt = "No namespace registered for string: %(spec)r"
 
 
992
    def __init__(self, spec):
 
 
993
        BzrError.__init__(self, spec=spec)
 
 
996
class NoSuchRevisionInTree(NoSuchRevision):
 
 
997
    """When using Tree.revision_tree, and the revision is not accessible."""
 
 
999
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
 
 
1001
    def __init__(self, tree, revision_id):
 
 
1002
        BzrError.__init__(self)
 
 
1004
        self.revision_id = revision_id
 
 
1007
class InvalidRevisionSpec(BzrError):
 
 
1009
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
 
1010
            " %(branch)s%(extra)s")
 
 
1012
    def __init__(self, spec, branch, extra=None):
 
 
1013
        BzrError.__init__(self, branch=branch, spec=spec)
 
 
1015
            self.extra = '\n' + str(extra)
 
 
1020
class HistoryMissing(BzrError):
 
 
1022
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
 
1025
class AppendRevisionsOnlyViolation(BzrError):
 
 
1027
    _fmt = ('Operation denied because it would change the main history,'
 
 
1028
           ' which is not permitted by the append_revisions_only setting on'
 
 
1029
           ' branch "%(location)s".')
 
 
1031
    def __init__(self, location):
 
 
1032
       import bzrlib.urlutils as urlutils
 
 
1033
       location = urlutils.unescape_for_display(location, 'ascii')
 
 
1034
       BzrError.__init__(self, location=location)
 
 
1037
class DivergedBranches(BzrError):
 
 
1039
    _fmt = ("These branches have diverged."
 
 
1040
            " Use the merge command to reconcile them.")
 
 
1042
    internal_error = False
 
 
1044
    def __init__(self, branch1, branch2):
 
 
1045
        self.branch1 = branch1
 
 
1046
        self.branch2 = branch2
 
 
1049
class NotLefthandHistory(BzrError):
 
 
1051
    _fmt = "Supplied history does not follow left-hand parents"
 
 
1053
    internal_error = True
 
 
1055
    def __init__(self, history):
 
 
1056
        BzrError.__init__(self, history=history)
 
 
1059
class UnrelatedBranches(BzrError):
 
 
1061
    _fmt = ("Branches have no common ancestor, and"
 
 
1062
            " no merge base revision was specified.")
 
 
1064
    internal_error = False
 
 
1067
class NoCommonAncestor(BzrError):
 
 
1069
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
1071
    def __init__(self, revision_a, revision_b):
 
 
1072
        self.revision_a = revision_a
 
 
1073
        self.revision_b = revision_b
 
 
1076
class NoCommonRoot(BzrError):
 
 
1078
    _fmt = ("Revisions are not derived from the same root: "
 
 
1079
           "%(revision_a)s %(revision_b)s.")
 
 
1081
    def __init__(self, revision_a, revision_b):
 
 
1082
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
 
1085
class NotAncestor(BzrError):
 
 
1087
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
 
1089
    def __init__(self, rev_id, not_ancestor_id):
 
 
1090
        BzrError.__init__(self, rev_id=rev_id,
 
 
1091
            not_ancestor_id=not_ancestor_id)
 
 
1094
class InstallFailed(BzrError):
 
 
1096
    def __init__(self, revisions):
 
 
1097
        revision_str = ", ".join(str(r) for r in revisions)
 
 
1098
        msg = "Could not install revisions:\n%s" % revision_str
 
 
1099
        BzrError.__init__(self, msg)
 
 
1100
        self.revisions = revisions
 
 
1103
class AmbiguousBase(BzrError):
 
 
1105
    def __init__(self, bases):
 
 
1106
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
1108
        msg = ("The correct base is unclear, because %s are all equally close"
 
 
1110
        BzrError.__init__(self, msg)
 
 
1114
class NoCommits(BzrError):
 
 
1116
    _fmt = "Branch %(branch)s has no commits."
 
 
1118
    def __init__(self, branch):
 
 
1119
        BzrError.__init__(self, branch=branch)
 
 
1122
class UnlistableStore(BzrError):
 
 
1124
    def __init__(self, store):
 
 
1125
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
1129
class UnlistableBranch(BzrError):
 
 
1131
    def __init__(self, br):
 
 
1132
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
1135
class BoundBranchOutOfDate(BzrError):
 
 
1137
    _fmt = ("Bound branch %(branch)s is out of date"
 
 
1138
            " with master branch %(master)s.")
 
 
1140
    def __init__(self, branch, master):
 
 
1141
        BzrError.__init__(self)
 
 
1142
        self.branch = branch
 
 
1143
        self.master = master
 
 
1146
class CommitToDoubleBoundBranch(BzrError):
 
 
1148
    _fmt = ("Cannot commit to branch %(branch)s."
 
 
1149
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
 
1151
    def __init__(self, branch, master, remote):
 
 
1152
        BzrError.__init__(self)
 
 
1153
        self.branch = branch
 
 
1154
        self.master = master
 
 
1155
        self.remote = remote
 
 
1158
class OverwriteBoundBranch(BzrError):
 
 
1160
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
 
1162
    def __init__(self, branch):
 
 
1163
        BzrError.__init__(self)
 
 
1164
        self.branch = branch
 
 
1167
class BoundBranchConnectionFailure(BzrError):
 
 
1169
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
 
1170
            " => %(target)s: %(error)s")
 
 
1172
    def __init__(self, branch, target, error):
 
 
1173
        BzrError.__init__(self)
 
 
1174
        self.branch = branch
 
 
1175
        self.target = target
 
 
1179
class WeaveError(BzrError):
 
 
1181
    _fmt = "Error in processing weave: %(message)s"
 
 
1183
    def __init__(self, message=None):
 
 
1184
        BzrError.__init__(self)
 
 
1185
        self.message = message
 
 
1188
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
1190
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
 
1192
    def __init__(self, revision_id, weave):
 
 
1194
        WeaveError.__init__(self)
 
 
1195
        self.revision_id = revision_id
 
 
1199
class WeaveRevisionNotPresent(WeaveError):
 
 
1201
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
 
1203
    def __init__(self, revision_id, weave):
 
 
1204
        WeaveError.__init__(self)
 
 
1205
        self.revision_id = revision_id
 
 
1209
class WeaveFormatError(WeaveError):
 
 
1211
    _fmt = "Weave invariant violated: %(what)s"
 
 
1213
    def __init__(self, what):
 
 
1214
        WeaveError.__init__(self)
 
 
1218
class WeaveParentMismatch(WeaveError):
 
 
1220
    _fmt = "Parents are mismatched between two revisions."
 
 
1223
class WeaveInvalidChecksum(WeaveError):
 
 
1225
    _fmt = "Text did not match it's checksum: %(message)s"
 
 
1228
class WeaveTextDiffers(WeaveError):
 
 
1230
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1231
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1233
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1234
        WeaveError.__init__(self)
 
 
1235
        self.revision_id = revision_id
 
 
1236
        self.weave_a = weave_a
 
 
1237
        self.weave_b = weave_b
 
 
1240
class WeaveTextDiffers(WeaveError):
 
 
1242
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1243
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1245
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1246
        WeaveError.__init__(self)
 
 
1247
        self.revision_id = revision_id
 
 
1248
        self.weave_a = weave_a
 
 
1249
        self.weave_b = weave_b
 
 
1252
class VersionedFileError(BzrError):
 
 
1254
    _fmt = "Versioned file error"
 
 
1257
class RevisionNotPresent(VersionedFileError):
 
 
1259
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
 
1261
    def __init__(self, revision_id, file_id):
 
 
1262
        VersionedFileError.__init__(self)
 
 
1263
        self.revision_id = revision_id
 
 
1264
        self.file_id = file_id
 
 
1267
class RevisionAlreadyPresent(VersionedFileError):
 
 
1269
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
 
1271
    def __init__(self, revision_id, file_id):
 
 
1272
        VersionedFileError.__init__(self)
 
 
1273
        self.revision_id = revision_id
 
 
1274
        self.file_id = file_id
 
 
1277
class VersionedFileInvalidChecksum(VersionedFileError):
 
 
1279
    _fmt = "Text did not match its checksum: %(message)s"
 
 
1282
class KnitError(BzrError):
 
 
1286
    internal_error = True
 
 
1289
class KnitHeaderError(KnitError):
 
 
1291
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
 
1293
    def __init__(self, badline, filename):
 
 
1294
        KnitError.__init__(self)
 
 
1295
        self.badline = badline
 
 
1296
        self.filename = filename
 
 
1299
class KnitCorrupt(KnitError):
 
 
1301
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
 
1303
    def __init__(self, filename, how):
 
 
1304
        KnitError.__init__(self)
 
 
1305
        self.filename = filename
 
 
1309
class KnitIndexUnknownMethod(KnitError):
 
 
1310
    """Raised when we don't understand the storage method.
 
 
1312
    Currently only 'fulltext' and 'line-delta' are supported.
 
 
1315
    _fmt = ("Knit index %(filename)s does not have a known method"
 
 
1316
            " in options: %(options)r")
 
 
1318
    def __init__(self, filename, options):
 
 
1319
        KnitError.__init__(self)
 
 
1320
        self.filename = filename
 
 
1321
        self.options = options
 
 
1324
class NoSuchExportFormat(BzrError):
 
 
1326
    _fmt = "Export format %(format)r not supported"
 
 
1328
    def __init__(self, format):
 
 
1329
        BzrError.__init__(self)
 
 
1330
        self.format = format
 
 
1333
class TransportError(BzrError):
 
 
1335
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
 
1337
    def __init__(self, msg=None, orig_error=None):
 
 
1338
        if msg is None and orig_error is not None:
 
 
1339
            msg = str(orig_error)
 
 
1340
        if orig_error is None:
 
 
1345
        self.orig_error = orig_error
 
 
1346
        BzrError.__init__(self)
 
 
1349
class TooManyConcurrentRequests(BzrError):
 
 
1351
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
 
1352
            " Be sure to finish_writing and finish_reading on the"
 
 
1353
            " currently open request.")
 
 
1355
    internal_error = True
 
 
1357
    def __init__(self, medium):
 
 
1358
        self.medium = medium
 
 
1361
class SmartProtocolError(TransportError):
 
 
1363
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
 
1365
    def __init__(self, details):
 
 
1366
        self.details = details
 
 
1369
# A set of semi-meaningful errors which can be thrown
 
 
1370
class TransportNotPossible(TransportError):
 
 
1372
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
 
1375
class ConnectionError(TransportError):
 
 
1377
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
 
1380
class SocketConnectionError(ConnectionError):
 
 
1382
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
 
1384
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
1386
            msg = 'Failed to connect to'
 
 
1387
        if orig_error is None:
 
 
1390
            orig_error = '; ' + str(orig_error)
 
 
1391
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
1396
            self.port = ':%s' % port
 
 
1399
class ConnectionReset(TransportError):
 
 
1401
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
 
1404
class InvalidRange(TransportError):
 
 
1406
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
 
1408
    def __init__(self, path, offset):
 
 
1409
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
 
1412
        self.offset = offset
 
 
1415
class InvalidHttpResponse(TransportError):
 
 
1417
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
 
1419
    def __init__(self, path, msg, orig_error=None):
 
 
1421
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
1424
class InvalidHttpRange(InvalidHttpResponse):
 
 
1426
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
 
1428
    def __init__(self, path, range, msg):
 
 
1430
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1433
class InvalidHttpContentType(InvalidHttpResponse):
 
 
1435
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
 
1437
    def __init__(self, path, ctype, msg):
 
 
1439
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1442
class RedirectRequested(TransportError):
 
 
1444
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
 
1446
    def __init__(self, source, target, is_permament=False, qual_proto=None):
 
 
1447
        self.source = source
 
 
1448
        self.target = target
 
 
1450
            self.permanently = ' permanently'
 
 
1452
            self.permanently = ''
 
 
1453
        self.is_permament = is_permament
 
 
1454
        self._qualified_proto = qual_proto
 
 
1455
        TransportError.__init__(self)
 
 
1457
    def _requalify_url(self, url):
 
 
1458
        """Restore the qualified proto in front of the url"""
 
 
1459
        # When this exception is raised, source and target are in
 
 
1460
        # user readable format. But some transports may use a
 
 
1461
        # different proto (http+urllib:// will present http:// to
 
 
1462
        # the user. If a qualified proto is specified, the code
 
 
1463
        # trapping the exception can get the qualified urls to
 
 
1464
        # properly handle the redirection themself (creating a
 
 
1465
        # new transport object from the target url for example).
 
 
1466
        # But checking that the scheme of the original and
 
 
1467
        # redirected urls are the same can be tricky. (see the
 
 
1468
        # FIXME in BzrDir.open_from_transport for the unique use
 
 
1470
        if self._qualified_proto is None:
 
 
1473
        # The TODO related to NotBranchError mention that doing
 
 
1474
        # that kind of manipulation on the urls may not be the
 
 
1475
        # exception object job. On the other hand, this object is
 
 
1476
        # the interface between the code and the user so
 
 
1477
        # presenting the urls in different ways is indeed its
 
 
1480
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
 
1481
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
 
1484
    def get_source_url(self):
 
 
1485
        return self._requalify_url(self.source)
 
 
1487
    def get_target_url(self):
 
 
1488
        return self._requalify_url(self.target)
 
 
1491
class TooManyRedirections(TransportError):
 
 
1493
    _fmt = "Too many redirections"
 
 
1495
class ConflictsInTree(BzrError):
 
 
1497
    _fmt = "Working tree has conflicts."
 
 
1500
class ParseConfigError(BzrError):
 
 
1502
    def __init__(self, errors, filename):
 
 
1503
        if filename is None:
 
 
1505
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
1506
            (filename, ('\n'.join(e.message for e in errors)))
 
 
1507
        BzrError.__init__(self, message)
 
 
1510
class NoEmailInUsername(BzrError):
 
 
1512
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
 
1514
    def __init__(self, username):
 
 
1515
        BzrError.__init__(self)
 
 
1516
        self.username = username
 
 
1519
class SigningFailed(BzrError):
 
 
1521
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
 
1523
    def __init__(self, command_line):
 
 
1524
        BzrError.__init__(self, command_line=command_line)
 
 
1527
class WorkingTreeNotRevision(BzrError):
 
 
1529
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
 
1530
            " the last commit, but weave merge requires that it be"
 
 
1533
    def __init__(self, tree):
 
 
1534
        BzrError.__init__(self, basedir=tree.basedir)
 
 
1537
class CantReprocessAndShowBase(BzrError):
 
 
1539
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
 
1540
           "the relationship of conflicting lines to the base")
 
 
1543
class GraphCycleError(BzrError):
 
 
1545
    _fmt = "Cycle in graph %(graph)r"
 
 
1547
    def __init__(self, graph):
 
 
1548
        BzrError.__init__(self)
 
 
1552
class WritingCompleted(BzrError):
 
 
1554
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
 
1555
            "called upon it - accept bytes may not be called anymore.")
 
 
1557
    internal_error = True
 
 
1559
    def __init__(self, request):
 
 
1560
        self.request = request
 
 
1563
class WritingNotComplete(BzrError):
 
 
1565
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
 
1566
            "called upon it - until the write phase is complete no "
 
 
1567
            "data may be read.")
 
 
1569
    internal_error = True
 
 
1571
    def __init__(self, request):
 
 
1572
        self.request = request
 
 
1575
class NotConflicted(BzrError):
 
 
1577
    _fmt = "File %(filename)s is not conflicted."
 
 
1579
    def __init__(self, filename):
 
 
1580
        BzrError.__init__(self)
 
 
1581
        self.filename = filename
 
 
1584
class MediumNotConnected(BzrError):
 
 
1586
    _fmt = """The medium '%(medium)s' is not connected."""
 
 
1588
    internal_error = True
 
 
1590
    def __init__(self, medium):
 
 
1591
        self.medium = medium
 
 
1594
class MustUseDecorated(Exception):
 
 
1596
    _fmt = "A decorating function has requested its original command be used."
 
 
1599
class NoBundleFound(BzrError):
 
 
1601
    _fmt = "No bundle was found in %(filename)s"
 
 
1603
    def __init__(self, filename):
 
 
1604
        BzrError.__init__(self)
 
 
1605
        self.filename = filename
 
 
1608
class BundleNotSupported(BzrError):
 
 
1610
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
 
1612
    def __init__(self, version, msg):
 
 
1613
        BzrError.__init__(self)
 
 
1614
        self.version = version
 
 
1618
class MissingText(BzrError):
 
 
1620
    _fmt = ("Branch %(base)s is missing revision"
 
 
1621
            " %(text_revision)s of %(file_id)s")
 
 
1623
    def __init__(self, branch, text_revision, file_id):
 
 
1624
        BzrError.__init__(self)
 
 
1625
        self.branch = branch
 
 
1626
        self.base = branch.base
 
 
1627
        self.text_revision = text_revision
 
 
1628
        self.file_id = file_id
 
 
1630
class DuplicateFileId(BzrError):
 
 
1632
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
 
1634
    def __init__(self, file_id, entry):
 
 
1635
        BzrError.__init__(self)
 
 
1636
        self.file_id = file_id
 
 
1640
class DuplicateKey(BzrError):
 
 
1642
    _fmt = "Key %(key)s is already present in map"
 
 
1645
class DuplicateHelpPrefix(BzrError):
 
 
1647
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
 
1649
    def __init__(self, prefix):
 
 
1650
        self.prefix = prefix
 
 
1653
class MalformedTransform(BzrError):
 
 
1655
    _fmt = "Tree transform is malformed %(conflicts)r"
 
 
1658
class NoFinalPath(BzrError):
 
 
1660
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
 
1661
            "file-id: %(file_id)r\n"
 
 
1662
            "root trans-id: %(root_trans_id)r\n")
 
 
1664
    def __init__(self, trans_id, transform):
 
 
1665
        self.trans_id = trans_id
 
 
1666
        self.file_id = transform.final_file_id(trans_id)
 
 
1667
        self.root_trans_id = transform.root
 
 
1670
class BzrBadParameter(BzrError):
 
 
1672
    _fmt = "Bad parameter: %(param)r"
 
 
1674
    internal_error = True
 
 
1676
    # This exception should never be thrown, but it is a base class for all
 
 
1677
    # parameter-to-function errors.
 
 
1679
    def __init__(self, param):
 
 
1680
        BzrError.__init__(self)
 
 
1684
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1686
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
 
1689
class ReusingTransform(BzrError):
 
 
1691
    _fmt = "Attempt to reuse a transform that has already been applied."
 
 
1694
class CantMoveRoot(BzrError):
 
 
1696
    _fmt = "Moving the root directory is not supported at this time"
 
 
1699
class BzrMoveFailedError(BzrError):
 
 
1701
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1703
    def __init__(self, from_path='', to_path='', extra=None):
 
 
1704
        BzrError.__init__(self)
 
 
1706
            self.extra = ': ' + str(extra)
 
 
1710
        has_from = len(from_path) > 0
 
 
1711
        has_to = len(to_path) > 0
 
 
1713
            self.from_path = osutils.splitpath(from_path)[-1]
 
 
1718
            self.to_path = osutils.splitpath(to_path)[-1]
 
 
1723
        if has_from and has_to:
 
 
1724
            self.operator = " =>"
 
 
1726
            self.from_path = "from " + from_path
 
 
1728
            self.operator = "to"
 
 
1730
            self.operator = "file"
 
 
1733
class BzrRenameFailedError(BzrMoveFailedError):
 
 
1735
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1737
    def __init__(self, from_path, to_path, extra=None):
 
 
1738
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
 
1740
class BzrRemoveChangedFilesError(BzrError):
 
 
1741
    """Used when user is trying to remove changed files."""
 
 
1743
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
 
 
1744
        "Use --keep to not delete them, or --force to delete them regardless.")
 
 
1746
    def __init__(self, tree_delta):
 
 
1747
        BzrError.__init__(self)
 
 
1748
        self.changes_as_text = tree_delta.get_changes_as_text()
 
 
1749
        #self.paths_as_string = '\n'.join(changed_files)
 
 
1750
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
 
1753
class BzrBadParameterNotString(BzrBadParameter):
 
 
1755
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
 
1758
class BzrBadParameterMissing(BzrBadParameter):
 
 
1760
    _fmt = "Parameter $(param)s is required but not present."
 
 
1763
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1765
    _fmt = ("Parameter %(param)s is unicode but"
 
 
1766
            " only byte-strings are permitted.")
 
 
1769
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1771
    _fmt = "Parameter %(param)s contains a newline."
 
 
1774
class DependencyNotPresent(BzrError):
 
 
1776
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
 
1778
    def __init__(self, library, error):
 
 
1779
        BzrError.__init__(self, library=library, error=error)
 
 
1782
class ParamikoNotPresent(DependencyNotPresent):
 
 
1784
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
 
1786
    def __init__(self, error):
 
 
1787
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1790
class PointlessMerge(BzrError):
 
 
1792
    _fmt = "Nothing to merge."
 
 
1795
class UninitializableFormat(BzrError):
 
 
1797
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
 
1799
    def __init__(self, format):
 
 
1800
        BzrError.__init__(self)
 
 
1801
        self.format = format
 
 
1804
class BadConversionTarget(BzrError):
 
 
1806
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
 
1808
    def __init__(self, problem, format):
 
 
1809
        BzrError.__init__(self)
 
 
1810
        self.problem = problem
 
 
1811
        self.format = format
 
 
1814
class NoDiff(BzrError):
 
 
1816
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
 
1818
    def __init__(self, msg):
 
 
1819
        BzrError.__init__(self, msg=msg)
 
 
1822
class NoDiff3(BzrError):
 
 
1824
    _fmt = "Diff3 is not installed on this machine."
 
 
1827
class ExistingLimbo(BzrError):
 
 
1829
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1830
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1831
    keep, and delete it when you are done."""
 
 
1833
    def __init__(self, limbo_dir):
 
 
1834
       BzrError.__init__(self)
 
 
1835
       self.limbo_dir = limbo_dir
 
 
1838
class ImmortalLimbo(BzrError):
 
 
1840
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
 
1841
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1842
    keep, and delete it when you are done."""
 
 
1844
    def __init__(self, limbo_dir):
 
 
1845
       BzrError.__init__(self)
 
 
1846
       self.limbo_dir = limbo_dir
 
 
1849
class OutOfDateTree(BzrError):
 
 
1851
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
 
1853
    def __init__(self, tree):
 
 
1854
        BzrError.__init__(self)
 
 
1858
class PublicBranchOutOfDate(BzrError):
 
 
1860
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
 
1863
    def __init__(self, public_location, revstring):
 
 
1864
        import bzrlib.urlutils as urlutils
 
 
1865
        public_location = urlutils.unescape_for_display(public_location,
 
 
1867
        BzrError.__init__(self, public_location=public_location,
 
 
1868
                          revstring=revstring)
 
 
1871
class MergeModifiedFormatError(BzrError):
 
 
1873
    _fmt = "Error in merge modified format"
 
 
1876
class ConflictFormatError(BzrError):
 
 
1878
    _fmt = "Format error in conflict listings"
 
 
1881
class CorruptRepository(BzrError):
 
 
1883
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
 
1884
            "Please run bzr reconcile on this repository.")
 
 
1886
    def __init__(self, repo):
 
 
1887
        BzrError.__init__(self)
 
 
1888
        self.repo_path = repo.bzrdir.root_transport.base
 
 
1891
class UpgradeRequired(BzrError):
 
 
1893
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
 
1895
    def __init__(self, path):
 
 
1896
        BzrError.__init__(self)
 
 
1900
class LocalRequiresBoundBranch(BzrError):
 
 
1902
    _fmt = "Cannot perform local-only commits on unbound branches."
 
 
1905
class MissingProgressBarFinish(BzrError):
 
 
1907
    _fmt = "A nested progress bar was not 'finished' correctly."
 
 
1910
class InvalidProgressBarType(BzrError):
 
 
1912
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
 
1913
            " is not a supported type Select one of: %(valid_types)s")
 
 
1915
    def __init__(self, bar_type, valid_types):
 
 
1916
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
1919
class UnsupportedOperation(BzrError):
 
 
1921
    _fmt = ("The method %(mname)s is not supported on"
 
 
1922
            " objects of type %(tname)s.")
 
 
1924
    def __init__(self, method, method_self):
 
 
1925
        self.method = method
 
 
1926
        self.mname = method.__name__
 
 
1927
        self.tname = type(method_self).__name__
 
 
1930
class CannotSetRevisionId(UnsupportedOperation):
 
 
1931
    """Raised when a commit is attempting to set a revision id but cant."""
 
 
1934
class NonAsciiRevisionId(UnsupportedOperation):
 
 
1935
    """Raised when a commit is attempting to set a non-ascii revision id
 
 
1940
class BinaryFile(BzrError):
 
 
1942
    _fmt = "File is binary but should be text."
 
 
1945
class IllegalPath(BzrError):
 
 
1947
    _fmt = "The path %(path)s is not permitted on this platform"
 
 
1949
    def __init__(self, path):
 
 
1950
        BzrError.__init__(self)
 
 
1954
class TestamentMismatch(BzrError):
 
 
1956
    _fmt = """Testament did not match expected value.
 
 
1957
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
 
1960
    def __init__(self, revision_id, expected, measured):
 
 
1961
        self.revision_id = revision_id
 
 
1962
        self.expected = expected
 
 
1963
        self.measured = measured
 
 
1966
class NotABundle(BzrError):
 
 
1968
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
 
1970
    def __init__(self, text):
 
 
1971
        BzrError.__init__(self)
 
 
1975
class BadBundle(BzrError): 
 
 
1977
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
 
1979
    def __init__(self, text):
 
 
1980
        BzrError.__init__(self)
 
 
1984
class MalformedHeader(BadBundle): 
 
 
1986
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
 
1989
class MalformedPatches(BadBundle): 
 
 
1991
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
 
1994
class MalformedFooter(BadBundle): 
 
 
1996
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
 
1999
class UnsupportedEOLMarker(BadBundle):
 
 
2001
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
 
2004
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
 
2005
        # but for this there is not
 
 
2006
        BzrError.__init__(self)
 
 
2009
class IncompatibleBundleFormat(BzrError):
 
 
2011
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
 
2013
    def __init__(self, bundle_format, other):
 
 
2014
        BzrError.__init__(self)
 
 
2015
        self.bundle_format = bundle_format
 
 
2019
class BadInventoryFormat(BzrError):
 
 
2021
    _fmt = "Root class for inventory serialization errors"
 
 
2024
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
2026
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
 
2028
    def __init__(self, msg):
 
 
2029
        BadInventoryFormat.__init__(self, msg=msg)
 
 
2032
class RootNotRich(BzrError):
 
 
2034
    _fmt = """This operation requires rich root data storage"""
 
 
2037
class NoSmartMedium(BzrError):
 
 
2039
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
 
2041
    internal_error = True
 
 
2043
    def __init__(self, transport):
 
 
2044
        self.transport = transport
 
 
2047
class NoSmartServer(NotBranchError):
 
 
2049
    _fmt = "No smart server available at %(url)s"
 
 
2051
    def __init__(self, url):
 
 
2055
class UnknownSSH(BzrError):
 
 
2057
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
 
2059
    def __init__(self, vendor):
 
 
2060
        BzrError.__init__(self)
 
 
2061
        self.vendor = vendor
 
 
2064
class SSHVendorNotFound(BzrError):
 
 
2066
    _fmt = ("Don't know how to handle SSH connections."
 
 
2067
            " Please set BZR_SSH environment variable.")
 
 
2070
class GhostRevisionUnusableHere(BzrError):
 
 
2072
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
 
2074
    def __init__(self, revision_id):
 
 
2075
        BzrError.__init__(self)
 
 
2076
        self.revision_id = revision_id
 
 
2079
class IllegalUseOfScopeReplacer(BzrError):
 
 
2081
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
 
2082
            " %(msg)s%(extra)s")
 
 
2084
    internal_error = True
 
 
2086
    def __init__(self, name, msg, extra=None):
 
 
2087
        BzrError.__init__(self)
 
 
2091
            self.extra = ': ' + str(extra)
 
 
2096
class InvalidImportLine(BzrError):
 
 
2098
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
 
2100
    internal_error = True
 
 
2102
    def __init__(self, text, msg):
 
 
2103
        BzrError.__init__(self)
 
 
2108
class ImportNameCollision(BzrError):
 
 
2110
    _fmt = ("Tried to import an object to the same name as"
 
 
2111
            " an existing object. %(name)s")
 
 
2113
    internal_error = True
 
 
2115
    def __init__(self, name):
 
 
2116
        BzrError.__init__(self)
 
 
2120
class NotAMergeDirective(BzrError):
 
 
2121
    """File starting with %(firstline)r is not a merge directive"""
 
 
2122
    def __init__(self, firstline):
 
 
2123
        BzrError.__init__(self, firstline=firstline)
 
 
2126
class NoMergeSource(BzrError):
 
 
2127
    """Raise if no merge source was specified for a merge directive"""
 
 
2129
    _fmt = "A merge directive must provide either a bundle or a public"\
 
 
2133
class IllegalMergeDirectivePayload(BzrError):
 
 
2134
    """A merge directive contained something other than a patch or bundle"""
 
 
2136
    _fmt = "Bad merge directive payload %(start)r"
 
 
2138
    def __init__(self, start):
 
 
2143
class PatchVerificationFailed(BzrError):
 
 
2144
    """A patch from a merge directive could not be verified"""
 
 
2146
    _fmt = "Preview patch does not match requested changes."
 
 
2149
class PatchMissing(BzrError):
 
 
2150
    """Raise a patch type was specified but no patch supplied"""
 
 
2152
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
 
2154
    def __init__(self, patch_type):
 
 
2155
        BzrError.__init__(self)
 
 
2156
        self.patch_type = patch_type
 
 
2159
class UnsupportedInventoryKind(BzrError):
 
 
2161
    _fmt = """Unsupported entry kind %(kind)s"""
 
 
2163
    def __init__(self, kind):
 
 
2167
class BadSubsumeSource(BzrError):
 
 
2169
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
 
 
2171
    def __init__(self, tree, other_tree, reason):
 
 
2173
        self.other_tree = other_tree
 
 
2174
        self.reason = reason
 
 
2177
class SubsumeTargetNeedsUpgrade(BzrError):
 
 
2179
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
 
2181
    def __init__(self, other_tree):
 
 
2182
        self.other_tree = other_tree
 
 
2185
class BadReferenceTarget(BzrError):
 
 
2187
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
 
2189
    internal_error = True
 
 
2191
    def __init__(self, tree, other_tree, reason):
 
 
2193
        self.other_tree = other_tree
 
 
2194
        self.reason = reason
 
 
2197
class NoSuchTag(BzrError):
 
 
2199
    _fmt = "No such tag: %(tag_name)s"
 
 
2201
    def __init__(self, tag_name):
 
 
2202
        self.tag_name = tag_name
 
 
2205
class TagsNotSupported(BzrError):
 
 
2207
    _fmt = ("Tags not supported by %(branch)s;"
 
 
2208
            " you may be able to use bzr upgrade --dirstate-tags.")
 
 
2210
    def __init__(self, branch):
 
 
2211
        self.branch = branch
 
 
2214
class TagAlreadyExists(BzrError):
 
 
2216
    _fmt = "Tag %(tag_name)s already exists."
 
 
2218
    def __init__(self, tag_name):
 
 
2219
        self.tag_name = tag_name
 
 
2222
class MalformedBugIdentifier(BzrError):
 
 
2224
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
 
2226
    def __init__(self, bug_id, reason):
 
 
2227
        self.bug_id = bug_id
 
 
2228
        self.reason = reason
 
 
2231
class UnknownBugTrackerAbbreviation(BzrError):
 
 
2233
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
 
2236
    def __init__(self, abbreviation, branch):
 
 
2237
        self.abbreviation = abbreviation
 
 
2238
        self.branch = branch
 
 
2241
class UnexpectedSmartServerResponse(BzrError):
 
 
2243
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
 
2245
    def __init__(self, response_tuple):
 
 
2246
        self.response_tuple = response_tuple
 
 
2249
class ContainerError(BzrError):
 
 
2250
    """Base class of container errors."""
 
 
2253
class UnknownContainerFormatError(ContainerError):
 
 
2255
    _fmt = "Unrecognised container format: %(container_format)r"
 
 
2257
    def __init__(self, container_format):
 
 
2258
        self.container_format = container_format
 
 
2261
class UnexpectedEndOfContainerError(ContainerError):
 
 
2263
    _fmt = "Unexpected end of container stream"
 
 
2265
    internal_error = False
 
 
2268
class UnknownRecordTypeError(ContainerError):
 
 
2270
    _fmt = "Unknown record type: %(record_type)r"
 
 
2272
    def __init__(self, record_type):
 
 
2273
        self.record_type = record_type
 
 
2276
class InvalidRecordError(ContainerError):
 
 
2278
    _fmt = "Invalid record: %(reason)s"
 
 
2280
    def __init__(self, reason):
 
 
2281
        self.reason = reason
 
 
2284
class ContainerHasExcessDataError(ContainerError):
 
 
2286
    _fmt = "Container has data after end marker: %(excess)r"
 
 
2288
    def __init__(self, excess):
 
 
2289
        self.excess = excess
 
 
2292
class DuplicateRecordNameError(ContainerError):
 
 
2294
    _fmt = "Container has multiple records with the same name: \"%(name)s\""
 
 
2296
    def __init__(self, name):
 
 
2300
class NoDestinationAddress(BzrError):
 
 
2302
    _fmt = "Message does not have a destination address."
 
 
2304
    internal_error = True
 
 
2307
class SMTPError(BzrError):
 
 
2309
    _fmt = "SMTP error: %(error)s"
 
 
2311
    def __init__(self, error):
 
 
2315
class SMTPConnectionRefused(SMTPError):
 
 
2317
    _fmt = "SMTP connection to %(host)s refused"
 
 
2319
    def __init__(self, error, host):
 
 
2324
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
 
2326
    _fmt = "Please specify smtp_server.  No server at default %(host)s."