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 UnavailableRepresentation(InternalBzrError):
 
 
567
    _fmt = ("The encoding '%(wanted)s' is not available for key %(key)s which "
 
 
568
        "is encoded as '%(native)s'.")
 
 
570
    def __init__(self, key, wanted, native):
 
 
571
        InternalBzrError.__init__(self)
 
 
577
class UnknownHook(BzrError):
 
 
579
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
 
581
    def __init__(self, hook_type, hook_name):
 
 
582
        BzrError.__init__(self)
 
 
583
        self.type = hook_type
 
 
584
        self.hook = hook_name
 
 
587
class UnsupportedProtocol(PathError):
 
 
589
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
 
591
    def __init__(self, url, extra):
 
 
592
        PathError.__init__(self, url, extra=extra)
 
 
595
class UnstackableBranchFormat(BzrError):
 
 
597
    _fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
 
 
598
        "You will need to upgrade the branch to permit branch stacking.")
 
 
600
    def __init__(self, format, url):
 
 
601
        BzrError.__init__(self)
 
 
606
class UnstackableRepositoryFormat(BzrError):
 
 
608
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
 
 
609
        "You will need to upgrade the repository to permit branch stacking.")
 
 
611
    def __init__(self, format, url):
 
 
612
        BzrError.__init__(self)
 
 
617
class ReadError(PathError):
 
 
619
    _fmt = """Error reading from %(path)r."""
 
 
622
class ShortReadvError(PathError):
 
 
624
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
 
 
625
            ' at %(offset)s for "%(path)s"%(extra)s')
 
 
627
    internal_error = True
 
 
629
    def __init__(self, path, offset, length, actual, extra=None):
 
 
630
        PathError.__init__(self, path, extra=extra)
 
 
636
class PathNotChild(PathError):
 
 
638
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
 
640
    internal_error = True
 
 
642
    def __init__(self, path, base, extra=None):
 
 
643
        BzrError.__init__(self)
 
 
647
            self.extra = ': ' + str(extra)
 
 
652
class InvalidNormalization(PathError):
 
 
654
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
 
657
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
658
# the exception object is a bit undesirable.
 
 
659
# TODO: Probably this behavior of should be a common superclass 
 
 
660
class NotBranchError(PathError):
 
 
662
    _fmt = 'Not a branch: "%(path)s".'
 
 
664
    def __init__(self, path):
 
 
665
       import bzrlib.urlutils as urlutils
 
 
666
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
669
class NoSubmitBranch(PathError):
 
 
671
    _fmt = 'No submit branch available for branch "%(path)s"'
 
 
673
    def __init__(self, branch):
 
 
674
       import bzrlib.urlutils as urlutils
 
 
675
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
 
678
class AlreadyBranchError(PathError):
 
 
680
    _fmt = 'Already a branch: "%(path)s".'
 
 
683
class BranchExistsWithoutWorkingTree(PathError):
 
 
685
    _fmt = 'Directory contains a branch, but no working tree \
 
 
686
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
 
689
class AtomicFileAlreadyClosed(PathError):
 
 
691
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
 
694
    def __init__(self, path, function):
 
 
695
        PathError.__init__(self, path=path, extra=None)
 
 
696
        self.function = function
 
 
699
class InaccessibleParent(PathError):
 
 
701
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
 
702
            ' relative path "%(path)s"')
 
 
704
    def __init__(self, path, base):
 
 
705
        PathError.__init__(self, path)
 
 
709
class NoRepositoryPresent(BzrError):
 
 
711
    _fmt = 'No repository present: "%(path)s"'
 
 
712
    def __init__(self, bzrdir):
 
 
713
        BzrError.__init__(self)
 
 
714
        self.path = bzrdir.transport.clone('..').base
 
 
717
class FileInWrongBranch(BzrError):
 
 
719
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
 
721
    def __init__(self, branch, path):
 
 
722
        BzrError.__init__(self)
 
 
724
        self.branch_base = branch.base
 
 
728
class UnsupportedFormatError(BzrError):
 
 
730
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
 
 
733
class UnknownFormatError(BzrError):
 
 
735
    _fmt = "Unknown %(kind)s format: %(format)r"
 
 
737
    def __init__(self, format, kind='branch'):
 
 
742
class IncompatibleFormat(BzrError):
 
 
744
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
 
746
    def __init__(self, format, bzrdir_format):
 
 
747
        BzrError.__init__(self)
 
 
749
        self.bzrdir = bzrdir_format
 
 
752
class IncompatibleRepositories(BzrError):
 
 
754
    _fmt = "Repository %(target)s is not compatible with repository"\
 
 
757
    def __init__(self, source, target):
 
 
758
        BzrError.__init__(self, target=target, source=source)
 
 
761
class IncompatibleRevision(BzrError):
 
 
763
    _fmt = "Revision is not compatible with %(repo_format)s"
 
 
765
    def __init__(self, repo_format):
 
 
766
        BzrError.__init__(self)
 
 
767
        self.repo_format = repo_format
 
 
770
class AlreadyVersionedError(BzrError):
 
 
771
    """Used when a path is expected not to be versioned, but it is."""
 
 
773
    _fmt = "%(context_info)s%(path)s is already versioned."
 
 
775
    def __init__(self, path, context_info=None):
 
 
776
        """Construct a new AlreadyVersionedError.
 
 
778
        :param path: This is the path which is versioned,
 
 
779
        which should be in a user friendly form.
 
 
780
        :param context_info: If given, this is information about the context,
 
 
781
        which could explain why this is expected to not be versioned.
 
 
783
        BzrError.__init__(self)
 
 
785
        if context_info is None:
 
 
786
            self.context_info = ''
 
 
788
            self.context_info = context_info + ". "
 
 
791
class NotVersionedError(BzrError):
 
 
792
    """Used when a path is expected to be versioned, but it is not."""
 
 
794
    _fmt = "%(context_info)s%(path)s is not versioned."
 
 
796
    def __init__(self, path, context_info=None):
 
 
797
        """Construct a new NotVersionedError.
 
 
799
        :param path: This is the path which is not versioned,
 
 
800
        which should be in a user friendly form.
 
 
801
        :param context_info: If given, this is information about the context,
 
 
802
        which could explain why this is expected to be versioned.
 
 
804
        BzrError.__init__(self)
 
 
806
        if context_info is None:
 
 
807
            self.context_info = ''
 
 
809
            self.context_info = context_info + ". "
 
 
812
class PathsNotVersionedError(BzrError):
 
 
813
    """Used when reporting several paths which are not versioned"""
 
 
815
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
 
817
    def __init__(self, paths):
 
 
818
        from bzrlib.osutils import quotefn
 
 
819
        BzrError.__init__(self)
 
 
821
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
824
class PathsDoNotExist(BzrError):
 
 
826
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
 
828
    # used when reporting that paths are neither versioned nor in the working
 
 
831
    def __init__(self, paths, extra=None):
 
 
833
        from bzrlib.osutils import quotefn
 
 
834
        BzrError.__init__(self)
 
 
836
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
838
            self.extra = ': ' + str(extra)
 
 
843
class BadFileKindError(BzrError):
 
 
845
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
 
