1
# Copyright (C) 2005, 2006 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.
 
 
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 InventoryModified(BzrNewError):
 
 
187
    """The current inventory for the tree %(tree)r has been modified, so a clean inventory cannot be read without data loss."""
 
 
189
    def __init__(self, tree):
 
 
190
        BzrNewError.__init__(self)
 
 
194
class NoSuchId(BzrNewError):
 
 
195
    """The file id %(file_id)s is not present in the tree %(tree)s."""
 
 
197
    def __init__(self, tree, file_id):
 
 
198
        BzrNewError.__init__(self)
 
 
199
        self.file_id = file_id
 
 
203
class NoWorkingTree(BzrNewError):
 
 
204
    """No WorkingTree exists for %(base)s."""
 
 
206
    def __init__(self, base):
 
 
207
        BzrNewError.__init__(self)
 
 
211
class WorkingTreeAlreadyPopulated(BzrNewError):
 
 
212
    """Working tree already populated in %(base)s"""
 
 
214
    is_user_error = False
 
 
217
class NotBuilding(BzrNewError):
 
 
218
    """Not currently building a tree."""
 
 
221
class NotLocalUrl(BzrNewError):
 
 
222
    """%(url)s is not a local path."""
 
 
224
    def __init__(self, url):
 
 
225
        BzrNewError.__init__(self)
 
 
229
class NotWriteLocked(BzrNewError):
 
 
230
    """%(not_locked)r is not write locked but needs to be."""
 
 
232
    def __init__(self, not_locked):
 
 
233
        BzrNewError.__init__(self)
 
 
234
        self.not_locked = not_locked
 
 
237
class BzrCommandError(BzrNewError):
 
 
238
    """Error from user command"""
 
 
242
    # Error from malformed user command; please avoid raising this as a
 
 
243
    # generic exception not caused by user input.
 
 
245
    # I think it's a waste of effort to differentiate between errors that
 
 
246
    # are not intended to be caught anyway.  UI code need not subclass
 
 
247
    # BzrCommandError, and non-UI code should not throw a subclass of
 
 
248
    # BzrCommandError.  ADHB 20051211
 
 
249
    def __init__(self, msg):
 
 
250
        # Object.__str__() must return a real string
 
 
251
        # returning a Unicode string is a python error.
 
 
252
        if isinstance(msg, unicode):
 
 
253
            self.msg = msg.encode('utf8')
 
 
261
class BzrOptionError(BzrCommandError):
 
 
262
    """Error in command line options"""
 
 
265
class StrictCommitFailed(BzrNewError):
 
 
266
    """Commit refused because there are unknown files in the tree"""
 
 
269
# XXX: Should be unified with TransportError; they seem to represent the
 
 
271
class PathError(BzrNewError):
 
 
272
    """Generic path error: %(path)r%(extra)s)"""
 
 
274
    def __init__(self, path, extra=None):
 
 
275
        BzrNewError.__init__(self)
 
 
278
            self.extra = ': ' + str(extra)
 
 
283
class NoSuchFile(PathError):
 
 
284
    """No such file: %(path)r%(extra)s"""
 
 
287
class FileExists(PathError):
 
 
288
    """File exists: %(path)r%(extra)s"""
 
 
291
class DirectoryNotEmpty(PathError):
 
 
292
    """Directory not empty: %(path)r%(extra)s"""
 
 
295
class ReadingCompleted(BzrNewError):
 
 
296
    """The MediumRequest '%(request)s' has already had finish_reading called upon it - the request has been completed and no more data may be read."""
 
 
298
    is_user_error = False
 
 
300
    def __init__(self, request):
 
 
301
        BzrNewError.__init__(self)
 
 
302
        self.request = request
 
 
305
class ResourceBusy(PathError):
 
 
306
    """Device or resource busy: %(path)r%(extra)s"""
 
 
309
class PermissionDenied(PathError):
 
 
310
    """Permission denied: %(path)r%(extra)s"""
 
 
313
class InvalidURL(PathError):
 
 
314
    """Invalid url supplied to transport: %(path)r%(extra)s"""
 
 
317
class InvalidURLJoin(PathError):
 
 
318
    """Invalid URL join request: %(args)s%(extra)s"""
 
 
320
    def __init__(self, msg, base, args):
 
 
321
        PathError.__init__(self, base, msg)
 
 
322
        self.args = [base] + list(args)
 
 
325
class UnsupportedProtocol(PathError):
 
 
326
    """Unsupported protocol for url "%(path)s"%(extra)s"""
 
 
328
    def __init__(self, url, extra):
 
 
329
        PathError.__init__(self, url, extra=extra)
 
 
