1
# Copyright (C) 2005, 2006, 2007, 2008 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
# return codes from the bzr program
 
 
50
EXIT_INTERNAL_ERROR = 4
 
 
53
class BzrError(StandardError):
 
 
55
    Base class for errors raised by bzrlib.
 
 
57
    :cvar internal_error: if True this was probably caused by a bzr bug and
 
 
58
    should be displayed with a traceback; if False (or absent) this was
 
 
59
    probably a user or environment error and they don't need the gory details.
 
 
60
    (That can be overridden by -Derror on the command line.)
 
 
62
    :cvar _fmt: Format string to display the error; this is expanded
 
 
63
    by the instance's dict.
 
 
66
    internal_error = False
 
 
68
    def __init__(self, msg=None, **kwds):
 
 
69
        """Construct a new BzrError.
 
 
71
        There are two alternative forms for constructing these objects.
 
 
72
        Either a preformatted string may be passed, or a set of named
 
 
73
        arguments can be given.  The first is for generic "user" errors which
 
 
74
        are not intended to be caught and so do not need a specific subclass.
 
 
75
        The second case is for use with subclasses that provide a _fmt format
 
 
76
        string to print the arguments.  
 
 
78
        Keyword arguments are taken as parameters to the error, which can 
 
 
79
        be inserted into the format string template.  It's recommended 
 
 
80
        that subclasses override the __init__ method to require specific 
 
 
83
        :param msg: If given, this is the literal complete text for the error,
 
 
84
        not subject to expansion.
 
 
86
        StandardError.__init__(self)
 
 
88
            # I was going to deprecate this, but it actually turns out to be
 
 
89
            # quite handy - mbp 20061103.
 
 
90
            self._preformatted_string = msg
 
 
92
            self._preformatted_string = None
 
 
93
            for key, value in kwds.items():
 
 
94
                setattr(self, key, value)
 
 
97
        s = getattr(self, '_preformatted_string', None)
 
 
99
            # contains a preformatted message; must be cast to plain str
 
 
102
            fmt = self._get_format_string()
 
 
104
                d = dict(self.__dict__)
 
 
105
                # special case: python2.5 puts the 'message' attribute in a
 
 
106
                # slot, so it isn't seen in __dict__
 
 
107
                d['message'] = getattr(self, 'message', 'no message')
 
 
109
                # __str__() should always return a 'str' object
 
 
110
                # never a 'unicode' object.
 
 
111
                if isinstance(s, unicode):
 
 
112
                    return s.encode('utf8')
 
 
114
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
 
 
115
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
 
116
                % (self.__class__.__name__,
 
 
118
                   getattr(self, '_fmt', None),
 
 
121
    def _get_format_string(self):
 
 
122
        """Return format string for this exception or None"""
 
 
123
        fmt = getattr(self, '_fmt', None)
 
 
126
        fmt = getattr(self, '__doc__', None)
 
 
128
            symbol_versioning.warn("%s uses its docstring as a format, "
 
 
129
                    "it should use _fmt instead" % self.__class__.__name__,
 
 
132
        return 'Unprintable exception %s: dict=%r, fmt=%r' \
 
 
133
            % (self.__class__.__name__,
 
 
135
               getattr(self, '_fmt', None),
 
 
139
class InternalBzrError(BzrError):
 
 
140
    """Base class for errors that are internal in nature.
 
 
142
    This is a convenience class for errors that are internal. The
 
 
143
    internal_error attribute can still be altered in subclasses, if needed.
 
 
144
    Using this class is simply an easy way to get internal errors.
 
 
147
    internal_error = True
 
 
150
class BzrNewError(BzrError):
 
 
151
    """Deprecated error base class."""
 
 
152
    # base classes should override the docstring with their human-
 
 
153
    # readable explanation
 
 
155
    def __init__(self, *args, **kwds):
 
 
156
        # XXX: Use the underlying BzrError to always generate the args
 
 
157
        # attribute if it doesn't exist.  We can't use super here, because
 
 
158
        # exceptions are old-style classes in python2.4 (but new in 2.5).
 
 
160
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
 
 
161
             'please convert %s to use BzrError instead'
 
 
162
             % self.__class__.__name__,
 
 
165
        BzrError.__init__(self, *args)
 
 
166
        for key, value in kwds.items():
 
 
167
            setattr(self, key, value)
 
 
171
            # __str__() should always return a 'str' object
 
 
172
            # never a 'unicode' object.
 
 
173
            s = self.__doc__ % self.__dict__
 
 
174
            if isinstance(s, unicode):
 
 
175
                return s.encode('utf8')
 
 
177
        except (TypeError, NameError, ValueError, KeyError), e:
 
 
178
            return 'Unprintable exception %s(%r): %r' \
 
 
