~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

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-2013, 2016 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,'
1173
1203
class DivergedBranches(BzrError):
1174
1204
 
1175
1205
    _fmt = ("These branches have diverged."
1176
 
            " Use the merge command to reconcile them.")
 
1206
            " Use the missing command to see how.\n"
 
1207
            "Use the merge command to reconcile them.")
1177
1208
 
1178
1209
    def __init__(self, branch1, branch2):
1179
1210
        self.branch1 = branch1
1227
1258
            not_ancestor_id=not_ancestor_id)
1228
1259
 
1229
1260
 
1230
 
class InstallFailed(BzrError):
1231
 
 
1232
 
    def __init__(self, revisions):
1233
 
        revision_str = ", ".join(str(r) for r in revisions)
1234
 
        msg = "Could not install revisions:\n%s" % revision_str
1235
 
        BzrError.__init__(self, msg)
1236
 
        self.revisions = revisions
1237
 
 
1238
 
 
1239
 
class AmbiguousBase(BzrError):
1240
 
 
1241
 
    def __init__(self, bases):
1242
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1243
 
                DeprecationWarning)
1244
 
        msg = ("The correct base is unclear, because %s are all equally close"
1245
 
                % ", ".join(bases))
1246
 
        BzrError.__init__(self, msg)
1247
 
        self.bases = bases
1248
 
 
1249
 
 
1250
1261
class NoCommits(BranchError):
1251
1262
 
1252
1263
    _fmt = "Branch %(branch)s has no commits."
1268
1279
class BoundBranchOutOfDate(BzrError):
1269
1280
 
1270
1281
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1271
 
            " %(master)s.")
 
1282
            " %(master)s.%(extra_help)s")
1272
1283
 
1273
1284
    def __init__(self, branch, master):
1274
1285
        BzrError.__init__(self)
1275
1286
        self.branch = branch
1276
1287
        self.master = master
 
1288
        self.extra_help = ''
1277
1289
 
1278
1290
 
1279
1291
class CommitToDoubleBoundBranch(BzrError):
1350
1362
 
1351
1363
class WeaveParentMismatch(WeaveError):
1352
1364
 
1353
 
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1365
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
1354
1366
 
1355
1367
 
1356
1368
class WeaveInvalidChecksum(WeaveError):
1357
1369
 
1358
 
    _fmt = "Text did not match it's checksum: %(message)s"
 
1370
    _fmt = "Text did not match its checksum: %(msg)s"
1359
1371
 
1360
1372
 
1361
1373
class WeaveTextDiffers(WeaveError):
1409
1421
 
1410
1422
class VersionedFileInvalidChecksum(VersionedFileError):
1411
1423
 
1412
 
    _fmt = "Text did not match its checksum: %(message)s"
 
1424
    _fmt = "Text did not match its checksum: %(msg)s"
1413
1425
 
1414
1426
 
1415
1427
class KnitError(InternalBzrError):
1511
1523
            problem we can raise the original error (value from sys.exc_info())
1512
1524
        """
1513
1525
        BzrError.__init__(self)
 
1526
        self.context = context
1514
1527
        self.reload_occurred = reload_occurred
1515
1528
        self.exc_info = exc_info
1516
1529
        self.orig_error = exc_info[1]
1598
1611
 
1599
1612
    def __init__(self, exc_info):
1600
1613
        import traceback
 
1614
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1601
1615
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1602
1616
        self.exc_info = exc_info
1603
1617
        traceback_strings = traceback.format_exception(
1642
1656
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1643
1657
 
1644
1658
 
 
1659
class ConnectionTimeout(ConnectionError):
 
1660
 
 
1661
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1662
 
 
1663
 
1645
1664
class InvalidRange(TransportError):
1646
1665
 
1647
1666
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1654
1673
 
1655
1674
class InvalidHttpResponse(TransportError):
1656
1675
 
1657
 
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1676
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
1658
1677
 
1659
1678
    def __init__(self, path, msg, orig_error=None):
1660
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,)
1661
1686
        TransportError.__init__(self, msg, orig_error=orig_error)
1662
1687
 
1663
1688
 
1670
1695
        InvalidHttpResponse.__init__(self, path, msg)
1671
1696
 
1672
1697
 
 
1698
class HttpBoundaryMissing(InvalidHttpResponse):
 
1699
    """A multipart response ends with no boundary marker.
 