847
    def __init__(self, filename, kind):
 
 
848
        BzrError.__init__(self, filename=filename, kind=kind)
 
 
851
class ForbiddenControlFileError(BzrError):
 
 
853
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
 
856
class LockError(InternalBzrError):
 
 
858
    _fmt = "Lock error: %(msg)s"
 
 
860
    # All exceptions from the lock/unlock functions should be from
 
 
861
    # this exception class.  They will be translated as necessary. The
 
 
862
    # original exception is available as e.original_error
 
 
864
    # New code should prefer to raise specific subclasses
 
 
865
    def __init__(self, message):
 
 
866
        # Python 2.5 uses a slot for StandardError.message,
 
 
867
        # so use a different variable name.  We now work around this in
 
 
868
        # BzrError.__str__, but this member name is kept for compatability.
 
 
872
class LockActive(LockError):
 
 
874
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
 
876
    internal_error = False
 
 
878
    def __init__(self, lock_description):
 
 
879
        self.lock_description = lock_description
 
 
882
class CommitNotPossible(LockError):
 
 
884
    _fmt = "A commit was attempted but we do not have a write lock open."
 
 
890
class AlreadyCommitted(LockError):
 
 
892
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
 
898
class ReadOnlyError(LockError):
 
 
900
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
 
902
    # TODO: There should also be an error indicating that you need a write
 
 
903
    # lock and don't have any lock at all... mbp 20070226
 
 
905
    def __init__(self, obj):
 
 
909
class LockFailed(LockError):
 
 
911
    internal_error = False
 
 
913
    _fmt = "Cannot lock %(lock)s: %(why)s"
 
 
915
    def __init__(self, lock, why):
 
 
916
        LockError.__init__(self, '')
 
 
921
class OutSideTransaction(BzrError):
 
 
923
    _fmt = ("A transaction related operation was attempted after"
 
 
924
            " the transaction finished.")
 
 
927
class ObjectNotLocked(LockError):
 
 
929
    _fmt = "%(obj)r is not locked"
 
 
931
    # this can indicate that any particular object is not locked; see also
 
 
932
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
933
    # the caller -- perhaps they should be unified.
 
 
934
    def __init__(self, obj):
 
 
938
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
940
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
 
942
    def __init__(self, obj):
 
 
946
class UnlockableTransport(LockError):
 
 
948
    internal_error = False
 
 
950
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
 
952
    def __init__(self, transport):
 
 
953
        self.transport = transport
 
 
956
class LockContention(LockError):
 
 
958
    _fmt = 'Could not acquire lock "%(lock)s"'
 
 
959
    # TODO: show full url for lock, combining the transport and relative
 
 
962
    internal_error = False
 
 
964
    def __init__(self, lock):
 
 
968
class LockBroken(LockError):
 
 
970
    _fmt = ("Lock was broken while still open: %(lock)s"
 
 
971
            " - check storage consistency!")
 
 
973
    internal_error = False
 
 
975
    def __init__(self, lock):
 
 
979
class LockBreakMismatch(LockError):
 
 
981
    _fmt = ("Lock was released and re-acquired before being broken:"
 
 
982
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
 
984
    internal_error = False
 
 
986
    def __init__(self, lock, holder, target):
 
 
992
class LockNotHeld(LockError):
 
 
994
    _fmt = "Lock not held: %(lock)s"
 
 
996
    internal_error = False
 
 
998
    def __init__(self, lock):
 
 
1002
class TokenLockingNotSupported(LockError):
 
 
1004
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
 
1006
    def __init__(self, obj):
 
 
1010
class TokenMismatch(LockBroken):
 
 
1012
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
 
1014
    internal_error = True
 
 
1016
    def __init__(self, given_token, lock_token):
 
 
1017
        self.given_token = given_token
 
 
1018
        self.lock_token = lock_token
 
 
1021
class PointlessCommit(BzrError):
 
 
1023
    _fmt = "No changes to commit"
 
 
1026
class CannotCommitSelectedFileMerge(BzrError):
 
 
1028
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
 
1029
        ' files %(files_str)s'
 
 
1031
    def __init__(self, files):
 
 
1032
        files_str = ', '.join(files)
 
 
1033
        BzrError.__init__(self, files=files, files_str=files_str)
 
 
1036
class BadCommitMessageEncoding(BzrError):
 
 
1038
    _fmt = 'The specified commit message contains characters unsupported by '\
 
 
1039
        'the current encoding.'
 
 
1042
class UpgradeReadonly(BzrError):
 
 
1044
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
 
1047
class UpToDateFormat(BzrError):
 
 
1049
    _fmt = "The branch format %(format)s is already at the most recent format."
 
 
1051
    def __init__(self, format):
 
 
1052
        BzrError.__init__(self)
 
 
1053
        self.format = format
 
 
1056
class StrictCommitFailed(Exception):
 
 
1058
    _fmt = "Commit refused because there are unknowns in the tree."
 
 
1061
class NoSuchRevision(InternalBzrError):
 
 
1063
    _fmt = "%(branch)s has no revision %(revision)s"
 
 
1065
    def __init__(self, branch, revision):
 
 
1066
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
 
 
1067
        BzrError.__init__(self, branch=branch, revision=revision)
 
 
1070
class RangeInChangeOption(BzrError):
 
 
1072
    _fmt = "Option --change does not accept revision ranges"
 
 
1075
class NoSuchRevisionSpec(BzrError):
 
 
1077
    _fmt = "No namespace registered for string: %(spec)r"
 
 
1079
    def __init__(self, spec):
 
 
1080
        BzrError.__init__(self, spec=spec)
 
 
1083
class NoSuchRevisionInTree(NoSuchRevision):
 
 
1084
    """When using Tree.revision_tree, and the revision is not accessible."""
 
 
1086
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
 
1088
    def __init__(self, tree, revision_id):
 
 
1089
        BzrError.__init__(self)
 
 
1091
        self.revision_id = revision_id
 
 
1094
class InvalidRevisionSpec(BzrError):
 
 
1096
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
 
1097
            " %(branch)s%(extra)s")
 
 
1099
    def __init__(self, spec, branch, extra=None):
 
 
1100
        BzrError.__init__(self, branch=branch, spec=spec)
 
 
1102
            self.extra = '\n' + str(extra)
 
 
1107
class HistoryMissing(BzrError):
 
 
1109
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
 
1112
class AppendRevisionsOnlyViolation(BzrError):
 
 
1114
    _fmt = ('Operation denied because it would change the main history,'
 
 
1115
           ' which is not permitted by the append_revisions_only setting on'
 
 
1116
           ' branch "%(location)s".')
 
 
1118
    def __init__(self, location):
 
 
1119
       import bzrlib.urlutils as urlutils
 
 
1120
       location = urlutils.unescape_for_display(location, 'ascii')
 
 
1121
       BzrError.__init__(self, location=location)
 
 
1124
class DivergedBranches(BzrError):
 
 
1126
    _fmt = ("These branches have diverged."
 
 
1127
            " Use the merge command to reconcile them.")
 
 
1129
    def __init__(self, branch1, branch2):
 
 
1130
        self.branch1 = branch1
 
 
