/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
 
 
32
 
20
33
# TODO: is there any value in providing the .args field used by standard
21
34
# python exceptions?   A list of values with no names seems less useful
22
35
# to me.
41
54
    Base class for errors raised by bzrlib.
42
55
 
43
56
    :cvar internal_error: if True this was probably caused by a bzr bug and
44
 
        should be displayed with a traceback; if False (or absent) this was
45
 
        probably a user or environment error and they don't need the gory
46
 
        details.  (That can be overridden by -Derror on the command line.)
 
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.)
47
60
 
48
61
    :cvar _fmt: Format string to display the error; this is expanded
49
 
        by the instance's dict.
 
62
    by the instance's dict.
50
63
    """
51
64
 
52
65
    internal_error = False
93
106
                # __str__() should always return a 'str' object
94
107
                # never a 'unicode' object.
95
108
                return s
96
 
        except Exception, e:
97
 
            pass # just bind to 'e' for formatting below
98
 
        else:
99
 
            e = None
100
 
        return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
101
 
            % (self.__class__.__name__,
102
 
               self.__dict__,
103
 
               getattr(self, '_fmt', None),
104
 
               e)
 
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)
105
115
 
106
116
    def __unicode__(self):
107
117
        u = self._format()
130
140
        """Return format string for this exception or None"""
131
141
        fmt = getattr(self, '_fmt', None)
132
142
        if fmt is not None:
133
 
            from bzrlib.i18n import gettext
134
 
            return gettext(unicode(fmt)) # _fmt strings should be ascii
 
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
155
 
136
156
    def __eq__(self, other):
137
157
        if self.__class__ is not other.__class__:
150
170
    internal_error = True
151
171
 
152
172
 
 
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
 
153
206
class AlreadyBuilding(BzrError):
154
207
 
155
208
    _fmt = "The tree builder is already building a tree."
251
304
class RootMissing(InternalBzrError):
252
305
 
253
306
    _fmt = ("The root entry of a tree must be the first entry supplied to "
254
 
        "the commit builder.")
 
307
        "record_entry_contents.")
255
308
 
256
309
 
257
310
class NoPublicBranch(BzrError):
568
621
 
569
622
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
570
623
 
571
 
    def __init__(self, url, extra=""):
 
624
    def __init__(self, url, extra):
572
625
        PathError.__init__(self, url, extra=extra)
573
626
 
574
627
 
627
680
 
628
681
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
629
682
 
630
 
    internal_error = False
 
683
    internal_error = True
631
684
 
632
685
    def __init__(self, path, base, extra=None):
633
686
        BzrError.__init__(self)
660
713
       self.bzrdir = bzrdir
661
714
       PathError.__init__(self, path=path)
662
715
 
663
 
    def __repr__(self):
664
 
        return '<%s %r>' % (self.__class__.__name__, self.__dict__)
665
 
 
666
716
    def _format(self):
667
717
        # XXX: Ideally self.detail would be a property, but Exceptions in
668
718
        # Python 2.4 have to be old-style classes so properties don't work.
673
723
                    self.bzrdir.open_repository()
674
724
                except NoRepositoryPresent:
675
725
                    self.detail = ''
676
 
                except Exception:
677
 
                    # Just ignore unexpected errors.  Raising arbitrary errors
678
 
                    # during str(err) can provoke strange bugs.  Concretely
679
 
                    # Launchpad's codehosting managed to raise NotBranchError
680
 
                    # here, and then get stuck in an infinite loop/recursion
681
 
                    # trying to str() that error.  All this error really cares
682
 
                    # about that there's no working repository there, and if
683
 
                    # open_repository() fails, there probably isn't.
684
 
                    self.detail = ''
685
726
                else:
686
727
                    self.detail = ': location is a repository'
687
728
            else:
737
778
        self.path = bzrdir.transport.clone('..').base
738
779
 
739
780
 
 
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
 
740
792
class UnsupportedFormatError(BzrError):
741
793
 
742
794
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
798
850
        """Construct a new AlreadyVersionedError.
