/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Vincent Ladeuil
  • Date: 2012-01-31 16:36:53 UTC
  • mto: (6437.23.3 2.5)
  • mto: This revision was merged to the branch mainline in revision 6458.
  • Revision ID: v.ladeuil+lp@free.fr-20120131163653-j5z45vjfx8a6h2d0
Feedback from mgz.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 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
 
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)
713
662
       self.bzrdir = bzrdir
714
663
       PathError.__init__(self, path=path)
715
664
 
 
665
    def __repr__(self):
 
666
        return '<%s %r>' % (self.__class__.__name__, self.__dict__)
 
667
 
716
668
    def _format(self):
717
669
        # XXX: Ideally self.detail would be a property, but Exceptions in
718
670
        # Python 2.4 have to be old-style classes so properties don't work.
723
675
                    self.bzrdir.open_repository()
724
676
                except NoRepositoryPresent:
725
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 = ''
726
687
                else:
727
688
                    self.detail = ': location is a repository'
728
689
            else:
739
700
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
740
701
 
741
702
 
 
703
class AlreadyControlDirError(PathError):
 
704
 
 
705
    _fmt = 'A control directory already exists: "%(path)s".'
 
706
 
 
707
 
742
708
class AlreadyBranchError(PathError):
743
709
 
744
710
    _fmt = 'Already a branch: "%(path)s".'
778
744
        self.path = bzrdir.transport.clone('..').base
779
745
 
780
746
 
781
 
class FileInWrongBranch(BzrError):
782
 
 
783
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
784
 
 
785
 
    def __init__(self, branch, path):
786
 
        BzrError.__init__(self)
787
 
        self.branch = branch
788
 
        self.branch_base = branch.base
789
 
        self.path = path
790
 
 
791
 
 
792
747
class UnsupportedFormatError(BzrError):
793
748
 
794
749
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
813
768
        self.bzrdir = bzrdir_format
814
769
 
815
770
 
 
771
class ParseFormatError(BzrError):
 
772
 
 
773
    _fmt = "Parse error on line %(lineno)d of %(format)s format: %(line)s"
 
774
 
 
775
    def __init__(self, format, lineno, line, text):
 
776
        BzrError.__init__(self)
 
777
        self.format = format
 
778
        self.lineno = lineno
 
779
        self.line = line
 
780
        self.text = text
 
781
 
 
782
 
816
783
class IncompatibleRepositories(BzrError):
817
784
    """Report an error that two repositories are not compatible.
818
785
 
850
817
        """Construct a new AlreadyVersionedError.
851
818
 
852
819
        :param path: This is the path which is versioned,
853
 
        which should be in a user friendly form.
 
820
            which should be in a user friendly form.
854
821
        :param context_info: If given, this is information about the context,
855
 
        which could explain why this is expected to not be versioned.
 
822
            which could explain why this is expected to not be versioned.
856
823
        """
857
824
        BzrError.__init__(self)
858
825
        self.path = path
871
838
        """Construct a new NotVersionedError.
872
839
 
873
840
        :param path: This is the path which is not versioned,
874
 
        which should be in a user friendly form.
 
841
            which should be in a user friendly form.
875
842
        :param context_info: If given, this is information about the context,
876
 
        which could explain why this is expected to be versioned.
 
843
            which could explain why this is expected to be versioned.
