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 sys.exc_type
 
 
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, **kwds):
 
 
124
        for key, value in kwds.items():
 
 
125
            setattr(self, key, value)
 
 
129
            # __str__() should always return a 'str' object
 
 
130
            # never a 'unicode' object.
 
 
131
            s = self.__doc__ % self.__dict__
 
 
132
            if isinstance(s, unicode):
 
 
133
                return s.encode('utf8')
 
 
135
        except (TypeError, NameError, ValueError, KeyError), e:
 
 
136
            return 'Unprintable exception %s(%r): %s' \
 
 
137
                % (self.__class__.__name__,
 
 
138
                   self.__dict__, str(e))
 
 
141
class AlreadyBuilding(BzrNewError):
 
 
142
    """The tree builder is already building a tree."""
 
 
145
class BzrCheckError(BzrNewError):
 
 
146
    """Internal check failed: %(message)s"""
 
 
148
    is_user_error = False
 
 
150
    def __init__(self, message):
 
 
151
        BzrNewError.__init__(self)
 
 
152
        self.message = message
 
 
155
class InvalidEntryName(BzrNewError):
 
 
156
    """Invalid entry name: %(name)s"""
 
 
158
    is_user_error = False
 
 
160
    def __init__(self, name):
 
 
161
        BzrNewError.__init__(self)
 
 
165
class InvalidRevisionNumber(BzrNewError):
 
 
166
    """Invalid revision number %(revno)d"""
 
 
167
    def __init__(self, revno):
 
 
168
        BzrNewError.__init__(self)
 
 
172
class InvalidRevisionId(BzrNewError):
 
 
173
    """Invalid revision-id {%(revision_id)s} in %(branch)s"""
 
 
175
    def __init__(self, revision_id, branch):
 
 
176
        # branch can be any string or object with __str__ defined
 
 
177
        BzrNewError.__init__(self)
 
 
178
        self.revision_id = revision_id
 
 
182
class NoSuchId(BzrNewError):
 
 
183
    """The file id %(file_id)s is not present in the tree %(tree)s."""
 
 
185
    def __init__(self, tree, file_id):
 
 
186
        BzrNewError.__init__(self)
 
 
187
        self.file_id = file_id
 
 
191
class NoWorkingTree(BzrNewError):
 
 
192
    """No WorkingTree exists for %(base)s."""
 
 
194
    def __init__(self, base):
 
 
195
        BzrNewError.__init__(self)
 
 
199
class NotBuilding(BzrNewError):
 
 
200
    """Not currently building a tree."""
 
 
203
class NotLocalUrl(BzrNewError):
 
 
204
    """%(url)s is not a local path."""
 
 
206
    def __init__(self, url):
 
 
207
        BzrNewError.__init__(self)
 
 
211
class BzrCommandError(BzrNewError):
 
 
212
    """Error from user command"""
 
 
216
    # Error from malformed user command; please avoid raising this as a
 
 
217
    # generic exception not caused by user input.
 
 
219
    # I think it's a waste of effort to differentiate between errors that
 
 
220
    # are not intended to be caught anyway.  UI code need not subclass
 
 
221
    # BzrCommandError, and non-UI code should not throw a subclass of
 
 
222
    # BzrCommandError.  ADHB 20051211
 
 
223
    def __init__(self, msg):
 
 
224
        # Object.__str__() must return a real string
 
 
225
        # returning a Unicode string is a python error.
 
 
226
        if isinstance(msg, unicode):
 
 
227
            self.msg = msg.encode('utf8')
 
 
235
class BzrOptionError(BzrCommandError):
 
 
236
    """Error in command line options"""
 
 
239
class StrictCommitFailed(BzrNewError):
 
 
240
    """Commit refused because there are unknown files in the tree"""
 
 
243
# XXX: Should be unified with TransportError; they seem to represent the
 
 
245
class PathError(BzrNewError):
 
 
246
    """Generic path error: %(path)r%(extra)s)"""
 
 
248
    def __init__(self, path, extra=None):
 
 
249
        BzrNewError.__init__(self)
 
 
252
            self.extra = ': ' + str(extra)
 
 
257
class NoSuchFile(PathError):
 
 
258
    """No such file: %(path)r%(extra)s"""
 
 
261
class FileExists(PathError):
 
 
262
    """File exists: %(path)r%(extra)s"""
 
 