799
851
 
800
852
        :param path: This is the path which is versioned,
801
 
            which should be in a user friendly form.
 
853
        which should be in a user friendly form.
802
854
        :param context_info: If given, this is information about the context,
803
 
            which could explain why this is expected to not be versioned.
 
855
        which could explain why this is expected to not be versioned.
804
856
        """
805
857
        BzrError.__init__(self)
806
858
        self.path = path
819
871
        """Construct a new NotVersionedError.
820
872
 
821
873
        :param path: This is the path which is not versioned,
822
 
            which should be in a user friendly form.
 
874
        which should be in a user friendly form.
823
875
        :param context_info: If given, this is information about the context,
824
 
            which could explain why this is expected to be versioned.
 
876
        which could explain why this is expected to be versioned.
825
877
        """
826
878
        BzrError.__init__(self)
827
879
        self.path = path
895
947
    # original exception is available as e.original_error
896
948
    #
897
949
    # New code should prefer to raise specific subclasses
898
 
    def __init__(self, msg):
899
 
        self.msg = msg
 
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
900
955
 
901
956
 
902
957
class LockActive(LockError):
986
1041
class LockContention(LockError):
987
1042
 
988
1043
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
1044
    # TODO: show full url for lock, combining the transport and relative
 
1045
    # bits?
989
1046
 
990
1047
    internal_error = False
991
1048
 
1018
1075
        self.target = target
1019
1076
 
1020
1077
 
1021
 
class LockCorrupt(LockError):
1022
 
 
1023
 
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
1024
 
            "Use 'bzr break-lock' to clear it")
1025
 
 
1026
 
    internal_error = False
1027
 
 
1028
 
    def __init__(self, corruption_info, file_data=None):
1029
 
        self.corruption_info = corruption_info
1030
 
        self.file_data = file_data
1031
 
 
1032
 
 
1033
1078
class LockNotHeld(LockError):
1034
1079
 
1035
1080
    _fmt = "Lock not held: %(lock)s"
1074
1119
        BzrError.__init__(self, files=files, files_str=files_str)
1075
1120
 
1076
1121
 
1077
 
class ExcludesUnsupported(BzrError):
1078
 
 
1079
 
    _fmt = ('Excluding paths during commit is not supported by '
1080
 
            'repository at %(repository)r.')
1081
 
 
1082
 
    def __init__(self, repository):
1083
 
        BzrError.__init__(self, repository=repository)
1084
 
 
1085
 
 
1086
1122
class BadCommitMessageEncoding(BzrError):
1087
1123
 
1088
1124
    _fmt = 'The specified commit message contains characters unsupported by '\
1144
1180
class InvalidRevisionSpec(BzrError):
1145
1181
 
1146
1182
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1147
 
            " %(branch_url)s%(extra)s")
 
1183
            " %(branch)s%(extra)s")
1148
1184
 
1149
1185
    def __init__(self, spec, branch, extra=None):
1150
1186
        BzrError.__init__(self, branch=branch, spec=spec)
1151
 
        self.branch_url = getattr(branch, 'user_url', str(branch))
1152
1187
        if extra:
1153
1188
            self.extra = '\n' + str(extra)
1154
1189
        else:
1155
1190
            self.extra = ''
1156
1191
 
1157
1192
 
 
1193
class HistoryMissing(BzrError):
 
1194
 
 
1195
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
1196
 
 
1197
 
1158
1198
class AppendRevisionsOnlyViolation(BzrError):
1159
1199
 
1160
1200
    _fmt = ('Operation denied because it would change the main history,'
1225
1265
            not_ancestor_id=not_ancestor_id)
1226
1266
 
1227
1267
 
 
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
 
1228
1279
class NoCommits(BranchError):
1229
1280
 
1230
1281
    _fmt = "Branch %(branch)s has no commits."
1329
1380
 
1330
1381
class WeaveParentMismatch(WeaveError):
1331
1382
 
1332
 
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
 
1383
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1333
1384
 
1334
1385
 
1335
1386
class WeaveInvalidChecksum(WeaveError):
1336
1387
 
1337
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1388
    _fmt = "Text did not match it's checksum: %(message)s"
1338
1389
 
1339
1390
 
1340
1391
class WeaveTextDiffers(WeaveError):
1388
1439
 
1389
1440
class VersionedFileInvalidChecksum(VersionedFileError):
1390
1441
 
1391
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1442
    _fmt = "Text did not match its checksum: %(message)s"
1392
1443
 
1393
1444
 
1394
1445
class KnitError(InternalBzrError):
1490
1541
            problem we can raise the original error (value from sys.exc_info())
1491
1542
        """
