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 InvalidEntryName(BzrError):
 
 
203
    _fmt = "Invalid entry name: %(name)s"
 
 
205
    internal_error = True
 
 
207
    def __init__(self, name):
 
 
208
        BzrError.__init__(self)
 
 
212
class InvalidRevisionNumber(BzrError):
 
 
214
    _fmt = "Invalid revision number %(revno)s"
 
 
216
    def __init__(self, revno):
 
 
217
        BzrError.__init__(self)
 
 
221
class InvalidRevisionId(BzrError):
 
 
223
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
 
225
    def __init__(self, revision_id, branch):
 
 
226
        # branch can be any string or object with __str__ defined
 
 
227
        BzrError.__init__(self)
 
 
228
        self.revision_id = revision_id
 
 
231
class ReservedId(BzrError):
 
 
233
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
 
235
    def __init__(self, revision_id):
 
 
236
        self.revision_id = revision_id
 
 
239
class NoHelpTopic(BzrError):
 
 
241
    _fmt = ("No help could be found for '%(topic)s'. "
 
 
242
        "Please use 'bzr help topics' to obtain a list of topics.")
 
 
244
    def __init__(self, topic):
 
 
248
class NoSuchId(BzrError):
 
 
250
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
 
252
    def __init__(self, tree, file_id):
 
 
253
        BzrError.__init__(self)
 
 
254
        self.file_id = file_id
 
 
258
class InventoryModified(BzrError):
 
 
260
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
 
261
            " so a clean inventory cannot be read without data loss.")
 
 
263
    internal_error = True
 
 
265
    def __init__(self, tree):
 
 
269
class NoWorkingTree(BzrError):
 
 
271
    _fmt = "No WorkingTree exists for %(base)s."
 
 
273
    def __init__(self, base):
 
 
274
        BzrError.__init__(self)
 
 
278
class NotBuilding(BzrError):
 
 
280
    _fmt = "Not currently building a tree."
 
 
283
class NotLocalUrl(BzrError):
 
 
285
    _fmt = "%(url)s is not a local path."
 
 
287
    def __init__(self, url):
 
 
291
class WorkingTreeAlreadyPopulated(BzrError):
 
 
293
    _fmt = """Working tree already populated in %(base)s"""
 
 
295
    internal_error = True
 
 
297
    def __init__(self, base):
 
 
300
class BzrCommandError(BzrError):
 
 
301
    """Error from user command"""
 
 
303
    internal_error = False
 
 
305
    # Error from malformed user command; please avoid raising this as a
 
 
306
    # generic exception not caused by user input.
 
 
308
    # I think it's a waste of effort to differentiate between errors that
 
 
309
    # are not intended to be caught anyway.  UI code need not subclass
 
 
310
    # BzrCommandError, and non-UI code should not throw a subclass of
 
 
311
    # BzrCommandError.  ADHB 20051211
 
 
312
    def __init__(self, msg):
 
 
313
        # Object.__str__() must return a real string
 
 
314
        # returning a Unicode string is a python error.
 
 
315
        if isinstance(msg, unicode):
 
 
316
            self.msg = msg.encode('utf8')
 
 
324
class NotWriteLocked(BzrError):
 
 
326
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
 
328
    def __init__(self, not_locked):
 
 
329
        self.not_locked = not_locked
 
 
332
class BzrOptionError(BzrCommandError):
 
 
334
    _fmt = "Error in command line options"
 
 
337
class BadOptionValue(BzrError):
 
 
339
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
 
341
    def __init__(self, name, value):
 
 
342
        BzrError.__init__(self, name=name, value=value)
 
 
345
class StrictCommitFailed(BzrError):
 
 
347
    _fmt = "Commit refused because there are unknown files in the tree"
 
 
350
# XXX: Should be unified with TransportError; they seem to represent the
 
 
352
# RBC 20060929: I think that unifiying with TransportError would be a mistake
 
 
353
# - this is finer than a TransportError - and more useful as such. It 
 
 
354
# differentiates between 'transport has failed' and 'operation on a transport
 
 
356
class PathError(BzrError):
 
 
358
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
 
360
    def __init__(self, path, extra=None):
 
 
361
        BzrError.__init__(self)
 
 
364
            self.extra = ': ' + str(extra)
 
 
369
class NoSuchFile(PathError):
 
 
371
    _fmt = "No such file: %(path)r%(extra)s"
 
 
374
class FileExists(PathError):
 
 
376
    _fmt = "File exists: %(path)r%(extra)s"
 
 
379
class RenameFailedFilesExist(BzrError):
 
 
380
    """Used when renaming and both source and dest exist."""
 
 
382
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
 
385
    def __init__(self, source, dest, extra=None):
 
 
386
        BzrError.__init__(self)
 
 
387
        self.source = str(source)
 
 
388
        self.dest = str(dest)
 
 
390
            self.extra = ' ' + str(extra)
 
 
395
class NotADirectory(PathError):
 
 
397
    _fmt = "%(path)r is not a directory %(extra)s"
 
 
400
class NotInWorkingDirectory(PathError):
 
 
402
    _fmt = "%(path)r is not in the working directory %(extra)s"
 
 
405
class DirectoryNotEmpty(PathError):
 
 
407
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
 
410
class ReadingCompleted(BzrError):
 
 
412
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
 
413
            "called upon it - the request has been completed and no more "
 
 
416
    internal_error = True
 
 
418
    def __init__(self, request):
 
 
419
        self.request = request
 
 
422
class ResourceBusy(PathError):
 
 
424
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
 
427
class PermissionDenied(PathError):
 
 
429
    _fmt = "Permission denied: %(path)r%(extra)s"
 
 
432
class InvalidURL(PathError):
 
 
434
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
 
437
class InvalidURLJoin(PathError):
 
 
439
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
 
441
    def __init__(self, msg, base, args):
 
 
442
        PathError.__init__(self, base, msg)
 
 
443
        self.args = [base] + list(args)
 
 
446
class UnknownHook(BzrError):
 
 
448
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
 
450
    def __init__(self, hook_type, hook_name):
 
 
451
        BzrError.__init__(self)
 
 
452
        self.type = hook_type
 
 
453
        self.hook = hook_name
 
 
456
class UnsupportedProtocol(PathError):
 
 
458
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
 
460
    def __init__(self, url, extra):
 
 
461
        PathError.__init__(self, url, extra=extra)
 
 