332
class ShortReadvError(PathError):
 
 
333
    """readv() read %(actual)s bytes rather than %(length)s bytes at %(offset)s for %(path)s%(extra)s"""
 
 
335
    is_user_error = False
 
 
337
    def __init__(self, path, offset, length, actual, extra=None):
 
 
338
        PathError.__init__(self, path, extra=extra)
 
 
344
class PathNotChild(BzrNewError):
 
 
345
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
 
 
347
    is_user_error = False
 
 
349
    def __init__(self, path, base, extra=None):
 
 
350
        BzrNewError.__init__(self)
 
 
354
            self.extra = ': ' + str(extra)
 
 
359
class InvalidNormalization(PathError):
 
 
360
    """Path %(path)r is not unicode normalized"""
 
 
363
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
364
# the exception object is a bit undesirable.
 
 
365
# TODO: Probably this behavior of should be a common superclass 
 
 
366
class NotBranchError(PathError):
 
 
367
    """Not a branch: %(path)s"""
 
 
369
    def __init__(self, path):
 
 
370
       import bzrlib.urlutils as urlutils
 
 
371
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
374
class AlreadyBranchError(PathError):
 
 
375
    """Already a branch: %(path)s."""
 
 
378
class BranchExistsWithoutWorkingTree(PathError):
 
 
379
    """Directory contains a branch, but no working tree \
 
 
380
(use bzr checkout if you wish to build a working tree): %(path)s"""
 
 
383
class AtomicFileAlreadyClosed(PathError):
 
 
384
    """'%(function)s' called on an AtomicFile after it was closed: %(path)s"""
 
 
386
    def __init__(self, path, function):
 
 
387
        PathError.__init__(self, path=path, extra=None)
 
 
388
        self.function = function
 
 
391
class InaccessibleParent(PathError):
 
 
392
    """Parent not accessible given base %(base)s and relative path %(path)s"""
 
 
394
    def __init__(self, path, base):
 
 
395
        PathError.__init__(self, path)
 
 
399
class NoRepositoryPresent(BzrNewError):
 
 
400
    """No repository present: %(path)r"""
 
 
401
    def __init__(self, bzrdir):
 
 
402
        BzrNewError.__init__(self)
 
 
403
        self.path = bzrdir.transport.clone('..').base
 
 
406
class FileInWrongBranch(BzrNewError):
 
 
407
    """File %(path)s in not in branch %(branch_base)s."""
 
 
409
    def __init__(self, branch, path):
 
 
410
        BzrNewError.__init__(self)
 
 
412
        self.branch_base = branch.base
 
 
416
class UnsupportedFormatError(BzrNewError):
 
 
417
    """Unsupported branch format: %(format)s"""
 
 
420
class UnknownFormatError(BzrNewError):
 
 
421
    """Unknown branch format: %(format)r"""
 
 