265
class DirectoryNotEmpty(PathError):
 
 
266
    """Directory not empty: %(path)r%(extra)s"""
 
 
269
class ResourceBusy(PathError):
 
 
270
    """Device or resource busy: %(path)r%(extra)s"""
 
 
273
class PermissionDenied(PathError):
 
 
274
    """Permission denied: %(path)r%(extra)s"""
 
 
277
class InvalidURL(PathError):
 
 
278
    """Invalid url supplied to transport: %(path)r%(extra)s"""
 
 
281
class InvalidURLJoin(PathError):
 
 
282
    """Invalid URL join request: %(args)s%(extra)s"""
 
 
284
    def __init__(self, msg, base, args):
 
 
285
        PathError.__init__(self, base, msg)
 
 
287
        self.args.extend(args)
 
 
290
class UnsupportedProtocol(PathError):
 
 
291
    """Unsupported protocol for url "%(path)s"%(extra)s"""
 
 
293
    def __init__(self, url, extra):
 
 
294
        PathError.__init__(self, url, extra=extra)
 
 
297
class ShortReadvError(PathError):
 
 
298
    """readv() read %(actual)s bytes rather than %(length)s bytes at %(offset)s for %(path)s%(extra)s"""
 
 
300
    is_user_error = False
 
 
302
    def __init__(self, path, offset, length, actual, extra=None):
 
 
303
        PathError.__init__(self, path, extra=extra)
 
 
309
class PathNotChild(BzrNewError):
 
 
310
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
 
 
312
    is_user_error = False
 
 
314
    def __init__(self, path, base, extra=None):
 
 
315
        BzrNewError.__init__(self)
 
 
319
            self.extra = ': ' + str(extra)
 
 
324
class InvalidNormalization(PathError):
 
 
325
    """Path %(path)r is not unicode normalized"""
 
 
328
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
329
# the exception object is a bit undesirable.
 
 
330
# TODO: Probably this behavior of should be a common superclass 
 
 
331
class NotBranchError(PathError):
 
 
332
    """Not a branch: %(path)s"""
 
 
334
    def __init__(self, path):
 
 
335
       import bzrlib.urlutils as urlutils
 
 
336
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
339
class AlreadyBranchError(PathError):
 
 
340
    """Already a branch: %(path)s."""
 
 
343
class BranchExistsWithoutWorkingTree(PathError):
 
 
344
    """Directory contains a branch, but no working tree \
 
 
345
(use bzr checkout if you wish to build a working tree): %(path)s"""
 
 
348
class AtomicFileAlreadyClosed(PathError):
 
 
349
    """'%(function)s' called on an AtomicFile after it was closed: %(path)s"""
 
 
351
    def __init__(self, path, function):
 
 
352
        PathError.__init__(self, path=path, extra=None)
 
 
353
        self.function = function
 
 
356
class InaccessibleParent(PathError):
 
 
357
    """Parent not accessible given base %(base)s and relative path %(path)s"""
 
 
359
    def __init__(self, path, base):
 
 
360
        PathError.__init__(self, path)
 
 
364
class NoRepositoryPresent(BzrNewError):
 
 
365
    """No repository present: %(path)r"""
 
 
366
    def __init__(self, bzrdir):
 
 
367
        BzrNewError.__init__(self)
 
 
368
        self.path = bzrdir.transport.clone('..').base
 
 
371
class FileInWrongBranch(BzrNewError):
 
 
372
    """File %(path)s in not in branch %(branch_base)s."""
 
 
374
    def __init__(self, branch, path):
 
 
375
        BzrNewError.__init__(self)
 
 
377
        self.branch_base = branch.base
 
 
381
class UnsupportedFormatError(BzrNewError):
 
 
382
    """Unsupported branch format: %(format)s"""
 
 
385
class UnknownFormatError(BzrNewError):
 
 
386
    """Unknown branch format: %(format)r"""
 
 