1700
 
 
1701
    This is a special case caused by buggy proxies, described in
 
1702
    <https://bugs.launchpad.net/bzr/+bug/198646>.
 
1703
    """
 
1704
 
 
1705
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
 
1706
 
 
1707
    def __init__(self, path, msg):
 
1708
        InvalidHttpResponse.__init__(self, path, msg)
 
1709
 
 
1710
 
1673
1711
class InvalidHttpContentType(InvalidHttpResponse):
1674
1712
 
1675
1713
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1703
1741
    _fmt = "Working tree has conflicts."
1704
1742
 
1705
1743
 
 
1744
class ConfigContentError(BzrError):
 
1745
 
 
1746
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
 
1747
 
 
1748
    def __init__(self, filename):
 
1749
        BzrError.__init__(self)
 
1750
        self.filename = filename
 
1751
 
 
1752
 
1706
1753
class ParseConfigError(BzrError):
1707
1754
 
 
1755
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
 
1756
 
1708
1757
    def __init__(self, errors, filename):
1709
 
        if filename is None:
1710
 
            filename = ""
1711
 
        message = "Error(s) parsing config file %s:\n%s" % \
1712
 
            (filename, ('\n'.join(e.msg for e in errors)))
1713
 
        BzrError.__init__(self, message)
 
1758
        BzrError.__init__(self)
 
1759
        self.filename = filename
 
1760
        self.errors = '\n'.join(e.msg for e in errors)
 
1761
 
 
1762
 
 
1763
class ConfigOptionValueError(BzrError):
 
1764
 
 
1765
    _fmt = ('Bad value "%(value)s" for option "%(name)s".\n'
 
1766
            'See ``bzr help %(name)s``')
 
1767
 
 
1768
    def __init__(self, name, value):
 
1769
        BzrError.__init__(self, name=name, value=value)
1714
1770
 
1715
1771
 
1716
1772
class NoEmailInUsername(BzrError):
1724
1780
 
1725
1781
class SigningFailed(BzrError):
1726
1782
 
1727
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1783
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
1728
1784
 
1729
1785
    def __init__(self, command_line):
1730
1786
        BzrError.__init__(self, command_line=command_line)
1731
1787
 
1732
1788
 
 
1789
class SignatureVerificationFailed(BzrError):
 
1790
 
 
1791
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
 
1792
 
 
1793
    def __init__(self, error):
 
1794
        BzrError.__init__(self, error=error)
 
1795
 
 
1796
 
 
1797
class DependencyNotPresent(BzrError):
 
1798
 
 
1799
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1800
 
 
1801
    def __init__(self, library, error):
 
1802
        BzrError.__init__(self, library=library, error=error)
 
1803
 
 
1804
 
 
1805
class GpgmeNotInstalled(DependencyNotPresent):
 
1806
 
 
1807
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
 
1808
 
 
1809
    def __init__(self, error):
 
1810
        DependencyNotPresent.__init__(self, 'gpgme', error)
 
1811
 
 
1812
 
1733
1813
class WorkingTreeNotRevision(BzrError):
1734
1814
 
1735
1815
    _fmt = ("The working tree for %(basedir)s has changed since"
1851
1931
        self.prefix = prefix
1852
1932
 
1853
1933
 
1854
 
class MalformedTransform(BzrError):
 
1934
class MalformedTransform(InternalBzrError):
1855
1935
 
1856
1936
    _fmt = "Tree transform is malformed %(conflicts)r"
1857
1937
 
1895
1975
    _fmt = "Moving the root directory is not supported at this time"
1896
1976
 
1897
1977
 
 
1978
class TransformRenameFailed(BzrError):
 
1979
 
 
1980
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
1981
 
 
1982
    def __init__(self, from_path, to_path, why, errno):
 
1983
        self.from_path = from_path
 
1984
        self.to_path = to_path
 
1985
        self.why = why
 
1986
        self.errno = errno
 
1987
 
 
1988
 
1898
1989
class BzrMoveFailedError(BzrError):
1899
1990
 
1900
 
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1991
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
 
1992
        "%(_has_extra)s%(extra)s")
1901
1993
 
1902
1994
    def __init__(self, from_path='', to_path='', extra=None):
1903
1995
        from bzrlib.osutils import splitpath
1904
1996
        BzrError.__init__(self)
1905
1997
        if extra:
1906
 
            self.extra = ': ' + str(extra)
 
1998
            self.extra, self._has_extra = extra, ': '
1907
1999
        else:
1908
 
            self.extra = ''
 
2000
            self.extra = self._has_extra = ''
1909
2001
 
1910
2002
        has_from = len(from_path) > 0
1911
2003
        has_to = len(to_path) > 0
1932
2024
 
1933
2025
class BzrRenameFailedError(BzrMoveFailedError):
1934
2026
 
1935
 
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
2027
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
 
2028
        "%(_has_extra)s%(extra)s")
1936
2029
 
1937
2030
    def __init__(self, from_path, to_path, extra=None):
1938
2031
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1939
2032
 
1940
 
class BzrRemoveChangedFilesError(BzrError):
1941
 
    """Used when user is trying to remove changed files."""
1942
 
 
1943
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
1944
 
        "%(changes_as_text)s"
1945
 
        "Use --keep to not delete them, or --force to delete them regardless.")
1946
 
 
1947
 
    def __init__(self, tree_delta):
1948
 
        BzrError.__init__(self)
1949
 
        self.changes_as_text = tree_delta.get_changes_as_text()
1950
 
        #self.paths_as_string = '\n'.join(changed_files)
1951
 
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
1952
 
 
1953
2033
 
1954
2034
class BzrBadParameterNotString(BzrBadParameter):
1955
2035
 
1958
2038
 
1959
2039
class BzrBadParameterMissing(BzrBadParameter):
1960
2040
 
1961
 
    _fmt = "Parameter $(param)s is required but not present."
 
2041
    _fmt = "Parameter %(param)s is required but not present."
1962
2042
 
1963
2043
 
1964
2044
class BzrBadParameterUnicode(BzrBadParameter):
1972
2052
    _fmt = "Parameter %(param)s contains a newline."
1973
2053
 
1974
2054
 
1975
 
class DependencyNotPresent(BzrError):
1976
 
 
1977
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1978
 
 
1979
 
    def __init__(self, library, error):
1980
 
        BzrError.__init__(self, library=library, error=error)
1981
 
 
1982
 
 
1983
2055
class ParamikoNotPresent(DependencyNotPresent):
1984
2056
 
1985
2057
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2004
2076
 
2005
2077
class BadConversionTarget(BzrError):
2006
2078
 
2007
 
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
2079
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
2080
            "    %(problem)s"
2008
2081
 
2009
 
    def __init__(self, problem, format):
 
2082
    def __init__(self, problem, format, from_format=None):
2010
2083
        BzrError.__init__(self)
2011
2084
        self.problem = problem
2012
2085
        self.format = format
 
2086
        self.from_format = from_format or '(unspecified)'
2013
2087
 
2014
2088
 
2015
2089
class NoDiffFound(BzrError):
2091
2165
 
2092
2166
class OutOfDateTree(BzrError):
2093
2167
 
2094
 
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
2168
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
2095
2169
 
2096
 
    def __init__(self, tree):
 
2170
    def __init__(self, tree, more=None):
 
2171
        if more is None:
 
2172
            more = ''
 
2173
        else:
 
2174
            more = ' ' + more
2097
2175
        BzrError.__init__(self)
2098
2176
        self.tree = tree
 
2177
        self.more = more
2099
2178
 
2100
2179
 
2101
2180
class PublicBranchOutOfDate(BzrError):
2139
2218
 
2140
2219
    def __init__(self, repo):
2141
2220
        BzrError.__init__(self)
2142
 
        self.repo_path = repo.bzrdir.root_transport.base
 
2221
        self.repo_path = repo.user_url
2143
2222
 
2144
2223
 
2145
2224
class InconsistentDelta(BzrError):
2155
2234
        self.reason = reason
2156
2235
 
2157
2236
 
 
2237
class InconsistentDeltaDelta(InconsistentDelta):
 
2238
    """Used when we get a delta that is not valid."""
 
2239
 
 
2240
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
2241
            "\nreason: %(reason)s")
 
2242
 
 
2243
    def __init__(self, delta, reason):
 
2244
        BzrError.__init__(self)
 
2245
        self.delta = delta
 
2246
        self.reason = reason
 
2247
 
 
2248
 
2158
2249
class UpgradeRequired(BzrError):
2159
2250
 
2160
2251
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
2169
2260
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2170
2261
 
2171
2262
 
 
2263
class RichRootUpgradeRequired(UpgradeRequired):
 
2264
 
 
2265
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
 
2266
           " a format which supports rich roots.")
 
2267
 
 
2268
 
2172
2269
class LocalRequiresBoundBranch(BzrError):
2173
2270
 
2174
2271
    _fmt = "Cannot perform local-only commits on unbound branches."
2175
2272
 
2176
2273
 
2177
 
class InvalidProgressBarType(BzrError):
2178
 
 
2179
 
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
2180
 
            " is not a supported type Select one of: %(valid_types)s")
2181
 
 
2182
 
    def __init__(self, bar_type, valid_types):
2183
 
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
2184
 
 
2185
 
 
2186
2274
class UnsupportedOperation(BzrError):
2187
2275
 
2188
2276
    _fmt = ("The method %(mname)s is not supported on"
2204
2292
    """