179
                % (self.__class__.__name__,
 
 
183
class AlreadyBuilding(BzrError):
 
 
185
    _fmt = "The tree builder is already building a tree."
 
 
188
class BzrCheckError(InternalBzrError):
 
 
190
    _fmt = "Internal check failed: %(message)s"
 
 
192
    def __init__(self, message):
 
 
193
        BzrError.__init__(self)
 
 
194
        self.message = message
 
 
197
class DisabledMethod(InternalBzrError):
 
 
199
    _fmt = "The smart server method '%(class_name)s' is disabled."
 
 
201
    def __init__(self, class_name):
 
 
202
        BzrError.__init__(self)
 
 
203
        self.class_name = class_name
 
 
206
class IncompatibleAPI(BzrError):
 
 
208
    _fmt = 'The API for "%(api)s" is not compatible with "%(wanted)s". '\
 
 
209
        'It supports versions "%(minimum)s" to "%(current)s".'
 
 
211
    def __init__(self, api, wanted, minimum, current):
 
 
214
        self.minimum = minimum
 
 
215
        self.current = current
 
 
218
class InProcessTransport(BzrError):
 
 
220
    _fmt = "The transport '%(transport)s' is only accessible within this " \
 
 
223
    def __init__(self, transport):
 
 
224
        self.transport = transport
 
 
227
class InvalidEntryName(InternalBzrError):
 
 
229
    _fmt = "Invalid entry name: %(name)s"
 
 
231
    def __init__(self, name):
 
 
232
        BzrError.__init__(self)
 
 
236
class InvalidRevisionNumber(BzrError):
 
 
238
    _fmt = "Invalid revision number %(revno)s"
 
 
240
    def __init__(self, revno):
 
 
241
        BzrError.__init__(self)
 
 
245
class InvalidRevisionId(BzrError):
 
 
247
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
 
249
    def __init__(self, revision_id, branch):
 
 
250
        # branch can be any string or object with __str__ defined
 
 
251
        BzrError.__init__(self)
 
 
252
        self.revision_id = revision_id
 
 
256
class ReservedId(BzrError):
 
 
258
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
 
260
    def __init__(self, revision_id):
 
 
261
        self.revision_id = revision_id
 
 
264
class RootMissing(InternalBzrError):
 
 
266
    _fmt = ("The root entry of a tree must be the first entry supplied to "
 
 
267
        "record_entry_contents.")
 
 
270
class NoPublicBranch(BzrError):
 
 
272
    _fmt = 'There is no public branch set for "%(branch_url)s".'
 
 
274
    def __init__(self, branch):
 
 
275
        import bzrlib.urlutils as urlutils
 
 
276
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
 
 
277
        BzrError.__init__(self, branch_url=public_location)
 
 
280
class NoHelpTopic(BzrError):
 
 
282
    _fmt = ("No help could be found for '%(topic)s'. "
 
 
283
        "Please use 'bzr help topics' to obtain a list of topics.")
 
 
285
    def __init__(self, topic):
 
 
289
class NoSuchId(BzrError):
 
 
291
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
 
 
293
    def __init__(self, tree, file_id):
 
 
294
        BzrError.__init__(self)
 
 
295
        self.file_id = file_id
 
 
299
class NoSuchIdInRepository(NoSuchId):
 
 
301
    _fmt = ('The file id "%(file_id)s" is not present in the repository'
 
 
304
    def __init__(self, repository, file_id):
 
 
305
        BzrError.__init__(self, repository=repository, file_id=file_id)
 
 
308
class InventoryModified(InternalBzrError):
 
 
310
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
 
311
            " so a clean inventory cannot be read without data loss.")
 
 
313
    def __init__(self, tree):
 
 
317
class NoWorkingTree(BzrError):
 
 
319
    _fmt = 'No WorkingTree exists for "%(base)s".'
 
 
321
    def __init__(self, base):
 
 
322
        BzrError.__init__(self)
 
 
326
class NotBuilding(BzrError):
 
 
328
    _fmt = "Not currently building a tree."
 
 
331
class NotLocalUrl(BzrError):
 
 
333
    _fmt = "%(url)s is not a local path."
 
 
335
    def __init__(self, url):
 
 
339
class WorkingTreeAlreadyPopulated(InternalBzrError):
 
 
341
    _fmt = 'Working tree already populated in "%(base)s"'
 
 
343
    def __init__(self, base):
 
 
347
class BzrCommandError(BzrError):
 
 
348
    """Error from user command"""
 
 
350
    # Error from malformed user command; please avoid raising this as a
 
 
351
    # generic exception not caused by user input.
 
 
353
    # I think it's a waste of effort to differentiate between errors that
 
 
354
    # are not intended to be caught anyway.  UI code need not subclass
 
 
355
    # BzrCommandError, and non-UI code should not throw a subclass of
 
 
356
    # BzrCommandError.  ADHB 20051211
 
 
357
    def __init__(self, msg):
 
 
358
        # Object.__str__() must return a real string
 
 
359
        # returning a Unicode string is a python error.
 
 
360
        if isinstance(msg, unicode):
 
 
361
            self.msg = msg.encode('utf8')
 
 
369
class NotWriteLocked(BzrError):
 
 
371
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
 
373
    def __init__(self, not_locked):
 
 
374
        self.not_locked = not_locked
 
 
377
class BzrOptionError(BzrCommandError):
 
 
379
    _fmt = "Error in command line options"
 
 
382
class BadIndexFormatSignature(BzrError):
 
 
384
    _fmt = "%(value)s is not an index of type %(_type)s."
 
 
386
    def __init__(self, value, _type):
 
 
387
        BzrError.__init__(self)
 
 
392
class BadIndexData(BzrError):
 
 
394
    _fmt = "Error in data for index %(value)s."
 
 
396
    def __init__(self, value):
 
 
397
        BzrError.__init__(self)
 
 
401
class BadIndexDuplicateKey(BzrError):
 
 
403
    _fmt = "The key '%(key)s' is already in index '%(index)s'."
 
 
405
    def __init__(self, key, index):
 
 
406
        BzrError.__init__(self)
 
 
411
class BadIndexKey(BzrError):
 
 
413
    _fmt = "The key '%(key)s' is not a valid key."
 
 
415
    def __init__(self, key):
 
 
416
        BzrError.__init__(self)
 
 
420
class BadIndexOptions(BzrError):
 
 
422
    _fmt = "Could not parse options for index %(value)s."
 
 
424
    def __init__(self, value):
 
 
425
        BzrError.__init__(self)
 
 
429
class BadIndexValue(BzrError):
 
 
431
    _fmt = "The value '%(value)s' is not a valid value."
 
 
433
    def __init__(self, value):
 
 
434
        BzrError.__init__(self)
 
 
438
class BadOptionValue(BzrError):
 
 
440
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
 
442
    def __init__(self, name, value):
 
 
443
        BzrError.__init__(self, name=name, value=value)
 
 
446
class StrictCommitFailed(BzrError):
 
 
448
    _fmt = "Commit refused because there are unknown files in the tree"
 
 
451
# XXX: Should be unified with TransportError; they seem to represent the
 
 
453
# RBC 20060929: I think that unifiying with TransportError would be a mistake
 
 
454
# - this is finer than a TransportError - and more useful as such. It 
 
 
455
# differentiates between 'transport has failed' and 'operation on a transport
 
 
457
class PathError(BzrError):
 
 
459
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
 
461
    def __init__(self, path, extra=None):
 
 
462
        BzrError.__init__(self)
 
 
465
            self.extra = ': ' + str(extra)
 
 
470
class NoSuchFile(PathError):
 
 
472
    _fmt = "No such file: %(path)r%(extra)s"
 
 
475
class FileExists(PathError):
 
 
477
    _fmt = "File exists: %(path)r%(extra)s"
 
 
480
class RenameFailedFilesExist(BzrError):
 
 
481
    """Used when renaming and both source and dest exist."""
 
 
483
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
 
484
            " (Use --after to tell bzr about a rename that has already"
 
 
485
            " happened)%(extra)s")
 
 
487
    def __init__(self, source, dest, extra=None):
 
 
488
        BzrError.__init__(self)
 
 
489
        self.source = str(source)
 
 
490
        self.dest = str(dest)
 
 
492
            self.extra = ' ' + str(extra)
 
 
497
class NotADirectory(PathError):
 
 
499
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
 
502
class NotInWorkingDirectory(PathError):
 
 
504
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
 
 
507
class DirectoryNotEmpty(PathError):
 
 
509
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
 
 
512
class HardLinkNotSupported(PathError):
 
 
514
    _fmt = 'Hard-linking "%(path)s" is not supported'
 
 
517
class ReadingCompleted(InternalBzrError):
 
 
519
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
 
520
            "called upon it - the request has been completed and no more "
 
 
523
    def __init__(self, request):
 
 
524
        self.request = request
 
 
527
class ResourceBusy(PathError):
 
 
529
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
 
 
532
class PermissionDenied(PathError):
 
 
534
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
 
537
class InvalidURL(PathError):
 
 
539
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
 
542
class InvalidURLJoin(PathError):
 
 
544
    _fmt = 'Invalid URL join request: "%(args)s"%(extra)s'
 
 
546
    def __init__(self, msg, base, args):
 
 
547
        PathError.__init__(self, base, msg)
 
 
548
        self.args = [base] + list(args)
 
 
551
class UnknownHook(BzrError):
 
 
553
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
 
555
    def __init__(self, hook_type, hook_name):
 
 
556
        BzrError.__init__(self)
 
 
557
        self.type = hook_type
 
 
558
        self.hook = hook_name
 
 
561
class UnsupportedProtocol(PathError):
 
 
563
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
 
565
    def __init__(self, url, extra):
 
 
566
        PathError.__init__(self, url, extra=extra)
 
 
569
class ReadError(PathError):
 
 
571
    _fmt = """Error reading from %(path)r."""
 
 
574
class ShortReadvError(PathError):
 
 
576
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
 
 
577
            ' at %(offset)s for "%(path)s"%(extra)s')
 
 
579
    internal_error = True
 
 
581
    def __init__(self, path, offset, length, actual, extra=None):
 
 
582
        PathError.__init__(self, path, extra=extra)
 
 
588
class PathNotChild(PathError):
 
 
590
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
 
592
    internal_error = True
 
 
594
    def __init__(self, path, base, extra=None):
 
 
595
        BzrError.__init__(self)
 
 
599
            self.extra = ': ' + str(extra)
 
 
604
class InvalidNormalization(PathError):
 
 
606
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
 
609
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
610
# the exception object is a bit undesirable.
 
 
611
# TODO: Probably this behavior of should be a common superclass 
 
 
612
class NotBranchError(PathError):
 
 
614
    _fmt = 'Not a branch: "%(path)s".'
 
 
616
    def __init__(self, path):
 
 
617
       import bzrlib.urlutils as urlutils
 
 
618
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
621
class NoSubmitBranch(PathError):
 
 
623
    _fmt = 'No submit branch available for branch "%(path)s"'
 
 
625
    def __init__(self, branch):
 
 
626
       import bzrlib.urlutils as urlutils
 
 
627
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
 
630
class AlreadyBranchError(PathError):
 
 
632
    _fmt = 'Already a branch: "%(path)s".'
 
 
635
class BranchExistsWithoutWorkingTree(PathError):
 
 
637
    _fmt = 'Directory contains a branch, but no working tree \
 
 
638
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
 
641
class AtomicFileAlreadyClosed(PathError):
 
 
643
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
 
646
    def __init__(self, path, function):
 
 
647
        PathError.__init__(self, path=path, extra=None)
 
 
648
        self.function = function
 
 
651
class InaccessibleParent(PathError):
 
 
653
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
 
654
            ' relative path "%(path)s"')
 
 
656
    def __init__(self, path, base):
 
 
657
        PathError.__init__(self, path)
 
 
661
class NoRepositoryPresent(BzrError):
 
 
663
    _fmt = 'No repository present: "%(path)s"'
 
 
