/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 __future__ import absolute_import
 
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
 
21
32
 
22
33
# TODO: is there any value in providing the .args field used by standard
23
34
# python exceptions?   A list of values with no names seems less useful
43
54
    Base class for errors raised by bzrlib.
44
55
 
45
56
    :cvar internal_error: if True this was probably caused by a bzr bug and
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.)
 
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.)
49
60
 
50
61
    :cvar _fmt: Format string to display the error; this is expanded
51
 
        by the instance's dict.
 
62
    by the instance's dict.
52
63
    """
53
64
 
54
65
    internal_error = False
95
106
                # __str__() should always return a 'str' object
96
107
                # never a 'unicode' object.
97
108
                return s
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)
 
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)
107
115
 
108
116
    def __unicode__(self):
109
117
        u = self._format()
132
140
        """Return format string for this exception or None"""
133
141
        fmt = getattr(self, '_fmt', None)
134
142
        if fmt is not None:
135
 
            from bzrlib.i18n import gettext
136
 
            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
               )
137
155
 
138
156
    def __eq__(self, other):
139
157
        if self.__class__ is not other.__class__:
152
170
    internal_error = True
153
171
 
154
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
 
155
206
class AlreadyBuilding(BzrError):
156
207
 
157
208
    _fmt = "The tree builder is already building a tree."
253
304
class RootMissing(InternalBzrError):
254
305
 
255
306
    _fmt = ("The root entry of a tree must be the first entry supplied to "
256
 
        "the commit builder.")
 
307
        "record_entry_contents.")
257
308
 
258
309
 
259
310
class NoPublicBranch(BzrError):
570
621
 
571
622
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
572
623
 
573
 
    def __init__(self, url, extra=""):
 
624
    def __init__(self, url, extra):
574
625
        PathError.__init__(self, url, extra=extra)
575
626
 
576
627
 
629
680
 
630
681
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
631
682
 
632
 
    internal_error = False
 
683
    internal_error = True
633
684
 
634
685
    def __init__(self, path, base, extra=None):
635
686
        BzrError.__init__(self)
662
713
       self.bzrdir = bzrdir
663
714
       PathError.__init__(self, path=path)
664
715
 
665
 
    def __repr__(self):
666
 
        return '<%s %r>' % (self.__class__.__name__, self.__dict__)
667
 
 
668
716
    def _format(self):
669
717
        # XXX: Ideally self.detail would be a property, but Exceptions in
670
718
        # Python 2.4 have to be old-style classes so properties don't work.
675
723
                    self.bzrdir.open_repository()
676
724
                except NoRepositoryPresent:
677
725
                    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
726
                else:
688
727
                    self.detail = ': location is a repository'
689
728
            else:
739
778
        self.path = bzrdir.transport.clone('..').base
740
779
 
741
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
 
742
792
class UnsupportedFormatError(BzrError):
743
793
 
744
794
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
763
813
        self.bzrdir = bzrdir_format
764
814
 
765
815
 
766
 
class ParseFormatError(BzrError):
767
 
 
768
 
    _fmt = "Parse error on line %(lineno)d of %(format)s format: %(line)s"
769
 
 
770
 
    def __init__(self, format, lineno, line, text):
771
 
        BzrError.__init__(self)
772
 
        self.format = format
773
 
        self.lineno = lineno
774
 
        self.line = line
775
 
        self.text = text
776
 
 
777
 
 
778
816
class IncompatibleRepositories(BzrError):
779
817
    """Report an error that two repositories are not compatible.
780
818
 
812
850
        """Construct a new AlreadyVersionedError.
813
851
 
814
852
        :param path: This is the path which is versioned,
815
 
            which should be in a user friendly form.
 
853
        which should be in a user friendly form.
816
854
        :param context_info: If given, this is information about the context,
817
 
            which could explain why this is expected to not be versioned.
 
855
        which could explain why this is expected to not be versioned.
818
856
        """
819
857
        BzrError.__init__(self)
820
858
        self.path = path