1131
        self.branch2 = branch2
 
 
1134
class NotLefthandHistory(InternalBzrError):
 
 
1136
    _fmt = "Supplied history does not follow left-hand parents"
 
 
1138
    def __init__(self, history):
 
 
1139
        BzrError.__init__(self, history=history)
 
 
1142
class UnrelatedBranches(BzrError):
 
 
1144
    _fmt = ("Branches have no common ancestor, and"
 
 
1145
            " no merge base revision was specified.")
 
 
1148
class CannotReverseCherrypick(BzrError):
 
 
1150
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
 
1154
class NoCommonAncestor(BzrError):
 
 
1156
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
1158
    def __init__(self, revision_a, revision_b):
 
 
1159
        self.revision_a = revision_a
 
 
1160
        self.revision_b = revision_b
 
 
1163
class NoCommonRoot(BzrError):
 
 
1165
    _fmt = ("Revisions are not derived from the same root: "
 
 
1166
           "%(revision_a)s %(revision_b)s.")
 
 
1168
    def __init__(self, revision_a, revision_b):
 
 
1169
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
 
1172
class NotAncestor(BzrError):
 
 
1174
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
 
1176
    def __init__(self, rev_id, not_ancestor_id):
 
 
1177
        BzrError.__init__(self, rev_id=rev_id,
 
 
1178
            not_ancestor_id=not_ancestor_id)
 
 
1181
class InstallFailed(BzrError):
 
 
1183
    def __init__(self, revisions):
 
 
1184
        revision_str = ", ".join(str(r) for r in revisions)
 
 
1185
        msg = "Could not install revisions:\n%s" % revision_str
 
 
1186
        BzrError.__init__(self, msg)
 
 
1187
        self.revisions = revisions
 
 
1190
class AmbiguousBase(BzrError):
 
 
1192
    def __init__(self, bases):
 
 
