~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Jelmer Vernooij
  • Date: 2012-08-28 20:49:22 UTC
  • mto: This revision was merged to the branch mainline in revision 6556.
  • Revision ID: jelmer@samba.org-20120828204922-o8ok2komaeab6o2v
Inline traceback specification.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
17
17
"""Exceptions for bzr, and reporting of them.
18
18
"""
19
19
 
20
 
from bzrlib import (
21
 
    osutils,
22
 
    symbol_versioning,
23
 
    )
24
 
from bzrlib.patches import (
25
 
    MalformedHunkHeader,
26
 
    MalformedLine,
27
 
    MalformedPatchHeader,
28
 
    PatchConflict,
29
 
    PatchSyntax,
30
 
    )
31
 
 
 
20
from __future__ import absolute_import
32
21
 
33
22
# TODO: is there any value in providing the .args field used by standard
34
23
# python exceptions?   A list of values with no names seems less useful
54
43
    Base class for errors raised by bzrlib.
55
44
 
56
45
    :cvar internal_error: if True this was probably caused by a bzr bug and
57
 
    should be displayed with a traceback; if False (or absent) this was
58
 
    probably a user or environment error and they don't need the gory details.
59
 
    (That can be overridden by -Derror on the command line.)
 
46
        should be displayed with a traceback; if False (or absent) this was
 
47
        probably a user or environment error and they don't need the gory
 
48
        details.  (That can be overridden by -Derror on the command line.)
60
49
 
61
50
    :cvar _fmt: Format string to display the error; this is expanded
62
 
    by the instance's dict.
 
51
        by the instance's dict.