424
class IncompatibleFormat(BzrNewError):
 
 
425
    """Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
 
 
427
    def __init__(self, format, bzrdir_format):
 
 
428
        BzrNewError.__init__(self)
 
 
430
        self.bzrdir = bzrdir_format
 
 
433
class IncompatibleRevision(BzrNewError):
 
 
434
    """Revision is not compatible with %(repo_format)s"""
 
 
436
    def __init__(self, repo_format):
 
 
437
        BzrNewError.__init__(self)
 
 
438
        self.repo_format = repo_format
 
 
441
class NotVersionedError(BzrNewError):
 
 
442
    """%(path)s is not versioned"""
 
 
443
    def __init__(self, path):
 
 
444
        BzrNewError.__init__(self)
 
 
448
class PathsNotVersionedError(BzrNewError):
 
 
449
    # used when reporting several paths are not versioned
 
 
450
    """Path(s) are not versioned: %(paths_as_string)s"""
 
 
452
    def __init__(self, paths):
 
 
453
        from bzrlib.osutils import quotefn
 
 
454
        BzrNewError.__init__(self)
 
 
456
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
459
class PathsDoNotExist(BzrNewError):
 
 
460
    """Path(s) do not exist: %(paths_as_string)s"""
 
 
462
    # used when reporting that paths are neither versioned nor in the working
 
 
465
    def __init__(self, paths):
 
 
467
        from bzrlib.osutils import quotefn
 
 
468
        BzrNewError.__init__(self)
 
 
470
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
473
class BadFileKindError(BzrNewError):
 
 
474
    """Cannot operate on %(filename)s of unsupported kind %(kind)s"""
 
 
477
class ForbiddenControlFileError(BzrNewError):
 
 
478
    """Cannot operate on %(filename)s because it is a control file"""
 
 
481
class LockError(BzrNewError):
 
 
482
    """Lock error: %(message)s"""
 
 
483
    # All exceptions from the lock/unlock functions should be from
 
 
484
    # this exception class.  They will be translated as necessary. The
 
 
485
    # original exception is available as e.original_error
 
 
487
    # New code should prefer to raise specific subclasses
 
 
488
    def __init__(self, message):
 
 
489
        self.message = message
 
 
492
class CommitNotPossible(LockError):
 
 
493
    """A commit was attempted but we do not have a write lock open."""
 
 
498
class AlreadyCommitted(LockError):
 
 
499
    """A rollback was requested, but is not able to be accomplished."""
 
 
504
class ReadOnlyError(LockError):
 
 
505
    """A write attempt was made in a read only transaction on %(obj)s"""
 
 
506
    def __init__(self, obj):
 
 
510
class OutSideTransaction(BzrNewError):
 
 
511
    """A transaction related operation was attempted after the transaction finished."""
 
 
514
class ObjectNotLocked(LockError):
 
 
515
    """%(obj)r is not locked"""
 
 
517
    is_user_error = False
 
 
519
    # this can indicate that any particular object is not locked; see also
 
 
520
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
521
    # the caller -- perhaps they should be unified.
 
 
522
    def __init__(self, obj):
 
 
526
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
527
    """Cannot change object %(obj)r in read only transaction"""
 
 
528
    def __init__(self, obj):
 
 
532
class UnlockableTransport(LockError):
 
 
533
    """Cannot lock: transport is read only: %(transport)s"""
 
 
534
    def __init__(self, transport):
 
 
535
        self.transport = transport
 
 
538
class LockContention(LockError):
 
 
539
    """Could not acquire lock %(lock)s"""
 
 
540
    # TODO: show full url for lock, combining the transport and relative bits?
 
 
541
    def __init__(self, lock):
 
 
545
class LockBroken(LockError):
 
 
546
    """Lock was broken while still open: %(lock)s - check storage consistency!"""
 
 
547
    def __init__(self, lock):
 
 
551
class LockBreakMismatch(LockError):
 
 
552
    """Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
 
 
553
    def __init__(self, lock, holder, target):
 
 
559
class LockNotHeld(LockError):
 
 
560
    """Lock not held: %(lock)s"""
 
 
561
    def __init__(self, lock):
 
 
565
class PointlessCommit(BzrNewError):
 
 
566
    """No changes to commit"""
 
 
569
class UpgradeReadonly(BzrNewError):
 
 
570
    """Upgrade URL cannot work with readonly URL's."""
 
 
573
class UpToDateFormat(BzrNewError):
 
 
574
    """The branch format %(format)s is already at the most recent format."""
 
 
576
    def __init__(self, format):
 
 
577
        BzrNewError.__init__(self)
 
 
581
class StrictCommitFailed(Exception):
 
 
582
    """Commit refused because there are unknowns in the tree."""
 
 
585
class NoSuchRevision(BzrNewError):
 
 
586
    """Branch %(branch)s has no revision %(revision)s"""
 
 
588
    is_user_error = False
 
 
590
    def __init__(self, branch, revision):
 
 
591
        BzrNewError.__init__(self, branch=branch, revision=revision)
 
 
594
class NoSuchRevisionSpec(BzrNewError):
 
 
595
    """No namespace registered for string: %(spec)r"""
 
 
597
    def __init__(self, spec):
 
 
598
        BzrNewError.__init__(self, spec=spec)
 
 
601
class InvalidRevisionSpec(BzrNewError):
 
 
602
    """Requested revision: '%(spec)s' does not exist in branch:
 
 
603
%(branch)s%(extra)s"""
 
 
605
    def __init__(self, spec, branch, extra=None):
 
 
606
        BzrNewError.__init__(self, branch=branch, spec=spec)
 
 
608
            self.extra = '\n' + str(extra)
 
 
613
class HistoryMissing(BzrError):
 
 
614
    def __init__(self, branch, object_type, object_id):
 
 
616
        BzrError.__init__(self,
 
 
617
                          '%s is missing %s {%s}'
 
 
618
                          % (branch, object_type, object_id))
 
 
621
class DivergedBranches(BzrNewError):
 
 
622
    "These branches have diverged.  Use the merge command to reconcile them."""
 
 
626
    def __init__(self, branch1, branch2):
 
 
627
        self.branch1 = branch1
 
 
628
        self.branch2 = branch2
 
 
631
class UnrelatedBranches(BzrNewError):
 
 
632
    "Branches have no common ancestor, and no merge base revision was specified."
 
 
637
class NoCommonAncestor(BzrNewError):
 
 
638
    "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
640
    def __init__(self, revision_a, revision_b):
 
 
641
        self.revision_a = revision_a
 
 
