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 BranchError(BzrError):
 
 
189
    """Base class for concrete 'errors about a branch'."""
 
 
191
    def __init__(self, branch):
 
 
192
        BzrError.__init__(self, branch=branch)
 
 
195
class BzrCheckError(InternalBzrError):
 
 
197
    _fmt = "Internal check failed: %(message)s"
 
 
199
    def __init__(self, message):
 
 
200
        BzrError.__init__(self)
 
 
201
        self.message = message
 
 
204
class DisabledMethod(InternalBzrError):
 
 
206
    _fmt = "The smart server method '%(class_name)s' is disabled."
 
 
208
    def __init__(self, class_name):
 
 
209
        BzrError.__init__(self)
 
 
210
        self.class_name = class_name
 
 
213
class IncompatibleAPI(BzrError):
 
 
215
    _fmt = 'The API for "%(api)s" is not compatible with "%(wanted)s". '\
 
 
216
        'It supports versions "%(minimum)s" to "%(current)s".'
 
 
218
    def __init__(self, api, wanted, minimum, current):
 
 
221
        self.minimum = minimum
 
 
222
        self.current = current
 
 
225
class InProcessTransport(BzrError):
 
 
227
    _fmt = "The transport '%(transport)s' is only accessible within this " \
 
 
230
    def __init__(self, transport):
 
 
231
        self.transport = transport
 
 
234
class InvalidEntryName(InternalBzrError):
 
 
236
    _fmt = "Invalid entry name: %(name)s"
 
 
238
    def __init__(self, name):
 
 
239
        BzrError.__init__(self)
 
 
243
class InvalidRevisionNumber(BzrError):
 
 
245
    _fmt = "Invalid revision number %(revno)s"
 
 
247
    def __init__(self, revno):
 
 
248
        BzrError.__init__(self)
 
 
252
class InvalidRevisionId(BzrError):
 
 
254
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
 
256
    def __init__(self, revision_id, branch):
 
 
257
        # branch can be any string or object with __str__ defined
 
 
258
        BzrError.__init__(self)
 
 
259
        self.revision_id = revision_id
 
 
263
class ReservedId(BzrError):
 
 
265
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
 
267
    def __init__(self, revision_id):
 
 
268
        self.revision_id = revision_id
 
 
271
class RootMissing(InternalBzrError):
 
 
273
    _fmt = ("The root entry of a tree must be the first entry supplied to "
 
 
274
        "record_entry_contents.")
 
 
277
class NoPublicBranch(BzrError):
 
 
279
    _fmt = 'There is no public branch set for "%(branch_url)s".'
 
 
281
    def __init__(self, branch):
 
 
282
        import bzrlib.urlutils as urlutils
 
 
283
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
 
 
284
        BzrError.__init__(self, branch_url=public_location)
 
 
287
class NoHelpTopic(BzrError):
 
 
289
    _fmt = ("No help could be found for '%(topic)s'. "
 
 
290
        "Please use 'bzr help topics' to obtain a list of topics.")
 
 
292
    def __init__(self, topic):
 
 
296
class NoSuchId(BzrError):
 
 
298
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
 
 
300
    def __init__(self, tree, file_id):
 
 
301
        BzrError.__init__(self)
 
 
302
        self.file_id = file_id
 
 
306
class NoSuchIdInRepository(NoSuchId):
 
 
308
    _fmt = ('The file id "%(file_id)s" is not present in the repository'
 
 
311
    def __init__(self, repository, file_id):
 
 
312
        BzrError.__init__(self, repository=repository, file_id=file_id)
 
 
315
class NotStacked(BranchError):
 
 
317
    _fmt = "The branch '%(branch)s' is not stacked."
 
 
320
class InventoryModified(InternalBzrError):
 
 
322
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
 
323
            " so a clean inventory cannot be read without data loss.")
 
 
325
    def __init__(self, tree):
 
 
329
class NoWorkingTree(BzrError):
 
 
331
    _fmt = 'No WorkingTree exists for "%(base)s".'
 
 
333
    def __init__(self, base):
 
 
334
        BzrError.__init__(self)
 
 
338
class NotBuilding(BzrError):
 
 
340
    _fmt = "Not currently building a tree."
 
 
343
class NotLocalUrl(BzrError):
 
 
345
    _fmt = "%(url)s is not a local path."
 
 
347
    def __init__(self, url):
 
 
351
class WorkingTreeAlreadyPopulated(InternalBzrError):
 
 
353
    _fmt = 'Working tree already populated in "%(base)s"'
 
 
355
    def __init__(self, base):
 
 
359
class BzrCommandError(BzrError):
 
 
360
    """Error from user command"""
 
 
362
    # Error from malformed user command; please avoid raising this as a
 
 
363
    # generic exception not caused by user input.
 
 
365
    # I think it's a waste of effort to differentiate between errors that
 
 
366
    # are not intended to be caught anyway.  UI code need not subclass
 
 
367
    # BzrCommandError, and non-UI code should not throw a subclass of
 
 
368
    # BzrCommandError.  ADHB 20051211
 
 
369
    def __init__(self, msg):
 
 
370
        # Object.__str__() must return a real string
 
 
371
        # returning a Unicode string is a python error.
 
 
372
        if isinstance(msg, unicode):
 
 
373
            self.msg = msg.encode('utf8')
 
 
381
class NotWriteLocked(BzrError):
 
 
383
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
 
385
    def __init__(self, not_locked):
 
 
386
        self.not_locked = not_locked
 
 
389
class BzrOptionError(BzrCommandError):
 
 
391
    _fmt = "Error in command line options"
 
 
394
class BadIndexFormatSignature(BzrError):
 
 
396
    _fmt = "%(value)s is not an index of type %(_type)s."
 
 
398
    def __init__(self, value, _type):
 
 
399
        BzrError.__init__(self)
 
 
404
class BadIndexData(BzrError):
 
 
406
    _fmt = "Error in data for index %(value)s."
 
 
408
    def __init__(self, value):
 
 
409
        BzrError.__init__(self)
 
 
413
class BadIndexDuplicateKey(BzrError):
 
 
415
    _fmt = "The key '%(key)s' is already in index '%(index)s'."
 
 
417
    def __init__(self, key, index):
 
 
418
        BzrError.__init__(self)
 
 
423
class BadIndexKey(BzrError):
 
 
425
    _fmt = "The key '%(key)s' is not a valid key."
 
 
427
    def __init__(self, key):
 
 
428
        BzrError.__init__(self)
 
 
432
class BadIndexOptions(BzrError):
 
 
434
    _fmt = "Could not parse options for index %(value)s."
 
 
436
    def __init__(self, value):
 
 
437
        BzrError.__init__(self)
 
 
441
class BadIndexValue(BzrError):
 
 
443
    _fmt = "The value '%(value)s' is not a valid value."
 
 
445
    def __init__(self, value):
 
 
446
        BzrError.__init__(self)
 
 
450
class BadOptionValue(BzrError):
 
 
452
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
 
454
    def __init__(self, name, value):
 
 
455
        BzrError.__init__(self, name=name, value=value)
 
 
458
class StrictCommitFailed(BzrError):
 
 
460
    _fmt = "Commit refused because there are unknown files in the tree"
 
 
463
# XXX: Should be unified with TransportError; they seem to represent the
 
 
465
# RBC 20060929: I think that unifiying with TransportError would be a mistake
 
 
466
# - this is finer than a TransportError - and more useful as such. It 
 
 
467
# differentiates between 'transport has failed' and 'operation on a transport
 
 
469
class PathError(BzrError):
 
 
471
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
 
473
    def __init__(self, path, extra=None):
 
 
474
        BzrError.__init__(self)
 
 
477
            self.extra = ': ' + str(extra)
 
 
482
class NoSuchFile(PathError):
 
 
484
    _fmt = "No such file: %(path)r%(extra)s"
 
 