833
871
        """Construct a new NotVersionedError.
834
872
 
835
873
        :param path: This is the path which is not versioned,
836
 
            which should be in a user friendly form.
 
874
        which should be in a user friendly form.
837
875
        :param context_info: If given, this is information about the context,
838
 
            which could explain why this is expected to be versioned.
 
876
        which could explain why this is expected to be versioned.
839
877
        """
840
878
        BzrError.__init__(self)
841
879
        self.path = path
909
947
    # original exception is available as e.original_error
910
948
    #
911
949
    # New code should prefer to raise specific subclasses
912
 
    def __init__(self, msg):
913
 
        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
914
955
 
915
956
 
916
957
class LockActive(LockError):
1000
1041
class LockContention(LockError):
1001
1042
 
1002
1043
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
1044
    # TODO: show full url for lock, combining the transport and relative
 
1045
    # bits?
1003
1046
 
1004
1047
    internal_error = False
1005
1048
 
1032
1075
        self.target = target
1033
1076
 
1034
1077
 
1035
 
class LockCorrupt(LockError):
1036
 
 
1037
 
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
1038
 
            "Use 'bzr break-lock' to clear it")
1039
 
 
1040
 
    internal_error = False
1041
 
 
1042
 
    def __init__(self, corruption_info, file_data=None):
1043
 
        self.corruption_info = corruption_info
1044
 
        self.file_data = file_data
1045
 
 
1046
 
 
1047
1078
class LockNotHeld(LockError):
1048
1079
 
1049
1080
    _fmt = "Lock not held: %(lock)s"
1088
1119
        BzrError.__init__(self, files=files, files_str=files_str)
1089
1120
 
1090
1121
 
1091
 
class ExcludesUnsupported(BzrError):
1092
 
 
1093
 
    _fmt = ('Excluding paths during commit is not supported by '
1094
 
            'repository at %(repository)r.')
1095
 
 
1096
 
    def __init__(self, repository):
1097
 
        BzrError.__init__(self, repository=repository)
1098
 
 
1099
 
 
1100
1122
class BadCommitMessageEncoding(BzrError):
1101
1123
 
1102
1124
    _fmt = 'The specified commit message contains characters unsupported by '\
1158
1180
class InvalidRevisionSpec(BzrError):
1159
1181
 
1160
1182
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1161
 
            " %(branch_url)s%(extra)s")
 
1183
            " %(branch)s%(extra)s")
1162
1184
 
1163
1185
    def __init__(self, spec, branch, extra=None):
1164
1186
        BzrError.__init__(self, branch=branch, spec=spec)
1165
 
        self.branch_url = getattr(branch, 'user_url', str(branch))
1166
1187
        if extra:
1167
1188
            self.extra = '\n' + str(extra)
1168
1189
        else:
1169
1190
            self.extra = ''
1170
1191
 
1171
1192
 
 
1193
class HistoryMissing(BzrError):
 
1194
 
 
1195
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
1196
 
 
1197
 
1172
1198
class AppendRevisionsOnlyViolation(BzrError):
1173
1199
 
1174
1200
    _fmt = ('Operation denied because it would change the main history,'
1239
1265
            not_ancestor_id=not_ancestor_id)
1240
1266
 
1241
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
 
1242
1279
class NoCommits(BranchError):
1243
1280
 
1244
1281
    _fmt = "Branch %(branch)s has no commits."
1343
1380
 
1344
1381
class WeaveParentMismatch(WeaveError):
1345
1382
 
1346
 
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
 
1383
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1347
1384
 
1348
1385
 
1349
1386
class WeaveInvalidChecksum(WeaveError):
1350
1387
 
1351
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1388
    _fmt = "Text did not match it's checksum: %(message)s"
1352
1389
 
1353
1390
 
1354
1391
class WeaveTextDiffers(WeaveError):
1402
1439
 
1403
1440
class VersionedFileInvalidChecksum(VersionedFileError):
1404
1441
 
1405
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1442
    _fmt = "Text did not match its checksum: %(message)s"
1406
1443
 
1407
1444
 