642
        self.revision_b = revision_b
 
 
645
class NoCommonRoot(BzrError):
 
 
646
    def __init__(self, revision_a, revision_b):
 
 
647
        msg = "Revisions are not derived from the same root: %s %s." \
 
 
648
            % (revision_a, revision_b) 
 
 
649
        BzrError.__init__(self, msg)
 
 
653
class NotAncestor(BzrError):
 
 
654
    def __init__(self, rev_id, not_ancestor_id):
 
 
655
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
 
657
        BzrError.__init__(self, msg)
 
 
659
        self.not_ancestor_id = not_ancestor_id
 
 
662
class InstallFailed(BzrError):
 
 
663
    def __init__(self, revisions):
 
 
664
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
 
 
665
        BzrError.__init__(self, msg)
 
 
666
        self.revisions = revisions
 
 
669
class AmbiguousBase(BzrError):
 
 
670
    def __init__(self, bases):
 
 
671
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
673
        msg = "The correct base is unclear, because %s are all equally close" %\
 
 
675
        BzrError.__init__(self, msg)
 
 
679
class NoCommits(BzrNewError):
 
 
680
    """Branch %(branch)s has no commits."""
 
 
682
    def __init__(self, branch):
 
 
683
        BzrNewError.__init__(self, branch=branch)
 
 
686
class UnlistableStore(BzrError):
 
 
687
    def __init__(self, store):
 
 
688
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
692
class UnlistableBranch(BzrError):
 
 
693
    def __init__(self, br):
 
 
694
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
697
class BoundBranchOutOfDate(BzrNewError):
 
 
698
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
 
 
699
    def __init__(self, branch, master):
 
 
700
        BzrNewError.__init__(self)
 
 
705
class CommitToDoubleBoundBranch(BzrNewError):
 
 
706
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
 
 
707
    def __init__(self, branch, master, remote):
 
 
708
        BzrNewError.__init__(self)
 
 
714
class OverwriteBoundBranch(BzrNewError):
 
 
715
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
 
 
716
    def __init__(self, branch):
 
 
717
        BzrNewError.__init__(self)
 
 
721
class BoundBranchConnectionFailure(BzrNewError):
 
 
722
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
 
 
723
    def __init__(self, branch, target, error):
 
 
724
        BzrNewError.__init__(self)
 
 
730
class WeaveError(BzrNewError):
 
 
731
    """Error in processing weave: %(message)s"""
 
 
733
    def __init__(self, message=None):
 
 
734
        BzrNewError.__init__(self)
 
 
735
        self.message = message
 
 
738
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
739
    """Revision {%(revision_id)s} already present in %(weave)s"""
 
 
740
    def __init__(self, revision_id, weave):
 
 
742
        WeaveError.__init__(self)
 
 
743
        self.revision_id = revision_id
 
 
747
class WeaveRevisionNotPresent(WeaveError):
 
 
748
    """Revision {%(revision_id)s} not present in %(weave)s"""
 
 
750
    def __init__(self, revision_id, weave):
 
 
751
        WeaveError.__init__(self)
 
 
752
        self.revision_id = revision_id
 
 
756
class WeaveFormatError(WeaveError):
 
 
757
    """Weave invariant violated: %(what)s"""
 
 
759
    def __init__(self, what):
 
 
760
        WeaveError.__init__(self)
 
 
764
class WeaveParentMismatch(WeaveError):
 
 
765
    """Parents are mismatched between two revisions."""
 
 
768
class WeaveInvalidChecksum(WeaveError):
 
 
769
    """Text did not match it's checksum: %(message)s"""
 
 
772
class WeaveTextDiffers(WeaveError):
 
 
773
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
 
775
    def __init__(self, revision_id, weave_a, weave_b):
 
 
776
        WeaveError.__init__(self)
 
 
777
        self.revision_id = revision_id
 
 
778
        self.weave_a = weave_a
 
 
779
        self.weave_b = weave_b
 
 
782
class WeaveTextDiffers(WeaveError):
 
 
783
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
 
785
    def __init__(self, revision_id, weave_a, weave_b):
 
 
786
        WeaveError.__init__(self)
 
 
787
        self.revision_id = revision_id
 
 
788
        self.weave_a = weave_a
 
 
789
        self.weave_b = weave_b
 
 
792
class VersionedFileError(BzrNewError):
 
 
793
    """Versioned file error."""
 
 
796
class RevisionNotPresent(VersionedFileError):
 
 
797
    """Revision {%(revision_id)s} not present in %(file_id)s."""
 
 
799
    def __init__(self, revision_id, file_id):
 
 
800
        VersionedFileError.__init__(self)
 
 
801
        self.revision_id = revision_id
 
 