487
class FileExists(PathError):
 
 
489
    _fmt = "File exists: %(path)r%(extra)s"
 
 
492
class RenameFailedFilesExist(BzrError):
 
 
493
    """Used when renaming and both source and dest exist."""
 
 
495
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
 
496
            " (Use --after to tell bzr about a rename that has already"
 
 
497
            " happened)%(extra)s")
 
 
499
    def __init__(self, source, dest, extra=None):
 
 
500
        BzrError.__init__(self)
 
 
501
        self.source = str(source)
 
 
502
        self.dest = str(dest)
 
 
504
            self.extra = ' ' + str(extra)
 
 
509
class NotADirectory(PathError):
 
 
511
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
 
514
class NotInWorkingDirectory(PathError):
 
 
516
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
 
 
519
class DirectoryNotEmpty(PathError):
 
 
521
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
 
 
524
class HardLinkNotSupported(PathError):
 
 
526
    _fmt = 'Hard-linking "%(path)s" is not supported'
 
 
529
class ReadingCompleted(InternalBzrError):
 
 
531
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
 
532
            "called upon it - the request has been completed and no more "
 
 
535
    def __init__(self, request):
 
 
536
        self.request = request
 
 
539
class ResourceBusy(PathError):
 
 
541
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
 
 
544
class PermissionDenied(PathError):
 
 
546
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
 
549
class InvalidURL(PathError):
 
 
551
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
 
554
class InvalidURLJoin(PathError):
 
 
556
    _fmt = "Invalid URL join request: %(reason)s: %(base)r + %(join_args)r"
 
 
558
    def __init__(self, reason, base, join_args):
 
 
561
        self.join_args = join_args
 
 
562
        PathError.__init__(self, base, reason)
 
 
565
class UnknownHook(BzrError):
 
 
567
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
 
569
    def __init__(self, hook_type, hook_name):
 
 
570
        BzrError.__init__(self)
 
 
571
        self.type = hook_type
 
 
572
        self.hook = hook_name
 
 
575
class UnsupportedProtocol(PathError):
 
 
577
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
 
579
    def __init__(self, url, extra):
 
 
580
        PathError.__init__(self, url, extra=extra)
 
 
583
class UnstackableBranchFormat(BzrError):
 
 
585
    _fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
 
 
586
        "You will need to upgrade the branch to permit branch stacking.")
 
 
588
    def __init__(self, format, url):
 
 
589
        BzrError.__init__(self)
 
 
594
class UnstackableRepositoryFormat(BzrError):
 
 
596
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
 
 
597
        "You will need to upgrade the repository to permit branch stacking.")
 
 
599
    def __init__(self, format, url):
 
 
600
        BzrError.__init__(self)
 
 
605
class ReadError(PathError):
 
 
607
    _fmt = """Error reading from %(path)r."""
 
 
610
class ShortReadvError(PathError):
 
 
612
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
 
 
613
            ' at %(offset)s for "%(path)s"%(extra)s')
 
 
615
    internal_error = True
 
 
617
    def __init__(self, path, offset, length, actual, extra=None):
 
 
618
        PathError.__init__(self, path, extra=extra)
 
 
624
class PathNotChild(PathError):
 
 
626
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
 
628
    internal_error = True
 
 
630
    def __init__(self, path, base, extra=None):
 
 
631
        BzrError.__init__(self)
 
 
635
            self.extra = ': ' + str(extra)
 
 
640
class InvalidNormalization(PathError):
 
 
642
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
 
645
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
646
# the exception object is a bit undesirable.
 
 
647
# TODO: Probably this behavior of should be a common superclass 
 
 
648
class NotBranchError(PathError):
 
 
650
    _fmt = 'Not a branch: "%(path)s".'
 
 
652
    def __init__(self, path):
 
 
653
       import bzrlib.urlutils as urlutils
 
 
654
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
657
class NoSubmitBranch(PathError):
 
 
659
    _fmt = 'No submit branch available for branch "%(path)s"'
 
 
661
    def __init__(self, branch):
 
 
662
       import bzrlib.urlutils as urlutils
 
 
663
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
 
666
class AlreadyBranchError(PathError):
 
 
668
    _fmt = 'Already a branch: "%(path)s".'
 
 
671
class BranchExistsWithoutWorkingTree(PathError):
 
 
673
    _fmt = 'Directory contains a branch, but no working tree \
 
 
674
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
 
677
class AtomicFileAlreadyClosed(PathError):
 
 
679
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
 
682
    def __init__(self, path, function):
 
 
683
        PathError.__init__(self, path=path, extra=None)
 
 
684
        self.function = function
 
 
687
class InaccessibleParent(PathError):
 
 
689
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
 
690
            ' relative path "%(path)s"')
 
 
692
    def __init__(self, path, base):
 
 
693
        PathError.__init__(self, path)
 
 
697
class NoRepositoryPresent(BzrError):
 
 
699
    _fmt = 'No repository present: "%(path)s"'
 
 
700
    def __init__(self, bzrdir):
 
 
701
        BzrError.__init__(self)
 
 
702
        self.path = bzrdir.transport.clone('..').base
 
 
705
class FileInWrongBranch(BzrError):
 
 
707
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
 
709
    def __init__(self, branch, path):
 
 
710
        BzrError.__init__(self)
 
 
712
        self.branch_base = branch.base
 
 
716
class UnsupportedFormatError(BzrError):
 
 
718
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
 
 
721
class UnknownFormatError(BzrError):
 
 
723
    _fmt = "Unknown %(kind)s format: %(format)r"
 
 
725
    def __init__(self, format, kind='branch'):
 
 
730
class IncompatibleFormat(BzrError):
 
 
732
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
 
734
    def __init__(self, format, bzrdir_format):
 
 
735
        BzrError.__init__(self)
 
 
737
        self.bzrdir = bzrdir_format
 
 
740
class IncompatibleRepositories(BzrError):
 
 
742
    _fmt = "Repository %(target)s is not compatible with repository"\
 
 
745
    def __init__(self, source, target):
 
 
746
        BzrError.__init__(self, target=target, source=source)
 
 
749
class IncompatibleRevision(BzrError):
 
 
751
    _fmt = "Revision is not compatible with %(repo_format)s"
 
 
753
    def __init__(self, repo_format):
 
 
754
        BzrError.__init__(self)
 
 
755
        self.repo_format = repo_format
 
 
758
class AlreadyVersionedError(BzrError):
 
 
759
    """Used when a path is expected not to be versioned, but it is."""
 
 
761
    _fmt = "%(context_info)s%(path)s is already versioned."
 
 
763
    def __init__(self, path, context_info=None):
 
 
764
        """Construct a new AlreadyVersionedError.
 
 
766
        :param path: This is the path which is versioned,
 
 
767
        which should be in a user friendly form.
 
 
768
        :param context_info: If given, this is information about the context,
 
 
769
        which could explain why this is expected to not be versioned.
 
 
771
        BzrError.__init__(self)
 
 
773
        if context_info is None:
 
 
774
            self.context_info = ''
 
 
776
            self.context_info = context_info + ". "
 
 
779
class NotVersionedError(BzrError):
 
 
780
    """Used when a path is expected to be versioned, but it is not."""
 
 
782
    _fmt = "%(context_info)s%(path)s is not versioned."
 
 
784
    def __init__(self, path, context_info=None):
 
 
785
        """Construct a new NotVersionedError.
 
 
787
        :param path: This is the path which is not versioned,
 
 
788
        which should be in a user friendly form.
 
 
789
        :param context_info: If given, this is information about the context,
 
 
790
        which could explain why this is expected to be versioned.
 
 
792
        BzrError.__init__(self)
 
 
794
        if context_info is None:
 
 
795
            self.context_info = ''
 
 
797
            self.context_info = context_info + ". "
 
 
800
class PathsNotVersionedError(BzrError):
 
 
801
    """Used when reporting several paths which are not versioned"""
 
 
803
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
 