63
52
    """
64
53
 
65
54
    internal_error = False
106
95
                # __str__() should always return a 'str' object
107
96
                # never a 'unicode' object.
108
97
                return s
109
 
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
110
 
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
111
 
                % (self.__class__.__name__,
112
 
                   self.__dict__,
113
 
                   getattr(self, '_fmt', None),
114
 
                   e)
 
98
        except Exception, e:
 
99
            pass # just bind to 'e' for formatting below
 
100
        else:
 
101
            e = None
 
102
        return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
103
            % (self.__class__.__name__,
 
104
               self.__dict__,
 
105
               getattr(self, '_fmt', None),
 
106
               e)
115
107
 
116
108
    def __unicode__(self):
117
109
        u = self._format()
140
132
        """Return format string for this exception or None"""
141
133
        fmt = getattr(self, '_fmt', None)
142
134
        if fmt is not None:
143
 
            return fmt
144
 
        fmt = getattr(self, '__doc__', None)
145
 
        if fmt is not None:
146
 
            symbol_versioning.warn("%s uses its docstring as a format, "
147
 
                    "it should use _fmt instead" % self.__class__.__name__,
148
 
                    DeprecationWarning)
149
 
            return fmt
150
 
        return 'Unprintable exception %s: dict=%r, fmt=%r' \
151
 
            % (self.__class__.__name__,
152
 
               self.__dict__,
153
 
               getattr(self, '_fmt', None),
154
 
               )
 
135
            from bzrlib.i18n import gettext
 
136
            return gettext(unicode(fmt)) # _fmt strings should be ascii
155
137
 
156
138
    def __eq__(self, other):
157
139
        if self.__class__ is not other.__class__:
170
152
    internal_error = True
171
153
 
172
154
 
173
 
class BzrNewError(BzrError):
174
 
    """Deprecated error base class."""
175
 
    # base classes should override the docstring with their human-
176
 
    # readable explanation
177
 
 
178
 
    def __init__(self, *args, **kwds):
179
 
        # XXX: Use the underlying BzrError to always generate the args
180
 
        # attribute if it doesn't exist.  We can't use super here, because
181
 
        # exceptions are old-style classes in python2.4 (but new in 2.5).
182
 
        # --bmc, 20060426
183
 
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
184
 
             'please convert %s to use BzrError instead'
185
 
             % self.__class__.__name__,
186
 
             DeprecationWarning,
187
 
             stacklevel=2)
188
 
        BzrError.__init__(self, *args)
189
 
        for key, value in kwds.items():
190
 
            setattr(self, key, value)
191
 
 
192
 
    def __str__(self):
193
 
        try:
194
 
            # __str__() should always return a 'str' object
195
 
            # never a 'unicode' object.
196
 
            s = self.__doc__ % self.__dict__
197
 
            if isinstance(s, unicode):
198
 
                return s.encode('utf8')
199
 
            return s
200
 
        except (TypeError, NameError, ValueError, KeyError), e:
201
 
            return 'Unprintable exception %s(%r): %r' \
202
 
                % (self.__class__.__name__,
203
 
                   self.__dict__, e)
204
 
 
205
 
 
206
155
class AlreadyBuilding(BzrError):
207
156
 
208
157
    _fmt = "The tree builder is already building a tree."
304
253
class RootMissing(InternalBzrError):
305
254
 
306
255
    _fmt = ("The root entry of a tree must be the first entry supplied to "
307
 
        "record_entry_contents.")
 
256
        "the commit builder.")
308
257
 
309
258
 
310
259
class NoPublicBranch(BzrError):
621
570
 
622
571
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
623
572
 
624
 
    def __init__(self, url, extra):
 
573
    def __init__(self, url, extra=""):
625
574
        PathError.__init__(self, url, extra=extra)
626
575
 
627
576
 
636
585
        self.url = url
637
586
 
638
587
 
 
588
class UnstackableLocationError(BzrError):
 
589
 
 
590
    _fmt = "The branch '%(branch_url)s' cannot be stacked on '%(target_url)s'."
 
591
 
 
592
    def __init__(self, branch_url, target_url):
 
593
        BzrError.__init__(self)
 
594
        self.branch_url = branch_url
 
595
        self.target_url = target_url
 
596
 
 
597
 
639
598
class UnstackableRepositoryFormat(BzrError):
640
599
 
641
600
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
670
629
 
671
630
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
672
631
 
673
 
    internal_error = True
 
632
    internal_error = False
674
633
 
675
634
    def __init__(self, path, base, extra=None):
676
635
        BzrError.__init__(self)
692
651
# TODO: Probably this behavior of should be a common superclass
693
652
class NotBranchError(PathError):
694
653
 
695
 
    _fmt = 'Not a branch: "%(path)s".'
 
654
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
696
655
 
697
 
    def __init__(self, path):
 
656
    def __init__(self, path, detail=None, bzrdir=None):
698
657
       import bzrlib.urlutils as urlutils
699
 
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
658
       path = urlutils.unescape_for_display(path, 'ascii')
 
659
       if detail is not None:
 
660
           detail = ': ' + detail
 
661
       self.detail = detail
 
662
       self.bzrdir = bzrdir
 
663
       PathError.__init__(self, path=path)
 
664
 
 
665
    def __repr__(self):
 
666
        return '<%s %r>' % (self.__class__.__name__, self.__dict__)
 
667
 
 
668
    def _format(self):
 
669
        # XXX: Ideally self.detail would be a property, but Exceptions in
 
670
        # Python 2.4 have to be old-style classes so properties don't work.
 
671
        # Instead we override _format.
 
672
        if self.detail is None:
 
673
            if self.bzrdir is not None:
 
674
                try:
 
675
                    self.bzrdir.open_repository()
 
676
                except NoRepositoryPresent:
 
677
                    self.detail = ''
 
678
                except Exception:
 
679
                    # Just ignore unexpected errors.  Raising arbitrary errors
 
680
                    # during str(err) can provoke strange bugs.  Concretely
 
681
                    # Launchpad's codehosting managed to raise NotBranchError
 
682
                    # here, and then get stuck in an infinite loop/recursion
 
683
                    # trying to str() that error.  All this error really cares
 
684
                    # about that there's no working repository there, and if
 
685
                    # open_repository() fails, there probably isn't.
 
686
                    self.detail = ''
 
687
                else:
 
688
                    self.detail = ': location is a repository'
 
689
            else:
 
690
                self.detail = ''
 
691
        return PathError._format(self)
700
692
 
701
693
 
702
694
class NoSubmitBranch(PathError):
708
700
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
709
701
 
710
702
 
 
703
class AlreadyControlDirError(PathError):
 
704
 
 
705
    _fmt = 'A control directory already exists: "%(path)s".'
 
706
 
 
707
 
711
708
class AlreadyBranchError(PathError):
712
709
 
713
710
    _fmt = 'Already a branch: "%(path)s".'
714
711
 
715
712
 
 
713
class InvalidBranchName(PathError):
 
714
 
 
715
    _fmt = "Invalid branch name: %(name)s"
 
716
 
 
717
    def __init__(self, name):
 
718
        BzrError.__init__(self)
 
719
        self.name = name
 
720
 
 
721
 
 
722
class ParentBranchExists(AlreadyBranchError):
 
723
 
 
724
    _fmt = 'Parent branch already exists: "%(path)s".'
 
725
 
 
726
 
716
727
class BranchExistsWithoutWorkingTree(PathError):
717
728
 
718
729
    _fmt = 'Directory contains a branch, but no working tree \
747
758
        self.path = bzrdir.transport.clone('..').base
748
759
 
749
760
 
750
 
class FileInWrongBranch(BzrError):
751
 
 
752
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
753
 
 
754
 
    def __init__(self, branch, path):
755
 
        BzrError.__init__(self)
756
 
        self.branch = branch
757
 
        self.branch_base = branch.base
758
 
        self.path = path
759
 
 
760
 
 
761
761
class UnsupportedFormatError(BzrError):
762
762
 
763
763
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
782
782
        self.bzrdir = bzrdir_format
783
783
 
784
784
 
 
785
class ParseFormatError(BzrError):
 
786
 
 
787
    _fmt = "Parse error on line %(lineno)d of %(format)s format: %(line)s"
 
788
 
 
789
    def __init__(self, format, lineno, line, text):
 
790
        BzrError.__init__(self)
 
791
        self.format = format
 
792
        self.lineno = lineno
 
793
        self.line = line
 
794
        self.text = text
 
795
 
 
796
 
785
797
class IncompatibleRepositories(BzrError):
 
798
    """Report an error that two repositories are not compatible.
 
