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 InvalidEntryName(BzrError):
 
 
191
    _fmt = "Invalid entry name: %(name)s"
 
 
193
    internal_error = True
 
 
195
    def __init__(self, name):
 
 
196
        BzrError.__init__(self)
 
 
200
class InvalidRevisionNumber(BzrError):
 
 
202
    _fmt = "Invalid revision number %(revno)s"
 
 
204
    def __init__(self, revno):
 
 
205
        BzrError.__init__(self)
 
 
209
class InvalidRevisionId(BzrError):
 
 
211
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
 
213
    def __init__(self, revision_id, branch):
 
 
214
        # branch can be any string or object with __str__ defined
 
 
215
        BzrError.__init__(self)
 
 
216
        self.revision_id = revision_id
 
 
219
class ReservedId(BzrError):
 
 
221
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
 
223
    def __init__(self, revision_id):
 
 
224
        self.revision_id = revision_id
 
 
227
class NoHelpTopic(BzrError):
 
 
229
    _fmt = ("No help could be found for '%(topic)s'. "
 
 
230
        "Please use 'bzr help topics' to obtain a list of topics.")
 
 
232
    def __init__(self, topic):
 
 
236
class NoSuchId(BzrError):
 
 
238
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
 
240
    def __init__(self, tree, file_id):
 
 
241
        BzrError.__init__(self)
 
 
242
        self.file_id = file_id
 
 
246
class InventoryModified(BzrError):
 
 
248
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
 
249
            " so a clean inventory cannot be read without data loss.")
 
 
251
    internal_error = True
 
 
253
    def __init__(self, tree):
 
 
257
class NoWorkingTree(BzrError):
 
 
259
    _fmt = "No WorkingTree exists for %(base)s."
 
 
261
    def __init__(self, base):
 
 
262
        BzrError.__init__(self)
 
 
266
class NotBuilding(BzrError):
 
 
268
    _fmt = "Not currently building a tree."
 
 
271
class NotLocalUrl(BzrError):
 
 
273
    _fmt = "%(url)s is not a local path."
 
 
275
    def __init__(self, url):
 
 
279
class WorkingTreeAlreadyPopulated(BzrError):
 
 
281
    _fmt = """Working tree already populated in %(base)s"""
 
 
283
    internal_error = True
 
 
285
    def __init__(self, base):
 
 
288
class BzrCommandError(BzrError):
 
 
289
    """Error from user command"""
 
 
291
    internal_error = False
 
 
293
    # Error from malformed user command; please avoid raising this as a
 
 
294
    # generic exception not caused by user input.
 
 
296
    # I think it's a waste of effort to differentiate between errors that
 
 
297
    # are not intended to be caught anyway.  UI code need not subclass
 
 
298
    # BzrCommandError, and non-UI code should not throw a subclass of
 
 
299
    # BzrCommandError.  ADHB 20051211
 
 
300
    def __init__(self, msg):
 
 
301
        # Object.__str__() must return a real string
 
 
302
        # returning a Unicode string is a python error.
 
 
303
        if isinstance(msg, unicode):
 
 
304
            self.msg = msg.encode('utf8')
 
 
312
class NotWriteLocked(BzrError):
 
 
314
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
 
316
    def __init__(self, not_locked):
 
 
317
        self.not_locked = not_locked
 
 
320
class BzrOptionError(BzrCommandError):
 
 
322
    _fmt = "Error in command line options"
 
 
325
class BadOptionValue(BzrError):
 
 
327
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
 
329
    def __init__(self, name, value):
 
 
330
        BzrError.__init__(self, name=name, value=value)
 
 
333
class StrictCommitFailed(BzrError):
 
 
335
    _fmt = "Commit refused because there are unknown files in the tree"
 
 
338
# XXX: Should be unified with TransportError; they seem to represent the
 
 
340
class PathError(BzrError):
 
 
342
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
 
344
    def __init__(self, path, extra=None):
 
 
345
        BzrError.__init__(self)
 
 
348
            self.extra = ': ' + str(extra)
 
 
353
class NoSuchFile(PathError):
 
 
355
    _fmt = "No such file: %(path)r%(extra)s"
 
 
358
class FileExists(PathError):
 
 
360
    _fmt = "File exists: %(path)r%(extra)s"
 
 
363
class RenameFailedFilesExist(BzrError):
 
 
364
    """Used when renaming and both source and dest exist."""
 
 
366
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
 
369
    def __init__(self, source, dest, extra=None):
 
 
370
        BzrError.__init__(self)
 
 
371
        self.source = str(source)
 
 
372
        self.dest = str(dest)
 
 
374
            self.extra = ' ' + str(extra)
 
 
379
class NotADirectory(PathError):
 
 
381
    _fmt = "%(path)r is not a directory %(extra)s"
 
 
384
class NotInWorkingDirectory(PathError):
 
 
386
    _fmt = "%(path)r is not in the working directory %(extra)s"
 
 
389
class DirectoryNotEmpty(PathError):
 
 
391
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
 
394
class ReadingCompleted(BzrError):
 
 
396
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
 
397
            "called upon it - the request has been completed and no more "
 
 
400
    internal_error = True
 
 
402
    def __init__(self, request):
 
 
403
        self.request = request
 
 
406
class ResourceBusy(PathError):
 
 
408
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
 
411
class PermissionDenied(PathError):
 
 
413
    _fmt = "Permission denied: %(path)r%(extra)s"
 
 
416
class InvalidURL(PathError):
 
 
418
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
 
421
class InvalidURLJoin(PathError):
 
 
423
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
 
425
    def __init__(self, msg, base, args):
 
 
426
        PathError.__init__(self, base, msg)
 
 
427
        self.args = [base] + list(args)
 
 
430
class UnknownHook(BzrError):
 
 
432
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
 
434
    def __init__(self, hook_type, hook_name):
 
 
435
        BzrError.__init__(self)
 
 
436
        self.type = hook_type
 
 
437
        self.hook = hook_name
 
 
440
class UnsupportedProtocol(PathError):
 
 
442
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
 
444
    def __init__(self, url, extra):
 
 
445
        PathError.__init__(self, url, extra=extra)
 
 