805
    def __init__(self, paths):
 
 
806
        from bzrlib.osutils import quotefn
 
 
807
        BzrError.__init__(self)
 
 
809
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
812
class PathsDoNotExist(BzrError):
 
 
814
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
 
816
    # used when reporting that paths are neither versioned nor in the working
 
 
819
    def __init__(self, paths, extra=None):
 
 
821
        from bzrlib.osutils import quotefn
 
 
822
        BzrError.__init__(self)
 
 
824
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
826
            self.extra = ': ' + str(extra)
 
 
831
class BadFileKindError(BzrError):
 
 
833
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
 
835
    def __init__(self, filename, kind):
 
 
836
        BzrError.__init__(self, filename=filename, kind=kind)
 
 
839
class ForbiddenControlFileError(BzrError):
 
 
841
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
 
844
class LockError(InternalBzrError):
 
 
846
    _fmt = "Lock error: %(msg)s"
 
 
848
    # All exceptions from the lock/unlock functions should be from
 
 
849
    # this exception class.  They will be translated as necessary. The
 
 
850
    # original exception is available as e.original_error
 
 
852
    # New code should prefer to raise specific subclasses
 
 
853
    def __init__(self, message):
 
 
854
        # Python 2.5 uses a slot for StandardError.message,
 
 
855
        # so use a different variable name.  We now work around this in
 
 
856
        # BzrError.__str__, but this member name is kept for compatability.
 
 
860
class LockActive(LockError):
 
 
862
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
 
864
    internal_error = False
 
 
866
    def __init__(self, lock_description):
 
 
867
        self.lock_description = lock_description
 
 
870
class CommitNotPossible(LockError):
 
 
872
    _fmt = "A commit was attempted but we do not have a write lock open."
 
 
878
class AlreadyCommitted(LockError):
 
 
880
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
 
886
class ReadOnlyError(LockError):
 
 
888
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
 
890
    # TODO: There should also be an error indicating that you need a write
 
 
891
    # lock and don't have any lock at all... mbp 20070226
 
 
893
    def __init__(self, obj):
 
 
897
class ReadOnlyLockError(LockError):
 
 
899
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
 
901
    @symbol_versioning.deprecated_method(symbol_versioning.zero_ninetytwo)
 
 
902
    def __init__(self, fname, msg):
 
 
903
        LockError.__init__(self, '')
 
 
908
class LockFailed(LockError):
 
 
910
    internal_error = False
 
 
912
    _fmt = "Cannot lock %(lock)s: %(why)s"
 
 
914
    def __init__(self, lock, why):
 
 
915
        LockError.__init__(self, '')
 
 
920
class OutSideTransaction(BzrError):
 
 
922
    _fmt = ("A transaction related operation was attempted after"
 
 
923
            " the transaction finished.")
 
 
926
class ObjectNotLocked(LockError):
 
 
928
    _fmt = "%(obj)r is not locked"
 
 
930
    # this can indicate that any particular object is not locked; see also
 
 
931
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
932
    # the caller -- perhaps they should be unified.
 
 
933
    def __init__(self, obj):
 
 
937
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
939
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
 
941
    def __init__(self, obj):
 
 
945
class UnlockableTransport(LockError):
 
 
947
    internal_error = False
 
 
949
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
 
951
    def __init__(self, transport):
 
 
952
        self.transport = transport
 
 
955
class LockContention(LockError):
 
 
957
    _fmt = 'Could not acquire lock "%(lock)s"'
 
 
958
    # TODO: show full url for lock, combining the transport and relative
 
 
961
    internal_error = False
 
 
963
    def __init__(self, lock):
 
 
967
class LockBroken(LockError):
 
 
969
    _fmt = ("Lock was broken while still open: %(lock)s"
 
 
970
            " - check storage consistency!")
 
 
972
    internal_error = False
 
 
974
    def __init__(self, lock):
 
 
978
class LockBreakMismatch(LockError):
 
 
980
    _fmt = ("Lock was released and re-acquired before being broken:"
 
 
981
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
 
983
    internal_error = False
 
 
985
    def __init__(self, lock, holder, target):
 
 
991
class LockNotHeld(LockError):
 
 
993
    _fmt = "Lock not held: %(lock)s"
 
 
995
    internal_error = False
 
 
997
    def __init__(self, lock):
 
 
1001
class TokenLockingNotSupported(LockError):
 
 
1003
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
 
1005
    def __init__(self, obj):
 
 
1009
class TokenMismatch(LockBroken):
 
 
1011
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
 
1013
    internal_error = True
 
 
1015
    def __init__(self, given_token, lock_token):
 
 
1016
        self.given_token = given_token
 
 
1017
        self.lock_token = lock_token
 
 
1020
class PointlessCommit(BzrError):
 
 
1022
    _fmt = "No changes to commit"
 
 
1025
class CannotCommitSelectedFileMerge(BzrError):
 
 
1027
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
 
1028
        ' files %(files_str)s'
 
 
1030
    def __init__(self, files):
 
 
1031
        files_str = ', '.join(files)
 
 
1032
        BzrError.__init__(self, files=files, files_str=files_str)
 
 
1035
class BadCommitMessageEncoding(BzrError):
 
 
1037
    _fmt = 'The specified commit message contains characters unsupported by '\
 
 
1038
        'the current encoding.'
 
 
1041
class UpgradeReadonly(BzrError):
 
 
1043
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
 
1046
class UpToDateFormat(BzrError):
 
 
1048
    _fmt = "The branch format %(format)s is already at the most recent format."
 
 
1050
    def __init__(self, format):
 
 
1051
        BzrError.__init__(self)
 
 
1052
        self.format = format
 
 
1055
class StrictCommitFailed(Exception):
 
 
1057
    _fmt = "Commit refused because there are unknowns in the tree."
 
 
1060
class NoSuchRevision(InternalBzrError):
 
 
1062
    _fmt = "%(branch)s has no revision %(revision)s"
 
 
1064
    def __init__(self, branch, revision):
 
 
1065
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
 
 
1066
        BzrError.__init__(self, branch=branch, revision=revision)
 
 
1069
# zero_ninetyone: this exception is no longer raised and should be removed
 
 
1070
class NotLeftParentDescendant(InternalBzrError):
 
 
1072
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
 
1073
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
 
1075
    def __init__(self, branch, old_revision, new_revision):
 
 
1076
        BzrError.__init__(self, branch_location=branch.base,
 
 
1077
                          old_revision=old_revision,
 
 
1078
                          new_revision=new_revision)
 
 
1081
class RangeInChangeOption(BzrError):
 
 
1083
    _fmt = "Option --change does not accept revision ranges"
 
 
1086
class NoSuchRevisionSpec(BzrError):
 
 
1088
    _fmt = "No namespace registered for string: %(spec)r"
 
 
1090
    def __init__(self, spec):
 
 
1091
        BzrError.__init__(self, spec=spec)
 
 
1094
class NoSuchRevisionInTree(NoSuchRevision):
 
 
1095
    """When using Tree.revision_tree, and the revision is not accessible."""
 
 
1097
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
 
1099
    def __init__(self, tree, revision_id):
 
 
1100
        BzrError.__init__(self)
 
 
1102
        self.revision_id = revision_id
 
 
1105
class InvalidRevisionSpec(BzrError):
 
 
1107
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
 
1108
            " %(branch)s%(extra)s")
 
 
1110
    def __init__(self, spec, branch, extra=None):
 
 
1111
        BzrError.__init__(self, branch=branch, spec=spec)
 
 
1113
            self.extra = '\n' + str(extra)
 
 
1118
class HistoryMissing(BzrError):
 
 
1120
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
 
1123
class AppendRevisionsOnlyViolation(BzrError):
 
 
1125
    _fmt = ('Operation denied because it would change the main history,'
 
 
1126
           ' which is not permitted by the append_revisions_only setting on'
 
 
1127
           ' branch "%(location)s".')
 
 
