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 (NameError, ValueError, KeyError), e:
 
 
136
            return 'Unprintable exception %s: %s' \
 
 
137
                % (self.__class__.__name__, str(e))
 
 
140
class BzrCheckError(BzrNewError):
 
 
141
    """Internal check failed: %(message)s"""
 
 
143
    is_user_error = False
 
 
145
    def __init__(self, message):
 
 
146
        BzrNewError.__init__(self)
 
 
147
        self.message = message
 
 
150
class InvalidEntryName(BzrNewError):
 
 
151
    """Invalid entry name: %(name)s"""
 
 
153
    is_user_error = False
 
 
155
    def __init__(self, name):
 
 
156
        BzrNewError.__init__(self)
 
 
160
class InvalidRevisionNumber(BzrNewError):
 
 
161
    """Invalid revision number %(revno)d"""
 
 
162
    def __init__(self, revno):
 
 
163
        BzrNewError.__init__(self)
 
 
167
class InvalidRevisionId(BzrNewError):
 
 
168
    """Invalid revision-id {%(revision_id)s} in %(branch)s"""
 
 
170
    def __init__(self, revision_id, branch):
 
 
171
        # branch can be any string or object with __str__ defined
 
 
172
        BzrNewError.__init__(self)
 
 
173
        self.revision_id = revision_id
 
 
177
class NoSuchId(BzrNewError):
 
 
178
    """The file id %(file_id)s is not present in the tree %(tree)s."""
 
 
180
    def __init__(self, tree, file_id):
 
 
181
        BzrNewError.__init__(self)
 
 
182
        self.file_id = file_id
 
 
186
class NoWorkingTree(BzrNewError):
 
 
187
    """No WorkingTree exists for %(base)s."""
 
 
189
    def __init__(self, base):
 
 
190
        BzrNewError.__init__(self)
 
 
194
class NotLocalUrl(BzrNewError):
 
 
195
    """%(url)s is not a local path."""
 
 
197
    def __init__(self, url):
 
 
198
        BzrNewError.__init__(self)
 
 
202
class BzrCommandError(BzrNewError):
 
 
203
    """Error from user command"""
 
 
207
    # Error from malformed user command; please avoid raising this as a
 
 
208
    # generic exception not caused by user input.
 
 
210
    # I think it's a waste of effort to differentiate between errors that
 
 
211
    # are not intended to be caught anyway.  UI code need not subclass
 
 
212
    # BzrCommandError, and non-UI code should not throw a subclass of
 
 
213
    # BzrCommandError.  ADHB 20051211
 
 
214
    def __init__(self, msg):
 
 
215
        # Object.__str__() must return a real string
 
 
216
        # returning a Unicode string is a python error.
 
 
217
        if isinstance(msg, unicode):
 
 
218
            self.msg = msg.encode('utf8')
 
 
226
class BzrOptionError(BzrCommandError):
 
 
227
    """Error in command line options"""
 
 
230
class StrictCommitFailed(BzrNewError):
 
 
231
    """Commit refused because there are unknown files in the tree"""
 
 
234
# XXX: Should be unified with TransportError; they seem to represent the
 
 
236
class PathError(BzrNewError):
 
 
237
    """Generic path error: %(path)r%(extra)s)"""
 
 
239
    def __init__(self, path, extra=None):
 
 
240
        BzrNewError.__init__(self)
 
 
243
            self.extra = ': ' + str(extra)
 
 
248
class NoSuchFile(PathError):
 
 
249
    """No such file: %(path)r%(extra)s"""
 
 
252
class FileExists(PathError):
 
 
253
    """File exists: %(path)r%(extra)s"""
 
 
256
class DirectoryNotEmpty(PathError):
 
 
257
    """Directory not empty: %(path)r%(extra)s"""
 
 
260
class ResourceBusy(PathError):
 
 
261
    """Device or resource busy: %(path)r%(extra)s"""
 
 
264
class PermissionDenied(PathError):
 
 
265
    """Permission denied: %(path)r%(extra)s"""
 
 
268
class InvalidURL(PathError):
 
 
269
    """Invalid url supplied to transport: %(path)r%(extra)s"""
 
 
