1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
 
3
# This program is free software; you can redistribute it and/or modify
 
 
4
# it under the terms of the GNU General Public License as published by
 
 
5
# the Free Software Foundation; either version 2 of the License, or
 
 
6
# (at your option) any later version.
 
 
8
# This program is distributed in the hope that it will be useful,
 
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
11
# GNU General Public License for more details.
 
 
13
# You should have received a copy of the GNU General Public License
 
 
14
# along with this program; if not, write to the Free Software
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
17
"""Exceptions for bzr, and reporting of them.
 
 
25
from bzrlib.patches import (
 
 
34
# TODO: is there any value in providing the .args field used by standard
 
 
35
# python exceptions?   A list of values with no names seems less useful 
 
 
38
# TODO: Perhaps convert the exception to a string at the moment it's 
 
 
39
# constructed to make sure it will succeed.  But that says nothing about
 
 
40
# exceptions that are never raised.
 
 
42
# TODO: selftest assertRaises should probably also check that every error
 
 
43
# raised can be formatted as a string successfully, and without giving
 
 
47
# 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 ReadingCompleted(InternalBzrError):
 
 
514
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
 
515
            "called upon it - the request has been completed and no more "
 
 
518
    def __init__(self, request):
 
 
519
        self.request = request
 
 
522
class ResourceBusy(PathError):
 
 
524
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
 
 
527
class PermissionDenied(PathError):
 
 
529
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
 
532
class InvalidURL(PathError):
 
 
534
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
 
537
class InvalidURLJoin(PathError):
 
 
539
    _fmt = 'Invalid URL join request: "%(args)s"%(extra)s'
 
 
541
    def __init__(self, msg, base, args):
 
 
542
        PathError.__init__(self, base, msg)
 
 
543
        self.args = [base] + list(args)
 
 
546
class UnknownHook(BzrError):
 
 
548
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
 
550
    def __init__(self, hook_type, hook_name):
 
 
551
        BzrError.__init__(self)
 
 
552
        self.type = hook_type
 
 
553
        self.hook = hook_name
 
 
556
class UnsupportedProtocol(PathError):
 
 
558
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
 
560
    def __init__(self, url, extra):
 
 
561
        PathError.__init__(self, url, extra=extra)
 
 
564
class ReadError(PathError):
 
 
566
    _fmt = """Error reading from %(path)r."""
 
 
569
class ShortReadvError(PathError):
 
 
571
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
 
 
572
            ' at %(offset)s for "%(path)s"%(extra)s')
 
 
574
    internal_error = True
 
 
576
    def __init__(self, path, offset, length, actual, extra=None):
 
 
577
        PathError.__init__(self, path, extra=extra)
 
 
583
class PathNotChild(PathError):
 
 
585
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
 
587
    internal_error = True
 
 
589
    def __init__(self, path, base, extra=None):
 
 
590
        BzrError.__init__(self)
 
 
594
            self.extra = ': ' + str(extra)
 
 
599
class InvalidNormalization(PathError):
 
 
601
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
 
604
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
605
# the exception object is a bit undesirable.
 
 
606
# TODO: Probably this behavior of should be a common superclass 
 
 
607
class NotBranchError(PathError):
 
 
609
    _fmt = 'Not a branch: "%(path)s".'
 
 
611
    def __init__(self, path):
 
 
612
       import bzrlib.urlutils as urlutils
 
 
613
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
616
class NoSubmitBranch(PathError):
 
 
618
    _fmt = 'No submit branch available for branch "%(path)s"'
 
 
620
    def __init__(self, branch):
 
 
621
       import bzrlib.urlutils as urlutils
 
 
622
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
 
625
class AlreadyBranchError(PathError):
 
 
627
    _fmt = 'Already a branch: "%(path)s".'
 
 
630
class BranchExistsWithoutWorkingTree(PathError):
 
 
632
    _fmt = 'Directory contains a branch, but no working tree \
 
 
633
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
 
636
class AtomicFileAlreadyClosed(PathError):
 
 
638
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
 
641
    def __init__(self, path, function):
 
 
642
        PathError.__init__(self, path=path, extra=None)
 
 
643
        self.function = function
 
 
646
class InaccessibleParent(PathError):
 
 
648
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
 
649
            ' relative path "%(path)s"')
 
 
651
    def __init__(self, path, base):
 
 
652
        PathError.__init__(self, path)
 
 
656
class NoRepositoryPresent(BzrError):
 
 
658
    _fmt = 'No repository present: "%(path)s"'
 
 
659
    def __init__(self, bzrdir):
 
 
660
        BzrError.__init__(self)
 
 
661
        self.path = bzrdir.transport.clone('..').base
 
 
664
class FileInWrongBranch(BzrError):
 
 
666
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
 
668
    def __init__(self, branch, path):
 
 
669
        BzrError.__init__(self)
 
 
671
        self.branch_base = branch.base
 
 
675
class UnsupportedFormatError(BzrError):
 
 
677
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
 
 
680
class UnknownFormatError(BzrError):
 
 
682
    _fmt = "Unknown branch format: %(format)r"
 
 
685
class IncompatibleFormat(BzrError):
 
 
687
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
 
689
    def __init__(self, format, bzrdir_format):
 
 
690
        BzrError.__init__(self)
 
 
692
        self.bzrdir = bzrdir_format
 
 
695
class IncompatibleRepositories(BzrError):
 
 
697
    _fmt = "Repository %(target)s is not compatible with repository"\
 
 
700
    def __init__(self, source, target):
 
 
701
        BzrError.__init__(self, target=target, source=source)
 
 
704
class IncompatibleRevision(BzrError):
 
 
706
    _fmt = "Revision is not compatible with %(repo_format)s"
 
 
708
    def __init__(self, repo_format):
 
 
709
        BzrError.__init__(self)
 
 
710
        self.repo_format = repo_format
 
 
713
class AlreadyVersionedError(BzrError):
 
 
714
    """Used when a path is expected not to be versioned, but it is."""
 
 
716
    _fmt = "%(context_info)s%(path)s is already versioned."
 
 
718
    def __init__(self, path, context_info=None):
 
 
719
        """Construct a new AlreadyVersionedError.
 
 
721
        :param path: This is the path which is versioned,
 
 
722
        which should be in a user friendly form.
 
 
723
        :param context_info: If given, this is information about the context,
 
 
724
        which could explain why this is expected to not be versioned.
 
 
726
        BzrError.__init__(self)
 
 
728
        if context_info is None:
 
 
729
            self.context_info = ''
 
 
731
            self.context_info = context_info + ". "
 
 
734
class NotVersionedError(BzrError):
 
 
735
    """Used when a path is expected to be versioned, but it is not."""
 
 