1492
1543
        BzrError.__init__(self)
1493
 
        self.context = context
1494
1544
        self.reload_occurred = reload_occurred
1495
1545
        self.exc_info = exc_info
1496
1546
        self.orig_error = exc_info[1]
1578
1628
 
1579
1629
    def __init__(self, exc_info):
1580
1630
        import traceback
1581
 
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1582
1631
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1583
1632
        self.exc_info = exc_info
1584
1633
        traceback_strings = traceback.format_exception(
1623
1672
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1624
1673
 
1625
1674
 
1626
 
class ConnectionTimeout(ConnectionError):
1627
 
 
1628
 
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
1629
 
 
1630
 
 
1631
1675
class InvalidRange(TransportError):
1632
1676
 
1633
1677
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1640
1684
 
1641
1685
class InvalidHttpResponse(TransportError):
1642
1686
 
1643
 
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1687
    _fmt = "Invalid http response for %(path)s: %(msg)s"
1644
1688
 
1645
1689
    def __init__(self, path, msg, orig_error=None):
1646
1690
        self.path = path
1647
 
        if orig_error is None:
1648
 
            orig_error = ''
1649
 
        else:
1650
 
            # This is reached for obscure and unusual errors so we want to
1651
 
            # preserve as much info as possible to ease debug.
1652
 
            orig_error = ': %r' % (orig_error,)
1653
1691
        TransportError.__init__(self, msg, orig_error=orig_error)
1654
1692
 
1655
1693
 
1662
1700
        InvalidHttpResponse.__init__(self, path, msg)
1663
1701
 
1664
1702
 
1665
 
class HttpBoundaryMissing(InvalidHttpResponse):
1666
 
    """A multipart response ends with no boundary marker.
1667
 
 
1668
 
    This is a special case caused by buggy proxies, described in
1669
 
    <https://bugs.launchpad.net/bzr/+bug/198646>.
1670
 
    """
1671
 
 
1672
 
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
1673
 
 
1674
 
    def __init__(self, path, msg):
1675
 
        InvalidHttpResponse.__init__(self, path, msg)
1676
 
 
1677
 
 
1678
1703
class InvalidHttpContentType(InvalidHttpResponse):
1679
1704
 
1680
1705
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1708
1733
    _fmt = "Working tree has conflicts."
1709
1734
 
1710
1735
 
1711
 
class ConfigContentError(BzrError):
1712
 
 
1713
 
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
1714
 
 
1715
 
    def __init__(self, filename):
1716
 
        BzrError.__init__(self)
1717
 
        self.filename = filename
1718
 
 
1719
 
 
1720
1736
class ParseConfigError(BzrError):
1721
1737
 
1722
 
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
1723
 
 
1724
1738
    def __init__(self, errors, filename):
1725
 
        BzrError.__init__(self)
1726
 
        self.filename = filename
1727
 
        self.errors = '\n'.join(e.msg for e in errors)
1728
 
 
1729
 
 
1730
 
class ConfigOptionValueError(BzrError):
1731
 
 
1732
 
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
1733
 
 
1734
 
    def __init__(self, name, value):
1735
 
        BzrError.__init__(self, name=name, value=value)
 
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)
1736
1744
 
1737
1745
 
1738
1746
class NoEmailInUsername(BzrError):
1746
1754
 
1747
1755
class SigningFailed(BzrError):
1748
1756
 
1749
 
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
 
1757
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1750
1758
 