2205
2293
 
2206
2294
 
 
2295
class GhostTagsNotSupported(BzrError):
 
2296
 
 
2297
    _fmt = "Ghost tags not supported by format %(format)r."
 
2298
 
 
2299
    def __init__(self, format):
 
2300
        self.format = format
 
2301
 
 
2302
 
2207
2303
class BinaryFile(BzrError):
2208
2304
 
2209
2305
    _fmt = "File is binary but should be text."
2572
2668
 
2573
2669
    This is distinct from ErrorFromSmartServer so that it is possible to
2574
2670
    distinguish between the following two cases:
2575
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2576
 
        and so should provoke a traceback to the user.
2577
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2578
 
        translated.  This is probably because the server sent us garbage, and
2579
 
        should not provoke a traceback.
 
2671
 
 
2672
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2673
      and so should provoke a traceback to the user.
 
2674
    - ErrorFromSmartServer was caught but its error_tuple could not be
 
2675
      translated.  This is probably because the server sent us garbage, and
 
2676
      should not provoke a traceback.
2580
2677
    """
2581
2678
 
2582
2679
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2638
2735
    _fmt = "Container has multiple records with the same name: %(name)s"
2639
2736
 
2640
2737
    def __init__(self, name):
2641
 
        self.name = name
 
2738
        self.name = name.decode("utf-8")
2642
2739
 
2643
2740
 
2644
2741
class NoDestinationAddress(InternalBzrError):
2672
2769
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2673
2770
 
2674
2771
 
2675
 
class UnknownMailClient(BzrError):
2676
 
 
2677
 
    _fmt = "Unknown mail client: %(mail_client)s"
2678
 
 
2679
 
    def __init__(self, mail_client):
2680
 
        BzrError.__init__(self, mail_client=mail_client)
2681
 
 
2682
 
 
2683
2772
class MailClientNotFound(BzrError):
2684
2773
 
2685
2774
    _fmt = "Unable to find mail client with the following names:"\
2708
2797
 
2709
2798
    def __init__(self, bzrdir):
2710
2799
        import bzrlib.urlutils as urlutils
2711
 
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2800
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
2712
2801
                                                    'ascii')
2713
2802
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2714
2803
 
2779
2868
 
2780
2869
class UncommittedChanges(BzrError):
2781
2870
 
2782
 
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2783
 
 
2784
 
    def __init__(self, tree):
2785
 
        import bzrlib.urlutils as urlutils
2786
 
        display_url = urlutils.unescape_for_display(
2787
 
            tree.bzrdir.root_transport.base, 'ascii')
2788
 
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
2871
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2872
            ' (See bzr status).%(more)s')
 
2873
 
 
2874
    def __init__(self, tree, more=None):
 
2875
        if more is None:
 
2876
            more = ''
 
2877
        else:
 
2878
            more = ' ' + more
 
2879
        import bzrlib.urlutils as urlutils
 
2880
        user_url = getattr(tree, "user_url", None)
 
2881
        if user_url is None:
 
2882
            display_url = str(tree)
 
2883
        else:
 
2884
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2885
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2886
 
 
2887
 
 
2888
class StoringUncommittedNotSupported(BzrError):
 
2889
 
 
2890
    _fmt = ('Branch "%(display_url)s" does not support storing uncommitted'
 
2891
            ' changes.')
 
2892
 
 
2893
    def __init__(self, branch):
 
2894
        import bzrlib.urlutils as urlutils
 
2895
        user_url = getattr(branch, "user_url", None)
 
2896
        if user_url is None:
 
2897
            display_url = str(branch)
 
2898
        else:
 
2899
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2900
        BzrError.__init__(self, branch=branch, display_url=display_url)
 
2901
 
 
2902
 
 
2903
class ShelvedChanges(UncommittedChanges):
 
2904
 
 
2905
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2906
            ' (See bzr shelve --list).%(more)s')
2789
2907
 
2790
2908
 
2791
2909
class MissingTemplateVariable(BzrError):
2850
2968
    pass
2851
2969
 
2852
2970
 
2853
 
class NotATerminal(BzrError):
2854
 
 
2855
 
    _fmt = 'Unable to ask for a password without real terminal.'
2856
 
 
2857
 
 
2858
2971
class UnableEncodePath(BzrError):
2859
2972
 
2860
2973
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
2864
2977
        from bzrlib.osutils import get_user_encoding
2865
2978
        self.path = path
2866
2979
        self.kind = kind
2867
 
        self.user_encoding = osutils.get_user_encoding()
 
2980
        self.user_encoding = get_user_encoding()
 
2981
 
 
2982
 
 
2983
class NoSuchConfig(BzrError):
 
2984
 
 
2985
    _fmt = ('The "%(config_id)s" configuration does not exist.')
 
2986
 
 
2987
    def __init__(self, config_id):
 
2988
        BzrError.__init__(self, config_id=config_id)
 
2989
 
 
2990
 
 
2991
class NoSuchConfigOption(BzrError):
 
2992
 
 
2993
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
 
2994
 
 
2995
    def __init__(self, option_name):
 
2996
        BzrError.__init__(self, option_name=option_name)
2868
2997
 
2869
2998
 
2870
2999
class NoSuchAlias(BzrError):
2902
3031
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2903
3032
 
2904
3033
    def __init__(self, host, port, orig_error):
 
3034
        # nb: in python2.4 socket.error doesn't have a useful repr
2905
3035
        BzrError.__init__(self, host=host, port=port,
2906
 
            orig_error=orig_error[1])
 
3036
            orig_error=repr(orig_error.args))
2907
3037
 
2908
3038
 
2909
3039
class UnknownRules(BzrError):
2914
3044
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
2915
3045
 
2916
3046
 
2917
 
class HookFailed(BzrError):
2918
 
    """Raised when a pre_change_branch_tip hook function fails anything other