1408
1445
class KnitError(InternalBzrError):
1504
1541
            problem we can raise the original error (value from sys.exc_info())
1505
1542
        """
1506
1543
        BzrError.__init__(self)
1507
 
        self.context = context
1508
1544
        self.reload_occurred = reload_occurred
1509
1545
        self.exc_info = exc_info
1510
1546
        self.orig_error = exc_info[1]
1592
1628
 
1593
1629
    def __init__(self, exc_info):
1594
1630
        import traceback
1595
 
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1596
1631
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1597
1632
        self.exc_info = exc_info
1598
1633
        traceback_strings = traceback.format_exception(
1637
1672
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1638
1673
 
1639
1674
 
1640
 
class ConnectionTimeout(ConnectionError):
1641
 
 
1642
 
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
1643
 
 
1644
 
 
1645
1675
class InvalidRange(TransportError):
1646
1676
 
1647
1677
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1654
1684
 
1655
1685
class InvalidHttpResponse(TransportError):
1656
1686
 
1657
 
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1687
    _fmt = "Invalid http response for %(path)s: %(msg)s"
1658
1688
 
1659
1689
    def __init__(self, path, msg, orig_error=None):
1660
1690
        self.path = path
1661
 
        if orig_error is None:
1662
 
            orig_error = ''
1663
 
        else:
1664
 
            # This is reached for obscure and unusual errors so we want to
1665
 
            # preserve as much info as possible to ease debug.
1666
 
            orig_error = ': %r' % (orig_error,)
1667
1691
        TransportError.__init__(self, msg, orig_error=orig_error)
1668
1692
 
1669
1693
 
1676
1700
        InvalidHttpResponse.__init__(self, path, msg)
1677
1701
 
1678
1702
 
1679
 
class HttpBoundaryMissing(InvalidHttpResponse):
1680
 
    """A multipart response ends with no boundary marker.
1681
 
 
1682
 
    This is a special case caused by buggy proxies, described in
1683
 
    <https://bugs.launchpad.net/bzr/+bug/198646>.
