~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
 
680
629
 
681
630
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
682
631
 
683
 
    internal_error = True
 
632
    internal_error = False
684
633
 
685
634
    def __init__(self, path, base, extra=None):
686
635
        BzrError.__init__(self)
702
651
# TODO: Probably this behavior of should be a common superclass
703
652
class NotBranchError(PathError):
704
653
 
705
 
    _fmt = 'Not a branch: "%(path)s".'
 
654
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
706
655
 
707
 
    def __init__(self, path):
 
656
    def __init__(self, path, detail=None, bzrdir=None):
708
657
       import bzrlib.urlutils as urlutils
709
 
       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)
710
692
 
711
693
 
712
694
class NoSubmitBranch(PathError):
718
700
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
719
701
 
720
702
 
 
703
class AlreadyControlDirError(PathError):
 
704
 
 
705
    _fmt = 'A control directory already exists: "%(path)s".'
 
706
 
 
707
 
721
708
class AlreadyBranchError(PathError):
722
709
 
723
710
    _fmt = 'Already a branch: "%(path)s".'
724
711
 
725
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
 
726
727
class BranchExistsWithoutWorkingTree(PathError):
727
728
 
728
729
    _fmt = 'Directory contains a branch, but no working tree \
757
758
        self.path = bzrdir.transport.clone('..').base
758
759
 
759
760
 
760
 
class FileInWrongBranch(BzrError):
761
 
 
762
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
763
 
 
764
 
    def __init__(self, branch, path):
765
 
        BzrError.__init__(self)
766
 
        self.branch = branch
767
 
        self.branch_base = branch.base
768
 
        self.path = path
769
 
 
770
 
 
771
761
class UnsupportedFormatError(BzrError):
772
762
 
773
763
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
792
782
        self.bzrdir = bzrdir_format
793
783
 
794
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
 
795
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
    """
796
804
 
797
805
    _fmt = "%(target)s\n" \
798
806
            "is not compatible with\n" \
823
831
        """Construct a new AlreadyVersionedError.
824
832
 
825
833
        :param path: This is the path which is versioned,
826
 
        which should be in a user friendly form.
 
834
            which should be in a user friendly form.
827
835
        :param context_info: If given, this is information about the context,
828
 
        which could explain why this is expected to not be versioned.
 
836
            which could explain why this is expected to not be versioned.
829
837
        """
830
838
        BzrError.__init__(self)
831
839
        self.path = path
844
852
        """Construct a new NotVersionedError.
845
853
 
846
854
        :param path: This is the path which is not versioned,
847
 
        which should be in a user friendly form.
 
855
            which should be in a user friendly form.
848
856
        :param context_info: If given, this is information about the context,
849
 
        which could explain why this is expected to be versioned.
 
857
            which could explain why this is expected to be versioned.
