1
# Copyright (C) 2005, 2006 Canonical
 
 
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.
 
 
19
There are 3 different classes of error:
 
 
21
 * KeyboardInterrupt, and OSError with EPIPE - the program terminates 
 
 
22
   with an appropriate short message
 
 
24
 * User errors, indicating a problem caused by the user such as a bad URL.
 
 
25
   These are printed in a short form.
 
 
27
 * Internal unexpected errors, including most Python builtin errors
 
 
28
   and some raised from inside bzr.  These are printed with a full 
 
 
29
   traceback and an invitation to report the bug.
 
 
31
Exceptions are caught at a high level to report errors to the user, and
 
 
32
might also be caught inside the program.  Therefore it needs to be
 
 
33
possible to convert them to a meaningful string, and also for them to be
 
 
34
interrogated by the program.
 
 
36
Exceptions are defined such that the arguments given to the constructor
 
 
37
are stored in the object as properties of the same name.  When the
 
 
38
object is printed as a string, the doc string of the class is used as
 
 
39
a format string with the property dictionary available to it.
 
 
41
This means that exceptions can used like this:
 
 
45
...   raise NotBranchError(path='/foo/bar')
 
 
47
...   print '%s.%s' % (sys.exc_type.__module__, sys.exc_type.__name__)
 
 
48
...   print sys.exc_value
 
 
49
...   path = getattr(sys.exc_value, 'path', None)
 
 
50
...   if path is not None:
 
 
52
bzrlib.errors.NotBranchError
 
 
53
Not a branch: /foo/bar
 
 
58
 * create a new exception class for any class of error that can be
 
 
59
   usefully distinguished.  If no callers are likely to want to catch
 
 
60
   one but not another, don't worry about them.
 
 
62
 * the __str__ method should generate something useful; BzrError provides
 
 
63
   a good default implementation
 
 