464
class ReadError(PathError):
 
 
466
    _fmt = """Error reading from %(path)r."""
 
 
469
class ShortReadvError(PathError):
 
 
471
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
 
 
472
            " at %(offset)s for %(path)s%(extra)s")
 
 
474
    internal_error = True
 
 
476
    def __init__(self, path, offset, length, actual, extra=None):
 
 
477
        PathError.__init__(self, path, extra=extra)
 
 
483
class PathNotChild(BzrError):
 
 
485
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
 
487
    internal_error = True
 
 
489
    def __init__(self, path, base, extra=None):
 
 
490
        BzrError.__init__(self)
 
 
494
            self.extra = ': ' + str(extra)
 
 
499
class InvalidNormalization(PathError):
 
 
501
    _fmt = "Path %(path)r is not unicode normalized"
 
 
504
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
505
# the exception object is a bit undesirable.
 
 
506
# TODO: Probably this behavior of should be a common superclass 
 
 
507
class NotBranchError(PathError):
 
 
509
    _fmt = "Not a branch: %(path)s"
 
 
511
    def __init__(self, path):
 
 
512
       import bzrlib.urlutils as urlutils
 
 
513
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
516
class NoSubmitBranch(PathError):
 
 
518
    _fmt = 'No submit branch available for branch "%(path)s"'
 
 
520
    def __init__(self, branch):
 
 
521
       import bzrlib.urlutils as urlutils
 
 
522
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
 
525
class AlreadyBranchError(PathError):
 
 
527
    _fmt = "Already a branch: %(path)s."
 
 
530
class BranchExistsWithoutWorkingTree(PathError):
 
 
532
    _fmt = "Directory contains a branch, but no working tree \
 
 
533
(use bzr checkout if you wish to build a working tree): %(path)s"
 
 
536
class AtomicFileAlreadyClosed(PathError):
 
 
538
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
 
541
    def __init__(self, path, function):
 
 
542
        PathError.__init__(self, path=path, extra=None)
 
 
543
        self.function = function
 
 
546
class InaccessibleParent(PathError):
 
 
548
    _fmt = ("Parent not accessible given base %(base)s and"
 
 
549
            " relative path %(path)s")
 
 
551
    def __init__(self, path, base):
 
 
552
        PathError.__init__(self, path)
 
 
556
class NoRepositoryPresent(BzrError):
 
 
558
    _fmt = "No repository present: %(path)r"
 
 
559
    def __init__(self, bzrdir):
 
 
560
        BzrError.__init__(self)
 
 
561
        self.path = bzrdir.transport.clone('..').base
 
 
564
class FileInWrongBranch(BzrError):
 
 
566
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
 
568
    def __init__(self, branch, path):
 
 
569
        BzrError.__init__(self)
 
 
571
        self.branch_base = branch.base
 
 
575
class UnsupportedFormatError(BzrError):
 
 
577
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
 
 
580
class UnknownFormatError(BzrError):
 
 
582
    _fmt = "Unknown branch format: %(format)r"
 
 
585
class IncompatibleFormat(BzrError):
 
 
587
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
 
589
    def __init__(self, format, bzrdir_format):
 
 
590
        BzrError.__init__(self)
 
 
592
        self.bzrdir = bzrdir_format
 
 
595
class IncompatibleRepositories(BzrError):
 
 
597
    _fmt = "Repository %(target)s is not compatible with repository"\
 
 
600
    def __init__(self, source, target):
 
 
601
        BzrError.__init__(self, target=target, source=source)
 
 
604
class IncompatibleRevision(BzrError):
 
 
606
    _fmt = "Revision is not compatible with %(repo_format)s"
 
 
608
    def __init__(self, repo_format):
 
 
609
        BzrError.__init__(self)
 
 
610
        self.repo_format = repo_format
 
 
613
class AlreadyVersionedError(BzrError):
 
 
614
    """Used when a path is expected not to be versioned, but it is."""
 
 
616
    _fmt = "%(context_info)s%(path)s is already versioned"
 
 
618
    def __init__(self, path, context_info=None):
 
 
619
        """Construct a new AlreadyVersionedError.
 
 
621
        :param path: This is the path which is 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 not be versioned.
 
 
626
        BzrError.__init__(self)
 
 
628
        if context_info is None:
 
 
629
            self.context_info = ''
 
 
631
            self.context_info = context_info + ". "
 
 
634
class NotVersionedError(BzrError):
 
 
635
    """Used when a path is expected to be versioned, but it is not."""
 
 
637
    _fmt = "%(context_info)s%(path)s is not versioned"
 
 
639
    def __init__(self, path, context_info=None):
 
 
640
        """Construct a new NotVersionedError.
 
 
642
        :param path: This is the path which is not versioned,
 
 
643
        which should be in a user friendly form.
 
 
644
        :param context_info: If given, this is information about the context,
 
 
645
        which could explain why this is expected to be versioned.
 
 
647
        BzrError.__init__(self)
 
 
649
        if context_info is None:
 
 
650
            self.context_info = ''
 
 
652
            self.context_info = context_info + ". "
 
 
655
class PathsNotVersionedError(BzrError):
 
 
656
    """Used when reporting several paths which are not versioned"""
 
 
658
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
 
660
    def __init__(self, paths):
 
 
661
        from bzrlib.osutils import quotefn
 
 
662
        BzrError.__init__(self)
 
 
664
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
667
class PathsDoNotExist(BzrError):
 
 
669
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
 
671
    # used when reporting that paths are neither versioned nor in the working
 
 
674
    def __init__(self, paths, extra=None):
 
 
676
        from bzrlib.osutils import quotefn
 
 
677
        BzrError.__init__(self)
 
 
679
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
681
            self.extra = ': ' + str(extra)
 
 
686
class BadFileKindError(BzrError):
 
 
688
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
 
690
    def __init__(self, filename, kind):
 
 
691
        BzrError.__init__(self, filename=filename, kind=kind)
 
 
694
class ForbiddenControlFileError(BzrError):
 
 
696
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
 
699
class LockError(BzrError):
 
 
701
    _fmt = "Lock error: %(msg)s"
 
 
703
    internal_error = True
 
 
705
    # All exceptions from the lock/unlock functions should be from
 
 
706
    # this exception class.  They will be translated as necessary. The
 
 
707
    # original exception is available as e.original_error
 
 
709
    # New code should prefer to raise specific subclasses
 
 
710
    def __init__(self, message):
 
 