737
    _fmt = "%(context_info)s%(path)s is not versioned."
 
 
739
    def __init__(self, path, context_info=None):
 
 
740
        """Construct a new NotVersionedError.
 
 
742
        :param path: This is the path which is not versioned,
 
 
743
        which should be in a user friendly form.
 
 
744
        :param context_info: If given, this is information about the context,
 
 
745
        which could explain why this is expected to be versioned.
 
 
747
        BzrError.__init__(self)
 
 
749
        if context_info is None:
 
 
750
            self.context_info = ''
 
 
752
            self.context_info = context_info + ". "
 
 
755
class PathsNotVersionedError(BzrError):
 
 
756
    """Used when reporting several paths which are not versioned"""
 
 
758
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
 
760
    def __init__(self, paths):
 
 
761
        from bzrlib.osutils import quotefn
 
 
762
        BzrError.__init__(self)
 
 
764
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
767
class PathsDoNotExist(BzrError):
 
 
769
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
 
771
    # used when reporting that paths are neither versioned nor in the working
 
 
774
    def __init__(self, paths, extra=None):
 
 
776
        from bzrlib.osutils import quotefn
 
 
777
        BzrError.__init__(self)
 
 
779
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
781
            self.extra = ': ' + str(extra)
 
 
786
class BadFileKindError(BzrError):
 
 
788
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
 
790
    def __init__(self, filename, kind):
 
 
791
        BzrError.__init__(self, filename=filename, kind=kind)
 
 
794
class ForbiddenControlFileError(BzrError):
 
 
796
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
 
799
class LockError(InternalBzrError):
 
 
801
    _fmt = "Lock error: %(msg)s"
 
 
803
    # All exceptions from the lock/unlock functions should be from
 
 
804
    # this exception class.  They will be translated as necessary. The
 
 
805
    # original exception is available as e.original_error
 
 
807
    # New code should prefer to raise specific subclasses
 
 
808
    def __init__(self, message):
 
 
809
        # Python 2.5 uses a slot for StandardError.message,
 
 
810
        # so use a different variable name.  We now work around this in
 
 
811
        # BzrError.__str__, but this member name is kept for compatability.
 
 
815
class LockActive(LockError):
 
 
817
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
 
819
    internal_error = False
 
 
821
    def __init__(self, lock_description):
 
 
822
        self.lock_description = lock_description
 
 
825
class CommitNotPossible(LockError):
 
 
827
    _fmt = "A commit was attempted but we do not have a write lock open."
 
 
833
class AlreadyCommitted(LockError):
 
 
835
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
 
841
class ReadOnlyError(LockError):
 
 
843
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
 
845
    # TODO: There should also be an error indicating that you need a write
 
 
846
    # lock and don't have any lock at all... mbp 20070226
 
 
848
    def __init__(self, obj):
 
 
852
class ReadOnlyLockError(LockError):
 
 
854
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
 
856
    @symbol_versioning.deprecated_method(symbol_versioning.zero_ninetytwo)
 
 
857
    def __init__(self, fname, msg):
 
 
858
        LockError.__init__(self, '')
 
 
863
class LockFailed(LockError):
 
 
865
    internal_error = False
 
 
867
    _fmt = "Cannot lock %(lock)s: %(why)s"
 
 
869
    def __init__(self, lock, why):
 
 
870
        LockError.__init__(self, '')
 
 
875
class OutSideTransaction(BzrError):
 
 
877
    _fmt = ("A transaction related operation was attempted after"
 
 
878
            " the transaction finished.")
 
 
881
class ObjectNotLocked(LockError):
 
 
883
    _fmt = "%(obj)r is not locked"
 
 
885
    # this can indicate that any particular object is not locked; see also
 
 
886
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
887
    # the caller -- perhaps they should be unified.
 
 
888
    def __init__(self, obj):
 
 
892
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
894
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
 
896
    def __init__(self, obj):
 
 
900
class UnlockableTransport(LockError):
 
 
902
    internal_error = False
 
 
904
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
 
906
    def __init__(self, transport):
 
 
907
        self.transport = transport
 
 
910
class LockContention(LockError):
 
 
912
    _fmt = 'Could not acquire lock "%(lock)s"'
 
 
913
    # TODO: show full url for lock, combining the transport and relative
 
 
916
    internal_error = False
 
 
918
    def __init__(self, lock):
 
 
922
class LockBroken(LockError):
 
 
924
    _fmt = ("Lock was broken while still open: %(lock)s"
 
 
925
            " - check storage consistency!")
 
 
927
    internal_error = False
 
 
929
    def __init__(self, lock):
 
 
933
class LockBreakMismatch(LockError):
 
 
935
    _fmt = ("Lock was released and re-acquired before being broken:"
 
 
936
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
 
938
    internal_error = False
 
 
940
    def __init__(self, lock, holder, target):
 
 
946
class LockNotHeld(LockError):
 
 
948
    _fmt = "Lock not held: %(lock)s"
 
 
950
    internal_error = False
 
 
952
    def __init__(self, lock):
 
 
956
class TokenLockingNotSupported(LockError):
 
 
958
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
 
960
    def __init__(self, obj):
 
 
964
class TokenMismatch(LockBroken):
 
 
966
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
 
968
    internal_error = True
 
 
970
    def __init__(self, given_token, lock_token):
 
 
971
        self.given_token = given_token
 
 
972
        self.lock_token = lock_token
 
 
975
class PointlessCommit(BzrError):
 
 
977
    _fmt = "No changes to commit"
 
 
980
class CannotCommitSelectedFileMerge(BzrError):
 
 
982
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
 
983
        ' files %(files_str)s'
 
 
985
    def __init__(self, files):
 
 
986
        files_str = ', '.join(files)
 
 
987
        BzrError.__init__(self, files=files, files_str=files_str)
 
 
990
class BadCommitMessageEncoding(BzrError):
 
 
992
    _fmt = 'The specified commit message contains characters unsupported by '\
 
 
993
        'the current encoding.'
 
 
996
class UpgradeReadonly(BzrError):
 
 
998
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
 
1001
class UpToDateFormat(BzrError):
 
 
1003
    _fmt = "The branch format %(format)s is already at the most recent format."
 
 
1005
    def __init__(self, format):
 
 
1006
        BzrError.__init__(self)
 
 
1007
        self.format = format
 
 
1010
class StrictCommitFailed(Exception):
 
 
1012
    _fmt = "Commit refused because there are unknowns in the tree."
 
 
1015
class NoSuchRevision(InternalBzrError):
 
 
1017
    _fmt = "%(branch)s has no revision %(revision)s"
 
 
1019
    def __init__(self, branch, revision):
 
 
1020
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
 
 
1021
        BzrError.__init__(self, branch=branch, revision=revision)
 
 
1024
# zero_ninetyone: this exception is no longer raised and should be removed
 
 
1025
class NotLeftParentDescendant(InternalBzrError):
 
 
1027
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
 
1028
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
 
1030
    def __init__(self, branch, old_revision, new_revision):
 
 
1031
        BzrError.__init__(self, branch_location=branch.base,
 
 
1032
                          old_revision=old_revision,
 
 
1033
                          new_revision=new_revision)
 
 
1036
class RangeInChangeOption(BzrError):
 
 
1038
    _fmt = "Option --change does not accept revision ranges"
 
 
1041
class NoSuchRevisionSpec(BzrError):
 
 
1043
    _fmt = "No namespace registered for string: %(spec)r"
 
 
1045
    def __init__(self, spec):
 
 
1046
        BzrError.__init__(self, spec=spec)
 
 
1049
class NoSuchRevisionInTree(NoSuchRevision):
 
 
1050
    """When using Tree.revision_tree, and the revision is not accessible."""
 
 
1052
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
 
1054
    def __init__(self, tree, revision_id):
 
 
1055
        BzrError.__init__(self)
 
 
1057
        self.revision_id = revision_id
 
 
1060
class InvalidRevisionSpec(BzrError):
 
 
1062
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
 
1063
            " %(branch)s%(extra)s")
 
 
1065
    def __init__(self, spec, branch, extra=None):
 
 
1066
        BzrError.__init__(self, branch=branch, spec=spec)
 
 
1068
            self.extra = '\n' + str(extra)
 
 
1073
class HistoryMissing(BzrError):
 
 
1075
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
 
1078
class AppendRevisionsOnlyViolation(BzrError):
 
 
1080
    _fmt = ('Operation denied because it would change the main history,'
 
 
1081
           ' which is not permitted by the append_revisions_only setting on'
 
 
1082
           ' branch "%(location)s".')
 
 
1084
    def __init__(self, location):
 
 
1085
       import bzrlib.urlutils as urlutils
 
 
1086
       location = urlutils.unescape_for_display(location, 'ascii')
 
 
1087
       BzrError.__init__(self, location=location)
 
 
1090
class DivergedBranches(BzrError):
 
 
1092
    _fmt = ("These branches have diverged."
 
 
1093
            " Use the merge command to reconcile them.")
 
 
1095
    def __init__(self, branch1, branch2):
 
 
1096
        self.branch1 = branch1
 
 
1097
        self.branch2 = branch2
 
 
1100
class NotLefthandHistory(InternalBzrError):
 
 
1102
    _fmt = "Supplied history does not follow left-hand parents"
 
 
1104
    def __init__(self, history):
 
 
1105
        BzrError.__init__(self, history=history)
 
 
1108
class UnrelatedBranches(BzrError):
 
 
1110
    _fmt = ("Branches have no common ancestor, and"
 
 
1111
            " no merge base revision was specified.")
 
 
1114
class CannotReverseCherrypick(BzrError):
 
 
1116
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
 
1120
class NoCommonAncestor(BzrError):
 
 
1122
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
1124
    def __init__(self, revision_a, revision_b):
 
 
1125
        self.revision_a = revision_a
 
 
1126
        self.revision_b = revision_b
 
 
1129
class NoCommonRoot(BzrError):
 
 
1131
    _fmt = ("Revisions are not derived from the same root: "
 
 
1132
           "%(revision_a)s %(revision_b)s.")
 
 
1134
    def __init__(self, revision_a, revision_b):
 
 
1135
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
 
1138
class NotAncestor(BzrError):
 
 
1140
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
 
1142
    def __init__(self, rev_id, not_ancestor_id):
 
 
1143
        BzrError.__init__(self, rev_id=rev_id,
 
 
1144
            not_ancestor_id=not_ancestor_id)
 
 
1147
class InstallFailed(BzrError):
 
 
1149
    def __init__(self, revisions):
 
 
1150
        revision_str = ", ".join(str(r) for r in revisions)
 
 
1151
        msg = "Could not install revisions:\n%s" % revision_str
 
 
1152
        BzrError.__init__(self, msg)
 
 
1153
        self.revisions = revisions
 
 
1156
class AmbiguousBase(BzrError):
 
 
1158
    def __init__(self, bases):
 
 
1159
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
1161
        msg = ("The correct base is unclear, because %s are all equally close"
 
 
1163
        BzrError.__init__(self, msg)
 
 
1167
class NoCommits(BzrError):
 
 
1169
    _fmt = "Branch %(branch)s has no commits."
 
 
1171
    def __init__(self, branch):
 
 
1172
        BzrError.__init__(self, branch=branch)
 
 
1175
class UnlistableStore(BzrError):
 
 
1177
    def __init__(self, store):
 
 
1178
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
1182
class UnlistableBranch(BzrError):
 
 
1184
    def __init__(self, br):
 
 
1185
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
1188
class BoundBranchOutOfDate(BzrError):
 
 
1190
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
 
1193
    def __init__(self, branch, master):
 
 
1194
        BzrError.__init__(self)
 
 
1195
        self.branch = branch
 
 
1196
        self.master = master
 
 
1199
class CommitToDoubleBoundBranch(BzrError):
 
 
1201
    _fmt = ("Cannot commit to branch %(branch)s."
 
 
1202
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
 
1204
    def __init__(self, branch, master, remote):
 
 
1205
        BzrError.__init__(self)
 
 
1206
        self.branch = branch
 
 
1207
        self.master = master
 
 
1208
        self.remote = remote
 
 
1211
class OverwriteBoundBranch(BzrError):
 
 
1213
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
 
1215
    def __init__(self, branch):
 
 
1216
        BzrError.__init__(self)
 
 
1217
        self.branch = branch
 
 
1220
class BoundBranchConnectionFailure(BzrError):
 
 
1222
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
 
1223
            " => %(target)s: %(error)s")
 
 
1225
    def __init__(self, branch, target, error):
 
 
1226
        BzrError.__init__(self)
 
 
1227
        self.branch = branch
 
 
1228
        self.target = target
 
 
1232
class WeaveError(BzrError):
 
 
1234
    _fmt = "Error in processing weave: %(message)s"
 
 
1236
    def __init__(self, message=None):
 
 
1237
        BzrError.__init__(self)
 
 
1238
        self.message = message
 
 
1241
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
1243
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
 
1245
    def __init__(self, revision_id, weave):
 
 
1247
        WeaveError.__init__(self)
 
 
1248
        self.revision_id = revision_id
 
 
1252
class WeaveRevisionNotPresent(WeaveError):
 
 
1254
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
 
1256
    def __init__(self, revision_id, weave):
 
 
1257
        WeaveError.__init__(self)
 
 
1258
        self.revision_id = revision_id
 
 
1262
class WeaveFormatError(WeaveError):
 
 
1264
    _fmt = "Weave invariant violated: %(what)s"
 
 
1266
    def __init__(self, what):
 
 
1267
        WeaveError.__init__(self)
 
 
1271
class WeaveParentMismatch(WeaveError):
 
 
1273
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
 
1276
class WeaveInvalidChecksum(WeaveError):
 
 
1278
    _fmt = "Text did not match it's checksum: %(message)s"
 
 
1281
class WeaveTextDiffers(WeaveError):
 
 
1283
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1284
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1286
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1287
        WeaveError.__init__(self)
 
 
1288
        self.revision_id = revision_id
 
 
1289
        self.weave_a = weave_a
 
 
1290
        self.weave_b = weave_b
 
 
1293
class WeaveTextDiffers(WeaveError):
 
 
1295
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1296
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1298
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1299
        WeaveError.__init__(self)
 
 
1300
        self.revision_id = revision_id
 
 
1301
        self.weave_a = weave_a
 
 
1302
        self.weave_b = weave_b
 
 
1305
class VersionedFileError(BzrError):
 
 
1307
    _fmt = "Versioned file error"
 
 
1310
class RevisionNotPresent(VersionedFileError):
 
 
1312
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
 
1314
    def __init__(self, revision_id, file_id):
 
 
1315
        VersionedFileError.__init__(self)
 
 
1316
        self.revision_id = revision_id
 
 
1317
        self.file_id = file_id
 
 
1320
class RevisionAlreadyPresent(VersionedFileError):
 
 
1322
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
 
1324
    def __init__(self, revision_id, file_id):
 
 
1325
        VersionedFileError.__init__(self)
 
 
1326
        self.revision_id = revision_id
 
 
1327
        self.file_id = file_id
 
 
1330
class VersionedFileInvalidChecksum(VersionedFileError):
 
 
1332
    _fmt = "Text did not match its checksum: %(message)s"
 
 
1335
class KnitError(InternalBzrError):
 
 
1340
class KnitCorrupt(KnitError):
 
 
1342
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
 
1344
    def __init__(self, filename, how):
 
 
1345
        KnitError.__init__(self)
 
 
1346
        self.filename = filename
 
 
1350
class KnitDataStreamIncompatible(KnitError):
 
 
1351
    # Not raised anymore, as we can convert data streams.  In future we may
 
 
1352
    # need it again for more exotic cases, so we're keeping it around for now.
 
 
1354
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
 
1356
    def __init__(self, stream_format, target_format):
 
 
1357
        self.stream_format = stream_format
 
 
1358
        self.target_format = target_format
 
 
1361
class KnitDataStreamUnknown(KnitError):
 
 
1362
    # Indicates a data stream we don't know how to handle.
 
 
1364
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
 
1366
    def __init__(self, stream_format):
 
 
1367
        self.stream_format = stream_format
 
 
1370
class KnitHeaderError(KnitError):
 
 
1372
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
 
1374
    def __init__(self, badline, filename):
 
 
1375
        KnitError.__init__(self)
 
 
1376
        self.badline = badline
 
 
1377
        self.filename = filename
 
 
1379
class KnitIndexUnknownMethod(KnitError):
 
 
1380
    """Raised when we don't understand the storage method.
 
 