664
    def __init__(self, bzrdir):
 
 
665
        BzrError.__init__(self)
 
 
666
        self.path = bzrdir.transport.clone('..').base
 
 
669
class FileInWrongBranch(BzrError):
 
 
671
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
 
673
    def __init__(self, branch, path):
 
 
674
        BzrError.__init__(self)
 
 
676
        self.branch_base = branch.base
 
 
680
class UnsupportedFormatError(BzrError):
 
 
682
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
 
 
685
class UnknownFormatError(BzrError):
 
 
687
    _fmt = "Unknown %(kind)s format: %(format)r"
 
 
689
    def __init__(self, format, kind='branch'):
 
 
694
class IncompatibleFormat(BzrError):
 
 
696
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
 
698
    def __init__(self, format, bzrdir_format):
 
 
699
        BzrError.__init__(self)
 
 
701
        self.bzrdir = bzrdir_format
 
 
704
class IncompatibleRepositories(BzrError):
 
 
706
    _fmt = "Repository %(target)s is not compatible with repository"\
 
 
709
    def __init__(self, source, target):
 
 
710
        BzrError.__init__(self, target=target, source=source)
 
 
713
class IncompatibleRevision(BzrError):
 
 
715
    _fmt = "Revision is not compatible with %(repo_format)s"
 
 
717
    def __init__(self, repo_format):
 
 
718
        BzrError.__init__(self)
 
 
719
        self.repo_format = repo_format
 
 
722
class AlreadyVersionedError(BzrError):
 
 
723
    """Used when a path is expected not to be versioned, but it is."""
 
 
725
    _fmt = "%(context_info)s%(path)s is already versioned."
 
 
727
    def __init__(self, path, context_info=None):
 
 
728
        """Construct a new AlreadyVersionedError.
 
 
730
        :param path: This is the path which is versioned,
 
 
731
        which should be in a user friendly form.
 
 
732
        :param context_info: If given, this is information about the context,
 
 
733
        which could explain why this is expected to not be versioned.
 
 
735
        BzrError.__init__(self)
 
 
737
        if context_info is None:
 
 
738
            self.context_info = ''
 
 
740
            self.context_info = context_info + ". "
 
 
743
class NotVersionedError(BzrError):
 
 
744
    """Used when a path is expected to be versioned, but it is not."""
 
 
746
    _fmt = "%(context_info)s%(path)s is not versioned."
 
 
748
    def __init__(self, path, context_info=None):
 
 
749
        """Construct a new NotVersionedError.
 
 
751
        :param path: This is the path which is not versioned,
 
 
752
        which should be in a user friendly form.
 
 
753
        :param context_info: If given, this is information about the context,
 
 
754
        which could explain why this is expected to be versioned.
 
 
756
        BzrError.__init__(self)
 
 
758
        if context_info is None:
 
 
759
            self.context_info = ''
 
 
761
            self.context_info = context_info + ". "
 
 
764
class PathsNotVersionedError(BzrError):
 
 
765
    """Used when reporting several paths which are not versioned"""
 
 
767
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
 
769
    def __init__(self, paths):
 
 
770
        from bzrlib.osutils import quotefn
 
 
771
        BzrError.__init__(self)
 
 
773
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
776
class PathsDoNotExist(BzrError):
 
 
778
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
 
780
    # used when reporting that paths are neither versioned nor in the working
 
 
783
    def __init__(self, paths, extra=None):
 
 
785
        from bzrlib.osutils import quotefn
 
 
786
        BzrError.__init__(self)
 
 
788
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
790
            self.extra = ': ' + str(extra)
 
 
795
class BadFileKindError(BzrError):
 
 
797
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
 
799
    def __init__(self, filename, kind):
 
 
800
        BzrError.__init__(self, filename=filename, kind=kind)
 
 
803
class ForbiddenControlFileError(BzrError):
 
 
805
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
 
808
class LockError(InternalBzrError):
 
 
810
    _fmt = "Lock error: %(msg)s"
 
 
812
    # All exceptions from the lock/unlock functions should be from
 
 
813
    # this exception class.  They will be translated as necessary. The
 
 
814
    # original exception is available as e.original_error
 
 
816
    # New code should prefer to raise specific subclasses
 
 
817
    def __init__(self, message):
 
 
818
        # Python 2.5 uses a slot for StandardError.message,
 
 
819
        # so use a different variable name.  We now work around this in
 
 
820
        # BzrError.__str__, but this member name is kept for compatability.
 
 
824
class LockActive(LockError):
 
 
826
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
 
828
    internal_error = False
 
 
830
    def __init__(self, lock_description):
 
 
831
        self.lock_description = lock_description
 
 
834
class CommitNotPossible(LockError):
 
 
836
    _fmt = "A commit was attempted but we do not have a write lock open."
 
 
842
class AlreadyCommitted(LockError):
 
 
844
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
 
850
class ReadOnlyError(LockError):
 
 
852
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
 
854
    # TODO: There should also be an error indicating that you need a write
 
 
855
    # lock and don't have any lock at all... mbp 20070226
 
 
857
    def __init__(self, obj):
 
 
861
class ReadOnlyLockError(LockError):
 
 
863
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
 
865
    @symbol_versioning.deprecated_method(symbol_versioning.zero_ninetytwo)
 
 
866
    def __init__(self, fname, msg):
 
 
867
        LockError.__init__(self, '')
 
 
872
class LockFailed(LockError):
 
 
874
    internal_error = False
 
 
876
    _fmt = "Cannot lock %(lock)s: %(why)s"
 
 
878
    def __init__(self, lock, why):
 
 
879
        LockError.__init__(self, '')
 
 
884
class OutSideTransaction(BzrError):
 
 
886
    _fmt = ("A transaction related operation was attempted after"
 
 
887
            " the transaction finished.")
 
 
890
class ObjectNotLocked(LockError):
 
 
892
    _fmt = "%(obj)r is not locked"
 
 
894
    # this can indicate that any particular object is not locked; see also
 
 
895
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
896
    # the caller -- perhaps they should be unified.
 
 
897
    def __init__(self, obj):
 
 
901
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
903
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
 
905
    def __init__(self, obj):
 
 
909
class UnlockableTransport(LockError):
 
 
911
    internal_error = False
 
 
913
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
 
915
    def __init__(self, transport):
 
 
916
        self.transport = transport
 
 
919
class LockContention(LockError):
 
 
921
    _fmt = 'Could not acquire lock "%(lock)s"'
 
 
922
    # TODO: show full url for lock, combining the transport and relative
 
 
925
    internal_error = False
 
 
927
    def __init__(self, lock):
 
 
931
class LockBroken(LockError):
 
 
933
    _fmt = ("Lock was broken while still open: %(lock)s"
 
 
934
            " - check storage consistency!")
 
 
936
    internal_error = False
 
 
938
    def __init__(self, lock):
 
 