2919
 
    than TipChangeRejected.
2920
 
    """
2921
 
 
2922
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2923
 
            "%(traceback_text)s%(exc_value)s")
2924
 
 
2925
 
    def __init__(self, hook_stage, hook_name, exc_info):
2926
 
        import traceback
2927
 
        self.hook_stage = hook_stage
2928
 
        self.hook_name = hook_name
2929
 
        self.exc_info = exc_info
2930
 
        self.exc_type = exc_info[0]
2931
 
        self.exc_value = exc_info[1]
2932
 
        self.exc_tb = exc_info[2]
2933
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
2934
 
 
2935
 
 
2936
3047
class TipChangeRejected(BzrError):
2937
3048
    """A pre_change_branch_tip hook function may raise this to cleanly and
2938
3049
    explicitly abort a change to a branch tip.
2949
3060
    _fmt = "Shelf corrupt."
2950
3061
 
2951
3062
 
 
3063
class DecompressCorruption(BzrError):
 
3064
 
 
3065
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
 
3066
 
 
3067
    def __init__(self, orig_error=None):
 
3068
        if orig_error is not None:
 
3069
            self.orig_error = ", %s" % (orig_error,)
 
3070
        else:
 
3071
            self.orig_error = ""
 
3072
        BzrError.__init__(self)
 