711
        # Python 2.5 uses a slot for StandardError.message,
 
 
712
        # so use a different variable name
 
 
713
        # so it is exposed in self.__dict__
 
 
717
class LockActive(LockError):
 
 
719
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
 
721
    internal_error = False
 
 
723
    def __init__(self, lock_description):
 
 
724
        self.lock_description = lock_description
 
 
727
class CommitNotPossible(LockError):
 
 
729
    _fmt = "A commit was attempted but we do not have a write lock open."
 
 
735
class AlreadyCommitted(LockError):
 
 
737
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
 
743
class ReadOnlyError(LockError):
 
 
745
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
 
747
    # TODO: There should also be an error indicating that you need a write
 
 
748
    # lock and don't have any lock at all... mbp 20070226
 
 
750
    def __init__(self, obj):
 
 
754
class ReadOnlyLockError(LockError):
 
 
756
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
 
758
    def __init__(self, fname, msg):
 
 
759
        LockError.__init__(self, '')
 
 
764
class OutSideTransaction(BzrError):
 
 
766
    _fmt = ("A transaction related operation was attempted after"
 
 
767
            " the transaction finished.")
 
 
770
class ObjectNotLocked(LockError):
 
 
772
    _fmt = "%(obj)r is not locked"
 
 
774
    # this can indicate that any particular object is not locked; see also
 
 
775
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
776
    # the caller -- perhaps they should be unified.
 
 
777
    def __init__(self, obj):
 
 
781
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
783
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
 
785
    def __init__(self, obj):
 
 
789
class UnlockableTransport(LockError):
 
 
791
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
 
793
    def __init__(self, transport):
 
 
794
        self.transport = transport
 
 
797
class LockContention(LockError):
 
 
799
    _fmt = "Could not acquire lock %(lock)s"
 
 
800
    # TODO: show full url for lock, combining the transport and relative
 
 
803
    internal_error = False
 
 
805
    def __init__(self, lock):
 
 
809
class LockBroken(LockError):
 
 
811
    _fmt = ("Lock was broken while still open: %(lock)s"
 
 
812
            " - check storage consistency!")
 
 
814
    internal_error = False
 
 
816
    def __init__(self, lock):
 
 
820
class LockBreakMismatch(LockError):
 
 
822
    _fmt = ("Lock was released and re-acquired before being broken:"
 
 
823
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
 
825
    internal_error = False
 
 
827
    def __init__(self, lock, holder, target):
 
 
833
class LockNotHeld(LockError):
 
 
835
    _fmt = "Lock not held: %(lock)s"
 
 
837
    internal_error = False
 
 
839
    def __init__(self, lock):
 
 
843
class TokenLockingNotSupported(LockError):
 
 
845
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
 
847
    internal_error = True
 
 
849
    def __init__(self, obj):
 
 
853
class TokenMismatch(LockBroken):
 
 
855
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
 
857
    internal_error = True
 
 
859
    def __init__(self, given_token, lock_token):
 
 
860
        self.given_token = given_token
 
 
861
        self.lock_token = lock_token
 
 
864
class PointlessCommit(BzrError):
 
 
866
    _fmt = "No changes to commit"
 
 
869
class CannotCommitSelectedFileMerge(BzrError):
 
 
871
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
 
872
        ' files %(files_str)s'
 
 
874
    def __init__(self, files):
 
 
875
        files_str = ', '.join(files)
 
 
876
        BzrError.__init__(self, files=files, files_str=files_str)
 
 
879
class UpgradeReadonly(BzrError):
 
 
881
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
 
884
class UpToDateFormat(BzrError):
 
 
886
    _fmt = "The branch format %(format)s is already at the most recent format."
 
 
888
    def __init__(self, format):
 
 
889
        BzrError.__init__(self)
 
 
893
class StrictCommitFailed(Exception):
 
 
895
    _fmt = "Commit refused because there are unknowns in the tree."
 
 
898
class NoSuchRevision(BzrError):
 
 
900
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
 
902
    internal_error = True
 
 
904
    def __init__(self, branch, revision):
 
 
905
        BzrError.__init__(self, branch=branch, revision=revision)
 
 
908
class NotLeftParentDescendant(BzrError):
 
 
910
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
 
911
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
 
913
    internal_error = True
 
 
915
    def __init__(self, branch, old_revision, new_revision):
 
 
916
        BzrError.__init__(self, branch_location=branch.base,
 
 
917
                          old_revision=old_revision,
 
 
918
                          new_revision=new_revision)
 
 
921
class NoSuchRevisionSpec(BzrError):
 
 
923
    _fmt = "No namespace registered for string: %(spec)r"
 
 
925
    def __init__(self, spec):
 
 
926
        BzrError.__init__(self, spec=spec)
 
 
929
class NoSuchRevisionInTree(NoSuchRevision):
 
 
930
    """When using Tree.revision_tree, and the revision is not accessible."""
 
 
932
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
 
 
934
    def __init__(self, tree, revision_id):
 
 
935
        BzrError.__init__(self)
 
 
937
        self.revision_id = revision_id
 
 
940
class InvalidRevisionSpec(BzrError):
 
 
942
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
 
943
            " %(branch)s%(extra)s")
 
 
945
    def __init__(self, spec, branch, extra=None):
 
 
946
        BzrError.__init__(self, branch=branch, spec=spec)
 
 
948
            self.extra = '\n' + str(extra)
 
 
953
class HistoryMissing(BzrError):
 
 
955
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
 
958
class AppendRevisionsOnlyViolation(BzrError):
 
 
960
    _fmt = ('Operation denied because it would change the main history,'
 
 
961
           ' which is not permitted by the append_revisions_only setting on'
 
 
962
           ' branch "%(location)s".')
 
 
964
    def __init__(self, location):
 
 
965
       import bzrlib.urlutils as urlutils
 
 
966
       location = urlutils.unescape_for_display(location, 'ascii')
 
 
967
       BzrError.__init__(self, location=location)
 
 
970
class DivergedBranches(BzrError):
 
 
972
    _fmt = ("These branches have diverged."
 
 
973
            " Use the merge command to reconcile them.")
 
 
975
    internal_error = False
 
 
977
    def __init__(self, branch1, branch2):
 
 
978
        self.branch1 = branch1
 
 
979
        self.branch2 = branch2
 
 
982
class NotLefthandHistory(BzrError):
 
 
984
    _fmt = "Supplied history does not follow left-hand parents"
 
 