877
844
        """
878
845
        BzrError.__init__(self)
879
846
        self.path = path
947
914
    # original exception is available as e.original_error
948
915
    #
949
916
    # New code should prefer to raise specific subclasses
950
 
    def __init__(self, message):
951
 
        # Python 2.5 uses a slot for StandardError.message,
952
 
        # so use a different variable name.  We now work around this in
953
 
        # BzrError.__str__, but this member name is kept for compatability.
954
 
        self.msg = message
 
917
    def __init__(self, msg):
 
918
        self.msg = msg
955
919
 
956
920
 
957
921
class LockActive(LockError):
1041
1005
class LockContention(LockError):
1042
1006
 
1043
1007
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
1044
 
    # TODO: show full url for lock, combining the transport and relative
1045
 
    # bits?
1046
1008
 
1047
1009
    internal_error = False
1048
1010
 
1075
1037
        self.target = target
1076
1038
 
1077
1039
 
 
1040
class LockCorrupt(LockError):
 
1041
 
 
1042
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
 
1043
            "Use 'bzr break-lock' to clear it")
 
1044
 
 
1045
    internal_error = False
 
1046
 
 
1047
    def __init__(self, corruption_info, file_data=None):
 
1048
        self.corruption_info = corruption_info
 
1049
        self.file_data = file_data
 
1050
 
 
1051
 
1078
1052
class LockNotHeld(LockError):
1079
1053
 
1080
1054
    _fmt = "Lock not held: %(lock)s"
1119
1093
        BzrError.__init__(self, files=files, files_str=files_str)
1120
1094
 
1121
1095
 
 
1096
class ExcludesUnsupported(BzrError):
 
1097
 
 
1098
    _fmt = ('Excluding paths during commit is not supported by '
 
1099
            'repository at %(repository)r.')
 
1100
 
 
1101
    def __init__(self, repository):
 
1102
        BzrError.__init__(self, repository=repository)
 
1103
 
 
1104
 
1122
1105
class BadCommitMessageEncoding(BzrError):
1123
1106
 
1124
1107
    _fmt = 'The specified commit message contains characters unsupported by '\
1180
1163
class InvalidRevisionSpec(BzrError):
1181
1164
 
1182
1165
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1183
 
            " %(branch)s%(extra)s")
 
1166
            " %(branch_url)s%(extra)s")
1184
1167
 
1185
1168
    def __init__(self, spec, branch, extra=None):
1186
1169
        BzrError.__init__(self, branch=branch, spec=spec)
 
1170
        self.branch_url = getattr(branch, 'user_url', str(branch))
1187
1171
        if extra:
1188
1172
            self.extra = '\n' + str(extra)
1189
1173
        else:
1190
1174
            self.extra = ''
1191
1175
 
1192
1176
 
1193
 
class HistoryMissing(BzrError):
1194
 
 
1195
 
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
1196
 
 
1197
 
 
1198
1177
class AppendRevisionsOnlyViolation(BzrError):
1199
1178
 
1200
1179
    _fmt = ('Operation denied because it would change the main history,'
1265
1244
            not_ancestor_id=not_ancestor_id)
1266
1245
 
1267
1246
 
1268
 
class AmbiguousBase(BzrError):
1269
 
 
1270
 
    def __init__(self, bases):
1271
 
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1272
 
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1273
 
        msg = ("The correct base is unclear, because %s are all equally close"
1274
 
                % ", ".join(bases))
1275
 
        BzrError.__init__(self, msg)
1276
 
        self.bases = bases
1277
 
 
1278
 
 
1279
1247
class NoCommits(BranchError):
1280
1248
 
1281
1249
    _fmt = "Branch %(branch)s has no commits."
1380
1348
 
1381
1349
class WeaveParentMismatch(WeaveError):
1382
1350
 
1383
 
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1351
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
1384
1352
 
1385
1353
 
1386
1354
class WeaveInvalidChecksum(WeaveError):
1387
1355
 
1388
 
    _fmt = "Text did not match it's checksum: %(message)s"
 
1356
    _fmt = "Text did not match its checksum: %(msg)s"
1389
1357
 
1390
1358
 
1391
1359
class WeaveTextDiffers(WeaveError):
1439
1407
 
1440
1408
class VersionedFileInvalidChecksum(VersionedFileError):
1441
1409
 
1442
 
    _fmt = "Text did not match its checksum: %(message)s"
 
1410
    _fmt = "Text did not match its checksum: %(msg)s"
1443
1411
 
1444
1412
 
1445
1413
class KnitError(InternalBzrError):
1541
1509
            problem we can raise the original error (value from sys.exc_info())
1542
1510
        """
1543
1511
        BzrError.__init__(self)
 
1512
        self.context = context
1544
1513
        self.reload_occurred = reload_occurred
1545
1514
        self.exc_info = exc_info
1546
1515
        self.orig_error = exc_info[1]
1628
1597
 
1629
1598
    def __init__(self, exc_info):
1630
1599
        import traceback
 
1600
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1631
1601
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1632
1602
        self.exc_info = exc_info