272
class InvalidURLJoin(PathError):
 
 
273
    """Invalid URL join request: %(args)s%(extra)s"""
 
 
275
    def __init__(self, msg, base, args):
 
 
276
        PathError.__init__(self, base, msg)
 
 
278
        self.args.extend(args)
 
 
281
class UnsupportedProtocol(PathError):
 
 
282
    """Unsupported protocol for url "%(path)s"%(extra)s"""
 
 
284
    def __init__(self, url, extra):
 
 
285
        PathError.__init__(self, url, extra=extra)
 
 
288
class PathNotChild(BzrNewError):
 
 
289
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
 
 
291
    is_user_error = False
 
 
293
    def __init__(self, path, base, extra=None):
 
 
294
        BzrNewError.__init__(self)
 
 
298
            self.extra = ': ' + str(extra)
 
 
303
class InvalidNormalization(PathError):
 
 
304
    """Path %(path)r is not unicode normalized"""
 
 
307
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
 
308
# the exception object is a bit undesirable.
 
 
309
# TODO: Probably this behavior of should be a common superclass 
 
 
310
class NotBranchError(PathError):
 
 
311
    """Not a branch: %(path)s"""
 
 
313
    def __init__(self, path):
 
 
314
       import bzrlib.urlutils as urlutils
 
 
315
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
 
318
class AlreadyBranchError(PathError):
 
 
319
    """Already a branch: %(path)s."""
 
 
322
class BranchExistsWithoutWorkingTree(PathError):
 
 
323
    """Directory contains a branch, but no working tree \
 
 
324
(use bzr checkout if you wish to build a working tree): %(path)s"""
 
 
327
class AtomicFileAlreadyClosed(PathError):
 
 
328
    """'%(function)s' called on an AtomicFile after it was closed: %(path)s"""
 
 
330
    def __init__(self, path, function):
 
 
331
        PathError.__init__(self, path=path, extra=None)
 
 
332
        self.function = function
 
 
335
class InaccessibleParent(PathError):
 
 
336
    """Parent not accessible given base %(base)s and relative path %(path)s"""
 
 
338
    def __init__(self, path, base):
 
 
339
        PathError.__init__(self, path)
 
 
343
class NoRepositoryPresent(BzrNewError):
 
 
344
    """No repository present: %(path)r"""
 
 
345
    def __init__(self, bzrdir):
 
 
346
        BzrNewError.__init__(self)
 
 
347
        self.path = bzrdir.transport.clone('..').base
 
 
350
class FileInWrongBranch(BzrNewError):
 
 
351
    """File %(path)s in not in branch %(branch_base)s."""
 
 
353
    def __init__(self, branch, path):
 
 
354
        BzrNewError.__init__(self)
 
 
356
        self.branch_base = branch.base
 
 
360
class UnsupportedFormatError(BzrNewError):
 
 
361
    """Unsupported branch format: %(format)s"""
 
 
364
class UnknownFormatError(BzrNewError):
 
 
365
    """Unknown branch format: %(format)r"""
 
 