850
858
        """
851
859
        BzrError.__init__(self)
852
860
        self.path = path
920
928
    # original exception is available as e.original_error
921
929
    #
922
930
    # New code should prefer to raise specific subclasses
923
 
    def __init__(self, message):
924
 
        # Python 2.5 uses a slot for StandardError.message,
925
 
        # so use a different variable name.  We now work around this in
926
 
        # BzrError.__str__, but this member name is kept for compatability.
927
 
        self.msg = message
 
931
    def __init__(self, msg):
 
932
        self.msg = msg
928
933
 
929
934
 
930
935
class LockActive(LockError):
1014
1019
class LockContention(LockError):
1015
1020
 
1016
1021
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
1017
 
    # TODO: show full url for lock, combining the transport and relative
1018
 
    # bits?
1019
1022
 
1020
1023
    internal_error = False
1021
1024
 
1048
1051
        self.target = target
1049
1052
 
1050
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
 
1051
1066
class LockNotHeld(LockError):
1052
1067
 
1053
1068
    _fmt = "Lock not held: %(lock)s"
1092
1107
        BzrError.__init__(self, files=files, files_str=files_str)
1093
1108
 
1094
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
 
1095
1119
class BadCommitMessageEncoding(BzrError):
1096
1120
 
1097
1121
    _fmt = 'The specified commit message contains characters unsupported by '\
1152
1176
 
1153
1177
class InvalidRevisionSpec(BzrError):
1154
1178
 
1155
 
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
1156
 
            " %(branch)s%(extra)s")
 
1179
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1180
            " %(branch_url)s%(extra)s")
1157
1181
 
1158
1182
    def __init__(self, spec, branch, extra=None):
1159
1183
        BzrError.__init__(self, branch=branch, spec=spec)
 
1184
        self.branch_url = getattr(branch, 'user_url', str(branch))
1160
1185
        if extra:
1161
1186
            self.extra = '\n' + str(extra)
1162
1187
        else:
1163
1188
            self.extra = ''
1164
1189
 
1165
1190
 
1166
 
class HistoryMissing(BzrError):
1167
 
 
1168
 
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
1169
 
 
1170
 
 
1171
1191
class AppendRevisionsOnlyViolation(BzrError):
1172
1192
 
1173
1193
    _fmt = ('Operation denied because it would change the main history,'
1238
1258
            not_ancestor_id=not_ancestor_id)
1239
1259
 
1240
1260
 
1241
 
class AmbiguousBase(BzrError):
1242
 
 
1243
 
    def __init__(self, bases):
1244
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1245
 
                DeprecationWarning)
1246
 
        msg = ("The correct base is unclear, because %s are all equally close"
1247
 
                % ", ".join(bases))
1248
 
        BzrError.__init__(self, msg)
1249
 
        self.bases = bases
1250
 
 
1251
 
 
1252
1261
class NoCommits(BranchError):
1253
1262
 
1254
1263
    _fmt = "Branch %(branch)s has no commits."
1270
1279
class BoundBranchOutOfDate(BzrError):
1271
1280
 
1272
1281
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1273
 
            " %(master)s.")
 
1282
            " %(master)s.%(extra_help)s")
1274
1283
 
1275
1284
    def __init__(self, branch, master):
1276
1285
        BzrError.__init__(self)
1277
1286
        self.branch = branch
1278
1287
        self.master = master
 
1288
        self.extra_help = ''
1279
1289
 
1280
1290
 
1281
1291
class CommitToDoubleBoundBranch(BzrError):
1352
1362
 
1353
1363
class WeaveParentMismatch(WeaveError):
1354
1364
 
1355
 
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1365
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
1356
1366
 
1357
1367
 
1358
1368
class WeaveInvalidChecksum(WeaveError):
1359
1369
 
1360
 
    _fmt = "Text did not match it's checksum: %(message)s"
 
1370
    _fmt = "Text did not match its checksum: %(msg)s"
1361
1371
 
1362
1372
 
1363
1373
class WeaveTextDiffers(WeaveError):
1411
1421
 
1412
1422
class VersionedFileInvalidChecksum(VersionedFileError):
1413
1423
 
1414
 
    _fmt = "Text did not match its checksum: %(message)s"
 
1424
    _fmt = "Text did not match its checksum: %(msg)s"
1415
1425
 
1416
1426
 
1417
1427
class KnitError(InternalBzrError):
1513
1523
            problem we can raise the original error (value from sys.exc_info())
1514
1524
        """
1515
1525
        BzrError.__init__(self)
 
1526
        self.context = context
1516
1527
        self.reload_occurred = reload_occurred
1517
1528
        self.exc_info = exc_info
1518
1529
        self.orig_error = exc_info[1]
1600
1611
 
1601
1612
    def __init__(self, exc_info):
1602
1613
        import traceback
 
1614
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1603
1615
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1604
1616
        self.exc_info = exc_info
1605
1617
        traceback_strings = traceback.format_exception(
1644
1656
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1645
1657
 
1646
1658
 
 
1659
class ConnectionTimeout(ConnectionError):
 
1660
 
 
1661
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1662
 
 
1663
 
1647
1664
class InvalidRange(TransportError):
1648
1665
 
1649
1666
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1656
1673
 
1657
1674
class InvalidHttpResponse(TransportError):
1658
1675
 
1659
 
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1676
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
1660
1677
 
1661
1678
    def __init__(self, path, msg, orig_error=None):
1662
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,)
1663
1686
        TransportError.__init__(self, msg, orig_error=orig_error)
1664
1687
 
1665
1688
 
1672
1695
        InvalidHttpResponse.__init__(self, path, msg)
1673
1696
 
1674
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
 
1675
1711
class InvalidHttpContentType(InvalidHttpResponse):
1676
1712
 
1677
1713
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1705
1741
    _fmt = "Working tree has conflicts."
1706
1742
 
1707
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
 
1708
1753
class ParseConfigError(BzrError):
1709
1754
 
 
1755
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
 
1756
 