448
class ShortReadvError(PathError):
 
 
450
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
 
 
451
            " at %(offset)s for %(path)s%(extra)s")
 
 
453
    internal_error = True
 
 
455
    def __init__(self, path, offset, length, actual, extra=None):
 
 
456
        PathError.__init__(self, path, extra=extra)
 
 
462
class PathNotChild(BzrError):
 
 
464
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
 
466
    internal_error = True
 
 
468
    def __init__(self, path, base, extra=None):
 
 
469
        BzrError.__init__(self)
 
 
473
            self.extra = ': ' + str(extra)
 
 
478
class InvalidNormalization(PathError):
 
 
480
    _fmt = "Path %(path)r is not unicode normalized"
 
 
483
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
484
# the exception object is a bit undesirable.
 
 
485
# TODO: Probably this behavior of should be a common superclass 
 
 
486
class NotBranchError(PathError):
 
 
488
    _fmt = "Not a branch: %(path)s"
 
 
490
    def __init__(self, path):
 
 
491
       import bzrlib.urlutils as urlutils
 
 
492
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
495
class NoSubmitBranch(PathError):
 
 
497
    _fmt = 'No submit branch available for branch "%(path)s"'
 
 
499
    def __init__(self, branch):
 
 
500
       import bzrlib.urlutils as urlutils
 
 
501
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
 
504
class AlreadyBranchError(PathError):
 
 
506
    _fmt = "Already a branch: %(path)s."
 
 
509
class BranchExistsWithoutWorkingTree(PathError):
 
 
511
    _fmt = "Directory contains a branch, but no working tree \
 
 
512
(use bzr checkout if you wish to build a working tree): %(path)s"
 
 
515
class AtomicFileAlreadyClosed(PathError):
 
 
517
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
 
520
    def __init__(self, path, function):
 
 
521
        PathError.__init__(self, path=path, extra=None)
 
 
522
        self.function = function
 
 
525
class InaccessibleParent(PathError):
 
 
527
    _fmt = ("Parent not accessible given base %(base)s and"
 
 
528
            " relative path %(path)s")
 
 
530
    def __init__(self, path, base):
 
 
531
        PathError.__init__(self, path)
 
 
535
class NoRepositoryPresent(BzrError):
 
 
537
    _fmt = "No repository present: %(path)r"
 
 
538
    def __init__(self, bzrdir):
 
 
539
        BzrError.__init__(self)
 
 
540
        self.path = bzrdir.transport.clone('..').base
 
 
543
class FileInWrongBranch(BzrError):
 
 
545
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
 
547
    def __init__(self, branch, path):
 
 
548
        BzrError.__init__(self)
 
 
550
        self.branch_base = branch.base
 
 
554
class UnsupportedFormatError(BzrError):
 
 
556
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
 
 
559
class UnknownFormatError(BzrError):
 
 
561
    _fmt = "Unknown branch format: %(format)r"
 
 
564
class IncompatibleFormat(BzrError):
 
 
566
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
 
568
    def __init__(self, format, bzrdir_format):
 
 
569
        BzrError.__init__(self)
 
 
571
        self.bzrdir = bzrdir_format
 
 
574
class IncompatibleRepositories(BzrError):
 
 
576
    _fmt = "Repository %(target)s is not compatible with repository"\
 
 
579
    def __init__(self, source, target):
 
 
580
        BzrError.__init__(self, target=target, source=source)
 
 
583
class IncompatibleRevision(BzrError):
 
 
585
    _fmt = "Revision is not compatible with %(repo_format)s"
 
 
587
    def __init__(self, repo_format):
 
 
588
        BzrError.__init__(self)
 
 
589
        self.repo_format = repo_format
 
 
592
class AlreadyVersionedError(BzrError):
 
 
593
    """Used when a path is expected not to be versioned, but it is."""
 
 
595
    _fmt = "%(context_info)s%(path)s is already versioned"
 
 
597
    def __init__(self, path, context_info=None):
 
 
598
        """Construct a new AlreadyVersionedError.
 
 
600
        :param path: This is the path which is versioned,
 
 
601
        which should be in a user friendly form.
 
 
602
        :param context_info: If given, this is information about the context,
 
 
603
        which could explain why this is expected to not be versioned.
 
 
605
        BzrError.__init__(self)
 
 
607
        if context_info is None:
 
 
608
            self.context_info = ''
 
 
610
            self.context_info = context_info + ". "
 
 
613
class NotVersionedError(BzrError):
 
 
614
    """Used when a path is expected to be versioned, but it is not."""
 
 
616
    _fmt = "%(context_info)s%(path)s is not versioned"
 
 
618
    def __init__(self, path, context_info=None):
 
 
619
        """Construct a new NotVersionedError.
 
 
621
        :param path: This is the path which is not versioned,
 
 
622
        which should be in a user friendly form.
 
 
623
        :param context_info: If given, this is information about the context,
 
 
624
        which could explain why this is expected to be versioned.
 
 
626
        BzrError.__init__(self)
 
 
628
        if context_info is None:
 
 
629
            self.context_info = ''
 
 
631
            self.context_info = context_info + ". "
 
 
634
class PathsNotVersionedError(BzrError):
 
 
635
    """Used when reporting several paths which are not versioned"""
 
 
637
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
 
639
    def __init__(self, paths):
 
 
640
        from bzrlib.osutils import quotefn
 
 
641
        BzrError.__init__(self)
 
 
643
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
646
class PathsDoNotExist(BzrError):
 
 
648
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
 
650
    # used when reporting that paths are neither versioned nor in the working
 
 
653
    def __init__(self, paths, extra=None):
 
 
655
        from bzrlib.osutils import quotefn
 
 
656
        BzrError.__init__(self)
 
 
658
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
660
            self.extra = ': ' + str(extra)
 
 
665
class BadFileKindError(BzrError):
 
 
667
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
 
669
    def __init__(self, filename, kind):
 
 
670
        BzrError.__init__(self, filename=filename, kind=kind)
 
 
673
class ForbiddenControlFileError(BzrError):
 
 
675
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
 
678
class LockError(BzrError):
 
 
680
    _fmt = "Lock error: %(msg)s"
 
 
682
    internal_error = True
 
 
684
    # All exceptions from the lock/unlock functions should be from
 
 