1684
 
    """
1685
 
 
1686
 
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
1687
 
 
1688
 
    def __init__(self, path, msg):
1689
 
        InvalidHttpResponse.__init__(self, path, msg)
1690
 
 
1691
 
 
1692
1703
class InvalidHttpContentType(InvalidHttpResponse):
1693
1704
 
1694
1705
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1722
1733
    _fmt = "Working tree has conflicts."
1723
1734
 
1724
1735
 
1725
 
class ConfigContentError(BzrError):
1726
 
 
1727
 
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
1728
 
 
1729
 
    def __init__(self, filename):
1730
 
        BzrError.__init__(self)
1731
 
        self.filename = filename
1732
 
 
1733
 
 
1734
1736
class ParseConfigError(BzrError):
1735
1737
 
1736
 
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
1737
 
 
1738
1738
    def __init__(self, errors, filename):
1739
 
        BzrError.__init__(self)
1740
 
        self.filename = filename
1741
 
        self.errors = '\n'.join(e.msg for e in errors)
1742
 
 
1743
 
 
1744
 
class ConfigOptionValueError(BzrError):
1745
 
 
1746
 
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
1747
 
 
1748
 
    def __init__(self, name, value):
1749
 
        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)
1750
1744
 
1751
1745
 
1752
1746
class NoEmailInUsername(BzrError):
1760
1754
 
1761
1755
class SigningFailed(BzrError):
1762
1756
 
1763
 
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
 
1757
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1764
1758
 
1765
1759
    def __init__(self, command_line):
1766
1760
        BzrError.__init__(self, command_line=command_line)
1767
1761
 
1768
1762
 
1769
 
class SignatureVerificationFailed(BzrError):
1770
 
 
1771
 
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
1772
 
 
1773
 
    def __init__(self, error):
1774
 
        BzrError.__init__(self, error=error)
1775
 
 
1776
 
 
1777
 
class DependencyNotPresent(BzrError):
1778
 
 
1779
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1780
 
 
1781
 
    def __init__(self, library, error):
1782
 
        BzrError.__init__(self, library=library, error=error)
1783
 
 
1784
 
 
1785
 
class GpgmeNotInstalled(DependencyNotPresent):
1786
 
 
1787
 
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
1788
 
 
1789
 
    def __init__(self, error):
1790
 
        DependencyNotPresent.__init__(self, 'gpgme', error)
1791
 
 
1792
 
 
1793
1763
class WorkingTreeNotRevision(BzrError):
1794
1764
 
1795
1765
    _fmt = ("The working tree for %(basedir)s has changed since"
1911
1881
        self.prefix = prefix
1912
1882
 
1913
1883
 
1914
 
class MalformedTransform(InternalBzrError):
 
1884
class MalformedTransform(BzrError):
1915
1885
 
1916
1886
    _fmt = "Tree transform is malformed %(conflicts)r"
1917
1887
 
1955
1925
    _fmt = "Moving the root directory is not supported at this time"
1956
1926
 
1957
1927
 
1958
 
class TransformRenameFailed(BzrError):
1959
 
 
1960
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
1961
 
 
1962
 
    def __init__(self, from_path, to_path, why, errno):
1963
 
        self.from_path = from_path
1964
 
        self.to_path = to_path
1965
 
        self.why = why
1966
 
        self.errno = errno
1967
 
 
1968
 
 
1969
1928
class BzrMoveFailedError(BzrError):
1970
1929
 
1971
 
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
1972
 
        "%(_has_extra)s%(extra)s")
 
1930
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1973
1931
 
1974
1932
    def __init__(self, from_path='', to_path='', extra=None):
1975
1933
        from bzrlib.osutils import splitpath
1976
1934
        BzrError.__init__(self)
1977
1935
        if extra:
1978
 
            self.extra, self._has_extra = extra, ': '
 
1936
            self.extra = ': ' + str(extra)
1979
1937
        else:
1980
 
            self.extra = self._has_extra = ''
 
1938
            self.extra = ''
1981
1939
 
1982
1940
        has_from = len(from_path) > 0
1983
1941
        has_to = len(to_path) > 0
2004
1962
 
2005
1963
class BzrRenameFailedError(BzrMoveFailedError):
2006
1964
 
2007
 
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
2008
 
        "%(_has_extra)s%(extra)s")
 
1965
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
2009
1966
 
2010
1967
    def __init__(self, from_path, to_path, extra=None):
2011
1968
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2012
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
 
2013
1983
 
2014
1984
class BzrBadParameterNotString(BzrBadParameter):
2015
1985
 
2018
1988
 
2019
1989
class BzrBadParameterMissing(BzrBadParameter):
2020
1990
 
2021
 
    _fmt = "Parameter %(param)s is required but not present."
 
1991
    _fmt = "Parameter $(param)s is required but not present."
2022
1992
 
2023
1993
 
2024
1994
class BzrBadParameterUnicode(BzrBadParameter):
2032
2002
    _fmt = "Parameter %(param)s contains a newline."
2033
2003
 
2034
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
 
2035
2013
class ParamikoNotPresent(DependencyNotPresent):
2036
2014
 
2037
2015
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2272
2250
    """
2273
2251
 
2274
2252
 
2275
 
class GhostTagsNotSupported(BzrError):
2276
 
 
2277
 
    _fmt = "Ghost tags not supported by format %(format)r."
2278
 
 
2279
 
    def __init__(self, format):
2280
 
        self.format = format
2281
 
 
2282
 
 
2283
2253
class BinaryFile(BzrError):
2284
2254
 
2285
2255
    _fmt = "File is binary but should be text."
2648
2618
 
2649
2619
    This is distinct from ErrorFromSmartServer so that it is possible to
2650
2620
    distinguish between the following two cases:
2651
 
 
2652
 
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
2653
 
      and so should provoke a traceback to the user.
2654
 
    - ErrorFromSmartServer was caught but its error_tuple could not be
2655
 
      translated.  This is probably because the server sent us garbage, and
2656
 
      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.