1710
1757
    def __init__(self, errors, filename):
1711
 
        if filename is None:
1712
 
            filename = ""
1713
 
        message = "Error(s) parsing config file %s:\n%s" % \
1714
 
            (filename, ('\n'.join(e.msg for e in errors)))
1715
 
        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)
1716
1770
 
1717
1771
 
1718
1772
class NoEmailInUsername(BzrError):
1726
1780
 
1727
1781
class SigningFailed(BzrError):
1728
1782
 
1729
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1783
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
1730
1784
 
1731
1785
    def __init__(self, command_line):
1732
1786
        BzrError.__init__(self, command_line=command_line)
1733
1787
 
1734
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
 
1735
1813
class WorkingTreeNotRevision(BzrError):
1736
1814
 
1737
1815
    _fmt = ("The working tree for %(basedir)s has changed since"
1853
1931
        self.prefix = prefix
1854
1932
 
1855
1933
 
1856
 
class MalformedTransform(BzrError):
 
1934
class MalformedTransform(InternalBzrError):
1857
1935
 
1858
1936
    _fmt = "Tree transform is malformed %(conflicts)r"
1859
1937
 
1897
1975
    _fmt = "Moving the root directory is not supported at this time"
1898
1976
 
1899
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
 
1900
1989
class BzrMoveFailedError(BzrError):
1901
1990
 
1902
 
    _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")
1903
1993
 
1904
1994
    def __init__(self, from_path='', to_path='', extra=None):
1905
1995
        from bzrlib.osutils import splitpath
1906
1996
        BzrError.__init__(self)
1907
1997
        if extra:
1908
 
            self.extra = ': ' + str(extra)
 
1998
            self.extra, self._has_extra = extra, ': '
1909
1999
        else:
1910
 
            self.extra = ''
 
2000
            self.extra = self._has_extra = ''
1911
2001
 
1912
2002
        has_from = len(from_path) > 0
1913
2003
        has_to = len(to_path) > 0
1934
2024
 
1935
2025
class BzrRenameFailedError(BzrMoveFailedError):
1936
2026
 
1937
 
    _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")
1938
2029
 
1939
2030
    def __init__(self, from_path, to_path, extra=None):
1940
2031
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1941
2032
 
1942
 
class BzrRemoveChangedFilesError(BzrError):
1943
 
    """Used when user is trying to remove changed files."""
1944
 
 
1945
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
1946
 
        "%(changes_as_text)s"
1947
 
        "Use --keep to not delete them, or --force to delete them regardless.")
1948
 
 
1949
 
    def __init__(self, tree_delta):
1950
 
        BzrError.__init__(self)
1951
 
        self.changes_as_text = tree_delta.get_changes_as_text()
1952
 
        #self.paths_as_string = '\n'.join(changed_files)
1953
 
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
1954
 
 
1955
2033
 
1956
2034
class BzrBadParameterNotString(BzrBadParameter):
1957
2035
 
1960
2038
 
1961
2039
class BzrBadParameterMissing(BzrBadParameter):
1962
2040
 
1963
 
    _fmt = "Parameter $(param)s is required but not present."
 
2041
    _fmt = "Parameter %(param)s is required but not present."
1964
2042
 
1965
2043
 
1966
2044
class BzrBadParameterUnicode(BzrBadParameter):
1974
2052
    _fmt = "Parameter %(param)s contains a newline."
1975
2053
 
1976
2054
 
1977
 
class DependencyNotPresent(BzrError):
1978
 
 
1979
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1980
 
 
1981
 
    def __init__(self, library, error):
1982
 
        BzrError.__init__(self, library=library, error=error)
1983
 
 
1984
 
 
1985
2055
class ParamikoNotPresent(DependencyNotPresent):
1986
2056
 
1987
2057
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2006
2076
 
2007
2077
class BadConversionTarget(BzrError):
2008
2078
 
2009
 
    _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"
2010
2081
 
2011
 
    def __init__(self, problem, format):
 
2082
    def __init__(self, problem, format, from_format=None):
2012
2083
        BzrError.__init__(self)
2013
2084
        self.problem = problem
2014
2085
        self.format = format
 
2086
        self.from_format = from_format or '(unspecified)'
2015
2087
 
2016
2088
 
2017
2089
class NoDiffFound(BzrError):
2146
2218
 
2147
2219
    def __init__(self, repo):
2148
2220
        BzrError.__init__(self)