799
 
 
800
    Note that the source and target repositories are permitted to be strings:
 
801
    this exception is thrown from the smart server and may refer to a
 
802
    repository the client hasn't opened.
 
803
    """
786
804
 
787
805
    _fmt = "%(target)s\n" \
788
806
            "is not compatible with\n" \
813
831
        """Construct a new AlreadyVersionedError.
814
832
 
815
833
        :param path: This is the path which is versioned,
816
 
        which should be in a user friendly form.
 
834
            which should be in a user friendly form.
817
835
        :param context_info: If given, this is information about the context,
818
 
        which could explain why this is expected to not be versioned.
 
836
            which could explain why this is expected to not be versioned.
819
837
        """
820
838
        BzrError.__init__(self)
821
839
        self.path = path
834
852
        """Construct a new NotVersionedError.
835
853
 
836
854
        :param path: This is the path which is not versioned,
837
 
        which should be in a user friendly form.
 
855
            which should be in a user friendly form.
838
856
        :param context_info: If given, this is information about the context,
839
 
        which could explain why this is expected to be versioned.
 
857
            which could explain why this is expected to be versioned.
840
858
        """
841
859
        BzrError.__init__(self)
842
860
        self.path = path
910
928
    # original exception is available as e.original_error
911
929
    #
912
930
    # New code should prefer to raise specific subclasses
913
 
    def __init__(self, message):
914
 
        # Python 2.5 uses a slot for StandardError.message,
915
 
        # so use a different variable name.  We now work around this in
916
 
        # BzrError.__str__, but this member name is kept for compatability.
917
 
        self.msg = message
 
931
    def __init__(self, msg):
 
932
        self.msg = msg
918
933
 
919
934
 
920
935
class LockActive(LockError):
1004
1019
class LockContention(LockError):
1005
1020
 
1006
1021
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
1007
 
    # TODO: show full url for lock, combining the transport and relative
1008
 
    # bits?
1009
1022
 
1010
1023
    internal_error = False
1011
1024
 
1038
1051
        self.target = target
1039
1052
 
1040
1053
 
 
1054
class LockCorrupt(LockError):
 
1055
 
 
1056
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
 
1057
            "Use 'bzr break-lock' to clear it")
 
1058
 
 
1059
    internal_error = False
 
1060
 
 
1061
    def __init__(self, corruption_info, file_data=None):
 
1062
        self.corruption_info = corruption_info
 
1063
        self.file_data = file_data
 
1064
 
 
1065
 
1041
1066
class LockNotHeld(LockError):
1042
1067
 
1043
1068
    _fmt = "Lock not held: %(lock)s"
1082
1107
        BzrError.__init__(self, files=files, files_str=files_str)
1083
1108
 
1084
1109
 
 
1110
class ExcludesUnsupported(BzrError):
 
1111
 
 
1112
    _fmt = ('Excluding paths during commit is not supported by '
 
1113
            'repository at %(repository)r.')
 
1114
 
 
1115
    def __init__(self, repository):
 
1116
        BzrError.__init__(self, repository=repository)
 
1117
 
 
1118
 
1085
1119
class BadCommitMessageEncoding(BzrError):
1086
1120
 
1087
1121
    _fmt = 'The specified commit message contains characters unsupported by '\
1142
1176
 
1143
1177
class InvalidRevisionSpec(BzrError):
1144
1178
 
1145
 
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
1146
 
            " %(branch)s%(extra)s")
 
1179
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1180
            " %(branch_url)s%(extra)s")
1147
1181
 
1148
1182
    def __init__(self, spec, branch, extra=None):
1149
1183
        BzrError.__init__(self, branch=branch, spec=spec)
 
1184
        self.branch_url = getattr(branch, 'user_url', str(branch))
1150
1185
        if extra:
1151
1186
            self.extra = '\n' + str(extra)
1152
1187
        else:
1153
1188
            self.extra = ''
1154
1189
 
1155
1190
 
1156
 
class HistoryMissing(BzrError):
1157
 
 
1158
 
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
1159
 
 
1160
 
 
1161
1191
class AppendRevisionsOnlyViolation(BzrError):
1162
1192
 
1163
1193
    _fmt = ('Operation denied because it would change the main history,'
1228
1258
            not_ancestor_id=not_ancestor_id)
1229
1259
 
1230
1260
 
1231
 
class AmbiguousBase(BzrError):
1232
 
 
1233
 
    def __init__(self, bases):
1234
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1235
 
                DeprecationWarning)
1236
 
        msg = ("The correct base is unclear, because %s are all equally close"
1237
 
                % ", ".join(bases))
1238
 
        BzrError.__init__(self, msg)
1239
 
        self.bases = bases
1240
 
 
1241
 
 
1242
1261
class NoCommits(BranchError):
1243
1262
 
1244
1263
    _fmt = "Branch %(branch)s has no commits."
1260
1279
class BoundBranchOutOfDate(BzrError):
1261
1280
 
1262
1281
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1263
 
            " %(master)s.")
 
1282
            " %(master)s.%(extra_help)s")
1264
1283
 
1265
1284
    def __init__(self, branch, master):
1266
1285
        BzrError.__init__(self)
1267
1286
        self.branch = branch
1268
1287
        self.master = master
 
1288
        self.extra_help = ''
1269
1289
 
1270
1290
 
1271
1291
class CommitToDoubleBoundBranch(BzrError):
1342
1362
 
1343
1363
class WeaveParentMismatch(WeaveError):
1344
1364
 
1345
 
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1365
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
1346
1366
 
1347
1367
 
1348
1368
class WeaveInvalidChecksum(WeaveError):
1349
1369
 
1350
 
    _fmt = "Text did not match it's checksum: %(message)s"
 
1370
    _fmt = "Text did not match its checksum: %(msg)s"
1351
1371
 
1352
1372
 
1353
1373
class WeaveTextDiffers(WeaveError):
1401
1421
 
1402
1422
class VersionedFileInvalidChecksum(VersionedFileError):
1403
1423
 
1404
 
    _fmt = "Text did not match its checksum: %(message)s"
 
1424
    _fmt = "Text did not match its checksum: %(msg)s"
1405
1425
 
1406
1426
 
1407
1427
class KnitError(InternalBzrError):
1503
1523
            problem we can raise the original error (value from sys.exc_info())
1504
1524
        """