1382
    Currently only 'fulltext' and 'line-delta' are supported.
 
 
1385
    _fmt = ("Knit index %(filename)s does not have a known method"
 
 
1386
            " in options: %(options)r")
 
 
1388
    def __init__(self, filename, options):
 
 
1389
        KnitError.__init__(self)
 
 
1390
        self.filename = filename
 
 
1391
        self.options = options
 
 
1394
class NoSuchExportFormat(BzrError):
 
 
1396
    _fmt = "Export format %(format)r not supported"
 
 
1398
    def __init__(self, format):
 
 
1399
        BzrError.__init__(self)
 
 
1400
        self.format = format
 
 
1403
class TransportError(BzrError):
 
 
1405
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
 
1407
    def __init__(self, msg=None, orig_error=None):
 
 
1408
        if msg is None and orig_error is not None:
 
 
1409
            msg = str(orig_error)
 
 
1410
        if orig_error is None:
 
 
1415
        self.orig_error = orig_error
 
 
1416
        BzrError.__init__(self)
 
 
1419
class TooManyConcurrentRequests(InternalBzrError):
 
 
1421
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
 
1422
            " Be sure to finish_writing and finish_reading on the"
 
 
1423
            " currently open request.")
 
 
1425
    def __init__(self, medium):
 
 