368
class IncompatibleFormat(BzrNewError):
 
 
369
    """Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
 
 
371
    def __init__(self, format, bzrdir_format):
 
 
372
        BzrNewError.__init__(self)
 
 
374
        self.bzrdir = bzrdir_format
 
 
377
class NotVersionedError(BzrNewError):
 
 
378
    """%(path)s is not versioned"""
 
 
379
    def __init__(self, path):
 
 
380
        BzrNewError.__init__(self)
 
 
384
class PathsNotVersionedError(BzrNewError):
 
 
385
    # used when reporting several paths are not versioned
 
 
386
    """Path(s) are not versioned: %(paths_as_string)s"""
 
 
388
    def __init__(self, paths):
 
 
389
        from bzrlib.osutils import quotefn
 
 
390
        BzrNewError.__init__(self)
 
 
392
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
395
class PathsDoNotExist(BzrNewError):
 
 
396
    """Path(s) do not exist: %(paths_as_string)s"""
 
 
398
    # used when reporting that paths are neither versioned nor in the working
 
 
401
    def __init__(self, paths):
 
 
403
        from bzrlib.osutils import quotefn
 
 
404
        BzrNewError.__init__(self)
 
 
406
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
 
409
class BadFileKindError(BzrNewError):
 
 
410
    """Cannot operate on %(filename)s of unsupported kind %(kind)s"""
 
 
413
class ForbiddenControlFileError(BzrNewError):
 
 
414
    """Cannot operate on %(filename)s because it is a control file"""
 
 
417
class LockError(BzrNewError):
 
 
418
    """Lock error: %(message)s"""
 
 
419
    # All exceptions from the lock/unlock functions should be from
 
 
420
    # this exception class.  They will be translated as necessary. The
 
 
421
    # original exception is available as e.original_error
 
 
423
    # New code should prefer to raise specific subclasses
 
 
424
    def __init__(self, message):
 
 
425
        self.message = message
 
 
428
class CommitNotPossible(LockError):
 
 
429
    """A commit was attempted but we do not have a write lock open."""
 
 
434
class AlreadyCommitted(LockError):
 
 
435
    """A rollback was requested, but is not able to be accomplished."""
 
 
440
class ReadOnlyError(LockError):
 
 
441
    """A write attempt was made in a read only transaction on %(obj)s"""
 
 
442
    def __init__(self, obj):
 
 
446
class OutSideTransaction(BzrNewError):
 
 
447
    """A transaction related operation was attempted after the transaction finished."""
 
 
450
class ObjectNotLocked(LockError):
 
 
451
    """%(obj)r is not locked"""
 
 
453
    is_user_error = False
 
 
455
    # this can indicate that any particular object is not locked; see also
 
 
456
    # LockNotHeld which means that a particular *lock* object is not held by
 
 
457
    # the caller -- perhaps they should be unified.
 
 
458
    def __init__(self, obj):
 
 
462
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
 
463
    """Cannot change object %(obj)r in read only transaction"""
 
 
464
    def __init__(self, obj):
 
 
468
class UnlockableTransport(LockError):
 
 
469
    """Cannot lock: transport is read only: %(transport)s"""
 
 
470
    def __init__(self, transport):
 
 
471
        self.transport = transport
 
 
474
class LockContention(LockError):
 
 
475
    """Could not acquire lock %(lock)s"""
 
 
476
    # TODO: show full url for lock, combining the transport and relative bits?
 
 
477
    def __init__(self, lock):
 
 
481
class LockBroken(LockError):
 
 
482
    """Lock was broken while still open: %(lock)s - check storage consistency!"""
 
 
483
    def __init__(self, lock):
 
 
487
class LockBreakMismatch(LockError):
 
 
488
    """Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
 
 
489
    def __init__(self, lock, holder, target):
 
 
495
class LockNotHeld(LockError):
 
 
496
    """Lock not held: %(lock)s"""
 
 
497
    def __init__(self, lock):
 
 
501
class PointlessCommit(BzrNewError):
 
 
502
    """No changes to commit"""
 
 
505
class UpgradeReadonly(BzrNewError):
 
 
506
    """Upgrade URL cannot work with readonly URL's."""
 
 
509
class UpToDateFormat(BzrNewError):
 
 
510
    """The branch format %(format)s is already at the most recent format."""
 
 
512
    def __init__(self, format):
 
 
513
        BzrNewError.__init__(self)
 
 
517
class StrictCommitFailed(Exception):
 
 
518
    """Commit refused because there are unknowns in the tree."""
 
 
521
class NoSuchRevision(BzrNewError):
 
 
522
    """Branch %(branch)s has no revision %(revision)s"""
 
 
524
    is_user_error = False
 
 
526
    def __init__(self, branch, revision):
 
 
527
        BzrNewError.__init__(self, branch=branch, revision=revision)
 
 
530
class NoSuchRevisionSpec(BzrNewError):
 
 
531
    """No namespace registered for string: %(spec)r"""
 
 
533
    def __init__(self, spec):
 
 
534
        BzrNewError.__init__(self, spec=spec)
 
 
537
class InvalidRevisionSpec(BzrNewError):
 
 
538
    """Requested revision: '%(spec)s' does not exist in branch:
 
 
539
%(branch)s%(extra)s"""
 
 
541
    def __init__(self, spec, branch, extra=None):
 
 