2149
 
        self.repo_path = repo.bzrdir.root_transport.base
 
2221
        self.repo_path = repo.user_url
2150
2222
 
2151
2223
 
2152
2224
class InconsistentDelta(BzrError):
2220
2292
    """
2221
2293
 
2222
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
 
2223
2303
class BinaryFile(BzrError):
2224
2304
 
2225
2305
    _fmt = "File is binary but should be text."
2588
2668
 
2589
2669
    This is distinct from ErrorFromSmartServer so that it is possible to
2590
2670
    distinguish between the following two cases:
2591
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2592
 
        and so should provoke a traceback to the user.
2593
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2594
 
        translated.  This is probably because the server sent us garbage, and
2595
 
        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.
2596
2677
    """
2597
2678
 
2598
2679
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2654
2735
    _fmt = "Container has multiple records with the same name: %(name)s"
2655
2736
 
2656
2737
    def __init__(self, name):
2657
 
        self.name = name
 
2738
        self.name = name.decode("utf-8")
2658
2739
 
2659
2740
 
2660
2741
class NoDestinationAddress(InternalBzrError):
2688
2769
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2689
2770
 
2690
2771
 
2691
 
class UnknownMailClient(BzrError):
2692
 
 
2693
 
    _fmt = "Unknown mail client: %(mail_client)s"
2694
 
 
2695
 
    def __init__(self, mail_client):
2696
 
        BzrError.__init__(self, mail_client=mail_client)
2697
 
 
2698
 
 
2699
2772
class MailClientNotFound(BzrError):
2700
2773
 
2701
2774
    _fmt = "Unable to find mail client with the following names:"\
2724
2797
 
2725
2798
    def __init__(self, bzrdir):
2726
2799
        import bzrlib.urlutils as urlutils
2727
 
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2800
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
2728
2801
                                                    'ascii')
2729
2802
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2730
2803
 
2804
2877
        else:
2805
2878
            more = ' ' + more
2806
2879
        import bzrlib.urlutils as urlutils
2807
 
        display_url = urlutils.unescape_for_display(
2808
 
            tree.bzrdir.root_transport.base, 'ascii')
 
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')
2809
2885
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2810
2886
 
2811
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')
 
2907
 
 
2908
 
2812
2909
class MissingTemplateVariable(BzrError):
2813
2910
 
2814
2911
    _fmt = 'Variable {%(name)s} is not available.'
2880
2977
        from bzrlib.osutils import get_user_encoding
2881
2978
        self.path = path
2882
2979
        self.kind = kind
2883
 
        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)
2884
2997
 
2885
2998
 
2886
2999
class NoSuchAlias(BzrError):
2918
3031
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2919
3032
 
2920
3033
    def __init__(self, host, port, orig_error):
 
3034
        # nb: in python2.4 socket.error doesn't have a useful repr
2921
3035
        BzrError.__init__(self, host=host, port=port,
2922
 
            orig_error=orig_error[1])
 
3036
            orig_error=repr(orig_error.args))
2923
3037
 
2924
3038
 
2925
3039
class UnknownRules(BzrError):
2930
3044
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
2931
3045
 
2932
3046
 
2933
 
class HookFailed(BzrError):
2934
 
    """Raised when a pre_change_branch_tip hook function fails anything other
2935
 
    than TipChangeRejected.
2936
 
    """
2937
 
 
2938
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2939
 
            "%(traceback_text)s%(exc_value)s")
2940
 
 
2941
 
    def __init__(self, hook_stage, hook_name, exc_info):
2942
 
        import traceback
2943
 
        self.hook_stage = hook_stage
2944
 
        self.hook_name = hook_name
2945
 
        self.exc_info = exc_info
2946
 
        self.exc_type = exc_info[0]
2947
 
        self.exc_value = exc_info[1]
2948
 
        self.exc_tb = exc_info[2]
2949
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
2950
 
 
2951
 
 
2952
3047
class TipChangeRejected(BzrError):
2953
3048
    """A pre_change_branch_tip hook function may raise this to cleanly and
2954
3049
    explicitly abort a change to a branch tip.
2965
3060
    _fmt = "Shelf corrupt."
2966
3061
 
2967
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
 
2968
3075
class NoSuchShelfId(BzrError):
2969
3076
 
2970
3077
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3066
3173
    def __init__(self, source_branch, target_branch):
3067
3174
        self.source_branch = source_branch
3068
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.')