389
class IncompatibleFormat(BzrNewError):
 
 
390
    """Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
 
 
392
    def __init__(self, format, bzrdir_format):
 
 
393
        BzrNewError.__init__(self)
 
 
395
        self.bzrdir = bzrdir_format
 
 
398
class NotVersionedError(BzrNewError):
 
 
399
    """%(path)s is not versioned"""
 
 
400
    def __init__(self, path):
 
 
401
        BzrNewError.__init__(self)
 
 
405
class PathsNotVersionedError(BzrNewError):
 
 
406
    # used when reporting several paths are not versioned
 
 
407
    """Path(s) are not versioned: %(paths_as_string)s"""
 
 
409
    def __init__(self, paths):
 
 
410
        from bzrlib.osutils import quotefn
 
 
411
        BzrNewError.__init__(self)
 
 
413
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
416
class PathsDoNotExist(BzrNewError):
 
 
417
    """Path(s) do not exist: %(paths_as_string)s"""
 
 
419
    # used when reporting that paths are neither versioned nor in the working
 
 
422
    def __init__(self, paths):
 
 
424
        from bzrlib.osutils import quotefn
 
 
425
        BzrNewError.__init__(self)
 
 
427
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
430
class BadFileKindError(BzrNewError):
 
 
431
    """Cannot operate on %(filename)s of unsupported kind %(kind)s"""
 
 
434
class ForbiddenControlFileError(BzrNewError):
 
 
435
    """Cannot operate on %(filename)s because it is a control file"""
 
 
438
class LockError(BzrNewError):
 
 
439
    """Lock error: %(message)s"""
 
 
440
    # All exceptions from the lock/unlock functions should be from
 
 
441
    # this exception class.  They will be translated as necessary. The
 
 
442
    # original exception is available as e.original_error
 
 
444
    # New code should prefer to raise specific subclasses
 
 
445
    def __init__(self, message):
 
 
446
        self.message = message
 
 
449
class CommitNotPossible(LockError):
 
 
450
    """A commit was attempted but we do not have a write lock open."""
 
 
455
class AlreadyCommitted(LockError):
 
 
456
    """A rollback was requested, but is not able to be accomplished."""
 
 
461
class ReadOnlyError(LockError):
 
 
462
    """A write attempt was made in a read only transaction on %(obj)s"""
 
 
463
    def __init__(self, obj):
 
 
467
class OutSideTransaction(BzrNewError):
 
 
468
    """A transaction related operation was attempted after the transaction finished."""
 
 
471
class ObjectNotLocked(LockError):
 
 
472
    """%(obj)r is not locked"""
 
 
474
    is_user_error = False
 
 
476
    # this can indicate that any particular object is not locked; see also
 
 
477
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
478
    # the caller -- perhaps they should be unified.
 
 
479
    def __init__(self, obj):
 
 
483
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
484
    """Cannot change object %(obj)r in read only transaction"""
 
 
485
    def __init__(self, obj):
 
 
489
class UnlockableTransport(LockError):
 
 
490
    """Cannot lock: transport is read only: %(transport)s"""
 
 
491
    def __init__(self, transport):
 
 
492
        self.transport = transport
 
 
495
class LockContention(LockError):
 
 
496
    """Could not acquire lock %(lock)s"""
 
 
497
    # TODO: show full url for lock, combining the transport and relative bits?
 
 
498
    def __init__(self, lock):
 
 
502
class LockBroken(LockError):
 
 
503
    """Lock was broken while still open: %(lock)s - check storage consistency!"""
 
 
504
    def __init__(self, lock):
 
 
508
class LockBreakMismatch(LockError):
 
 
509
    """Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
 
 
510
    def __init__(self, lock, holder, target):
 
 
516
class LockNotHeld(LockError):
 
 
517
    """Lock not held: %(lock)s"""
 
 
518
    def __init__(self, lock):
 
 
522
class PointlessCommit(BzrNewError):
 
 
523
    """No changes to commit"""
 
 
526
class UpgradeReadonly(BzrNewError):
 
 
527
    """Upgrade URL cannot work with readonly URL's."""
 
 
530
class UpToDateFormat(BzrNewError):
 
 
531
    """The branch format %(format)s is already at the most recent format."""
 
 
533
    def __init__(self, format):
 
 
534
        BzrNewError.__init__(self)
 
 
538
class StrictCommitFailed(Exception):
 
 
539
    """Commit refused because there are unknowns in the tree."""
 
 
542
class NoSuchRevision(BzrNewError):
 
 
543
    """Branch %(branch)s has no revision %(revision)s"""
 
 
545
    is_user_error = False
 
 
547
    def __init__(self, branch, revision):
 
 
548
        BzrNewError.__init__(self, branch=branch, revision=revision)
 
 
551
class NoSuchRevisionSpec(BzrNewError):
 
 
552
    """No namespace registered for string: %(spec)r"""
 
 