1751
1759
    def __init__(self, command_line):
1752
1760
        BzrError.__init__(self, command_line=command_line)
1753
1761
 
1754
1762
 
1755
 
class SignatureVerificationFailed(BzrError):
1756
 
 
1757
 
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
1758
 
 
1759
 
    def __init__(self, error):
1760
 
        BzrError.__init__(self, error=error)
1761
 
 
1762
 
 
1763
 
class DependencyNotPresent(BzrError):
1764
 
 
1765
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1766
 
 
1767
 
    def __init__(self, library, error):
1768
 
        BzrError.__init__(self, library=library, error=error)
1769
 
 
1770
 
 
1771
 
class GpgmeNotInstalled(DependencyNotPresent):
1772
 
 
1773
 
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
1774
 
 
1775
 
    def __init__(self, error):
1776
 
        DependencyNotPresent.__init__(self, 'gpgme', error)
1777
 
 
1778
 
 
1779
1763
class WorkingTreeNotRevision(BzrError):
1780
1764
 
1781
1765
    _fmt = ("The working tree for %(basedir)s has changed since"
1897
1881
        self.prefix = prefix
1898
1882
 
1899
1883
 
1900
 
class MalformedTransform(InternalBzrError):
 
1884
class MalformedTransform(BzrError):
1901
1885
 
1902
1886
    _fmt = "Tree transform is malformed %(conflicts)r"
1903
1887
 
1941
1925
    _fmt = "Moving the root directory is not supported at this time"
1942
1926
 
1943
1927
 
1944
 
class TransformRenameFailed(BzrError):
1945
 
 
1946
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
1947
 
 
1948
 
    def __init__(self, from_path, to_path, why, errno):
1949
 
        self.from_path = from_path
1950
 
        self.to_path = to_path
1951
 
        self.why = why
1952
 
        self.errno = errno
1953
 
 
1954
 
 
1955
1928
class BzrMoveFailedError(BzrError):
1956
1929
 
1957
 
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
1958
 
        "%(_has_extra)s%(extra)s")
 
1930
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1959
1931
 
1960
1932
    def __init__(self, from_path='', to_path='', extra=None):
1961
1933
        from bzrlib.osutils import splitpath
1962
1934
        BzrError.__init__(self)
1963
1935
        if extra:
1964
 
            self.extra, self._has_extra = extra, ': '
 
1936
            self.extra = ': ' + str(extra)
1965
1937
        else:
1966
 
            self.extra = self._has_extra = ''
 
1938
            self.extra = ''
1967
1939
 
1968
1940
        has_from = len(from_path) > 0
1969
1941
        has_to = len(to_path) > 0
1990
1962
 
1991
1963
class BzrRenameFailedError(BzrMoveFailedError):
1992
1964
 
1993
 
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
1994
 
        "%(_has_extra)s%(extra)s")
 
1965
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
1995
1966
 
1996
1967
    def __init__(self, from_path, to_path, extra=None):
1997
1968
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1998
1969
 
 
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
 
1999
1983
 
2000
1984
class BzrBadParameterNotString(BzrBadParameter):
2001
1985
 
2004
1988
 
2005
1989
class BzrBadParameterMissing(BzrBadParameter):
2006
1990
 
2007
 
    _fmt = "Parameter %(param)s is required but not present."
 
1991
    _fmt = "Parameter $(param)s is required but not present."
2008
1992
 
2009
1993
 
2010
1994
class BzrBadParameterUnicode(BzrBadParameter):
2018
2002
    _fmt = "Parameter %(param)s contains a newline."
2019
2003
 
2020
2004
 
 
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
 
2021
2013
class ParamikoNotPresent(DependencyNotPresent):
2022
2014
 