3073
 
 
3074
 
2952
3075
class NoSuchShelfId(BzrError):
2953
3076
 
2954
3077
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
2965
3088
        BzrError.__init__(self, invalid_id=invalid_id)
2966
3089
 
2967
3090
 
 
3091
class JailBreak(BzrError):
 
3092
 
 
3093
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
3094
 
 
3095
    def __init__(self, url):
 
3096
        BzrError.__init__(self, url=url)
 
3097
 
 
3098
 
2968
3099
class UserAbort(BzrError):
2969
3100
 
2970
3101
    _fmt = 'The user aborted the operation.'
3030
3161
 
3031
3162
    def __init__(self, repository):
3032
3163
        self.repository = repository
 
3164
 
 
3165
 
 
3166
class LossyPushToSameVCS(BzrError):
 
3167
 
 
3168
    _fmt = ("Lossy push not possible between %(source_branch)r and "
 
3169
            "%(target_branch)r that are in the same VCS.")
 
3170
 
 
3171
    internal_error = True
 
3172
 
 
3173
    def __init__(self, source_branch, target_branch):
 
3174
        self.source_branch = source_branch
 
3175
        self.target_branch = target_branch
 
3176
 
 
3177
 
 
3178
class NoRoundtrippingSupport(BzrError):
 