1505
1525
        BzrError.__init__(self)
 
1526
        self.context = context
1506
1527
        self.reload_occurred = reload_occurred
1507
1528
        self.exc_info = exc_info
1508
1529
        self.orig_error = exc_info[1]
1590
1611
 
1591
1612
    def __init__(self, exc_info):
1592
1613
        import traceback
 
1614
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1593
1615
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1594
1616
        self.exc_info = exc_info
1595
1617
        traceback_strings = traceback.format_exception(
1634
1656
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1635
1657
 
1636
1658
 
 
1659
class ConnectionTimeout(ConnectionError):
 
1660
 
 
1661
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1662
 
 
1663
 
1637
1664
class InvalidRange(TransportError):
1638
1665
 
1639
1666
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1646
1673
 
1647
1674
class InvalidHttpResponse(TransportError):
1648
1675
 
1649
 
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1676
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
1650
1677
 
1651
1678
    def __init__(self, path, msg, orig_error=None):
1652
1679
        self.path = path
 
1680
        if orig_error is None:
 
1681
            orig_error = ''
 
1682
        else:
 
1683
            # This is reached for obscure and unusual errors so we want to
 
1684
            # preserve as much info as possible to ease debug.
 
1685
            orig_error = ': %r' % (orig_error,)
1653
1686
        TransportError.__init__(self, msg, orig_error=orig_error)
1654
1687
 
1655
1688
 
 
1689
class CertificateError(TransportError):
 
1690
 
 
1691
    _fmt = "Certificate error: %(error)s"
 
1692
 
 
1693
    def __init__(self, error):
 
1694
        self.error = error
 
1695
 
 
1696
 
1656
1697
class InvalidHttpRange(InvalidHttpResponse):
1657
1698
 
1658
1699
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1662
1703
        InvalidHttpResponse.__init__(self, path, msg)
1663
1704
 
1664
1705
 
 
1706
class HttpBoundaryMissing(InvalidHttpResponse):
 
1707
    """A multipart response ends with no boundary marker.
 
1708
 
 
1709
    This is a special case caused by buggy proxies, described in
 
1710
    <https://bugs.launchpad.net/bzr/+bug/198646>.
 
1711
    """
 
1712
 
 
1713
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
 
1714
 
 
1715
    def __init__(self, path, msg):
 
1716
        InvalidHttpResponse.__init__(self, path, msg)
 
1717
 
 
1718
 
1665
1719
class InvalidHttpContentType(InvalidHttpResponse):
1666
1720
 
1667
1721
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1695
1749
    _fmt = "Working tree has conflicts."
1696
1750
 
1697
1751
 
 
1752
class ConfigContentError(BzrError):
 
1753
 
 
1754
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
 
1755
 
 
1756
    def __init__(self, filename):
 
1757
        BzrError.__init__(self)
 
1758
        self.filename = filename
 
1759
 
 
1760
 
1698
1761
class ParseConfigError(BzrError):
1699
1762
 
 
1763
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
 
1764
 
1700
1765
    def __init__(self, errors, filename):
1701
 
        if filename is None:
1702
 
            filename = ""
1703
 
        message = "Error(s) parsing config file %s:\n%s" % \
1704
 
            (filename, ('\n'.join(e.msg for e in errors)))
1705
 
        BzrError.__init__(self, message)
 
1766
        BzrError.__init__(self)
 
1767
        self.filename = filename
 
1768
        self.errors = '\n'.join(e.msg for e in errors)
 
1769
 
 
1770
 
 
1771
class ConfigOptionValueError(BzrError):
 
1772
 
 
1773
    _fmt = ('Bad value "%(value)s" for option "%(name)s".\n'
 
1774
            'See ``bzr help %(name)s``')
 
1775
 
 
1776
    def __init__(self, name, value):
 
1777
        BzrError.__init__(self, name=name, value=value)
1706
1778
 
1707
1779
 
1708
1780
class NoEmailInUsername(BzrError):
1716
1788
 
1717
1789
class SigningFailed(BzrError):
1718
1790
 
1719
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1791
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
1720
1792
 
1721
1793
    def __init__(self, command_line):
1722
1794
        BzrError.__init__(self, command_line=command_line)
1723
1795
 
1724
1796
 
 
1797
class SignatureVerificationFailed(BzrError):
 
1798
 
 
1799
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
 
1800
 
 
1801
    def __init__(self, error):
 
1802
        BzrError.__init__(self, error=error)
 
1803
 
 
1804
 
 
1805
class DependencyNotPresent(BzrError):
 
1806
 
 
1807
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1808
 
 
1809
    def __init__(self, library, error):
 
1810
        BzrError.__init__(self, library=library, error=error)
 
1811
 
 
1812
 
 
1813
class GpgmeNotInstalled(DependencyNotPresent):
 
1814
 
 
1815
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
 
1816
 
 
1817
    def __init__(self, error):
 
1818
        DependencyNotPresent.__init__(self, 'gpgme', error)
 
1819
 
 
1820
 
1725
1821
class WorkingTreeNotRevision(BzrError):
1726
1822
 
1727
1823
    _fmt = ("The working tree for %(basedir)s has changed since"
1843
1939
        self.prefix = prefix
1844
1940
 
1845
1941
 
1846
 
class MalformedTransform(BzrError):
 
1942
class MalformedTransform(InternalBzrError):
1847
1943
 
1848
1944
    _fmt = "Tree transform is malformed %(conflicts)r"
1849
1945
 
1887
1983
    _fmt = "Moving the root directory is not supported at this time"
1888
1984
 
1889
1985
 
 
1986
class TransformRenameFailed(BzrError):
 
1987
 
 
1988
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
1989
 
 
1990
    def __init__(self, from_path, to_path, why, errno):
 
1991
        self.from_path = from_path
 
1992
        self.to_path = to_path
 
1993
        self.why = why
 
1994
        self.errno = errno
 
1995
 
 
1996
 
1890
1997
class BzrMoveFailedError(BzrError):
1891
1998
 
1892
 
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1999
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
 
2000
        "%(_has_extra)s%(extra)s")
1893
2001
 
1894
2002
    def __init__(self, from_path='', to_path='', extra=None):
1895
2003
        from bzrlib.osutils import splitpath
1896
2004
        BzrError.__init__(self)
1897
2005
        if extra:
1898
 
            self.extra = ': ' + str(extra)
 
2006
            self.extra, self._has_extra = extra, ': '
1899
2007
        else:
1900
 
            self.extra = ''
 
2008
            self.extra = self._has_extra = ''
1901
2009
 
1902
2010
        has_from = len(from_path) > 0
1903
2011
        has_to = len(to_path) > 0
1924
2032
 
1925
2033
class BzrRenameFailedError(BzrMoveFailedError):
1926
2034
 
1927
 
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
2035
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
 
2036
        "%(_has_extra)s%(extra)s")
