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 InvalidRebaseURLs(PathError):
 
 
567
    _fmt = "URLs differ by more than path: %(from_)r and %(to)r"
 
 
569
    def __init__(self, from_, to):
 
 
572
        PathError.__init__(self, from_, 'URLs differ by more than path.')
 
 
575
class UnavailableRepresentation(InternalBzrError):
 
 
577
    _fmt = ("The encoding '%(wanted)s' is not available for key %(key)s which "
 
 
578
        "is encoded as '%(native)s'.")
 
 
580
    def __init__(self, key, wanted, native):
 
 
581
        InternalBzrError.__init__(self)
 
 
587
class UnknownHook(BzrError):
 
 
589
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
 
591
    def __init__(self, hook_type, hook_name):
 
 
592
        BzrError.__init__(self)
 
 
593
        self.type = hook_type
 
 
594
        self.hook = hook_name
 
 
597
class UnsupportedProtocol(PathError):
 
 
599
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
 
601
    def __init__(self, url, extra):
 
 
602
        PathError.__init__(self, url, extra=extra)
 
 
605
class UnstackableBranchFormat(BzrError):
 
 
607
    _fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
 
 
608
        "You will need to upgrade the branch to permit branch stacking.")
 
 
610
    def __init__(self, format, url):
 
 
611
        BzrError.__init__(self)
 
 
616
class UnstackableRepositoryFormat(BzrError):
 
 
618
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
 
 
619
        "You will need to upgrade the repository to permit branch stacking.")
 
 
621
    def __init__(self, format, url):
 
 
622
        BzrError.__init__(self)
 
 
627
class ReadError(PathError):
 
 
629
    _fmt = """Error reading from %(path)r."""
 
 
632
class ShortReadvError(PathError):
 
 
634
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
 
 
635
            ' at %(offset)s for "%(path)s"%(extra)s')
 
 
637
    internal_error = True
 
 
639
    def __init__(self, path, offset, length, actual, extra=None):
 
 
640
        PathError.__init__(self, path, extra=extra)
 
 
646
class PathNotChild(PathError):
 
 
648
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
 
650
    internal_error = True
 
 
652
    def __init__(self, path, base, extra=None):
 
 
653
        BzrError.__init__(self)
 
 
657
            self.extra = ': ' + str(extra)
 
 
662
class InvalidNormalization(PathError):
 
 
664
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
 
667
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
668
# the exception object is a bit undesirable.
 
 
669
# TODO: Probably this behavior of should be a common superclass 
 
 
670
class NotBranchError(PathError):
 
 
672
    _fmt = 'Not a branch: "%(path)s".'
 
 
674
    def __init__(self, path):
 
 
675
       import bzrlib.urlutils as urlutils
 
 
676
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
679
class NoSubmitBranch(PathError):
 
 
681
    _fmt = 'No submit branch available for branch "%(path)s"'
 
 
683
    def __init__(self, branch):
 
 
684
       import bzrlib.urlutils as urlutils
 
 
685
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
 
688
class AlreadyBranchError(PathError):
 
 
690
    _fmt = 'Already a branch: "%(path)s".'
 
 
693
class BranchExistsWithoutWorkingTree(PathError):
 
 
695
    _fmt = 'Directory contains a branch, but no working tree \
 
 
696
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
 
699
class AtomicFileAlreadyClosed(PathError):
 
 
701
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
 
704
    def __init__(self, path, function):
 
 
705
        PathError.__init__(self, path=path, extra=None)
 
 
706
        self.function = function
 
 
709
class InaccessibleParent(PathError):
 
 
711
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
 
712
            ' relative path "%(path)s"')
 
 
714
    def __init__(self, path, base):
 
 
715
        PathError.__init__(self, path)
 
 
719
class NoRepositoryPresent(BzrError):
 
 
721
    _fmt = 'No repository present: "%(path)s"'
 
 
722
    def __init__(self, bzrdir):
 
 
723
        BzrError.__init__(self)
 
 
724
        self.path = bzrdir.transport.clone('..').base
 
 
727
class FileInWrongBranch(BzrError):
 
 
729
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
 
731
    def __init__(self, branch, path):
 
 
732
        BzrError.__init__(self)
 
 
734
        self.branch_base = branch.base
 
 
738
class UnsupportedFormatError(BzrError):
 
 
740
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
 
 
743
class UnknownFormatError(BzrError):
 
 
745
    _fmt = "Unknown %(kind)s format: %(format)r"
 
 
747
    def __init__(self, format, kind='branch'):
 
 
752
class IncompatibleFormat(BzrError):
 
 
754
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
 
756
    def __init__(self, format, bzrdir_format):
 
 
757
        BzrError.__init__(self)
 
 
759
        self.bzrdir = bzrdir_format
 
 
762
class IncompatibleRepositories(BzrError):
 
 
764
    _fmt = "Repository %(target)s is not compatible with repository"\
 
 
767
    def __init__(self, source, target):
 
 
768
        BzrError.__init__(self, target=target, source=source)
 
 
771
class IncompatibleRevision(BzrError):
 
 
773
    _fmt = "Revision is not compatible with %(repo_format)s"
 
 
775
    def __init__(self, repo_format):
 
 
776
        BzrError.__init__(self)
 
 
777
        self.repo_format = repo_format
 
 
780
class AlreadyVersionedError(BzrError):
 
 
781
    """Used when a path is expected not to be versioned, but it is."""
 
 
783
    _fmt = "%(context_info)s%(path)s is already versioned."
 
 
785
    def __init__(self, path, context_info=None):
 
 
786
        """Construct a new AlreadyVersionedError.
 
 
788
        :param path: This is the path which is versioned,
 
 
789
        which should be in a user friendly form.
 
 
790
        :param context_info: If given, this is information about the context,
 
 
791
        which could explain why this is expected to not be versioned.
 
 
793
        BzrError.__init__(self)
 
 
795
        if context_info is None:
 
 
796
            self.context_info = ''
 
 
798
            self.context_info = context_info + ". "
 
 
801
class NotVersionedError(BzrError):
 
 
802
    """Used when a path is expected to be versioned, but it is not."""
 
 
804
    _fmt = "%(context_info)s%(path)s is not versioned."
 
 
806
    def __init__(self, path, context_info=None):
 
 
807
        """Construct a new NotVersionedError.
 
 
809
        :param path: This is the path which is not versioned,
 
 
810
        which should be in a user friendly form.
 
 
811
        :param context_info: If given, this is information about the context,
 
 
812
        which could explain why this is expected to be versioned.
 
 
814
        BzrError.__init__(self)
 
 
816
        if context_info is None:
 
 
817
            self.context_info = ''
 
 
819
            self.context_info = context_info + ". "
 
 
822
class PathsNotVersionedError(BzrError):
 
 
823
    """Used when reporting several paths which are not versioned"""
 
 
825
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
 
827
    def __init__(self, paths):
 
 
828
        from bzrlib.osutils import quotefn
 
 
829
        BzrError.__init__(self)
 
 
831
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
834
class PathsDoNotExist(BzrError):
 
 
836
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
 
838
    # used when reporting that paths are neither versioned nor in the working
 
 
841
    def __init__(self, paths, extra=None):
 
 