1426
        self.medium = medium
 
 
1429
class SmartProtocolError(TransportError):
 
 
1431
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
 
1433
    def __init__(self, details):
 
 
1434
        self.details = details
 
 
1437
# A set of semi-meaningful errors which can be thrown
 
 
1438
class TransportNotPossible(TransportError):
 
 
1440
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
 
1443
class ConnectionError(TransportError):
 
 
1445
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
 
1448
class SocketConnectionError(ConnectionError):
 
 
1450
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
 
1452
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
1454
            msg = 'Failed to connect to'
 
 
1455
        if orig_error is None:
 
 
1458
            orig_error = '; ' + str(orig_error)
 
 
1459
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
1464
            self.port = ':%s' % port
 
 
1467
class ConnectionReset(TransportError):
 
 
1469
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
 
1472
class InvalidRange(TransportError):
 
 
1474
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
 
1476
    def __init__(self, path, offset, msg=None):
 
 
1477
        TransportError.__init__(self, msg)
 
 
1479
        self.offset = offset
 
 
1482
class InvalidHttpResponse(TransportError):
 
 
1484
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
 
1486
    def __init__(self, path, msg, orig_error=None):
 
 
1488
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
1491
class InvalidHttpRange(InvalidHttpResponse):
 
 
1493
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
 
1495
    def __init__(self, path, range, msg):
 
 
1497
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1500
class InvalidHttpContentType(InvalidHttpResponse):
 
 
1502
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
 
1504
    def __init__(self, path, ctype, msg):
 
 
1506
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1509
class RedirectRequested(TransportError):
 
 
1511
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
 
1513
    def __init__(self, source, target, is_permanent=False, qual_proto=None):
 
 
1514
        self.source = source
 
 
1515
        self.target = target
 
 
1517
            self.permanently = ' permanently'
 
 
1519
            self.permanently = ''
 
 
1520
        self._qualified_proto = qual_proto
 
 
1521
        TransportError.__init__(self)
 
 
1523
    def _requalify_url(self, url):
 
 
1524
        """Restore the qualified proto in front of the url"""
 
 