1928
2037
 
1929
2038
    def __init__(self, from_path, to_path, extra=None):
1930
2039
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1931
2040
 
1932
 
class BzrRemoveChangedFilesError(BzrError):
1933
 
    """Used when user is trying to remove changed files."""
1934
 
 
1935
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
1936
 
        "%(changes_as_text)s"
1937
 
        "Use --keep to not delete them, or --force to delete them regardless.")
1938
 
 
1939
 
    def __init__(self, tree_delta):
1940
 
        BzrError.__init__(self)
1941
 
        self.changes_as_text = tree_delta.get_changes_as_text()
1942
 
        #self.paths_as_string = '\n'.join(changed_files)
1943
 
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
1944
 
 
1945
2041
 
1946
2042
class BzrBadParameterNotString(BzrBadParameter):
1947
2043
 
1950
2046
 
1951
2047
class BzrBadParameterMissing(BzrBadParameter):
1952
2048
 
1953
 
    _fmt = "Parameter $(param)s is required but not present."
 
2049
    _fmt = "Parameter %(param)s is required but not present."
1954
2050
 
1955
2051
 
1956
2052
class BzrBadParameterUnicode(BzrBadParameter):
1964
2060
    _fmt = "Parameter %(param)s contains a newline."
1965
2061
 
1966
2062
 
1967
 
class DependencyNotPresent(BzrError):
1968
 
 
1969
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1970
 
 
1971
 
    def __init__(self, library, error):
1972
 
        BzrError.__init__(self, library=library, error=error)
1973
 
 
1974
 
 
1975
2063
class ParamikoNotPresent(DependencyNotPresent):
1976
2064
 
1977
2065
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
1996
2084
 
1997
2085
class BadConversionTarget(BzrError):
1998
2086
 
1999
 
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
2087
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
2088
            "    %(problem)s"
2000
2089
 