1129
    def __init__(self, location):
 
 
1130
       import bzrlib.urlutils as urlutils
 
 
1131
       location = urlutils.unescape_for_display(location, 'ascii')
 
 
1132
       BzrError.__init__(self, location=location)
 
 
1135
class DivergedBranches(BzrError):
 
 
1137
    _fmt = ("These branches have diverged."
 
 
1138
            " Use the merge command to reconcile them.")
 
 
1140
    def __init__(self, branch1, branch2):
 
 
1141
        self.branch1 = branch1
 
 
1142
        self.branch2 = branch2
 
 
1145
class NotLefthandHistory(InternalBzrError):
 
 
1147
    _fmt = "Supplied history does not follow left-hand parents"
 
 
1149
    def __init__(self, history):
 
 
1150
        BzrError.__init__(self, history=history)
 
 
1153
class UnrelatedBranches(BzrError):
 
 
1155
    _fmt = ("Branches have no common ancestor, and"
 
 
1156
            " no merge base revision was specified.")
 
 
1159
class CannotReverseCherrypick(BzrError):
 
 
1161
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
 
1165
class NoCommonAncestor(BzrError):
 
 
1167
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
1169
    def __init__(self, revision_a, revision_b):
 
 
1170
        self.revision_a = revision_a
 
 
1171
        self.revision_b = revision_b
 
 
1174
class NoCommonRoot(BzrError):
 
 
1176
    _fmt = ("Revisions are not derived from the same root: "
 
 
1177
           "%(revision_a)s %(revision_b)s.")
 
 
1179
    def __init__(self, revision_a, revision_b):
 
 
1180
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
 
1183
class NotAncestor(BzrError):
 
 
1185
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
 
1187
    def __init__(self, rev_id, not_ancestor_id):
 
 
1188
        BzrError.__init__(self, rev_id=rev_id,
 
 
1189
            not_ancestor_id=not_ancestor_id)
 
 
1192
class InstallFailed(BzrError):
 
 
1194
    def __init__(self, revisions):
 
 
1195
        revision_str = ", ".join(str(r) for r in revisions)
 
 
1196
        msg = "Could not install revisions:\n%s" % revision_str
 
 
1197
        BzrError.__init__(self, msg)
 
 
1198
        self.revisions = revisions
 
 
1201
class AmbiguousBase(BzrError):
 
 
1203
    def __init__(self, bases):
 
 