2657
2626
    """
2658
2627
 
2659
2628
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2715
2684
    _fmt = "Container has multiple records with the same name: %(name)s"
2716
2685
 
2717
2686
    def __init__(self, name):
2718
 
        self.name = name.decode("utf-8")
 
2687
        self.name = name
2719
2688
 
2720
2689
 
2721
2690
class NoDestinationAddress(InternalBzrError):
2865
2834
        else:
2866
2835
            more = ' ' + more
2867
2836
        import bzrlib.urlutils as urlutils
2868
 
        user_url = getattr(tree, "user_url", None)
2869
 
        if user_url is None:
2870
 
            display_url = str(tree)
2871
 
        else:
2872
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2837
        display_url = urlutils.unescape_for_display(
 
2838
            tree.user_url, 'ascii')
2873
2839
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2874
2840
 
2875
2841
 
2876
 
class ShelvedChanges(UncommittedChanges):
2877
 
 
2878
 
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
2879
 
            ' (See bzr shelve --list).%(more)s')
2880
 
 
2881
 
 
2882
2842
class MissingTemplateVariable(BzrError):
2883
2843
 
2884
2844
    _fmt = 'Variable {%(name)s} is not available.'
2950
2910
        from bzrlib.osutils import get_user_encoding
2951
2911
        self.path = path
2952
2912
        self.kind = kind
2953
 
        self.user_encoding = get_user_encoding()
2954
 
 
2955
 
 
2956
 
class NoSuchConfig(BzrError):
2957
 
 
2958
 
    _fmt = ('The "%(config_id)s" configuration does not exist.')
2959
 
 
2960
 
    def __init__(self, config_id):
2961
 
        BzrError.__init__(self, config_id=config_id)
2962
 
 
2963
 
 
2964
 
class NoSuchConfigOption(BzrError):
2965
 
 
2966
 
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
2967
 
 
2968
 
    def __init__(self, option_name):
2969
 
        BzrError.__init__(self, option_name=option_name)
 
2913
        self.user_encoding = osutils.get_user_encoding()
2970
2914
 
2971
2915
 
2972
2916
class NoSuchAlias(BzrError):
3017
2961
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
3018
2962
 
3019
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
 
3020
2989
class TipChangeRejected(BzrError):
3021
2990
    """A pre_change_branch_tip hook function may raise this to cleanly and
3022
2991
    explicitly abort a change to a branch tip.
3033
3002
    _fmt = "Shelf corrupt."
3034
3003
 
3035
3004
 
3036
 
class DecompressCorruption(BzrError):
3037
 
 
3038
 
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
3039
 
 
3040
 
    def __init__(self, orig_error=None):
3041
 
        if orig_error is not None:
3042
 
            self.orig_error = ", %s" % (orig_error,)
3043
 
        else:
3044
 
            self.orig_error = ""
3045
 
        BzrError.__init__(self)
3046
 
 
3047
 
 
3048
3005
class NoSuchShelfId(BzrError):
3049
3006
 
3050
3007
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3177
3134
    def __init__(self, bzrdir):
3178
3135
        self.bzrdir = bzrdir
3179
3136
 
3180
 
 
3181
 
class NoWhoami(BzrError):
3182
 
 
3183
 
    _fmt = ('Unable to determine your name.\n'
3184
 
        "Please, set your name with the 'whoami' command.\n"
3185
 
        'E.g. bzr whoami "Your Name <name@example.com>"')
3186
 
 
3187
 
 
3188
 
class InvalidPattern(BzrError):
3189
 
 
3190
 
    _fmt = ('Invalid pattern(s) found. %(msg)s')
3191
 
 
3192
 
    def __init__(self, msg):
3193
 
        self.msg = msg
3194
 
 
3195
 
 
3196
 
class RecursiveBind(BzrError):
3197
 
 
3198
 
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3199
 
        'Please use `bzr unbind` to fix.')
3200
 
 
3201
 
    def __init__(self, branch_url):
3202
 
        self.branch_url = branch_url
3203
 
 
3204
 
 
3205
 