554
    def __init__(self, spec):
 
 
555
        BzrNewError.__init__(self, spec=spec)
 
 
558
class InvalidRevisionSpec(BzrNewError):
 
 
559
    """Requested revision: '%(spec)s' does not exist in branch:
 
 
560
%(branch)s%(extra)s"""
 
 
562
    def __init__(self, spec, branch, extra=None):
 
 
563
        BzrNewError.__init__(self, branch=branch, spec=spec)
 
 
565
            self.extra = '\n' + str(extra)
 
 
570
class HistoryMissing(BzrError):
 
 
571
    def __init__(self, branch, object_type, object_id):
 
 
573
        BzrError.__init__(self,
 
 
574
                          '%s is missing %s {%s}'
 
 
575
                          % (branch, object_type, object_id))
 
 
578
class DivergedBranches(BzrNewError):
 
 
579
    "These branches have diverged.  Use the merge command to reconcile them."""
 
 
583
    def __init__(self, branch1, branch2):
 
 
584
        self.branch1 = branch1
 
 
585
        self.branch2 = branch2
 
 
588
class UnrelatedBranches(BzrNewError):
 
 
589
    "Branches have no common ancestor, and no merge base revision was specified."
 
 
594
class NoCommonAncestor(BzrNewError):
 
 
595
    "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
597
    def __init__(self, revision_a, revision_b):
 
 
598
        self.revision_a = revision_a
 
 
599
        self.revision_b = revision_b
 
 
602
class NoCommonRoot(BzrError):
 
 
603
    def __init__(self, revision_a, revision_b):
 
 
604
        msg = "Revisions are not derived from the same root: %s %s." \
 
 
605
            % (revision_a, revision_b) 
 
 
606
        BzrError.__init__(self, msg)
 
 
610
class NotAncestor(BzrError):
 
 
611
    def __init__(self, rev_id, not_ancestor_id):
 
 
612
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
 
614
        BzrError.__init__(self, msg)
 
 
616
        self.not_ancestor_id = not_ancestor_id
 
 
619
class InstallFailed(BzrError):
 
 
620
    def __init__(self, revisions):
 
 
621
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
 
 
622
        BzrError.__init__(self, msg)
 
 
623
        self.revisions = revisions
 
 
626
class AmbiguousBase(BzrError):
 
 
627
    def __init__(self, bases):
 
 
628
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
630
        msg = "The correct base is unclear, because %s are all equally close" %\
 
 
632
        BzrError.__init__(self, msg)
 
 
636
class NoCommits(BzrNewError):
 
 
637
    """Branch %(branch)s has no commits."""
 
 
639
    def __init__(self, branch):
 
 
640
        BzrNewError.__init__(self, branch=branch)
 
 
643
class UnlistableStore(BzrError):
 
 
644
    def __init__(self, store):
 
 
645
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
649
class UnlistableBranch(BzrError):
 
 
650
    def __init__(self, br):
 
 
651
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
654
class BoundBranchOutOfDate(BzrNewError):
 
 
655
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
 
 
656
    def __init__(self, branch, master):
 
 
657
        BzrNewError.__init__(self)
 
 
662
class CommitToDoubleBoundBranch(BzrNewError):
 
 
663
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
 
 
664
    def __init__(self, branch, master, remote):
 
 
665
        BzrNewError.__init__(self)
 
 
671
class OverwriteBoundBranch(BzrNewError):
 
 
672
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
 
 
673
    def __init__(self, branch):
 
 
674
        BzrNewError.__init__(self)
 
 
678
class BoundBranchConnectionFailure(BzrNewError):
 
 
679
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
 
 
680
    def __init__(self, branch, target, error):
 
 
681
        BzrNewError.__init__(self)
 
 
687
class WeaveError(BzrNewError):
 
 
688
    """Error in processing weave: %(message)s"""
 
 
690
    def __init__(self, message=None):
 
 
691
        BzrNewError.__init__(self)
 
 
692
        self.message = message
 
 
695
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
696
    """Revision {%(revision_id)s} already present in %(weave)s"""
 
 
697
    def __init__(self, revision_id, weave):
 
 
699
        WeaveError.__init__(self)
 
 
700
        self.revision_id = revision_id
 
 