3179
 
 
3180
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
3181
            "%(target_branch)r.")
 
3182
 
 
3183
    internal_error = True
 
3184
 
 
3185
    def __init__(self, source_branch, target_branch):
 
3186
        self.source_branch = source_branch
 
3187
        self.target_branch = target_branch
 
3188
 
 
3189
 
 
3190
class FileTimestampUnavailable(BzrError):
 
3191
 
 
3192
    _fmt = "The filestamp for %(path)s is not available."
 
3193
 
 
3194
    internal_error = True
 
3195
 
 
3196
    def __init__(self, path):
 
3197
        self.path = path
 
3198
 
 
3199
 
 
3200
class NoColocatedBranchSupport(BzrError):
 
3201
 
 
3202
    _fmt = ("%(bzrdir)r does not support co-located branches.")
 
3203
 
 
3204
    def __init__(self, bzrdir):
 
3205
        self.bzrdir = bzrdir
 
3206
 
 
3207
 
 
3208
class NoWhoami(BzrError):
 
3209
 
 
3210
    _fmt = ('Unable to determine your name.\n'
 
3211
        "Please, set your name with the 'whoami' command.\n"
 
3212
        'E.g. bzr whoami "Your Name <name@example.com>"')
 
3213
 
 
3214
 
 
3215
class InvalidPattern(BzrError):
 
3216
 
 
3217
    _fmt = ('Invalid pattern(s) found. %(msg)s')
 
3218
 
 
3219
    def __init__(self, msg):
 
3220
        self.msg = msg
 
3221
 
 
3222
 
 
3223
class RecursiveBind(BzrError):
 
3224
 
 
3225
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
 
3226
        'Please use `bzr unbind` to fix.')
 
3227
 
 
3228
    def __init__(self, branch_url):
 
3229
        self.branch_url = branch_url
 
3230
 
 
3231
 
 
3232
# FIXME: I would prefer to define the config related exception classes in
 
3233
# config.py but the lazy import mechanism proscribes this -- vila 20101222
 
3234
class OptionExpansionLoop(BzrError):
 
3235
 
 
3236
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
 
3237
 
 
3238
    def __init__(self, string, refs):
 
3239
        self.string = string
 
3240
        self.refs = '->'.join(refs)
 
3241
 
 
3242
 
 
3243
class ExpandingUnknownOption(BzrError):
 
3244
 
 
3245
    _fmt = 'Option "%(name)s" is not defined while expanding "%(string)s".'
 
3246
 
 
3247
    def __init__(self, name, string):
 
3248
        self.name = name
 
3249
        self.string = string
 
3250
 
 
3251
 
 
3252
class IllegalOptionName(BzrError):
 
3253
 
 
3254
    _fmt = 'Option "%(name)s" is not allowed.'
 
3255
 
 
3256
    def __init__(self, name):
 
3257
        self.name = name
 
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.')