1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
 
3
# This program is free software; you can redistribute it and/or modify
 
 
4
# it under the terms of the GNU General Public License as published by
 
 
5
# the Free Software Foundation; either version 2 of the License, or
 
 
6
# (at your option) any later version.
 
 
8
# This program is distributed in the hope that it will be useful,
 
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
11
# GNU General Public License for more details.
 
 
13
# You should have received a copy of the GNU General Public License
 
 
14
# along with this program; if not, write to the Free Software
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
17
"""Exceptions for bzr, and reporting of them.
 
 
25
from bzrlib.patches import (
 
 
34
# TODO: is there any value in providing the .args field used by standard
 
 
35
# python exceptions?   A list of values with no names seems less useful 
 
 
38
# TODO: Perhaps convert the exception to a string at the moment it's 
 
 
39
# constructed to make sure it will succeed.  But that says nothing about
 
 
40
# exceptions that are never raised.
 
 
42
# TODO: selftest assertRaises should probably also check that every error
 
 
43
# raised can be formatted as a string successfully, and without giving
 
 
47
class BzrError(StandardError):
 
 
49
    Base class for errors raised by bzrlib.
 
 
51
    :cvar internal_error: if True this was probably caused by a bzr bug and
 
 
52
    should be displayed with a traceback; if False (or absent) this was
 
 
53
    probably a user or environment error and they don't need the gory details.
 
 
54
    (That can be overridden by -Derror on the command line.)
 
 
56
    :cvar _fmt: Format string to display the error; this is expanded
 
 
57
    by the instance's dict.
 
 
60
    internal_error = False
 
 
62
    def __init__(self, msg=None, **kwds):
 
 
63
        """Construct a new BzrError.
 
 
65
        There are two alternative forms for constructing these objects.
 
 
66
        Either a preformatted string may be passed, or a set of named
 
 
67
        arguments can be given.  The first is for generic "user" errors which
 
 
68
        are not intended to be caught and so do not need a specific subclass.
 
 
69
        The second case is for use with subclasses that provide a _fmt format
 
 
70
        string to print the arguments.  
 
 
72
        Keyword arguments are taken as parameters to the error, which can 
 
 
73
        be inserted into the format string template.  It's recommended 
 
 
74
        that subclasses override the __init__ method to require specific 
 
 
77
        :param msg: If given, this is the literal complete text for the error,
 
 
78
        not subject to expansion.
 
 
80
        StandardError.__init__(self)
 
 
82
            # I was going to deprecate this, but it actually turns out to be
 
 
83
            # quite handy - mbp 20061103.
 
 
84
            self._preformatted_string = msg
 
 
86
            self._preformatted_string = None
 
 
87
            for key, value in kwds.items():
 
 
88
                setattr(self, key, value)
 
 
91
        s = getattr(self, '_preformatted_string', None)
 
 
93
            # contains a preformatted message; must be cast to plain str
 
 
96
            fmt = self._get_format_string()
 
 
98
                s = fmt % self.__dict__
 
 
99
                # __str__() should always return a 'str' object
 
 
100
                # never a 'unicode' object.
 
 
101
                if isinstance(s, unicode):
 
 
102
                    return s.encode('utf8')
 
 
104
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
 
 
105
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
 