1193
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
1195
        msg = ("The correct base is unclear, because %s are all equally close"
 
 
1197
        BzrError.__init__(self, msg)
 
 
1201
class NoCommits(BranchError):
 
 
1203
    _fmt = "Branch %(branch)s has no commits."
 
 
1206
class UnlistableStore(BzrError):
 
 
1208
    def __init__(self, store):
 
 
1209
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
1213
class UnlistableBranch(BzrError):
 
 
1215
    def __init__(self, br):
 
 
1216
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
1219
class BoundBranchOutOfDate(BzrError):
 
 
1221
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
 
1224
    def __init__(self, branch, master):
 
 
1225
        BzrError.__init__(self)
 
 
1226
        self.branch = branch
 
 
1227
        self.master = master
 
 
1230
class CommitToDoubleBoundBranch(BzrError):
 
 
1232
    _fmt = ("Cannot commit to branch %(branch)s."
 
 
1233
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
 
1235
    def __init__(self, branch, master, remote):
 
 
1236
        BzrError.__init__(self)
 
 
1237
        self.branch = branch
 
 
1238
        self.master = master
 
 
1239
        self.remote = remote
 
 
1242
class OverwriteBoundBranch(BzrError):
 
 
1244
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
 
1246
    def __init__(self, branch):
 
 
1247
        BzrError.__init__(self)
 
 
1248
        self.branch = branch
 
 
1251
class BoundBranchConnectionFailure(BzrError):
 
 
1253
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
 
1254
            " => %(target)s: %(error)s")
 
 
1256
    def __init__(self, branch, target, error):
 
 
1257
        BzrError.__init__(self)
 
 
1258
        self.branch = branch
 
 
1259
        self.target = target
 
 
1263
class WeaveError(BzrError):
 
 
1265
    _fmt = "Error in processing weave: %(message)s"
 
 
1267
    def __init__(self, message=None):
 
 
1268
        BzrError.__init__(self)
 
 
1269
        self.message = message
 
 
1272
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
1274
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
 
1276
    def __init__(self, revision_id, weave):
 
 
1278
        WeaveError.__init__(self)
 
 
1279
        self.revision_id = revision_id
 
 
1283
class WeaveRevisionNotPresent(WeaveError):
 
 
1285
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
 
1287
    def __init__(self, revision_id, weave):
 
 
1288
        WeaveError.__init__(self)
 
 
1289
        self.revision_id = revision_id
 
 
1293
class WeaveFormatError(WeaveError):
 
 
1295
    _fmt = "Weave invariant violated: %(what)s"
 
 
1297
    def __init__(self, what):
 
 
1298
        WeaveError.__init__(self)
 
 
1302
class WeaveParentMismatch(WeaveError):
 
 
1304
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
 
1307
class WeaveInvalidChecksum(WeaveError):
 
 
1309
    _fmt = "Text did not match it's checksum: %(message)s"
 
 
1312
class WeaveTextDiffers(WeaveError):
 
 
1314
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1315
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1317
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1318
        WeaveError.__init__(self)
 
 
1319
        self.revision_id = revision_id
 
 
1320
        self.weave_a = weave_a
 
 
1321
        self.weave_b = weave_b
 
 
1324
class WeaveTextDiffers(WeaveError):
 
 
1326
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1327
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1329
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1330
        WeaveError.__init__(self)
 
 
1331
        self.revision_id = revision_id
 
 
1332
        self.weave_a = weave_a
 
 
1333
        self.weave_b = weave_b
 
 
1336
class VersionedFileError(BzrError):
 
 
1338
    _fmt = "Versioned file error"
 
 
1341
class RevisionNotPresent(VersionedFileError):
 
 
1343
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
 
1345
    def __init__(self, revision_id, file_id):
 
 
1346
        VersionedFileError.__init__(self)
 
 
1347
        self.revision_id = revision_id
 
 
1348
        self.file_id = file_id
 
 
1351
class RevisionAlreadyPresent(VersionedFileError):
 
 
1353
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
 
1355
    def __init__(self, revision_id, file_id):
 
 
1356
        VersionedFileError.__init__(self)
 
 
1357
        self.revision_id = revision_id
 
 
1358
        self.file_id = file_id
 
 
1361
class VersionedFileInvalidChecksum(VersionedFileError):
 
 
1363
    _fmt = "Text did not match its checksum: %(message)s"
 
 
1366
class KnitError(InternalBzrError):
 
 
1371
class KnitCorrupt(KnitError):
 
 
1373
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
 
1375
    def __init__(self, filename, how):
 
 
1376
        KnitError.__init__(self)
 
 
1377
        self.filename = filename
 
 
1381
class KnitDataStreamIncompatible(KnitError):
 
 
1382
    # Not raised anymore, as we can convert data streams.  In future we may
 
 
1383
    # need it again for more exotic cases, so we're keeping it around for now.
 
 
1385
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
 
1387
    def __init__(self, stream_format, target_format):
 
 
1388
        self.stream_format = stream_format
 
 
1389
        self.target_format = target_format
 
 
1392
class KnitDataStreamUnknown(KnitError):
 
 
1393
    # Indicates a data stream we don't know how to handle.
 
 
1395
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
 
1397
    def __init__(self, stream_format):
 
 
1398
        self.stream_format = stream_format
 
 
1401
class KnitHeaderError(KnitError):
 
 
1403
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
 
1405
    def __init__(self, badline, filename):
 
 
1406
        KnitError.__init__(self)
 
 
1407
        self.badline = badline
 
 
1408
        self.filename = filename
 
 
1410
class KnitIndexUnknownMethod(KnitError):
 
 
1411
    """Raised when we don't understand the storage method.
 
 
1413
    Currently only 'fulltext' and 'line-delta' are supported.
 
 
1416
    _fmt = ("Knit index %(filename)s does not have a known method"
 
 
1417
            " in options: %(options)r")
 
 
1419
    def __init__(self, filename, options):
 
 
1420
        KnitError.__init__(self)
 
 
1421
        self.filename = filename
 
 
1422
        self.options = options
 
 
1425
class NoSuchExportFormat(BzrError):
 
 
1427
    _fmt = "Export format %(format)r not supported"
 
 
1429
    def __init__(self, format):
 
 
1430
        BzrError.__init__(self)
 
 
1431
        self.format = format
 
 
1434
class TransportError(BzrError):
 
 
1436
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
 
1438
    def __init__(self, msg=None, orig_error=None):
 
 
1439
        if msg is None and orig_error is not None:
 
 
1440
            msg = str(orig_error)
 
 
1441
        if orig_error is None:
 
 
1446
        self.orig_error = orig_error
 
 
1447
        BzrError.__init__(self)
 
 
1450
class TooManyConcurrentRequests(InternalBzrError):
 
 
1452
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
 
1453
            " Be sure to finish_writing and finish_reading on the"
 
 
1454
            " currently open request.")
 
 
1456
    def __init__(self, medium):
 
 
1457
        self.medium = medium
 
 
1460
class SmartProtocolError(TransportError):
 
 
1462
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
 
1464
    def __init__(self, details):
 
 
1465
        self.details = details
 
 
1468
class UnexpectedProtocolVersionMarker(TransportError):
 
 
1470
    _fmt = "Received bad protocol version marker: %(marker)r"
 
 
1472
    def __init__(self, marker):
 
 
1473
        self.marker = marker
 
 
1476
class UnknownSmartMethod(InternalBzrError):
 
 
1478
    _fmt = "The server does not recognise the '%(verb)s' request."
 
 
1480
    def __init__(self, verb):
 
 
1484
class SmartMessageHandlerError(InternalBzrError):
 
 
1486
    _fmt = "The message handler raised an exception: %(exc_value)s."
 
 
1488
    def __init__(self, exc_info):
 
 
1489
        self.exc_type, self.exc_value, self.tb = exc_info
 
 
1492
# A set of semi-meaningful errors which can be thrown
 
 
1493
class TransportNotPossible(TransportError):
 
 
1495
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
 
1498
class ConnectionError(TransportError):
 
 
1500
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
 
1503
class SocketConnectionError(ConnectionError):
 
 
1505
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
 
1507
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
1509
            msg = 'Failed to connect to'
 
 
1510
        if orig_error is None:
 
 
1513
            orig_error = '; ' + str(orig_error)
 
 
1514
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
1519
            self.port = ':%s' % port
 
 
1522
class ConnectionReset(TransportError):
 
 
1524
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
 
1527
class InvalidRange(TransportError):
 
 
1529
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
 
1531
    def __init__(self, path, offset, msg=None):
 
 
1532
        TransportError.__init__(self, msg)
 
 
1534
        self.offset = offset
 
 
1537
class InvalidHttpResponse(TransportError):
 
 
1539
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
 
1541
    def __init__(self, path, msg, orig_error=None):
 
 
1543
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
1546
class InvalidHttpRange(InvalidHttpResponse):
 
 
1548
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
 
1550
    def __init__(self, path, range, msg):
 
 
1552
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1555
class InvalidHttpContentType(InvalidHttpResponse):
 
 
1557
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
 
1559
    def __init__(self, path, ctype, msg):
 
 
1561
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1564
class RedirectRequested(TransportError):
 
 
1566
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
 
1568
    def __init__(self, source, target, is_permanent=False, qual_proto=None):
 
 
1569
        self.source = source
 
 
1570
        self.target = target
 
 
1572
            self.permanently = ' permanently'
 
 
1574
            self.permanently = ''
 
 
1575
        self._qualified_proto = qual_proto
 
 
1576
        TransportError.__init__(self)
 
 
1578
    def _requalify_url(self, url):
 
 
1579
        """Restore the qualified proto in front of the url"""
 
 
1580
        # When this exception is raised, source and target are in
 
 
1581
        # user readable format. But some transports may use a
 
 
1582
        # different proto (http+urllib:// will present http:// to
 
 
1583
        # the user. If a qualified proto is specified, the code
 
 
1584
        # trapping the exception can get the qualified urls to
 
 
1585
        # properly handle the redirection themself (creating a
 
 
1586
        # new transport object from the target url for example).
 
 
1587
        # But checking that the scheme of the original and
 
 
1588
        # redirected urls are the same can be tricky. (see the
 
 
1589
        # FIXME in BzrDir.open_from_transport for the unique use
 
 
1591
        if self._qualified_proto is None:
 
 
1594
        # The TODO related to NotBranchError mention that doing
 
 
1595
        # that kind of manipulation on the urls may not be the
 
 
1596
        # exception object job. On the other hand, this object is
 
 
1597
        # the interface between the code and the user so
 
 
1598
        # presenting the urls in different ways is indeed its
 
 
1601
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
 
1602
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
 
1605
    def get_source_url(self):
 
 
1606
        return self._requalify_url(self.source)
 
 
1608
    def get_target_url(self):
 
 
1609
        return self._requalify_url(self.target)
 
 
1612
class TooManyRedirections(TransportError):
 
 
1614
    _fmt = "Too many redirections"
 
 
1617
class ConflictsInTree(BzrError):
 
 
1619
    _fmt = "Working tree has conflicts."
 
 
1622
class ParseConfigError(BzrError):
 
 
1624
    def __init__(self, errors, filename):
 
 
1625
        if filename is None:
 
 
1627
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
1628
            (filename, ('\n'.join(e.message for e in errors)))
 
 
1629
        BzrError.__init__(self, message)
 
 
1632
class NoEmailInUsername(BzrError):
 
 
1634
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
 
1636
    def __init__(self, username):
 
 
1637
        BzrError.__init__(self)
 
 
1638
        self.username = username
 
 
1641
class SigningFailed(BzrError):
 
 
1643
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
 
1645
    def __init__(self, command_line):
 
 
1646
        BzrError.__init__(self, command_line=command_line)
 
 
1649
class WorkingTreeNotRevision(BzrError):
 
 
1651
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
 
1652
            " the last commit, but weave merge requires that it be"
 
 
1655
    def __init__(self, tree):
 
 
1656
        BzrError.__init__(self, basedir=tree.basedir)
 
 
1659
class CantReprocessAndShowBase(BzrError):
 
 
1661
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
 
1662
           "the relationship of conflicting lines to the base")
 
 
1665
class GraphCycleError(BzrError):
 
 
1667
    _fmt = "Cycle in graph %(graph)r"
 
 
1669
    def __init__(self, graph):
 
 
1670
        BzrError.__init__(self)
 
 
1674
class WritingCompleted(InternalBzrError):
 
 
1676
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
 
1677
            "called upon it - accept bytes may not be called anymore.")
 
 
1679
    def __init__(self, request):
 
 
1680
        self.request = request
 
 
1683
class WritingNotComplete(InternalBzrError):
 
 
1685
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
 
1686
            "called upon it - until the write phase is complete no "
 
 
1687
            "data may be read.")
 
 
1689
    def __init__(self, request):
 
 
1690
        self.request = request
 
 
1693
class NotConflicted(BzrError):
 
 
1695
    _fmt = "File %(filename)s is not conflicted."
 
 
1697
    def __init__(self, filename):
 
 
1698
        BzrError.__init__(self)
 
 
1699
        self.filename = filename
 
 
1702
class MediumNotConnected(InternalBzrError):
 
 
1704
    _fmt = """The medium '%(medium)s' is not connected."""
 
 
1706
    def __init__(self, medium):
 
 
1707
        self.medium = medium
 
 
1710
class MustUseDecorated(Exception):
 
 
1712
    _fmt = "A decorating function has requested its original command be used."
 
 
1715
class NoBundleFound(BzrError):
 
 
1717
    _fmt = 'No bundle was found in "%(filename)s".'
 
 
1719
    def __init__(self, filename):
 
 
1720
        BzrError.__init__(self)
 
 
1721
        self.filename = filename
 
 
1724
class BundleNotSupported(BzrError):
 
 
1726
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
 
1728
    def __init__(self, version, msg):
 
 
1729
        BzrError.__init__(self)
 
 
1730
        self.version = version
 
 
1734
class MissingText(BzrError):
 
 
1736
    _fmt = ("Branch %(base)s is missing revision"
 
 
1737
            " %(text_revision)s of %(file_id)s")
 
 
1739
    def __init__(self, branch, text_revision, file_id):
 
 
1740
        BzrError.__init__(self)
 
 
1741
        self.branch = branch
 
 
1742
        self.base = branch.base
 
 
1743
        self.text_revision = text_revision
 
 
1744
        self.file_id = file_id
 
 
1747
class DuplicateFileId(BzrError):
 
 
1749
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
 
1751
    def __init__(self, file_id, entry):
 
 
1752
        BzrError.__init__(self)
 
 
1753
        self.file_id = file_id
 
 
1757
class DuplicateKey(BzrError):
 
 
1759
    _fmt = "Key %(key)s is already present in map"
 
 
1762
class DuplicateHelpPrefix(BzrError):
 
 
1764
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
 
1766
    def __init__(self, prefix):
 
 
1767
        self.prefix = prefix
 
 
1770
class MalformedTransform(BzrError):
 
 
1772
    _fmt = "Tree transform is malformed %(conflicts)r"
 
 
1775
class NoFinalPath(BzrError):
 
 
1777
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
 
1778
            "file-id: %(file_id)r\n"
 
 
1779
            "root trans-id: %(root_trans_id)r\n")
 
 
1781
    def __init__(self, trans_id, transform):
 
 
1782
        self.trans_id = trans_id
 
 
1783
        self.file_id = transform.final_file_id(trans_id)
 
 
1784
        self.root_trans_id = transform.root
 
 
1787
class BzrBadParameter(InternalBzrError):
 
 
1789
    _fmt = "Bad parameter: %(param)r"
 
 
1791
    # This exception should never be thrown, but it is a base class for all
 
 
1792
    # parameter-to-function errors.
 
 
1794
    def __init__(self, param):
 
 
1795
        BzrError.__init__(self)
 
 
1799
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1801
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
 
1804
class ReusingTransform(BzrError):
 
 
1806
    _fmt = "Attempt to reuse a transform that has already been applied."
 
 
1809
class CantMoveRoot(BzrError):
 
 
1811
    _fmt = "Moving the root directory is not supported at this time"
 
 
1814
class BzrMoveFailedError(BzrError):
 
 
1816
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1818
    def __init__(self, from_path='', to_path='', extra=None):
 
 
1819
        BzrError.__init__(self)
 
 
1821
            self.extra = ': ' + str(extra)
 
 
1825
        has_from = len(from_path) > 0
 
 
1826
        has_to = len(to_path) > 0
 
 
1828
            self.from_path = osutils.splitpath(from_path)[-1]
 
 
1833
            self.to_path = osutils.splitpath(to_path)[-1]
 
 
1838
        if has_from and has_to:
 
 
1839
            self.operator = " =>"
 
 
1841
            self.from_path = "from " + from_path
 
 
1843
            self.operator = "to"
 
 
1845
            self.operator = "file"
 
 
1848
class BzrRenameFailedError(BzrMoveFailedError):
 
 
1850
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1852
    def __init__(self, from_path, to_path, extra=None):
 
 
1853
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
 
1855
class BzrRemoveChangedFilesError(BzrError):
 
 
1856
    """Used when user is trying to remove changed files."""
 
 
1858
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
 
1859
        "%(changes_as_text)s"
 
 
1860
        "Use --keep to not delete them, or --force to delete them regardless.")
 
 
1862
    def __init__(self, tree_delta):
 
 
1863
        BzrError.__init__(self)
 
 
1864
        self.changes_as_text = tree_delta.get_changes_as_text()
 
 
1865
        #self.paths_as_string = '\n'.join(changed_files)
 
 
1866
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
 
1869
class BzrBadParameterNotString(BzrBadParameter):
 
 
1871
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
 
1874
class BzrBadParameterMissing(BzrBadParameter):
 
 
1876
    _fmt = "Parameter $(param)s is required but not present."
 
 
1879
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1881
    _fmt = ("Parameter %(param)s is unicode but"
 
 
1882
            " only byte-strings are permitted.")
 
 
1885
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1887
    _fmt = "Parameter %(param)s contains a newline."
 
 
1890
class DependencyNotPresent(BzrError):
 
 
1892
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
 
1894
    def __init__(self, library, error):
 
 
1895
        BzrError.__init__(self, library=library, error=error)
 
 
1898
class ParamikoNotPresent(DependencyNotPresent):
 
 
1900
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
 
1902
    def __init__(self, error):
 
 
1903
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1906
class PointlessMerge(BzrError):
 
 
1908
    _fmt = "Nothing to merge."
 
 
1911
class UninitializableFormat(BzrError):
 
 
1913
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
 
1915
    def __init__(self, format):
 
 
1916
        BzrError.__init__(self)
 
 
1917
        self.format = format
 
 
1920
class BadConversionTarget(BzrError):
 
 
1922
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
 
1924
    def __init__(self, problem, format):
 
 
1925
        BzrError.__init__(self)
 
 
1926
        self.problem = problem
 
 
1927
        self.format = format
 
 
1930
class NoDiffFound(BzrError):
 
 
1932
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
 
1934
    def __init__(self, path):
 
 
1935
        BzrError.__init__(self, path)
 
 
1938
class ExecutableMissing(BzrError):
 
 
1940
    _fmt = "%(exe_name)s could not be found on this machine"
 
 
1942
    def __init__(self, exe_name):
 
 
1943
        BzrError.__init__(self, exe_name=exe_name)
 
 
1946
class NoDiff(BzrError):
 
 
1948
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
 
1950
    def __init__(self, msg):
 
 
1951
        BzrError.__init__(self, msg=msg)
 
 
1954
class NoDiff3(BzrError):
 
 
1956
    _fmt = "Diff3 is not installed on this machine."
 
 
1959
class ExistingContent(BzrError):
 
 
1960
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
 
1962
    _fmt = "The content being inserted is already present."
 
 
1965
class ExistingLimbo(BzrError):
 
 
1967
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1968
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1969
    keep, and delete it when you are done."""
 
 
1971
    def __init__(self, limbo_dir):
 
 
1972
       BzrError.__init__(self)
 
 
1973
       self.limbo_dir = limbo_dir
 
 
1976
class ExistingPendingDeletion(BzrError):
 
 
1978
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1979
    Please examine %(pending_deletion)s to see if it contains any files you
 
 
1980
    wish to keep, and delete it when you are done."""
 
 
1982
    def __init__(self, pending_deletion):
 
 
1983
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
 
1986
class ImmortalLimbo(BzrError):
 
 
1988
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
 
1989
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1990
    keep, and delete it when you are done."""
 
 
1992
    def __init__(self, limbo_dir):
 
 
1993
       BzrError.__init__(self)
 
 
1994
       self.limbo_dir = limbo_dir
 
 
1997
class ImmortalPendingDeletion(BzrError):
 
 
1999
    _fmt = ("Unable to delete transform temporary directory "
 
 
2000
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
 
2001
    "contains any files you wish to keep, and delete it when you are done.")
 
 
2003
    def __init__(self, pending_deletion):
 
 
2004
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
 
2007
class OutOfDateTree(BzrError):
 
 
2009
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
 
2011
    def __init__(self, tree):
 
 
2012
        BzrError.__init__(self)
 
 
2016
class PublicBranchOutOfDate(BzrError):
 
 
2018
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
 
2021
    def __init__(self, public_location, revstring):
 
 
2022
        import bzrlib.urlutils as urlutils
 
 
2023
        public_location = urlutils.unescape_for_display(public_location,
 
 
2025
        BzrError.__init__(self, public_location=public_location,
 
 
2026
                          revstring=revstring)
 
 
2029
class MergeModifiedFormatError(BzrError):
 
 
2031
    _fmt = "Error in merge modified format"
 
 
2034
class ConflictFormatError(BzrError):
 
 
2036
    _fmt = "Format error in conflict listings"
 
 
2039
class CorruptDirstate(BzrError):
 
 
2041
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
 
2042
            "Error: %(description)s")
 
 
2044
    def __init__(self, dirstate_path, description):
 
 
2045
        BzrError.__init__(self)
 
 
2046
        self.dirstate_path = dirstate_path
 
 
2047
        self.description = description
 
 
2050
class CorruptRepository(BzrError):
 
 
2052
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
 
2053
            "Please run bzr reconcile on this repository.")
 
 