2001
 
    def __init__(self, problem, format):
 
2090
    def __init__(self, problem, format, from_format=None):
2002
2091
        BzrError.__init__(self)
2003
2092
        self.problem = problem
2004
2093
        self.format = format
 
2094
        self.from_format = from_format or '(unspecified)'
2005
2095
 
2006
2096
 
2007
2097
class NoDiffFound(BzrError):
2083
2173
 
2084
2174
class OutOfDateTree(BzrError):
2085
2175
 
2086
 
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
2176
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
2087
2177
 
2088
 
    def __init__(self, tree):
 
2178
    def __init__(self, tree, more=None):
 
2179
        if more is None:
 
2180
            more = ''
 
2181
        else:
 
2182
            more = ' ' + more
2089
2183
        BzrError.__init__(self)
2090
2184
        self.tree = tree
 
2185
        self.more = more
2091
2186
 
2092
2187
 
2093
2188
class PublicBranchOutOfDate(BzrError):
2131
2226
 
2132
2227
    def __init__(self, repo):
2133
2228
        BzrError.__init__(self)
2134
 
        self.repo_path = repo.bzrdir.root_transport.base
 
2229
        self.repo_path = repo.user_url
2135
2230
 
2136
2231
 
2137
2232
class InconsistentDelta(BzrError):
2147
2242
        self.reason = reason
2148
2243
 
2149
2244
 
 
2245
class InconsistentDeltaDelta(InconsistentDelta):
 
2246
    """Used when we get a delta that is not valid."""
 
2247
 
 
2248
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
2249
            "\nreason: %(reason)s")
 
2250
 
 
2251
    def __init__(self, delta, reason):
 
2252
        BzrError.__init__(self)
 
2253
        self.delta = delta
 
2254
        self.reason = reason
 
2255
 
 
2256
 
2150
2257
class UpgradeRequired(BzrError):
2151
2258
 
2152
2259
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
2193
2300
    """
2194
2301
 
2195
2302
 
 
2303
class GhostTagsNotSupported(BzrError):
 
2304
 
 
2305
    _fmt = "Ghost tags not supported by format %(format)r."
 
2306
 
 
2307
    def __init__(self, format):
 
2308
        self.format = format
 
2309
 
 
2310
 
2196
2311
class BinaryFile(BzrError):
2197
2312
 
2198
2313
    _fmt = "File is binary but should be text."
2561
2676
 
2562
2677
    This is distinct from ErrorFromSmartServer so that it is possible to
2563
2678
    distinguish between the following two cases:
2564
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2565
 
        and so should provoke a traceback to the user.
2566
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2567
 
        translated.  This is probably because the server sent us garbage, and
2568
 
        should not provoke a traceback.
 
2679
 
 
2680
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2681
      and so should provoke a traceback to the user.
 
2682
    - ErrorFromSmartServer was caught but its error_tuple could not be
 
2683
      translated.  This is probably because the server sent us garbage, and
 
2684
      should not provoke a traceback.
2569
2685
    """
2570
2686
 
2571
2687
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2627
2743
    _fmt = "Container has multiple records with the same name: %(name)s"
2628
2744
 
2629
2745
    def __init__(self, name):
2630
 
        self.name = name
 
2746
        self.name = name.decode("utf-8")
2631
2747
 
2632
2748
 
2633
2749
class NoDestinationAddress(InternalBzrError):
2661
2777
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2662
2778
 
2663
2779
 
2664
 
class UnknownMailClient(BzrError):
2665
 
 
2666
 
    _fmt = "Unknown mail client: %(mail_client)s"
2667
 
 
2668
 
    def __init__(self, mail_client):
2669
 
        BzrError.__init__(self, mail_client=mail_client)
2670
 
 
2671
 
 
2672
2780
class MailClientNotFound(BzrError):
2673
2781
 
2674
2782
    _fmt = "Unable to find mail client with the following names:"\
2697
2805
 
2698
2806
    def __init__(self, bzrdir):
2699
2807
        import bzrlib.urlutils as urlutils
2700
 
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2808
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
2701
2809
                                                    'ascii')
2702
2810
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2703
2811
 
2768
2876
 
2769
2877
class UncommittedChanges(BzrError):
2770
2878
 
2771
 
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2772
 
 
2773
 
    def __init__(self, tree):
2774
 
        import bzrlib.urlutils as urlutils
2775
 
        display_url = urlutils.unescape_for_display(
2776
 
            tree.bzrdir.root_transport.base, 'ascii')
2777
 
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
2879
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2880
            ' (See bzr status).%(more)s')
 
2881
 
 
2882
    def __init__(self, tree, more=None):
 
2883
        if more is None:
 
2884
            more = ''
 
2885
        else:
 
2886
            more = ' ' + more
 
2887
        import bzrlib.urlutils as urlutils
 
2888
        user_url = getattr(tree, "user_url", None)
 
2889
        if user_url is None:
 
2890
            display_url = str(tree)
 
2891
        else:
 
2892
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2893
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2894
 
 
2895
 
 
2896
class StoringUncommittedNotSupported(BzrError):
 