1525
        # When this exception is raised, source and target are in
 
 
1526
        # user readable format. But some transports may use a
 
 
1527
        # different proto (http+urllib:// will present http:// to
 
 
1528
        # the user. If a qualified proto is specified, the code
 
 
1529
        # trapping the exception can get the qualified urls to
 
 
1530
        # properly handle the redirection themself (creating a
 
 
1531
        # new transport object from the target url for example).
 
 
1532
        # But checking that the scheme of the original and
 
 
1533
        # redirected urls are the same can be tricky. (see the
 
 
1534
        # FIXME in BzrDir.open_from_transport for the unique use
 
 
1536
        if self._qualified_proto is None:
 
 
1539
        # The TODO related to NotBranchError mention that doing
 
 
1540
        # that kind of manipulation on the urls may not be the
 
 
1541
        # exception object job. On the other hand, this object is
 
 
1542
        # the interface between the code and the user so
 
 
1543
        # presenting the urls in different ways is indeed its
 
 
1546
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
 
1547
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
 
1550
    def get_source_url(self):
 
 
1551
        return self._requalify_url(self.source)
 
 
1553
    def get_target_url(self):
 
 
1554
        return self._requalify_url(self.target)
 
 
1557
class TooManyRedirections(TransportError):
 
 
1559
    _fmt = "Too many redirections"
 
 
1562
class ConflictsInTree(BzrError):
 
 
1564
    _fmt = "Working tree has conflicts."
 
 
1567
class ParseConfigError(BzrError):
 
 
1569
    def __init__(self, errors, filename):
 
 
1570
        if filename is None:
 
 
1572
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
1573
            (filename, ('\n'.join(e.message for e in errors)))
 
 
1574
        BzrError.__init__(self, message)
 
 
1577
class NoEmailInUsername(BzrError):
 
 
1579
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
 
1581
    def __init__(self, username):
 
 
1582
        BzrError.__init__(self)
 
 
1583
        self.username = username
 
 
1586
class SigningFailed(BzrError):
 
 
1588
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
 
1590
    def __init__(self, command_line):
 
 
1591
        BzrError.__init__(self, command_line=command_line)
 
 
1594
class WorkingTreeNotRevision(BzrError):
 
 
1596
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
 
1597
            " the last commit, but weave merge requires that it be"
 
 
1600
    def __init__(self, tree):
 
 
1601
        BzrError.__init__(self, basedir=tree.basedir)
 
 
1604
class CantReprocessAndShowBase(BzrError):
 
 
1606
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
 
1607
           "the relationship of conflicting lines to the base")
 
 
1610
class GraphCycleError(BzrError):
 
 
1612
    _fmt = "Cycle in graph %(graph)r"
 
 
1614
    def __init__(self, graph):
 
 
1615
        BzrError.__init__(self)
 
 
1619
class WritingCompleted(InternalBzrError):
 
 
1621
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
 
1622
            "called upon it - accept bytes may not be called anymore.")
 
 
1624
    def __init__(self, request):
 
 
1625
        self.request = request
 
 
1628
class WritingNotComplete(InternalBzrError):
 
 
1630
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
 
1631
            "called upon it - until the write phase is complete no "
 
 
1632
            "data may be read.")
 
 
1634
    def __init__(self, request):
 
 
1635
        self.request = request
 
 
1638
class NotConflicted(BzrError):
 
 
1640
    _fmt = "File %(filename)s is not conflicted."
 
 
1642
    def __init__(self, filename):
 
 
1643
        BzrError.__init__(self)
 
 
1644
        self.filename = filename
 
 
1647
class MediumNotConnected(InternalBzrError):
 
 
1649
    _fmt = """The medium '%(medium)s' is not connected."""
 
 
1651
    def __init__(self, medium):
 
 
1652
        self.medium = medium
 
 
1655
class MustUseDecorated(Exception):
 
 
1657
    _fmt = "A decorating function has requested its original command be used."
 
 
1660
class NoBundleFound(BzrError):
 
 
1662
    _fmt = 'No bundle was found in "%(filename)s".'
 
 
1664
    def __init__(self, filename):
 
 
1665
        BzrError.__init__(self)
 
 
1666
        self.filename = filename
 
 
1669
class BundleNotSupported(BzrError):
 
 
1671
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
 
1673
    def __init__(self, version, msg):
 
 
1674
        BzrError.__init__(self)
 
 
1675
        self.version = version
 
 
1679
class MissingText(BzrError):
 
 
1681
    _fmt = ("Branch %(base)s is missing revision"
 
 
1682
            " %(text_revision)s of %(file_id)s")
 
 
1684
    def __init__(self, branch, text_revision, file_id):
 
 
1685
        BzrError.__init__(self)
 
 
1686
        self.branch = branch
 
 
1687
        self.base = branch.base
 
 
1688
        self.text_revision = text_revision
 
 
1689
        self.file_id = file_id
 
 
1692
class DuplicateFileId(BzrError):
 
 
1694
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
 
1696
    def __init__(self, file_id, entry):
 
 
1697
        BzrError.__init__(self)
 
 
1698
        self.file_id = file_id
 
 
1702
class DuplicateKey(BzrError):
 
 
1704
    _fmt = "Key %(key)s is already present in map"
 
 
1707
class DuplicateHelpPrefix(BzrError):
 
 
1709
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
 
1711
    def __init__(self, prefix):
 
 
1712
        self.prefix = prefix
 
 
1715
class MalformedTransform(BzrError):
 
 
1717
    _fmt = "Tree transform is malformed %(conflicts)r"
 
 
1720
class NoFinalPath(BzrError):
 
 
1722
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
 
1723
            "file-id: %(file_id)r\n"
 
 
1724
            "root trans-id: %(root_trans_id)r\n")
 
 
1726
    def __init__(self, trans_id, transform):
 
 
1727
        self.trans_id = trans_id
 
 
1728
        self.file_id = transform.final_file_id(trans_id)
 
 
1729
        self.root_trans_id = transform.root
 
 
1732
class BzrBadParameter(InternalBzrError):
 
 
1734
    _fmt = "Bad parameter: %(param)r"
 
 
1736
    # This exception should never be thrown, but it is a base class for all
 
 
1737
    # parameter-to-function errors.
 
 
1739
    def __init__(self, param):
 
 
1740
        BzrError.__init__(self)
 
 
1744
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1746
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
 
1749
class ReusingTransform(BzrError):
 
 
1751
    _fmt = "Attempt to reuse a transform that has already been applied."
 
 
1754
class CantMoveRoot(BzrError):
 
 
1756
    _fmt = "Moving the root directory is not supported at this time"
 
 
1759
class BzrMoveFailedError(BzrError):
 
 
1761
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1763
    def __init__(self, from_path='', to_path='', extra=None):
 
 