685
    # this exception class.  They will be translated as necessary. The
 
 
686
    # original exception is available as e.original_error
 
 
688
    # New code should prefer to raise specific subclasses
 
 
689
    def __init__(self, message):
 
 
690
        # Python 2.5 uses a slot for StandardError.message,
 
 
691
        # so use a different variable name
 
 
692
        # so it is exposed in self.__dict__
 
 
696
class LockActive(LockError):
 
 
698
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
 
700
    internal_error = False
 
 
702
    def __init__(self, lock_description):
 
 
703
        self.lock_description = lock_description
 
 
706
class CommitNotPossible(LockError):
 
 
708
    _fmt = "A commit was attempted but we do not have a write lock open."
 
 
714
class AlreadyCommitted(LockError):
 
 
716
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
 
722
class ReadOnlyError(LockError):
 
 
724
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
 
726
    # TODO: There should also be an error indicating that you need a write
 
 
727
    # lock and don't have any lock at all... mbp 20070226
 
 
729
    def __init__(self, obj):
 
 
733
class ReadOnlyLockError(LockError):
 
 
735
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
 
737
    def __init__(self, fname, msg):
 
 
738
        LockError.__init__(self, '')
 
 
743
class OutSideTransaction(BzrError):
 
 
745
    _fmt = ("A transaction related operation was attempted after"
 
 
746
            " the transaction finished.")
 
 
749
class ObjectNotLocked(LockError):
 
 
751
    _fmt = "%(obj)r is not locked"
 
 
753
    # this can indicate that any particular object is not locked; see also
 
 
754
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
755
    # the caller -- perhaps they should be unified.
 
 
756
    def __init__(self, obj):
 
 
760
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
762
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
 
764
    def __init__(self, obj):
 
 
768
class UnlockableTransport(LockError):
 
 
770
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
 
772
    def __init__(self, transport):
 
 
773
        self.transport = transport
 
 
776
class LockContention(LockError):
 
 
778
    _fmt = "Could not acquire lock %(lock)s"
 
 
779
    # TODO: show full url for lock, combining the transport and relative
 
 
782
    internal_error = False
 
 
784
    def __init__(self, lock):
 
 
788
class LockBroken(LockError):
 
 
790
    _fmt = ("Lock was broken while still open: %(lock)s"
 
 
791
            " - check storage consistency!")
 
 
793
    internal_error = False
 
 
795
    def __init__(self, lock):
 
 
799
class LockBreakMismatch(LockError):
 
 
801
    _fmt = ("Lock was released and re-acquired before being broken:"
 
 
802
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
 
804
    internal_error = False
 
 
806
    def __init__(self, lock, holder, target):
 
 
812
class LockNotHeld(LockError):
 
 
814
    _fmt = "Lock not held: %(lock)s"
 
 
816
    internal_error = False
 
 
818
    def __init__(self, lock):
 
 
822
class TokenLockingNotSupported(LockError):
 
 
824
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
 
826
    internal_error = True
 
 
828
    def __init__(self, obj):
 
 
832
class TokenMismatch(LockBroken):
 
 
834
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
 
836
    internal_error = True
 
 
838
    def __init__(self, given_token, lock_token):
 
 
839
        self.given_token = given_token
 
 
840
        self.lock_token = lock_token
 
 
843
class PointlessCommit(BzrError):
 
 
845
    _fmt = "No changes to commit"
 
 
848
class CannotCommitSelectedFileMerge(BzrError):
 
 
850
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
 
851
        ' files %(files_str)s'
 
 
853
    def __init__(self, files):
 
 
854
        files_str = ', '.join(files)
 
 
855
        BzrError.__init__(self, files=files, files_str=files_str)
 
 
858
class UpgradeReadonly(BzrError):
 
 
860
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
 
863
class UpToDateFormat(BzrError):
 
 
865
    _fmt = "The branch format %(format)s is already at the most recent format."
 
 
867
    def __init__(self, format):
 
 
868
        BzrError.__init__(self)
 
 
872
class StrictCommitFailed(Exception):
 
 
874
    _fmt = "Commit refused because there are unknowns in the tree."
 
 
877
class NoSuchRevision(BzrError):
 
 
879
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
 
881
    internal_error = True
 
 
883
    def __init__(self, branch, revision):
 
 
884
        BzrError.__init__(self, branch=branch, revision=revision)
 
 
887
class NotLeftParentDescendant(BzrError):
 
 
889
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
 
890
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
 
892
    internal_error = True
 
 
894
    def __init__(self, branch, old_revision, new_revision):
 
 
895
        BzrError.__init__(self, branch_location=branch.base,
 
 
896
                          old_revision=old_revision,
 
 
897
                          new_revision=new_revision)
 
 
900
class NoSuchRevisionSpec(BzrError):
 
 
902
    _fmt = "No namespace registered for string: %(spec)r"
 
 
904
    def __init__(self, spec):
 
 
905
        BzrError.__init__(self, spec=spec)
 
 
908
class NoSuchRevisionInTree(NoSuchRevision):
 
 
909
    """When using Tree.revision_tree, and the revision is not accessible."""
 
 
911
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
 
 
913
    def __init__(self, tree, revision_id):
 
 
914
        BzrError.__init__(self)
 
 
916
        self.revision_id = revision_id
 
 
919
class InvalidRevisionSpec(BzrError):
 
 
921
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
 
922
            " %(branch)s%(extra)s")
 
 
924
    def __init__(self, spec, branch, extra=None):
 
 
925
        BzrError.__init__(self, branch=branch, spec=spec)
 
 
927
            self.extra = '\n' + str(extra)
 
 
932
class HistoryMissing(BzrError):
 
 
934
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
 
937
class AppendRevisionsOnlyViolation(BzrError):
 
 
939
    _fmt = ('Operation denied because it would change the main history,'
 
 
940
           ' which is not permitted by the append_revisions_only setting on'
 
 
941
           ' branch "%(location)s".')
 
 
943
    def __init__(self, location):
 
 
944
       import bzrlib.urlutils as urlutils
 
 
945
       location = urlutils.unescape_for_display(location, 'ascii')
 
 
946
       BzrError.__init__(self, location=location)
 
 