843
        from bzrlib.osutils import quotefn
 
 
844
        BzrError.__init__(self)
 
 
846
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
848
            self.extra = ': ' + str(extra)
 
 
853
class BadFileKindError(BzrError):
 
 
855
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
 
857
    def __init__(self, filename, kind):
 
 
858
        BzrError.__init__(self, filename=filename, kind=kind)
 
 
861
class BadFilenameEncoding(BzrError):
 
 
863
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
 
 
864
            ' encoding %(fs_encoding)s')
 
 
866
    def __init__(self, filename, fs_encoding):
 
 
867
        BzrError.__init__(self)
 
 
868
        self.filename = filename
 
 
869
        self.fs_encoding = fs_encoding
 
 
872
class ForbiddenControlFileError(BzrError):
 
 
874
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
 
877
class LockError(InternalBzrError):
 
 
879
    _fmt = "Lock error: %(msg)s"
 
 
881
    # All exceptions from the lock/unlock functions should be from
 
 
882
    # this exception class.  They will be translated as necessary. The
 
 
883
    # original exception is available as e.original_error
 
 
885
    # New code should prefer to raise specific subclasses
 
 
886
    def __init__(self, message):
 
 
887
        # Python 2.5 uses a slot for StandardError.message,
 
 
888
        # so use a different variable name.  We now work around this in
 
 
889
        # BzrError.__str__, but this member name is kept for compatability.
 
 
893
class LockActive(LockError):
 
 
895
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
 
897
    internal_error = False
 
 
899
    def __init__(self, lock_description):
 
 
900
        self.lock_description = lock_description
 
 
903
class CommitNotPossible(LockError):
 
 
905
    _fmt = "A commit was attempted but we do not have a write lock open."
 
 
911
class AlreadyCommitted(LockError):
 
 
913
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
 
919
class ReadOnlyError(LockError):
 
 
921
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
 
923
    # TODO: There should also be an error indicating that you need a write
 
 
924
    # lock and don't have any lock at all... mbp 20070226
 
 
926
    def __init__(self, obj):
 
 
930
class LockFailed(LockError):
 
 
932
    internal_error = False
 
 
934
    _fmt = "Cannot lock %(lock)s: %(why)s"
 
 
936
    def __init__(self, lock, why):
 
 
937
        LockError.__init__(self, '')
 
 
942
class OutSideTransaction(BzrError):
 
 
944
    _fmt = ("A transaction related operation was attempted after"
 
 
945
            " the transaction finished.")
 
 
948
class ObjectNotLocked(LockError):
 
 
950
    _fmt = "%(obj)r is not locked"
 
 
952
    # this can indicate that any particular object is not locked; see also
 
 
953
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
954
    # the caller -- perhaps they should be unified.
 
 
955
    def __init__(self, obj):
 
 
959
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
961
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
 
963
    def __init__(self, obj):
 
 
967
class UnlockableTransport(LockError):
 
 
969
    internal_error = False
 
 
971
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
 
973
    def __init__(self, transport):
 
 
974
        self.transport = transport
 
 
977
class LockContention(LockError):
 
 
979
    _fmt = 'Could not acquire lock "%(lock)s"'
 
 
980
    # TODO: show full url for lock, combining the transport and relative
 
 
983
    internal_error = False
 
 
985
    def __init__(self, lock):
 
 
989
class LockBroken(LockError):
 
 
991
    _fmt = ("Lock was broken while still open: %(lock)s"
 
 
992
            " - check storage consistency!")
 
 
994
    internal_error = False
 
 
996
    def __init__(self, lock):
 
 
1000
class LockBreakMismatch(LockError):
 
 
1002
    _fmt = ("Lock was released and re-acquired before being broken:"
 
 
1003
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
 
1005
    internal_error = False
 
 
1007
    def __init__(self, lock, holder, target):
 
 
1009
        self.holder = holder
 
 
1010
        self.target = target
 
 
1013
class LockNotHeld(LockError):
 
 
1015
    _fmt = "Lock not held: %(lock)s"
 
 
1017
    internal_error = False
 
 
1019
    def __init__(self, lock):
 
 
1023
class TokenLockingNotSupported(LockError):
 
 
1025
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
 
1027
    def __init__(self, obj):
 
 
1031
class TokenMismatch(LockBroken):
 
 
1033
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
 
1035
    internal_error = True
 
 
1037
    def __init__(self, given_token, lock_token):
 
 
1038
        self.given_token = given_token
 
 
1039
        self.lock_token = lock_token
 
 
1042
class PointlessCommit(BzrError):
 
 
1044
    _fmt = "No changes to commit"
 
 
1047
class CannotCommitSelectedFileMerge(BzrError):
 
 
1049
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
 
1050
        ' files %(files_str)s'
 
 
1052
    def __init__(self, files):
 
 
1053
        files_str = ', '.join(files)
 
 
1054
        BzrError.__init__(self, files=files, files_str=files_str)
 
 
1057
class BadCommitMessageEncoding(BzrError):
 
 
1059
    _fmt = 'The specified commit message contains characters unsupported by '\
 
 
1060
        'the current encoding.'
 
 
1063
class UpgradeReadonly(BzrError):
 
 
1065
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
 
1068
class UpToDateFormat(BzrError):
 
 
1070
    _fmt = "The branch format %(format)s is already at the most recent format."
 
 
1072
    def __init__(self, format):
 
 
1073
        BzrError.__init__(self)
 
 
1074
        self.format = format
 
 
1077
class StrictCommitFailed(Exception):
 
 
1079
    _fmt = "Commit refused because there are unknowns in the tree."
 
 
1082
class NoSuchRevision(InternalBzrError):
 
 
1084
    _fmt = "%(branch)s has no revision %(revision)s"
 
 
1086
    def __init__(self, branch, revision):
 
 
1087
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
 
 
1088
        BzrError.__init__(self, branch=branch, revision=revision)
 
 
1091
class RangeInChangeOption(BzrError):
 
 
1093
    _fmt = "Option --change does not accept revision ranges"
 
 
1096
class NoSuchRevisionSpec(BzrError):
 
 
1098
    _fmt = "No namespace registered for string: %(spec)r"
 
 
1100
    def __init__(self, spec):
 
 
1101
        BzrError.__init__(self, spec=spec)
 
 
1104
class NoSuchRevisionInTree(NoSuchRevision):
 
 
1105
    """When using Tree.revision_tree, and the revision is not accessible."""
 
 
1107
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
 
1109
    def __init__(self, tree, revision_id):
 
 
1110
        BzrError.__init__(self)
 
 
1112
        self.revision_id = revision_id
 
 
1115
class InvalidRevisionSpec(BzrError):
 
 
1117
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
 
1118
            " %(branch)s%(extra)s")
 
 
1120
    def __init__(self, spec, branch, extra=None):
 
 
1121
        BzrError.__init__(self, branch=branch, spec=spec)
 
 
1123
            self.extra = '\n' + str(extra)
 
 
1128
class HistoryMissing(BzrError):
 
 
1130
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
 
1133
class AppendRevisionsOnlyViolation(BzrError):
 
 
1135
    _fmt = ('Operation denied because it would change the main history,'
 
 
1136
           ' which is not permitted by the append_revisions_only setting on'
 
 
1137
           ' branch "%(location)s".')
 
 