2055
    def __init__(self, repo):
 
 
2056
        BzrError.__init__(self)
 
 
2057
        self.repo_path = repo.bzrdir.root_transport.base
 
 
2060
class InconsistentDelta(BzrError):
 
 
2061
    """Used when we get a delta that is not valid."""
 
 
2063
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
 
2064
            " %(file_id)r\nreason: %(reason)s")
 
 
2066
    def __init__(self, path, file_id, reason):
 
 
2067
        BzrError.__init__(self)
 
 
2069
        self.file_id = file_id
 
 
2070
        self.reason = reason
 
 
2073
class UpgradeRequired(BzrError):
 
 
2075
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
 
2077
    def __init__(self, path):
 
 
2078
        BzrError.__init__(self)
 
 
2082
class RepositoryUpgradeRequired(UpgradeRequired):
 
 
2084
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
 
2087
class LocalRequiresBoundBranch(BzrError):
 
 
2089
    _fmt = "Cannot perform local-only commits on unbound branches."
 
 
2092
class MissingProgressBarFinish(BzrError):
 
 
2094
    _fmt = "A nested progress bar was not 'finished' correctly."
 
 
2097
class InvalidProgressBarType(BzrError):
 
 
2099
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
 
2100
            " is not a supported type Select one of: %(valid_types)s")
 
 