949
class DivergedBranches(BzrError):
 
 
951
    _fmt = ("These branches have diverged."
 
 
952
            " Use the merge command to reconcile them.")
 
 
954
    internal_error = False
 
 
956
    def __init__(self, branch1, branch2):
 
 
957
        self.branch1 = branch1
 
 
958
        self.branch2 = branch2
 
 
961
class NotLefthandHistory(BzrError):
 
 
963
    _fmt = "Supplied history does not follow left-hand parents"
 
 
965
    internal_error = True
 
 
967
    def __init__(self, history):
 
 
968
        BzrError.__init__(self, history=history)
 
 
971
class UnrelatedBranches(BzrError):
 
 
973
    _fmt = ("Branches have no common ancestor, and"
 
 
974
            " no merge base revision was specified.")
 
 
976
    internal_error = False
 
 
979
class NoCommonAncestor(BzrError):
 
 
981
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
983
    def __init__(self, revision_a, revision_b):
 
 
984
        self.revision_a = revision_a
 
 
985
        self.revision_b = revision_b
 
 
988
class NoCommonRoot(BzrError):
 
 
990
    _fmt = ("Revisions are not derived from the same root: "
 
 
991
           "%(revision_a)s %(revision_b)s.")
 
 
993
    def __init__(self, revision_a, revision_b):
 
 
994
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
 
997
class NotAncestor(BzrError):
 
 
999
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
 
1001
    def __init__(self, rev_id, not_ancestor_id):
 
 
1002
        BzrError.__init__(self, rev_id=rev_id,
 
 
1003
            not_ancestor_id=not_ancestor_id)
 
 
1006
class InstallFailed(BzrError):
 
 
1008
    def __init__(self, revisions):
 
 
1009
        revision_str = ", ".join(str(r) for r in revisions)
 
 
1010
        msg = "Could not install revisions:\n%s" % revision_str
 
 
1011
        BzrError.__init__(self, msg)
 
 
1012
        self.revisions = revisions
 
 
1015
class AmbiguousBase(BzrError):
 
 
1017
    def __init__(self, bases):
 
 