704
class WeaveRevisionNotPresent(WeaveError):
 
 
705
    """Revision {%(revision_id)s} not present in %(weave)s"""
 
 
707
    def __init__(self, revision_id, weave):
 
 
708
        WeaveError.__init__(self)
 
 
709
        self.revision_id = revision_id
 
 
713
class WeaveFormatError(WeaveError):
 
 
714
    """Weave invariant violated: %(what)s"""
 
 
716
    def __init__(self, what):
 
 
717
        WeaveError.__init__(self)
 
 
721
class WeaveParentMismatch(WeaveError):
 
 
722
    """Parents are mismatched between two revisions."""
 
 
725
class WeaveInvalidChecksum(WeaveError):
 
 
726
    """Text did not match it's checksum: %(message)s"""
 
 
729
class WeaveTextDiffers(WeaveError):
 
 
730
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
 
732
    def __init__(self, revision_id, weave_a, weave_b):
 
 
733
        WeaveError.__init__(self)
 
 
734
        self.revision_id = revision_id
 
 
735
        self.weave_a = weave_a
 
 
736
        self.weave_b = weave_b
 
 
739
class WeaveTextDiffers(WeaveError):
 
 
740
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
 
742
    def __init__(self, revision_id, weave_a, weave_b):
 
 
743
        WeaveError.__init__(self)
 
 
744
        self.revision_id = revision_id
 
 
745
        self.weave_a = weave_a
 
 
746
        self.weave_b = weave_b
 
 
749
class VersionedFileError(BzrNewError):
 
 
750
    """Versioned file error."""
 
 
753
class RevisionNotPresent(VersionedFileError):
 
 
754
    """Revision {%(revision_id)s} not present in %(file_id)s."""
 
 
756
    def __init__(self, revision_id, file_id):
 
 
757
        VersionedFileError.__init__(self)
 
 
758
        self.revision_id = revision_id
 
 
759
        self.file_id = file_id
 
 
762
class RevisionAlreadyPresent(VersionedFileError):
 
 
763
    """Revision {%(revision_id)s} already present in %(file_id)s."""
 
 
765
    def __init__(self, revision_id, file_id):
 
 
766
        VersionedFileError.__init__(self)
 
 
767
        self.revision_id = revision_id
 
 
768
        self.file_id = file_id
 
 
771
class KnitError(BzrNewError):
 
 
775
class KnitHeaderError(KnitError):
 
 
776
    """Knit header error: %(badline)r unexpected"""
 
 
778
    def __init__(self, badline):
 
 
779
        KnitError.__init__(self)
 
 
780
        self.badline = badline
 
 
783
class KnitCorrupt(KnitError):
 
 
784
    """Knit %(filename)s corrupt: %(how)s"""
 
 
786
    def __init__(self, filename, how):
 
 
787
        KnitError.__init__(self)
 
 
788
        self.filename = filename
 
 
792
class NoSuchExportFormat(BzrNewError):
 
 
793
    """Export format %(format)r not supported"""
 
 
794
    def __init__(self, format):
 
 
795
        BzrNewError.__init__(self)
 
 
799
class TransportError(BzrNewError):
 
 
800
    """Transport error: %(msg)s %(orig_error)s"""
 
 
802
    def __init__(self, msg=None, orig_error=None):
 
 
803
        if msg is None and orig_error is not None:
 
 
804
            msg = str(orig_error)
 
 
805
        if orig_error is None:
 
 
810
        self.orig_error = orig_error
 
 
811
        BzrNewError.__init__(self)
 
 
814
class SmartProtocolError(TransportError):
 
 
815
    """Generic bzr smart protocol error: %(details)s"""
 
 
817
    def __init__(self, details):
 
 
818
        self.details = details
 
 
821
# A set of semi-meaningful errors which can be thrown
 
 
822
class TransportNotPossible(TransportError):
 
 
823
    """Transport operation not possible: %(msg)s %(orig_error)%"""
 
 
826
class ConnectionError(TransportError):
 
 
827
    """Connection error: %(msg)s %(orig_error)s"""
 
 
830
class ConnectionReset(TransportError):
 
 
831
    """Connection closed: %(msg)s %(orig_error)s"""
 
 
834
class InvalidRange(TransportError):
 
 
835
    """Invalid range access in %(path)s at %(offset)s."""
 
 
837
    def __init__(self, path, offset):
 
 
838
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
 