65
Exception strings should start with a capital letter and should not have a
 
 
69
from warnings import warn
 
 
71
from bzrlib.patches import (PatchSyntax, 
 
 
78
# based on Scott James Remnant's hct error classes
 
 
80
# TODO: is there any value in providing the .args field used by standard
 
 
81
# python exceptions?   A list of values with no names seems less useful 
 
 
84
# TODO: Perhaps convert the exception to a string at the moment it's 
 
 
85
# constructed to make sure it will succeed.  But that says nothing about
 
 
86
# exceptions that are never raised.
 
 
88
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
 
 
91
# TODO: The pattern (from hct) of using classes docstrings as message
 
 
92
# templates is cute but maybe not such a great idea - perhaps should have a
 
 
93
# separate static message_template.
 
 
96
class BzrError(StandardError):
 
 
101
        # XXX: Should we show the exception class in 
 
 
102
        # exceptions that don't provide their own message?  
 
 
103
        # maybe it should be done at a higher level
 
 
104
        ## n = self.__class__.__name__ + ': '
 
 
106
        if len(self.args) == 1:
 
 
107
            return str(self.args[0])
 
 
108
        elif len(self.args) == 2:
 
 
109
            # further explanation or suggestions
 
 
111
                return n + '\n  '.join([self.args[0]] + self.args[1])
 
 
113
                return n + "%r" % self
 
 
115
            return n + `self.args`
 
 
118
class BzrNewError(BzrError):
 
 
120
    # base classes should override the docstring with their human-
 
 
121
    # readable explanation
 
 
123
    def __init__(self, *args, **kwds):
 
 
124
        # XXX: Use the underlying BzrError to always generate the args attribute
 
 
125
        # if it doesn't exist.  We can't use super here, because exceptions are
 
 
126
        # old-style classes in python2.4 (but new in 2.5).  --bmc, 20060426
 
 
127
        BzrError.__init__(self, *args)
 
 
128
        for key, value in kwds.items():
 
 
129
            setattr(self, key, value)
 
 
133
            # __str__() should always return a 'str' object
 
 
134
            # never a 'unicode' object.
 
 
135
            s = self.__doc__ % self.__dict__
 
 
136
            if isinstance(s, unicode):
 
 
137
                return s.encode('utf8')
 
 
139
        except (TypeError, NameError, ValueError, KeyError), e:
 
 
140
            return 'Unprintable exception %s(%r): %s' \
 
 
141
                % (self.__class__.__name__,
 
 
142
                   self.__dict__, str(e))
 
 
145
class AlreadyBuilding(BzrNewError):
 
 
146
    """The tree builder is already building a tree."""
 
 
149
class BzrCheckError(BzrNewError):
 
 
150
    """Internal check failed: %(message)s"""
 
 
152
    is_user_error = False
 
 
154
    def __init__(self, message):
 
 
155
        BzrNewError.__init__(self)
 
 
156
        self.message = message
 
 
159
class InvalidEntryName(BzrNewError):
 
 
160
    """Invalid entry name: %(name)s"""
 
 
162
    is_user_error = False
 
 
164
    def __init__(self, name):
 
 
165
        BzrNewError.__init__(self)
 
 
169
class InvalidRevisionNumber(BzrNewError):
 
 
170
    """Invalid revision number %(revno)d"""
 
 
171
    def __init__(self, revno):
 
 
172
        BzrNewError.__init__(self)
 
 
176
class InvalidRevisionId(BzrNewError):
 
 
177
    """Invalid revision-id {%(revision_id)s} in %(branch)s"""
 
 
179
    def __init__(self, revision_id, branch):
 
 
180
        # branch can be any string or object with __str__ defined
 
 
181
        BzrNewError.__init__(self)
 
 
182
        self.revision_id = revision_id
 
 
186
class NoSuchId(BzrNewError):
 
 
187
    """The file id %(file_id)s is not present in the tree %(tree)s."""
 
 
189
    def __init__(self, tree, file_id):
 
 
190
        BzrNewError.__init__(self)
 
 
191
        self.file_id = file_id
 
 
195
class NoWorkingTree(BzrNewError):
 
 
196
    """No WorkingTree exists for %(base)s."""
 
 
198
    def __init__(self, base):
 
 
199
        BzrNewError.__init__(self)
 
 
203
class NotBuilding(BzrNewError):
 
 
204
    """Not currently building a tree."""
 
 
207
class NotLocalUrl(BzrNewError):
 
 
208
    """%(url)s is not a local path."""
 
 
210
    def __init__(self, url):
 
 
211
        BzrNewError.__init__(self)
 
 
215
class BzrCommandError(BzrNewError):
 
 
216
    """Error from user command"""
 
 
220
    # Error from malformed user command; please avoid raising this as a
 
 
221
    # generic exception not caused by user input.
 
 
223
    # I think it's a waste of effort to differentiate between errors that
 
 
224
    # are not intended to be caught anyway.  UI code need not subclass
 
 
225
    # BzrCommandError, and non-UI code should not throw a subclass of
 
 
226
    # BzrCommandError.  ADHB 20051211
 
 
227
    def __init__(self, msg):
 
 
228
        # Object.__str__() must return a real string
 
 
229
        # returning a Unicode string is a python error.
 
 
230
        if isinstance(msg, unicode):
 
 
231
            self.msg = msg.encode('utf8')
 
 
239
class BzrOptionError(BzrCommandError):
 
 
240
    """Error in command line options"""
 
 
243
class StrictCommitFailed(BzrNewError):
 
 
244
    """Commit refused because there are unknown files in the tree"""
 
 
247
# XXX: Should be unified with TransportError; they seem to represent the
 
 
249
class PathError(BzrNewError):
 
 
250
    """Generic path error: %(path)r%(extra)s)"""
 
 
252
    def __init__(self, path, extra=None):
 
 
253
        BzrNewError.__init__(self)
 
 
256
            self.extra = ': ' + str(extra)
 
 
261
class NoSuchFile(PathError):
 
 
262
    """No such file: %(path)r%(extra)s"""
 
 
265
class FileExists(PathError):
 
 
266
    """File exists: %(path)r%(extra)s"""
 
 
269
class DirectoryNotEmpty(PathError):
 
 
270
    """Directory not empty: %(path)r%(extra)s"""
 
 
273
class ResourceBusy(PathError):
 
 
274
    """Device or resource busy: %(path)r%(extra)s"""
 
 
277
class PermissionDenied(PathError):
 
 
278
    """Permission denied: %(path)r%(extra)s"""
 
 
281
class InvalidURL(PathError):
 
 
282
    """Invalid url supplied to transport: %(path)r%(extra)s"""
 
 
285
class InvalidURLJoin(PathError):
 
 
286
    """Invalid URL join request: %(args)s%(extra)s"""
 
 
288
    def __init__(self, msg, base, args):
 
 
289
        PathError.__init__(self, base, msg)
 
 
290
        self.args = [base] + list(args)
 
 
293
class UnsupportedProtocol(PathError):
 
 
294
    """Unsupported protocol for url "%(path)s"%(extra)s"""
 
 
296
    def __init__(self, url, extra):
 
 
297
        PathError.__init__(self, url, extra=extra)
 
 
300
class ShortReadvError(PathError):
 
 
301
    """readv() read %(actual)s bytes rather than %(length)s bytes at %(offset)s for %(path)s%(extra)s"""
 
 
303
    is_user_error = False
 
 
305
    def __init__(self, path, offset, length, actual, extra=None):
 
 
306
        PathError.__init__(self, path, extra=extra)
 
 
312
class PathNotChild(BzrNewError):
 
 
313
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
 
 
315
    is_user_error = False
 
 
317
    def __init__(self, path, base, extra=None):
 
 
318
        BzrNewError.__init__(self)
 
 
322
            self.extra = ': ' + str(extra)
 
 
327
class InvalidNormalization(PathError):
 
 
328
    """Path %(path)r is not unicode normalized"""
 
 
331
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
332
# the exception object is a bit undesirable.
 
 
333
# TODO: Probably this behavior of should be a common superclass 
 
 
334
class NotBranchError(PathError):
 
 
335
    """Not a branch: %(path)s"""
 
 
337
    def __init__(self, path):
 
 
338
       import bzrlib.urlutils as urlutils
 
 
339
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
342
class AlreadyBranchError(PathError):
 
 
343
    """Already a branch: %(path)s."""
 
 
346
class BranchExistsWithoutWorkingTree(PathError):
 
 
347
    """Directory contains a branch, but no working tree \
 
 
348
(use bzr checkout if you wish to build a working tree): %(path)s"""
 
 
351
class AtomicFileAlreadyClosed(PathError):
 
 
352
    """'%(function)s' called on an AtomicFile after it was closed: %(path)s"""
 
 
354
    def __init__(self, path, function):
 
 
355
        PathError.__init__(self, path=path, extra=None)
 
 
356
        self.function = function
 
 
359
class InaccessibleParent(PathError):
 
 
360
    """Parent not accessible given base %(base)s and relative path %(path)s"""
 
 
362
    def __init__(self, path, base):
 
 
363
        PathError.__init__(self, path)
 
 
367
class NoRepositoryPresent(BzrNewError):
 
 
368
    """No repository present: %(path)r"""
 
 
369
    def __init__(self, bzrdir):
 
 
370
        BzrNewError.__init__(self)
 
 
371
        self.path = bzrdir.transport.clone('..').base
 
 
374
class FileInWrongBranch(BzrNewError):
 
 
375
    """File %(path)s in not in branch %(branch_base)s."""
 
 
377
    def __init__(self, branch, path):
 
 
378
        BzrNewError.__init__(self)
 
 
380
        self.branch_base = branch.base
 
 
384
class UnsupportedFormatError(BzrNewError):
 
 
385
    """Unsupported branch format: %(format)s"""
 
 
388
class UnknownFormatError(BzrNewError):
 
 
389
    """Unknown branch format: %(format)r"""
 
 
392
class IncompatibleFormat(BzrNewError):
 
 
393
    """Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
 
 
395
    def __init__(self, format, bzrdir_format):
 
 
396
        BzrNewError.__init__(self)
 
 
398
        self.bzrdir = bzrdir_format
 
 
401
class NotVersionedError(BzrNewError):
 
 
402
    """%(path)s is not versioned"""
 
 
403
    def __init__(self, path):
 
 
404
        BzrNewError.__init__(self)
 
 
408
class PathsNotVersionedError(BzrNewError):
 
 
409
    # used when reporting several paths are not versioned
 
 
410
    """Path(s) are not versioned: %(paths_as_string)s"""
 
 
412
    def __init__(self, paths):
 
 
413
        from bzrlib.osutils import quotefn
 
 
414
        BzrNewError.__init__(self)
 
 
416
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
419
class PathsDoNotExist(BzrNewError):
 
 
420
    """Path(s) do not exist: %(paths_as_string)s"""
 
 
422
    # used when reporting that paths are neither versioned nor in the working
 
 
425
    def __init__(self, paths):
 
 
427
        from bzrlib.osutils import quotefn
 
 
428
        BzrNewError.__init__(self)
 
 
430
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
433
class BadFileKindError(BzrNewError):
 
 
434
    """Cannot operate on %(filename)s of unsupported kind %(kind)s"""
 
 
437
class ForbiddenControlFileError(BzrNewError):
 
 
438
    """Cannot operate on %(filename)s because it is a control file"""
 
 
441
class LockError(BzrNewError):
 
 
442
    """Lock error: %(message)s"""
 
 
443
    # All exceptions from the lock/unlock functions should be from
 
 
444
    # this exception class.  They will be translated as necessary. The
 
 
445
    # original exception is available as e.original_error
 
 
447
    # New code should prefer to raise specific subclasses
 
 
448
    def __init__(self, message):
 
 
449
        self.message = message
 
 
452
class CommitNotPossible(LockError):
 
 
453
    """A commit was attempted but we do not have a write lock open."""
 
 
458
class AlreadyCommitted(LockError):
 
 
459
    """A rollback was requested, but is not able to be accomplished."""
 
 
464
class ReadOnlyError(LockError):
 
 
465
    """A write attempt was made in a read only transaction on %(obj)s"""
 
 
466
    def __init__(self, obj):
 
 
470
class OutSideTransaction(BzrNewError):
 
 
471
    """A transaction related operation was attempted after the transaction finished."""
 
 
474
class ObjectNotLocked(LockError):
 
 
475
    """%(obj)r is not locked"""
 
 
477
    is_user_error = False
 
 
479
    # this can indicate that any particular object is not locked; see also
 
 
480
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
481
    # the caller -- perhaps they should be unified.
 
 
482
    def __init__(self, obj):
 
 
486
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
487
    """Cannot change object %(obj)r in read only transaction"""
 
 
488
    def __init__(self, obj):
 
 
492
class UnlockableTransport(LockError):
 
 
493
    """Cannot lock: transport is read only: %(transport)s"""
 
 
494
    def __init__(self, transport):
 
 
495
        self.transport = transport
 
 
498
class LockContention(LockError):
 
 
499
    """Could not acquire lock %(lock)s"""
 
 
500
    # TODO: show full url for lock, combining the transport and relative bits?
 
 
501
    def __init__(self, lock):
 
 
505
class LockBroken(LockError):
 
 
506
    """Lock was broken while still open: %(lock)s - check storage consistency!"""
 
 
507
    def __init__(self, lock):
 
 
511
class LockBreakMismatch(LockError):
 
 
512
    """Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
 
 
513
    def __init__(self, lock, holder, target):
 
 
519
class LockNotHeld(LockError):
 
 
520
    """Lock not held: %(lock)s"""
 
 
521
    def __init__(self, lock):
 
 
525
class PointlessCommit(BzrNewError):
 
 
526
    """No changes to commit"""
 
 
529
class UpgradeReadonly(BzrNewError):
 
 
530
    """Upgrade URL cannot work with readonly URL's."""
 
 
533
class UpToDateFormat(BzrNewError):
 
 
534
    """The branch format %(format)s is already at the most recent format."""
 
 
536
    def __init__(self, format):
 
 
537
        BzrNewError.__init__(self)
 
 
541
class StrictCommitFailed(Exception):
 
 
542
    """Commit refused because there are unknowns in the tree."""
 
 
545
class NoSuchRevision(BzrNewError):
 
 
546
    """Branch %(branch)s has no revision %(revision)s"""
 
 
548
    is_user_error = False
 
 
550
    def __init__(self, branch, revision):
 
 
551
        BzrNewError.__init__(self, branch=branch, revision=revision)
 
 
554
class NoSuchRevisionSpec(BzrNewError):
 
 
555
    """No namespace registered for string: %(spec)r"""
 
 
557
    def __init__(self, spec):
 
 
558
        BzrNewError.__init__(self, spec=spec)
 
 
561
class InvalidRevisionSpec(BzrNewError):
 
 
562
    """Requested revision: '%(spec)s' does not exist in branch:
 
 
563
%(branch)s%(extra)s"""
 
 
565
    def __init__(self, spec, branch, extra=None):
 
 
566
        BzrNewError.__init__(self, branch=branch, spec=spec)
 
 
568
            self.extra = '\n' + str(extra)
 
 
573
class HistoryMissing(BzrError):
 
 
574
    def __init__(self, branch, object_type, object_id):
 
 
576
        BzrError.__init__(self,
 
 
577
                          '%s is missing %s {%s}'
 
 
578
                          % (branch, object_type, object_id))
 
 
581
class DivergedBranches(BzrNewError):
 
 
582
    "These branches have diverged.  Use the merge command to reconcile them."""
 
 
586
    def __init__(self, branch1, branch2):
 
 
587
        self.branch1 = branch1
 
 
588
        self.branch2 = branch2
 
 
591
class UnrelatedBranches(BzrNewError):
 
 
592
    "Branches have no common ancestor, and no merge base revision was specified."
 
 
597
class NoCommonAncestor(BzrNewError):
 
 
598
    "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
600
    def __init__(self, revision_a, revision_b):
 
 
601
        self.revision_a = revision_a
 
 
602
        self.revision_b = revision_b
 
 
605
class NoCommonRoot(BzrError):
 
 
606
    def __init__(self, revision_a, revision_b):
 
 
607
        msg = "Revisions are not derived from the same root: %s %s." \
 
 
608
            % (revision_a, revision_b) 
 
 
609
        BzrError.__init__(self, msg)
 
 
613
class NotAncestor(BzrError):
 
 
614
    def __init__(self, rev_id, not_ancestor_id):
 
 
615
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
 
617
        BzrError.__init__(self, msg)
 
 
619
        self.not_ancestor_id = not_ancestor_id
 
 
622
class InstallFailed(BzrError):
 
 
623
    def __init__(self, revisions):
 
 
624
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
 
 
625
        BzrError.__init__(self, msg)
 
 
626
        self.revisions = revisions
 
 
629
class AmbiguousBase(BzrError):
 
 
630
    def __init__(self, bases):
 
 
631
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
633
        msg = "The correct base is unclear, because %s are all equally close" %\
 
 
635
        BzrError.__init__(self, msg)
 
 
639
class NoCommits(BzrNewError):
 
 
640
    """Branch %(branch)s has no commits."""
 
 
642
    def __init__(self, branch):
 
 
643
        BzrNewError.__init__(self, branch=branch)
 
 
646
class UnlistableStore(BzrError):
 
 
647
    def __init__(self, store):
 
 
648
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
652
class UnlistableBranch(BzrError):
 
 
653
    def __init__(self, br):
 
 
654
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
657
class BoundBranchOutOfDate(BzrNewError):
 
 
658
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
 
 
659
    def __init__(self, branch, master):
 
 
660
        BzrNewError.__init__(self)
 
 
665
class CommitToDoubleBoundBranch(BzrNewError):
 
 
666
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
 
 
667
    def __init__(self, branch, master, remote):
 
 
668
        BzrNewError.__init__(self)
 
 
674
class OverwriteBoundBranch(BzrNewError):
 
 
675
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
 
 
676
    def __init__(self, branch):
 
 
677
        BzrNewError.__init__(self)
 
 
681
class BoundBranchConnectionFailure(BzrNewError):
 
 
682
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
 
 
683
    def __init__(self, branch, target, error):
 
 
684
        BzrNewError.__init__(self)
 
 
690
class WeaveError(BzrNewError):
 
 
691
    """Error in processing weave: %(message)s"""
 
 
693
    def __init__(self, message=None):
 
 
694
        BzrNewError.__init__(self)
 
 
695
        self.message = message
 
 
698
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
699
    """Revision {%(revision_id)s} already present in %(weave)s"""
 
 
700
    def __init__(self, revision_id, weave):
 
 
702
        WeaveError.__init__(self)
 
 
703
        self.revision_id = revision_id
 
 
707
class WeaveRevisionNotPresent(WeaveError):
 
 
708
    """Revision {%(revision_id)s} not present in %(weave)s"""
 
 
710
    def __init__(self, revision_id, weave):
 
 
711
        WeaveError.__init__(self)
 
 
712
        self.revision_id = revision_id
 
 
716
class WeaveFormatError(WeaveError):
 
 
717
    """Weave invariant violated: %(what)s"""
 
 
719
    def __init__(self, what):
 
 
720
        WeaveError.__init__(self)
 
 
724
class WeaveParentMismatch(WeaveError):
 
 
725
    """Parents are mismatched between two revisions."""
 
 
728
class WeaveInvalidChecksum(WeaveError):
 
 
729
    """Text did not match it's checksum: %(message)s"""
 
 
732
class WeaveTextDiffers(WeaveError):
 
 
733
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
 
735
    def __init__(self, revision_id, weave_a, weave_b):
 
 
736
        WeaveError.__init__(self)
 
 
737
        self.revision_id = revision_id
 
 
738
        self.weave_a = weave_a
 
 
739
        self.weave_b = weave_b
 
 
742
class WeaveTextDiffers(WeaveError):
 
 
743
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
 
745
    def __init__(self, revision_id, weave_a, weave_b):
 
 
746
        WeaveError.__init__(self)
 
 
747
        self.revision_id = revision_id
 
 
748
        self.weave_a = weave_a
 
 
749
        self.weave_b = weave_b
 
 
752
class VersionedFileError(BzrNewError):
 
 
753
    """Versioned file error."""
 
 
756
class RevisionNotPresent(VersionedFileError):
 
 
757
    """Revision {%(revision_id)s} not present in %(file_id)s."""
 
 
759
    def __init__(self, revision_id, file_id):
 
 
760
        VersionedFileError.__init__(self)
 
 
761
        self.revision_id = revision_id
 
 
762
        self.file_id = file_id
 
 
765
class RevisionAlreadyPresent(VersionedFileError):
 
 
766
    """Revision {%(revision_id)s} already present in %(file_id)s."""
 
 
768
    def __init__(self, revision_id, file_id):
 
 
769
        VersionedFileError.__init__(self)
 
 
770
        self.revision_id = revision_id
 
 
771
        self.file_id = file_id
 
 
774
class KnitError(BzrNewError):
 
 
778
class KnitHeaderError(KnitError):
 
 
779
    """Knit header error: %(badline)r unexpected"""
 
 
781
    def __init__(self, badline):
 
 
782
        KnitError.__init__(self)
 
 
783
        self.badline = badline
 
 
786
class KnitCorrupt(KnitError):
 
 
787
    """Knit %(filename)s corrupt: %(how)s"""
 
 
789
    def __init__(self, filename, how):
 
 
790
        KnitError.__init__(self)
 
 
791
        self.filename = filename
 
 
795
class NoSuchExportFormat(BzrNewError):
 
 
796
    """Export format %(format)r not supported"""
 
 
797
    def __init__(self, format):
 
 
798
        BzrNewError.__init__(self)
 
 
802
class TransportError(BzrNewError):
 
 
803
    """Transport error: %(msg)s %(orig_error)s"""
 
 
805
    def __init__(self, msg=None, orig_error=None):
 
 
806
        if msg is None and orig_error is not None:
 
 
807
            msg = str(orig_error)
 
 
808
        if orig_error is None:
 
 
813
        self.orig_error = orig_error
 
 
814
        BzrNewError.__init__(self)
 
 
817
class SmartProtocolError(TransportError):
 
 
818
    """Generic bzr smart protocol error: %(details)s"""
 
 
820
    def __init__(self, details):
 
 
821
        self.details = details
 
 
824
# A set of semi-meaningful errors which can be thrown
 
 
825
class TransportNotPossible(TransportError):
 
 
826
    """Transport operation not possible: %(msg)s %(orig_error)%"""
 
 
829
class ConnectionError(TransportError):
 
 
830
    """Connection error: %(msg)s %(orig_error)s"""
 
 
833
class ConnectionReset(TransportError):
 
 
834
    """Connection closed: %(msg)s %(orig_error)s"""
 
 
837
class InvalidRange(TransportError):
 
 
838
    """Invalid range access in %(path)s at %(offset)s."""
 
 
840
    def __init__(self, path, offset):
 
 
841
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
 
847
class InvalidHttpResponse(TransportError):
 
 
848
    """Invalid http response for %(path)s: %(msg)s"""
 
 
850
    def __init__(self, path, msg, orig_error=None):
 
 
852
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
855
class InvalidHttpRange(InvalidHttpResponse):
 
 
856
    """Invalid http range "%(range)s" for %(path)s: %(msg)s"""
 
 
858
    def __init__(self, path, range, msg):
 
 
860
        InvalidHttpResponse.__init__(self, path, msg)
 
 
863
class InvalidHttpContentType(InvalidHttpResponse):
 
 
864
    """Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
 
 
866
    def __init__(self, path, ctype, msg):
 
 
868
        InvalidHttpResponse.__init__(self, path, msg)
 
 
871
class ConflictsInTree(BzrError):
 
 
873
        BzrError.__init__(self, "Working tree has conflicts.")
 
 
876
class ParseConfigError(BzrError):
 
 
877
    def __init__(self, errors, filename):
 
 
880
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
881
            (filename, ('\n'.join(e.message for e in errors)))
 
 
882
        BzrError.__init__(self, message)
 
 
885
class SigningFailed(BzrError):
 
 
886
    def __init__(self, command_line):
 
 
887
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
 
 
891
class WorkingTreeNotRevision(BzrError):
 
 
892
    def __init__(self, tree):
 
 
893
        BzrError.__init__(self, "The working tree for %s has changed since"
 
 
894
                          " last commit, but weave merge requires that it be"
 
 
895
                          " unchanged." % tree.basedir)
 
 
898
class CantReprocessAndShowBase(BzrNewError):
 
 
899
    """Can't reprocess and show base.
 
 
900
Reprocessing obscures relationship of conflicting lines to base."""
 
 
903
class GraphCycleError(BzrNewError):
 
 
904
    """Cycle in graph %(graph)r"""
 
 
905
    def __init__(self, graph):
 
 
906
        BzrNewError.__init__(self)
 
 
910
class NotConflicted(BzrNewError):
 
 
911
    """File %(filename)s is not conflicted."""
 
 
913
    def __init__(self, filename):
 
 
914
        BzrNewError.__init__(self)
 
 
915
        self.filename = filename
 
 
918
class MustUseDecorated(Exception):
 
 
919
    """A decorating function has requested its original command be used.
 
 
921
    This should never escape bzr, so does not need to be printable.
 
 
925
class NoBundleFound(BzrNewError):
 
 
926
    """No bundle was found in %(filename)s"""
 
 
927
    def __init__(self, filename):
 
 
928
        BzrNewError.__init__(self)
 
 
929
        self.filename = filename
 
 
932
class BundleNotSupported(BzrNewError):
 
 
933
    """Unable to handle bundle version %(version)s: %(msg)s"""
 
 
934
    def __init__(self, version, msg):
 
 
935
        BzrNewError.__init__(self)
 
 
936
        self.version = version
 
 
940
class MissingText(BzrNewError):
 
 
941
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
 
 
943
    def __init__(self, branch, text_revision, file_id):
 
 
944
        BzrNewError.__init__(self)
 
 
946
        self.base = branch.base
 
 
947
        self.text_revision = text_revision
 
 
948
        self.file_id = file_id
 
 
951
class DuplicateKey(BzrNewError):
 
 
952
    """Key %(key)s is already present in map"""
 
 
955
class MalformedTransform(BzrNewError):
 
 
956
    """Tree transform is malformed %(conflicts)r"""
 
 
959
class BzrBadParameter(BzrNewError):
 
 
960
    """A bad parameter : %(param)s is not usable.
 
 
962
    This exception should never be thrown, but it is a base class for all
 
 
963
    parameter-to-function errors.
 
 
965
    def __init__(self, param):
 
 
966
        BzrNewError.__init__(self)
 
 
970
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
971
    """Parameter %(param)s is neither unicode nor utf8."""
 
 
974
class ReusingTransform(BzrNewError):
 
 
975
    """Attempt to reuse a transform that has already been applied."""
 
 
978
class CantMoveRoot(BzrNewError):
 
 
979
    """Moving the root directory is not supported at this time"""
 
 
982
class BzrBadParameterNotString(BzrBadParameter):
 
 
983
    """Parameter %(param)s is not a string or unicode string."""
 
 
986
class BzrBadParameterMissing(BzrBadParameter):
 
 
987
    """Parameter $(param)s is required but not present."""
 
 
990
class BzrBadParameterUnicode(BzrBadParameter):
 
 
991
    """Parameter %(param)s is unicode but only byte-strings are permitted."""
 
 
994
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
995
    """Parameter %(param)s contains a newline."""
 
 
998
class DependencyNotPresent(BzrNewError):
 
 
999
    """Unable to import library "%(library)s": %(error)s"""
 
 
1001
    def __init__(self, library, error):
 
 
1002
        BzrNewError.__init__(self, library=library, error=error)
 
 
1005
class ParamikoNotPresent(DependencyNotPresent):
 
 
1006
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
 
1008
    def __init__(self, error):
 
 
1009
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1012
class PointlessMerge(BzrNewError):
 
 
1013
    """Nothing to merge."""
 
 
1016
class UninitializableFormat(BzrNewError):
 
 
1017
    """Format %(format)s cannot be initialised by this version of bzr."""
 
 
1019
    def __init__(self, format):
 
 
1020
        BzrNewError.__init__(self)
 
 
1021
        self.format = format
 
 
1024
class BadConversionTarget(BzrNewError):
 
 
1025
    """Cannot convert to format %(format)s.  %(problem)s"""
 
 
1027
    def __init__(self, problem, format):
 
 
1028
        BzrNewError.__init__(self)
 
 
1029
        self.problem = problem
 
 
1030
        self.format = format
 
 
1033
class NoDiff(BzrNewError):
 
 
1034
    """Diff is not installed on this machine: %(msg)s"""
 
 
1036
    def __init__(self, msg):
 
 
1037
        BzrNewError.__init__(self, msg=msg)
 
 
1040
class NoDiff3(BzrNewError):
 
 
1041
    """Diff3 is not installed on this machine."""
 
 
1044
class ExistingLimbo(BzrNewError):
 
 
1045
    """This tree contains left-over files from a failed operation.
 
 
1046
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1047
    keep, and delete it when you are done.
 
 
1049
    def __init__(self, limbo_dir):
 
 
1050
       BzrNewError.__init__(self)
 
 
1051
       self.limbo_dir = limbo_dir
 
 
1054
class ImmortalLimbo(BzrNewError):
 
 
1055
    """Unable to delete transform temporary directory $(limbo_dir)s.
 
 
1056
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1057
    keep, and delete it when you are done.
 
 
1059
    def __init__(self, limbo_dir):
 
 
1060
       BzrNewError.__init__(self)
 
 
1061
       self.limbo_dir = limbo_dir
 
 
1064
class OutOfDateTree(BzrNewError):
 
 
1065
    """Working tree is out of date, please run 'bzr update'."""
 
 
1067
    def __init__(self, tree):
 
 
1068
        BzrNewError.__init__(self)
 
 
1072
class MergeModifiedFormatError(BzrNewError):
 
 
1073
    """Error in merge modified format"""
 
 
1076
class ConflictFormatError(BzrNewError):
 
 
1077
    """Format error in conflict listings"""
 
 
1080
class CorruptRepository(BzrNewError):
 
 
1081
    """An error has been detected in the repository %(repo_path)s.
 
 
1082
Please run bzr reconcile on this repository."""
 
 
1084
    def __init__(self, repo):
 
 
1085
        BzrNewError.__init__(self)
 
 
1086
        self.repo_path = repo.bzrdir.root_transport.base
 
 
1089
class UpgradeRequired(BzrNewError):
 
 
1090
    """To use this feature you must upgrade your branch at %(path)s."""
 
 
1092
    def __init__(self, path):
 
 
1093
        BzrNewError.__init__(self)
 
 
1097
class LocalRequiresBoundBranch(BzrNewError):
 
 
1098
    """Cannot perform local-only commits on unbound branches."""
 
 
1101
class MissingProgressBarFinish(BzrNewError):
 
 
1102
    """A nested progress bar was not 'finished' correctly."""
 
 
1105
class InvalidProgressBarType(BzrNewError):
 
 
1106
    """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
 
1107
Select one of: %(valid_types)s"""
 
 
1109
    def __init__(self, bar_type, valid_types):
 
 
1110
        BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
1113
class UnsupportedOperation(BzrNewError):
 
 
1114
    """The method %(mname)s is not supported on objects of type %(tname)s."""
 
 
1115
    def __init__(self, method, method_self):
 
 
1116
        self.method = method
 
 
1117
        self.mname = method.__name__
 
 
1118
        self.tname = type(method_self).__name__
 
 
1121
class BinaryFile(BzrNewError):
 
 
1122
    """File is binary but should be text."""
 
 
1125
class IllegalPath(BzrNewError):
 
 
1126
    """The path %(path)s is not permitted on this platform"""
 
 
1128
    def __init__(self, path):
 
 
1129
        BzrNewError.__init__(self)
 
 
1133
class TestamentMismatch(BzrNewError):
 
 
1134
    """Testament did not match expected value.  
 
 
1135
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
 
1138
    def __init__(self, revision_id, expected, measured):
 
 
1139
        self.revision_id = revision_id
 
 
1140
        self.expected = expected
 
 
1141
        self.measured = measured
 
 
1144
class NotABundle(BzrNewError):
 
 
1145
    """Not a bzr revision-bundle: %(text)r"""
 
 
1147
    def __init__(self, text):
 
 
1148
        BzrNewError.__init__(self)
 
 
1152
class BadBundle(BzrNewError): 
 
 
1153
    """Bad bzr revision-bundle: %(text)r"""
 
 
1155
    def __init__(self, text):
 
 
1156
        BzrNewError.__init__(self)
 
 
1160
class MalformedHeader(BadBundle): 
 
 
1161
    """Malformed bzr revision-bundle header: %(text)r"""
 
 
1163
    def __init__(self, text):
 
 
1164
        BzrNewError.__init__(self)
 
 
1168
class MalformedPatches(BadBundle): 
 
 
1169
    """Malformed patches in bzr revision-bundle: %(text)r"""
 
 
1171
    def __init__(self, text):
 
 
1172
        BzrNewError.__init__(self)
 
 
1176
class MalformedFooter(BadBundle): 
 
 
1177
    """Malformed footer in bzr revision-bundle: %(text)r"""
 
 
1179
    def __init__(self, text):
 
 
1180
        BzrNewError.__init__(self)
 
 
1184
class UnsupportedEOLMarker(BadBundle):
 
 
1185
    """End of line marker was not \\n in bzr revision-bundle"""    
 
 
1188
        BzrNewError.__init__(self)
 
 
1191
class BadInventoryFormat(BzrNewError):
 
 
1192
    """Root class for inventory serialization errors"""
 
 
1195
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
1196
    """The inventory was not in the expected format:\n %(msg)s"""
 
 
1198
    def __init__(self, msg):
 
 
1199
        BadInventoryFormat.__init__(self, msg=msg)
 
 
1202
class NoSmartServer(NotBranchError):
 
 
1203
    """No smart server available at %(url)s"""
 
 
1205
    def __init__(self, url):
 
 
1209
class UnknownSSH(BzrNewError):
 
 
1210
    """Unrecognised value for BZR_SSH environment variable: %(vendor)s"""
 
 
1212
    def __init__(self, vendor):
 
 
1213
        BzrNewError.__init__(self)
 
 
1214
        self.vendor = vendor
 
 
1217
class GhostRevisionUnusableHere(BzrNewError):
 
 
1218
    """Ghost revision {%(revision_id)s} cannot be used here."""
 
 
1220
    def __init__(self, revision_id):
 
 
1221
        BzrNewError.__init__(self)
 
 
1222
        self.revision_id = revision_id
 
 
1225
class IllegalUseOfScopeReplacer(BzrNewError):
 
 
1226
    """ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"""
 
 
1228
    is_user_error = False
 
 
1230
    def __init__(self, name, msg, extra=None):
 
 
1231
        BzrNewError.__init__(self)
 
 
1235
            self.extra = ': ' + str(extra)
 
 
1240
class InvalidImportLine(BzrNewError):
 
 
1241
    """Not a valid import statement: %(msg)\n%(text)s"""
 
 
1243
    is_user_error = False
 
 
1245
    def __init__(self, text, msg):
 
 
1246
        BzrNewError.__init__(self)
 
 
1251
class ImportNameCollision(BzrNewError):
 
 
1252
    """Tried to import an object to the same name as an existing object. %(name)s"""
 
 
1254
    is_user_error = False
 
 
1256
    def __init__(self, name):
 
 
1257
        BzrNewError.__init__(self)