1204
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
1206
        msg = ("The correct base is unclear, because %s are all equally close"
 
 
1208
        BzrError.__init__(self, msg)
 
 
1212
class NoCommits(BranchError):
 
 
1214
    _fmt = "Branch %(branch)s has no commits."
 
 
1217
class UnlistableStore(BzrError):
 
 
1219
    def __init__(self, store):
 
 
1220
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
1224
class UnlistableBranch(BzrError):
 
 
1226
    def __init__(self, br):
 
 
1227
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
1230
class BoundBranchOutOfDate(BzrError):
 
 
1232
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
 
1235
    def __init__(self, branch, master):
 
 
1236
        BzrError.__init__(self)
 
 
1237
        self.branch = branch
 
 
1238
        self.master = master
 
 
1241
class CommitToDoubleBoundBranch(BzrError):
 
 
1243
    _fmt = ("Cannot commit to branch %(branch)s."
 
 
1244
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
 
1246
    def __init__(self, branch, master, remote):
 
 
1247
        BzrError.__init__(self)
 
 
1248
        self.branch = branch
 
 
1249
        self.master = master
 
 
1250
        self.remote = remote
 
 
1253
class OverwriteBoundBranch(BzrError):
 
 
1255
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
 
1257
    def __init__(self, branch):
 
 
1258
        BzrError.__init__(self)
 
 
1259
        self.branch = branch
 
 
1262
class BoundBranchConnectionFailure(BzrError):
 
 
1264
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
 
1265
            " => %(target)s: %(error)s")
 
 
1267
    def __init__(self, branch, target, error):
 
 
1268
        BzrError.__init__(self)
 
 
1269
        self.branch = branch
 
 
1270
        self.target = target
 
 
1274
class WeaveError(BzrError):
 
 
1276
    _fmt = "Error in processing weave: %(message)s"
 
 
1278
    def __init__(self, message=None):
 
 
1279
        BzrError.__init__(self)
 
 
1280
        self.message = message
 
 
1283
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
1285
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
 
1287
    def __init__(self, revision_id, weave):
 
 
1289
        WeaveError.__init__(self)
 
 
1290
        self.revision_id = revision_id
 
 
1294
class WeaveRevisionNotPresent(WeaveError):
 
 
1296
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
 
1298
    def __init__(self, revision_id, weave):
 
 
1299
        WeaveError.__init__(self)
 
 
1300
        self.revision_id = revision_id
 
 
1304
class WeaveFormatError(WeaveError):
 
 
1306
    _fmt = "Weave invariant violated: %(what)s"
 
 
1308
    def __init__(self, what):
 
 
1309
        WeaveError.__init__(self)
 
 
1313
class WeaveParentMismatch(WeaveError):
 
 
1315
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
 
1318
class WeaveInvalidChecksum(WeaveError):
 
 
1320
    _fmt = "Text did not match it's checksum: %(message)s"
 
 
1323
class WeaveTextDiffers(WeaveError):
 
 
1325
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1326
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1328
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1329
        WeaveError.__init__(self)
 
 
1330
        self.revision_id = revision_id
 
 
1331
        self.weave_a = weave_a
 
 
1332
        self.weave_b = weave_b
 
 
1335
class WeaveTextDiffers(WeaveError):
 
 
1337
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1338
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1340
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1341
        WeaveError.__init__(self)
 
 
1342
        self.revision_id = revision_id
 
 
1343
        self.weave_a = weave_a
 
 
1344
        self.weave_b = weave_b
 
 
1347
class VersionedFileError(BzrError):
 
 
1349
    _fmt = "Versioned file error"
 
 
1352
class RevisionNotPresent(VersionedFileError):
 
 
1354
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
 
1356
    def __init__(self, revision_id, file_id):
 
 
1357
        VersionedFileError.__init__(self)
 
 
1358
        self.revision_id = revision_id
 
 
1359
        self.file_id = file_id
 
 
1362
class RevisionAlreadyPresent(VersionedFileError):
 
 
1364
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
 
1366
    def __init__(self, revision_id, file_id):
 
 
1367
        VersionedFileError.__init__(self)
 
 
1368
        self.revision_id = revision_id
 
 
1369
        self.file_id = file_id
 
 
1372
class VersionedFileInvalidChecksum(VersionedFileError):
 
 
1374
    _fmt = "Text did not match its checksum: %(message)s"
 
 
1377
class KnitError(InternalBzrError):
 
 
1382
class KnitCorrupt(KnitError):
 
 
1384
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
 
1386
    def __init__(self, filename, how):
 
 
1387
        KnitError.__init__(self)
 
 
1388
        self.filename = filename
 
 
1392
class KnitDataStreamIncompatible(KnitError):
 
 
1393
    # Not raised anymore, as we can convert data streams.  In future we may
 
 
1394
    # need it again for more exotic cases, so we're keeping it around for now.
 
 
1396
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
 
1398
    def __init__(self, stream_format, target_format):
 
 
1399
        self.stream_format = stream_format
 
 
1400
        self.target_format = target_format
 
 
1403
class KnitDataStreamUnknown(KnitError):
 
 
1404
    # Indicates a data stream we don't know how to handle.
 
 
1406
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
 
1408
    def __init__(self, stream_format):
 
 
1409
        self.stream_format = stream_format
 
 
1412
class KnitHeaderError(KnitError):
 
 
1414
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
 
1416
    def __init__(self, badline, filename):
 
 
1417
        KnitError.__init__(self)
 
 
1418
        self.badline = badline
 
 
1419
        self.filename = filename
 
 
1421
class KnitIndexUnknownMethod(KnitError):
 
 
1422
    """Raised when we don't understand the storage method.
 
 
1424
    Currently only 'fulltext' and 'line-delta' are supported.
 
 
1427
    _fmt = ("Knit index %(filename)s does not have a known method"
 
 
1428
            " in options: %(options)r")
 
 
1430
    def __init__(self, filename, options):
 
 
1431
        KnitError.__init__(self)
 
 
1432
        self.filename = filename
 
 
1433
        self.options = options
 
 
1436
class NoSuchExportFormat(BzrError):
 
 
1438
    _fmt = "Export format %(format)r not supported"
 
 
1440
    def __init__(self, format):
 
 
1441
        BzrError.__init__(self)
 
 
1442
        self.format = format
 
 
1445
class TransportError(BzrError):
 
 
1447
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
 
1449
    def __init__(self, msg=None, orig_error=None):
 
 
1450
        if msg is None and orig_error is not None:
 
 
1451
            msg = str(orig_error)
 
 
1452
        if orig_error is None:
 
 
1457
        self.orig_error = orig_error
 
 
1458
        BzrError.__init__(self)
 
 
1461
class TooManyConcurrentRequests(InternalBzrError):
 
 
1463
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
 
1464
            " Be sure to finish_writing and finish_reading on the"
 
 
1465
            " currently open request.")
 
 
1467
    def __init__(self, medium):
 
 
1468
        self.medium = medium
 
 
1471
class SmartProtocolError(TransportError):
 
 
1473
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
 
1475
    def __init__(self, details):
 
 
1476
        self.details = details
 
 
1479
class UnknownSmartMethod(InternalBzrError):
 
 
1481
    _fmt = "The server does not recognise the '%(verb)s' request."
 
 
1483
    def __init__(self, verb):
 
 
1487
# A set of semi-meaningful errors which can be thrown
 
 
1488
class TransportNotPossible(TransportError):
 
 
1490
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
 
1493
class ConnectionError(TransportError):
 
 
1495
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
 
1498
class SocketConnectionError(ConnectionError):
 
 
1500
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
 
1502
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
1504
            msg = 'Failed to connect to'
 
 
1505
        if orig_error is None:
 
 
1508
            orig_error = '; ' + str(orig_error)
 
 
1509
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
1514
            self.port = ':%s' % port
 
 
1517
class ConnectionReset(TransportError):
 
 
1519
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
 
1522
class InvalidRange(TransportError):
 
 
1524
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
 
1526
    def __init__(self, path, offset, msg=None):
 
 
1527
        TransportError.__init__(self, msg)
 
 
1529
        self.offset = offset
 
 
1532
class InvalidHttpResponse(TransportError):
 
 
1534
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
 
1536
    def __init__(self, path, msg, orig_error=None):
 
 
1538
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
1541
class InvalidHttpRange(InvalidHttpResponse):
 
 
1543
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
 
1545
    def __init__(self, path, range, msg):
 
 
1547
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1550
class InvalidHttpContentType(InvalidHttpResponse):
 
 
1552
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
 
1554
    def __init__(self, path, ctype, msg):
 
 
1556
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1559
class RedirectRequested(TransportError):
 
 
1561
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
 
1563
    def __init__(self, source, target, is_permanent=False, qual_proto=None):
 
 
1564
        self.source = source
 
 
1565
        self.target = target
 
 
1567
            self.permanently = ' permanently'
 
 
1569
            self.permanently = ''
 
 
1570
        self._qualified_proto = qual_proto
 
 
1571
        TransportError.__init__(self)
 
 
1573
    def _requalify_url(self, url):
 
 
1574
        """Restore the qualified proto in front of the url"""
 
 
1575
        # When this exception is raised, source and target are in
 
 
1576
        # user readable format. But some transports may use a
 
 
1577
        # different proto (http+urllib:// will present http:// to
 
 
1578
        # the user. If a qualified proto is specified, the code
 
 
1579
        # trapping the exception can get the qualified urls to
 
 
1580
        # properly handle the redirection themself (creating a
 
 
1581
        # new transport object from the target url for example).
 
 
1582
        # But checking that the scheme of the original and
 
 
1583
        # redirected urls are the same can be tricky. (see the
 
 
1584
        # FIXME in BzrDir.open_from_transport for the unique use
 
 
1586
        if self._qualified_proto is None:
 
 
1589
        # The TODO related to NotBranchError mention that doing
 
 
1590
        # that kind of manipulation on the urls may not be the
 
 
1591
        # exception object job. On the other hand, this object is
 
 
1592
        # the interface between the code and the user so
 
 
1593
        # presenting the urls in different ways is indeed its
 
 
1596
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
 
1597
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
 
1600
    def get_source_url(self):
 
 
1601
        return self._requalify_url(self.source)
 
 
1603
    def get_target_url(self):
 
 
1604
        return self._requalify_url(self.target)
 
 
1607
class TooManyRedirections(TransportError):
 
 
1609
    _fmt = "Too many redirections"
 
 
1612
class ConflictsInTree(BzrError):
 
 
1614
    _fmt = "Working tree has conflicts."
 
 
1617
class ParseConfigError(BzrError):
 
 
1619
    def __init__(self, errors, filename):
 
 
1620
        if filename is None:
 
 
1622
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
1623
            (filename, ('\n'.join(e.message for e in errors)))
 
 
1624
        BzrError.__init__(self, message)
 
 
1627
class NoEmailInUsername(BzrError):
 
 
1629
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
 
1631
    def __init__(self, username):
 
 
1632
        BzrError.__init__(self)
 
 
1633
        self.username = username
 
 
1636
class SigningFailed(BzrError):
 
 
1638
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
 
1640
    def __init__(self, command_line):
 
 
1641
        BzrError.__init__(self, command_line=command_line)
 
 
1644
class WorkingTreeNotRevision(BzrError):
 
 
1646
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
 
1647
            " the last commit, but weave merge requires that it be"
 
 
1650
    def __init__(self, tree):
 
 
1651
        BzrError.__init__(self, basedir=tree.basedir)
 
 
1654
class CantReprocessAndShowBase(BzrError):
 
 
1656
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
 
1657
           "the relationship of conflicting lines to the base")
 
 
1660
class GraphCycleError(BzrError):
 
 
1662
    _fmt = "Cycle in graph %(graph)r"
 
 
1664
    def __init__(self, graph):
 
 
1665
        BzrError.__init__(self)
 
 
1669
class WritingCompleted(InternalBzrError):
 
 
1671
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
 
1672
            "called upon it - accept bytes may not be called anymore.")
 
 
1674
    def __init__(self, request):
 
 
1675
        self.request = request
 
 
1678
class WritingNotComplete(InternalBzrError):
 
 
1680
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
 
1681
            "called upon it - until the write phase is complete no "
 
 
1682
            "data may be read.")
 
 
1684
    def __init__(self, request):
 
 
1685
        self.request = request
 
 
1688
class NotConflicted(BzrError):
 
 
1690
    _fmt = "File %(filename)s is not conflicted."
 
 
1692
    def __init__(self, filename):
 
 
1693
        BzrError.__init__(self)
 
 
1694
        self.filename = filename
 
 
1697
class MediumNotConnected(InternalBzrError):
 
 
1699
    _fmt = """The medium '%(medium)s' is not connected."""
 
 
1701
    def __init__(self, medium):
 
 
1702
        self.medium = medium
 
 
1705
class MustUseDecorated(Exception):
 
 
1707
    _fmt = "A decorating function has requested its original command be used."
 
 
1710
class NoBundleFound(BzrError):
 
 
1712
    _fmt = 'No bundle was found in "%(filename)s".'
 
 
1714
    def __init__(self, filename):
 
 
1715
        BzrError.__init__(self)
 
 
1716
        self.filename = filename
 
 
1719
class BundleNotSupported(BzrError):
 
 
1721
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
 
1723
    def __init__(self, version, msg):
 
 
1724
        BzrError.__init__(self)
 
 
1725
        self.version = version
 
 
1729
class MissingText(BzrError):
 
 
1731
    _fmt = ("Branch %(base)s is missing revision"
 
 
1732
            " %(text_revision)s of %(file_id)s")
 
 
1734
    def __init__(self, branch, text_revision, file_id):
 
 
1735
        BzrError.__init__(self)
 
 
1736
        self.branch = branch
 
 
1737
        self.base = branch.base
 
 
1738
        self.text_revision = text_revision
 
 
1739
        self.file_id = file_id
 
 
1742
class DuplicateFileId(BzrError):
 
 
1744
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
 
1746
    def __init__(self, file_id, entry):
 
 
1747
        BzrError.__init__(self)
 
 
1748
        self.file_id = file_id
 
 
1752
class DuplicateKey(BzrError):
 
 
1754
    _fmt = "Key %(key)s is already present in map"
 
 
1757
class DuplicateHelpPrefix(BzrError):
 
 
1759
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
 
1761
    def __init__(self, prefix):
 
 
1762
        self.prefix = prefix
 
 
1765
class MalformedTransform(BzrError):
 
 
1767
    _fmt = "Tree transform is malformed %(conflicts)r"
 
 
1770
class NoFinalPath(BzrError):
 
 
1772
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
 
1773
            "file-id: %(file_id)r\n"
 
 
1774
            "root trans-id: %(root_trans_id)r\n")
 
 
1776
    def __init__(self, trans_id, transform):
 
 
1777
        self.trans_id = trans_id
 
 
1778
        self.file_id = transform.final_file_id(trans_id)
 
 
1779
        self.root_trans_id = transform.root
 
 
1782
class BzrBadParameter(InternalBzrError):
 
 
1784
    _fmt = "Bad parameter: %(param)r"
 
 
1786
    # This exception should never be thrown, but it is a base class for all
 
 
1787
    # parameter-to-function errors.
 
 
1789
    def __init__(self, param):
 
 
1790
        BzrError.__init__(self)
 
 
1794
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1796
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
 
1799
class ReusingTransform(BzrError):
 
 
1801
    _fmt = "Attempt to reuse a transform that has already been applied."
 
 
1804
class CantMoveRoot(BzrError):
 
 
1806
    _fmt = "Moving the root directory is not supported at this time"
 
 
1809
class BzrMoveFailedError(BzrError):
 
 
1811
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1813
    def __init__(self, from_path='', to_path='', extra=None):
 
 
1814
        BzrError.__init__(self)
 
 
1816
            self.extra = ': ' + str(extra)
 
 
1820
        has_from = len(from_path) > 0
 
 
1821
        has_to = len(to_path) > 0
 
 
1823
            self.from_path = osutils.splitpath(from_path)[-1]
 
 
1828
            self.to_path = osutils.splitpath(to_path)[-1]
 
 
1833
        if has_from and has_to:
 
 
1834
            self.operator = " =>"
 
 
1836
            self.from_path = "from " + from_path
 
 
1838
            self.operator = "to"
 
 
1840
            self.operator = "file"
 
 
1843
class BzrRenameFailedError(BzrMoveFailedError):
 
 
1845
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1847
    def __init__(self, from_path, to_path, extra=None):
 
 
1848
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
 
1850
class BzrRemoveChangedFilesError(BzrError):
 
 
1851
    """Used when user is trying to remove changed files."""
 
 
1853
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
 
1854
        "%(changes_as_text)s"
 
 
1855
        "Use --keep to not delete them, or --force to delete them regardless.")
 
 
1857
    def __init__(self, tree_delta):
 
 
1858
        BzrError.__init__(self)
 
 
1859
        self.changes_as_text = tree_delta.get_changes_as_text()
 
 
1860
        #self.paths_as_string = '\n'.join(changed_files)
 
 
1861
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
 
1864
class BzrBadParameterNotString(BzrBadParameter):
 
 
1866
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
 
1869
class BzrBadParameterMissing(BzrBadParameter):
 
 
1871
    _fmt = "Parameter $(param)s is required but not present."
 
 
1874
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1876
    _fmt = ("Parameter %(param)s is unicode but"
 
 
1877
            " only byte-strings are permitted.")
 
 
1880
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1882
    _fmt = "Parameter %(param)s contains a newline."
 
 
1885
class DependencyNotPresent(BzrError):
 
 
1887
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
 
1889
    def __init__(self, library, error):
 
 
1890
        BzrError.__init__(self, library=library, error=error)
 
 
1893
class ParamikoNotPresent(DependencyNotPresent):
 
 
1895
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
 
1897
    def __init__(self, error):
 
 
1898
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1901
class PointlessMerge(BzrError):
 
 
1903
    _fmt = "Nothing to merge."
 
 
1906
class UninitializableFormat(BzrError):
 
 
1908
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
 
1910
    def __init__(self, format):
 
 
1911
        BzrError.__init__(self)
 
 
1912
        self.format = format
 
 
1915
class BadConversionTarget(BzrError):
 
 
1917
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
 
1919
    def __init__(self, problem, format):
 
 
1920
        BzrError.__init__(self)
 
 
1921
        self.problem = problem
 
 
1922
        self.format = format
 
 
1925
class NoDiffFound(BzrError):
 
 
1927
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
 
1929
    def __init__(self, path):
 
 
1930
        BzrError.__init__(self, path)
 
 
1933
class ExecutableMissing(BzrError):
 
 
1935
    _fmt = "%(exe_name)s could not be found on this machine"
 
 
1937
    def __init__(self, exe_name):
 
 
1938
        BzrError.__init__(self, exe_name=exe_name)
 
 
1941
class NoDiff(BzrError):
 
 
1943
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
 
1945
    def __init__(self, msg):
 
 
1946
        BzrError.__init__(self, msg=msg)
 
 
1949
class NoDiff3(BzrError):
 
 
1951
    _fmt = "Diff3 is not installed on this machine."
 
 
1954
class ExistingContent(BzrError):
 
 
1955
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
 
1957
    _fmt = "The content being inserted is already present."
 
 
1960
class ExistingLimbo(BzrError):
 
 
1962
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1963
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1964
    keep, and delete it when you are done."""
 
 
1966
    def __init__(self, limbo_dir):
 
 
1967
       BzrError.__init__(self)
 
 
1968
       self.limbo_dir = limbo_dir
 
 
1971
class ExistingPendingDeletion(BzrError):
 
 
1973
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1974
    Please examine %(pending_deletion)s to see if it contains any files you
 
 
1975
    wish to keep, and delete it when you are done."""
 
 
1977
    def __init__(self, pending_deletion):
 
 
1978
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
 
1981
class ImmortalLimbo(BzrError):
 
 
1983
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
 
1984
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1985
    keep, and delete it when you are done."""
 
 
1987
    def __init__(self, limbo_dir):
 
 
1988
       BzrError.__init__(self)
 
 
1989
       self.limbo_dir = limbo_dir
 
 
1992
class ImmortalPendingDeletion(BzrError):
 
 
1994
    _fmt = ("Unable to delete transform temporary directory "
 
 
1995
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
 
1996
    "contains any files you wish to keep, and delete it when you are done.")
 
 
1998
    def __init__(self, pending_deletion):
 
 
1999
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
 
2002
class OutOfDateTree(BzrError):
 
 
2004
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
 
2006
    def __init__(self, tree):
 
 
2007
        BzrError.__init__(self)
 
 
2011
class PublicBranchOutOfDate(BzrError):
 
 
2013
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
 
2016
    def __init__(self, public_location, revstring):
 
 
2017
        import bzrlib.urlutils as urlutils
 
 
2018
        public_location = urlutils.unescape_for_display(public_location,
 
 
2020
        BzrError.__init__(self, public_location=public_location,
 
 
2021
                          revstring=revstring)
 
 
2024
class MergeModifiedFormatError(BzrError):
 
 
2026
    _fmt = "Error in merge modified format"
 
 
2029
class ConflictFormatError(BzrError):
 
 
2031
    _fmt = "Format error in conflict listings"
 
 
2034
class CorruptDirstate(BzrError):
 
 
2036
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
 
2037
            "Error: %(description)s")
 
 
2039
    def __init__(self, dirstate_path, description):
 
 
2040
        BzrError.__init__(self)
 
 
2041
        self.dirstate_path = dirstate_path
 
 
2042
        self.description = description
 
 
2045
class CorruptRepository(BzrError):
 
 
2047
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
 
2048
            "Please run bzr reconcile on this repository.")
 
 