802
        self.file_id = file_id
 
 
805
class RevisionAlreadyPresent(VersionedFileError):
 
 
806
    """Revision {%(revision_id)s} already present in %(file_id)s."""
 
 
808
    def __init__(self, revision_id, file_id):
 
 
809
        VersionedFileError.__init__(self)
 
 
810
        self.revision_id = revision_id
 
 
811
        self.file_id = file_id
 
 
814
class KnitError(BzrNewError):
 
 
818
class KnitHeaderError(KnitError):
 
 
819
    """Knit header error: %(badline)r unexpected"""
 
 
821
    def __init__(self, badline):
 
 
822
        KnitError.__init__(self)
 
 
823
        self.badline = badline
 
 
826
class KnitCorrupt(KnitError):
 
 
827
    """Knit %(filename)s corrupt: %(how)s"""
 
 
829
    def __init__(self, filename, how):
 
 
830
        KnitError.__init__(self)
 
 
831
        self.filename = filename
 
 
835
class NoSuchExportFormat(BzrNewError):
 
 
836
    """Export format %(format)r not supported"""
 
 
838
    def __init__(self, format):
 
 
839
        BzrNewError.__init__(self)
 
 
844
class TooManyConcurrentRequests(BzrNewError):
 
 
845
    """The medium '%(medium)s' has reached its concurrent request limit. Be sure to finish_writing and finish_reading on the current request that is open."""
 
 
847
    def __init__(self, medium):
 
 
848
        BzrNewError.__init__(self)
 
 
852
class TransportError(BzrNewError):
 
 
853
    """Transport error: %(msg)s %(orig_error)s"""
 
 
855
    def __init__(self, msg=None, orig_error=None):
 
 
856
        if msg is None and orig_error is not None:
 
 
857
            msg = str(orig_error)
 
 
858
        if orig_error is None:
 
 
863
        self.orig_error = orig_error
 
 
864
        BzrNewError.__init__(self)
 
 
867
class SmartProtocolError(TransportError):
 
 
868
    """Generic bzr smart protocol error: %(details)s"""
 
 
870
    def __init__(self, details):
 
 
871
        self.details = details
 
 
874
# A set of semi-meaningful errors which can be thrown
 
 
875
class TransportNotPossible(TransportError):
 
 
876
    """Transport operation not possible: %(msg)s %(orig_error)s"""
 
 
879
class ConnectionError(TransportError):
 
 
880
    """Connection error: %(msg)s %(orig_error)s"""
 
 
883
class SocketConnectionError(ConnectionError):
 
 
884
    """%(msg)s %(host)s%(port)s%(orig_error)s"""
 
 
886
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
 
888
            msg = 'Failed to connect to'
 
 
889
        if orig_error is None:
 
 
892
            orig_error = '; ' + str(orig_error)
 
 
893
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
 
898
            self.port = ':%s' % port
 
 
901
class ConnectionReset(TransportError):
 
 
902
    """Connection closed: %(msg)s %(orig_error)s"""
 
 
905
class InvalidRange(TransportError):
 
 
906
    """Invalid range access in %(path)s at %(offset)s."""
 
 
908
    def __init__(self, path, offset):
 
 
909
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
 
915
class InvalidHttpResponse(TransportError):
 
 
916
    """Invalid http response for %(path)s: %(msg)s"""
 
 
918
    def __init__(self, path, msg, orig_error=None):
 
 
920
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
923
class InvalidHttpRange(InvalidHttpResponse):
 
 
924
    """Invalid http range "%(range)s" for %(path)s: %(msg)s"""
 
 
926
    def __init__(self, path, range, msg):
 
 
928
        InvalidHttpResponse.__init__(self, path, msg)
 
 