2023
2015
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2258
2250
    """
2259
2251
 
2260
2252
 
2261
 
class GhostTagsNotSupported(BzrError):
2262
 
 
2263
 
    _fmt = "Ghost tags not supported by format %(format)r."
2264
 
 
2265
 
    def __init__(self, format):
2266
 
        self.format = format
2267
 
 
2268
 
 
2269
2253
class BinaryFile(BzrError):
2270
2254
 
2271
2255
    _fmt = "File is binary but should be text."
2634
2618
 
2635
2619
    This is distinct from ErrorFromSmartServer so that it is possible to
2636
2620
    distinguish between the following two cases:
2637
 
 
2638
 
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
2639
 
      and so should provoke a traceback to the user.
2640
 
    - ErrorFromSmartServer was caught but its error_tuple could not be
2641
 
      translated.  This is probably because the server sent us garbage, and
2642
 
      should not provoke a traceback.
 
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.
2643
2626
    """
2644
2627
 
2645
2628
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2701
2684
    _fmt = "Container has multiple records with the same name: %(name)s"
2702
2685
 
2703
2686
    def __init__(self, name):
2704
 
        self.name = name.decode("utf-8")
 
2687
        self.name = name
2705
2688
 
2706
2689
 
2707
2690
class NoDestinationAddress(InternalBzrError):
2851
2834
        else:
2852
2835
            more = ' ' + more
2853
2836
        import bzrlib.urlutils as urlutils
2854
 
        user_url = getattr(tree, "user_url", None)
2855
 
        if user_url is None:
2856
 
            display_url = str(tree)
2857
 
        else:
2858
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2837
        display_url = urlutils.unescape_for_display(
 
2838
            tree.user_url, 'ascii')
2859
2839
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2860
2840
 
2861
2841
 
2862
 
class ShelvedChanges(UncommittedChanges):
2863
 
 
2864
 
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
2865
 
            ' (See bzr shelve --list).%(more)s')
2866
 
 
2867
 
 
2868
2842
class MissingTemplateVariable(BzrError):
2869
2843
 
2870
2844
    _fmt = 'Variable {%(name)s} is not available.'
2936
2910
        from bzrlib.osutils import get_user_encoding
2937
2911
        self.path = path
2938
2912
        self.kind = kind
2939
 
        self.user_encoding = get_user_encoding()
2940
 
 
2941
 
 
2942
 
class NoSuchConfig(BzrError):
2943
 
 
2944
 
    _fmt = ('The "%(config_id)s" configuration does not exist.')
2945
 
 
2946
 
    def __init__(self, config_id):
2947
 
        BzrError.__init__(self, config_id=config_id)
2948
 
 
2949
 
 
2950
 
class NoSuchConfigOption(BzrError):
2951
 
 
2952
 
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
2953
 
 
2954
 
    def __init__(self, option_name):
2955
 
        BzrError.__init__(self, option_name=option_name)
 
2913
        self.user_encoding = osutils.get_user_encoding()
2956
2914
 
2957
2915
 
2958
2916
class NoSuchAlias(BzrError):
3003
2961
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
3004
2962
 
3005
2963
 
 
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
 