1633
1603
        traceback_strings = traceback.format_exception(
1672
1642
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1673
1643
 
1674
1644
 
 
1645
class ConnectionTimeout(ConnectionError):
 
1646
 
 
1647
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1648
 
 
1649
 
1675
1650
class InvalidRange(TransportError):
1676
1651
 
1677
1652
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1684
1659
 
1685
1660
class InvalidHttpResponse(TransportError):
1686
1661
 
1687
 
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1662
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
1688
1663
 
1689
1664
    def __init__(self, path, msg, orig_error=None):
1690
1665
        self.path = path
 
1666
        if orig_error is None:
 
1667
            orig_error = ''
 
1668
        else:
 
1669
            # This is reached for obscure and unusual errors so we want to
 
1670
            # preserve as much info as possible to ease debug.
 
1671
            orig_error = ': %r' % (orig_error,)
1691
1672
        TransportError.__init__(self, msg, orig_error=orig_error)
1692
1673
 
1693
1674
 
 
1675
class CertificateError(TransportError):
 
1676
 
 
1677
    _fmt = "Certificate error: %(error)s"
 
1678
 
 
1679
    def __init__(self, error):
 
1680
        self.error = error
 
1681
 
 
1682
 
1694
1683
class InvalidHttpRange(InvalidHttpResponse):
1695
1684
 
1696
1685
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1700
1689
        InvalidHttpResponse.__init__(self, path, msg)
1701
1690
 
1702
1691
 
 
1692
class HttpBoundaryMissing(InvalidHttpResponse):
 
1693
    """A multipart response ends with no boundary marker.
 
1694
 
 
1695
    This is a special case caused by buggy proxies, described in
 
1696
    <https://bugs.launchpad.net/bzr/+bug/198646>.
 
1697
    """
 
1698
 
 
1699
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
 
1700
 
 
1701
    def __init__(self, path, msg):
 
1702
        InvalidHttpResponse.__init__(self, path, msg)
 
1703
 
 
1704
 
1703
1705
class InvalidHttpContentType(InvalidHttpResponse):
1704
1706
 
1705
1707
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1733
1735
    _fmt = "Working tree has conflicts."
1734
1736
 
1735
1737
 
 
1738
class ConfigContentError(BzrError):
 
1739
 
 
1740
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
 
1741
 
 
1742
    def __init__(self, filename):
 
1743
        BzrError.__init__(self)
 
1744
        self.filename = filename
 
1745
 
 
1746
 
1736
1747
class ParseConfigError(BzrError):
1737
1748
 
 
1749
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
 
1750
 
1738
1751
    def __init__(self, errors, filename):
1739
 
        if filename is None:
1740
 
            filename = ""
1741
 
        message = "Error(s) parsing config file %s:\n%s" % \
1742
 
            (filename, ('\n'.join(e.msg for e in errors)))
1743
 
        BzrError.__init__(self, message)
 
1752
        BzrError.__init__(self)
 
1753
        self.filename = filename
 
1754
        self.errors = '\n'.join(e.msg for e in errors)
 
1755
 
 
1756
 
 
1757
class ConfigOptionValueError(BzrError):
 
1758
 
 
1759
    _fmt = ('Bad value "%(value)s" for option "%(name)s".\n'
 
1760
            'See ``bzr help %(name)s``')
 
1761
 
 
1762
    def __init__(self, name, value):
 
1763
        BzrError.__init__(self, name=name, value=value)
1744
1764
 
1745
1765
 
1746
1766
class NoEmailInUsername(BzrError):
1754
1774
 
1755
1775
class SigningFailed(BzrError):
1756
1776
 
1757
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1777
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
1758
1778
 
1759
1779
    def __init__(self, command_line):
1760
1780
        BzrError.__init__(self, command_line=command_line)
1761
1781
 
1762
1782
 
 
1783
class SignatureVerificationFailed(BzrError):
 
1784
 
 
1785
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
 
1786
 
 
1787
    def __init__(self, error):
 
1788
        BzrError.__init__(self, error=error)
 
1789
 
 
1790
 
 
1791
class DependencyNotPresent(BzrError):
 
1792
 
 
1793
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1794
 
 
1795
    def __init__(self, library, error):
 
1796
        BzrError.__init__(self, library=library, error=error)
 
1797
 
 
1798
 
 
1799
class GpgmeNotInstalled(DependencyNotPresent):
 
1800
 
 
1801
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
 
1802
 
 
1803
    def __init__(self, error):
 
1804
        DependencyNotPresent.__init__(self, 'gpgme', error)
 
1805
 
 
1806
 
1763
1807
class WorkingTreeNotRevision(BzrError):
1764
1808
 
1765
1809
    _fmt = ("The working tree for %(basedir)s has changed since"
1881
1925
        self.prefix = prefix
1882
1926
 
1883
1927
 
1884
 
class MalformedTransform(BzrError):
 
1928
class MalformedTransform(InternalBzrError):
1885
1929
 
1886
1930
    _fmt = "Tree transform is malformed %(conflicts)r"
1887
1931
 
1925
1969
    _fmt = "Moving the root directory is not supported at this time"
1926
1970
 
1927
1971
 
 
1972
class TransformRenameFailed(BzrError):
 
1973
 
 
1974
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
1975
 
 
1976
    def __init__(self, from_path, to_path, why, errno):
 
1977
        self.from_path = from_path
 
1978
        self.to_path = to_path
 
1979
        self.why = why
 
1980
        self.errno = errno
 
1981
 
 
1982
 
1928
1983
class BzrMoveFailedError(BzrError):
1929
1984
 
1930
 
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1985
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
 
1986
        "%(_has_extra)s%(extra)s")
1931
1987
 
1932
1988
    def __init__(self, from_path='', to_path='', extra=None):
1933
1989
        from bzrlib.osutils import splitpath
1934
1990
        BzrError.__init__(self)
1935
1991
        if extra:
1936
 
            self.extra = ': ' + str(extra)
 
1992
            self.extra, self._has_extra = extra, ': '
1937
1993
        else:
1938
 
            self.extra = ''
 
1994
            self.extra = self._has_extra = ''
1939
1995
 
1940
1996
        has_from = len(from_path) > 0
1941
1997
        has_to = len(to_path) > 0
1962
2018
 
1963
2019
class BzrRenameFailedError(BzrMoveFailedError):
1964
2020
 
1965
 
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
2021
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
 
2022
        "%(_has_extra)s%(extra)s")