1139
    def __init__(self, location):
 
 
1140
       import bzrlib.urlutils as urlutils
 
 
1141
       location = urlutils.unescape_for_display(location, 'ascii')
 
 
1142
       BzrError.__init__(self, location=location)
 
 
1145
class DivergedBranches(BzrError):
 
 
1147
    _fmt = ("These branches have diverged."
 
 
1148
            " Use the merge command to reconcile them.")
 
 
1150
    def __init__(self, branch1, branch2):
 
 
1151
        self.branch1 = branch1
 
 
1152
        self.branch2 = branch2
 
 
1155
class NotLefthandHistory(InternalBzrError):
 
 
1157
    _fmt = "Supplied history does not follow left-hand parents"
 
 
1159
    def __init__(self, history):
 
 
1160
        BzrError.__init__(self, history=history)
 
 
1163
class UnrelatedBranches(BzrError):
 
 
1165
    _fmt = ("Branches have no common ancestor, and"
 
 
1166
            " no merge base revision was specified.")
 
 
1169
class CannotReverseCherrypick(BzrError):
 
 
1171
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
 
1175
class NoCommonAncestor(BzrError):
 
 
1177
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
1179
    def __init__(self, revision_a, revision_b):
 
 
1180
        self.revision_a = revision_a
 
 
1181
        self.revision_b = revision_b
 
 
1184
class NoCommonRoot(BzrError):
 
 
1186
    _fmt = ("Revisions are not derived from the same root: "
 
 
1187
           "%(revision_a)s %(revision_b)s.")
 
 
1189
    def __init__(self, revision_a, revision_b):
 
 
1190
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
 
1193
class NotAncestor(BzrError):
 
 
1195
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
 
1197
    def __init__(self, rev_id, not_ancestor_id):
 
 
1198
        BzrError.__init__(self, rev_id=rev_id,
 
 
1199
            not_ancestor_id=not_ancestor_id)
 
 
1202
class InstallFailed(BzrError):
 
 
1204
    def __init__(self, revisions):
 
 
1205
        revision_str = ", ".join(str(r) for r in revisions)
 
 
1206
        msg = "Could not install revisions:\n%s" % revision_str
 
 
1207
        BzrError.__init__(self, msg)
 
 
1208
        self.revisions = revisions
 
 
1211
class AmbiguousBase(BzrError):
 
 
1213
    def __init__(self, bases):
 
 