942
class LockBreakMismatch(LockError):
 
 
944
    _fmt = ("Lock was released and re-acquired before being broken:"
 
 
945
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
 
947
    internal_error = False
 
 
949
    def __init__(self, lock, holder, target):
 
 
955
class LockNotHeld(LockError):
 
 
957
    _fmt = "Lock not held: %(lock)s"
 
 
959
    internal_error = False
 
 
961
    def __init__(self, lock):
 
 
965
class TokenLockingNotSupported(LockError):
 
 
967
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
 
969
    def __init__(self, obj):
 
 
973
class TokenMismatch(LockBroken):
 
 
975
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
 
977
    internal_error = True
 
 
979
    def __init__(self, given_token, lock_token):
 
 
980
        self.given_token = given_token
 
 
981
        self.lock_token = lock_token
 
 
984
class PointlessCommit(BzrError):
 
 
986
    _fmt = "No changes to commit"
 
 
989
class CannotCommitSelectedFileMerge(BzrError):
 
 
991
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
 
992
        ' files %(files_str)s'
 
 
994
    def __init__(self, files):
 
 
995
        files_str = ', '.join(files)
 
 
996
        BzrError.__init__(self, files=files, files_str=files_str)
 
 
999
class BadCommitMessageEncoding(BzrError):
 
 
1001
    _fmt = 'The specified commit message contains characters unsupported by '\
 
 
1002
        'the current encoding.'
 
 
1005
class UpgradeReadonly(BzrError):
 
 
1007
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
 
1010
class UpToDateFormat(BzrError):
 
 
1012
    _fmt = "The branch format %(format)s is already at the most recent format."
 
 
1014
    def __init__(self, format):
 
 
1015
        BzrError.__init__(self)
 
 
1016
        self.format = format
 
 
1019
class StrictCommitFailed(Exception):
 
 
1021
    _fmt = "Commit refused because there are unknowns in the tree."
 
 
1024
class NoSuchRevision(InternalBzrError):
 
 
1026
    _fmt = "%(branch)s has no revision %(revision)s"
 
 
1028
    def __init__(self, branch, revision):
 
 
1029
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
 
 
1030
        BzrError.__init__(self, branch=branch, revision=revision)
 
 
1033
# zero_ninetyone: this exception is no longer raised and should be removed
 
 
1034
class NotLeftParentDescendant(InternalBzrError):
 
 
1036
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
 
1037
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
 
1039
    def __init__(self, branch, old_revision, new_revision):
 
 
1040
        BzrError.__init__(self, branch_location=branch.base,
 
 
1041
                          old_revision=old_revision,
 
 
1042
                          new_revision=new_revision)
 
 
1045
class RangeInChangeOption(BzrError):
 
 
1047
    _fmt = "Option --change does not accept revision ranges"
 
 
1050
class NoSuchRevisionSpec(BzrError):
 
 
1052
    _fmt = "No namespace registered for string: %(spec)r"
 
 
1054
    def __init__(self, spec):
 
 
1055
        BzrError.__init__(self, spec=spec)
 
 
1058
class NoSuchRevisionInTree(NoSuchRevision):
 
 
1059
    """When using Tree.revision_tree, and the revision is not accessible."""
 
 
1061
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
 
1063
    def __init__(self, tree, revision_id):
 
 
1064
        BzrError.__init__(self)
 
 
1066
        self.revision_id = revision_id
 
 
1069
class InvalidRevisionSpec(BzrError):
 
 
1071
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
 
1072
            " %(branch)s%(extra)s")
 
 
1074
    def __init__(self, spec, branch, extra=None):
 
 
1075
        BzrError.__init__(self, branch=branch, spec=spec)
 
 
1077
            self.extra = '\n' + str(extra)
 
 
1082
class HistoryMissing(BzrError):
 
 
1084
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
 
1087
class AppendRevisionsOnlyViolation(BzrError):
 
 
1089
    _fmt = ('Operation denied because it would change the main history,'
 
 
1090
           ' which is not permitted by the append_revisions_only setting on'
 
 
1091
           ' branch "%(location)s".')
 
 
1093
    def __init__(self, location):
 
 
1094
       import bzrlib.urlutils as urlutils
 
 
1095
       location = urlutils.unescape_for_display(location, 'ascii')
 
 
1096
       BzrError.__init__(self, location=location)
 
 
1099
class DivergedBranches(BzrError):
 
 
1101
    _fmt = ("These branches have diverged."
 
 
1102
            " Use the merge command to reconcile them.")
 
 
1104
    def __init__(self, branch1, branch2):
 
 
1105
        self.branch1 = branch1
 
 
1106
        self.branch2 = branch2
 
 
1109
class NotLefthandHistory(InternalBzrError):
 
 
1111
    _fmt = "Supplied history does not follow left-hand parents"
 
 
1113
    def __init__(self, history):
 
 
1114
        BzrError.__init__(self, history=history)
 
 
1117
class UnrelatedBranches(BzrError):
 
 
1119
    _fmt = ("Branches have no common ancestor, and"
 
 
1120
            " no merge base revision was specified.")
 
 
1123
class CannotReverseCherrypick(BzrError):
 
 
1125
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
 
1129
class NoCommonAncestor(BzrError):
 
 
1131
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
1133
    def __init__(self, revision_a, revision_b):
 
 
1134
        self.revision_a = revision_a
 
 
1135
        self.revision_b = revision_b
 
 
1138
class NoCommonRoot(BzrError):
 
 
1140
    _fmt = ("Revisions are not derived from the same root: "
 
 
1141
           "%(revision_a)s %(revision_b)s.")
 
 
1143
    def __init__(self, revision_a, revision_b):
 
 
1144
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
 
1147
class NotAncestor(BzrError):
 
 
1149
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
 
1151
    def __init__(self, rev_id, not_ancestor_id):
 
 
1152
        BzrError.__init__(self, rev_id=rev_id,
 
 
1153
            not_ancestor_id=not_ancestor_id)
 
 
1156
class InstallFailed(BzrError):
 
 
1158
    def __init__(self, revisions):
 
 
1159
        revision_str = ", ".join(str(r) for r in revisions)
 
 
1160
        msg = "Could not install revisions:\n%s" % revision_str
 
 
1161
        BzrError.__init__(self, msg)
 
 
1162
        self.revisions = revisions
 
 
1165
class AmbiguousBase(BzrError):
 
 
1167
    def __init__(self, bases):
 
 