1966
2023
 
1967
2024
    def __init__(self, from_path, to_path, extra=None):
1968
2025
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1969
2026
 
1970
 
class BzrRemoveChangedFilesError(BzrError):
1971
 
    """Used when user is trying to remove changed files."""
1972
 
 
1973
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
1974
 
        "%(changes_as_text)s"
1975
 
        "Use --keep to not delete them, or --force to delete them regardless.")
1976
 
 
1977
 
    def __init__(self, tree_delta):
1978
 
        BzrError.__init__(self)
1979
 
        self.changes_as_text = tree_delta.get_changes_as_text()
1980
 
        #self.paths_as_string = '\n'.join(changed_files)
1981
 
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
1982
 
 
1983
2027
 
1984
2028
class BzrBadParameterNotString(BzrBadParameter):
1985
2029
 
1988
2032
 
1989
2033
class BzrBadParameterMissing(BzrBadParameter):
1990
2034
 
1991
 
    _fmt = "Parameter $(param)s is required but not present."
 
2035
    _fmt = "Parameter %(param)s is required but not present."
1992
2036
 
1993
2037
 
1994
2038
class BzrBadParameterUnicode(BzrBadParameter):
2002
2046
    _fmt = "Parameter %(param)s contains a newline."
2003
2047
 
2004
2048
 
2005
 
class DependencyNotPresent(BzrError):
2006
 
 
2007
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
2008
 
 
2009
 
    def __init__(self, library, error):
2010
 
        BzrError.__init__(self, library=library, error=error)
2011
 
 
2012
 
 
2013
2049
class ParamikoNotPresent(DependencyNotPresent):
2014
2050
 
2015
2051
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2250
2286
    """
2251
2287
 
2252
2288
 
 
2289
class GhostTagsNotSupported(BzrError):
 
2290
 
 
2291
    _fmt = "Ghost tags not supported by format %(format)r."
 
2292
 
 
2293
    def __init__(self, format):
 
2294
        self.format = format
 
2295
 
 
2296
 
2253
2297
class BinaryFile(BzrError):
2254
2298
 
2255
2299
    _fmt = "File is binary but should be text."
2618
2662
 
2619
2663
    This is distinct from ErrorFromSmartServer so that it is possible to
2620
2664
    distinguish between the following two cases:
2621
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2622
 
        and so should provoke a traceback to the user.
2623
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2624
 
        translated.  This is probably because the server sent us garbage, and
2625
 
        should not provoke a traceback.
 
2665
 
 
2666
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2667
      and so should provoke a traceback to the user.
 
2668
    - ErrorFromSmartServer was caught but its error_tuple could not be
 
2669
      translated.  This is probably because the server sent us garbage, and
 
2670
      should not provoke a traceback.
2626
2671
    """
2627
2672
 
2628
2673
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2684
2729
    _fmt = "Container has multiple records with the same name: %(name)s"