2050
    def __init__(self, repo):
 
 
2051
        BzrError.__init__(self)
 
 
2052
        self.repo_path = repo.bzrdir.root_transport.base
 
 
2055
class InconsistentDelta(BzrError):
 
 
2056
    """Used when we get a delta that is not valid."""
 
 
2058
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
 
2059
            " %(file_id)r\nreason: %(reason)s")
 
 
2061
    def __init__(self, path, file_id, reason):
 
 
2062
        BzrError.__init__(self)
 
 
2064
        self.file_id = file_id
 
 
2065
        self.reason = reason
 
 
2068
class UpgradeRequired(BzrError):
 
 
2070
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
 
2072
    def __init__(self, path):
 
 
2073
        BzrError.__init__(self)
 
 
2077
class LocalRequiresBoundBranch(BzrError):
 
 
2079
    _fmt = "Cannot perform local-only commits on unbound branches."
 
 
2082
class MissingProgressBarFinish(BzrError):
 
 
2084
    _fmt = "A nested progress bar was not 'finished' correctly."
 
 
2087
class InvalidProgressBarType(BzrError):
 
 
2089
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
 
2090
            " is not a supported type Select one of: %(valid_types)s")
 
 
2092
    def __init__(self, bar_type, valid_types):
 
 
2093
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
2096
class UnsupportedOperation(BzrError):
 
 
2098
    _fmt = ("The method %(mname)s is not supported on"
 
 
2099
            " objects of type %(tname)s.")
 
 