1764
        BzrError.__init__(self)
 
 
1766
            self.extra = ': ' + str(extra)
 
 
1770
        has_from = len(from_path) > 0
 
 
1771
        has_to = len(to_path) > 0
 
 
1773
            self.from_path = osutils.splitpath(from_path)[-1]
 
 
1778
            self.to_path = osutils.splitpath(to_path)[-1]
 
 
1783
        if has_from and has_to:
 
 
1784
            self.operator = " =>"
 
 
1786
            self.from_path = "from " + from_path
 
 
1788
            self.operator = "to"
 
 
1790
            self.operator = "file"
 
 
1793
class BzrRenameFailedError(BzrMoveFailedError):
 
 
1795
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1797
    def __init__(self, from_path, to_path, extra=None):
 
 
1798
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
 
1800
class BzrRemoveChangedFilesError(BzrError):
 
 
1801
    """Used when user is trying to remove changed files."""
 
 
1803
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
 
1804
        "%(changes_as_text)s"
 
 
1805
        "Use --keep to not delete them, or --force to delete them regardless.")
 
 
1807
    def __init__(self, tree_delta):
 
 
1808
        BzrError.__init__(self)
 
 
1809
        self.changes_as_text = tree_delta.get_changes_as_text()
 
 
1810
        #self.paths_as_string = '\n'.join(changed_files)
 
 
1811
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
 
1814
class BzrBadParameterNotString(BzrBadParameter):
 
 
1816
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
 
1819
class BzrBadParameterMissing(BzrBadParameter):
 
 
1821
    _fmt = "Parameter $(param)s is required but not present."
 
 
1824
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1826
    _fmt = ("Parameter %(param)s is unicode but"
 
 
1827
            " only byte-strings are permitted.")
 
 
1830
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1832
    _fmt = "Parameter %(param)s contains a newline."
 
 
1835
class DependencyNotPresent(BzrError):
 
 
1837
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
 
1839
    def __init__(self, library, error):
 
 
1840
        BzrError.__init__(self, library=library, error=error)
 
 
1843
class ParamikoNotPresent(DependencyNotPresent):
 
 
1845
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
 
1847
    def __init__(self, error):
 
 
1848
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1851
class PointlessMerge(BzrError):
 
 
1853
    _fmt = "Nothing to merge."
 
 
1856
class UninitializableFormat(BzrError):
 
 
1858
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
 
1860
    def __init__(self, format):
 
 
1861
        BzrError.__init__(self)
 
 
1862
        self.format = format
 
 
1865
class BadConversionTarget(BzrError):
 
 
1867
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
 
1869
    def __init__(self, problem, format):
 
 
1870
        BzrError.__init__(self)
 
 
1871
        self.problem = problem
 
 
1872
        self.format = format
 
 
1875
class NoDiffFound(BzrError):
 
 
1877
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
 
1879
    def __init__(self, path):
 
 
1880
        BzrError.__init__(self, path)
 
 
1883
class ExecutableMissing(BzrError):
 
 
1885
    _fmt = "%(exe_name)s could not be found on this machine"
 
 
1887
    def __init__(self, exe_name):
 
 
1888
        BzrError.__init__(self, exe_name=exe_name)
 
 
1891
class NoDiff(BzrError):
 
 
1893
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
 
1895
    def __init__(self, msg):
 
 
1896
        BzrError.__init__(self, msg=msg)
 
 
1899
class NoDiff3(BzrError):
 
 
1901
    _fmt = "Diff3 is not installed on this machine."
 
 
1904
class ExistingContent(BzrError):
 
 
1905
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
 
1907
    _fmt = "The content being inserted is already present."
 
 
1910
class ExistingLimbo(BzrError):
 
 
1912
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1913
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1914
    keep, and delete it when you are done."""
 
 
1916
    def __init__(self, limbo_dir):
 
 
1917
       BzrError.__init__(self)
 
 
1918
       self.limbo_dir = limbo_dir
 
 
1921
class ExistingPendingDeletion(BzrError):
 
 
1923
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1924
    Please examine %(pending_deletion)s to see if it contains any files you
 
 
1925
    wish to keep, and delete it when you are done."""
 
 
1927
    def __init__(self, pending_deletion):
 
 
1928
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
 
1931
class ImmortalLimbo(BzrError):
 
 
1933
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
 
1934
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1935
    keep, and delete it when you are done."""
 
 
1937
    def __init__(self, limbo_dir):
 
 
1938
       BzrError.__init__(self)
 
 
1939
       self.limbo_dir = limbo_dir
 
 
1942
class ImmortalPendingDeletion(BzrError):
 
 
1944
    _fmt = ("Unable to delete transform temporary directory "
 
 
1945
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
 
1946
    "contains any files you wish to keep, and delete it when you are done.")
 
 
1948
    def __init__(self, pending_deletion):
 
 
1949
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
 
1952
class OutOfDateTree(BzrError):
 
 
1954
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
 
1956
    def __init__(self, tree):
 
 
1957
        BzrError.__init__(self)
 
 
1961
class PublicBranchOutOfDate(BzrError):
 
 
1963
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
 
1966
    def __init__(self, public_location, revstring):
 
 
1967
        import bzrlib.urlutils as urlutils
 
 
1968
        public_location = urlutils.unescape_for_display(public_location,
 
 
1970
        BzrError.__init__(self, public_location=public_location,
 
 
1971
                          revstring=revstring)
 
 
1974
class MergeModifiedFormatError(BzrError):
 
 
1976
    _fmt = "Error in merge modified format"
 
 
1979
class ConflictFormatError(BzrError):
 
 
1981
    _fmt = "Format error in conflict listings"
 
 
1984
class CorruptRepository(BzrError):
 
 
1986
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
 
1987
            "Please run bzr reconcile on this repository.")
 
 
1989
    def __init__(self, repo):
 
 
1990
        BzrError.__init__(self)
 
 
1991
        self.repo_path = repo.bzrdir.root_transport.base
 
 
1994
class UpgradeRequired(BzrError):
 
 
1996
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
 
1998
    def __init__(self, path):
 
 
1999
        BzrError.__init__(self)
 
 
2003
class LocalRequiresBoundBranch(BzrError):
 
 
2005
    _fmt = "Cannot perform local-only commits on unbound branches."
 
 
2008
class MissingProgressBarFinish(BzrError):
 
 
2010
    _fmt = "A nested progress bar was not 'finished' correctly."
 
 
2013
class InvalidProgressBarType(BzrError):
 
 
2015
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
 
2016
            " is not a supported type Select one of: %(valid_types)s")
 
 
2018
    def __init__(self, bar_type, valid_types):
 
 
2019
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
2022
class UnsupportedOperation(BzrError):
 
 
2024
    _fmt = ("The method %(mname)s is not supported on"
 
 
2025
            " objects of type %(tname)s.")
 
 
2027
    def __init__(self, method, method_self):
 
 
2028
        self.method = method
 
 
2029
        self.mname = method.__name__
 
 
2030
        self.tname = type(method_self).__name__
 
 
2033
class CannotSetRevisionId(UnsupportedOperation):
 
 
2034
    """Raised when a commit is attempting to set a revision id but cant."""
 
 
2037
class NonAsciiRevisionId(UnsupportedOperation):
 
 
2038
    """Raised when a commit is attempting to set a non-ascii revision id
 
 