931
class InvalidHttpContentType(InvalidHttpResponse):
 
 
932
    """Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
 
 
934
    def __init__(self, path, ctype, msg):
 
 
936
        InvalidHttpResponse.__init__(self, path, msg)
 
 
939
class ConflictsInTree(BzrError):
 
 
941
        BzrError.__init__(self, "Working tree has conflicts.")
 
 
944
class ParseConfigError(BzrError):
 
 
945
    def __init__(self, errors, filename):
 
 
948
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
949
            (filename, ('\n'.join(e.message for e in errors)))
 
 
950
        BzrError.__init__(self, message)
 
 
953
class NoEmailInUsername(BzrNewError):
 
 
954
    """%(username)r does not seem to contain a reasonable email address"""
 
 
956
    def __init__(self, username):
 
 
957
        BzrNewError.__init__(self)
 
 
958
        self.username = username
 
 
961
class SigningFailed(BzrError):
 
 
962
    def __init__(self, command_line):
 
 
963
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
 
 
967
class WorkingTreeNotRevision(BzrError):
 
 
968
    def __init__(self, tree):
 
 
969
        BzrError.__init__(self, "The working tree for %s has changed since"
 
 
970
                          " last commit, but weave merge requires that it be"
 
 
971
                          " unchanged." % tree.basedir)
 
 
974
class WritingCompleted(BzrNewError):
 
 
975
    """The MediumRequest '%(request)s' has already had finish_writing called upon it - accept bytes may not be called anymore."""
 
 
977
    is_user_error = False
 
 
979
    def __init__(self, request):
 
 
980
        BzrNewError.__init__(self)
 
 
981
        self.request = request
 
 
984
class WritingNotComplete(BzrNewError):
 
 
985
    """The MediumRequest '%(request)s' has not has finish_writing called upon it - until the write phase is complete no data may be read."""
 
 
987
    is_user_error = False
 
 
989
    def __init__(self, request):
 
 
990
        BzrNewError.__init__(self)
 
 
991
        self.request = request
 
 
994
class CantReprocessAndShowBase(BzrNewError):
 
 
995
    """Can't reprocess and show base.
 
 
996
Reprocessing obscures relationship of conflicting lines to base."""
 
 
999
class GraphCycleError(BzrNewError):
 
 
1000
    """Cycle in graph %(graph)r"""
 
 
1001
    def __init__(self, graph):
 
 
1002
        BzrNewError.__init__(self)
 
 
1006
class NotConflicted(BzrNewError):
 
 
1007
    """File %(filename)s is not conflicted."""
 
 
1009
    def __init__(self, filename):
 
 
1010
        BzrNewError.__init__(self)
 
 
1011
        self.filename = filename
 
 
1014
class MediumNotConnected(BzrNewError):
 
 
1015
    """The medium '%(medium)s' is not connected."""
 
 
1017
    def __init__(self, medium):
 
 
1018
        BzrNewError.__init__(self)
 
 
1019
        self.medium = medium
 
 
1022
class MustUseDecorated(Exception):
 
 
1023
    """A decorating function has requested its original command be used.
 
 
1025
    This should never escape bzr, so does not need to be printable.
 
 
1029
class NoBundleFound(BzrNewError):
 
 
1030
    """No bundle was found in %(filename)s"""
 
 
1031
    def __init__(self, filename):
 
 
1032
        BzrNewError.__init__(self)
 
 
1033
        self.filename = filename
 
 
1036
class BundleNotSupported(BzrNewError):
 
 
1037
    """Unable to handle bundle version %(version)s: %(msg)s"""
 
 
1038
    def __init__(self, version, msg):
 
 
1039
        BzrNewError.__init__(self)
 
 
1040
        self.version = version
 
 
1044
class MissingText(BzrNewError):
 
 
1045
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
 
 
1047
    def __init__(self, branch, text_revision, file_id):
 
 
1048
        BzrNewError.__init__(self)
 
 
1049
        self.branch = branch
 
 
1050
        self.base = branch.base
 
 
1051
        self.text_revision = text_revision
 
 
1052
        self.file_id = file_id
 
 
1055
class DuplicateKey(BzrNewError):
 
 
1056
    """Key %(key)s is already present in map"""
 
 
1059
class MalformedTransform(BzrNewError):
 
 
1060
    """Tree transform is malformed %(conflicts)r"""
 
 
1063
class NoFinalPath(BzrNewError):
 
 
1064
    """No final name for trans_id %(trans_id)r
 
 
1065
    file-id: %(file_id)r"
 
 
1066
    root trans-id: %(root_trans_id)r 
 
 
1069
    def __init__(self, trans_id, transform):
 
 
1070
        self.trans_id = trans_id
 
 
1071
        self.file_id = transform.final_file_id(trans_id)
 
 
1072
        self.root_trans_id = transform.root
 
 
1075
class BzrBadParameter(BzrNewError):
 
 
1076
    """A bad parameter : %(param)s is not usable.
 
 
1078
    This exception should never be thrown, but it is a base class for all
 
 
1079
    parameter-to-function errors.
 
 
1081
    def __init__(self, param):
 
 
1082
        BzrNewError.__init__(self)
 
 
1086
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
1087
    """Parameter %(param)s is neither unicode nor utf8."""
 
 
1090
class ReusingTransform(BzrNewError):
 
 
1091
    """Attempt to reuse a transform that has already been applied."""
 
 
1094
class CantMoveRoot(BzrNewError):
 
 
1095
    """Moving the root directory is not supported at this time"""
 
 
1098
class BzrBadParameterNotString(BzrBadParameter):
 
 
1099
    """Parameter %(param)s is not a string or unicode string."""
 
 