1214
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
1216
        msg = ("The correct base is unclear, because %s are all equally close"
 
 
1218
        BzrError.__init__(self, msg)
 
 
1222
class NoCommits(BranchError):
 
 
1224
    _fmt = "Branch %(branch)s has no commits."
 
 
1227
class UnlistableStore(BzrError):
 
 
1229
    def __init__(self, store):
 
 
1230
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
1234
class UnlistableBranch(BzrError):
 
 
1236
    def __init__(self, br):
 
 
1237
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
1240
class BoundBranchOutOfDate(BzrError):
 
 
1242
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
 
1245
    def __init__(self, branch, master):
 
 
1246
        BzrError.__init__(self)
 
 
1247
        self.branch = branch
 
 
1248
        self.master = master
 
 
1251
class CommitToDoubleBoundBranch(BzrError):
 
 
1253
    _fmt = ("Cannot commit to branch %(branch)s."
 
 
1254
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
 
1256
    def __init__(self, branch, master, remote):
 
 
1257
        BzrError.__init__(self)
 
 
1258
        self.branch = branch
 
 
1259
        self.master = master
 
 
1260
        self.remote = remote
 
 
1263
class OverwriteBoundBranch(BzrError):
 
 
1265
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
 
1267
    def __init__(self, branch):
 
 
1268
        BzrError.__init__(self)
 
 
1269
        self.branch = branch
 
 
1272
class BoundBranchConnectionFailure(BzrError):
 
 
1274
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
 
1275
            " => %(target)s: %(error)s")
 
 
1277
    def __init__(self, branch, target, error):
 
 
1278
        BzrError.__init__(self)
 
 
1279
        self.branch = branch
 
 
1280
        self.target = target
 
 
1284
class WeaveError(BzrError):
 
 
1286
    _fmt = "Error in processing weave: %(message)s"
 
 
1288
    def __init__(self, message=None):
 
 
1289
        BzrError.__init__(self)
 
 
1290
        self.message = message
 
 
1293
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
1295
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
 
1297
    def __init__(self, revision_id, weave):
 
 
1299
        WeaveError.__init__(self)
 
 
1300
        self.revision_id = revision_id
 
 
1304
class WeaveRevisionNotPresent(WeaveError):
 
 
1306
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
 
1308
    def __init__(self, revision_id, weave):
 
 
1309
        WeaveError.__init__(self)
 
 
1310
        self.revision_id = revision_id
 
 
1314
class WeaveFormatError(WeaveError):
 
 
1316
    _fmt = "Weave invariant violated: %(what)s"
 
 
1318
    def __init__(self, what):
 
 
1319
        WeaveError.__init__(self)
 
 
1323
class WeaveParentMismatch(WeaveError):
 
 
1325
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
 
1328
class WeaveInvalidChecksum(WeaveError):
 
 
1330
    _fmt = "Text did not match it's checksum: %(message)s"
 
 
1333
class WeaveTextDiffers(WeaveError):
 
 
1335
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1336
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1338
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1339
        WeaveError.__init__(self)
 
 
1340
        self.revision_id = revision_id
 
 
1341
        self.weave_a = weave_a
 
 
1342
        self.weave_b = weave_b
 
 
1345
class WeaveTextDiffers(WeaveError):
 
 
1347
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1348
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1350
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1351
        WeaveError.__init__(self)
 
 
1352
        self.revision_id = revision_id
 
 
1353
        self.weave_a = weave_a
 
 
1354
        self.weave_b = weave_b
 
 
1357
class VersionedFileError(BzrError):
 
 
1359
    _fmt = "Versioned file error"
 
 
1362
class RevisionNotPresent(VersionedFileError):
 
 
1364
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
 
1366
    def __init__(self, revision_id, file_id):
 
 
1367
        VersionedFileError.__init__(self)
 
 
1368
        self.revision_id = revision_id
 
 
1369
        self.file_id = file_id
 
 
1372
class RevisionAlreadyPresent(VersionedFileError):
 
 
1374
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
 
1376
    def __init__(self, revision_id, file_id):
 
 
1377
        VersionedFileError.__init__(self)
 
 
1378
        self.revision_id = revision_id
 
 
1379
        self.file_id = file_id
 
 
1382
class VersionedFileInvalidChecksum(VersionedFileError):
 
 
1384
    _fmt = "Text did not match its checksum: %(message)s"
 
 
1387
class KnitError(InternalBzrError):
 
 
1392
class KnitCorrupt(KnitError):
 
 
1394
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
 
1396
    def __init__(self, filename, how):
 
 
1397
        KnitError.__init__(self)
 
 
1398
        self.filename = filename
 
 
1402
class KnitDataStreamIncompatible(KnitError):
 
 
1403
    # Not raised anymore, as we can convert data streams.  In future we may
 
 
1404
    # need it again for more exotic cases, so we're keeping it around for now.
 
 
1406
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
 
1408
    def __init__(self, stream_format, target_format):
 
 
1409
        self.stream_format = stream_format
 
 
1410
        self.target_format = target_format
 
 
1413
class KnitDataStreamUnknown(KnitError):
 
 
1414
    # Indicates a data stream we don't know how to handle.
 
 
1416
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
 
1418
    def __init__(self, stream_format):
 
 
1419
        self.stream_format = stream_format
 
 
1422
class KnitHeaderError(KnitError):
 
 
1424
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
 
1426
    def __init__(self, badline, filename):
 
 
1427
        KnitError.__init__(self)
 
 
1428
        self.badline = badline
 
 
1429
        self.filename = filename
 
 
1431
class KnitIndexUnknownMethod(KnitError):
 
 
1432
    """Raised when we don't understand the storage method.
 
 
1434
    Currently only 'fulltext' and 'line-delta' are supported.
 
 
1437
    _fmt = ("Knit index %(filename)s does not have a known method"
 
 
1438
            " in options: %(options)r")
 
 
1440
    def __init__(self, filename, options):
 
 
1441
        KnitError.__init__(self)
 
 
1442
        self.filename = filename
 
 
1443
        self.options = options
 
 
1446
class NoSuchExportFormat(BzrError):
 
 
1448
    _fmt = "Export format %(format)r not supported"
 
 
1450
    def __init__(self, format):
 
 
1451
        BzrError.__init__(self)
 
 
1452
        self.format = format
 
 
1455
class TransportError(BzrError):
 
 
1457
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
 
1459
    def __init__(self, msg=None, orig_error=None):
 
 
1460
        if msg is None and orig_error is not None:
 
 
1461
            msg = str(orig_error)
 
 
1462
        if orig_error is None:
 
 
1467
        self.orig_error = orig_error
 
 
1468
        BzrError.__init__(self)
 
 
1471
class TooManyConcurrentRequests(InternalBzrError):
 
 
1473
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
 
1474
            " Be sure to finish_writing and finish_reading on the"
 
 
1475
            " currently open request.")
 
 
1477
    def __init__(self, medium):
 
 
1478
        self.medium = medium
 
 
1481
class SmartProtocolError(TransportError):
 
 
1483
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
 
1485
    def __init__(self, details):
 
 
1486
        self.details = details
 
 
1489
class UnexpectedProtocolVersionMarker(TransportError):
 
 
1491
    _fmt = "Received bad protocol version marker: %(marker)r"
 
 
1493
    def __init__(self, marker):
 
 
1494
        self.marker = marker
 
 
1497
class UnknownSmartMethod(InternalBzrError):
 
 
1499
    _fmt = "The server does not recognise the '%(verb)s' request."
 
 
1501
    def __init__(self, verb):
 
 
1505
class SmartMessageHandlerError(InternalBzrError):
 
 
1507
    _fmt = "The message handler raised an exception: %(exc_value)s."
 
 
1509
    def __init__(self, exc_info):
 
 
1510
        self.exc_type, self.exc_value, self.tb = exc_info
 
 
1513
# A set of semi-meaningful errors which can be thrown
 
 
1514
class TransportNotPossible(TransportError):
 
 
1516
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
 
1519
class ConnectionError(TransportError):
 
 
1521
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
 
1524
class SocketConnectionError(ConnectionError):
 
 
1526
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
 
1528
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
1530
            msg = 'Failed to connect to'
 
 
1531
        if orig_error is None:
 
 
1534
            orig_error = '; ' + str(orig_error)
 
 
1535
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
1540
            self.port = ':%s' % port
 
 
1543
class ConnectionReset(TransportError):
 
 
1545
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
 
1548
class InvalidRange(TransportError):
 
 
1550
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
 
1552
    def __init__(self, path, offset, msg=None):
 
 
1553
        TransportError.__init__(self, msg)
 
 
1555
        self.offset = offset
 
 
1558
class InvalidHttpResponse(TransportError):
 
 
1560
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
 
1562
    def __init__(self, path, msg, orig_error=None):
 
 
1564
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
1567
class InvalidHttpRange(InvalidHttpResponse):
 
 
1569
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
 
1571
    def __init__(self, path, range, msg):
 
 
1573
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1576
class InvalidHttpContentType(InvalidHttpResponse):
 
 
1578
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
 
1580
    def __init__(self, path, ctype, msg):
 
 
1582
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1585
class RedirectRequested(TransportError):
 
 
1587
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
 
1589
    def __init__(self, source, target, is_permanent=False, qual_proto=None):
 
 
1590
        self.source = source
 
 
1591
        self.target = target
 
 
1593
            self.permanently = ' permanently'
 
 
1595
            self.permanently = ''
 
 
1596
        self._qualified_proto = qual_proto
 
 
1597
        TransportError.__init__(self)
 
 
1599
    def _requalify_url(self, url):
 
 
1600
        """Restore the qualified proto in front of the url"""
 
 
1601
        # When this exception is raised, source and target are in
 
 
1602
        # user readable format. But some transports may use a
 
 
1603
        # different proto (http+urllib:// will present http:// to
 
 
1604
        # the user. If a qualified proto is specified, the code
 
 
1605
        # trapping the exception can get the qualified urls to
 
 
1606
        # properly handle the redirection themself (creating a
 
 
1607
        # new transport object from the target url for example).
 
 
1608
        # But checking that the scheme of the original and
 
 
1609
        # redirected urls are the same can be tricky. (see the
 
 
1610
        # FIXME in BzrDir.open_from_transport for the unique use
 
 
1612
        if self._qualified_proto is None:
 
 
1615
        # The TODO related to NotBranchError mention that doing
 
 
1616
        # that kind of manipulation on the urls may not be the
 
 
1617
        # exception object job. On the other hand, this object is
 
 
1618
        # the interface between the code and the user so
 
 
1619
        # presenting the urls in different ways is indeed its
 
 
1622
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
 
1623
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
 
1626
    def get_source_url(self):
 
 
1627
        return self._requalify_url(self.source)
 
 
1629
    def get_target_url(self):
 
 
1630
        return self._requalify_url(self.target)
 
 
1633
class TooManyRedirections(TransportError):
 
 
1635
    _fmt = "Too many redirections"
 
 
1638
class ConflictsInTree(BzrError):
 
 
1640
    _fmt = "Working tree has conflicts."
 
 
1643
class ParseConfigError(BzrError):
 
 
1645
    def __init__(self, errors, filename):
 
 
1646
        if filename is None:
 
 
1648
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
1649
            (filename, ('\n'.join(e.message for e in errors)))
 
 
1650
        BzrError.__init__(self, message)
 
 
1653
class NoEmailInUsername(BzrError):
 
 
1655
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
 
1657
    def __init__(self, username):
 
 
1658
        BzrError.__init__(self)
 
 
1659
        self.username = username
 
 
1662
class SigningFailed(BzrError):
 
 
1664
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
 
1666
    def __init__(self, command_line):
 
 
1667
        BzrError.__init__(self, command_line=command_line)
 
 
1670
class WorkingTreeNotRevision(BzrError):
 
 
1672
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
 
1673
            " the last commit, but weave merge requires that it be"
 
 
1676
    def __init__(self, tree):
 
 
1677
        BzrError.__init__(self, basedir=tree.basedir)
 
 
1680
class CantReprocessAndShowBase(BzrError):
 
 
1682
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
 
1683
           "the relationship of conflicting lines to the base")
 
 
1686
class GraphCycleError(BzrError):
 
 
1688
    _fmt = "Cycle in graph %(graph)r"
 
 
1690
    def __init__(self, graph):
 
 
1691
        BzrError.__init__(self)
 
 
1695
class WritingCompleted(InternalBzrError):
 
 
1697
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
 
1698
            "called upon it - accept bytes may not be called anymore.")
 
 
1700
    def __init__(self, request):
 
 
1701
        self.request = request
 
 
1704
class WritingNotComplete(InternalBzrError):
 
 
1706
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
 
1707
            "called upon it - until the write phase is complete no "
 
 
1708
            "data may be read.")
 
 
1710
    def __init__(self, request):
 
 
1711
        self.request = request
 
 
1714
class NotConflicted(BzrError):
 
 
1716
    _fmt = "File %(filename)s is not conflicted."
 
 
1718
    def __init__(self, filename):
 
 
1719
        BzrError.__init__(self)
 
 
1720
        self.filename = filename
 
 
1723
class MediumNotConnected(InternalBzrError):
 
 
1725
    _fmt = """The medium '%(medium)s' is not connected."""
 
 
1727
    def __init__(self, medium):
 
 
1728
        self.medium = medium
 
 
1731
class MustUseDecorated(Exception):
 
 
1733
    _fmt = "A decorating function has requested its original command be used."
 
 
1736
class NoBundleFound(BzrError):
 
 
1738
    _fmt = 'No bundle was found in "%(filename)s".'
 
 
1740
    def __init__(self, filename):
 
 
1741
        BzrError.__init__(self)
 
 
1742
        self.filename = filename
 
 
1745
class BundleNotSupported(BzrError):
 
 
1747
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
 
1749
    def __init__(self, version, msg):
 
 
1750
        BzrError.__init__(self)
 
 
1751
        self.version = version
 
 
1755
class MissingText(BzrError):
 
 
1757
    _fmt = ("Branch %(base)s is missing revision"
 
 
1758
            " %(text_revision)s of %(file_id)s")
 
 
1760
    def __init__(self, branch, text_revision, file_id):
 
 
1761
        BzrError.__init__(self)
 
 
1762
        self.branch = branch
 
 
1763
        self.base = branch.base
 
 
1764
        self.text_revision = text_revision
 
 
1765
        self.file_id = file_id
 
 
1768
class DuplicateFileId(BzrError):
 
 
1770
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
 
1772
    def __init__(self, file_id, entry):
 
 
1773
        BzrError.__init__(self)
 
 
1774
        self.file_id = file_id
 
 
1778
class DuplicateKey(BzrError):
 
 
1780
    _fmt = "Key %(key)s is already present in map"
 
 
1783
class DuplicateHelpPrefix(BzrError):
 
 
1785
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
 
1787
    def __init__(self, prefix):
 
 
1788
        self.prefix = prefix
 
 
1791
class MalformedTransform(BzrError):
 
 
1793
    _fmt = "Tree transform is malformed %(conflicts)r"
 
 
1796
class NoFinalPath(BzrError):
 
 
1798
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
 
1799
            "file-id: %(file_id)r\n"
 
 
1800
            "root trans-id: %(root_trans_id)r\n")
 
 
1802
    def __init__(self, trans_id, transform):
 
 
1803
        self.trans_id = trans_id
 
 
1804
        self.file_id = transform.final_file_id(trans_id)
 
 
1805
        self.root_trans_id = transform.root
 
 
1808
class BzrBadParameter(InternalBzrError):
 
 
1810
    _fmt = "Bad parameter: %(param)r"
 
 
1812
    # This exception should never be thrown, but it is a base class for all
 
 
1813
    # parameter-to-function errors.
 
 
1815
    def __init__(self, param):
 
 
1816
        BzrError.__init__(self)
 
 
1820
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1822
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
 
1825
class ReusingTransform(BzrError):
 
 
1827
    _fmt = "Attempt to reuse a transform that has already been applied."
 
 
1830
class CantMoveRoot(BzrError):
 
 
1832
    _fmt = "Moving the root directory is not supported at this time"
 
 
1835
class BzrMoveFailedError(BzrError):
 
 
1837
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1839
    def __init__(self, from_path='', to_path='', extra=None):
 
 
1840
        BzrError.__init__(self)
 
 
1842
            self.extra = ': ' + str(extra)
 
 
1846
        has_from = len(from_path) > 0
 
 
1847
        has_to = len(to_path) > 0
 
 
1849
            self.from_path = osutils.splitpath(from_path)[-1]
 
 
1854
            self.to_path = osutils.splitpath(to_path)[-1]
 
 
1859
        if has_from and has_to:
 
 
1860
            self.operator = " =>"
 
 
1862
            self.from_path = "from " + from_path
 
 
1864
            self.operator = "to"
 
 
1866
            self.operator = "file"
 
 
1869
class BzrRenameFailedError(BzrMoveFailedError):
 
 
1871
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1873
    def __init__(self, from_path, to_path, extra=None):
 
 
1874
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
 
1876
class BzrRemoveChangedFilesError(BzrError):
 
 
1877
    """Used when user is trying to remove changed files."""
 
 
1879
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
 
1880
        "%(changes_as_text)s"
 
 
1881
        "Use --keep to not delete them, or --force to delete them regardless.")
 
 
1883
    def __init__(self, tree_delta):
 
 
1884
        BzrError.__init__(self)
 
 
1885
        self.changes_as_text = tree_delta.get_changes_as_text()
 
 
1886
        #self.paths_as_string = '\n'.join(changed_files)
 
 
1887
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
 
1890
class BzrBadParameterNotString(BzrBadParameter):
 
 
1892
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
 
1895
class BzrBadParameterMissing(BzrBadParameter):
 
 
1897
    _fmt = "Parameter $(param)s is required but not present."
 
 
1900
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1902
    _fmt = ("Parameter %(param)s is unicode but"
 
 
1903
            " only byte-strings are permitted.")
 
 
1906
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1908
    _fmt = "Parameter %(param)s contains a newline."
 
 
1911
class DependencyNotPresent(BzrError):
 
 
1913
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
 
1915
    def __init__(self, library, error):
 
 
1916
        BzrError.__init__(self, library=library, error=error)
 
 
1919
class ParamikoNotPresent(DependencyNotPresent):
 
 
1921
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
 
1923
    def __init__(self, error):
 
 
1924
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1927
class PointlessMerge(BzrError):
 
 
1929
    _fmt = "Nothing to merge."
 
 
1932
class UninitializableFormat(BzrError):
 
 
1934
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
 
1936
    def __init__(self, format):
 
 
1937
        BzrError.__init__(self)
 
 
1938
        self.format = format
 
 
1941
class BadConversionTarget(BzrError):
 
 
1943
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
 
1945
    def __init__(self, problem, format):
 
 
1946
        BzrError.__init__(self)
 
 
1947
        self.problem = problem
 
 
1948
        self.format = format
 
 
1951
class NoDiffFound(BzrError):
 
 
1953
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
 
1955
    def __init__(self, path):
 
 
1956
        BzrError.__init__(self, path)
 
 
1959
class ExecutableMissing(BzrError):
 
 
1961
    _fmt = "%(exe_name)s could not be found on this machine"
 
 
1963
    def __init__(self, exe_name):
 
 
1964
        BzrError.__init__(self, exe_name=exe_name)
 
 
1967
class NoDiff(BzrError):
 
 
1969
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
 
1971
    def __init__(self, msg):
 
 
1972
        BzrError.__init__(self, msg=msg)
 
 
1975
class NoDiff3(BzrError):
 
 
1977
    _fmt = "Diff3 is not installed on this machine."
 
 
1980
class ExistingContent(BzrError):
 
 
1981
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
 
1983
    _fmt = "The content being inserted is already present."
 
 
1986
class ExistingLimbo(BzrError):
 
 
1988
    _fmt = """This tree contains left-over files from a failed operation.
 
 
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 ExistingPendingDeletion(BzrError):
 
 
1999
    _fmt = """This tree contains left-over files from a failed operation.
 
 
2000
    Please examine %(pending_deletion)s to see if it contains any files you
 
 
2001
    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 ImmortalLimbo(BzrError):
 
 
2009
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
 
2010
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
2011
    keep, and delete it when you are done."""
 
 
2013
    def __init__(self, limbo_dir):
 
 
2014
       BzrError.__init__(self)
 
 
2015
       self.limbo_dir = limbo_dir
 
 
2018
class ImmortalPendingDeletion(BzrError):
 
 
2020
    _fmt = ("Unable to delete transform temporary directory "
 
 
2021
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
 
2022
    "contains any files you wish to keep, and delete it when you are done.")
 
 
2024
    def __init__(self, pending_deletion):
 
 
2025
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
 
2028
class OutOfDateTree(BzrError):
 
 
2030
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
 
2032
    def __init__(self, tree):
 
 
2033
        BzrError.__init__(self)
 
 
2037
class PublicBranchOutOfDate(BzrError):
 
 
2039
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
 
2042
    def __init__(self, public_location, revstring):
 
 
2043
        import bzrlib.urlutils as urlutils
 
 
2044
        public_location = urlutils.unescape_for_display(public_location,
 
 
2046
        BzrError.__init__(self, public_location=public_location,
 
 
2047
                          revstring=revstring)
 
 
2050
class MergeModifiedFormatError(BzrError):
 
 
2052
    _fmt = "Error in merge modified format"
 
 
2055
class ConflictFormatError(BzrError):
 
 
2057
    _fmt = "Format error in conflict listings"
 
 
2060
class CorruptDirstate(BzrError):
 
 
2062
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
 
2063
            "Error: %(description)s")
 
 
2065
    def __init__(self, dirstate_path, description):
 
 
2066
        BzrError.__init__(self)
 
 
2067
        self.dirstate_path = dirstate_path
 
 
2068
        self.description = description
 
 
2071
class CorruptRepository(BzrError):
 
 
2073
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
 
2074
            "Please run bzr reconcile on this repository.")
 
 