1168
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
1170
        msg = ("The correct base is unclear, because %s are all equally close"
 
 
1172
        BzrError.__init__(self, msg)
 
 
1176
class NoCommits(BzrError):
 
 
1178
    _fmt = "Branch %(branch)s has no commits."
 
 
1180
    def __init__(self, branch):
 
 
1181
        BzrError.__init__(self, branch=branch)
 
 
1184
class UnlistableStore(BzrError):
 
 
1186
    def __init__(self, store):
 
 
1187
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
1191
class UnlistableBranch(BzrError):
 
 
1193
    def __init__(self, br):
 
 
1194
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
1197
class BoundBranchOutOfDate(BzrError):
 
 
1199
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
 
1202
    def __init__(self, branch, master):
 
 
1203
        BzrError.__init__(self)
 
 
1204
        self.branch = branch
 
 
1205
        self.master = master
 
 
1208
class CommitToDoubleBoundBranch(BzrError):
 
 
1210
    _fmt = ("Cannot commit to branch %(branch)s."
 
 
1211
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
 
1213
    def __init__(self, branch, master, remote):
 
 
1214
        BzrError.__init__(self)
 
 
1215
        self.branch = branch
 
 
1216
        self.master = master
 
 
1217
        self.remote = remote
 
 
1220
class OverwriteBoundBranch(BzrError):
 
 
1222
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
 
1224
    def __init__(self, branch):
 
 
1225
        BzrError.__init__(self)
 
 
1226
        self.branch = branch
 
 
1229
class BoundBranchConnectionFailure(BzrError):
 
 
1231
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
 
1232
            " => %(target)s: %(error)s")
 
 
1234
    def __init__(self, branch, target, error):
 
 
1235
        BzrError.__init__(self)
 
 
1236
        self.branch = branch
 
 
1237
        self.target = target
 
 
1241
class WeaveError(BzrError):
 
 
1243
    _fmt = "Error in processing weave: %(message)s"
 
 
1245
    def __init__(self, message=None):
 
 
1246
        BzrError.__init__(self)
 
 
1247
        self.message = message
 
 
1250
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
1252
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
 
1254
    def __init__(self, revision_id, weave):
 
 
1256
        WeaveError.__init__(self)
 
 
1257
        self.revision_id = revision_id
 
 
1261
class WeaveRevisionNotPresent(WeaveError):
 
 
1263
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
 
1265
    def __init__(self, revision_id, weave):
 
 
1266
        WeaveError.__init__(self)
 
 
1267
        self.revision_id = revision_id
 
 
1271
class WeaveFormatError(WeaveError):
 
 
1273
    _fmt = "Weave invariant violated: %(what)s"
 
 
1275
    def __init__(self, what):
 
 
1276
        WeaveError.__init__(self)
 
 
1280
class WeaveParentMismatch(WeaveError):
 
 
1282
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
 
1285
class WeaveInvalidChecksum(WeaveError):
 
 
1287
    _fmt = "Text did not match it's checksum: %(message)s"
 
 
1290
class WeaveTextDiffers(WeaveError):
 
 
1292
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1293
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1295
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1296
        WeaveError.__init__(self)
 
 
1297
        self.revision_id = revision_id
 
 
1298
        self.weave_a = weave_a
 
 
1299
        self.weave_b = weave_b
 
 
1302
class WeaveTextDiffers(WeaveError):
 
 
1304
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1305
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1307
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1308
        WeaveError.__init__(self)
 
 
1309
        self.revision_id = revision_id
 
 
1310
        self.weave_a = weave_a
 
 
1311
        self.weave_b = weave_b
 
 
1314
class VersionedFileError(BzrError):
 
 
1316
    _fmt = "Versioned file error"
 
 
1319
class RevisionNotPresent(VersionedFileError):
 
 
1321
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
 
1323
    def __init__(self, revision_id, file_id):
 
 
1324
        VersionedFileError.__init__(self)
 
 
1325
        self.revision_id = revision_id
 
 
1326
        self.file_id = file_id
 
 
1329
class RevisionAlreadyPresent(VersionedFileError):
 
 
1331
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
 
1333
    def __init__(self, revision_id, file_id):
 
 
1334
        VersionedFileError.__init__(self)
 
 
1335
        self.revision_id = revision_id
 
 
1336
        self.file_id = file_id
 
 
1339
class VersionedFileInvalidChecksum(VersionedFileError):
 
 
1341
    _fmt = "Text did not match its checksum: %(message)s"
 
 
1344
class KnitError(InternalBzrError):
 
 
1349
class KnitCorrupt(KnitError):
 
 
1351
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
 
1353
    def __init__(self, filename, how):
 
 
1354
        KnitError.__init__(self)
 
 
1355
        self.filename = filename
 
 
1359
class KnitDataStreamIncompatible(KnitError):
 
 
1360
    # Not raised anymore, as we can convert data streams.  In future we may
 
 
1361
    # need it again for more exotic cases, so we're keeping it around for now.
 
 
1363
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
 
1365
    def __init__(self, stream_format, target_format):
 
 
1366
        self.stream_format = stream_format
 
 
1367
        self.target_format = target_format
 
 
1370
class KnitDataStreamUnknown(KnitError):
 
 
1371
    # Indicates a data stream we don't know how to handle.
 
 
1373
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
 
1375
    def __init__(self, stream_format):
 
 
1376
        self.stream_format = stream_format
 
 
1379
class KnitHeaderError(KnitError):
 
 
1381
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
 
1383
    def __init__(self, badline, filename):
 
 
1384
        KnitError.__init__(self)
 
 
1385
        self.badline = badline
 
 
1386
        self.filename = filename
 
 
1388
class KnitIndexUnknownMethod(KnitError):
 
 
1389
    """Raised when we don't understand the storage method.
 
 
1391
    Currently only 'fulltext' and 'line-delta' are supported.
 
 
1394
    _fmt = ("Knit index %(filename)s does not have a known method"
 
 
1395
            " in options: %(options)r")
 
 
1397
    def __init__(self, filename, options):
 
 
1398
        KnitError.__init__(self)
 
 
1399
        self.filename = filename
 
 
1400
        self.options = options
 
 
1403
class NoSuchExportFormat(BzrError):
 
 
1405
    _fmt = "Export format %(format)r not supported"
 
 
1407
    def __init__(self, format):
 
 
1408
        BzrError.__init__(self)
 
 
1409
        self.format = format
 
 
1412
class TransportError(BzrError):
 
 
1414
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
 
1416
    def __init__(self, msg=None, orig_error=None):
 
 
1417
        if msg is None and orig_error is not None:
 
 
1418
            msg = str(orig_error)
 
 
1419
        if orig_error is None:
 
 
1424
        self.orig_error = orig_error
 
 
1425
        BzrError.__init__(self)
 
 
1428
class TooManyConcurrentRequests(InternalBzrError):
 
 
1430
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
 
1431
            " Be sure to finish_writing and finish_reading on the"
 
 
1432
            " currently open request.")
 
 
1434
    def __init__(self, medium):
 
 
1435
        self.medium = medium
 
 
1438
class SmartProtocolError(TransportError):
 
 
1440
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
 
1442
    def __init__(self, details):
 
 
1443
        self.details = details
 
 
1446
# A set of semi-meaningful errors which can be thrown
 
 
1447
class TransportNotPossible(TransportError):
 
 
1449
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
 
1452
class ConnectionError(TransportError):
 
 
1454
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
 
1457
class SocketConnectionError(ConnectionError):
 
 
1459
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
 
1461
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
1463
            msg = 'Failed to connect to'
 
 
1464
        if orig_error is None:
 
 
1467
            orig_error = '; ' + str(orig_error)
 
 
1468
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
1473
            self.port = ':%s' % port
 
 
1476
class ConnectionReset(TransportError):
 
 
1478
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
 
1481
class InvalidRange(TransportError):
 
 
1483
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
 
1485
    def __init__(self, path, offset, msg=None):
 
 
1486
        TransportError.__init__(self, msg)
 
 
1488
        self.offset = offset
 
 
1491
class InvalidHttpResponse(TransportError):
 
 
1493
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
 
1495
    def __init__(self, path, msg, orig_error=None):
 
 
1497
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
1500
class InvalidHttpRange(InvalidHttpResponse):
 
 
1502
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
 
1504
    def __init__(self, path, range, msg):
 
 
1506
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1509
class InvalidHttpContentType(InvalidHttpResponse):
 
 
1511
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
 
1513
    def __init__(self, path, ctype, msg):
 
 
1515
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1518
class RedirectRequested(TransportError):
 
 
1520
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
 
1522
    def __init__(self, source, target, is_permanent=False, qual_proto=None):
 
 
1523
        self.source = source
 
 
1524
        self.target = target
 
 
1526
            self.permanently = ' permanently'
 
 
1528
            self.permanently = ''
 
 
1529
        self._qualified_proto = qual_proto
 
 
1530
        TransportError.__init__(self)
 
 
1532
    def _requalify_url(self, url):
 
 
1533
        """Restore the qualified proto in front of the url"""
 
 
1534
        # When this exception is raised, source and target are in
 
 
1535
        # user readable format. But some transports may use a
 
 
1536
        # different proto (http+urllib:// will present http:// to
 
 
1537
        # the user. If a qualified proto is specified, the code
 
 
1538
        # trapping the exception can get the qualified urls to
 
 
1539
        # properly handle the redirection themself (creating a
 
 
1540
        # new transport object from the target url for example).
 
 
1541
        # But checking that the scheme of the original and
 
 
1542
        # redirected urls are the same can be tricky. (see the
 
 
1543
        # FIXME in BzrDir.open_from_transport for the unique use
 
 
1545
        if self._qualified_proto is None:
 
 
1548
        # The TODO related to NotBranchError mention that doing
 
 
1549
        # that kind of manipulation on the urls may not be the
 
 
1550
        # exception object job. On the other hand, this object is
 
 
1551
        # the interface between the code and the user so
 
 
1552
        # presenting the urls in different ways is indeed its
 
 
1555
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
 
1556
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
 
1559
    def get_source_url(self):
 
 
1560
        return self._requalify_url(self.source)
 
 
1562
    def get_target_url(self):
 
 
1563
        return self._requalify_url(self.target)
 
 
1566
class TooManyRedirections(TransportError):
 
 
1568
    _fmt = "Too many redirections"
 
 
1571
class ConflictsInTree(BzrError):
 
 
1573
    _fmt = "Working tree has conflicts."
 
 
1576
class ParseConfigError(BzrError):
 
 
1578
    def __init__(self, errors, filename):
 
 
1579
        if filename is None:
 
 
1581
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
1582
            (filename, ('\n'.join(e.message for e in errors)))
 
 
1583
        BzrError.__init__(self, message)
 
 
1586
class NoEmailInUsername(BzrError):
 
 
1588
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
 
1590
    def __init__(self, username):
 
 
1591
        BzrError.__init__(self)
 
 
1592
        self.username = username
 
 
1595
class SigningFailed(BzrError):
 
 
1597
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
 
1599
    def __init__(self, command_line):
 
 
1600
        BzrError.__init__(self, command_line=command_line)
 
 
1603
class WorkingTreeNotRevision(BzrError):
 
 
1605
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
 
1606
            " the last commit, but weave merge requires that it be"
 
 
1609
    def __init__(self, tree):
 
 
1610
        BzrError.__init__(self, basedir=tree.basedir)
 
 
1613
class CantReprocessAndShowBase(BzrError):
 
 
1615
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
 
1616
           "the relationship of conflicting lines to the base")
 
 
1619
class GraphCycleError(BzrError):
 
 
1621
    _fmt = "Cycle in graph %(graph)r"
 
 
1623
    def __init__(self, graph):
 
 
1624
        BzrError.__init__(self)
 
 
1628
class WritingCompleted(InternalBzrError):
 
 
1630
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
 
1631
            "called upon it - accept bytes may not be called anymore.")
 
 
1633
    def __init__(self, request):
 
 
1634
        self.request = request
 
 
1637
class WritingNotComplete(InternalBzrError):
 
 
1639
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
 
1640
            "called upon it - until the write phase is complete no "
 
 
1641
            "data may be read.")
 
 
1643
    def __init__(self, request):
 
 
1644
        self.request = request
 
 
1647
class NotConflicted(BzrError):
 
 
1649
    _fmt = "File %(filename)s is not conflicted."
 
 
1651
    def __init__(self, filename):
 
 
1652
        BzrError.__init__(self)
 
 
1653
        self.filename = filename
 
 
1656
class MediumNotConnected(InternalBzrError):
 
 
1658
    _fmt = """The medium '%(medium)s' is not connected."""
 
 
1660
    def __init__(self, medium):
 
 
1661
        self.medium = medium
 
 
1664
class MustUseDecorated(Exception):
 
 
1666
    _fmt = "A decorating function has requested its original command be used."
 
 
1669
class NoBundleFound(BzrError):
 
 
1671
    _fmt = 'No bundle was found in "%(filename)s".'
 
 
1673
    def __init__(self, filename):
 
 
1674
        BzrError.__init__(self)
 
 
1675
        self.filename = filename
 
 
1678
class BundleNotSupported(BzrError):
 
 
1680
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
 
1682
    def __init__(self, version, msg):
 
 
1683
        BzrError.__init__(self)
 
 
1684
        self.version = version
 
 
1688
class MissingText(BzrError):
 
 
1690
    _fmt = ("Branch %(base)s is missing revision"
 
 
1691
            " %(text_revision)s of %(file_id)s")
 
 
1693
    def __init__(self, branch, text_revision, file_id):
 
 
1694
        BzrError.__init__(self)
 
 
1695
        self.branch = branch
 
 
1696
        self.base = branch.base
 
 
1697
        self.text_revision = text_revision
 
 
1698
        self.file_id = file_id
 
 
1701
class DuplicateFileId(BzrError):
 
 
1703
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
 
1705
    def __init__(self, file_id, entry):
 
 
1706
        BzrError.__init__(self)
 
 
1707
        self.file_id = file_id
 
 
1711
class DuplicateKey(BzrError):
 
 
1713
    _fmt = "Key %(key)s is already present in map"
 
 
1716
class DuplicateHelpPrefix(BzrError):
 
 
1718
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
 
1720
    def __init__(self, prefix):
 
 
1721
        self.prefix = prefix
 
 
1724
class MalformedTransform(BzrError):
 
 
1726
    _fmt = "Tree transform is malformed %(conflicts)r"
 
 
1729
class NoFinalPath(BzrError):
 
 
1731
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
 
1732
            "file-id: %(file_id)r\n"
 
 
1733
            "root trans-id: %(root_trans_id)r\n")
 
 
1735
    def __init__(self, trans_id, transform):
 
 
1736
        self.trans_id = trans_id
 
 
1737
        self.file_id = transform.final_file_id(trans_id)
 
 
1738
        self.root_trans_id = transform.root
 
 
1741
class BzrBadParameter(InternalBzrError):
 
 
1743
    _fmt = "Bad parameter: %(param)r"
 
 
1745
    # This exception should never be thrown, but it is a base class for all
 
 
1746
    # parameter-to-function errors.
 
 
1748
    def __init__(self, param):
 
 
1749
        BzrError.__init__(self)
 
 
1753
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1755
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
 
1758
class ReusingTransform(BzrError):
 
 
1760
    _fmt = "Attempt to reuse a transform that has already been applied."
 
 
1763
class CantMoveRoot(BzrError):
 
 
1765
    _fmt = "Moving the root directory is not supported at this time"
 
 
1768
class BzrMoveFailedError(BzrError):
 
 
1770
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1772
    def __init__(self, from_path='', to_path='', extra=None):
 
 
1773
        BzrError.__init__(self)
 
 
1775
            self.extra = ': ' + str(extra)
 
 
1779
        has_from = len(from_path) > 0
 
 
1780
        has_to = len(to_path) > 0
 
 
1782
            self.from_path = osutils.splitpath(from_path)[-1]
 
 
1787
            self.to_path = osutils.splitpath(to_path)[-1]
 
 
1792
        if has_from and has_to:
 
 
1793
            self.operator = " =>"
 
 
1795
            self.from_path = "from " + from_path
 
 
1797
            self.operator = "to"
 
 
1799
            self.operator = "file"
 
 
1802
class BzrRenameFailedError(BzrMoveFailedError):
 
 
1804
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1806
    def __init__(self, from_path, to_path, extra=None):
 
 
1807
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
 
1809
class BzrRemoveChangedFilesError(BzrError):
 
 
1810
    """Used when user is trying to remove changed files."""
 
 
1812
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
 
1813
        "%(changes_as_text)s"
 
 
1814
        "Use --keep to not delete them, or --force to delete them regardless.")
 
 
1816
    def __init__(self, tree_delta):
 
 
1817
        BzrError.__init__(self)
 
 
1818
        self.changes_as_text = tree_delta.get_changes_as_text()
 
 
1819
        #self.paths_as_string = '\n'.join(changed_files)
 
 
1820
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
 
1823
class BzrBadParameterNotString(BzrBadParameter):
 
 
1825
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
 
1828
class BzrBadParameterMissing(BzrBadParameter):
 
 
1830
    _fmt = "Parameter $(param)s is required but not present."
 
 
1833
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1835
    _fmt = ("Parameter %(param)s is unicode but"
 
 
1836
            " only byte-strings are permitted.")
 
 
1839
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1841
    _fmt = "Parameter %(param)s contains a newline."
 
 
1844
class DependencyNotPresent(BzrError):
 
 
1846
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
 
1848
    def __init__(self, library, error):
 
 
1849
        BzrError.__init__(self, library=library, error=error)
 
 
1852
class ParamikoNotPresent(DependencyNotPresent):
 
 
1854
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
 
1856
    def __init__(self, error):
 
 
1857
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1860
class PointlessMerge(BzrError):
 
 
1862
    _fmt = "Nothing to merge."
 
 
1865
class UninitializableFormat(BzrError):
 
 
1867
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
 
1869
    def __init__(self, format):
 
 
1870
        BzrError.__init__(self)
 
 
1871
        self.format = format
 
 
1874
class BadConversionTarget(BzrError):
 
 
1876
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
 
1878
    def __init__(self, problem, format):
 
 
1879
        BzrError.__init__(self)
 
 
1880
        self.problem = problem
 
 
1881
        self.format = format
 
 
1884
class NoDiffFound(BzrError):
 
 
1886
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
 
1888
    def __init__(self, path):
 
 
1889
        BzrError.__init__(self, path)
 
 
1892
class ExecutableMissing(BzrError):
 
 
1894
    _fmt = "%(exe_name)s could not be found on this machine"
 
 
1896
    def __init__(self, exe_name):
 
 
1897
        BzrError.__init__(self, exe_name=exe_name)
 
 
1900
class NoDiff(BzrError):
 
 
1902
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
 
1904
    def __init__(self, msg):
 
 
1905
        BzrError.__init__(self, msg=msg)
 
 
1908
class NoDiff3(BzrError):
 
 
1910
    _fmt = "Diff3 is not installed on this machine."
 
 
1913
class ExistingContent(BzrError):
 
 
1914
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
 
1916
    _fmt = "The content being inserted is already present."
 
 
1919
class ExistingLimbo(BzrError):
 
 
1921
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1922
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1923
    keep, and delete it when you are done."""
 
 
1925
    def __init__(self, limbo_dir):
 
 
1926
       BzrError.__init__(self)
 
 
1927
       self.limbo_dir = limbo_dir
 
 
1930
class ExistingPendingDeletion(BzrError):
 
 
1932
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1933
    Please examine %(pending_deletion)s to see if it contains any files you
 
 
1934
    wish to keep, and delete it when you are done."""
 
 
1936
    def __init__(self, pending_deletion):
 
 
1937
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
 
1940
class ImmortalLimbo(BzrError):
 
 
1942
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
 
1943
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1944
    keep, and delete it when you are done."""
 
 
1946
    def __init__(self, limbo_dir):
 
 
1947
       BzrError.__init__(self)
 
 
1948
       self.limbo_dir = limbo_dir
 
 
1951
class ImmortalPendingDeletion(BzrError):
 
 
1953
    _fmt = ("Unable to delete transform temporary directory "
 
 
1954
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
 
1955
    "contains any files you wish to keep, and delete it when you are done.")
 
 
1957
    def __init__(self, pending_deletion):
 
 
1958
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
 
1961
class OutOfDateTree(BzrError):
 
 
1963
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
 
1965
    def __init__(self, tree):
 
 
1966
        BzrError.__init__(self)
 
 
1970
class PublicBranchOutOfDate(BzrError):
 
 
1972
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
 
1975
    def __init__(self, public_location, revstring):
 
 
1976
        import bzrlib.urlutils as urlutils
 
 
1977
        public_location = urlutils.unescape_for_display(public_location,
 
 
1979
        BzrError.__init__(self, public_location=public_location,
 
 
1980
                          revstring=revstring)
 
 
1983
class MergeModifiedFormatError(BzrError):
 
 
1985
    _fmt = "Error in merge modified format"
 
 
1988
class ConflictFormatError(BzrError):
 
 
1990
    _fmt = "Format error in conflict listings"
 
 
1993
class CorruptDirstate(BzrError):
 
 
1995
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
 
1996
            "Error: %(description)s")
 
 
1998
    def __init__(self, dirstate_path, description):
 
 
1999
        BzrError.__init__(self)
 
 
2000
        self.dirstate_path = dirstate_path
 
 
2001
        self.description = description
 
 
2004
class CorruptRepository(BzrError):
 
 
2006
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
 
2007
            "Please run bzr reconcile on this repository.")
 
 