2101
    def __init__(self, method, method_self):
 
 
2102
        self.method = method
 
 
2103
        self.mname = method.__name__
 
 
2104
        self.tname = type(method_self).__name__
 
 
2107
class CannotSetRevisionId(UnsupportedOperation):
 
 
2108
    """Raised when a commit is attempting to set a revision id but cant."""
 
 
2111
class NonAsciiRevisionId(UnsupportedOperation):
 
 
2112
    """Raised when a commit is attempting to set a non-ascii revision id
 
 
2117
class BinaryFile(BzrError):
 
 
2119
    _fmt = "File is binary but should be text."
 
 
2122
class IllegalPath(BzrError):
 
 
2124
    _fmt = "The path %(path)s is not permitted on this platform"
 
 
2126
    def __init__(self, path):
 
 
2127
        BzrError.__init__(self)
 
 
2131
class TestamentMismatch(BzrError):
 
 
2133
    _fmt = """Testament did not match expected value.
 
 
2134
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
 
2137
    def __init__(self, revision_id, expected, measured):
 
 
2138
        self.revision_id = revision_id
 
 
2139
        self.expected = expected
 
 
2140
        self.measured = measured
 
 
2143
class NotABundle(BzrError):
 
 
2145
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
 
2147
    def __init__(self, text):
 
 
2148
        BzrError.__init__(self)
 
 
2152
class BadBundle(BzrError): 
 
 
2154
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
 
2156
    def __init__(self, text):
 
 
2157
        BzrError.__init__(self)
 
 
2161
class MalformedHeader(BadBundle): 
 
 
2163
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
 
2166
class MalformedPatches(BadBundle): 
 
 
2168
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
 
2171
class MalformedFooter(BadBundle): 
 
 
2173
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
 
2176
class UnsupportedEOLMarker(BadBundle):
 
 
2178
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
 
2181
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
 
2182
        # but for this there is not
 
 
2183
        BzrError.__init__(self)
 
 
2186
class IncompatibleBundleFormat(BzrError):
 
 
2188
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
 
2190
    def __init__(self, bundle_format, other):
 
 
2191
        BzrError.__init__(self)
 
 
2192
        self.bundle_format = bundle_format
 
 
2196
class BadInventoryFormat(BzrError):
 
 
2198
    _fmt = "Root class for inventory serialization errors"
 
 
2201
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
2203
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
 
2205
    def __init__(self, msg):
 
 
2206
        BadInventoryFormat.__init__(self, msg=msg)
 
 
2209
class RootNotRich(BzrError):
 
 
2211
    _fmt = """This operation requires rich root data storage"""
 
 
2214
class NoSmartMedium(InternalBzrError):
 
 
2216
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
 
2218
    def __init__(self, transport):
 
 
2219
        self.transport = transport
 
 
2222
class NoSmartServer(NotBranchError):
 
 
2224
    _fmt = "No smart server available at %(url)s"
 
 
2226
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
 
2227
    def __init__(self, url):
 
 
2231
class UnknownSSH(BzrError):
 
 
2233
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
 
2235
    def __init__(self, vendor):
 
 
2236
        BzrError.__init__(self)
 
 
2237
        self.vendor = vendor
 
 
2240
class SSHVendorNotFound(BzrError):
 
 
2242
    _fmt = ("Don't know how to handle SSH connections."
 
 
2243
            " Please set BZR_SSH environment variable.")
 
 
2246
class GhostRevisionUnusableHere(BzrError):
 
 
2248
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
 
2250
    def __init__(self, revision_id):
 
 
2251
        BzrError.__init__(self)
 
 
2252
        self.revision_id = revision_id
 
 
2255
class IllegalUseOfScopeReplacer(InternalBzrError):
 
 
2257
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
 
2258
            " %(msg)s%(extra)s")
 
 
2260
    def __init__(self, name, msg, extra=None):
 
 
2261
        BzrError.__init__(self)
 
 
2265
            self.extra = ': ' + str(extra)
 
 
2270
class InvalidImportLine(InternalBzrError):
 
 
2272
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
 
2274
    def __init__(self, text, msg):
 
 
2275
        BzrError.__init__(self)
 
 
2280
class ImportNameCollision(InternalBzrError):
 
 
2282
    _fmt = ("Tried to import an object to the same name as"
 
 
2283
            " an existing object. %(name)s")
 
 
2285
    def __init__(self, name):
 
 
2286
        BzrError.__init__(self)
 
 
2290
class NotAMergeDirective(BzrError):
 
 
2291
    """File starting with %(firstline)r is not a merge directive"""
 
 
2292
    def __init__(self, firstline):
 
 
2293
        BzrError.__init__(self, firstline=firstline)
 
 
2296
class NoMergeSource(BzrError):
 
 
2297
    """Raise if no merge source was specified for a merge directive"""
 
 
2299
    _fmt = "A merge directive must provide either a bundle or a public"\
 
 
2303
class IllegalMergeDirectivePayload(BzrError):
 
 
2304
    """A merge directive contained something other than a patch or bundle"""
 
 
2306
    _fmt = "Bad merge directive payload %(start)r"
 
 
2308
    def __init__(self, start):
 
 
2313
class PatchVerificationFailed(BzrError):
 
 
2314
    """A patch from a merge directive could not be verified"""
 
 
2316
    _fmt = "Preview patch does not match requested changes."
 
 
2319
class PatchMissing(BzrError):
 
 
2320
    """Raise a patch type was specified but no patch supplied"""
 
 
2322
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
 
2324
    def __init__(self, patch_type):
 
 
2325
        BzrError.__init__(self)
 
 
2326
        self.patch_type = patch_type
 
 
2329
class UnsupportedInventoryKind(BzrError):
 
 
2331
    _fmt = """Unsupported entry kind %(kind)s"""
 
 