2076
    def __init__(self, repo):
 
 
2077
        BzrError.__init__(self)
 
 
2078
        self.repo_path = repo.bzrdir.root_transport.base
 
 
2081
class InconsistentDelta(BzrError):
 
 
2082
    """Used when we get a delta that is not valid."""
 
 
2084
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
 
2085
            " %(file_id)r\nreason: %(reason)s")
 
 
2087
    def __init__(self, path, file_id, reason):
 
 
2088
        BzrError.__init__(self)
 
 
2090
        self.file_id = file_id
 
 
2091
        self.reason = reason
 
 
2094
class UpgradeRequired(BzrError):
 
 
2096
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
 
2098
    def __init__(self, path):
 
 
2099
        BzrError.__init__(self)
 
 
2103
class RepositoryUpgradeRequired(UpgradeRequired):
 
 
2105
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
 
2108
class LocalRequiresBoundBranch(BzrError):
 
 
2110
    _fmt = "Cannot perform local-only commits on unbound branches."
 
 
2113
class MissingProgressBarFinish(BzrError):
 
 
2115
    _fmt = "A nested progress bar was not 'finished' correctly."
 
 
2118
class InvalidProgressBarType(BzrError):
 
 
2120
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
 
2121
            " is not a supported type Select one of: %(valid_types)s")
 
 