2009
    def __init__(self, repo):
 
 
2010
        BzrError.__init__(self)
 
 
2011
        self.repo_path = repo.bzrdir.root_transport.base
 
 
2014
class InconsistentDelta(BzrError):
 
 
2015
    """Used when we get a delta that is not valid."""
 
 
2017
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
 
2018
            " %(file_id)r\nreason: %(reason)s")
 
 
2020
    def __init__(self, path, file_id, reason):
 
 
2021
        BzrError.__init__(self)
 
 
2023
        self.file_id = file_id
 
 
2024
        self.reason = reason
 
 
2027
class UpgradeRequired(BzrError):
 
 
2029
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
 
2031
    def __init__(self, path):
 
 
2032
        BzrError.__init__(self)
 
 
2036
class LocalRequiresBoundBranch(BzrError):
 
 
2038
    _fmt = "Cannot perform local-only commits on unbound branches."
 
 
2041
class MissingProgressBarFinish(BzrError):
 
 
2043
    _fmt = "A nested progress bar was not 'finished' correctly."
 
 
2046
class InvalidProgressBarType(BzrError):
 
 
2048
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
 
2049
            " is not a supported type Select one of: %(valid_types)s")
 
 
2051
    def __init__(self, bar_type, valid_types):
 
 
2052
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
2055
class UnsupportedOperation(BzrError):
 
 
2057
    _fmt = ("The method %(mname)s is not supported on"
 
 
2058
            " objects of type %(tname)s.")
 
 