2897
 
 
2898
    _fmt = ('Branch "%(display_url)s" does not support storing uncommitted'
 
2899
            ' changes.')
 
2900
 
 
2901
    def __init__(self, branch):
 
2902
        import bzrlib.urlutils as urlutils
 
2903
        user_url = getattr(branch, "user_url", None)
 
2904
        if user_url is None:
 
2905
            display_url = str(branch)
 
2906
        else:
 
2907
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2908
        BzrError.__init__(self, branch=branch, display_url=display_url)
 
2909
 
 
2910
 
 
2911
class ShelvedChanges(UncommittedChanges):
 
2912
 
 
2913
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2914
            ' (See bzr shelve --list).%(more)s')
2778
2915
 
2779
2916
 
2780
2917
class MissingTemplateVariable(BzrError):
2848
2985
        from bzrlib.osutils import get_user_encoding
2849
2986
        self.path = path
2850
2987
        self.kind = kind
2851
 
        self.user_encoding = osutils.get_user_encoding()
 
2988
        self.user_encoding = get_user_encoding()
 
2989
 
 
2990
 
 
2991
class NoSuchConfig(BzrError):
 
2992
 
 
2993
    _fmt = ('The "%(config_id)s" configuration does not exist.')
 
2994
 
 
2995
    def __init__(self, config_id):
 
2996
        BzrError.__init__(self, config_id=config_id)
 
2997
 
 
2998
 
 
2999
class NoSuchConfigOption(BzrError):
 
3000
 
 
3001
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
 
3002
 
 
3003
    def __init__(self, option_name):
 
3004
        BzrError.__init__(self, option_name=option_name)
2852
3005
 
2853
3006
 
2854
3007
class NoSuchAlias(BzrError):
2886
3039
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2887
3040
 
2888
3041
    def __init__(self, host, port, orig_error):
 
3042
        # nb: in python2.4 socket.error doesn't have a useful repr
2889
3043
        BzrError.__init__(self, host=host, port=port,
2890
 
            orig_error=orig_error[1])
 
3044
            orig_error=repr(orig_error.args))
2891
3045
 
2892
3046
 
2893
3047
class UnknownRules(BzrError):
2898
3052
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
2899
3053
 
2900
3054
 
2901
 
class HookFailed(BzrError):
2902
 
    """Raised when a pre_change_branch_tip hook function fails anything other
2903
 
    than TipChangeRejected.
2904
 
    """
2905
 
 
2906
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2907
 
            "%(traceback_text)s%(exc_value)s")
2908
 
 
2909
 
    def __init__(self, hook_stage, hook_name, exc_info):
2910
 
        import traceback
2911
 
        self.hook_stage = hook_stage
2912
 
        self.hook_name = hook_name
2913
 
        self.exc_info = exc_info
2914
 
        self.exc_type = exc_info[0]
2915
 
        self.exc_value = exc_info[1]
2916
 
        self.exc_tb = exc_info[2]