3006
2989
class TipChangeRejected(BzrError):
3007
2990
    """A pre_change_branch_tip hook function may raise this to cleanly and
3008
2991
    explicitly abort a change to a branch tip.
3019
3002
    _fmt = "Shelf corrupt."
3020
3003
 
3021
3004
 
3022
 
class DecompressCorruption(BzrError):
3023
 
 
3024
 
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
3025
 
 
3026
 
    def __init__(self, orig_error=None):
3027
 
        if orig_error is not None:
3028
 
            self.orig_error = ", %s" % (orig_error,)
3029
 
        else:
3030
 
            self.orig_error = ""
3031
 
        BzrError.__init__(self)
3032
 
 
3033
 
 
3034
3005
class NoSuchShelfId(BzrError):
3035
3006
 
3036
3007
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3163
3134
    def __init__(self, bzrdir):
3164
3135
        self.bzrdir = bzrdir
3165
3136
 
3166
 
 
3167
 
class NoWhoami(BzrError):
3168
 
 
3169
 
    _fmt = ('Unable to determine your name.\n'
3170
 
        "Please, set your name with the 'whoami' command.\n"
3171
 
        'E.g. bzr whoami "Your Name <name@example.com>"')
3172
 
 
3173
 
 
3174
 
class InvalidPattern(BzrError):
3175
 
 
3176
 
    _fmt = ('Invalid pattern(s) found. %(msg)s')
3177
 
 
3178
 
    def __init__(self, msg):
3179
 
        self.msg = msg
3180
 
 
3181
 
 
3182
 
class RecursiveBind(BzrError):
3183
 
 
3184
 
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3185
 
        'Please use `bzr unbind` to fix.')
3186
 
 
3187
 
    def __init__(self, branch_url):
3188
 
        self.branch_url = branch_url
3189
 
 
3190
 
 
3191
 
# FIXME: I would prefer to define the config related exception classes in
3192
 
# config.py but the lazy import mechanism proscribes this -- vila 20101222
3193
 
class OptionExpansionLoop(BzrError):
3194
 
 
3195
 
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
3196
 
 
3197
 
    def __init__(self, string, refs):
3198
 
        self.string = string
3199
 
        self.refs = '->'.join(refs)
3200
 
 
3201
 
 
3202
 
class ExpandingUnknownOption(BzrError):
3203
 
 
3204
 
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
3205
 
 
3206
 
    def __init__(self, name, string):
3207
 
        self.name = name
3208
 
        self.string = string
3209
 
 
3210
 
 
3211
 
class NoCompatibleInter(BzrError):
3212
 
 
3213
 
    _fmt = ('No compatible object available for operations from %(source)r '
3214
 
            'to %(target)r.')
3215
 
 
3216
 
    def __init__(self, source, target):
3217
 
        self.source = source
3218
 
        self.target = target
3219
 
 
3220
 
 
3221
 
class HpssVfsRequestNotAllowed(BzrError):
3222
 
 
3223
 
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
3224
 
            "%(method)s, %(arguments)s.")
3225
 
 
3226
 
    def __init__(self, method, arguments):
3227
 
        self.method = method
3228
 
        self.arguments = arguments
3229
 
 
3230
 
 
3231
 
class UnsupportedKindChange(BzrError):
3232
 
 
3233
 
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
3234
 
            "%(path)s not supported by format %(format)r")
3235
 
 
3236
 
    def __init__(self, path, from_kind, to_kind, format):
3237
 
        self.path = path
3238
 
        self.from_kind = from_kind
3239
 
        self.to_kind = to_kind
3240
 
        self.format = format
3241
 
 
3242
 
 
3243
 
class PatchSyntax(BzrError):
3244
 
    """Base class for patch syntax errors."""
3245
 
 
3246
 
 
3247
 
class BinaryFiles(BzrError):
3248
 
 
3249
 
    _fmt = 'Binary files section encountered.'
3250
 
 
3251
 
    def __init__(self, orig_name, mod_name):
3252
 
        self.orig_name = orig_name
3253
 
        self.mod_name = mod_name
3254
 
 
3255
 
 
3256
 
class MalformedPatchHeader(PatchSyntax):
3257
 
 
3258
 
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
3259
 
 
3260
 
    def __init__(self, desc, line):
3261
 
        self.desc = desc
3262
 
        self.line = line
3263
 
 
3264
 
 
3265
 
class MalformedHunkHeader(PatchSyntax):
3266
 
 
3267
 
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
3268
 
 
3269
 
    def __init__(self, desc, line):
3270
 
        self.desc = desc
3271
 
        self.line = line
3272
 
 
3273
 
 
3274
 
class MalformedLine(PatchSyntax):
3275
 
 
3276
 
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
3277
 
 
3278
 
    def __init__(self, desc, line):
3279
 
        self.desc = desc
3280
 
        self.line = line
3281
 
 
3282
 
 
3283
 
class PatchConflict(BzrError):
3284
 
 
3285
 
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
3286
 
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
3287
 
 
3288
 
    def __init__(self, line_no, orig_line, patch_line):
3289
 
        self.line_no = line_no
3290
 
        self.orig_line = orig_line.rstrip('\n')
3291
 
        self.patch_line = patch_line.rstrip('\n')