2685
2730
 
2686
2731
    def __init__(self, name):
2687
 
        self.name = name
 
2732
        self.name = name.decode("utf-8")
2688
2733
 
2689
2734
 
2690
2735
class NoDestinationAddress(InternalBzrError):
2834
2879
        else:
2835
2880
            more = ' ' + more
2836
2881
        import bzrlib.urlutils as urlutils
2837
 
        display_url = urlutils.unescape_for_display(
2838
 
            tree.user_url, 'ascii')
 
2882
        user_url = getattr(tree, "user_url", None)
 
2883
        if user_url is None:
 
2884
            display_url = str(tree)
 
2885
        else:
 
2886
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
2839
2887
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2840
2888
 
2841
2889
 
 
2890
class ShelvedChanges(UncommittedChanges):
 
2891
 
 
2892
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2893
            ' (See bzr shelve --list).%(more)s')
 
2894
 
 
2895
 
2842
2896
class MissingTemplateVariable(BzrError):
2843
2897
 
2844
2898
    _fmt = 'Variable {%(name)s} is not available.'
2910
2964
        from bzrlib.osutils import get_user_encoding
2911
2965
        self.path = path
2912
2966
        self.kind = kind
2913
 
        self.user_encoding = osutils.get_user_encoding()
 
2967
        self.user_encoding = get_user_encoding()
 
2968
 
 
2969
 
 
2970
class NoSuchConfig(BzrError):
 
2971
 
 
2972
    _fmt = ('The "%(config_id)s" configuration does not exist.')
 
2973
 
 
2974
    def __init__(self, config_id):
 
2975
        BzrError.__init__(self, config_id=config_id)
 
2976
 
 
2977
 
 
2978
class NoSuchConfigOption(BzrError):
 
2979
 
 
2980
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
 
2981
 
 
2982
    def __init__(self, option_name):
 
2983
        BzrError.__init__(self, option_name=option_name)
2914
2984
 
2915
2985
 
2916
2986
class NoSuchAlias(BzrError):
2961
3031
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
2962
3032
 
2963
3033
 
2964
 
class HookFailed(BzrError):
2965
 
    """Raised when a pre_change_branch_tip hook function fails anything other
2966
 
    than TipChangeRejected.
2967
 
 
2968
 
    Note that this exception is no longer raised, and the import is only left
2969
 
    to be nice to code which might catch it in a plugin.
2970
 
    """
2971
 
 
2972
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2973
 
            "%(traceback_text)s%(exc_value)s")
2974
 
 
2975
 
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
2976
 
        if warn:
2977
 
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
2978
 
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
2979
 
        import traceback
2980
 
        self.hook_stage = hook_stage
2981
 
        self.hook_name = hook_name
2982
 
        self.exc_info = exc_info
2983
 
        self.exc_type = exc_info[0]
2984
 
        self.exc_value = exc_info[1]
2985
 
        self.exc_tb = exc_info[2]