2917
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
2918
 
 
2919
 
 
2920
3055
class TipChangeRejected(BzrError):
2921
3056
    """A pre_change_branch_tip hook function may raise this to cleanly and
2922
3057
    explicitly abort a change to a branch tip.
2933
3068
    _fmt = "Shelf corrupt."
2934
3069
 
2935
3070
 
 
3071
class DecompressCorruption(BzrError):
 
3072
 
 
3073
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
 
3074
 
 
3075
    def __init__(self, orig_error=None):
 
3076
        if orig_error is not None:
 
3077
            self.orig_error = ", %s" % (orig_error,)
 
3078
        else:
 
3079
            self.orig_error = ""
 
3080
        BzrError.__init__(self)
 
3081
 
 
3082
 
2936
3083
class NoSuchShelfId(BzrError):
2937
3084
 
2938
3085
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3034
3181
    def __init__(self, source_branch, target_branch):
3035
3182
        self.source_branch = source_branch
3036
3183
        self.target_branch = target_branch
 
3184
 
 
3185
 
 
3186
class NoRoundtrippingSupport(BzrError):
 
3187
 
 
3188
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
3189
            "%(target_branch)r.")
 
3190
 
 
3191
    internal_error = True
 
3192
 
 
3193
    def __init__(self, source_branch, target_branch):
 
3194
        self.source_branch = source_branch
 
3195
        self.target_branch = target_branch
 
3196
 
 
3197
 
 
3198
class FileTimestampUnavailable(BzrError):
 
3199
 
 
3200
    _fmt = "The filestamp for %(path)s is not available."
 
3201
 
 
3202
    internal_error = True
 
3203
 
 
3204
    def __init__(self, path):
 
3205
        self.path = path
 
3206
 
 
3207
 
 
3208
class NoColocatedBranchSupport(BzrError):
 
3209
 
 
3210
    _fmt = ("%(bzrdir)r does not support co-located branches.")
 
3211
 
 
3212
    def __init__(self, bzrdir):
 
3213
        self.bzrdir = bzrdir
 
3214
 
 
3215
 
 
3216
class NoWhoami(BzrError):
 
3217
 
 
3218
    _fmt = ('Unable to determine your name.\n'
 
3219
        "Please, set your name with the 'whoami' command.\n"
 
3220
        'E.g. bzr whoami "Your Name <name@example.com>"')
 
3221
 
 
3222
 
 
3223
class InvalidPattern(BzrError):
 
3224
 
 
3225
    _fmt = ('Invalid pattern(s) found. %(msg)s')
 
3226
 
 
3227
    def __init__(self, msg):
 
3228
        self.msg = msg
 
3229
 
 
3230
 
 
3231
class RecursiveBind(BzrError):
 
3232
 
 
3233
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
 
3234
        'Please use `bzr unbind` to fix.')
 
3235
 
 
3236
    def __init__(self, branch_url):
 
3237
        self.branch_url = branch_url
 
3238
 
 
3239
 
 
3240
# FIXME: I would prefer to define the config related exception classes in
 
3241
# config.py but the lazy import mechanism proscribes this -- vila 20101222
 
3242
class OptionExpansionLoop(BzrError):
 
3243
 
 
3244
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
 
3245
 
 
3246
    def __init__(self, string, refs):
 
3247
        self.string = string
 
3248
        self.refs = '->'.join(refs)
 
3249
 
 
3250
 
 
3251
class ExpandingUnknownOption(BzrError):
 
3252
 
 
3253
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
 
3254
 
 
3255
    def __init__(self, name, string):
 
3256
        self.name = name
 
3257
        self.string = string
 
3258
 
 
3259
 
 
3260
class NoCompatibleInter(BzrError):
 
3261
 
 
3262
    _fmt = ('No compatible object available for operations from %(source)r '
 
3263
            'to %(target)r.')
 
3264
 
 
3265
    def __init__(self, source, target):
 
3266
        self.source = source
 
3267
        self.target = target
 
3268
 
 
3269
 
 
3270
class HpssVfsRequestNotAllowed(BzrError):
 
3271
 
 
3272
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
 
3273
            "%(method)s, %(arguments)s.")
 
3274
 
 
3275
    def __init__(self, method, arguments):
 
3276
        self.method = method
 
3277
        self.arguments = arguments
 
3278
 
 
3279
 
 
3280
class UnsupportedKindChange(BzrError):
 
3281
 
 
3282
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
 
3283
            "%(path)s not supported by format %(format)r")
 
3284
 
 
3285
    def __init__(self, path, from_kind, to_kind, format):
 
3286
        self.path = path
 
3287
        self.from_kind = from_kind
 
3288
        self.to_kind = to_kind
 
3289
        self.format = format
 
3290
 
 
3291
 
 
3292
class MissingFeature(BzrError):
 
3293
 
 
3294
    _fmt = ("Missing feature %(feature)s not provided by this "
 
3295
            "version of Bazaar or any plugin.")
 
3296
 
 
3297
    def __init__(self, feature):
 
3298
        self.feature = feature
 
3299
 
 
3300
 
 
3301
class PatchSyntax(BzrError):
 
3302
    """Base class for patch syntax errors."""
 
3303
 
 
3304
 
 
3305
class BinaryFiles(BzrError):
 
3306
 
 
3307
    _fmt = 'Binary files section encountered.'
 
3308
 
 
3309
    def __init__(self, orig_name, mod_name):
 
3310
        self.orig_name = orig_name
 
3311
        self.mod_name = mod_name
 
3312
 
 
3313
 
 
3314
class MalformedPatchHeader(PatchSyntax):
 
3315
 
 
3316
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
 
3317
 
 
3318
    def __init__(self, desc, line):
 
3319
        self.desc = desc
 
3320
        self.line = line
 
3321
 
 
3322
 
 
3323
class MalformedHunkHeader(PatchSyntax):
 
3324
 
 
3325
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
 
3326
 
 
3327
    def __init__(self, desc, line):
 
3328
        self.desc = desc
 
3329
        self.line = line
 
3330
 
 
3331
 
 
3332
class MalformedLine(PatchSyntax):
 
3333
 
 
3334
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
 
3335
 
 
3336
    def __init__(self, desc, line):
 
3337
        self.desc = desc
 
3338
        self.line = line
 
3339
 
 
3340
 
 
3341
class PatchConflict(BzrError):
 
3342
 
 
3343
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
 
3344
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
 
3345
 
 
3346
    def __init__(self, line_no, orig_line, patch_line):
 
3347
        self.line_no = line_no
 
3348
        self.orig_line = orig_line.rstrip('\n')
 
3349
        self.patch_line = patch_line.rstrip('\n')
 
3350
 
 
3351
 
 
3352
class FeatureAlreadyRegistered(BzrError):
 
3353
 
 
3354
    _fmt = 'The feature %(feature)s has already been registered.'
 
3355
 
 
3356
    def __init__(self, feature):
 
3357
        self.feature = feature
 
3358
 
 
3359
 
 
3360
class ChangesAlreadyStored(BzrCommandError):
 
3361
 
 
3362
    _fmt = ('Cannot store uncommitted changes because this branch already'
 
3363
            ' stores uncommitted changes.')