542
        BzrNewError.__init__(self, branch=branch, spec=spec)
 
 
544
            self.extra = '\n' + str(extra)
 
 
549
class HistoryMissing(BzrError):
 
 
550
    def __init__(self, branch, object_type, object_id):
 
 
552
        BzrError.__init__(self,
 
 
553
                          '%s is missing %s {%s}'
 
 
554
                          % (branch, object_type, object_id))
 
 
557
class DivergedBranches(BzrNewError):
 
 
558
    "These branches have diverged.  Use the merge command to reconcile them."""
 
 
562
    def __init__(self, branch1, branch2):
 
 
563
        self.branch1 = branch1
 
 
564
        self.branch2 = branch2
 
 
567
class UnrelatedBranches(BzrNewError):
 
 
568
    "Branches have no common ancestor, and no merge base revision was specified."
 
 
573
class NoCommonAncestor(BzrNewError):
 
 
574
    "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
 
576
    def __init__(self, revision_a, revision_b):
 
 
577
        self.revision_a = revision_a
 
 
578
        self.revision_b = revision_b
 
 
581
class NoCommonRoot(BzrError):
 
 
582
    def __init__(self, revision_a, revision_b):
 
 
583
        msg = "Revisions are not derived from the same root: %s %s." \
 
 
584
            % (revision_a, revision_b) 
 
 
585
        BzrError.__init__(self, msg)
 
 
589
class NotAncestor(BzrError):
 
 
590
    def __init__(self, rev_id, not_ancestor_id):
 
 
591
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
 
593
        BzrError.__init__(self, msg)
 
 
595
        self.not_ancestor_id = not_ancestor_id
 
 
598
class InstallFailed(BzrError):
 
 
599
    def __init__(self, revisions):
 
 
600
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
 
 
601
        BzrError.__init__(self, msg)
 
 
602
        self.revisions = revisions
 
 
605
class AmbiguousBase(BzrError):
 
 
606
    def __init__(self, bases):
 
 
607
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
 
609
        msg = "The correct base is unclear, because %s are all equally close" %\
 
 
611
        BzrError.__init__(self, msg)
 
 
615
class NoCommits(BzrNewError):
 
 
616
    """Branch %(branch)s has no commits."""
 
 
618
    def __init__(self, branch):
 
 
619
        BzrNewError.__init__(self, branch=branch)
 
 
622
class UnlistableStore(BzrError):
 
 
623
    def __init__(self, store):
 
 
624
        BzrError.__init__(self, "Store %s is not listable" % store)
 
 
628
class UnlistableBranch(BzrError):
 
 
629
    def __init__(self, br):
 
 
630
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
 
633
class BoundBranchOutOfDate(BzrNewError):
 
 
634
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
 
 
635
    def __init__(self, branch, master):
 
 
636
        BzrNewError.__init__(self)
 
 
641
class CommitToDoubleBoundBranch(BzrNewError):
 
 
642
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
 
 
643
    def __init__(self, branch, master, remote):
 
 
644
        BzrNewError.__init__(self)
 
 
650
class OverwriteBoundBranch(BzrNewError):
 
 
651
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
 
 
652
    def __init__(self, branch):
 
 
653
        BzrNewError.__init__(self)
 
 
657
class BoundBranchConnectionFailure(BzrNewError):
 
 
658
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
 
 
659
    def __init__(self, branch, target, error):
 
 
660
        BzrNewError.__init__(self)
 
 
666
class WeaveError(BzrNewError):
 
 
667
    """Error in processing weave: %(message)s"""
 
 
669
    def __init__(self, message=None):
 
 
670
        BzrNewError.__init__(self)
 
 
671
        self.message = message
 
 
674
class WeaveRevisionAlreadyPresent(WeaveError):
 
 
675
    """Revision {%(revision_id)s} already present in %(weave)s"""
 
 
676
    def __init__(self, revision_id, weave):
 
 
678
        WeaveError.__init__(self)
 
 
679
        self.revision_id = revision_id
 
 