2043
class BinaryFile(BzrError):
 
 
2045
    _fmt = "File is binary but should be text."
 
 
2048
class IllegalPath(BzrError):
 
 
2050
    _fmt = "The path %(path)s is not permitted on this platform"
 
 
2052
    def __init__(self, path):
 
 
2053
        BzrError.__init__(self)
 
 
2057
class TestamentMismatch(BzrError):
 
 
2059
    _fmt = """Testament did not match expected value.
 
 
2060
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
 
2063
    def __init__(self, revision_id, expected, measured):
 
 
2064
        self.revision_id = revision_id
 
 
2065
        self.expected = expected
 
 
2066
        self.measured = measured
 
 
2069
class NotABundle(BzrError):
 
 
2071
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
 
2073
    def __init__(self, text):
 
 
2074
        BzrError.__init__(self)
 
 
2078
class BadBundle(BzrError): 
 
 
2080
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
 
2082
    def __init__(self, text):
 
 
2083
        BzrError.__init__(self)
 
 
2087
class MalformedHeader(BadBundle): 
 
 
2089
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
 
2092
class MalformedPatches(BadBundle): 
 
 
2094
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
 
2097
class MalformedFooter(BadBundle): 
 
 
2099
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
 
2102
class UnsupportedEOLMarker(BadBundle):
 
 
2104
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
 
2107
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
 
2108
        # but for this there is not
 
 
2109
        BzrError.__init__(self)
 
 
2112
class IncompatibleBundleFormat(BzrError):
 
 
2114
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
 
2116
    def __init__(self, bundle_format, other):
 
 
2117
        BzrError.__init__(self)
 
 
2118
        self.bundle_format = bundle_format
 
 
2122
class BadInventoryFormat(BzrError):
 
 
2124
    _fmt = "Root class for inventory serialization errors"
 
 
2127
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
2129
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
 
2131
    def __init__(self, msg):
 
 
2132
        BadInventoryFormat.__init__(self, msg=msg)
 
 
2135
class RootNotRich(BzrError):
 
 
2137
    _fmt = """This operation requires rich root data storage"""
 
 
2140
class NoSmartMedium(InternalBzrError):
 
 
2142
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
 
2144
    def __init__(self, transport):
 
 
2145
        self.transport = transport
 
 
2148
class NoSmartServer(NotBranchError):
 
 
2150
    _fmt = "No smart server available at %(url)s"
 
 
2152
    def __init__(self, url):
 
 
2156
class UnknownSSH(BzrError):
 
 
2158
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
 
2160
    def __init__(self, vendor):
 
 
2161
        BzrError.__init__(self)
 
 
2162
        self.vendor = vendor
 
 
2165
class SSHVendorNotFound(BzrError):
 
 
2167
    _fmt = ("Don't know how to handle SSH connections."
 
 
2168
            " Please set BZR_SSH environment variable.")
 
 
2171
class GhostRevisionUnusableHere(BzrError):
 
 
2173
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
 
2175
    def __init__(self, revision_id):
 
 
2176
        BzrError.__init__(self)
 
 
2177
        self.revision_id = revision_id
 
 
2180
class IllegalUseOfScopeReplacer(InternalBzrError):
 
 
2182
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
 
2183
            " %(msg)s%(extra)s")
 
 
2185
    def __init__(self, name, msg, extra=None):
 
 
2186
        BzrError.__init__(self)
 
 
2190
            self.extra = ': ' + str(extra)
 
 
2195
class InvalidImportLine(InternalBzrError):
 
 
2197
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
 
2199
    def __init__(self, text, msg):
 
 
2200
        BzrError.__init__(self)
 
 
2205
class ImportNameCollision(InternalBzrError):
 
 
2207
    _fmt = ("Tried to import an object to the same name as"
 
 
2208
            " an existing object. %(name)s")
 
 
2210
    def __init__(self, name):
 
 
2211
        BzrError.__init__(self)
 
 
2215
class NotAMergeDirective(BzrError):
 
 
2216
    """File starting with %(firstline)r is not a merge directive"""
 
 
2217
    def __init__(self, firstline):
 
 
2218
        BzrError.__init__(self, firstline=firstline)
 
 
2221
class NoMergeSource(BzrError):
 
 
2222
    """Raise if no merge source was specified for a merge directive"""
 
 
2224
    _fmt = "A merge directive must provide either a bundle or a public"\
 
 
2228
class IllegalMergeDirectivePayload(BzrError):
 
 
2229
    """A merge directive contained something other than a patch or bundle"""
 
 
2231
    _fmt = "Bad merge directive payload %(start)r"
 
 
2233
    def __init__(self, start):
 
 
2238
class PatchVerificationFailed(BzrError):
 
 
2239
    """A patch from a merge directive could not be verified"""
 
 
2241
    _fmt = "Preview patch does not match requested changes."
 
 
2244
class PatchMissing(BzrError):
 
 
2245
    """Raise a patch type was specified but no patch supplied"""
 
 
2247
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
 
2249
    def __init__(self, patch_type):
 
 
2250
        BzrError.__init__(self)
 
 
2251
        self.patch_type = patch_type
 
 
2254
class UnsupportedInventoryKind(BzrError):
 
 
2256
    _fmt = """Unsupported entry kind %(kind)s"""
 
 
2258
    def __init__(self, kind):
 
 
2262
class BadSubsumeSource(BzrError):
 
 
2264
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
 
2266
    def __init__(self, tree, other_tree, reason):
 
 
2268
        self.other_tree = other_tree
 
 
2269
        self.reason = reason
 
 
2272
class SubsumeTargetNeedsUpgrade(BzrError):
 
 
2274
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
 
2276
    def __init__(self, other_tree):
 
 
2277
        self.other_tree = other_tree
 
 
2280
class BadReferenceTarget(InternalBzrError):
 
 
2282
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
 
2285
    def __init__(self, tree, other_tree, reason):
 
 
2287
        self.other_tree = other_tree
 
 
2288
        self.reason = reason
 
 
2291
class NoSuchTag(BzrError):
 
 
2293
    _fmt = "No such tag: %(tag_name)s"
 
 
2295
    def __init__(self, tag_name):
 
 
2296
        self.tag_name = tag_name
 
 
2299
class TagsNotSupported(BzrError):
 
 
2301
    _fmt = ("Tags not supported by %(branch)s;"
 
 
2302
            " you may be able to use bzr upgrade --dirstate-tags.")
 
 
2304
    def __init__(self, branch):
 
 
2305
        self.branch = branch
 
 
2308
class TagAlreadyExists(BzrError):
 
 
2310
    _fmt = "Tag %(tag_name)s already exists."
 
 
2312
    def __init__(self, tag_name):
 
 
2313
        self.tag_name = tag_name
 
 
2316
class MalformedBugIdentifier(BzrError):
 
 
2318
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
 
2320
    def __init__(self, bug_id, reason):
 
 
2321
        self.bug_id = bug_id
 
 
2322
        self.reason = reason
 
 
2325
class InvalidBugTrackerURL(BzrError):
 
 
2327
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
 
2328
            "contain {id}: %(url)s")
 
 
2330
    def __init__(self, abbreviation, url):
 
 
2331
        self.abbreviation = abbreviation
 
 
2335
class UnknownBugTrackerAbbreviation(BzrError):
 
 
2337
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
 
2340
    def __init__(self, abbreviation, branch):
 
 
2341
        self.abbreviation = abbreviation
 
 
2342
        self.branch = branch
 
 
2345
class UnexpectedSmartServerResponse(BzrError):
 
 
2347
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
 
2349
    def __init__(self, response_tuple):
 
 
2350
        self.response_tuple = response_tuple
 
 
2353
class ContainerError(BzrError):
 
 
2354
    """Base class of container errors."""
 
 
2357
class UnknownContainerFormatError(ContainerError):
 
 
2359
    _fmt = "Unrecognised container format: %(container_format)r"
 
 
2361
    def __init__(self, container_format):
 
 
2362
        self.container_format = container_format
 
 
2365
class UnexpectedEndOfContainerError(ContainerError):
 
 
2367
    _fmt = "Unexpected end of container stream"
 
 
2370
class UnknownRecordTypeError(ContainerError):
 
 
2372
    _fmt = "Unknown record type: %(record_type)r"
 
 
2374
    def __init__(self, record_type):
 
 
2375
        self.record_type = record_type
 
 
2378
class InvalidRecordError(ContainerError):
 
 
2380
    _fmt = "Invalid record: %(reason)s"
 
 
2382
    def __init__(self, reason):
 
 
2383
        self.reason = reason
 
 
2386
class ContainerHasExcessDataError(ContainerError):
 
 
2388
    _fmt = "Container has data after end marker: %(excess)r"
 
 
2390
    def __init__(self, excess):
 
 
2391
        self.excess = excess
 
 
2394
class DuplicateRecordNameError(ContainerError):
 
 
2396
    _fmt = "Container has multiple records with the same name: %(name)s"
 
 
2398
    def __init__(self, name):
 
 
2402
class NoDestinationAddress(InternalBzrError):
 
 
2404
    _fmt = "Message does not have a destination address."
 
 
2407
class RepositoryDataStreamError(BzrError):
 
 
2409
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
 
2411
    def __init__(self, reason):
 
 
2412
        self.reason = reason
 
 
2415
class SMTPError(BzrError):
 
 
2417
    _fmt = "SMTP error: %(error)s"
 
 
2419
    def __init__(self, error):
 
 
2423
class NoMessageSupplied(BzrError):
 
 
2425
    _fmt = "No message supplied."
 
 
2428
class NoMailAddressSpecified(BzrError):
 
 
2430
    _fmt = "No mail-to address specified."
 
 
2433
class UnknownMailClient(BzrError):
 
 
2435
    _fmt = "Unknown mail client: %(mail_client)s"
 
 
2437
    def __init__(self, mail_client):
 
 
2438
        BzrError.__init__(self, mail_client=mail_client)
 
 
2441
class MailClientNotFound(BzrError):
 
 
2443
    _fmt = "Unable to find mail client with the following names:"\
 
 
2444
        " %(mail_command_list_string)s"
 
 
2446
    def __init__(self, mail_command_list):
 
 
2447
        mail_command_list_string = ', '.join(mail_command_list)
 
 
2448
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
 
2449
                          mail_command_list_string=mail_command_list_string)
 
 
2451
class SMTPConnectionRefused(SMTPError):
 
 
2453
    _fmt = "SMTP connection to %(host)s refused"
 
 
2455
    def __init__(self, error, host):
 
 
2460
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
 
2462
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
 
2465
class BzrDirError(BzrError):
 
 
2467
    def __init__(self, bzrdir):
 
 
2468
        import bzrlib.urlutils as urlutils
 
 
2469
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
 
2471
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
 
2474
class AlreadyBranch(BzrDirError):
 
 
2476
    _fmt = "'%(display_url)s' is already a branch."
 
 
2479
class AlreadyTree(BzrDirError):
 
 
2481
    _fmt = "'%(display_url)s' is already a tree."
 
 
2484
class AlreadyCheckout(BzrDirError):
 
 
2486
    _fmt = "'%(display_url)s' is already a checkout."
 
 
2489
class AlreadyLightweightCheckout(BzrDirError):
 
 
2491
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
 
2494
class ReconfigurationNotSupported(BzrDirError):
 
 
2496
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
 
2499
class NoBindLocation(BzrDirError):
 
 
2501
    _fmt = "No location could be found to bind to at %(display_url)s."
 
 
2504
class UncommittedChanges(BzrError):
 
 
2506
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
 
 
2508
    def __init__(self, tree):
 
 
2509
        import bzrlib.urlutils as urlutils
 
 
2510
        display_url = urlutils.unescape_for_display(
 
 
2511
            tree.bzrdir.root_transport.base, 'ascii')
 
 
2512
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
 
2515
class MissingTemplateVariable(BzrError):
 
 
2517
    _fmt = 'Variable {%(name)s} is not available.'
 
 
2519
    def __init__(self, name):
 
 
2523
class UnableCreateSymlink(BzrError):
 
 
2525
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
 
2527
    def __init__(self, path=None):
 
 
2531
                path_str = repr(str(path))
 
 
2532
            except UnicodeEncodeError:
 
 
2533
                path_str = repr(path)
 
 
2535
        self.path_str = path_str
 
 
2538
class UnsupportedTimezoneFormat(BzrError):
 
 
2540
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
 
2541
            'options are "utc", "original", "local".')
 
 
2543
    def __init__(self, timezone):
 
 
2544
        self.timezone = timezone