2123
    def __init__(self, bar_type, valid_types):
 
 
2124
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
2127
class UnsupportedOperation(BzrError):
 
 
2129
    _fmt = ("The method %(mname)s is not supported on"
 
 
2130
            " objects of type %(tname)s.")
 
 
2132
    def __init__(self, method, method_self):
 
 
2133
        self.method = method
 
 
2134
        self.mname = method.__name__
 
 
2135
        self.tname = type(method_self).__name__
 
 
2138
class CannotSetRevisionId(UnsupportedOperation):
 
 
2139
    """Raised when a commit is attempting to set a revision id but cant."""
 
 
2142
class NonAsciiRevisionId(UnsupportedOperation):
 
 
2143
    """Raised when a commit is attempting to set a non-ascii revision id
 
 
2148
class BinaryFile(BzrError):
 
 
2150
    _fmt = "File is binary but should be text."
 
 
2153
class IllegalPath(BzrError):
 
 
2155
    _fmt = "The path %(path)s is not permitted on this platform"
 
 
2157
    def __init__(self, path):
 
 
2158
        BzrError.__init__(self)
 
 
2162
class TestamentMismatch(BzrError):
 
 
2164
    _fmt = """Testament did not match expected value.
 
 
2165
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
 
2168
    def __init__(self, revision_id, expected, measured):
 
 
2169
        self.revision_id = revision_id
 
 
2170
        self.expected = expected
 
 
2171
        self.measured = measured
 
 
2174
class NotABundle(BzrError):
 
 
2176
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
 
2178
    def __init__(self, text):
 
 
2179
        BzrError.__init__(self)
 
 
2183
class BadBundle(BzrError): 
 
 
2185
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
 
2187
    def __init__(self, text):
 
 
2188
        BzrError.__init__(self)
 
 
2192
class MalformedHeader(BadBundle): 
 
 
2194
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
 
2197
class MalformedPatches(BadBundle): 
 
 
2199
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
 
2202
class MalformedFooter(BadBundle): 
 
 
2204
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
 
2207
class UnsupportedEOLMarker(BadBundle):
 
 
2209
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
 
2212
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
 
2213
        # but for this there is not
 
 
2214
        BzrError.__init__(self)
 
 
2217
class IncompatibleBundleFormat(BzrError):
 
 
2219
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
 
2221
    def __init__(self, bundle_format, other):
 
 
2222
        BzrError.__init__(self)
 
 
2223
        self.bundle_format = bundle_format
 
 
2227
class BadInventoryFormat(BzrError):
 
 
2229
    _fmt = "Root class for inventory serialization errors"
 
 
2232
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
2234
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
 
2236
    def __init__(self, msg):
 
 
2237
        BadInventoryFormat.__init__(self, msg=msg)
 
 
2240
class RootNotRich(BzrError):
 
 
2242
    _fmt = """This operation requires rich root data storage"""
 
 