683
class WeaveRevisionNotPresent(WeaveError):
 
 
684
    """Revision {%(revision_id)s} not present in %(weave)s"""
 
 
686
    def __init__(self, revision_id, weave):
 
 
687
        WeaveError.__init__(self)
 
 
688
        self.revision_id = revision_id
 
 
692
class WeaveFormatError(WeaveError):
 
 
693
    """Weave invariant violated: %(what)s"""
 
 
695
    def __init__(self, what):
 
 
696
        WeaveError.__init__(self)
 
 
700
class WeaveParentMismatch(WeaveError):
 
 
701
    """Parents are mismatched between two revisions."""
 
 
704
class WeaveInvalidChecksum(WeaveError):
 
 
705
    """Text did not match it's checksum: %(message)s"""
 
 
708
class WeaveTextDiffers(WeaveError):
 
 
709
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
 
711
    def __init__(self, revision_id, weave_a, weave_b):
 
 
712
        WeaveError.__init__(self)
 
 
713
        self.revision_id = revision_id
 
 
714
        self.weave_a = weave_a
 
 
715
        self.weave_b = weave_b
 
 
718
class WeaveTextDiffers(WeaveError):
 
 
719
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
 
721
    def __init__(self, revision_id, weave_a, weave_b):
 
 
722
        WeaveError.__init__(self)
 
 
723
        self.revision_id = revision_id
 
 
724
        self.weave_a = weave_a
 
 
725
        self.weave_b = weave_b
 
 
728
class VersionedFileError(BzrNewError):
 
 
729
    """Versioned file error."""
 
 
732
class RevisionNotPresent(VersionedFileError):
 
 
733
    """Revision {%(revision_id)s} not present in %(file_id)s."""
 
 
735
    def __init__(self, revision_id, file_id):
 
 
736
        VersionedFileError.__init__(self)
 
 
737
        self.revision_id = revision_id
 
 
738
        self.file_id = file_id
 
 
741
class RevisionAlreadyPresent(VersionedFileError):
 
 
742
    """Revision {%(revision_id)s} already present in %(file_id)s."""
 
 
744
    def __init__(self, revision_id, file_id):
 
 
745
        VersionedFileError.__init__(self)
 
 
746
        self.revision_id = revision_id
 
 
747
        self.file_id = file_id
 
 
750
class KnitError(BzrNewError):
 
 
754
class KnitHeaderError(KnitError):
 
 
755
    """Knit header error: %(badline)r unexpected"""
 
 
757
    def __init__(self, badline):
 
 
758
        KnitError.__init__(self)
 
 
759
        self.badline = badline
 
 
762
class KnitCorrupt(KnitError):
 
 
763
    """Knit %(filename)s corrupt: %(how)s"""
 
 
765
    def __init__(self, filename, how):
 
 
766
        KnitError.__init__(self)
 
 
767
        self.filename = filename
 
 
771
class NoSuchExportFormat(BzrNewError):
 
 
772
    """Export format %(format)r not supported"""
 
 
773
    def __init__(self, format):
 
 
774
        BzrNewError.__init__(self)
 
 
778
class TransportError(BzrNewError):
 
 
779
    """Transport error: %(msg)s %(orig_error)s"""
 
 
781
    def __init__(self, msg=None, orig_error=None):
 
 
782
        if msg is None and orig_error is not None:
 
 
783
            msg = str(orig_error)
 
 
784
        if orig_error is None:
 
 
789
        self.orig_error = orig_error
 
 
790
        BzrNewError.__init__(self)
 
 
793
# A set of semi-meaningful errors which can be thrown
 
 
794
class TransportNotPossible(TransportError):
 
 
795
    """Transport operation not possible: %(msg)s %(orig_error)%"""
 
 
798
class ConnectionError(TransportError):
 
 
799
    """Connection error: %(msg)s %(orig_error)s"""
 
 
802
class ConnectionReset(TransportError):
 
 
803
    """Connection closed: %(msg)s %(orig_error)s"""
 
 
806
class InvalidRange(TransportError):
 
 
807
    """Invalid range access in %(path)s at %(offset)s."""
 
 
809
    def __init__(self, path, offset):
 
 
810
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
 