2102
    def __init__(self, bar_type, valid_types):
 
 
2103
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
2106
class UnsupportedOperation(BzrError):
 
 
2108
    _fmt = ("The method %(mname)s is not supported on"
 
 
2109
            " objects of type %(tname)s.")
 
 
2111
    def __init__(self, method, method_self):
 
 
2112
        self.method = method
 
 
2113
        self.mname = method.__name__
 
 
2114
        self.tname = type(method_self).__name__
 
 
2117
class CannotSetRevisionId(UnsupportedOperation):
 
 
2118
    """Raised when a commit is attempting to set a revision id but cant."""
 
 
2121
class NonAsciiRevisionId(UnsupportedOperation):
 
 
2122
    """Raised when a commit is attempting to set a non-ascii revision id
 
 
2127
class BinaryFile(BzrError):
 
 
2129
    _fmt = "File is binary but should be text."
 
 
2132
class IllegalPath(BzrError):
 
 
2134
    _fmt = "The path %(path)s is not permitted on this platform"
 
 
2136
    def __init__(self, path):
 
 
2137
        BzrError.__init__(self)
 
 
2141
class TestamentMismatch(BzrError):
 
 
2143
    _fmt = """Testament did not match expected value.
 
 
2144
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
 
2147
    def __init__(self, revision_id, expected, measured):
 
 
2148
        self.revision_id = revision_id
 
 
2149
        self.expected = expected
 
 
2150
        self.measured = measured
 
 
2153
class NotABundle(BzrError):
 
 
2155
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
 
2157
    def __init__(self, text):
 
 
2158
        BzrError.__init__(self)
 
 
2162
class BadBundle(BzrError): 
 
 
2164
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
 
2166
    def __init__(self, text):
 
 
2167
        BzrError.__init__(self)
 
 
2171
class MalformedHeader(BadBundle): 
 
 
2173
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
 
2176
class MalformedPatches(BadBundle): 
 
 
2178
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
 
2181
class MalformedFooter(BadBundle): 
 
 
2183
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
 
2186
class UnsupportedEOLMarker(BadBundle):
 
 
2188
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
 
2191
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
 
2192
        # but for this there is not
 
 
2193
        BzrError.__init__(self)
 
 
2196
class IncompatibleBundleFormat(BzrError):
 
 
2198
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
 
2200
    def __init__(self, bundle_format, other):
 
 
2201
        BzrError.__init__(self)
 
 
2202
        self.bundle_format = bundle_format
 
 
2206
class BadInventoryFormat(BzrError):
 
 
2208
    _fmt = "Root class for inventory serialization errors"
 
 
2211
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
2213
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
 
2215
    def __init__(self, msg):
 
 
2216
        BadInventoryFormat.__init__(self, msg=msg)
 
 
2219
class RootNotRich(BzrError):
 
 
2221
    _fmt = """This operation requires rich root data storage"""
 
 