2245
class NoSmartMedium(InternalBzrError):
 
 
2247
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
 
2249
    def __init__(self, transport):
 
 
2250
        self.transport = transport
 
 
2253
class NoSmartServer(NotBranchError):
 
 
2255
    _fmt = "No smart server available at %(url)s"
 
 
2257
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
 
2258
    def __init__(self, url):
 
 
2262
class UnknownSSH(BzrError):
 
 
2264
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
 
2266
    def __init__(self, vendor):
 
 
2267
        BzrError.__init__(self)
 
 
2268
        self.vendor = vendor
 
 
2271
class SSHVendorNotFound(BzrError):
 
 
2273
    _fmt = ("Don't know how to handle SSH connections."
 
 
2274
            " Please set BZR_SSH environment variable.")
 
 
2277
class GhostRevisionsHaveNoRevno(BzrError):
 
 
2278
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
 
2280
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
 
2281
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
 
2283
    def __init__(self, revision_id, ghost_revision_id):
 
 
2284
        self.revision_id = revision_id
 
 
2285
        self.ghost_revision_id = ghost_revision_id
 
 
2288
class GhostRevisionUnusableHere(BzrError):
 
 
2290
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
 
2292
    def __init__(self, revision_id):
 
 
2293
        BzrError.__init__(self)
 
 
2294
        self.revision_id = revision_id
 
 
2297
class IllegalUseOfScopeReplacer(InternalBzrError):
 
 
2299
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
 
2300
            " %(msg)s%(extra)s")
 
 
2302
    def __init__(self, name, msg, extra=None):
 
 
2303
        BzrError.__init__(self)
 
 
2307
            self.extra = ': ' + str(extra)
 
 
2312
class InvalidImportLine(InternalBzrError):
 
 
2314
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
 
2316
    def __init__(self, text, msg):
 
 
2317
        BzrError.__init__(self)
 
 
2322
class ImportNameCollision(InternalBzrError):
 
 
2324
    _fmt = ("Tried to import an object to the same name as"
 
 
2325
            " an existing object. %(name)s")
 
 
2327
    def __init__(self, name):
 
 
2328
        BzrError.__init__(self)
 
 
2332
class NotAMergeDirective(BzrError):
 
 
2333
    """File starting with %(firstline)r is not a merge directive"""
 
 
2334
    def __init__(self, firstline):
 
 
2335
        BzrError.__init__(self, firstline=firstline)
 
 
2338
class NoMergeSource(BzrError):
 
 
2339
    """Raise if no merge source was specified for a merge directive"""
 
 
2341
    _fmt = "A merge directive must provide either a bundle or a public"\
 
 
2345
class IllegalMergeDirectivePayload(BzrError):
 
 
2346
    """A merge directive contained something other than a patch or bundle"""
 
 
2348
    _fmt = "Bad merge directive payload %(start)r"
 
 
2350
    def __init__(self, start):
 
 
2355
class PatchVerificationFailed(BzrError):
 
 
2356
    """A patch from a merge directive could not be verified"""
 
 
2358
    _fmt = "Preview patch does not match requested changes."
 
 
2361
class PatchMissing(BzrError):
 
 
2362
    """Raise a patch type was specified but no patch supplied"""
 
 
2364
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
 
2366
    def __init__(self, patch_type):
 
 
2367
        BzrError.__init__(self)
 
 
2368
        self.patch_type = patch_type
 
 
2371
class UnsupportedInventoryKind(BzrError):
 
 
2373
    _fmt = """Unsupported entry kind %(kind)s"""
 
 
2375
    def __init__(self, kind):
 
 
2379
class BadSubsumeSource(BzrError):
 
 
2381
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
 
2383
    def __init__(self, tree, other_tree, reason):
 
 
2385
        self.other_tree = other_tree
 
 
2386
        self.reason = reason
 
 
2389
class SubsumeTargetNeedsUpgrade(BzrError):
 
 
2391
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
 
2393
    def __init__(self, other_tree):
 
 
2394
        self.other_tree = other_tree
 
 
2397
class BadReferenceTarget(InternalBzrError):
 
 
2399
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
 
2402
    def __init__(self, tree, other_tree, reason):
 
 
2404
        self.other_tree = other_tree
 
 
2405
        self.reason = reason
 
 
2408
class NoSuchTag(BzrError):
 
 
2410
    _fmt = "No such tag: %(tag_name)s"
 
 
2412
    def __init__(self, tag_name):
 
 
2413
        self.tag_name = tag_name
 
 
2416
class TagsNotSupported(BzrError):
 
 
2418
    _fmt = ("Tags not supported by %(branch)s;"
 
 
2419
            " you may be able to use bzr upgrade --dirstate-tags.")
 
 
2421
    def __init__(self, branch):
 
 
2422
        self.branch = branch
 
 
2425
class TagAlreadyExists(BzrError):
 
 
2427
    _fmt = "Tag %(tag_name)s already exists."
 
 
2429
    def __init__(self, tag_name):
 
 
2430
        self.tag_name = tag_name
 
 
2433
class MalformedBugIdentifier(BzrError):
 
 
2435
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
 
2437
    def __init__(self, bug_id, reason):
 
 
2438
        self.bug_id = bug_id
 
 
2439
        self.reason = reason
 
 
2442
class InvalidBugTrackerURL(BzrError):
 
 
2444
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
 
2445
            "contain {id}: %(url)s")
 
 
2447
    def __init__(self, abbreviation, url):
 
 
2448
        self.abbreviation = abbreviation
 
 
2452
class UnknownBugTrackerAbbreviation(BzrError):
 
 
2454
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
 
2457
    def __init__(self, abbreviation, branch):
 
 
2458
        self.abbreviation = abbreviation
 
 
2459
        self.branch = branch
 
 
2462
class UnexpectedSmartServerResponse(BzrError):
 
 
2464
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
 
2466
    def __init__(self, response_tuple):
 
 
2467
        self.response_tuple = response_tuple
 
 
2470
class ErrorFromSmartServer(BzrError):
 
 
2472
    _fmt = "Error received from smart server: %(error_tuple)r"
 
 
2474
    internal_error = True
 
 
2476
    def __init__(self, error_tuple):
 
 
2477
        self.error_tuple = error_tuple
 
 
2479
            self.error_verb = error_tuple[0]
 
 
2481
            self.error_verb = None
 
 
2482
        self.error_args = error_tuple[1:]
 
 
2485
class ContainerError(BzrError):
 
 
2486
    """Base class of container errors."""
 
 
2489
class UnknownContainerFormatError(ContainerError):
 
 
2491
    _fmt = "Unrecognised container format: %(container_format)r"
 
 
2493
    def __init__(self, container_format):
 
 
2494
        self.container_format = container_format
 
 
2497
class UnexpectedEndOfContainerError(ContainerError):
 
 
2499
    _fmt = "Unexpected end of container stream"
 
 
2502
class UnknownRecordTypeError(ContainerError):
 
 
2504
    _fmt = "Unknown record type: %(record_type)r"
 
 
2506
    def __init__(self, record_type):
 
 
2507
        self.record_type = record_type
 
 
2510
class InvalidRecordError(ContainerError):
 
 
2512
    _fmt = "Invalid record: %(reason)s"
 
 