106
                % (self.__class__.__name__,
 
 
108
                   getattr(self, '_fmt', None),
 
 
111
    def _get_format_string(self):
 
 
112
        """Return format string for this exception or None"""
 
 
113
        fmt = getattr(self, '_fmt', None)
 
 
116
        fmt = getattr(self, '__doc__', None)
 
 
118
            symbol_versioning.warn("%s uses its docstring as a format, "
 
 
119
                    "it should use _fmt instead" % self.__class__.__name__,
 
 
122
        return 'Unprintable exception %s: dict=%r, fmt=%r' \
 
 
123
            % (self.__class__.__name__,
 
 
125
               getattr(self, '_fmt', None),
 
 
129
class BzrNewError(BzrError):
 
 
130
    """Deprecated error base class."""
 
 
131
    # base classes should override the docstring with their human-
 
 
132
    # readable explanation
 
 
134
    def __init__(self, *args, **kwds):
 
 
135
        # XXX: Use the underlying BzrError to always generate the args
 
 
136
        # attribute if it doesn't exist.  We can't use super here, because
 
 
137
        # exceptions are old-style classes in python2.4 (but new in 2.5).
 
 
139
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
 
 
140
             'please convert %s to use BzrError instead'
 
 
141
             % self.__class__.__name__,
 
 
144
        BzrError.__init__(self, *args)
 
 
145
        for key, value in kwds.items():
 
 
146
            setattr(self, key, value)
 
 
150
            # __str__() should always return a 'str' object
 
 
151
            # never a 'unicode' object.
 
 
152
            s = self.__doc__ % self.__dict__
 
 
153
            if isinstance(s, unicode):
 
 
154
                return s.encode('utf8')
 
 
156
        except (TypeError, NameError, ValueError, KeyError), e:
 
 
157
            return 'Unprintable exception %s(%r): %r' \
 
 
158
                % (self.__class__.__name__,
 
 
162
class AlreadyBuilding(BzrError):
 
 
164
    _fmt = "The tree builder is already building a tree."
 
 
167
class BzrCheckError(BzrError):
 
 
169
    _fmt = "Internal check failed: %(message)s"
 
 
171
    internal_error = True
 
 
173
    def __init__(self, message):
 
 
174
        BzrError.__init__(self)
 
 
175
        self.message = message
 
 
178
class DisabledMethod(BzrError):
 
 
180
    _fmt = "The smart server method '%(class_name)s' is disabled."
 
 
182
    internal_error = True
 
 
184
    def __init__(self, class_name):
 
 
185
        BzrError.__init__(self)
 
 
186
        self.class_name = class_name
 
 
189
class IncompatibleAPI(BzrError):
 
 
191
    _fmt = 'The API for "%(api)s" is not compatible with "%(wanted)s". '\
 
 
192
        'It supports versions "%(minimum)s" to "%(current)s".'
 
 
194
    def __init__(self, api, wanted, minimum, current):
 
 
197
        self.minimum = minimum
 
 
198
        self.current = current
 
 
201
class InProcessTransport(BzrError):
 
 
203
    _fmt = "The transport '%(transport)s' is only accessible within this " \
 
 
206
    def __init__(self, transport):
 
 
207
        self.transport = transport
 
 
210
class InvalidEntryName(BzrError):
 
 
212
    _fmt = "Invalid entry name: %(name)s"
 
 
214
    internal_error = True
 
 
216
    def __init__(self, name):
 
 
217
        BzrError.__init__(self)
 
 
221
class InvalidRevisionNumber(BzrError):
 
 
223
    _fmt = "Invalid revision number %(revno)s"
 
 
225
    def __init__(self, revno):
 
 
226
        BzrError.__init__(self)
 
 
230
class InvalidRevisionId(BzrError):
 
 
232
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
 
234
    def __init__(self, revision_id, branch):
 
 
235
        # branch can be any string or object with __str__ defined
 
 
236
        BzrError.__init__(self)
 
 
237
        self.revision_id = revision_id
 
 
240
class ReservedId(BzrError):
 
 
242
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
 
244
    def __init__(self, revision_id):
 
 
245
        self.revision_id = revision_id
 
 
248
class NoHelpTopic(BzrError):
 
 
250
    _fmt = ("No help could be found for '%(topic)s'. "
 
 
251
        "Please use 'bzr help topics' to obtain a list of topics.")
 
 
253
    def __init__(self, topic):
 
 
257
class NoSuchId(BzrError):
 
 
259
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
 
261
    def __init__(self, tree, file_id):
 
 
262
        BzrError.__init__(self)
 
 
263
        self.file_id = file_id
 
 
267
class NoSuchIdInRepository(NoSuchId):
 
 
269
    _fmt = ("The file id %(file_id)r is not present in the repository"
 
 
272
    def __init__(self, repository, file_id):
 
 
273
        BzrError.__init__(self, repository=repository, file_id=file_id)
 
 
276
class InventoryModified(BzrError):
 
 
278
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
 
279
            " so a clean inventory cannot be read without data loss.")
 
 
281
    internal_error = True
 
 
283
    def __init__(self, tree):
 
 
287
class NoWorkingTree(BzrError):
 
 
289
    _fmt = "No WorkingTree exists for %(base)s."
 
 
291
    def __init__(self, base):
 
 
292
        BzrError.__init__(self)
 
 
296
class NotBuilding(BzrError):
 
 
298
    _fmt = "Not currently building a tree."
 
 
301
class NotLocalUrl(BzrError):
 
 
303
    _fmt = "%(url)s is not a local path."
 
 
305
    def __init__(self, url):
 
 
309
class WorkingTreeAlreadyPopulated(BzrError):
 
 
311
    _fmt = """Working tree already populated in %(base)s"""
 
 
313
    internal_error = True
 
 
315
    def __init__(self, base):
 
 
318
class BzrCommandError(BzrError):
 
 
319
    """Error from user command"""
 
 
321
    internal_error = False
 
 
323
    # Error from malformed user command; please avoid raising this as a
 
 
324
    # generic exception not caused by user input.
 
 
326
    # I think it's a waste of effort to differentiate between errors that
 
 
327
    # are not intended to be caught anyway.  UI code need not subclass
 
 
328
    # BzrCommandError, and non-UI code should not throw a subclass of
 
 
329
    # BzrCommandError.  ADHB 20051211
 
 
330
    def __init__(self, msg):
 
 
331
        # Object.__str__() must return a real string
 
 
332
        # returning a Unicode string is a python error.
 
 
333
        if isinstance(msg, unicode):
 
 
334
            self.msg = msg.encode('utf8')
 
 
342
class NotWriteLocked(BzrError):
 
 
344
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
 
346
    def __init__(self, not_locked):
 
 
347
        self.not_locked = not_locked
 
 
350
class BzrOptionError(BzrCommandError):
 
 
352
    _fmt = "Error in command line options"
 
 
355
class BadIndexFormatSignature(BzrError):
 
 
357
    _fmt = "%(value)s is not an index of type %(_type)s."
 
 
359
    def __init__(self, value, _type):
 
 
360
        BzrError.__init__(self)
 
 
365
class BadIndexData(BzrError):
 
 
367
    _fmt = "Error in data for index %(value)s."
 
 
369
    def __init__(self, value):
 
 
370
        BzrError.__init__(self)
 
 
374
class BadIndexDuplicateKey(BzrError):
 
 
376
    _fmt = "The key '%(key)s' is already in index '%(index)s'."
 
 
378
    def __init__(self, key, index):
 
 
379
        BzrError.__init__(self)
 
 
384
class BadIndexKey(BzrError):
 
 
386
    _fmt = "The key '%(key)s' is not a valid key."
 
 
388
    def __init__(self, key):
 
 
389
        BzrError.__init__(self)
 
 
393
class BadIndexOptions(BzrError):
 
 
395
    _fmt = "Could not parse options for index %(value)s."
 
 
397
    def __init__(self, value):
 
 
398
        BzrError.__init__(self)
 
 
402
class BadIndexValue(BzrError):
 
 
404
    _fmt = "The value '%(value)s' is not a valid value."
 
 
406
    def __init__(self, value):
 
 
407
        BzrError.__init__(self)
 
 
411
class BadOptionValue(BzrError):
 
 
413
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
 
415
    def __init__(self, name, value):
 
 
416
        BzrError.__init__(self, name=name, value=value)
 
 
419
class StrictCommitFailed(BzrError):
 
 
421
    _fmt = "Commit refused because there are unknown files in the tree"
 
 
424
# XXX: Should be unified with TransportError; they seem to represent the
 
 
426
# RBC 20060929: I think that unifiying with TransportError would be a mistake
 
 
427
# - this is finer than a TransportError - and more useful as such. It 
 
 
428
# differentiates between 'transport has failed' and 'operation on a transport
 
 
430
class PathError(BzrError):
 
 
432
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
 
434
    def __init__(self, path, extra=None):
 
 
435
        BzrError.__init__(self)
 
 
438
            self.extra = ': ' + str(extra)
 
 
443
class NoSuchFile(PathError):
 
 
445
    _fmt = "No such file: %(path)r%(extra)s"
 
 
448
class FileExists(PathError):
 
 
450
    _fmt = "File exists: %(path)r%(extra)s"
 
 
453
class RenameFailedFilesExist(BzrError):
 
 
454
    """Used when renaming and both source and dest exist."""
 
 
456
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
 
459
    def __init__(self, source, dest, extra=None):
 
 
460
        BzrError.__init__(self)
 
 
461
        self.source = str(source)
 
 
462
        self.dest = str(dest)
 
 
464
            self.extra = ' ' + str(extra)
 
 
469
class NotADirectory(PathError):
 
 
471
    _fmt = "%(path)r is not a directory %(extra)s"
 
 
474
class NotInWorkingDirectory(PathError):
 
 
476
    _fmt = "%(path)r is not in the working directory %(extra)s"
 
 
479
class DirectoryNotEmpty(PathError):
 
 
481
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
 
484
class ReadingCompleted(BzrError):
 
 
486
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
 
487
            "called upon it - the request has been completed and no more "
 
 
490
    internal_error = True
 
 
492
    def __init__(self, request):
 
 
493
        self.request = request
 
 
496
class ResourceBusy(PathError):
 
 
498
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
 
501
class PermissionDenied(PathError):
 
 
503
    _fmt = "Permission denied: %(path)r%(extra)s"
 
 
506
class InvalidURL(PathError):
 
 
508
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
 
511
class InvalidURLJoin(PathError):
 
 
513
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
 
515
    def __init__(self, msg, base, args):
 
 
516
        PathError.__init__(self, base, msg)
 
 
517
        self.args = [base] + list(args)
 
 
520
class UnknownHook(BzrError):
 
 
522
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
 
524
    def __init__(self, hook_type, hook_name):
 
 
525
        BzrError.__init__(self)
 
 
526
        self.type = hook_type
 
 
527
        self.hook = hook_name
 
 
530
class UnsupportedProtocol(PathError):
 
 
532
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
 
534
    def __init__(self, url, extra):
 
 
535
        PathError.__init__(self, url, extra=extra)
 
 
538
class ReadError(PathError):
 
 
540
    _fmt = """Error reading from %(path)r."""
 
 
543
class ShortReadvError(PathError):
 
 
545
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
 
 
546
            " at %(offset)s for %(path)s%(extra)s")
 
 
548
    internal_error = True
 
 
550
    def __init__(self, path, offset, length, actual, extra=None):
 
 
551
        PathError.__init__(self, path, extra=extra)
 
 
557
class PathNotChild(PathError):
 
 
559
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
 
561
    internal_error = True
 
 
563
    def __init__(self, path, base, extra=None):
 
 
564
        BzrError.__init__(self)
 
 
568
            self.extra = ': ' + str(extra)
 
 
573
class InvalidNormalization(PathError):
 
 
575
    _fmt = "Path %(path)r is not unicode normalized"
 
 
578
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
579
# the exception object is a bit undesirable.
 
 
580
# TODO: Probably this behavior of should be a common superclass 
 
 
581
class NotBranchError(PathError):
 
 
583
    _fmt = "Not a branch: %(path)s"
 
 
585
    def __init__(self, path):
 
 
586
       import bzrlib.urlutils as urlutils
 
 
587
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
590
class NoSubmitBranch(PathError):
 
 
592
    _fmt = 'No submit branch available for branch "%(path)s"'
 
 
594
    def __init__(self, branch):
 
 
595
       import bzrlib.urlutils as urlutils
 
 
596
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
 
599
class AlreadyBranchError(PathError):
 
 
601
    _fmt = "Already a branch: %(path)s."
 
 
604
class BranchExistsWithoutWorkingTree(PathError):
 
 
606
    _fmt = "Directory contains a branch, but no working tree \
 
 
607
(use bzr checkout if you wish to build a working tree): %(path)s"
 
 
610
class AtomicFileAlreadyClosed(PathError):
 
 
612
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
 
615
    def __init__(self, path, function):
 
 
616
        PathError.__init__(self, path=path, extra=None)
 
 
617
        self.function = function
 
 
620
class InaccessibleParent(PathError):
 
 
622
    _fmt = ("Parent not accessible given base %(base)s and"
 
 
623
            " relative path %(path)s")
 
 
625
    def __init__(self, path, base):
 
 
626
        PathError.__init__(self, path)
 
 
630
class NoRepositoryPresent(BzrError):
 
 
632
    _fmt = "No repository present: %(path)r"
 
 
633
    def __init__(self, bzrdir):
 
 
634
        BzrError.__init__(self)
 
 
635
        self.path = bzrdir.transport.clone('..').base
 
 
638
class FileInWrongBranch(BzrError):
 
 
640
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
 
642
    def __init__(self, branch, path):
 
 
643
        BzrError.__init__(self)
 
 
645
        self.branch_base = branch.base
 
 
649
class UnsupportedFormatError(BzrError):
 
 
651
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
 
 
654
class UnknownFormatError(BzrError):
 
 
656
    _fmt = "Unknown branch format: %(format)r"
 
 
659
class IncompatibleFormat(BzrError):
 
 
661
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
 
663
    def __init__(self, format, bzrdir_format):
 
 
664
        BzrError.__init__(self)
 
 
666
        self.bzrdir = bzrdir_format
 
 
669
class IncompatibleRepositories(BzrError):
 
 
671
    _fmt = "Repository %(target)s is not compatible with repository"\
 
 
674
    def __init__(self, source, target):
 
 
675
        BzrError.__init__(self, target=target, source=source)
 
 
678
class IncompatibleRevision(BzrError):
 
 
680
    _fmt = "Revision is not compatible with %(repo_format)s"
 
 
682
    def __init__(self, repo_format):
 
 
683
        BzrError.__init__(self)
 
 
684
        self.repo_format = repo_format
 
 
687
class AlreadyVersionedError(BzrError):
 
 
688
    """Used when a path is expected not to be versioned, but it is."""
 
 
690
    _fmt = "%(context_info)s%(path)s is already versioned"
 
 
692
    def __init__(self, path, context_info=None):
 
 
693
        """Construct a new AlreadyVersionedError.
 
 
695
        :param path: This is the path which is versioned,
 
 
696
        which should be in a user friendly form.
 
 
697
        :param context_info: If given, this is information about the context,
 
 
698
        which could explain why this is expected to not be versioned.
 
 
700
        BzrError.__init__(self)
 
 
702
        if context_info is None:
 
 
703
            self.context_info = ''
 
 
705
            self.context_info = context_info + ". "
 
 
708
class NotVersionedError(BzrError):
 
 
709
    """Used when a path is expected to be versioned, but it is not."""
 
 
711
    _fmt = "%(context_info)s%(path)s is not versioned"
 
 
713
    def __init__(self, path, context_info=None):
 
 
714
        """Construct a new NotVersionedError.
 
 
716
        :param path: This is the path which is not versioned,
 
 
717
        which should be in a user friendly form.
 
 
718
        :param context_info: If given, this is information about the context,
 
 
719
        which could explain why this is expected to be versioned.
 
 
721
        BzrError.__init__(self)
 
 
723
        if context_info is None:
 
 
724
            self.context_info = ''
 
 
726
            self.context_info = context_info + ". "
 
 
729
class PathsNotVersionedError(BzrError):
 
 
730
    """Used when reporting several paths which are not versioned"""
 
 
732
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
 
734
    def __init__(self, paths):
 
 
735
        from bzrlib.osutils import quotefn
 
 
736
        BzrError.__init__(self)
 
 
738
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
741
class PathsDoNotExist(BzrError):
 
 
743
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
 
745
    # used when reporting that paths are neither versioned nor in the working
 
 
748
    def __init__(self, paths, extra=None):
 
 
750
        from bzrlib.osutils import quotefn
 
 
751
        BzrError.__init__(self)
 
 
753
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
755
            self.extra = ': ' + str(extra)
 
 
760
class BadFileKindError(BzrError):
 
 
762
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
 
764
    def __init__(self, filename, kind):
 
 
765
        BzrError.__init__(self, filename=filename, kind=kind)
 
 
768
class ForbiddenControlFileError(BzrError):
 
 
770
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
 
773
class LockError(BzrError):
 
 
775
    _fmt = "Lock error: %(msg)s"
 
 
777
    internal_error = True
 
 
779
    # All exceptions from the lock/unlock functions should be from
 
 
780
    # this exception class.  They will be translated as necessary. The
 
 
781
    # original exception is available as e.original_error
 
 
783
    # New code should prefer to raise specific subclasses
 
 
784
    def __init__(self, message):
 
 
785
        # Python 2.5 uses a slot for StandardError.message,
 
 
786
        # so use a different variable name
 
 
787
        # so it is exposed in self.__dict__
 
 
791
class LockActive(LockError):
 
 
793
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
 
795
    internal_error = False
 
 
797
    def __init__(self, lock_description):
 
 
798
        self.lock_description = lock_description
 
 
801
class CommitNotPossible(LockError):
 
 
803
    _fmt = "A commit was attempted but we do not have a write lock open."
 
 
809
class AlreadyCommitted(LockError):
 
 
811
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
 
817
class ReadOnlyError(LockError):
 
 
819
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
 
821
    # TODO: There should also be an error indicating that you need a write
 
 
822
    # lock and don't have any lock at all... mbp 20070226
 
 
824
    def __init__(self, obj):
 
 
828
class ReadOnlyLockError(LockError):
 
 
830
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
 
832
    def __init__(self, fname, msg):
 
 
833
        LockError.__init__(self, '')
 
 
838
class OutSideTransaction(BzrError):
 
 
840
    _fmt = ("A transaction related operation was attempted after"
 
 
841
            " the transaction finished.")
 
 
844
class ObjectNotLocked(LockError):
 
 
846
    _fmt = "%(obj)r is not locked"
 
 
848
    # this can indicate that any particular object is not locked; see also
 
 
849
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
850
    # the caller -- perhaps they should be unified.
 
 
851
    def __init__(self, obj):
 
 
855
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
857
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
 
859
    def __init__(self, obj):
 
 
863
class UnlockableTransport(LockError):
 
 
865
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
 
867
    def __init__(self, transport):
 
 
868
        self.transport = transport
 
 
871
class LockContention(LockError):
 
 
873
    _fmt = "Could not acquire lock %(lock)s"
 
 
874
    # TODO: show full url for lock, combining the transport and relative
 
 
877
    internal_error = False
 
 
879
    def __init__(self, lock):
 
 
883
class LockBroken(LockError):
 
 
885
    _fmt = ("Lock was broken while still open: %(lock)s"
 
 
886
            " - check storage consistency!")
 
 
888
    internal_error = False
 
 
890
    def __init__(self, lock):
 
 
894
class LockBreakMismatch(LockError):
 
 
896
    _fmt = ("Lock was released and re-acquired before being broken:"
 
 
897
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
 
899
    internal_error = False
 
 
901
    def __init__(self, lock, holder, target):
 
 
907
class LockNotHeld(LockError):
 
 
909
    _fmt = "Lock not held: %(lock)s"
 
 
911
    internal_error = False
 
 
913
    def __init__(self, lock):
 
 
917
class TokenLockingNotSupported(LockError):
 
 
919
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
 
921
    internal_error = True
 
 
923
    def __init__(self, obj):
 
 
927
class TokenMismatch(LockBroken):
 
 
929
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
 
931
    internal_error = True
 
 
933
    def __init__(self, given_token, lock_token):
 
 
934
        self.given_token = given_token
 
 
935
        self.lock_token = lock_token
 
 
938
class PointlessCommit(BzrError):
 
 
940
    _fmt = "No changes to commit"
 
 
943
class CannotCommitSelectedFileMerge(BzrError):
 
 
945
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
 
946
        ' files %(files_str)s'
 
 
948
    def __init__(self, files):
 
 
949
        files_str = ', '.join(files)
 
 
950
        BzrError.__init__(self, files=files, files_str=files_str)
 
 
953
class UpgradeReadonly(BzrError):
 
 
955
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
 
958
class UpToDateFormat(BzrError):
 
 
960
    _fmt = "The branch format %(format)s is already at the most recent format."
 
 
962
    def __init__(self, format):
 
 
963
        BzrError.__init__(self)
 
 
967
class StrictCommitFailed(Exception):
 
 
969
    _fmt = "Commit refused because there are unknowns in the tree."
 
 
972
class NoSuchRevision(BzrError):
 
 
974
    _fmt = "%(branch)s has no revision %(revision)s"
 
 
976
    internal_error = True
 
 
978
    def __init__(self, branch, revision):
 
 
979
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
 
 
980
        BzrError.__init__(self, branch=branch, revision=revision)
 
 
983
# zero_ninetyone: this exception is no longer raised and should be removed
 
 
984
class NotLeftParentDescendant(BzrError):
 
 
986
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
 
987
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
 
989
    internal_error = True
 
 
991
    def __init__(self, branch, old_revision, new_revision):
 
 
992
        BzrError.__init__(self, branch_location=branch.base,
 
 
993
                          old_revision=old_revision,
 
 
994
                          new_revision=new_revision)
 
 
997
class NoSuchRevisionSpec(BzrError):
 
 
999
    _fmt = "No namespace registered for string: %(spec)r"
 
 
1001
    def __init__(self, spec):
 
 
1002
        BzrError.__init__(self, spec=spec)
 
 
1005
class NoSuchRevisionInTree(NoSuchRevision):
 
 
1006
    """When using Tree.revision_tree, and the revision is not accessible."""
 
 
1008
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
 
 
1010
    def __init__(self, tree, revision_id):
 
 
1011
        BzrError.__init__(self)
 
 
1013
        self.revision_id = revision_id
 
 
1016
class InvalidRevisionSpec(BzrError):
 
 
1018
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
 
1019
            " %(branch)s%(extra)s")
 
 
1021
    def __init__(self, spec, branch, extra=None):
 
 
1022
        BzrError.__init__(self, branch=branch, spec=spec)
 
 
1024
            self.extra = '\n' + str(extra)
 
 
1029
class HistoryMissing(BzrError):
 
 
1031
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
 
1034
class AppendRevisionsOnlyViolation(BzrError):
 
 
1036
    _fmt = ('Operation denied because it would change the main history,'
 
 
1037
           ' which is not permitted by the append_revisions_only setting on'
 
 
1038
           ' branch "%(location)s".')
 
 
1040
    def __init__(self, location):
 
 
1041
       import bzrlib.urlutils as urlutils
 
 
1042
       location = urlutils.unescape_for_display(location, 'ascii')
 
 
1043
       BzrError.__init__(self, location=location)
 
 
1046
class DivergedBranches(BzrError):
 
 
1048
    _fmt = ("These branches have diverged."
 
 
1049
            " Use the merge command to reconcile them.")
 
 
1051
    internal_error = False
 
 
1053
    def __init__(self, branch1, branch2):
 
 
1054
        self.branch1 = branch1
 
 
1055
        self.branch2 = branch2
 
 
1058
class NotLefthandHistory(BzrError):
 
 
1060
    _fmt = "Supplied history does not follow left-hand parents"
 
 
1062
    internal_error = True
 
 
1064
    def __init__(self, history):
 
 
1065
        BzrError.__init__(self, history=history)
 
 
1068
class UnrelatedBranches(BzrError):
 
 
1070
    _fmt = ("Branches have no common ancestor, and"
 
 
1071
            " no merge base revision was specified.")
 
 
1073
    internal_error = False
 
 
1076
class NoCommonAncestor(BzrError):
 
 
1078
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
1080
    def __init__(self, revision_a, revision_b):
 
 
1081
        self.revision_a = revision_a
 
 
1082
        self.revision_b = revision_b
 
 
1085
class NoCommonRoot(BzrError):
 
 
1087
    _fmt = ("Revisions are not derived from the same root: "
 
 
1088
           "%(revision_a)s %(revision_b)s.")
 
 
1090
    def __init__(self, revision_a, revision_b):
 
 
1091
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
 
1094
class NotAncestor(BzrError):
 
 
1096
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
 
1098
    def __init__(self, rev_id, not_ancestor_id):
 
 
1099
        BzrError.__init__(self, rev_id=rev_id,
 
 
1100
            not_ancestor_id=not_ancestor_id)
 
 
1103
class InstallFailed(BzrError):
 
 
1105
    def __init__(self, revisions):
 
 
1106
        revision_str = ", ".join(str(r) for r in revisions)
 
 
1107
        msg = "Could not install revisions:\n%s" % revision_str
 
 
1108
        BzrError.__init__(self, msg)
 
 
1109
        self.revisions = revisions
 
 
1112
class AmbiguousBase(BzrError):
 
 
1114
    def __init__(self, bases):
 
 
1115
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
1117
        msg = ("The correct base is unclear, because %s are all equally close"
 
 
1119
        BzrError.__init__(self, msg)
 
 
1123
class NoCommits(BzrError):
 
 
1125
    _fmt = "Branch %(branch)s has no commits."
 
 
1127
    def __init__(self, branch):
 
 
1128
        BzrError.__init__(self, branch=branch)
 
 
1131
class UnlistableStore(BzrError):
 
 
1133
    def __init__(self, store):
 
 
1134
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
1138
class UnlistableBranch(BzrError):
 
 
1140
    def __init__(self, br):
 
 
1141
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
1144
class BoundBranchOutOfDate(BzrError):
 
 
1146
    _fmt = ("Bound branch %(branch)s is out of date"
 
 
1147
            " with master branch %(master)s.")
 
 
1149
    def __init__(self, branch, master):
 
 
1150
        BzrError.__init__(self)
 
 
1151
        self.branch = branch
 
 
1152
        self.master = master
 
 
1155
class CommitToDoubleBoundBranch(BzrError):
 
 
1157
    _fmt = ("Cannot commit to branch %(branch)s."
 
 
1158
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
 
1160
    def __init__(self, branch, master, remote):
 
 
1161
        BzrError.__init__(self)
 
 
1162
        self.branch = branch
 
 
1163
        self.master = master
 
 
1164
        self.remote = remote
 
 
1167
class OverwriteBoundBranch(BzrError):
 
 
1169
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
 
1171
    def __init__(self, branch):
 
 
1172
        BzrError.__init__(self)
 
 
1173
        self.branch = branch
 
 
1176
class BoundBranchConnectionFailure(BzrError):
 
 
1178
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
 
1179
            " => %(target)s: %(error)s")
 
 
1181
    def __init__(self, branch, target, error):
 
 
1182
        BzrError.__init__(self)
 
 
1183
        self.branch = branch
 
 
1184
        self.target = target
 
 
1188
class WeaveError(BzrError):
 
 
1190
    _fmt = "Error in processing weave: %(message)s"
 
 
1192
    def __init__(self, message=None):
 
 
1193
        BzrError.__init__(self)
 
 
1194
        self.message = message
 
 
1197
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
1199
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
 
1201
    def __init__(self, revision_id, weave):
 
 
1203
        WeaveError.__init__(self)
 
 
1204
        self.revision_id = revision_id
 
 
1208
class WeaveRevisionNotPresent(WeaveError):
 
 
1210
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
 
1212
    def __init__(self, revision_id, weave):
 
 
1213
        WeaveError.__init__(self)
 
 
1214
        self.revision_id = revision_id
 
 
1218
class WeaveFormatError(WeaveError):
 
 
1220
    _fmt = "Weave invariant violated: %(what)s"
 
 
1222
    def __init__(self, what):
 
 
1223
        WeaveError.__init__(self)
 
 
1227
class WeaveParentMismatch(WeaveError):
 
 
1229
    _fmt = "Parents are mismatched between two revisions."
 
 
1232
class WeaveInvalidChecksum(WeaveError):
 
 
1234
    _fmt = "Text did not match it's checksum: %(message)s"
 
 
1237
class WeaveTextDiffers(WeaveError):
 
 
1239
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1240
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1242
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1243
        WeaveError.__init__(self)
 
 
1244
        self.revision_id = revision_id
 
 
1245
        self.weave_a = weave_a
 
 
1246
        self.weave_b = weave_b
 
 
1249
class WeaveTextDiffers(WeaveError):
 
 
1251
    _fmt = ("Weaves differ on text content. Revision:"
 
 
1252
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
 
1254
    def __init__(self, revision_id, weave_a, weave_b):
 
 
1255
        WeaveError.__init__(self)
 
 
1256
        self.revision_id = revision_id
 
 
1257
        self.weave_a = weave_a
 
 
1258
        self.weave_b = weave_b
 
 
1261
class VersionedFileError(BzrError):
 
 
1263
    _fmt = "Versioned file error"
 
 
1266
class RevisionNotPresent(VersionedFileError):
 
 
1268
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
 
1270
    def __init__(self, revision_id, file_id):
 
 
1271
        VersionedFileError.__init__(self)
 
 
1272
        self.revision_id = revision_id
 
 
1273
        self.file_id = file_id
 
 
1276
class RevisionAlreadyPresent(VersionedFileError):
 
 
1278
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
 
1280
    def __init__(self, revision_id, file_id):
 
 
1281
        VersionedFileError.__init__(self)
 
 
1282
        self.revision_id = revision_id
 
 
1283
        self.file_id = file_id
 
 
1286
class VersionedFileInvalidChecksum(VersionedFileError):
 
 
1288
    _fmt = "Text did not match its checksum: %(message)s"
 
 
1291
class KnitError(BzrError):
 
 
1295
    internal_error = True
 
 
1298
class KnitHeaderError(KnitError):
 
 
1300
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
 
1302
    def __init__(self, badline, filename):
 
 
1303
        KnitError.__init__(self)
 
 
1304
        self.badline = badline
 
 
1305
        self.filename = filename
 
 
1308
class KnitCorrupt(KnitError):
 
 
1310
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
 
1312
    def __init__(self, filename, how):
 
 
1313
        KnitError.__init__(self)
 
 
1314
        self.filename = filename
 
 
1318
class KnitIndexUnknownMethod(KnitError):
 
 
1319
    """Raised when we don't understand the storage method.
 
 
1321
    Currently only 'fulltext' and 'line-delta' are supported.
 
 
1324
    _fmt = ("Knit index %(filename)s does not have a known method"
 
 
1325
            " in options: %(options)r")
 
 
1327
    def __init__(self, filename, options):
 
 
1328
        KnitError.__init__(self)
 
 
1329
        self.filename = filename
 
 
1330
        self.options = options
 
 
1333
class NoSuchExportFormat(BzrError):
 
 
1335
    _fmt = "Export format %(format)r not supported"
 
 
1337
    def __init__(self, format):
 
 
1338
        BzrError.__init__(self)
 
 
1339
        self.format = format
 
 
1342
class TransportError(BzrError):
 
 
1344
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
 
1346
    def __init__(self, msg=None, orig_error=None):
 
 
1347
        if msg is None and orig_error is not None:
 
 
1348
            msg = str(orig_error)
 
 
1349
        if orig_error is None:
 
 
1354
        self.orig_error = orig_error
 
 
1355
        BzrError.__init__(self)
 
 
1358
class TooManyConcurrentRequests(BzrError):
 
 
1360
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
 
1361
            " Be sure to finish_writing and finish_reading on the"
 
 
1362
            " currently open request.")
 
 
1364
    internal_error = True
 
 
1366
    def __init__(self, medium):
 
 
1367
        self.medium = medium
 
 
1370
class SmartProtocolError(TransportError):
 
 
1372
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
 
1374
    def __init__(self, details):
 
 
1375
        self.details = details
 
 
1378
# A set of semi-meaningful errors which can be thrown
 
 
1379
class TransportNotPossible(TransportError):
 
 
1381
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
 
1384
class ConnectionError(TransportError):
 
 
1386
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
 
1389
class SocketConnectionError(ConnectionError):
 
 
1391
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
 
1393
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
1395
            msg = 'Failed to connect to'
 
 
1396
        if orig_error is None:
 
 
1399
            orig_error = '; ' + str(orig_error)
 
 
1400
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
1405
            self.port = ':%s' % port
 
 
1408
class ConnectionReset(TransportError):
 
 
1410
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
 
1413
class InvalidRange(TransportError):
 
 
1415
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
 
1417
    def __init__(self, path, offset):
 
 
1418
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
 
1421
        self.offset = offset
 
 
1424
class InvalidHttpResponse(TransportError):
 
 
1426
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
 
1428
    def __init__(self, path, msg, orig_error=None):
 
 
1430
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
1433
class InvalidHttpRange(InvalidHttpResponse):
 
 
1435
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
 
1437
    def __init__(self, path, range, msg):
 
 
1439
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1442
class InvalidHttpContentType(InvalidHttpResponse):
 
 
1444
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
 
1446
    def __init__(self, path, ctype, msg):
 
 
1448
        InvalidHttpResponse.__init__(self, path, msg)
 
 
1451
class RedirectRequested(TransportError):
 
 
1453
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
 
1455
    def __init__(self, source, target, is_permament=False, qual_proto=None):
 
 
1456
        self.source = source
 
 
1457
        self.target = target
 
 
1459
            self.permanently = ' permanently'
 
 
1461
            self.permanently = ''
 
 
1462
        self.is_permament = is_permament
 
 
1463
        self._qualified_proto = qual_proto
 
 
1464
        TransportError.__init__(self)
 
 
1466
    def _requalify_url(self, url):
 
 
1467
        """Restore the qualified proto in front of the url"""
 
 
1468
        # When this exception is raised, source and target are in
 
 
1469
        # user readable format. But some transports may use a
 
 
1470
        # different proto (http+urllib:// will present http:// to
 
 
1471
        # the user. If a qualified proto is specified, the code
 
 
1472
        # trapping the exception can get the qualified urls to
 
 
1473
        # properly handle the redirection themself (creating a
 
 
1474
        # new transport object from the target url for example).
 
 
1475
        # But checking that the scheme of the original and
 
 
1476
        # redirected urls are the same can be tricky. (see the
 
 
1477
        # FIXME in BzrDir.open_from_transport for the unique use
 
 
1479
        if self._qualified_proto is None:
 
 
1482
        # The TODO related to NotBranchError mention that doing
 
 
1483
        # that kind of manipulation on the urls may not be the
 
 
1484
        # exception object job. On the other hand, this object is
 
 
1485
        # the interface between the code and the user so
 
 
1486
        # presenting the urls in different ways is indeed its
 
 
1489
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
 
1490
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
 
1493
    def get_source_url(self):
 
 
1494
        return self._requalify_url(self.source)
 
 
1496
    def get_target_url(self):
 
 
1497
        return self._requalify_url(self.target)
 
 
1500
class TooManyRedirections(TransportError):
 
 
1502
    _fmt = "Too many redirections"
 
 
1504
class ConflictsInTree(BzrError):
 
 
1506
    _fmt = "Working tree has conflicts."
 
 
1509
class ParseConfigError(BzrError):
 
 
1511
    def __init__(self, errors, filename):
 
 
1512
        if filename is None:
 
 
1514
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
1515
            (filename, ('\n'.join(e.message for e in errors)))
 
 
1516
        BzrError.__init__(self, message)
 
 
1519
class NoEmailInUsername(BzrError):
 
 
1521
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
 
1523
    def __init__(self, username):
 
 
1524
        BzrError.__init__(self)
 
 
1525
        self.username = username
 
 
1528
class SigningFailed(BzrError):
 
 
1530
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
 
1532
    def __init__(self, command_line):
 
 
1533
        BzrError.__init__(self, command_line=command_line)
 
 
1536
class WorkingTreeNotRevision(BzrError):
 
 
1538
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
 
1539
            " the last commit, but weave merge requires that it be"
 
 
1542
    def __init__(self, tree):
 
 
1543
        BzrError.__init__(self, basedir=tree.basedir)
 
 
1546
class CantReprocessAndShowBase(BzrError):
 
 
1548
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
 
1549
           "the relationship of conflicting lines to the base")
 
 
1552
class GraphCycleError(BzrError):
 
 
1554
    _fmt = "Cycle in graph %(graph)r"
 
 
1556
    def __init__(self, graph):
 
 
1557
        BzrError.__init__(self)
 
 
1561
class WritingCompleted(BzrError):
 
 
1563
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
 
1564
            "called upon it - accept bytes may not be called anymore.")
 
 
1566
    internal_error = True
 
 
1568
    def __init__(self, request):
 
 
1569
        self.request = request
 
 
1572
class WritingNotComplete(BzrError):
 
 
1574
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
 
1575
            "called upon it - until the write phase is complete no "
 
 
1576
            "data may be read.")
 
 
1578
    internal_error = True
 
 
1580
    def __init__(self, request):
 
 
1581
        self.request = request
 
 
1584
class NotConflicted(BzrError):
 
 
1586
    _fmt = "File %(filename)s is not conflicted."
 
 
1588
    def __init__(self, filename):
 
 
1589
        BzrError.__init__(self)
 
 
1590
        self.filename = filename
 
 
1593
class MediumNotConnected(BzrError):
 
 
1595
    _fmt = """The medium '%(medium)s' is not connected."""
 
 
1597
    internal_error = True
 
 
1599
    def __init__(self, medium):
 
 
1600
        self.medium = medium
 
 
1603
class MustUseDecorated(Exception):
 
 
1605
    _fmt = "A decorating function has requested its original command be used."
 
 
1608
class NoBundleFound(BzrError):
 
 
1610
    _fmt = "No bundle was found in %(filename)s"
 
 
1612
    def __init__(self, filename):
 
 
1613
        BzrError.__init__(self)
 
 
1614
        self.filename = filename
 
 
1617
class BundleNotSupported(BzrError):
 
 
1619
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
 
1621
    def __init__(self, version, msg):
 
 
1622
        BzrError.__init__(self)
 
 
1623
        self.version = version
 
 
1627
class MissingText(BzrError):
 
 
1629
    _fmt = ("Branch %(base)s is missing revision"
 
 
1630
            " %(text_revision)s of %(file_id)s")
 
 
1632
    def __init__(self, branch, text_revision, file_id):
 
 
1633
        BzrError.__init__(self)
 
 
1634
        self.branch = branch
 
 
1635
        self.base = branch.base
 
 
1636
        self.text_revision = text_revision
 
 
1637
        self.file_id = file_id
 
 
1639
class DuplicateFileId(BzrError):
 
 
1641
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
 
1643
    def __init__(self, file_id, entry):
 
 
1644
        BzrError.__init__(self)
 
 
1645
        self.file_id = file_id
 
 
1649
class DuplicateKey(BzrError):
 
 
1651
    _fmt = "Key %(key)s is already present in map"
 
 
1654
class DuplicateHelpPrefix(BzrError):
 
 
1656
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
 
1658
    def __init__(self, prefix):
 
 
1659
        self.prefix = prefix
 
 
1662
class MalformedTransform(BzrError):
 
 
1664
    _fmt = "Tree transform is malformed %(conflicts)r"
 
 
1667
class NoFinalPath(BzrError):
 
 
1669
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
 
1670
            "file-id: %(file_id)r\n"
 
 
1671
            "root trans-id: %(root_trans_id)r\n")
 
 
1673
    def __init__(self, trans_id, transform):
 
 
1674
        self.trans_id = trans_id
 
 
1675
        self.file_id = transform.final_file_id(trans_id)
 
 
1676
        self.root_trans_id = transform.root
 
 
1679
class BzrBadParameter(BzrError):
 
 
1681
    _fmt = "Bad parameter: %(param)r"
 
 
1683
    internal_error = True
 
 
1685
    # This exception should never be thrown, but it is a base class for all
 
 
1686
    # parameter-to-function errors.
 
 
1688
    def __init__(self, param):
 
 
1689
        BzrError.__init__(self)
 
 
1693
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1695
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
 
1698
class ReusingTransform(BzrError):
 
 
1700
    _fmt = "Attempt to reuse a transform that has already been applied."
 
 
1703
class CantMoveRoot(BzrError):
 
 
1705
    _fmt = "Moving the root directory is not supported at this time"
 
 
1708
class BzrMoveFailedError(BzrError):
 
 
1710
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1712
    def __init__(self, from_path='', to_path='', extra=None):
 
 
1713
        BzrError.__init__(self)
 
 
1715
            self.extra = ': ' + str(extra)
 
 
1719
        has_from = len(from_path) > 0
 
 
1720
        has_to = len(to_path) > 0
 
 
1722
            self.from_path = osutils.splitpath(from_path)[-1]
 
 
1727
            self.to_path = osutils.splitpath(to_path)[-1]
 
 
1732
        if has_from and has_to:
 
 
1733
            self.operator = " =>"
 
 
1735
            self.from_path = "from " + from_path
 
 
1737
            self.operator = "to"
 
 
1739
            self.operator = "file"
 
 
1742
class BzrRenameFailedError(BzrMoveFailedError):
 
 
1744
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
 
1746
    def __init__(self, from_path, to_path, extra=None):
 
 
1747
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
 
1749
class BzrRemoveChangedFilesError(BzrError):
 
 
1750
    """Used when user is trying to remove changed files."""
 
 
1752
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
 
 
1753
        "Use --keep to not delete them, or --force to delete them regardless.")
 
 
1755
    def __init__(self, tree_delta):
 
 
1756
        BzrError.__init__(self)
 
 
1757
        self.changes_as_text = tree_delta.get_changes_as_text()
 
 
1758
        #self.paths_as_string = '\n'.join(changed_files)
 
 
1759
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
 
1762
class BzrBadParameterNotString(BzrBadParameter):
 
 
1764
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
 
1767
class BzrBadParameterMissing(BzrBadParameter):
 
 
1769
    _fmt = "Parameter $(param)s is required but not present."
 
 
1772
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1774
    _fmt = ("Parameter %(param)s is unicode but"
 
 
1775
            " only byte-strings are permitted.")
 
 
1778
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1780
    _fmt = "Parameter %(param)s contains a newline."
 
 
1783
class DependencyNotPresent(BzrError):
 
 
1785
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
 
1787
    def __init__(self, library, error):
 
 
1788
        BzrError.__init__(self, library=library, error=error)
 
 
1791
class ParamikoNotPresent(DependencyNotPresent):
 
 
1793
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
 
1795
    def __init__(self, error):
 
 
1796
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1799
class PointlessMerge(BzrError):
 
 
1801
    _fmt = "Nothing to merge."
 
 
1804
class UninitializableFormat(BzrError):
 
 
1806
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
 
1808
    def __init__(self, format):
 
 
1809
        BzrError.__init__(self)
 
 
1810
        self.format = format
 
 
1813
class BadConversionTarget(BzrError):
 
 
1815
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
 
1817
    def __init__(self, problem, format):
 
 
1818
        BzrError.__init__(self)
 
 
1819
        self.problem = problem
 
 
1820
        self.format = format
 
 
1823
class NoDiff(BzrError):
 
 
1825
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
 
1827
    def __init__(self, msg):
 
 
1828
        BzrError.__init__(self, msg=msg)
 
 
1831
class NoDiff3(BzrError):
 
 
1833
    _fmt = "Diff3 is not installed on this machine."
 
 
1836
class ExistingLimbo(BzrError):
 
 
1838
    _fmt = """This tree contains left-over files from a failed operation.
 
 
1839
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1840
    keep, and delete it when you are done."""
 
 
1842
    def __init__(self, limbo_dir):
 
 
1843
       BzrError.__init__(self)
 
 
1844
       self.limbo_dir = limbo_dir
 
 
1847
class ImmortalLimbo(BzrError):
 
 
1849
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
 
1850
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1851
    keep, and delete it when you are done."""
 
 
1853
    def __init__(self, limbo_dir):
 
 
1854
       BzrError.__init__(self)
 
 
1855
       self.limbo_dir = limbo_dir
 
 
1858
class OutOfDateTree(BzrError):
 
 
1860
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
 
1862
    def __init__(self, tree):
 
 
1863
        BzrError.__init__(self)
 
 
1867
class PublicBranchOutOfDate(BzrError):
 
 
1869
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
 
1872
    def __init__(self, public_location, revstring):
 
 
1873
        import bzrlib.urlutils as urlutils
 
 
1874
        public_location = urlutils.unescape_for_display(public_location,
 
 
1876
        BzrError.__init__(self, public_location=public_location,
 
 
1877
                          revstring=revstring)
 
 
1880
class MergeModifiedFormatError(BzrError):
 
 
1882
    _fmt = "Error in merge modified format"
 
 
1885
class ConflictFormatError(BzrError):
 
 
1887
    _fmt = "Format error in conflict listings"
 
 
1890
class CorruptRepository(BzrError):
 
 
1892
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
 
1893
            "Please run bzr reconcile on this repository.")
 
 
1895
    def __init__(self, repo):
 
 
1896
        BzrError.__init__(self)
 
 
1897
        self.repo_path = repo.bzrdir.root_transport.base
 
 
1900
class UpgradeRequired(BzrError):
 
 
1902
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
 
1904
    def __init__(self, path):
 
 
1905
        BzrError.__init__(self)
 
 
1909
class LocalRequiresBoundBranch(BzrError):
 
 
1911
    _fmt = "Cannot perform local-only commits on unbound branches."
 
 
1914
class MissingProgressBarFinish(BzrError):
 
 
1916
    _fmt = "A nested progress bar was not 'finished' correctly."
 
 
1919
class InvalidProgressBarType(BzrError):
 
 
1921
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
 
1922
            " is not a supported type Select one of: %(valid_types)s")
 
 
1924
    def __init__(self, bar_type, valid_types):
 
 
1925
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
1928
class UnsupportedOperation(BzrError):
 
 
1930
    _fmt = ("The method %(mname)s is not supported on"
 
 
1931
            " objects of type %(tname)s.")
 
 
1933
    def __init__(self, method, method_self):
 
 
1934
        self.method = method
 
 
1935
        self.mname = method.__name__
 
 
1936
        self.tname = type(method_self).__name__
 
 
1939
class CannotSetRevisionId(UnsupportedOperation):
 
 
1940
    """Raised when a commit is attempting to set a revision id but cant."""
 
 
1943
class NonAsciiRevisionId(UnsupportedOperation):
 
 
1944
    """Raised when a commit is attempting to set a non-ascii revision id
 
 
1949
class BinaryFile(BzrError):
 
 
1951
    _fmt = "File is binary but should be text."
 
 
1954
class IllegalPath(BzrError):
 
 
1956
    _fmt = "The path %(path)s is not permitted on this platform"
 
 
1958
    def __init__(self, path):
 
 
1959
        BzrError.__init__(self)
 
 
1963
class TestamentMismatch(BzrError):
 
 
1965
    _fmt = """Testament did not match expected value.
 
 
1966
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
 
1969
    def __init__(self, revision_id, expected, measured):
 
 
1970
        self.revision_id = revision_id
 
 
1971
        self.expected = expected
 
 
1972
        self.measured = measured
 
 
1975
class NotABundle(BzrError):
 
 
1977
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
 
1979
    def __init__(self, text):
 
 
1980
        BzrError.__init__(self)
 
 
1984
class BadBundle(BzrError): 
 
 
1986
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
 
1988
    def __init__(self, text):
 
 
1989
        BzrError.__init__(self)
 
 
1993
class MalformedHeader(BadBundle): 
 
 
1995
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
 
1998
class MalformedPatches(BadBundle): 
 
 
2000
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
 
2003
class MalformedFooter(BadBundle): 
 
 
2005
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
 
2008
class UnsupportedEOLMarker(BadBundle):
 
 
2010
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
 
2013
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
 
2014
        # but for this there is not
 
 
2015
        BzrError.__init__(self)
 
 
2018
class IncompatibleBundleFormat(BzrError):
 
 
2020
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
 
2022
    def __init__(self, bundle_format, other):
 
 
2023
        BzrError.__init__(self)
 
 
2024
        self.bundle_format = bundle_format
 
 
2028
class BadInventoryFormat(BzrError):
 
 
2030
    _fmt = "Root class for inventory serialization errors"
 
 
2033
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
2035
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
 
2037
    def __init__(self, msg):
 
 
2038
        BadInventoryFormat.__init__(self, msg=msg)
 
 
2041
class RootNotRich(BzrError):
 
 
2043
    _fmt = """This operation requires rich root data storage"""
 
 
2046
class NoSmartMedium(BzrError):
 
 
2048
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
 
2050
    internal_error = True
 
 
2052
    def __init__(self, transport):
 
 
2053
        self.transport = transport
 
 
2056
class NoSmartServer(NotBranchError):
 
 
2058
    _fmt = "No smart server available at %(url)s"
 
 
2060
    def __init__(self, url):
 
 
2064
class UnknownSSH(BzrError):
 
 
2066
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
 
2068
    def __init__(self, vendor):
 
 
2069
        BzrError.__init__(self)
 
 
2070
        self.vendor = vendor
 
 
2073
class SSHVendorNotFound(BzrError):
 
 
2075
    _fmt = ("Don't know how to handle SSH connections."
 
 
2076
            " Please set BZR_SSH environment variable.")
 
 
2079
class GhostRevisionUnusableHere(BzrError):
 
 
2081
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
 
2083
    def __init__(self, revision_id):
 
 
2084
        BzrError.__init__(self)
 
 
2085
        self.revision_id = revision_id
 
 
2088
class IllegalUseOfScopeReplacer(BzrError):
 
 
2090
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
 
2091
            " %(msg)s%(extra)s")
 
 
2093
    internal_error = True
 
 
2095
    def __init__(self, name, msg, extra=None):
 
 
2096
        BzrError.__init__(self)
 
 
2100
            self.extra = ': ' + str(extra)
 
 
2105
class InvalidImportLine(BzrError):
 
 
2107
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
 
2109
    internal_error = True
 
 
2111
    def __init__(self, text, msg):
 
 
2112
        BzrError.__init__(self)
 
 
2117
class ImportNameCollision(BzrError):
 
 
2119
    _fmt = ("Tried to import an object to the same name as"
 
 
2120
            " an existing object. %(name)s")
 
 
2122
    internal_error = True
 
 
2124
    def __init__(self, name):
 
 
2125
        BzrError.__init__(self)
 
 
2129
class NotAMergeDirective(BzrError):
 
 
2130
    """File starting with %(firstline)r is not a merge directive"""
 
 
2131
    def __init__(self, firstline):
 
 
2132
        BzrError.__init__(self, firstline=firstline)
 
 
2135
class NoMergeSource(BzrError):
 
 
2136
    """Raise if no merge source was specified for a merge directive"""
 
 
2138
    _fmt = "A merge directive must provide either a bundle or a public"\
 
 
2142
class IllegalMergeDirectivePayload(BzrError):
 
 
2143
    """A merge directive contained something other than a patch or bundle"""
 
 
2145
    _fmt = "Bad merge directive payload %(start)r"
 
 
2147
    def __init__(self, start):
 
 
2152
class PatchVerificationFailed(BzrError):
 
 
2153
    """A patch from a merge directive could not be verified"""
 
 
2155
    _fmt = "Preview patch does not match requested changes."
 
 
2158
class PatchMissing(BzrError):
 
 
2159
    """Raise a patch type was specified but no patch supplied"""
 
 
2161
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
 
2163
    def __init__(self, patch_type):
 
 
2164
        BzrError.__init__(self)
 
 
2165
        self.patch_type = patch_type
 
 
2168
class UnsupportedInventoryKind(BzrError):
 
 
2170
    _fmt = """Unsupported entry kind %(kind)s"""
 
 
2172
    def __init__(self, kind):
 
 
2176
class BadSubsumeSource(BzrError):
 
 
2178
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
 
 
2180
    def __init__(self, tree, other_tree, reason):
 
 
2182
        self.other_tree = other_tree
 
 
2183
        self.reason = reason
 
 
2186
class SubsumeTargetNeedsUpgrade(BzrError):
 
 
2188
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
 
2190
    def __init__(self, other_tree):
 
 
2191
        self.other_tree = other_tree
 
 
2194
class BadReferenceTarget(BzrError):
 
 
2196
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
 
2198
    internal_error = True
 
 
2200
    def __init__(self, tree, other_tree, reason):
 
 
2202
        self.other_tree = other_tree
 
 
2203
        self.reason = reason
 
 
2206
class NoSuchTag(BzrError):
 
 
2208
    _fmt = "No such tag: %(tag_name)s"
 
 
2210
    def __init__(self, tag_name):
 
 
2211
        self.tag_name = tag_name
 
 
2214
class TagsNotSupported(BzrError):
 
 
2216
    _fmt = ("Tags not supported by %(branch)s;"
 
 
2217
            " you may be able to use bzr upgrade --dirstate-tags.")
 
 
2219
    def __init__(self, branch):
 
 
2220
        self.branch = branch
 
 
2223
class TagAlreadyExists(BzrError):
 
 
2225
    _fmt = "Tag %(tag_name)s already exists."
 
 
2227
    def __init__(self, tag_name):
 
 
2228
        self.tag_name = tag_name
 
 
2231
class MalformedBugIdentifier(BzrError):
 
 
2233
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
 
2235
    def __init__(self, bug_id, reason):
 
 
2236
        self.bug_id = bug_id
 
 
2237
        self.reason = reason
 
 
2240
class UnknownBugTrackerAbbreviation(BzrError):
 
 
2242
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
 
2245
    def __init__(self, abbreviation, branch):
 
 
2246
        self.abbreviation = abbreviation
 
 
2247
        self.branch = branch
 
 
2250
class UnexpectedSmartServerResponse(BzrError):
 
 
2252
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
 
2254
    def __init__(self, response_tuple):
 
 
2255
        self.response_tuple = response_tuple
 
 
2258
class ContainerError(BzrError):
 
 
2259
    """Base class of container errors."""
 
 
2262
class UnknownContainerFormatError(ContainerError):
 
 
2264
    _fmt = "Unrecognised container format: %(container_format)r"
 
 
2266
    def __init__(self, container_format):
 
 
2267
        self.container_format = container_format
 
 
2270
class UnexpectedEndOfContainerError(ContainerError):
 
 
2272
    _fmt = "Unexpected end of container stream"
 
 
2274
    internal_error = False
 
 
2277
class UnknownRecordTypeError(ContainerError):
 
 
2279
    _fmt = "Unknown record type: %(record_type)r"
 
 
2281
    def __init__(self, record_type):
 
 
2282
        self.record_type = record_type
 
 
2285
class InvalidRecordError(ContainerError):
 
 
2287
    _fmt = "Invalid record: %(reason)s"
 
 
2289
    def __init__(self, reason):
 
 
2290
        self.reason = reason
 
 
2293
class ContainerHasExcessDataError(ContainerError):
 
 
2295
    _fmt = "Container has data after end marker: %(excess)r"
 
 
2297
    def __init__(self, excess):
 
 
2298
        self.excess = excess
 
 
2301
class DuplicateRecordNameError(ContainerError):
 
 
2303
    _fmt = "Container has multiple records with the same name: \"%(name)s\""
 
 
2305
    def __init__(self, name):
 
 
2309
class NoDestinationAddress(BzrError):
 
 
2311
    _fmt = "Message does not have a destination address."
 
 
2313
    internal_error = True
 
 
2316
class SMTPError(BzrError):
 
 
2318
    _fmt = "SMTP error: %(error)s"
 
 
2320
    def __init__(self, error):
 
 
2324
class NoMessageSupplied(BzrError):
 
 
2326
    _fmt = "No message supplied."
 
 
2329
class UnknownMailClient(BzrError):
 
 
2331
    _fmt = "Unknown mail client: %(mail_client)s"
 
 
2333
    def __init__(self, mail_client):
 
 
2334
        BzrError.__init__(self, mail_client=mail_client)
 
 
2337
class MailClientNotFound(BzrError):
 
 
2339
    _fmt = "Unable to find mail client with the following names:"\
 
 
2340
        " %(mail_command_list_string)s"
 
 
2342
    def __init__(self, mail_command_list):
 
 
2343
        mail_command_list_string = ', '.join(mail_command_list)
 
 
2344
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
 
2345
                          mail_command_list_string=mail_command_list_string)
 
 
2347
class SMTPConnectionRefused(SMTPError):
 
 
2349
    _fmt = "SMTP connection to %(host)s refused"
 
 
2351
    def __init__(self, error, host):
 
 
2356
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
 
2358
    _fmt = "Please specify smtp_server.  No server at default %(host)s."