816
class InvalidHttpResponse(TransportError):
 
 
817
    """Invalid http response for %(path)s: %(msg)s"""
 
 
819
    def __init__(self, path, msg, orig_error=None):
 
 
821
        TransportError.__init__(self, msg, orig_error=orig_error)
 
 
824
class InvalidHttpRange(InvalidHttpResponse):
 
 
825
    """Invalid http range "%(range)s" for %(path)s: %(msg)s"""
 
 
827
    def __init__(self, path, range, msg):
 
 
829
        InvalidHttpResponse.__init__(self, path, msg)
 
 
832
class InvalidHttpContentType(InvalidHttpResponse):
 
 
833
    """Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
 
 
835
    def __init__(self, path, ctype, msg):
 
 
837
        InvalidHttpResponse.__init__(self, path, msg)
 
 
840
class ConflictsInTree(BzrError):
 
 
842
        BzrError.__init__(self, "Working tree has conflicts.")
 
 
845
class ParseConfigError(BzrError):
 
 
846
    def __init__(self, errors, filename):
 
 
849
        message = "Error(s) parsing config file %s:\n%s" % \
 
 
850
            (filename, ('\n'.join(e.message for e in errors)))
 
 
851
        BzrError.__init__(self, message)
 
 
854
class SigningFailed(BzrError):
 
 
855
    def __init__(self, command_line):
 
 
856
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
 
 
860
class WorkingTreeNotRevision(BzrError):
 
 
861
    def __init__(self, tree):
 
 
862
        BzrError.__init__(self, "The working tree for %s has changed since"
 
 
863
                          " last commit, but weave merge requires that it be"
 
 
864
                          " unchanged." % tree.basedir)
 
 
867
class CantReprocessAndShowBase(BzrNewError):
 
 
868
    """Can't reprocess and show base.
 
 
869
Reprocessing obscures relationship of conflicting lines to base."""
 
 
872
class GraphCycleError(BzrNewError):
 
 
873
    """Cycle in graph %(graph)r"""
 
 
874
    def __init__(self, graph):
 
 
875
        BzrNewError.__init__(self)
 
 
879
class NotConflicted(BzrNewError):
 
 
880
    """File %(filename)s is not conflicted."""
 
 
882
    def __init__(self, filename):
 
 
883
        BzrNewError.__init__(self)
 
 
884
        self.filename = filename
 
 
887
class MustUseDecorated(Exception):
 
 
888
    """A decorating function has requested its original command be used.
 
 
890
    This should never escape bzr, so does not need to be printable.
 
 
894
class NoBundleFound(BzrNewError):
 
 
895
    """No bundle was found in %(filename)s"""
 
 
896
    def __init__(self, filename):
 
 
897
        BzrNewError.__init__(self)
 
 
898
        self.filename = filename
 
 
901
class BundleNotSupported(BzrNewError):
 
 
902
    """Unable to handle bundle version %(version)s: %(msg)s"""
 
 
903
    def __init__(self, version, msg):
 
 
904
        BzrNewError.__init__(self)
 
 
905
        self.version = version
 
 
909
class MissingText(BzrNewError):
 
 
910
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
 
 
912
    def __init__(self, branch, text_revision, file_id):
 
 
913
        BzrNewError.__init__(self)
 
 
915
        self.base = branch.base
 
 
916
        self.text_revision = text_revision
 
 
917
        self.file_id = file_id
 
 
920
class DuplicateKey(BzrNewError):
 
 
921
    """Key %(key)s is already present in map"""
 
 
924
class MalformedTransform(BzrNewError):
 
 
925
    """Tree transform is malformed %(conflicts)r"""
 
 