2060
    def __init__(self, method, method_self):
 
 
2061
        self.method = method
 
 
2062
        self.mname = method.__name__
 
 
2063
        self.tname = type(method_self).__name__
 
 
2066
class CannotSetRevisionId(UnsupportedOperation):
 
 
2067
    """Raised when a commit is attempting to set a revision id but cant."""
 
 
2070
class NonAsciiRevisionId(UnsupportedOperation):
 
 
2071
    """Raised when a commit is attempting to set a non-ascii revision id
 
 
2076
class BinaryFile(BzrError):
 
 
2078
    _fmt = "File is binary but should be text."
 
 
2081
class IllegalPath(BzrError):
 
 
2083
    _fmt = "The path %(path)s is not permitted on this platform"
 
 
2085
    def __init__(self, path):
 
 
2086
        BzrError.__init__(self)
 
 
2090
class TestamentMismatch(BzrError):
 
 
2092
    _fmt = """Testament did not match expected value.
 
 
2093
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
 
2096
    def __init__(self, revision_id, expected, measured):
 
 
2097
        self.revision_id = revision_id
 
 
2098
        self.expected = expected
 
 
2099
        self.measured = measured
 
 
2102
class NotABundle(BzrError):
 
 
2104
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
 
2106
    def __init__(self, text):
 
 
2107
        BzrError.__init__(self)
 
 
2111
class BadBundle(BzrError): 
 
 
2113
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
 
2115
    def __init__(self, text):
 
 
2116
        BzrError.__init__(self)
 
 
2120
class MalformedHeader(BadBundle): 
 
 
2122
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
 
2125
class MalformedPatches(BadBundle): 
 
 
2127
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
 
2130
class MalformedFooter(BadBundle): 
 
 
2132
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
 
2135
class UnsupportedEOLMarker(BadBundle):
 
 
2137
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
 
2140
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
 
2141
        # but for this there is not
 
 
2142
        BzrError.__init__(self)
 
 
2145
class IncompatibleBundleFormat(BzrError):
 
 
2147
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
 
2149
    def __init__(self, bundle_format, other):
 
 
2150
        BzrError.__init__(self)
 
 
2151
        self.bundle_format = bundle_format
 
 
2155
class BadInventoryFormat(BzrError):
 
 
2157
    _fmt = "Root class for inventory serialization errors"
 
 
2160
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
2162
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
 
2164
    def __init__(self, msg):
 
 
2165
        BadInventoryFormat.__init__(self, msg=msg)
 
 
2168
class RootNotRich(BzrError):
 
 
2170
    _fmt = """This operation requires rich root data storage"""
 
 
2173
class NoSmartMedium(InternalBzrError):
 
 
2175
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
 
2177
    def __init__(self, transport):
 
 
2178
        self.transport = transport
 
 
2181
class NoSmartServer(NotBranchError):
 
 
2183
    _fmt = "No smart server available at %(url)s"
 
 
2185
    def __init__(self, url):
 
 
2189
class UnknownSSH(BzrError):
 
 
2191
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
 
2193
    def __init__(self, vendor):
 
 
2194
        BzrError.__init__(self)
 
 
2195
        self.vendor = vendor
 
 
2198
class SSHVendorNotFound(BzrError):
 
 
2200
    _fmt = ("Don't know how to handle SSH connections."
 
 
2201
            " Please set BZR_SSH environment variable.")
 
 
2204
class GhostRevisionUnusableHere(BzrError):
 
 
2206
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
 
2208
    def __init__(self, revision_id):
 
 
2209
        BzrError.__init__(self)
 
 
2210
        self.revision_id = revision_id
 
 
2213
class IllegalUseOfScopeReplacer(InternalBzrError):
 
 
2215
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
 
2216
            " %(msg)s%(extra)s")
 
 
2218
    def __init__(self, name, msg, extra=None):
 
 
2219
        BzrError.__init__(self)
 
 
2223
            self.extra = ': ' + str(extra)
 
 
2228
class InvalidImportLine(InternalBzrError):
 
 
2230
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
 
2232
    def __init__(self, text, msg):
 
 
2233
        BzrError.__init__(self)
 
 
2238
class ImportNameCollision(InternalBzrError):
 
 
2240
    _fmt = ("Tried to import an object to the same name as"
 
 
2241
            " an existing object. %(name)s")
 
 
2243
    def __init__(self, name):
 
 
2244
        BzrError.__init__(self)
 
 
2248
class NotAMergeDirective(BzrError):
 
 
2249
    """File starting with %(firstline)r is not a merge directive"""
 
 
2250
    def __init__(self, firstline):
 
 
2251
        BzrError.__init__(self, firstline=firstline)
 
 
2254
class NoMergeSource(BzrError):
 
 
2255
    """Raise if no merge source was specified for a merge directive"""
 
 
2257
    _fmt = "A merge directive must provide either a bundle or a public"\
 
 
2261
class IllegalMergeDirectivePayload(BzrError):
 
 
2262
    """A merge directive contained something other than a patch or bundle"""
 
 
2264
    _fmt = "Bad merge directive payload %(start)r"
 
 
2266
    def __init__(self, start):
 
 