2333
    def __init__(self, kind):
 
 
2337
class BadSubsumeSource(BzrError):
 
 
2339
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
 
2341
    def __init__(self, tree, other_tree, reason):
 
 
2343
        self.other_tree = other_tree
 
 
2344
        self.reason = reason
 
 
2347
class SubsumeTargetNeedsUpgrade(BzrError):
 
 
2349
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
 
2351
    def __init__(self, other_tree):
 
 
2352
        self.other_tree = other_tree
 
 
2355
class BadReferenceTarget(InternalBzrError):
 
 
2357
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
 
2360
    def __init__(self, tree, other_tree, reason):
 
 
2362
        self.other_tree = other_tree
 
 
2363
        self.reason = reason
 
 
2366
class NoSuchTag(BzrError):
 
 
2368
    _fmt = "No such tag: %(tag_name)s"
 
 
2370
    def __init__(self, tag_name):
 
 
2371
        self.tag_name = tag_name
 
 
2374
class TagsNotSupported(BzrError):
 
 
2376
    _fmt = ("Tags not supported by %(branch)s;"
 
 
2377
            " you may be able to use bzr upgrade --dirstate-tags.")
 
 
2379
    def __init__(self, branch):
 
 
2380
        self.branch = branch
 
 
2383
class TagAlreadyExists(BzrError):
 
 
2385
    _fmt = "Tag %(tag_name)s already exists."
 
 
2387
    def __init__(self, tag_name):
 
 
2388
        self.tag_name = tag_name
 
 
2391
class MalformedBugIdentifier(BzrError):
 
 
2393
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
 
2395
    def __init__(self, bug_id, reason):
 
 
2396
        self.bug_id = bug_id
 
 
2397
        self.reason = reason
 
 
2400
class InvalidBugTrackerURL(BzrError):
 
 
2402
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
 
2403
            "contain {id}: %(url)s")
 
 
2405
    def __init__(self, abbreviation, url):
 
 
2406
        self.abbreviation = abbreviation
 
 
2410
class UnknownBugTrackerAbbreviation(BzrError):
 
 
2412
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
 
2415
    def __init__(self, abbreviation, branch):
 
 
2416
        self.abbreviation = abbreviation
 
 
2417
        self.branch = branch
 
 
2420
class UnexpectedSmartServerResponse(BzrError):
 
 
2422
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
 
2424
    def __init__(self, response_tuple):
 
 
2425
        self.response_tuple = response_tuple
 
 
2428
class ContainerError(BzrError):
 
 
2429
    """Base class of container errors."""
 
 
2432
class UnknownContainerFormatError(ContainerError):
 
 
2434
    _fmt = "Unrecognised container format: %(container_format)r"
 
 
2436
    def __init__(self, container_format):
 
 
2437
        self.container_format = container_format
 
 
2440
class UnexpectedEndOfContainerError(ContainerError):
 
 
2442
    _fmt = "Unexpected end of container stream"
 
 
2445
class UnknownRecordTypeError(ContainerError):
 
 
2447
    _fmt = "Unknown record type: %(record_type)r"
 
 
2449
    def __init__(self, record_type):
 
 
2450
        self.record_type = record_type
 
 
2453
class InvalidRecordError(ContainerError):
 
 
2455
    _fmt = "Invalid record: %(reason)s"
 
 
2457
    def __init__(self, reason):
 
 
2458
        self.reason = reason
 
 
2461
class ContainerHasExcessDataError(ContainerError):
 
 
2463
    _fmt = "Container has data after end marker: %(excess)r"
 
 
2465
    def __init__(self, excess):
 
 
2466
        self.excess = excess
 
 
2469
class DuplicateRecordNameError(ContainerError):
 
 
2471
    _fmt = "Container has multiple records with the same name: %(name)s"
 
 
2473
    def __init__(self, name):
 
 
2477
class NoDestinationAddress(InternalBzrError):
 
 
2479
    _fmt = "Message does not have a destination address."
 
 
2482
class RepositoryDataStreamError(BzrError):
 
 
2484
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
 
2486
    def __init__(self, reason):
 
 
2487
        self.reason = reason
 
 
2490
class SMTPError(BzrError):
 
 
2492
    _fmt = "SMTP error: %(error)s"
 
 
2494
    def __init__(self, error):
 
 
2498
class NoMessageSupplied(BzrError):
 
 
2500
    _fmt = "No message supplied."
 
 
2503
class NoMailAddressSpecified(BzrError):
 
 
2505
    _fmt = "No mail-to address specified."
 
 
2508
class UnknownMailClient(BzrError):
 
 
2510
    _fmt = "Unknown mail client: %(mail_client)s"
 
 
2512
    def __init__(self, mail_client):
 
 
2513
        BzrError.__init__(self, mail_client=mail_client)
 
 
2516
class MailClientNotFound(BzrError):
 
 
2518
    _fmt = "Unable to find mail client with the following names:"\
 
 
2519
        " %(mail_command_list_string)s"
 
 
2521
    def __init__(self, mail_command_list):
 
 
2522
        mail_command_list_string = ', '.join(mail_command_list)
 
 
2523
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
 
2524
                          mail_command_list_string=mail_command_list_string)
 
 
2526
class SMTPConnectionRefused(SMTPError):
 
 
2528
    _fmt = "SMTP connection to %(host)s refused"
 
 
2530
    def __init__(self, error, host):
 
 
2535
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
 
2537
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
 
2540
class BzrDirError(BzrError):
 
 
2542
    def __init__(self, bzrdir):
 
 
2543
        import bzrlib.urlutils as urlutils
 
 
2544
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
 
2546
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
 
2549
class AlreadyBranch(BzrDirError):
 
 
2551
    _fmt = "'%(display_url)s' is already a branch."
 
 
2554
class AlreadyTree(BzrDirError):
 
 
2556
    _fmt = "'%(display_url)s' is already a tree."
 
 
2559
class AlreadyCheckout(BzrDirError):
 
 
2561
    _fmt = "'%(display_url)s' is already a checkout."
 
 
2564
class AlreadyLightweightCheckout(BzrDirError):
 
 
2566
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
 
2569
class ReconfigurationNotSupported(BzrDirError):
 
 
2571
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
 
2574
class NoBindLocation(BzrDirError):
 
 
2576
    _fmt = "No location could be found to bind to at %(display_url)s."
 
 
2579
class UncommittedChanges(BzrError):
 
 
2581
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
 
 
2583
    def __init__(self, tree):
 
 
2584
        import bzrlib.urlutils as urlutils
 
 
2585
        display_url = urlutils.unescape_for_display(
 
 
2586
            tree.bzrdir.root_transport.base, 'ascii')
 
 
2587
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
 
2590
class MissingTemplateVariable(BzrError):
 
 
2592
    _fmt = 'Variable {%(name)s} is not available.'
 
 
2594
    def __init__(self, name):
 
 
2598
class NoTemplate(BzrError):
 
 
2600
    _fmt = 'No template specified.'
 
 
2603
class UnableCreateSymlink(BzrError):
 
 
2605
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
 
2607
    def __init__(self, path=None):
 
 
2611
                path_str = repr(str(path))
 
 
2612
            except UnicodeEncodeError:
 
 
2613
                path_str = repr(path)
 
 
2615
        self.path_str = path_str
 
 
2618
class UnsupportedTimezoneFormat(BzrError):
 
 
2620
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
 
2621
            'options are "utc", "original", "local".')
 
 
2623
    def __init__(self, timezone):
 
 
2624
        self.timezone = timezone
 
 
2627
class NotATerminal(BzrError):
 
 
2629
    _fmt = 'Unable to ask for a password without real terminal.'
 
 
2632
class UnableEncodePath(BzrError):
 
 
2634
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
 
2635
            'user encoding %(user_encoding)s')
 
 
2637
    def __init__(self, path, kind):
 
 
2640
        self.user_encoding = osutils.get_user_encoding()