844
class InvalidHttpResponse(TransportError):
 
 
845
    """Invalid http response for %(path)s: %(msg)s"""
 
 
847
    def __init__(self, path, msg, orig_error=None):
 
 
849
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
852
class InvalidHttpRange(InvalidHttpResponse):
 
 
853
    """Invalid http range "%(range)s" for %(path)s: %(msg)s"""
 
 
855
    def __init__(self, path, range, msg):
 
 
857
        InvalidHttpResponse.__init__(self, path, msg)
 
 
860
class InvalidHttpContentType(InvalidHttpResponse):
 
 
861
    """Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
 
 
863
    def __init__(self, path, ctype, msg):
 
 
865
        InvalidHttpResponse.__init__(self, path, msg)
 
 
868
class ConflictsInTree(BzrError):
 
 
870
        BzrError.__init__(self, "Working tree has conflicts.")
 
 
873
class ParseConfigError(BzrError):
 
 
874
    def __init__(self, errors, filename):
 
 
877
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
878
            (filename, ('\n'.join(e.message for e in errors)))
 
 
879
        BzrError.__init__(self, message)
 
 
882
class SigningFailed(BzrError):
 
 
883
    def __init__(self, command_line):
 
 
884
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
 
 
888
class WorkingTreeNotRevision(BzrError):
 
 
889
    def __init__(self, tree):
 
 
890
        BzrError.__init__(self, "The working tree for %s has changed since"
 
 
891
                          " last commit, but weave merge requires that it be"
 
 
892
                          " unchanged." % tree.basedir)
 
 
895
class CantReprocessAndShowBase(BzrNewError):
 
 
896
    """Can't reprocess and show base.
 
 
897
Reprocessing obscures relationship of conflicting lines to base."""
 
 
900
class GraphCycleError(BzrNewError):
 
 
901
    """Cycle in graph %(graph)r"""
 
 
902
    def __init__(self, graph):
 
 
903
        BzrNewError.__init__(self)
 
 
907
class NotConflicted(BzrNewError):
 
 
908
    """File %(filename)s is not conflicted."""
 
 
910
    def __init__(self, filename):
 
 
911
        BzrNewError.__init__(self)
 
 
912
        self.filename = filename
 
 
915
class MustUseDecorated(Exception):
 
 
916
    """A decorating function has requested its original command be used.
 
 
918
    This should never escape bzr, so does not need to be printable.
 
 
922
class NoBundleFound(BzrNewError):
 
 
923
    """No bundle was found in %(filename)s"""
 
 
924
    def __init__(self, filename):
 
 
925
        BzrNewError.__init__(self)
 
 
926
        self.filename = filename
 
 
929
class BundleNotSupported(BzrNewError):
 
 
930
    """Unable to handle bundle version %(version)s: %(msg)s"""
 
 
931
    def __init__(self, version, msg):
 
 
932
        BzrNewError.__init__(self)
 
 
933
        self.version = version
 
 
937
class MissingText(BzrNewError):
 
 
938
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
 
 
940
    def __init__(self, branch, text_revision, file_id):
 
 
941
        BzrNewError.__init__(self)
 
 
943
        self.base = branch.base
 
 
944
        self.text_revision = text_revision
 
 
945
        self.file_id = file_id
 
 
948
class DuplicateKey(BzrNewError):
 
 
949
    """Key %(key)s is already present in map"""
 
 
952
class MalformedTransform(BzrNewError):
 
 
953
    """Tree transform is malformed %(conflicts)r"""
 
 