928
class BzrBadParameter(BzrNewError):
 
 
929
    """A bad parameter : %(param)s is not usable.
 
 
931
    This exception should never be thrown, but it is a base class for all
 
 
932
    parameter-to-function errors.
 
 
934
    def __init__(self, param):
 
 
935
        BzrNewError.__init__(self)
 
 
939
class BzrBadParameterNotUnicode(BzrBadParameter):
 
 
940
    """Parameter %(param)s is neither unicode nor utf8."""
 
 
943
class ReusingTransform(BzrNewError):
 
 
944
    """Attempt to reuse a transform that has already been applied."""
 
 
947
class CantMoveRoot(BzrNewError):
 
 
948
    """Moving the root directory is not supported at this time"""
 
 
951
class BzrBadParameterNotString(BzrBadParameter):
 
 
952
    """Parameter %(param)s is not a string or unicode string."""
 
 
955
class BzrBadParameterMissing(BzrBadParameter):
 
 
956
    """Parameter $(param)s is required but not present."""
 
 
959
class BzrBadParameterUnicode(BzrBadParameter):
 
 
960
    """Parameter %(param)s is unicode but only byte-strings are permitted."""
 
 
963
class BzrBadParameterContainsNewline(BzrBadParameter):
 
 
964
    """Parameter %(param)s contains a newline."""
 
 
967
class DependencyNotPresent(BzrNewError):
 
 
968
    """Unable to import library "%(library)s": %(error)s"""
 
 
970
    def __init__(self, library, error):
 
 
971
        BzrNewError.__init__(self, library=library, error=error)
 
 
974
class ParamikoNotPresent(DependencyNotPresent):
 
 
975
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
 
977
    def __init__(self, error):
 
 
978
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
 
981
class PointlessMerge(BzrNewError):
 
 
982
    """Nothing to merge."""
 
 
985
class UninitializableFormat(BzrNewError):
 
 
986
    """Format %(format)s cannot be initialised by this version of bzr."""
 
 
988
    def __init__(self, format):
 
 
989
        BzrNewError.__init__(self)
 
 
993
class NoDiff(BzrNewError):
 
 
994
    """Diff is not installed on this machine: %(msg)s"""
 
 
996
    def __init__(self, msg):
 
 
997
        BzrNewError.__init__(self, msg=msg)
 
 
1000
class NoDiff3(BzrNewError):
 
 
1001
    """Diff3 is not installed on this machine."""
 
 
1004
class ExistingLimbo(BzrNewError):
 
 
1005
    """This tree contains left-over files from a failed operation.
 
 
1006
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1007
    keep, and delete it when you are done.
 
 
1009
    def __init__(self, limbo_dir):
 
 
1010
       BzrNewError.__init__(self)
 
 
1011
       self.limbo_dir = limbo_dir
 
 
1014
class ImmortalLimbo(BzrNewError):
 
 
1015
    """Unable to delete transform temporary directory $(limbo_dir)s.
 
 
1016
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
 
1017
    keep, and delete it when you are done.
 
 
1019
    def __init__(self, limbo_dir):
 
 
1020
       BzrNewError.__init__(self)
 
 
1021
       self.limbo_dir = limbo_dir
 
 
1024
class OutOfDateTree(BzrNewError):
 
 
1025
    """Working tree is out of date, please run 'bzr update'."""
 
 
1027
    def __init__(self, tree):
 
 
1028
        BzrNewError.__init__(self)
 
 
1032
class MergeModifiedFormatError(BzrNewError):
 
 
1033
    """Error in merge modified format"""
 
 
1036
class ConflictFormatError(BzrNewError):
 
 
1037
    """Format error in conflict listings"""
 
 
1040
class CorruptRepository(BzrNewError):
 
 
1041
    """An error has been detected in the repository %(repo_path)s.
 
 
1042
Please run bzr reconcile on this repository."""
 
 
1044
    def __init__(self, repo):
 
 
1045
        BzrNewError.__init__(self)
 
 
1046
        self.repo_path = repo.bzrdir.root_transport.base
 
 
1049
class UpgradeRequired(BzrNewError):
 
 
1050
    """To use this feature you must upgrade your branch at %(path)s."""
 
 
1052
    def __init__(self, path):
 
 
1053
        BzrNewError.__init__(self)
 
 
1057
class LocalRequiresBoundBranch(BzrNewError):
 
 
1058
    """Cannot perform local-only commits on unbound branches."""
 
 
1061
class MissingProgressBarFinish(BzrNewError):
 
 
1062
    """A nested progress bar was not 'finished' correctly."""
 
 
1065
class InvalidProgressBarType(BzrNewError):
 
 
1066
    """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
 