2271
class PatchVerificationFailed(BzrError):
 
 
2272
    """A patch from a merge directive could not be verified"""
 
 
2274
    _fmt = "Preview patch does not match requested changes."
 
 
2277
class PatchMissing(BzrError):
 
 
2278
    """Raise a patch type was specified but no patch supplied"""
 
 
2280
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
 
2282
    def __init__(self, patch_type):
 
 
2283
        BzrError.__init__(self)
 
 
2284
        self.patch_type = patch_type
 
 
2287
class UnsupportedInventoryKind(BzrError):
 
 
2289
    _fmt = """Unsupported entry kind %(kind)s"""
 
 
2291
    def __init__(self, kind):
 
 
2295
class BadSubsumeSource(BzrError):
 
 
2297
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
 
2299
    def __init__(self, tree, other_tree, reason):
 
 
2301
        self.other_tree = other_tree
 
 
2302
        self.reason = reason
 
 
2305
class SubsumeTargetNeedsUpgrade(BzrError):
 
 
2307
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
 
2309
    def __init__(self, other_tree):
 
 
2310
        self.other_tree = other_tree
 
 
2313
class BadReferenceTarget(InternalBzrError):
 
 
2315
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
 
2318
    def __init__(self, tree, other_tree, reason):
 
 
2320
        self.other_tree = other_tree
 
 
2321
        self.reason = reason
 
 
2324
class NoSuchTag(BzrError):
 
 
2326
    _fmt = "No such tag: %(tag_name)s"
 
 
2328
    def __init__(self, tag_name):
 
 
2329
        self.tag_name = tag_name
 
 
2332
class TagsNotSupported(BzrError):
 
 
2334
    _fmt = ("Tags not supported by %(branch)s;"
 
 
2335
            " you may be able to use bzr upgrade --dirstate-tags.")
 
 
2337
    def __init__(self, branch):
 
 
2338
        self.branch = branch
 
 
2341
class TagAlreadyExists(BzrError):
 
 
2343
    _fmt = "Tag %(tag_name)s already exists."
 
 
2345
    def __init__(self, tag_name):
 
 
2346
        self.tag_name = tag_name
 
 
2349
class MalformedBugIdentifier(BzrError):
 
 
2351
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
 
2353
    def __init__(self, bug_id, reason):
 
 
2354
        self.bug_id = bug_id
 
 
2355
        self.reason = reason
 
 
2358
class InvalidBugTrackerURL(BzrError):
 
 
2360
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
 
2361
            "contain {id}: %(url)s")
 
 
2363
    def __init__(self, abbreviation, url):
 
 
2364
        self.abbreviation = abbreviation
 
 
2368
class UnknownBugTrackerAbbreviation(BzrError):
 
 
2370
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
 
2373
    def __init__(self, abbreviation, branch):
 
 
2374
        self.abbreviation = abbreviation
 
 
2375
        self.branch = branch
 
 
2378
class UnexpectedSmartServerResponse(BzrError):
 
 
2380
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
 
2382
    def __init__(self, response_tuple):
 
 
2383
        self.response_tuple = response_tuple
 
 
2386
class ContainerError(BzrError):
 
 
2387
    """Base class of container errors."""
 
 
2390
class UnknownContainerFormatError(ContainerError):
 
 
2392
    _fmt = "Unrecognised container format: %(container_format)r"
 
 
2394
    def __init__(self, container_format):
 
 
2395
        self.container_format = container_format
 
 
2398
class UnexpectedEndOfContainerError(ContainerError):
 
 
2400
    _fmt = "Unexpected end of container stream"
 
 
2403
class UnknownRecordTypeError(ContainerError):
 
 
2405
    _fmt = "Unknown record type: %(record_type)r"
 
 
2407
    def __init__(self, record_type):
 
 
2408
        self.record_type = record_type
 
 
2411
class InvalidRecordError(ContainerError):
 
 
2413
    _fmt = "Invalid record: %(reason)s"
 
 
2415
    def __init__(self, reason):
 
 
2416
        self.reason = reason
 
 
2419
class ContainerHasExcessDataError(ContainerError):
 
 
2421
    _fmt = "Container has data after end marker: %(excess)r"
 
 
2423
    def __init__(self, excess):
 
 
2424
        self.excess = excess
 
 
2427
class DuplicateRecordNameError(ContainerError):
 
 
2429
    _fmt = "Container has multiple records with the same name: %(name)s"
 
 
2431
    def __init__(self, name):
 
 
2435
class NoDestinationAddress(InternalBzrError):
 
 
2437
    _fmt = "Message does not have a destination address."
 
 
2440
class RepositoryDataStreamError(BzrError):
 
 
2442
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
 
2444
    def __init__(self, reason):
 
 
2445
        self.reason = reason
 
 
2448
class SMTPError(BzrError):
 
 
2450
    _fmt = "SMTP error: %(error)s"
 
 
2452
    def __init__(self, error):
 
 
2456
class NoMessageSupplied(BzrError):
 
 
2458
    _fmt = "No message supplied."
 
 
2461
class NoMailAddressSpecified(BzrError):
 
 
2463
    _fmt = "No mail-to address specified."
 
 
2466
class UnknownMailClient(BzrError):
 
 
2468
    _fmt = "Unknown mail client: %(mail_client)s"
 
 
2470
    def __init__(self, mail_client):
 
 
2471
        BzrError.__init__(self, mail_client=mail_client)
 
 
2474
class MailClientNotFound(BzrError):
 
 
2476
    _fmt = "Unable to find mail client with the following names:"\
 
 
2477
        " %(mail_command_list_string)s"
 
 
2479
    def __init__(self, mail_command_list):
 
 
2480
        mail_command_list_string = ', '.join(mail_command_list)
 
 
2481
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
 
2482
                          mail_command_list_string=mail_command_list_string)
 
 
2484
class SMTPConnectionRefused(SMTPError):
 
 
2486
    _fmt = "SMTP connection to %(host)s refused"
 
 
2488
    def __init__(self, error, host):
 
 
2493
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
 
2495
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
 
2498
class BzrDirError(BzrError):
 
 
2500
    def __init__(self, bzrdir):
 
 
2501
        import bzrlib.urlutils as urlutils
 
 
2502
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
 
2504
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
 
2507
class AlreadyBranch(BzrDirError):
 
 
2509
    _fmt = "'%(display_url)s' is already a branch."
 
 
2512
class AlreadyTree(BzrDirError):
 
 
2514
    _fmt = "'%(display_url)s' is already a tree."
 
 
2517
class AlreadyCheckout(BzrDirError):
 
 
2519
    _fmt = "'%(display_url)s' is already a checkout."
 
 
2522
class AlreadyLightweightCheckout(BzrDirError):
 
 
2524
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
 
2527
class ReconfigurationNotSupported(BzrDirError):
 
 
2529
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
 
2532
class NoBindLocation(BzrDirError):
 
 
2534
    _fmt = "No location could be found to bind to at %(display_url)s."
 
 
2537
class UncommittedChanges(BzrError):
 
 
2539
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
 
 
2541
    def __init__(self, tree):
 
 
2542
        import bzrlib.urlutils as urlutils
 
 
2543
        display_url = urlutils.unescape_for_display(
 
 
2544
            tree.bzrdir.root_transport.base, 'ascii')
 
 
2545
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
 
2548
class MissingTemplateVariable(BzrError):
 
 
2550
    _fmt = 'Variable {%(name)s} is not available.'
 
 
2552
    def __init__(self, name):
 
 
2556
class NoTemplate(BzrError):
 
 
2558
    _fmt = 'No template specified.'
 
 
2561
class UnableCreateSymlink(BzrError):
 
 
2563
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
 
2565
    def __init__(self, path=None):
 
 
2569
                path_str = repr(str(path))
 
 
2570
            except UnicodeEncodeError:
 
 
2571
                path_str = repr(path)
 
 
2573
        self.path_str = path_str
 
 
2576
class UnsupportedTimezoneFormat(BzrError):
 
 
2578
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
 
2579
            'options are "utc", "original", "local".')
 
 
2581
    def __init__(self, timezone):
 
 
2582
        self.timezone = timezone
 
 
2585
class UnableEncodePath(BzrError):
 
 
2587
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
 
2588
            'user encoding %(user_encoding)s')
 
 
2590
    def __init__(self, path, kind):
 
 
2593
        self.user_encoding = osutils.get_user_encoding()