# FIXME: I would prefer to define the config related exception classes in
3206
 
# config.py but the lazy import mechanism proscribes this -- vila 20101222
3207
 
class OptionExpansionLoop(BzrError):
3208
 
 
3209
 
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
3210
 
 
3211
 
    def __init__(self, string, refs):
3212
 
        self.string = string
3213
 
        self.refs = '->'.join(refs)
3214
 
 
3215
 
 
3216
 
class ExpandingUnknownOption(BzrError):
3217
 
 
3218
 
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
3219
 
 
3220
 
    def __init__(self, name, string):
3221
 
        self.name = name
3222
 
        self.string = string
3223
 
 
3224
 
 
3225
 
class NoCompatibleInter(BzrError):
3226
 
 
3227
 
    _fmt = ('No compatible object available for operations from %(source)r '
3228
 
            'to %(target)r.')
3229
 
 
3230
 
    def __init__(self, source, target):
3231
 
        self.source = source
3232
 
        self.target = target
3233
 
 
3234
 
 
3235
 
class HpssVfsRequestNotAllowed(BzrError):
3236
 
 
3237
 
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
3238
 
            "%(method)s, %(arguments)s.")
3239
 
 
3240
 
    def __init__(self, method, arguments):
3241
 
        self.method = method
3242
 
        self.arguments = arguments
3243
 
 
3244
 
 
3245
 
class UnsupportedKindChange(BzrError):
3246
 
 
3247
 
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
3248
 
            "%(path)s not supported by format %(format)r")
3249
 
 
3250
 
    def __init__(self, path, from_kind, to_kind, format):
3251
 
        self.path = path
3252
 
        self.from_kind = from_kind
3253
 
        self.to_kind = to_kind
3254
 
        self.format = format
3255
 
 
3256
 
 
3257
 
class MissingFeature(BzrError):
3258
 
 
3259
 
    _fmt = ("Missing feature %(feature)s not provided by this "
3260
 
            "version of Bazaar or any plugin.")
3261
 
 
3262
 
    def __init__(self, feature):
3263
 
        self.feature = feature
3264
 
 
3265
 
 
3266
 
class PatchSyntax(BzrError):
3267
 
    """Base class for patch syntax errors."""
3268
 
 
3269
 
 
3270
 
class BinaryFiles(BzrError):
3271
 
 
3272
 
    _fmt = 'Binary files section encountered.'
3273
 
 
3274
 
    def __init__(self, orig_name, mod_name):
3275
 
        self.orig_name = orig_name
3276
 
        self.mod_name = mod_name
3277
 
 
3278
 
 
3279
 
class MalformedPatchHeader(PatchSyntax):
3280
 
 
3281
 
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
3282
 
 
3283
 
    def __init__(self, desc, line):
3284
 
        self.desc = desc
3285
 
        self.line = line
3286
 
 
3287
 
 
3288
 
class MalformedHunkHeader(PatchSyntax):
3289
 
 
3290
 
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
3291
 
 
3292
 
    def __init__(self, desc, line):
3293
 
        self.desc = desc
3294
 
        self.line = line
3295
 
 
3296
 
 
3297
 
class MalformedLine(PatchSyntax):
3298
 
 
3299
 
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
3300
 
 
3301
 
    def __init__(self, desc, line):
3302
 
        self.desc = desc
3303
 
        self.line = line
3304
 
 
3305
 
 
3306
 
class PatchConflict(BzrError):
3307
 
 
3308
 
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
3309
 
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
3310
 
 
3311
 
    def __init__(self, line_no, orig_line, patch_line):
3312
 
        self.line_no = line_no
3313
 
        self.orig_line = orig_line.rstrip('\n')
3314
 
        self.patch_line = patch_line.rstrip('\n')
3315
 
 
3316
 
 
3317
 
class FeatureAlreadyRegistered(BzrError):
3318
 
 
3319
 
    _fmt = 'The feature %(feature)s has already been registered.'
3320
 
 
3321
 
    def __init__(self, feature):
3322
 
        self.feature = feature