1102
class BzrBadParameterMissing(BzrBadParameter):
 
 
1103
    """Parameter $(param)s is required but not present."""
 
 
1106
class BzrBadParameterUnicode(BzrBadParameter):
 
 
1107
    """Parameter %(param)s is unicode but only byte-strings are permitted."""
 
 
1110
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
1111
    """Parameter %(param)s contains a newline."""
 
 
1114
class DependencyNotPresent(BzrNewError):
 
 
1115
    """Unable to import library "%(library)s": %(error)s"""
 
 
1117
    def __init__(self, library, error):
 
 
1118
        BzrNewError.__init__(self, library=library, error=error)
 
 
1121
class ParamikoNotPresent(DependencyNotPresent):
 
 
1122
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
 
1124
    def __init__(self, error):
 
 
1125
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1128
class PointlessMerge(BzrNewError):
 
 
1129
    """Nothing to merge."""
 
 
1132
class UninitializableFormat(BzrNewError):
 
 
1133
    """Format %(format)s cannot be initialised by this version of bzr."""
 
 
1135
    def __init__(self, format):
 
 
1136
        BzrNewError.__init__(self)
 
 
1137
        self.format = format
 
 
1140
class BadConversionTarget(BzrNewError):
 
 
1141
    """Cannot convert to format %(format)s.  %(problem)s"""
 
 
1143
    def __init__(self, problem, format):
 
 
1144
        BzrNewError.__init__(self)
 
 
1145
        self.problem = problem
 
 
1146
        self.format = format
 
 
1149
class NoDiff(BzrNewError):
 
 
1150
    """Diff is not installed on this machine: %(msg)s"""
 
 
1152
    def __init__(self, msg):
 
 
1153
        BzrNewError.__init__(self, msg=msg)
 
 
1156
class NoDiff3(BzrNewError):
 
 
1157
    """Diff3 is not installed on this machine."""
 
 
1160
class ExistingLimbo(BzrNewError):
 
 
1161
    """This tree contains left-over files from a failed operation.
 
 
1162
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1163
    keep, and delete it when you are done.
 
 
1165
    def __init__(self, limbo_dir):
 
 
1166
       BzrNewError.__init__(self)
 
 
1167
       self.limbo_dir = limbo_dir
 
 
1170
class ImmortalLimbo(BzrNewError):
 
 
1171
    """Unable to delete transform temporary directory $(limbo_dir)s.
 
 
1172
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1173
    keep, and delete it when you are done.
 
 
1175
    def __init__(self, limbo_dir):
 
 
1176
       BzrNewError.__init__(self)
 
 
1177
       self.limbo_dir = limbo_dir
 
 
1180
class OutOfDateTree(BzrNewError):
 
 
1181
    """Working tree is out of date, please run 'bzr update'."""
 
 
1183
    def __init__(self, tree):
 
 
1184
        BzrNewError.__init__(self)
 
 
1188
class MergeModifiedFormatError(BzrNewError):
 
 
1189
    """Error in merge modified format"""
 
 
1192
class ConflictFormatError(BzrNewError):
 
 
1193
    """Format error in conflict listings"""
 
 
1196
class CorruptRepository(BzrNewError):
 
 
1197
    """An error has been detected in the repository %(repo_path)s.
 
 
1198
Please run bzr reconcile on this repository."""
 
 
1200
    def __init__(self, repo):
 
 
1201
        BzrNewError.__init__(self)
 
 
1202
        self.repo_path = repo.bzrdir.root_transport.base
 
 
1205
class UpgradeRequired(BzrNewError):
 
 
1206
    """To use this feature you must upgrade your branch at %(path)s."""
 
 
1208
    def __init__(self, path):
 
 
1209
        BzrNewError.__init__(self)
 
 
1213
class LocalRequiresBoundBranch(BzrNewError):
 
 
1214
    """Cannot perform local-only commits on unbound branches."""
 
 
1217
class MissingProgressBarFinish(BzrNewError):
 
 
1218
    """A nested progress bar was not 'finished' correctly."""
 
 
1221
class InvalidProgressBarType(BzrNewError):
 
 
1222
    """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
 
1223
Select one of: %(valid_types)s"""
 
 
1225
    def __init__(self, bar_type, valid_types):
 
 
1226
        BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
1229
class UnsupportedOperation(BzrNewError):
 
 
1230
    """The method %(mname)s is not supported on objects of type %(tname)s."""
 
 
1231
    def __init__(self, method, method_self):
 
 
1232
        self.method = method
 
 
1233
        self.mname = method.__name__
 
 
1234
        self.tname = type(method_self).__name__
 
 
1237
class BinaryFile(BzrNewError):
 
 
1238
    """File is binary but should be text."""
 
 