956
class BzrBadParameter(BzrNewError):
 
 
957
    """A bad parameter : %(param)s is not usable.
 
 
959
    This exception should never be thrown, but it is a base class for all
 
 
960
    parameter-to-function errors.
 
 
962
    def __init__(self, param):
 
 
963
        BzrNewError.__init__(self)
 
 
967
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
968
    """Parameter %(param)s is neither unicode nor utf8."""
 
 
971
class ReusingTransform(BzrNewError):
 
 
972
    """Attempt to reuse a transform that has already been applied."""
 
 
975
class CantMoveRoot(BzrNewError):
 
 
976
    """Moving the root directory is not supported at this time"""
 
 
979
class BzrBadParameterNotString(BzrBadParameter):
 
 
980
    """Parameter %(param)s is not a string or unicode string."""
 
 
983
class BzrBadParameterMissing(BzrBadParameter):
 
 
984
    """Parameter $(param)s is required but not present."""
 
 
987
class BzrBadParameterUnicode(BzrBadParameter):
 
 
988
    """Parameter %(param)s is unicode but only byte-strings are permitted."""
 
 
991
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
992
    """Parameter %(param)s contains a newline."""
 
 
995
class DependencyNotPresent(BzrNewError):
 
 
996
    """Unable to import library "%(library)s": %(error)s"""
 
 
998
    def __init__(self, library, error):
 
 
999
        BzrNewError.__init__(self, library=library, error=error)
 
 
1002
class ParamikoNotPresent(DependencyNotPresent):
 
 
1003
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
 
1005
    def __init__(self, error):
 
 
1006
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
1009
class PointlessMerge(BzrNewError):
 
 
1010
    """Nothing to merge."""
 
 
1013
class UninitializableFormat(BzrNewError):
 
 
1014
    """Format %(format)s cannot be initialised by this version of bzr."""
 
 
1016
    def __init__(self, format):
 
 
1017
        BzrNewError.__init__(self)
 
 
1018
        self.format = format
 
 
1021
class BadConversionTarget(BzrNewError):
 
 
1022
    """Cannot convert to format %(format)s.  %(problem)s"""
 
 
1024
    def __init__(self, problem, format):
 
 
1025
        BzrNewError.__init__(self)
 
 
1026
        self.problem = problem
 
 
1027
        self.format = format
 
 
1030
class NoDiff(BzrNewError):
 
 
1031
    """Diff is not installed on this machine: %(msg)s"""
 
 
1033
    def __init__(self, msg):
 
 
1034
        BzrNewError.__init__(self, msg=msg)
 
 
1037
class NoDiff3(BzrNewError):
 
 
1038
    """Diff3 is not installed on this machine."""
 
 
1041
class ExistingLimbo(BzrNewError):
 
 
1042
    """This tree contains left-over files from a failed operation.
 
 
1043
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1044
    keep, and delete it when you are done.
 
 
1046
    def __init__(self, limbo_dir):
 
 
1047
       BzrNewError.__init__(self)
 
 
1048
       self.limbo_dir = limbo_dir
 
 
1051
class ImmortalLimbo(BzrNewError):
 
 
1052
    """Unable to delete transform temporary directory $(limbo_dir)s.
 
 
1053
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1054
    keep, and delete it when you are done.
 
 
1056
    def __init__(self, limbo_dir):
 
 
1057
       BzrNewError.__init__(self)
 
 
1058
       self.limbo_dir = limbo_dir
 
 
1061
class OutOfDateTree(BzrNewError):
 
 
1062
    """Working tree is out of date, please run 'bzr update'."""
 
 
1064
    def __init__(self, tree):
 
 
1065
        BzrNewError.__init__(self)
 
 
1069
class MergeModifiedFormatError(BzrNewError):
 
 
1070
    """Error in merge modified format"""
 
 
1073
class ConflictFormatError(BzrNewError):
 
 
1074
    """Format error in conflict listings"""
 
 
1077
class CorruptRepository(BzrNewError):
 
 
1078
    """An error has been detected in the repository %(repo_path)s.
 
 
1079
Please run bzr reconcile on this repository."""
 
 
1081
    def __init__(self, repo):
 
 
1082
        BzrNewError.__init__(self)
 
 
1083
        self.repo_path = repo.bzrdir.root_transport.base
 
 
1086
class UpgradeRequired(BzrNewError):
 
 
1087
    """To use this feature you must upgrade your branch at %(path)s."""
 
 
1089
    def __init__(self, path):
 
 
1090
        BzrNewError.__init__(self)
 
 
1094
class LocalRequiresBoundBranch(BzrNewError):
 
 
1095
    """Cannot perform local-only commits on unbound branches."""
 
 
1098
class MissingProgressBarFinish(BzrNewError):
 
 
1099
    """A nested progress bar was not 'finished' correctly."""
 
 
1102
class InvalidProgressBarType(BzrNewError):
 
 
1103
    """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
 