2986
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
2987
 
 
2988
 
 
2989
3034
class TipChangeRejected(BzrError):
2990
3035
    """A pre_change_branch_tip hook function may raise this to cleanly and
2991
3036
    explicitly abort a change to a branch tip.
3002
3047
    _fmt = "Shelf corrupt."
3003
3048
 
3004
3049
 
 
3050
class DecompressCorruption(BzrError):
 
3051
 
 
3052
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
 
3053
 
 
3054
    def __init__(self, orig_error=None):
 
3055
        if orig_error is not None:
 
3056
            self.orig_error = ", %s" % (orig_error,)
 
3057
        else:
 
3058
            self.orig_error = ""
 
3059
        BzrError.__init__(self)
 
3060
 
 
3061
 
3005
3062
class NoSuchShelfId(BzrError):
3006
3063
 
3007
3064
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3134
3191
    def __init__(self, bzrdir):
3135
3192
        self.bzrdir = bzrdir
3136
3193
 
 
3194
 
 
3195
class NoWhoami(BzrError):
 
3196
 
 
3197
    _fmt = ('Unable to determine your name.\n'
 
3198
        "Please, set your name with the 'whoami' command.\n"
 
3199
        'E.g. bzr whoami "Your Name <name@example.com>"')
 
3200
 
 
3201
 
 
3202
class InvalidPattern(BzrError):
 
3203
 
 
3204
    _fmt = ('Invalid pattern(s) found. %(msg)s')
 
3205
 
 
3206
    def __init__(self, msg):
 
3207
        self.msg = msg
 
3208
 
 
3209
 
 
3210
class RecursiveBind(BzrError):
 
3211
 
 
3212
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
 
3213
        'Please use `bzr unbind` to fix.')
 
3214
 
 
3215
    def __init__(self, branch_url):
 
3216
        self.branch_url = branch_url
 
3217
 
 
3218
 
 
3219
# FIXME: I would prefer to define the config related exception classes in
 
3220
# config.py but the lazy import mechanism proscribes this -- vila 20101222
 
3221
class OptionExpansionLoop(BzrError):
 
3222
 
 
3223
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
 
3224
 
 
3225
    def __init__(self, string, refs):
 
3226
        self.string = string
 
3227
        self.refs = '->'.join(refs)
 
3228
 
 
3229
 
 
3230
class ExpandingUnknownOption(BzrError):
 
3231
 
 
3232
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
 
3233
 
 
3234
    def __init__(self, name, string):
 
3235
        self.name = name
 
3236
        self.string = string
 
3237
 
 
3238
 
 
3239
class NoCompatibleInter(BzrError):
 
3240
 
 
3241
    _fmt = ('No compatible object available for operations from %(source)r '
 
3242
            'to %(target)r.')
 
3243
 
 
3244
    def __init__(self, source, target):
 
3245
        self.source = source
 
3246
        self.target = target
 
3247
 
 
3248
 
 
3249
class HpssVfsRequestNotAllowed(BzrError):
 
3250
 
 
3251
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
 
3252
            "%(method)s, %(arguments)s.")
 
3253
 
 
3254
    def __init__(self, method, arguments):
 
3255
        self.method = method
 
3256
        self.arguments = arguments
 
3257
 
 
3258
 
 
3259
class UnsupportedKindChange(BzrError):
 
3260
 
 
3261
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
 
3262
            "%(path)s not supported by format %(format)r")
 
3263
 
 
3264
    def __init__(self, path, from_kind, to_kind, format):
 
3265
        self.path = path
 
3266
        self.from_kind = from_kind
 
3267
        self.to_kind = to_kind
 
3268
        self.format = format
 
3269
 
 
3270
 
 
3271
class MissingFeature(BzrError):
 
3272
 
 
3273
    _fmt = ("Missing feature %(feature)s not provided by this "
 
3274
            "version of Bazaar or any plugin.")
 
3275
 
 
3276
    def __init__(self, feature):
 
3277
        self.feature = feature
 
3278
 
 
3279
 
 
3280
class PatchSyntax(BzrError):
 
3281
    """Base class for patch syntax errors."""
 
3282
 
 
3283
 
 
3284
class BinaryFiles(BzrError):
 
3285
 
 
3286
    _fmt = 'Binary files section encountered.'
 
3287
 
 
3288
    def __init__(self, orig_name, mod_name):
 
3289
        self.orig_name = orig_name
 
3290
        self.mod_name = mod_name
 
3291
 
 
3292
 
 
3293
class MalformedPatchHeader(PatchSyntax):
 
3294
 
 
3295
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
 
3296
 
 
3297
    def __init__(self, desc, line):
 
3298
        self.desc = desc
 
3299
        self.line = line
 
3300
 
 
3301
 
 
3302
class MalformedHunkHeader(PatchSyntax):
 
3303
 
 
3304
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
 
3305
 
 
3306
    def __init__(self, desc, line):
 
3307
        self.desc = desc
 
3308
        self.line = line
 
3309
 
 
3310
 
 
3311
class MalformedLine(PatchSyntax):
 
3312
 
 
3313
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
 
3314
 
 
3315
    def __init__(self, desc, line):
 
3316
        self.desc = desc
 
3317
        self.line = line
 
3318
 
 
3319
 
 
3320
class PatchConflict(BzrError):
 
3321
 
 
3322
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
 
3323
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
 
3324
 
 
3325
    def __init__(self, line_no, orig_line, patch_line):
 
3326
        self.line_no = line_no
 
3327
        self.orig_line = orig_line.rstrip('\n')
 
3328
        self.patch_line = patch_line.rstrip('\n')
 
3329
 
 
3330
 
 
3331
class FeatureAlreadyRegistered(BzrError):
 
3332
 
 
3333
    _fmt = 'The feature %(feature)s has already been registered.'
 
3334
 
 
3335
    def __init__(self, feature):
 
3336
        self.feature = feature