986
    internal_error = True
 
 
988
    def __init__(self, history):
 
 
989
        BzrError.__init__(self, history=history)
 
 
992
class UnrelatedBranches(BzrError):
 
 
994
    _fmt = ("Branches have no common ancestor, and"
 
 
995
            " no merge base revision was specified.")
 
 
997
    internal_error = False
 
 
1000
class NoCommonAncestor(BzrError):
 
 
1002
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
1004
    def __init__(self, revision_a, revision_b):
 
 
1005
        self.revision_a = revision_a
 
 
1006
        self.revision_b = revision_b
 
 
1009
class NoCommonRoot(BzrError):
 
 
1011
    _fmt = ("Revisions are not derived from the same root: "
 
 
1012
           "%(revision_a)s %(revision_b)s.")
 
 
1014
    def __init__(self, revision_a, revision_b):
 
 
1015
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
 
1018
class NotAncestor(BzrError):
 
 
1020
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
 
1022
    def __init__(self, rev_id, not_ancestor_id):
 
 
1023
        BzrError.__init__(self, rev_id=rev_id,
 
 
1024
            not_ancestor_id=not_ancestor_id)
 
 
1027
class InstallFailed(BzrError):
 
 
1029
    def __init__(self, revisions):
 
 
1030
        revision_str = ", ".join(str(r) for r in revisions)
 
 
1031
        msg = "Could not install revisions:\n%s" % revision_str
 
 
1032
        BzrError.__init__(self, msg)
 
 
1033
        self.revisions = revisions
 
 
1036
class AmbiguousBase(BzrError):
 
 
1038
    def __init__(self, bases):
 
 