2514
    def __init__(self, reason):
 
 
2515
        self.reason = reason
 
 
2518
class ContainerHasExcessDataError(ContainerError):
 
 
2520
    _fmt = "Container has data after end marker: %(excess)r"
 
 
2522
    def __init__(self, excess):
 
 
2523
        self.excess = excess
 
 
2526
class DuplicateRecordNameError(ContainerError):
 
 
2528
    _fmt = "Container has multiple records with the same name: %(name)s"
 
 
2530
    def __init__(self, name):
 
 
2534
class NoDestinationAddress(InternalBzrError):
 
 
2536
    _fmt = "Message does not have a destination address."
 
 
2539
class RepositoryDataStreamError(BzrError):
 
 
2541
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
 
2543
    def __init__(self, reason):
 
 
2544
        self.reason = reason
 
 
2547
class SMTPError(BzrError):
 
 
2549
    _fmt = "SMTP error: %(error)s"
 
 
2551
    def __init__(self, error):
 
 
2555
class NoMessageSupplied(BzrError):
 
 
2557
    _fmt = "No message supplied."
 
 
2560
class NoMailAddressSpecified(BzrError):
 
 
2562
    _fmt = "No mail-to address specified."
 
 
2565
class UnknownMailClient(BzrError):
 
 
2567
    _fmt = "Unknown mail client: %(mail_client)s"
 
 
2569
    def __init__(self, mail_client):
 
 
2570
        BzrError.__init__(self, mail_client=mail_client)
 
 
2573
class MailClientNotFound(BzrError):
 
 
2575
    _fmt = "Unable to find mail client with the following names:"\
 
 
2576
        " %(mail_command_list_string)s"
 
 
2578
    def __init__(self, mail_command_list):
 
 
2579
        mail_command_list_string = ', '.join(mail_command_list)
 
 
2580
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
 
2581
                          mail_command_list_string=mail_command_list_string)
 
 
2583
class SMTPConnectionRefused(SMTPError):
 
 
2585
    _fmt = "SMTP connection to %(host)s refused"
 
 
2587
    def __init__(self, error, host):
 
 
2592
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
 
2594
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
 
2597
class BzrDirError(BzrError):
 
 
2599
    def __init__(self, bzrdir):
 
 
2600
        import bzrlib.urlutils as urlutils
 
 
2601
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
 
2603
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
 
2606
class UnsyncedBranches(BzrDirError):
 
 
2608
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
 
2609
            " bzr help sync-for-reconfigure.")
 
 
2611
    def __init__(self, bzrdir, target_branch):
 
 
2612
        BzrDirError.__init__(self, bzrdir)
 
 
2613
        import bzrlib.urlutils as urlutils
 
 
2614
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
 
2618
class AlreadyBranch(BzrDirError):
 
 
2620
    _fmt = "'%(display_url)s' is already a branch."
 
 
2623
class AlreadyTree(BzrDirError):
 
 
2625
    _fmt = "'%(display_url)s' is already a tree."
 
 
2628
class AlreadyCheckout(BzrDirError):
 
 
2630
    _fmt = "'%(display_url)s' is already a checkout."
 
 
2633
class AlreadyLightweightCheckout(BzrDirError):
 
 
2635
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
 
2638
class AlreadyUsingShared(BzrDirError):
 
 
2640
    _fmt = "'%(display_url)s' is already using a shared repository."
 
 
2643
class AlreadyStandalone(BzrDirError):
 
 
2645
    _fmt = "'%(display_url)s' is already standalone."
 
 
2648
class ReconfigurationNotSupported(BzrDirError):
 
 
2650
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
 
2653
class NoBindLocation(BzrDirError):
 
 
2655
    _fmt = "No location could be found to bind to at %(display_url)s."
 
 
2658
class UncommittedChanges(BzrError):
 
 
2660
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
 
 
2662
    def __init__(self, tree):
 
 
2663
        import bzrlib.urlutils as urlutils
 
 
2664
        display_url = urlutils.unescape_for_display(
 
 
2665
            tree.bzrdir.root_transport.base, 'ascii')
 
 
2666
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
 
2669
class MissingTemplateVariable(BzrError):
 
 
2671
    _fmt = 'Variable {%(name)s} is not available.'
 
 
2673
    def __init__(self, name):
 
 
2677
class NoTemplate(BzrError):
 
 
2679
    _fmt = 'No template specified.'
 
 
2682
class UnableCreateSymlink(BzrError):
 
 
2684
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
 
2686
    def __init__(self, path=None):
 
 
2690
                path_str = repr(str(path))
 
 
2691
            except UnicodeEncodeError:
 
 
2692
                path_str = repr(path)
 
 
2694
        self.path_str = path_str
 
 
2697
class UnsupportedTimezoneFormat(BzrError):
 
 
2699
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
 
2700
            'options are "utc", "original", "local".')
 
 
2702
    def __init__(self, timezone):
 
 
2703
        self.timezone = timezone
 
 
2706
class CommandAvailableInPlugin(StandardError):
 
 
2708
    internal_error = False
 
 
2710
    def __init__(self, cmd_name, plugin_metadata, provider):
 
 
2712
        self.plugin_metadata = plugin_metadata
 
 
2713
        self.cmd_name = cmd_name
 
 
2714
        self.provider = provider
 
 
2718
        _fmt = ('"%s" is not a standard bzr command. \n' 
 
 
2719
                'However, the following official plugin provides this command: %s\n'
 
 
2720
                'You can install it by going to: %s'
 
 
2721
                % (self.cmd_name, self.plugin_metadata['name'], 
 
 
2722
                    self.plugin_metadata['url']))
 
 
2727
class NoPluginAvailable(BzrError):
 
 
2731
class NotATerminal(BzrError):
 
 
2733
    _fmt = 'Unable to ask for a password without real terminal.'
 
 
2736
class UnableEncodePath(BzrError):
 
 
2738
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
 
2739
            'user encoding %(user_encoding)s')
 
 
2741
    def __init__(self, path, kind):
 
 
2744
        self.user_encoding = osutils.get_user_encoding()
 
 
2747
class NoSuchAlias(BzrError):
 
 
2749
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
 
2751
    def __init__(self, alias_name):
 
 
2752
        BzrError.__init__(self, alias_name=alias_name)
 
 
2755
class DirectoryLookupFailure(BzrError):
 
 
2756
    """Base type for lookup errors."""
 
 
2761
class InvalidLocationAlias(DirectoryLookupFailure):
 
 
2763
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
 
2765
    def __init__(self, alias_name):
 
 
2766
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
 
2769
class UnsetLocationAlias(DirectoryLookupFailure):
 
 
2771
    _fmt = 'No %(alias_name)s location assigned.'
 
 
2773
    def __init__(self, alias_name):
 
 
2774
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
 
2777
class CannotBindAddress(BzrError):
 
 
2779
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
 
2781
    def __init__(self, host, port, orig_error):
 
 
2782
        BzrError.__init__(self, host=host, port=port,
 
 
2783
            orig_error=orig_error[1])
 
 
2786
class UnknownRules(BzrError):
 
 
2788
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
 
2790
    def __init__(self, unknowns):
 
 
2791
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))