1018
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
1020
        msg = ("The correct base is unclear, because %s are all equally close"
 
 
1022
        BzrError.__init__(self, msg)
 
 
1026
class NoCommits(BzrError):
 
 
1028
    _fmt = "Branch %(branch)s has no commits."
 
 
1030
    def __init__(self, branch):
 
 
1031
        BzrError.__init__(self, branch=branch)
 
 
1034
class UnlistableStore(BzrError):
 
 
1036
    def __init__(self, store):
 
 
1037
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
1041
class UnlistableBranch(BzrError):
 
 
1043
    def __init__(self, br):
 
 
1044
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
1047
class BoundBranchOutOfDate(BzrError):
 
 
1049
    _fmt = ("Bound branch %(branch)s is out of date"
 
 
1050
            " with master branch %(master)s.")
 
 
1052
    def __init__(self, branch, master):
 
 
1053
        BzrError.__init__(self)
 
 
1054
        self.branch = branch
 
 
1055
        self.master = master
 
 
1058
class CommitToDoubleBoundBranch(BzrError):
 
 
1060
    _fmt = ("Cannot commit to branch %(branch)s."
 
 
1061
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
 
1063
    def __init__(self, branch, master, remote):
 
 
1064
        BzrError.__init__(self)
 
 
1065
        self.branch = branch
 
 
1066
        self.master = master
 
 
1067
        self.remote = remote
 
 
1070
class OverwriteBoundBranch(BzrError):
 
 
1072
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
 
1074
    def __init__(self, branch):
 
 
1075
        BzrError.__init__(self)
 
 
1076
        self.branch = branch
 
 
1079
class BoundBranchConnectionFailure(BzrError):
 
 
1081
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
 
1082
            " => %(target)s: %(error)s")
 
 
1084
    def __init__(self, branch, target, error):
 
 
1085
        BzrError.__init__(self)
 
 
1086
        self.branch = branch
 
 
1087
        self.target = target
 
 
1091
class WeaveError(BzrError):
 
 
1093
    _fmt = "Error in processing weave: %(message)s"
 
 
1095
    def __init__(self, message=None):
 
 
1096
        BzrError.__init__(self)
 
 
1097
        self.message = message
 
 
1100
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
1102
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
 
1104
    def __init__(self, revision_id, weave):
 
 
1106
        WeaveError.__init__(self)
 
 
1107
        self.revision_id = revision_id
 
 
1111
class WeaveRevisionNotPresent(WeaveError):
 
 
1113
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
 
1115
    def __init__(self, revision_id, weave):
 
 
1116
        WeaveError.__init__(self)
 
 
1117
        self.revision_id = revision_id
 
 
1121
class WeaveFormatError(WeaveError):
 
 
1123
    _fmt = "Weave invariant violated: %(what)s"
 
 
1125
    def __init__(self, what):
 
 
1126
        WeaveError.__init__(self)
 
 
1130
class WeaveParentMismatch(WeaveError):
 
 
1132
    _fmt = "Parents are mismatched between two revisions."
 
 
1135
class WeaveInvalidChecksum(WeaveError):
 
 
1137
    _fmt = "Text did not match it's checksum: %(message)s"
 
 
1140
class WeaveTextDiffers(WeaveError):
 
 
1142
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1143
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1145
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1146
        WeaveError.__init__(self)
 
 
1147
        self.revision_id = revision_id
 
 
1148
        self.weave_a = weave_a
 
 
1149
        self.weave_b = weave_b
 
 
1152
class WeaveTextDiffers(WeaveError):
 
 
1154
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1155
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1157
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1158
        WeaveError.__init__(self)
 
 
1159
        self.revision_id = revision_id
 
 
1160
        self.weave_a = weave_a
 
 
1161
        self.weave_b = weave_b
 
 
1164
class VersionedFileError(BzrError):
 
 
1166
    _fmt = "Versioned file error"
 
 
1169
class RevisionNotPresent(VersionedFileError):
 
 
1171
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
 
1173
    def __init__(self, revision_id, file_id):
 
 
1174
        VersionedFileError.__init__(self)
 
 
1175
        self.revision_id = revision_id
 
 
1176
        self.file_id = file_id
 
 
1179
class RevisionAlreadyPresent(VersionedFileError):
 
 
1181
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
 
1183
    def __init__(self, revision_id, file_id):
 
 
1184
        VersionedFileError.__init__(self)
 
 
1185
        self.revision_id = revision_id
 
 
1186
        self.file_id = file_id
 
 
1189
class KnitError(BzrError):
 
 
1193
    internal_error = True
 
 
1196
class KnitHeaderError(KnitError):
 
 
1198
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
 
1200
    def __init__(self, badline, filename):
 
 
1201
        KnitError.__init__(self)
 
 
1202
        self.badline = badline
 
 
1203
        self.filename = filename
 
 
1206
class KnitCorrupt(KnitError):
 
 
1208
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
 
1210
    def __init__(self, filename, how):
 
 
1211
        KnitError.__init__(self)
 
 
1212
        self.filename = filename
 
 
1216
class KnitIndexUnknownMethod(KnitError):
 
 
1217
    """Raised when we don't understand the storage method.
 
 
1219
    Currently only 'fulltext' and 'line-delta' are supported.
 
 
1222
    _fmt = ("Knit index %(filename)s does not have a known method"
 
 
1223
            " in options: %(options)r")
 
 
1225
    def __init__(self, filename, options):
 
 
1226
        KnitError.__init__(self)
 
 
1227
        self.filename = filename
 
 
1228
        self.options = options
 
 
1231
class NoSuchExportFormat(BzrError):
 
 
1233
    _fmt = "Export format %(format)r not supported"
 
 
1235
    def __init__(self, format):
 
 
1236
        BzrError.__init__(self)
 
 
1237
        self.format = format
 
 
1240
class TransportError(BzrError):
 
 
1242
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
 
1244
    def __init__(self, msg=None, orig_error=None):
 
 
1245
        if msg is None and orig_error is not None:
 
 
1246
            msg = str(orig_error)
 
 
1247
        if orig_error is None:
 
 
1252
        self.orig_error = orig_error
 
 
1253
        BzrError.__init__(self)
 
 
1256
class TooManyConcurrentRequests(BzrError):
 
 
1258
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
 
1259
            " Be sure to finish_writing and finish_reading on the"
 
 
1260
            " currently open request.")
 
 
1262
    internal_error = True
 
 
1264
    def __init__(self, medium):
 
 
1265
        self.medium = medium
 
 
1268
class SmartProtocolError(TransportError):
 
 
1270
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
 
1272
    def __init__(self, details):
 
 
1273
        self.details = details
 
 
1276
# A set of semi-meaningful errors which can be thrown
 
 
1277
class TransportNotPossible(TransportError):
 
 
1279
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
 
1282
class ConnectionError(TransportError):
 
 
1284
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
 
1287
class SocketConnectionError(ConnectionError):
 
 
1289
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
 
1291
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
1293
            msg = 'Failed to connect to'
 
 
1294
        if orig_error is None:
 
 
1297
            orig_error = '; ' + str(orig_error)
 
 
1298
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
1303
            self.port = ':%s' % port
 
 
1306
class ConnectionReset(TransportError):
 
 
1308
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
 
1311
class InvalidRange(TransportError):
 
 
1313
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
 
1315
    def __init__(self, path, offset):
 
 
1316
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
 
1319
        self.offset = offset
 
 
1322
class InvalidHttpResponse(TransportError):
 
 
1324
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
 
1326
    def __init__(self, path, msg, orig_error=None):
 
 
1328
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
1331
class InvalidHttpRange(InvalidHttpResponse):
 
 
1333
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
 
1335
    def __init__(self, path, range, msg):
 
 
1337
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1340
class InvalidHttpContentType(InvalidHttpResponse):
 
 
1342
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
 
1344
    def __init__(self, path, ctype, msg):
 
 
1346
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1349
class RedirectRequested(TransportError):
 
 
1351
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
 
1353
    def __init__(self, source, target, is_permament=False, qual_proto=None):
 
 
1354
        self.source = source
 
 
1355
        self.target = target
 
 
1357
            self.permanently = ' permanently'
 
 
1359
            self.permanently = ''
 
 
1360
        self.is_permament = is_permament
 
 
1361
        self._qualified_proto = qual_proto
 
 
1362
        TransportError.__init__(self)
 
 
1364
    def _requalify_url(self, url):
 
 
1365
        """Restore the qualified proto in front of the url"""
 
 
1366
        # When this exception is raised, source and target are in
 
 
1367
        # user readable format. But some transports may use a
 
 
1368
        # different proto (http+urllib:// will present http:// to
 
 
1369
        # the user. If a qualified proto is specified, the code
 
 
1370
        # trapping the exception can get the qualified urls to
 
 
1371
        # properly handle the redirection themself (creating a
 
 
1372
        # new transport object from the target url for example).
 
 
1373
        # But checking that the scheme of the original and
 
 
1374
        # redirected urls are the same can be tricky. (see the
 
 
1375
        # FIXME in BzrDir.open_from_transport for the unique use
 
 
1377
        if self._qualified_proto is None:
 
 
1380
        # The TODO related to NotBranchError mention that doing
 
 
1381
        # that kind of manipulation on the urls may not be the
 
 
1382
        # exception object job. On the other hand, this object is
 
 
1383
        # the interface between the code and the user so
 
 
1384
        # presenting the urls in different ways is indeed its
 
 
1387
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
 
1388
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
 
1391
    def get_source_url(self):
 
 
1392
        return self._requalify_url(self.source)
 
 
1394
    def get_target_url(self):
 
 
1395
        return self._requalify_url(self.target)
 
 
1398
class TooManyRedirections(TransportError):
 
 
1400
    _fmt = "Too many redirections"
 
 
1402
class ConflictsInTree(BzrError):
 
 
1404
    _fmt = "Working tree has conflicts."
 
 
1407
class ParseConfigError(BzrError):
 
 
1409
    def __init__(self, errors, filename):
 
 
1410
        if filename is None:
 
 
1412
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
1413
            (filename, ('\n'.join(e.message for e in errors)))
 
 
1414
        BzrError.__init__(self, message)
 
 
1417
class NoEmailInUsername(BzrError):
 
 
1419
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
 
1421
    def __init__(self, username):
 
 
1422
        BzrError.__init__(self)
 
 
1423
        self.username = username
 
 
1426
class SigningFailed(BzrError):
 
 
1428
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
 
1430
    def __init__(self, command_line):
 
 
1431
        BzrError.__init__(self, command_line=command_line)
 
 
1434
class WorkingTreeNotRevision(BzrError):
 
 
1436
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
 
1437
            " the last commit, but weave merge requires that it be"
 
 
1440
    def __init__(self, tree):
 
 
1441
        BzrError.__init__(self, basedir=tree.basedir)
 
 
1444
class CantReprocessAndShowBase(BzrError):
 
 
1446
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
 
1447
           "the relationship of conflicting lines to the base")
 
 
1450
class GraphCycleError(BzrError):
 
 
1452
    _fmt = "Cycle in graph %(graph)r"
 
 
1454
    def __init__(self, graph):
 
 
1455
        BzrError.__init__(self)
 
 
1459
class WritingCompleted(BzrError):
 
 
1461
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
 
1462
            "called upon it - accept bytes may not be called anymore.")
 
 
1464
    internal_error = True
 
 
1466
    def __init__(self, request):
 
 
1467
        self.request = request
 
 
1470
class WritingNotComplete(BzrError):
 
 
1472
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
 
1473
            "called upon it - until the write phase is complete no "
 
 
1474
            "data may be read.")
 
 
1476
    internal_error = True
 
 
1478
    def __init__(self, request):
 
 
1479
        self.request = request
 
 
1482
class NotConflicted(BzrError):
 
 
1484
    _fmt = "File %(filename)s is not conflicted."
 
 
1486
    def __init__(self, filename):
 
 
1487
        BzrError.__init__(self)
 
 
1488
        self.filename = filename
 
 
1491
class MediumNotConnected(BzrError):
 
 
1493
    _fmt = """The medium '%(medium)s' is not connected."""
 
 
1495
    internal_error = True
 
 
1497
    def __init__(self, medium):
 
 
1498
        self.medium = medium
 
 
1501
class MustUseDecorated(Exception):
 
 
1503
    _fmt = "A decorating function has requested its original command be used."
 
 
1506
class NoBundleFound(BzrError):
 
 
1508
    _fmt = "No bundle was found in %(filename)s"
 
 
1510
    def __init__(self, filename):
 
 
1511
        BzrError.__init__(self)
 
 
1512
        self.filename = filename
 
 
1515
class BundleNotSupported(BzrError):
 
 
1517
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
 
1519
    def __init__(self, version, msg):
 
 
1520
        BzrError.__init__(self)
 
 
1521
        self.version = version
 
 
1525
class MissingText(BzrError):
 
 
1527
    _fmt = ("Branch %(base)s is missing revision"
 
 
1528
            " %(text_revision)s of %(file_id)s")
 
 
1530
    def __init__(self, branch, text_revision, file_id):
 
 
1531
        BzrError.__init__(self)
 
 
1532
        self.branch = branch
 
 
1533
        self.base = branch.base
 
 
1534
        self.text_revision = text_revision
 
 
1535
        self.file_id = file_id
 
 
1538
class DuplicateFileId(BzrError):
 
 
1540
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
 
1542
    def __init__(self, file_id, entry):
 
 
1543
        BzrError.__init__(self)
 
 
1544
        self.file_id = file_id
 
 
1548
class DuplicateKey(BzrError):
 
 
1550
    _fmt = "Key %(key)s is already present in map"
 
 
1553
class DuplicateHelpPrefix(BzrError):
 
 
1555
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
 
1557
    def __init__(self, prefix):
 
 
1558
        self.prefix = prefix
 
 
1561
class MalformedTransform(BzrError):
 
 
1563
    _fmt = "Tree transform is malformed %(conflicts)r"
 
 
1566
class NoFinalPath(BzrError):
 
 
1568
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
 
1569
            "file-id: %(file_id)r\n"
 
 
1570
            "root trans-id: %(root_trans_id)r\n")
 
 
1572
    def __init__(self, trans_id, transform):
 
 
1573
        self.trans_id = trans_id
 
 
1574
        self.file_id = transform.final_file_id(trans_id)
 
 
1575
        self.root_trans_id = transform.root
 
 
1578
class BzrBadParameter(BzrError):
 
 
1580
    _fmt = "Bad parameter: %(param)r"
 
 
1582
    internal_error = True
 
 
1584
    # This exception should never be thrown, but it is a base class for all
 
 
1585
    # parameter-to-function errors.
 
 
1587
    def __init__(self, param):
 
 
1588
        BzrError.__init__(self)
 
 
1592
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1594
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
 
1597
class ReusingTransform(BzrError):
 
 
1599
    _fmt = "Attempt to reuse a transform that has already been applied."
 
 
1602
class CantMoveRoot(BzrError):
 
 
1604
    _fmt = "Moving the root directory is not supported at this time"
 
 
1607
class BzrMoveFailedError(BzrError):
 
 
1609
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1611
    def __init__(self, from_path='', to_path='', extra=None):
 
 
1612
        BzrError.__init__(self)
 
 
1614
            self.extra = ': ' + str(extra)
 
 
1618
        has_from = len(from_path) > 0
 
 
1619
        has_to = len(to_path) > 0
 
 
1621
            self.from_path = osutils.splitpath(from_path)[-1]
 
 
1626
            self.to_path = osutils.splitpath(to_path)[-1]
 
 
1631
        if has_from and has_to:
 
 
1632
            self.operator = " =>"
 
 
1634
            self.from_path = "from " + from_path
 
 
1636
            self.operator = "to"
 
 
1638
            self.operator = "file"
 
 
1641
class BzrRenameFailedError(BzrMoveFailedError):
 
 
1643
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1645
    def __init__(self, from_path, to_path, extra=None):
 
 
1646
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
 
1648
class BzrRemoveChangedFilesError(BzrError):
 
 
1649
    """Used when user is trying to remove changed files."""
 
 
1651
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
 
 
1652
        "Use --keep to not delete them, or --force to delete them regardless.")
 
 
1654
    def __init__(self, tree_delta):
 
 
1655
        BzrError.__init__(self)
 
 
1656
        self.changes_as_text = tree_delta.get_changes_as_text()
 
 
1657
        #self.paths_as_string = '\n'.join(changed_files)
 
 
1658
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
 
1661
class BzrBadParameterNotString(BzrBadParameter):
 
 
1663
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
 
1666
class BzrBadParameterMissing(BzrBadParameter):
 
 
1668
    _fmt = "Parameter $(param)s is required but not present."
 
 
1671
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1673
    _fmt = ("Parameter %(param)s is unicode but"
 
 
1674
            " only byte-strings are permitted.")
 
 
1677
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1679
    _fmt = "Parameter %(param)s contains a newline."
 
 
1682
class DependencyNotPresent(BzrError):
 
 
1684
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
 
1686
    def __init__(self, library, error):
 
 
1687
        BzrError.__init__(self, library=library, error=error)
 
 
1690
class ParamikoNotPresent(DependencyNotPresent):
 
 
1692
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
 
1694
    def __init__(self, error):
 
 
1695
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1698
class PointlessMerge(BzrError):
 
 
1700
    _fmt = "Nothing to merge."
 
 
1703
class UninitializableFormat(BzrError):
 
 
1705
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
 
1707
    def __init__(self, format):
 
 
1708
        BzrError.__init__(self)
 
 
1709
        self.format = format
 
 
1712
class BadConversionTarget(BzrError):
 
 
1714
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
 
1716
    def __init__(self, problem, format):
 
 
1717
        BzrError.__init__(self)
 
 
1718
        self.problem = problem
 
 
1719
        self.format = format
 
 
1722
class NoDiff(BzrError):
 
 
1724
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
 
1726
    def __init__(self, msg):
 
 
1727
        BzrError.__init__(self, msg=msg)
 
 
1730
class NoDiff3(BzrError):
 
 
1732
    _fmt = "Diff3 is not installed on this machine."
 
 
1735
class ExistingLimbo(BzrError):
 
 
1737
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1738
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1739
    keep, and delete it when you are done."""
 
 
1741
    def __init__(self, limbo_dir):
 
 
1742
       BzrError.__init__(self)
 
 
1743
       self.limbo_dir = limbo_dir
 
 
1746
class ImmortalLimbo(BzrError):
 
 
1748
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
 
1749
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1750
    keep, and delete it when you are done."""
 
 
1752
    def __init__(self, limbo_dir):
 
 
1753
       BzrError.__init__(self)
 
 
1754
       self.limbo_dir = limbo_dir
 
 
1757
class OutOfDateTree(BzrError):
 
 
1759
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
 
1761
    def __init__(self, tree):
 
 
1762
        BzrError.__init__(self)
 
 
1766
class PublicBranchOutOfDate(BzrError):
 
 
1768
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
 
1771
    def __init__(self, public_location, revstring):
 
 
1772
        import bzrlib.urlutils as urlutils
 
 
1773
        public_location = urlutils.unescape_for_display(public_location,
 
 
1775
        BzrError.__init__(self, public_location=public_location,
 
 
1776
                          revstring=revstring)
 
 
1779
class MergeModifiedFormatError(BzrError):
 
 
1781
    _fmt = "Error in merge modified format"
 
 
1784
class ConflictFormatError(BzrError):
 
 
1786
    _fmt = "Format error in conflict listings"
 
 
1789
class CorruptRepository(BzrError):
 
 
1791
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
 
1792
            "Please run bzr reconcile on this repository.")
 
 
1794
    def __init__(self, repo):
 
 
1795
        BzrError.__init__(self)
 
 
1796
        self.repo_path = repo.bzrdir.root_transport.base
 
 
1799
class UpgradeRequired(BzrError):
 
 
1801
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
 
1803
    def __init__(self, path):
 
 
1804
        BzrError.__init__(self)
 
 
1808
class LocalRequiresBoundBranch(BzrError):
 
 
1810
    _fmt = "Cannot perform local-only commits on unbound branches."
 
 
1813
class MissingProgressBarFinish(BzrError):
 
 
1815
    _fmt = "A nested progress bar was not 'finished' correctly."
 
 
1818
class InvalidProgressBarType(BzrError):
 
 
1820
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
 
1821
            " is not a supported type Select one of: %(valid_types)s")
 
 
1823
    def __init__(self, bar_type, valid_types):
 
 
1824
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
1827
class UnsupportedOperation(BzrError):
 
 
1829
    _fmt = ("The method %(mname)s is not supported on"
 
 
1830
            " objects of type %(tname)s.")
 
 
1832
    def __init__(self, method, method_self):
 
 
1833
        self.method = method
 
 
1834
        self.mname = method.__name__
 
 
1835
        self.tname = type(method_self).__name__
 
 
1838
class CannotSetRevisionId(UnsupportedOperation):
 
 
1839
    """Raised when a commit is attempting to set a revision id but cant."""
 
 
1842
class NonAsciiRevisionId(UnsupportedOperation):
 
 
1843
    """Raised when a commit is attempting to set a non-ascii revision id
 
 
1848
class BinaryFile(BzrError):
 
 
1850
    _fmt = "File is binary but should be text."
 
 
1853
class IllegalPath(BzrError):
 
 
1855
    _fmt = "The path %(path)s is not permitted on this platform"
 
 
1857
    def __init__(self, path):
 
 
1858
        BzrError.__init__(self)
 
 
1862
class TestamentMismatch(BzrError):
 
 
1864
    _fmt = """Testament did not match expected value.
 
 
1865
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
 
1868
    def __init__(self, revision_id, expected, measured):
 
 
1869
        self.revision_id = revision_id
 
 
1870
        self.expected = expected
 
 
1871
        self.measured = measured
 
 
1874
class NotABundle(BzrError):
 
 
1876
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
 
1878
    def __init__(self, text):
 
 
1879
        BzrError.__init__(self)
 
 
1883
class BadBundle(BzrError): 
 
 
1885
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
 
1887
    def __init__(self, text):
 
 
1888
        BzrError.__init__(self)
 
 
1892
class MalformedHeader(BadBundle): 
 
 
1894
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
 
1897
class MalformedPatches(BadBundle): 
 
 
1899
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
 
1902
class MalformedFooter(BadBundle): 
 
 
1904
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
 
1907
class UnsupportedEOLMarker(BadBundle):
 
 
1909
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
 
1912
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
 
1913
        # but for this there is not
 
 
1914
        BzrError.__init__(self)
 
 
1917
class IncompatibleBundleFormat(BzrError):
 
 
1919
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
 
1921
    def __init__(self, bundle_format, other):
 
 
1922
        BzrError.__init__(self)
 
 
1923
        self.bundle_format = bundle_format
 
 
1927
class BadInventoryFormat(BzrError):
 
 
1929
    _fmt = "Root class for inventory serialization errors"
 
 
1932
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
1934
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
 
1936
    def __init__(self, msg):
 
 
1937
        BadInventoryFormat.__init__(self, msg=msg)
 
 
1940
class RootNotRich(BzrError):
 
 
1942
    _fmt = """This operation requires rich root data storage"""
 
 
1945
class NoSmartMedium(BzrError):
 
 
1947
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
 
1949
    internal_error = True
 
 
1951
    def __init__(self, transport):
 
 
1952
        self.transport = transport
 
 
1955
class NoSmartServer(NotBranchError):
 
 
1957
    _fmt = "No smart server available at %(url)s"
 
 
1959
    def __init__(self, url):
 
 
1963
class UnknownSSH(BzrError):
 
 
1965
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
 
1967
    def __init__(self, vendor):
 
 
1968
        BzrError.__init__(self)
 
 
1969
        self.vendor = vendor
 
 
1972
class SSHVendorNotFound(BzrError):
 
 
1974
    _fmt = ("Don't know how to handle SSH connections."
 
 
1975
            " Please set BZR_SSH environment variable.")
 
 
1978
class GhostRevisionUnusableHere(BzrError):
 
 
1980
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
 
1982
    def __init__(self, revision_id):
 
 
1983
        BzrError.__init__(self)
 
 
1984
        self.revision_id = revision_id
 
 
1987
class IllegalUseOfScopeReplacer(BzrError):
 
 
1989
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
 
1990
            " %(msg)s%(extra)s")
 
 
1992
    internal_error = True
 
 
1994
    def __init__(self, name, msg, extra=None):
 
 
1995
        BzrError.__init__(self)
 
 
1999
            self.extra = ': ' + str(extra)
 
 
2004
class InvalidImportLine(BzrError):
 
 
2006
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
 
2008
    internal_error = True
 
 
2010
    def __init__(self, text, msg):
 
 
2011
        BzrError.__init__(self)
 
 
2016
class ImportNameCollision(BzrError):
 
 
2018
    _fmt = ("Tried to import an object to the same name as"
 
 
2019
            " an existing object. %(name)s")
 
 
2021
    internal_error = True
 
 
2023
    def __init__(self, name):
 
 
2024
        BzrError.__init__(self)
 
 
2028
class NotAMergeDirective(BzrError):
 
 
2029
    """File starting with %(firstline)r is not a merge directive"""
 
 
2030
    def __init__(self, firstline):
 
 
2031
        BzrError.__init__(self, firstline=firstline)
 
 
2034
class NoMergeSource(BzrError):
 
 
2035
    """Raise if no merge source was specified for a merge directive"""
 
 
2037
    _fmt = "A merge directive must provide either a bundle or a public"\
 
 
2041
class PatchMissing(BzrError):
 
 
2042
    """Raise a patch type was specified but no patch supplied"""
 
 
2044
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
 
2046
    def __init__(self, patch_type):
 
 
2047
        BzrError.__init__(self)
 
 
2048
        self.patch_type = patch_type
 
 
2051
class UnsupportedInventoryKind(BzrError):
 
 
2053
    _fmt = """Unsupported entry kind %(kind)s"""
 
 
2055
    def __init__(self, kind):
 
 
2059
class BadSubsumeSource(BzrError):
 
 
2061
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
 
 
2063
    def __init__(self, tree, other_tree, reason):
 
 
2065
        self.other_tree = other_tree
 
 
2066
        self.reason = reason
 
 
2069
class SubsumeTargetNeedsUpgrade(BzrError):
 
 
2071
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
 
2073
    def __init__(self, other_tree):
 
 
2074
        self.other_tree = other_tree
 
 
2077
class BadReferenceTarget(BzrError):
 
 
2079
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
 
2081
    internal_error = True
 
 
2083
    def __init__(self, tree, other_tree, reason):
 
 
2085
        self.other_tree = other_tree
 
 
2086
        self.reason = reason
 
 
2089
class NoSuchTag(BzrError):
 
 
2091
    _fmt = "No such tag: %(tag_name)s"
 
 
2093
    def __init__(self, tag_name):
 
 
2094
        self.tag_name = tag_name
 
 
2097
class TagsNotSupported(BzrError):
 
 
2099
    _fmt = ("Tags not supported by %(branch)s;"
 
 
2100
            " you may be able to use bzr upgrade --dirstate-tags.")
 
 
2102
    def __init__(self, branch):
 
 
2103
        self.branch = branch
 
 
2106
class TagAlreadyExists(BzrError):
 
 
2108
    _fmt = "Tag %(tag_name)s already exists."
 
 
2110
    def __init__(self, tag_name):
 
 
2111
        self.tag_name = tag_name
 
 
2114
class MalformedBugIdentifier(BzrError):
 
 
2116
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
 
2118
    def __init__(self, bug_id, reason):
 
 
2119
        self.bug_id = bug_id
 
 
2120
        self.reason = reason
 
 
2123
class UnknownBugTrackerAbbreviation(BzrError):
 
 
2125
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
 
2128
    def __init__(self, abbreviation, branch):
 
 
2129
        self.abbreviation = abbreviation
 
 
2130
        self.branch = branch
 
 
2133
class UnexpectedSmartServerResponse(BzrError):
 
 
2135
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
 
2137
    def __init__(self, response_tuple):
 
 
2138
        self.response_tuple = response_tuple
 
 
2141
class NoDestinationAddress(BzrError):
 
 
2143
    _fmt = "Message does not have a destination address."
 
 
2145
    internal_error = True
 
 
2148
class SMTPError(BzrError):
 
 
2150
    _fmt = "SMTP error: %(error)s"
 
 
2152
    def __init__(self, error):