2224
class NoSmartMedium(InternalBzrError):
 
 
2226
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
 
2228
    def __init__(self, transport):
 
 
2229
        self.transport = transport
 
 
2232
class NoSmartServer(NotBranchError):
 
 
2234
    _fmt = "No smart server available at %(url)s"
 
 
2236
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
 
2237
    def __init__(self, url):
 
 
2241
class UnknownSSH(BzrError):
 
 
2243
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
 
2245
    def __init__(self, vendor):
 
 
2246
        BzrError.__init__(self)
 
 
2247
        self.vendor = vendor
 
 
2250
class SSHVendorNotFound(BzrError):
 
 
2252
    _fmt = ("Don't know how to handle SSH connections."
 
 
2253
            " Please set BZR_SSH environment variable.")
 
 
2256
class GhostRevisionsHaveNoRevno(BzrError):
 
 
2257
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
 
2259
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
 
2260
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
 
2262
    def __init__(self, revision_id, ghost_revision_id):
 
 
2263
        self.revision_id = revision_id
 
 
2264
        self.ghost_revision_id = ghost_revision_id
 
 
2267
class GhostRevisionUnusableHere(BzrError):
 
 
2269
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
 
2271
    def __init__(self, revision_id):
 
 
2272
        BzrError.__init__(self)
 
 
2273
        self.revision_id = revision_id
 
 
2276
class IllegalUseOfScopeReplacer(InternalBzrError):
 
 
2278
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
 
2279
            " %(msg)s%(extra)s")
 
 
2281
    def __init__(self, name, msg, extra=None):
 
 
2282
        BzrError.__init__(self)
 
 
2286
            self.extra = ': ' + str(extra)
 
 
2291
class InvalidImportLine(InternalBzrError):
 
 
2293
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
 
2295
    def __init__(self, text, msg):
 
 
2296
        BzrError.__init__(self)
 
 
2301
class ImportNameCollision(InternalBzrError):
 
 
2303
    _fmt = ("Tried to import an object to the same name as"
 
 
2304
            " an existing object. %(name)s")
 
 
2306
    def __init__(self, name):
 
 
2307
        BzrError.__init__(self)
 
 
2311
class NotAMergeDirective(BzrError):
 
 
2312
    """File starting with %(firstline)r is not a merge directive"""
 
 
2313
    def __init__(self, firstline):
 
 
2314
        BzrError.__init__(self, firstline=firstline)
 
 
2317
class NoMergeSource(BzrError):
 
 
2318
    """Raise if no merge source was specified for a merge directive"""
 
 
2320
    _fmt = "A merge directive must provide either a bundle or a public"\
 
 
2324
class IllegalMergeDirectivePayload(BzrError):
 
 
2325
    """A merge directive contained something other than a patch or bundle"""
 
 
2327
    _fmt = "Bad merge directive payload %(start)r"
 
 
2329
    def __init__(self, start):
 
 
2334
class PatchVerificationFailed(BzrError):
 
 
2335
    """A patch from a merge directive could not be verified"""
 
 
2337
    _fmt = "Preview patch does not match requested changes."
 
 
2340
class PatchMissing(BzrError):
 
 
2341
    """Raise a patch type was specified but no patch supplied"""
 
 
2343
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
 
2345
    def __init__(self, patch_type):
 
 
2346
        BzrError.__init__(self)
 
 
2347
        self.patch_type = patch_type
 
 
2350
class UnsupportedInventoryKind(BzrError):
 
 
2352
    _fmt = """Unsupported entry kind %(kind)s"""
 
 
2354
    def __init__(self, kind):
 
 
2358
class BadSubsumeSource(BzrError):
 
 
2360
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
 
2362
    def __init__(self, tree, other_tree, reason):
 
 
2364
        self.other_tree = other_tree
 
 
2365
        self.reason = reason
 
 
2368
class SubsumeTargetNeedsUpgrade(BzrError):
 
 
2370
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
 
2372
    def __init__(self, other_tree):
 
 
2373
        self.other_tree = other_tree
 
 
2376
class BadReferenceTarget(InternalBzrError):
 
 
2378
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
 
2381
    def __init__(self, tree, other_tree, reason):
 
 
2383
        self.other_tree = other_tree
 
 
2384
        self.reason = reason
 
 
2387
class NoSuchTag(BzrError):
 
 
2389
    _fmt = "No such tag: %(tag_name)s"
 
 
2391
    def __init__(self, tag_name):
 
 
2392
        self.tag_name = tag_name
 
 
2395
class TagsNotSupported(BzrError):
 
 
2397
    _fmt = ("Tags not supported by %(branch)s;"
 
 
2398
            " you may be able to use bzr upgrade --dirstate-tags.")
 
 
2400
    def __init__(self, branch):
 
 
2401
        self.branch = branch
 
 
2404
class TagAlreadyExists(BzrError):
 
 
2406
    _fmt = "Tag %(tag_name)s already exists."
 
 
2408
    def __init__(self, tag_name):
 
 
2409
        self.tag_name = tag_name
 
 
2412
class MalformedBugIdentifier(BzrError):
 
 
2414
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
 
2416
    def __init__(self, bug_id, reason):
 
 
2417
        self.bug_id = bug_id
 
 
2418
        self.reason = reason
 
 
2421
class InvalidBugTrackerURL(BzrError):
 
 
2423
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
 
2424
            "contain {id}: %(url)s")
 
 
2426
    def __init__(self, abbreviation, url):
 
 
2427
        self.abbreviation = abbreviation
 
 
2431
class UnknownBugTrackerAbbreviation(BzrError):
 
 
2433
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
 
2436
    def __init__(self, abbreviation, branch):
 
 
2437
        self.abbreviation = abbreviation
 
 
2438
        self.branch = branch
 
 
2441
class UnexpectedSmartServerResponse(BzrError):
 
 
2443
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
 
2445
    def __init__(self, response_tuple):
 
 
2446
        self.response_tuple = response_tuple
 
 
2449
class ErrorFromSmartServer(BzrError):
 
 
2451
    _fmt = "Error received from smart server: %(error_tuple)r"
 
 
2453
    internal_error = True
 
 
2455
    def __init__(self, error_tuple):
 
 
2456
        self.error_tuple = error_tuple
 
 
2458
            self.error_verb = error_tuple[0]
 
 
2460
            self.error_verb = None
 
 
2461
        self.error_args = error_tuple[1:]
 
 
2464
class ContainerError(BzrError):
 
 
2465
    """Base class of container errors."""
 
 
2468
class UnknownContainerFormatError(ContainerError):
 
 
2470
    _fmt = "Unrecognised container format: %(container_format)r"
 
 
2472
    def __init__(self, container_format):
 
 
2473
        self.container_format = container_format
 
 
2476
class UnexpectedEndOfContainerError(ContainerError):
 
 
2478
    _fmt = "Unexpected end of container stream"
 
 
2481
class UnknownRecordTypeError(ContainerError):
 
 
2483
    _fmt = "Unknown record type: %(record_type)r"
 
 
2485
    def __init__(self, record_type):
 
 
2486
        self.record_type = record_type
 
 