1067
Select one of: %(valid_types)s"""
 
 
1069
    def __init__(self, bar_type, valid_types):
 
 
1070
        BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
 
1073
class UnsupportedOperation(BzrNewError):
 
 
1074
    """The method %(mname)s is not supported on objects of type %(tname)s."""
 
 
1075
    def __init__(self, method, method_self):
 
 
1076
        self.method = method
 
 
1077
        self.mname = method.__name__
 
 
1078
        self.tname = type(method_self).__name__
 
 
1081
class BinaryFile(BzrNewError):
 
 
1082
    """File is binary but should be text."""
 
 
1085
class IllegalPath(BzrNewError):
 
 
1086
    """The path %(path)s is not permitted on this platform"""
 
 
1088
    def __init__(self, path):
 
 
1089
        BzrNewError.__init__(self)
 
 
1093
class TestamentMismatch(BzrNewError):
 
 
1094
    """Testament did not match expected value.  
 
 
1095
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
 
1098
    def __init__(self, revision_id, expected, measured):
 
 
1099
        self.revision_id = revision_id
 
 
1100
        self.expected = expected
 
 
1101
        self.measured = measured
 
 
1104
class NotABundle(BzrNewError):
 
 
1105
    """Not a bzr revision-bundle: %(text)r"""
 
 
1107
    def __init__(self, text):
 
 
1108
        BzrNewError.__init__(self)
 
 
1112
class BadBundle(BzrNewError): 
 
 
1113
    """Bad bzr revision-bundle: %(text)r"""
 
 
1115
    def __init__(self, text):
 
 
1116
        BzrNewError.__init__(self)
 
 
1120
class MalformedHeader(BadBundle): 
 
 
1121
    """Malformed bzr revision-bundle header: %(text)r"""
 
 
1123
    def __init__(self, text):
 
 
1124
        BzrNewError.__init__(self)
 
 
1128
class MalformedPatches(BadBundle): 
 
 
1129
    """Malformed patches in bzr revision-bundle: %(text)r"""
 
 
1131
    def __init__(self, text):
 
 
1132
        BzrNewError.__init__(self)
 
 
1136
class MalformedFooter(BadBundle): 
 
 
1137
    """Malformed footer in bzr revision-bundle: %(text)r"""
 
 
1139
    def __init__(self, text):
 
 
1140
        BzrNewError.__init__(self)
 
 
1144
class UnsupportedEOLMarker(BadBundle):
 
 
1145
    """End of line marker was not \\n in bzr revision-bundle"""    
 
 
1148
        BzrNewError.__init__(self)
 
 
1151
class UnknownSSH(BzrNewError):
 
 
1152
    """Unrecognised value for BZR_SSH environment variable: %(vendor)s"""
 
 
1154
    def __init__(self, vendor):
 
 
1155
        BzrNewError.__init__(self)
 
 
1156
        self.vendor = vendor
 
 
1159
class GhostRevisionUnusableHere(BzrNewError):
 
 
1160
    """Ghost revision {%(revision_id)s} cannot be used here."""
 
 
1162
    def __init__(self, revision_id):
 
 
1163
        BzrNewError.__init__(self)
 
 
1164
        self.revision_id = revision_id
 
 
1167
class IllegalUseOfScopeReplacer(BzrNewError):
 
 
1168
    """ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"""
 
 
1170
    is_user_error = False
 
 
1172
    def __init__(self, name, msg, extra=None):
 
 
1173
        BzrNewError.__init__(self)
 
 
1177
            self.extra = ': ' + str(extra)
 
 
1182
class InvalidImportLine(BzrNewError):
 
 
1183
    """Not a valid import statement: %(msg)\n%(text)s"""
 
 
1185
    is_user_error = False
 
 
1187
    def __init__(self, text, msg):
 
 
1188
        BzrNewError.__init__(self)
 
 
1193
class ImportNameCollision(BzrNewError):
 
 
1194
    """Tried to import an object to the same name as an existing object. %(name)s"""
 
 
1196
    is_user_error = False
 
 
1198
    def __init__(self, name):
 
 
1199
        BzrNewError.__init__(self)