1039
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
1041
        msg = ("The correct base is unclear, because %s are all equally close"
 
 
1043
        BzrError.__init__(self, msg)
 
 
1047
class NoCommits(BzrError):
 
 
1049
    _fmt = "Branch %(branch)s has no commits."
 
 
1051
    def __init__(self, branch):
 
 
1052
        BzrError.__init__(self, branch=branch)
 
 
1055
class UnlistableStore(BzrError):
 
 
1057
    def __init__(self, store):
 
 
1058
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
1062
class UnlistableBranch(BzrError):
 
 
1064
    def __init__(self, br):
 
 
1065
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
1068
class BoundBranchOutOfDate(BzrError):
 
 
1070
    _fmt = ("Bound branch %(branch)s is out of date"
 
 
1071
            " with master branch %(master)s.")
 
 
1073
    def __init__(self, branch, master):
 
 
1074
        BzrError.__init__(self)
 
 
1075
        self.branch = branch
 
 
1076
        self.master = master
 
 
1079
class CommitToDoubleBoundBranch(BzrError):
 
 
1081
    _fmt = ("Cannot commit to branch %(branch)s."
 
 
1082
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
 
1084
    def __init__(self, branch, master, remote):
 
 
1085
        BzrError.__init__(self)
 
 
1086
        self.branch = branch
 
 
1087
        self.master = master
 
 
1088
        self.remote = remote
 
 
1091
class OverwriteBoundBranch(BzrError):
 
 
1093
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
 
1095
    def __init__(self, branch):
 
 
1096
        BzrError.__init__(self)
 
 
1097
        self.branch = branch
 
 
1100
class BoundBranchConnectionFailure(BzrError):
 
 
1102
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
 
1103
            " => %(target)s: %(error)s")
 
 
1105
    def __init__(self, branch, target, error):
 
 
1106
        BzrError.__init__(self)
 
 
1107
        self.branch = branch
 
 
1108
        self.target = target
 
 
1112
class WeaveError(BzrError):
 
 
1114
    _fmt = "Error in processing weave: %(message)s"
 
 
1116
    def __init__(self, message=None):
 
 
1117
        BzrError.__init__(self)
 
 
1118
        self.message = message
 
 
1121
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
1123
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
 
1125
    def __init__(self, revision_id, weave):
 
 
1127
        WeaveError.__init__(self)
 
 
1128
        self.revision_id = revision_id
 
 
1132
class WeaveRevisionNotPresent(WeaveError):
 
 
1134
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
 
1136
    def __init__(self, revision_id, weave):
 
 
1137
        WeaveError.__init__(self)
 
 
1138
        self.revision_id = revision_id
 
 
1142
class WeaveFormatError(WeaveError):
 
 
1144
    _fmt = "Weave invariant violated: %(what)s"
 
 
1146
    def __init__(self, what):
 
 
1147
        WeaveError.__init__(self)
 
 
1151
class WeaveParentMismatch(WeaveError):
 
 
1153
    _fmt = "Parents are mismatched between two revisions."
 
 
1156
class WeaveInvalidChecksum(WeaveError):
 
 
1158
    _fmt = "Text did not match it's checksum: %(message)s"
 
 
1161
class WeaveTextDiffers(WeaveError):
 
 
1163
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1164
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1166
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1167
        WeaveError.__init__(self)
 
 
1168
        self.revision_id = revision_id
 
 
1169
        self.weave_a = weave_a
 
 
1170
        self.weave_b = weave_b
 
 
1173
class WeaveTextDiffers(WeaveError):
 
 
1175
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1176
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1178
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1179
        WeaveError.__init__(self)
 
 
1180
        self.revision_id = revision_id
 
 
1181
        self.weave_a = weave_a
 
 
1182
        self.weave_b = weave_b
 
 
1185
class VersionedFileError(BzrError):
 
 
1187
    _fmt = "Versioned file error"
 
 
1190
class RevisionNotPresent(VersionedFileError):
 
 
1192
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
 
1194
    def __init__(self, revision_id, file_id):
 
 
1195
        VersionedFileError.__init__(self)
 
 
1196
        self.revision_id = revision_id
 
 
1197
        self.file_id = file_id
 
 
1200
class RevisionAlreadyPresent(VersionedFileError):
 
 
1202
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
 
1204
    def __init__(self, revision_id, file_id):
 
 
1205
        VersionedFileError.__init__(self)
 
 
1206
        self.revision_id = revision_id
 
 
1207
        self.file_id = file_id
 
 
1210
class KnitError(BzrError):
 
 
1214
    internal_error = True
 
 
1217
class KnitHeaderError(KnitError):
 
 
1219
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
 
1221
    def __init__(self, badline, filename):
 
 
1222
        KnitError.__init__(self)
 
 
1223
        self.badline = badline
 
 
1224
        self.filename = filename
 
 
1227
class KnitCorrupt(KnitError):
 
 
1229
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
 
1231
    def __init__(self, filename, how):
 
 
1232
        KnitError.__init__(self)
 
 
1233
        self.filename = filename
 
 
1237
class KnitIndexUnknownMethod(KnitError):
 
 
1238
    """Raised when we don't understand the storage method.
 
 
1240
    Currently only 'fulltext' and 'line-delta' are supported.
 
 
1243
    _fmt = ("Knit index %(filename)s does not have a known method"
 
 
1244
            " in options: %(options)r")
 
 
1246
    def __init__(self, filename, options):
 
 
1247
        KnitError.__init__(self)
 
 
1248
        self.filename = filename
 
 
1249
        self.options = options
 
 
1252
class NoSuchExportFormat(BzrError):
 
 
1254
    _fmt = "Export format %(format)r not supported"
 
 
1256
    def __init__(self, format):
 
 
1257
        BzrError.__init__(self)
 
 
1258
        self.format = format
 
 
1261
class TransportError(BzrError):
 
 
1263
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
 
1265
    def __init__(self, msg=None, orig_error=None):
 
 
1266
        if msg is None and orig_error is not None:
 
 
1267
            msg = str(orig_error)
 
 
1268
        if orig_error is None:
 
 
1273
        self.orig_error = orig_error
 
 
1274
        BzrError.__init__(self)
 
 
1277
class TooManyConcurrentRequests(BzrError):
 
 
1279
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
 
1280
            " Be sure to finish_writing and finish_reading on the"
 
 
1281
            " currently open request.")
 
 
1283
    internal_error = True
 
 
1285
    def __init__(self, medium):
 
 
1286
        self.medium = medium
 
 
1289
class SmartProtocolError(TransportError):
 
 
1291
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
 
1293
    def __init__(self, details):
 
 
1294
        self.details = details
 
 
1297
# A set of semi-meaningful errors which can be thrown
 
 
1298
class TransportNotPossible(TransportError):
 
 
1300
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
 
1303
class ConnectionError(TransportError):
 
 
1305
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
 
1308
class SocketConnectionError(ConnectionError):
 
 
1310
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
 
1312
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
1314
            msg = 'Failed to connect to'
 
 
1315
        if orig_error is None:
 
 
1318
            orig_error = '; ' + str(orig_error)
 
 
1319
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
1324
            self.port = ':%s' % port
 
 
1327
class ConnectionReset(TransportError):
 
 
1329
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
 
1332
class InvalidRange(TransportError):
 
 
1334
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
 
1336
    def __init__(self, path, offset):
 
 
1337
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
 
1340
        self.offset = offset
 
 
1343
class InvalidHttpResponse(TransportError):
 
 
1345
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
 
1347
    def __init__(self, path, msg, orig_error=None):
 
 
1349
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
1352
class InvalidHttpRange(InvalidHttpResponse):
 
 
1354
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
 
1356
    def __init__(self, path, range, msg):
 
 
1358
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1361
class InvalidHttpContentType(InvalidHttpResponse):
 
 
1363
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
 
1365
    def __init__(self, path, ctype, msg):
 
 
1367
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1370
class RedirectRequested(TransportError):
 
 
1372
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
 
1374
    def __init__(self, source, target, is_permament=False, qual_proto=None):
 
 
1375
        self.source = source
 
 
1376
        self.target = target
 
 
1378
            self.permanently = ' permanently'
 
 
1380
            self.permanently = ''
 
 
1381
        self.is_permament = is_permament
 
 
1382
        self._qualified_proto = qual_proto
 
 
1383
        TransportError.__init__(self)
 
 
1385
    def _requalify_url(self, url):
 
 
1386
        """Restore the qualified proto in front of the url"""
 
 
1387
        # When this exception is raised, source and target are in
 
 
1388
        # user readable format. But some transports may use a
 
 
1389
        # different proto (http+urllib:// will present http:// to
 
 
1390
        # the user. If a qualified proto is specified, the code
 
 
1391
        # trapping the exception can get the qualified urls to
 
 
1392
        # properly handle the redirection themself (creating a
 
 
1393
        # new transport object from the target url for example).
 
 
1394
        # But checking that the scheme of the original and
 
 
1395
        # redirected urls are the same can be tricky. (see the
 
 
1396
        # FIXME in BzrDir.open_from_transport for the unique use
 
 
1398
        if self._qualified_proto is None:
 
 
1401
        # The TODO related to NotBranchError mention that doing
 
 
1402
        # that kind of manipulation on the urls may not be the
 
 
1403
        # exception object job. On the other hand, this object is
 
 
1404
        # the interface between the code and the user so
 
 
1405
        # presenting the urls in different ways is indeed its
 
 
1408
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
 
1409
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
 
1412
    def get_source_url(self):
 
 
1413
        return self._requalify_url(self.source)
 
 
1415
    def get_target_url(self):
 
 
1416
        return self._requalify_url(self.target)
 
 
1419
class TooManyRedirections(TransportError):
 
 
1421
    _fmt = "Too many redirections"
 
 
1423
class ConflictsInTree(BzrError):
 
 
1425
    _fmt = "Working tree has conflicts."
 
 
1428
class ParseConfigError(BzrError):
 
 
1430
    def __init__(self, errors, filename):
 
 
1431
        if filename is None:
 
 
1433
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
1434
            (filename, ('\n'.join(e.message for e in errors)))
 
 
1435
        BzrError.__init__(self, message)
 
 
1438
class NoEmailInUsername(BzrError):
 
 
1440
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
 
1442
    def __init__(self, username):
 
 
1443
        BzrError.__init__(self)
 
 
1444
        self.username = username
 
 
1447
class SigningFailed(BzrError):
 
 
1449
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
 
1451
    def __init__(self, command_line):
 
 
1452
        BzrError.__init__(self, command_line=command_line)
 
 
1455
class WorkingTreeNotRevision(BzrError):
 
 
1457
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
 
1458
            " the last commit, but weave merge requires that it be"
 
 
1461
    def __init__(self, tree):
 
 
1462
        BzrError.__init__(self, basedir=tree.basedir)
 
 
1465
class CantReprocessAndShowBase(BzrError):
 
 
1467
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
 
1468
           "the relationship of conflicting lines to the base")
 
 
1471
class GraphCycleError(BzrError):
 
 
1473
    _fmt = "Cycle in graph %(graph)r"
 
 
1475
    def __init__(self, graph):
 
 
1476
        BzrError.__init__(self)
 
 
1480
class WritingCompleted(BzrError):
 
 
1482
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
 
1483
            "called upon it - accept bytes may not be called anymore.")
 
 
1485
    internal_error = True
 
 
1487
    def __init__(self, request):
 
 
1488
        self.request = request
 
 
1491
class WritingNotComplete(BzrError):
 
 
1493
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
 
1494
            "called upon it - until the write phase is complete no "
 
 
1495
            "data may be read.")
 
 
1497
    internal_error = True
 
 
1499
    def __init__(self, request):
 
 
1500
        self.request = request
 
 
1503
class NotConflicted(BzrError):
 
 
1505
    _fmt = "File %(filename)s is not conflicted."
 
 
1507
    def __init__(self, filename):
 
 
1508
        BzrError.__init__(self)
 
 
1509
        self.filename = filename
 
 
1512
class MediumNotConnected(BzrError):
 
 
1514
    _fmt = """The medium '%(medium)s' is not connected."""
 
 
1516
    internal_error = True
 
 
1518
    def __init__(self, medium):
 
 
1519
        self.medium = medium
 
 
1522
class MustUseDecorated(Exception):
 
 
1524
    _fmt = "A decorating function has requested its original command be used."
 
 
1527
class NoBundleFound(BzrError):
 
 
1529
    _fmt = "No bundle was found in %(filename)s"
 
 
1531
    def __init__(self, filename):
 
 
1532
        BzrError.__init__(self)
 
 
1533
        self.filename = filename
 
 
1536
class BundleNotSupported(BzrError):
 
 
1538
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
 
1540
    def __init__(self, version, msg):
 
 
1541
        BzrError.__init__(self)
 
 
1542
        self.version = version
 
 
1546
class MissingText(BzrError):
 
 
1548
    _fmt = ("Branch %(base)s is missing revision"
 
 
1549
            " %(text_revision)s of %(file_id)s")
 
 
1551
    def __init__(self, branch, text_revision, file_id):
 
 
1552
        BzrError.__init__(self)
 
 
1553
        self.branch = branch
 
 
1554
        self.base = branch.base
 
 
1555
        self.text_revision = text_revision
 
 
1556
        self.file_id = file_id
 
 
1559
class DuplicateFileId(BzrError):
 
 
1561
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
 
1563
    def __init__(self, file_id, entry):
 
 
1564
        BzrError.__init__(self)
 
 
1565
        self.file_id = file_id
 
 
1569
class DuplicateKey(BzrError):
 
 
1571
    _fmt = "Key %(key)s is already present in map"
 
 
1574
class DuplicateHelpPrefix(BzrError):
 
 
1576
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
 
1578
    def __init__(self, prefix):
 
 
1579
        self.prefix = prefix
 
 
1582
class MalformedTransform(BzrError):
 
 
1584
    _fmt = "Tree transform is malformed %(conflicts)r"
 
 
1587
class NoFinalPath(BzrError):
 
 
1589
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
 
1590
            "file-id: %(file_id)r\n"
 
 
1591
            "root trans-id: %(root_trans_id)r\n")
 
 
1593
    def __init__(self, trans_id, transform):
 
 
1594
        self.trans_id = trans_id
 
 
1595
        self.file_id = transform.final_file_id(trans_id)
 
 
1596
        self.root_trans_id = transform.root
 
 
1599
class BzrBadParameter(BzrError):
 
 
1601
    _fmt = "Bad parameter: %(param)r"
 
 
1603
    internal_error = True
 
 
1605
    # This exception should never be thrown, but it is a base class for all
 
 
1606
    # parameter-to-function errors.
 
 
1608
    def __init__(self, param):
 
 
1609
        BzrError.__init__(self)
 
 
1613
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1615
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
 
1618
class ReusingTransform(BzrError):
 
 
1620
    _fmt = "Attempt to reuse a transform that has already been applied."
 
 
1623
class CantMoveRoot(BzrError):
 
 
1625
    _fmt = "Moving the root directory is not supported at this time"
 
 
1628
class BzrMoveFailedError(BzrError):
 
 
1630
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1632
    def __init__(self, from_path='', to_path='', extra=None):
 
 
1633
        BzrError.__init__(self)
 
 
1635
            self.extra = ': ' + str(extra)
 
 
1639
        has_from = len(from_path) > 0
 
 
1640
        has_to = len(to_path) > 0
 
 
1642
            self.from_path = osutils.splitpath(from_path)[-1]
 
 
1647
            self.to_path = osutils.splitpath(to_path)[-1]
 
 
1652
        if has_from and has_to:
 
 
1653
            self.operator = " =>"
 
 
1655
            self.from_path = "from " + from_path
 
 
1657
            self.operator = "to"
 
 
1659
            self.operator = "file"
 
 
1662
class BzrRenameFailedError(BzrMoveFailedError):
 
 
1664
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1666
    def __init__(self, from_path, to_path, extra=None):
 
 
1667
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
 
1669
class BzrRemoveChangedFilesError(BzrError):
 
 
1670
    """Used when user is trying to remove changed files."""
 
 
1672
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
 
 
1673
        "Use --keep to not delete them, or --force to delete them regardless.")
 
 
1675
    def __init__(self, tree_delta):
 
 
1676
        BzrError.__init__(self)
 
 
1677
        self.changes_as_text = tree_delta.get_changes_as_text()
 
 
1678
        #self.paths_as_string = '\n'.join(changed_files)
 
 
1679
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
 
1682
class BzrBadParameterNotString(BzrBadParameter):
 
 
1684
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
 
1687
class BzrBadParameterMissing(BzrBadParameter):
 
 
1689
    _fmt = "Parameter $(param)s is required but not present."
 
 
1692
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1694
    _fmt = ("Parameter %(param)s is unicode but"
 
 
1695
            " only byte-strings are permitted.")
 
 
1698
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1700
    _fmt = "Parameter %(param)s contains a newline."
 
 
1703
class DependencyNotPresent(BzrError):
 
 
1705
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
 
1707
    def __init__(self, library, error):
 
 
1708
        BzrError.__init__(self, library=library, error=error)
 
 
1711
class ParamikoNotPresent(DependencyNotPresent):
 
 
1713
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
 
1715
    def __init__(self, error):
 
 
1716
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1719
class PointlessMerge(BzrError):
 
 
1721
    _fmt = "Nothing to merge."
 
 
1724
class UninitializableFormat(BzrError):
 
 
1726
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
 
1728
    def __init__(self, format):
 
 
1729
        BzrError.__init__(self)
 
 
1730
        self.format = format
 
 
1733
class BadConversionTarget(BzrError):
 
 
1735
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
 
1737
    def __init__(self, problem, format):
 
 
1738
        BzrError.__init__(self)
 
 
1739
        self.problem = problem
 
 
1740
        self.format = format
 
 
1743
class NoDiff(BzrError):
 
 
1745
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
 
1747
    def __init__(self, msg):
 
 
1748
        BzrError.__init__(self, msg=msg)
 
 
1751
class NoDiff3(BzrError):
 
 
1753
    _fmt = "Diff3 is not installed on this machine."
 
 
1756
class ExistingLimbo(BzrError):
 
 
1758
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1759
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1760
    keep, and delete it when you are done."""
 
 
1762
    def __init__(self, limbo_dir):
 
 
1763
       BzrError.__init__(self)
 
 
1764
       self.limbo_dir = limbo_dir
 
 
1767
class ImmortalLimbo(BzrError):
 
 
1769
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
 
1770
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1771
    keep, and delete it when you are done."""
 
 
1773
    def __init__(self, limbo_dir):
 
 
1774
       BzrError.__init__(self)
 
 
1775
       self.limbo_dir = limbo_dir
 
 
1778
class OutOfDateTree(BzrError):
 
 
1780
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
 
1782
    def __init__(self, tree):
 
 
1783
        BzrError.__init__(self)
 
 
1787
class PublicBranchOutOfDate(BzrError):
 
 
1789
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
 
1792
    def __init__(self, public_location, revstring):
 
 
1793
        import bzrlib.urlutils as urlutils
 
 
1794
        public_location = urlutils.unescape_for_display(public_location,
 
 
1796
        BzrError.__init__(self, public_location=public_location,
 
 
1797
                          revstring=revstring)
 
 
1800
class MergeModifiedFormatError(BzrError):
 
 
1802
    _fmt = "Error in merge modified format"
 
 
1805
class ConflictFormatError(BzrError):
 
 
1807
    _fmt = "Format error in conflict listings"
 
 
1810
class CorruptRepository(BzrError):
 
 
1812
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
 
1813
            "Please run bzr reconcile on this repository.")
 
 
1815
    def __init__(self, repo):
 
 
1816
        BzrError.__init__(self)
 
 
1817
        self.repo_path = repo.bzrdir.root_transport.base
 
 
1820
class UpgradeRequired(BzrError):
 
 
1822
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
 
1824
    def __init__(self, path):
 
 
1825
        BzrError.__init__(self)
 
 
1829
class LocalRequiresBoundBranch(BzrError):
 
 
1831
    _fmt = "Cannot perform local-only commits on unbound branches."
 
 
1834
class MissingProgressBarFinish(BzrError):
 
 
1836
    _fmt = "A nested progress bar was not 'finished' correctly."
 
 
1839
class InvalidProgressBarType(BzrError):
 
 
1841
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
 
1842
            " is not a supported type Select one of: %(valid_types)s")
 
 
1844
    def __init__(self, bar_type, valid_types):
 
 
1845
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
1848
class UnsupportedOperation(BzrError):
 
 
1850
    _fmt = ("The method %(mname)s is not supported on"
 
 
1851
            " objects of type %(tname)s.")
 
 
1853
    def __init__(self, method, method_self):
 
 
1854
        self.method = method
 
 
1855
        self.mname = method.__name__
 
 
1856
        self.tname = type(method_self).__name__
 
 
1859
class CannotSetRevisionId(UnsupportedOperation):
 
 
1860
    """Raised when a commit is attempting to set a revision id but cant."""
 
 
1863
class NonAsciiRevisionId(UnsupportedOperation):
 
 
1864
    """Raised when a commit is attempting to set a non-ascii revision id
 
 
1869
class BinaryFile(BzrError):
 
 
1871
    _fmt = "File is binary but should be text."
 
 
1874
class IllegalPath(BzrError):
 
 
1876
    _fmt = "The path %(path)s is not permitted on this platform"
 
 
1878
    def __init__(self, path):
 
 
1879
        BzrError.__init__(self)
 
 
1883
class TestamentMismatch(BzrError):
 
 
1885
    _fmt = """Testament did not match expected value.
 
 
1886
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
 
1889
    def __init__(self, revision_id, expected, measured):
 
 
1890
        self.revision_id = revision_id
 
 
1891
        self.expected = expected
 
 
1892
        self.measured = measured
 
 
1895
class NotABundle(BzrError):
 
 
1897
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
 
1899
    def __init__(self, text):
 
 
1900
        BzrError.__init__(self)
 
 
1904
class BadBundle(BzrError): 
 
 
1906
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
 
1908
    def __init__(self, text):
 
 
1909
        BzrError.__init__(self)
 
 
1913
class MalformedHeader(BadBundle): 
 
 
1915
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
 
1918
class MalformedPatches(BadBundle): 
 
 
1920
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
 
1923
class MalformedFooter(BadBundle): 
 
 
1925
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
 
1928
class UnsupportedEOLMarker(BadBundle):
 
 
1930
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
 
1933
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
 
1934
        # but for this there is not
 
 
1935
        BzrError.__init__(self)
 
 
1938
class IncompatibleBundleFormat(BzrError):
 
 
1940
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
 
1942
    def __init__(self, bundle_format, other):
 
 
1943
        BzrError.__init__(self)
 
 
1944
        self.bundle_format = bundle_format
 
 
1948
class BadInventoryFormat(BzrError):
 
 
1950
    _fmt = "Root class for inventory serialization errors"
 
 
1953
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
1955
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
 
1957
    def __init__(self, msg):
 
 
1958
        BadInventoryFormat.__init__(self, msg=msg)
 
 
1961
class RootNotRich(BzrError):
 
 
1963
    _fmt = """This operation requires rich root data storage"""
 
 
1966
class NoSmartMedium(BzrError):
 
 
1968
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
 
1970
    internal_error = True
 
 
1972
    def __init__(self, transport):
 
 
1973
        self.transport = transport
 
 
1976
class NoSmartServer(NotBranchError):
 
 
1978
    _fmt = "No smart server available at %(url)s"
 
 
1980
    def __init__(self, url):
 
 
1984
class UnknownSSH(BzrError):
 
 
1986
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
 
1988
    def __init__(self, vendor):
 
 
1989
        BzrError.__init__(self)
 
 
1990
        self.vendor = vendor
 
 
1993
class SSHVendorNotFound(BzrError):
 
 
1995
    _fmt = ("Don't know how to handle SSH connections."
 
 
1996
            " Please set BZR_SSH environment variable.")
 
 
1999
class GhostRevisionUnusableHere(BzrError):
 
 
2001
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
 
2003
    def __init__(self, revision_id):
 
 
2004
        BzrError.__init__(self)
 
 
2005
        self.revision_id = revision_id
 
 
2008
class IllegalUseOfScopeReplacer(BzrError):
 
 
2010
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
 
2011
            " %(msg)s%(extra)s")
 
 
2013
    internal_error = True
 
 
2015
    def __init__(self, name, msg, extra=None):
 
 
2016
        BzrError.__init__(self)
 
 
2020
            self.extra = ': ' + str(extra)
 
 
2025
class InvalidImportLine(BzrError):
 
 
2027
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
 
2029
    internal_error = True
 
 
2031
    def __init__(self, text, msg):
 
 
2032
        BzrError.__init__(self)
 
 
2037
class ImportNameCollision(BzrError):
 
 
2039
    _fmt = ("Tried to import an object to the same name as"
 
 
2040
            " an existing object. %(name)s")
 
 
2042
    internal_error = True
 
 
2044
    def __init__(self, name):
 
 
2045
        BzrError.__init__(self)
 
 
2049
class NotAMergeDirective(BzrError):
 
 
2050
    """File starting with %(firstline)r is not a merge directive"""
 
 
2051
    def __init__(self, firstline):
 
 
2052
        BzrError.__init__(self, firstline=firstline)
 
 
2055
class NoMergeSource(BzrError):
 
 
2056
    """Raise if no merge source was specified for a merge directive"""
 
 
2058
    _fmt = "A merge directive must provide either a bundle or a public"\
 
 
2062
class PatchMissing(BzrError):
 
 
2063
    """Raise a patch type was specified but no patch supplied"""
 
 
2065
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
 
2067
    def __init__(self, patch_type):
 
 
2068
        BzrError.__init__(self)
 
 
2069
        self.patch_type = patch_type
 
 
2072
class UnsupportedInventoryKind(BzrError):
 
 
2074
    _fmt = """Unsupported entry kind %(kind)s"""
 
 
2076
    def __init__(self, kind):
 
 
2080
class BadSubsumeSource(BzrError):
 
 
2082
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
 
 
2084
    def __init__(self, tree, other_tree, reason):
 
 
2086
        self.other_tree = other_tree
 
 
2087
        self.reason = reason
 
 
2090
class SubsumeTargetNeedsUpgrade(BzrError):
 
 
2092
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
 
2094
    def __init__(self, other_tree):
 
 
2095
        self.other_tree = other_tree
 
 
2098
class BadReferenceTarget(BzrError):
 
 
2100
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
 
2102
    internal_error = True
 
 
2104
    def __init__(self, tree, other_tree, reason):
 
 
2106
        self.other_tree = other_tree
 
 
2107
        self.reason = reason
 
 
2110
class NoSuchTag(BzrError):
 
 
2112
    _fmt = "No such tag: %(tag_name)s"
 
 
2114
    def __init__(self, tag_name):
 
 
2115
        self.tag_name = tag_name
 
 
2118
class TagsNotSupported(BzrError):
 
 
2120
    _fmt = ("Tags not supported by %(branch)s;"
 
 
2121
            " you may be able to use bzr upgrade --dirstate-tags.")
 
 
2123
    def __init__(self, branch):
 
 
2124
        self.branch = branch
 
 
2127
class TagAlreadyExists(BzrError):
 
 
2129
    _fmt = "Tag %(tag_name)s already exists."
 
 
2131
    def __init__(self, tag_name):
 
 
2132
        self.tag_name = tag_name
 
 
2135
class MalformedBugIdentifier(BzrError):
 
 
2137
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
 
2139
    def __init__(self, bug_id, reason):
 
 
2140
        self.bug_id = bug_id
 
 
2141
        self.reason = reason
 
 
2144
class UnknownBugTrackerAbbreviation(BzrError):
 
 
2146
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
 
2149
    def __init__(self, abbreviation, branch):
 
 
2150
        self.abbreviation = abbreviation
 
 
2151
        self.branch = branch
 
 
2154
class UnexpectedSmartServerResponse(BzrError):
 
 
2156
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
 
2158
    def __init__(self, response_tuple):
 
 
2159
        self.response_tuple = response_tuple
 
 
2162
class ContainerError(BzrError):
 
 
2163
    """Base class of container errors."""
 
 
2166
class UnknownContainerFormatError(ContainerError):
 
 
2168
    _fmt = "Unrecognised container format: %(container_format)r"
 
 
2170
    def __init__(self, container_format):
 
 
2171
        self.container_format = container_format
 
 
2174
class UnexpectedEndOfContainerError(ContainerError):
 
 
2176
    _fmt = "Unexpected end of container stream"
 
 
2178
    internal_error = False
 
 
2181
class UnknownRecordTypeError(ContainerError):
 
 
2183
    _fmt = "Unknown record type: %(record_type)r"
 
 
2185
    def __init__(self, record_type):
 
 
2186
        self.record_type = record_type
 
 
2189
class InvalidRecordError(ContainerError):
 
 
2191
    _fmt = "Invalid record: %(reason)s"
 
 
2193
    def __init__(self, reason):
 
 
2194
        self.reason = reason
 
 
2197
class ContainerHasExcessDataError(ContainerError):
 
 
2199
    _fmt = "Container has data after end marker: %(excess)r"
 
 
2201
    def __init__(self, excess):
 
 
2202
        self.excess = excess
 
 
2205
class DuplicateRecordNameError(ContainerError):
 
 
2207
    _fmt = "Container has multiple records with the same name: \"%(name)s\""
 
 
2209
    def __init__(self, name):
 
 
2213
class NoDestinationAddress(BzrError):
 
 
2215
    _fmt = "Message does not have a destination address."
 
 
2217
    internal_error = True
 
 
2220
class SMTPError(BzrError):
 
 
2222
    _fmt = "SMTP error: %(error)s"
 
 
2224
    def __init__(self, error):