2489
class InvalidRecordError(ContainerError):
 
 
2491
    _fmt = "Invalid record: %(reason)s"
 
 
2493
    def __init__(self, reason):
 
 
2494
        self.reason = reason
 
 
2497
class ContainerHasExcessDataError(ContainerError):
 
 
2499
    _fmt = "Container has data after end marker: %(excess)r"
 
 
2501
    def __init__(self, excess):
 
 
2502
        self.excess = excess
 
 
2505
class DuplicateRecordNameError(ContainerError):
 
 
2507
    _fmt = "Container has multiple records with the same name: %(name)s"
 
 
2509
    def __init__(self, name):
 
 
2513
class NoDestinationAddress(InternalBzrError):
 
 
2515
    _fmt = "Message does not have a destination address."
 
 
2518
class RepositoryDataStreamError(BzrError):
 
 
2520
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
 
2522
    def __init__(self, reason):
 
 
2523
        self.reason = reason
 
 
2526
class SMTPError(BzrError):
 
 
2528
    _fmt = "SMTP error: %(error)s"
 
 
2530
    def __init__(self, error):
 
 
2534
class NoMessageSupplied(BzrError):
 
 
2536
    _fmt = "No message supplied."
 
 
2539
class NoMailAddressSpecified(BzrError):
 
 
2541
    _fmt = "No mail-to address specified."
 
 
2544
class UnknownMailClient(BzrError):
 
 
2546
    _fmt = "Unknown mail client: %(mail_client)s"
 
 
2548
    def __init__(self, mail_client):
 
 
2549
        BzrError.__init__(self, mail_client=mail_client)
 
 
2552
class MailClientNotFound(BzrError):
 
 
2554
    _fmt = "Unable to find mail client with the following names:"\
 
 
2555
        " %(mail_command_list_string)s"
 
 
2557
    def __init__(self, mail_command_list):
 
 
2558
        mail_command_list_string = ', '.join(mail_command_list)
 
 
2559
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
 
2560
                          mail_command_list_string=mail_command_list_string)
 
 
2562
class SMTPConnectionRefused(SMTPError):
 
 
2564
    _fmt = "SMTP connection to %(host)s refused"
 
 
2566
    def __init__(self, error, host):
 
 
2571
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
 
2573
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
 
2576
class BzrDirError(BzrError):
 
 
2578
    def __init__(self, bzrdir):
 
 
2579
        import bzrlib.urlutils as urlutils
 
 
2580
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
 
2582
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
 
2585
class UnsyncedBranches(BzrDirError):
 
 
2587
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
 
2588
            " bzr help sync-for-reconfigure.")
 
 
2590
    def __init__(self, bzrdir, target_branch):
 
 
2591
        BzrDirError.__init__(self, bzrdir)
 
 
2592
        import bzrlib.urlutils as urlutils
 
 
2593
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
 
2597
class AlreadyBranch(BzrDirError):
 
 
2599
    _fmt = "'%(display_url)s' is already a branch."
 
 
2602
class AlreadyTree(BzrDirError):
 
 
2604
    _fmt = "'%(display_url)s' is already a tree."
 
 
2607
class AlreadyCheckout(BzrDirError):
 
 
2609
    _fmt = "'%(display_url)s' is already a checkout."
 
 
2612
class AlreadyLightweightCheckout(BzrDirError):
 
 
2614
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
 
2617
class AlreadyUsingShared(BzrDirError):
 
 
2619
    _fmt = "'%(display_url)s' is already using a shared repository."
 
 
2622
class AlreadyStandalone(BzrDirError):
 
 
2624
    _fmt = "'%(display_url)s' is already standalone."
 
 
2627
class ReconfigurationNotSupported(BzrDirError):
 
 
2629
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
 
2632
class NoBindLocation(BzrDirError):
 
 
2634
    _fmt = "No location could be found to bind to at %(display_url)s."
 
 
2637
class UncommittedChanges(BzrError):
 
 
2639
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
 
 
2641
    def __init__(self, tree):
 
 
2642
        import bzrlib.urlutils as urlutils
 
 
2643
        display_url = urlutils.unescape_for_display(
 
 
2644
            tree.bzrdir.root_transport.base, 'ascii')
 
 
2645
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
 
2648
class MissingTemplateVariable(BzrError):
 
 
2650
    _fmt = 'Variable {%(name)s} is not available.'
 
 
2652
    def __init__(self, name):
 
 
2656
class NoTemplate(BzrError):
 
 
2658
    _fmt = 'No template specified.'
 
 
2661
class UnableCreateSymlink(BzrError):
 
 
2663
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
 
2665
    def __init__(self, path=None):
 
 
2669
                path_str = repr(str(path))
 
 
2670
            except UnicodeEncodeError:
 
 
2671
                path_str = repr(path)
 
 
2673
        self.path_str = path_str
 
 
2676
class UnsupportedTimezoneFormat(BzrError):
 
 
2678
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
 
2679
            'options are "utc", "original", "local".')
 
 
2681
    def __init__(self, timezone):
 
 
2682
        self.timezone = timezone
 
 
2685
class CommandAvailableInPlugin(StandardError):
 
 
2687
    internal_error = False
 
 
2689
    def __init__(self, cmd_name, plugin_metadata, provider):
 
 
2691
        self.plugin_metadata = plugin_metadata
 
 
2692
        self.cmd_name = cmd_name
 
 
2693
        self.provider = provider
 
 
2697
        _fmt = ('"%s" is not a standard bzr command. \n' 
 
 
2698
                'However, the following official plugin provides this command: %s\n'
 
 
2699
                'You can install it by going to: %s'
 
 
2700
                % (self.cmd_name, self.plugin_metadata['name'], 
 
 
2701
                    self.plugin_metadata['url']))
 
 
2706
class NoPluginAvailable(BzrError):
 
 
2710
class NotATerminal(BzrError):
 
 
2712
    _fmt = 'Unable to ask for a password without real terminal.'
 
 
2715
class UnableEncodePath(BzrError):
 
 
2717
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
 
2718
            'user encoding %(user_encoding)s')
 
 
2720
    def __init__(self, path, kind):
 
 
2723
        self.user_encoding = osutils.get_user_encoding()
 
 
2726
class NoSuchAlias(BzrError):
 
 
2728
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
 
2730
    def __init__(self, alias_name):
 
 
2731
        BzrError.__init__(self, alias_name=alias_name)
 
 
2734
class DirectoryLookupFailure(BzrError):
 
 
2735
    """Base type for lookup errors."""
 
 
2740
class InvalidLocationAlias(DirectoryLookupFailure):
 
 
2742
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
 
2744
    def __init__(self, alias_name):
 
 
2745
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
 
2748
class UnsetLocationAlias(DirectoryLookupFailure):
 
 
2750
    _fmt = 'No %(alias_name)s location assigned.'
 
 
2752
    def __init__(self, alias_name):
 
 
2753
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
 
2756
class CannotBindAddress(BzrError):
 
 
2758
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
 
2760
    def __init__(self, host, port, orig_error):
 
 
2761
        BzrError.__init__(self, host=host, port=port,
 
 
2762
            orig_error=orig_error[1])