1241
class IllegalPath(BzrNewError):
 
 
1242
    """The path %(path)s is not permitted on this platform"""
 
 
1244
    def __init__(self, path):
 
 
1245
        BzrNewError.__init__(self)
 
 
1249
class TestamentMismatch(BzrNewError):
 
 
1250
    """Testament did not match expected value.  
 
 
1251
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
 
1254
    def __init__(self, revision_id, expected, measured):
 
 
1255
        self.revision_id = revision_id
 
 
1256
        self.expected = expected
 
 
1257
        self.measured = measured
 
 
1260
class NotABundle(BzrNewError):
 
 
1261
    """Not a bzr revision-bundle: %(text)r"""
 
 
1263
    def __init__(self, text):
 
 
1264
        BzrNewError.__init__(self)
 
 
1268
class BadBundle(BzrNewError): 
 
 
1269
    """Bad bzr revision-bundle: %(text)r"""
 
 
1271
    def __init__(self, text):
 
 
1272
        BzrNewError.__init__(self)
 
 
1276
class MalformedHeader(BadBundle): 
 
 
1277
    """Malformed bzr revision-bundle header: %(text)r"""
 
 
1279
    def __init__(self, text):
 
 
1280
        BzrNewError.__init__(self)
 
 
1284
class MalformedPatches(BadBundle): 
 
 
1285
    """Malformed patches in bzr revision-bundle: %(text)r"""
 
 
1287
    def __init__(self, text):
 
 
1288
        BzrNewError.__init__(self)
 
 
1292
class MalformedFooter(BadBundle): 
 
 
1293
    """Malformed footer in bzr revision-bundle: %(text)r"""
 
 
1295
    def __init__(self, text):
 
 
1296
        BzrNewError.__init__(self)
 
 
1300
class UnsupportedEOLMarker(BadBundle):
 
 
1301
    """End of line marker was not \\n in bzr revision-bundle"""    
 
 
1304
        BzrNewError.__init__(self)
 
 
1307
class IncompatibleFormat(BzrNewError):
 
 
1308
    """Bundle format %(bundle_format)s is incompatible with %(other)s"""
 
 
1310
    def __init__(self, bundle_format, other):
 
 
1311
        BzrNewError.__init__(self)
 
 
1312
        self.bundle_format = bundle_format
 
 
1316
class BadInventoryFormat(BzrNewError):
 
 
1317
    """Root class for inventory serialization errors"""
 
 
1320
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
1321
    """The inventory was not in the expected format:\n %(msg)s"""
 
 
1323
    def __init__(self, msg):
 
 
1324
        BadInventoryFormat.__init__(self, msg=msg)
 
 
1327
class NoSmartMedium(BzrNewError):
 
 
1328
    """The transport '%(transport)s' cannot tunnel the smart protocol."""
 
 
1330
    def __init__(self, transport):
 
 
1331
        BzrNewError.__init__(self)
 
 
1332
        self.transport = transport
 
 
1335
class NoSmartServer(NotBranchError):
 
 
1336
    """No smart server available at %(url)s"""
 
 
1338
    def __init__(self, url):
 
 
1342
class UnknownSSH(BzrNewError):
 
 
1343
    """Unrecognised value for BZR_SSH environment variable: %(vendor)s"""
 
 
1345
    def __init__(self, vendor):
 
 
1346
        BzrNewError.__init__(self)
 
 
1347
        self.vendor = vendor
 
 
1350
class GhostRevisionUnusableHere(BzrNewError):
 
 
1351
    """Ghost revision {%(revision_id)s} cannot be used here."""
 
 
1353
    def __init__(self, revision_id):
 
 
1354
        BzrNewError.__init__(self)
 
 
1355
        self.revision_id = revision_id
 
 
1358
class IllegalUseOfScopeReplacer(BzrNewError):
 
 
1359
    """ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"""
 
 
1361
    is_user_error = False
 
 
1363
    def __init__(self, name, msg, extra=None):
 
 
1364
        BzrNewError.__init__(self)
 
 
1368
            self.extra = ': ' + str(extra)
 
 
1373
class InvalidImportLine(BzrNewError):
 
 
1374
    """Not a valid import statement: %(msg)\n%(text)s"""
 
 
1376
    is_user_error = False
 
 
1378
    def __init__(self, text, msg):
 
 
1379
        BzrNewError.__init__(self)
 
 
1384
class ImportNameCollision(BzrNewError):
 
 
1385
    """Tried to import an object to the same name as an existing object. %(name)s"""
 
 
1387
    is_user_error = False
 
 
1389
    def __init__(self, name):
 
 
1390
        BzrNewError.__init__(self)