1104
Select one of: %(valid_types)s"""
 
 
1106
    def __init__(self, bar_type, valid_types):
 
 
1107
        BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
1110
class UnsupportedOperation(BzrNewError):
 
 
1111
    """The method %(mname)s is not supported on objects of type %(tname)s."""
 
 
1112
    def __init__(self, method, method_self):
 
 
1113
        self.method = method
 
 
1114
        self.mname = method.__name__
 
 
1115
        self.tname = type(method_self).__name__
 
 
1118
class BinaryFile(BzrNewError):
 
 
1119
    """File is binary but should be text."""
 
 
1122
class IllegalPath(BzrNewError):
 
 
1123
    """The path %(path)s is not permitted on this platform"""
 
 
1125
    def __init__(self, path):
 
 
1126
        BzrNewError.__init__(self)
 
 
1130
class TestamentMismatch(BzrNewError):
 
 
1131
    """Testament did not match expected value.  
 
 
1132
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
 
1135
    def __init__(self, revision_id, expected, measured):
 
 
1136
        self.revision_id = revision_id
 
 
1137
        self.expected = expected
 
 
1138
        self.measured = measured
 
 
1141
class NotABundle(BzrNewError):
 
 
1142
    """Not a bzr revision-bundle: %(text)r"""
 
 
1144
    def __init__(self, text):
 
 
1145
        BzrNewError.__init__(self)
 
 
1149
class BadBundle(BzrNewError): 
 
 
1150
    """Bad bzr revision-bundle: %(text)r"""
 
 
1152
    def __init__(self, text):
 
 
1153
        BzrNewError.__init__(self)
 
 
1157
class MalformedHeader(BadBundle): 
 
 
1158
    """Malformed bzr revision-bundle header: %(text)r"""
 
 
1160
    def __init__(self, text):
 
 
1161
        BzrNewError.__init__(self)
 
 
1165
class MalformedPatches(BadBundle): 
 
 
1166
    """Malformed patches in bzr revision-bundle: %(text)r"""
 
 
1168
    def __init__(self, text):
 
 
1169
        BzrNewError.__init__(self)
 
 
1173
class MalformedFooter(BadBundle): 
 
 
1174
    """Malformed footer in bzr revision-bundle: %(text)r"""
 
 
1176
    def __init__(self, text):
 
 
1177
        BzrNewError.__init__(self)
 
 
1181
class UnsupportedEOLMarker(BadBundle):
 
 
1182
    """End of line marker was not \\n in bzr revision-bundle"""    
 
 
1185
        BzrNewError.__init__(self)
 
 
1188
class BadInventoryFormat(BzrNewError):
 
 
1189
    """Root class for inventory serialization errors"""
 
 
1192
class UnexpectedInventoryFormat(BadInventoryFormat):
 
 
1193
    """The inventory was not in the expected format:\n %(msg)s"""
 
 
1195
    def __init__(self, msg):
 
 
1196
        BadInventoryFormat.__init__(self, msg=msg)
 
 
1199
class NoSmartServer(NotBranchError):
 
 
1200
    """No smart server available at %(url)s"""
 
 
1202
    def __init__(self, url):
 
 
1206
class UnknownSSH(BzrNewError):
 
 
1207
    """Unrecognised value for BZR_SSH environment variable: %(vendor)s"""
 
 
1209
    def __init__(self, vendor):
 
 
1210
        BzrNewError.__init__(self)
 
 
1211
        self.vendor = vendor
 
 
1214
class GhostRevisionUnusableHere(BzrNewError):
 
 
1215
    """Ghost revision {%(revision_id)s} cannot be used here."""
 
 
1217
    def __init__(self, revision_id):
 
 
1218
        BzrNewError.__init__(self)
 
 
1219
        self.revision_id = revision_id
 
 
1222
class IllegalUseOfScopeReplacer(BzrNewError):
 
 
1223
    """ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"""
 
 
1225
    is_user_error = False
 
 
1227
    def __init__(self, name, msg, extra=None):
 
 
1228
        BzrNewError.__init__(self)
 
 
1232
            self.extra = ': ' + str(extra)
 
 
1237
class InvalidImportLine(BzrNewError):
 
 
1238
    """Not a valid import statement: %(msg)\n%(text)s"""
 
 
1240
    is_user_error = False
 
 
1242
    def __init__(self, text, msg):
 
 
1243
        BzrNewError.__init__(self)
 
 
1248
class ImportNameCollision(BzrNewError):
 
 
1249
    """Tried to import an object to the same name as an existing object. %(name)s"""
 
 
1251
    is_user_error = False
 
 
1253
    def __init__(self, name):
 
 
1254
        BzrNewError.__init__(self)