/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:
700
739
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
701
740
 
702
741
 
703
 
class AlreadyControlDirError(PathError):
704
 
 
705
 
    _fmt = 'A control directory already exists: "%(path)s".'
706
 
 
707
 
 
708
742
class AlreadyBranchError(PathError):
709
743
 
710
744
    _fmt = 'Already a branch: "%(path)s".'
711
745
 
712
746
 
713
 
class ParentBranchExists(AlreadyBranchError):
714
 
 
715
 
    _fmt = 'Parent branch already exists: "%(path)s".'
716
 
 
717
 
 
718
747
class BranchExistsWithoutWorkingTree(PathError):
719
748
 
720
749
    _fmt = 'Directory contains a branch, but no working tree \
749
778
        self.path = bzrdir.transport.clone('..').base
750
779
 
751
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
 
752
792
class UnsupportedFormatError(BzrError):
753
793
 
754
794
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
773
813
        self.bzrdir = bzrdir_format
774
814
 
775
815
 
776
 
class ParseFormatError(BzrError):
777
 
 
778
 
    _fmt = "Parse error on line %(lineno)d of %(format)s format: %(line)s"
779
 
 
780
 
    def __init__(self, format, lineno, line, text):
781
 
        BzrError.__init__(self)
782
 
        self.format = format
783
 
        self.lineno = lineno
784
 
        self.line = line
785
 
        self.text = text
786
 
 
787
 
 
788
816
class IncompatibleRepositories(BzrError):
789
817
    """Report an error that two repositories are not compatible.
790
818
 
822
850
        """Construct a new AlreadyVersionedError.
823
851
 
824
852
        :param path: This is the path which is versioned,
825
 
            which should be in a user friendly form.
 
853
        which should be in a user friendly form.
826
854
        :param context_info: If given, this is information about the context,
827
 
            which could explain why this is expected to not be versioned.
 
855
        which could explain why this is expected to not be versioned.
828
856
        """
829
857
        BzrError.__init__(self)
830
858
        self.path = path
843
871
        """Construct a new NotVersionedError.
844
872
 
845
873
        :param path: This is the path which is not versioned,
846
 
            which should be in a user friendly form.
 
874
        which should be in a user friendly form.
847
875
        :param context_info: If given, this is information about the context,
848
 
            which could explain why this is expected to be versioned.
 
876
        which could explain why this is expected to be versioned.
849
877
        """
850
878
        BzrError.__init__(self)
851
879
        self.path = path
919
947
    # original exception is available as e.original_error
920
948
    #
921
949
    # New code should prefer to raise specific subclasses
922
 
    def __init__(self, msg):
923
 
        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
924
955
 
925
956
 
926
957
class LockActive(LockError):
1010
1041
class LockContention(LockError):
1011
1042
 
1012
1043
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
1044
    # TODO: show full url for lock, combining the transport and relative
 
1045
    # bits?
1013
1046
 
1014
1047
    internal_error = False
1015
1048
 
1042
1075
        self.target = target
1043
1076
 
1044
1077
 
1045
 
class LockCorrupt(LockError):
1046
 
 
1047
 
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
1048
 
            "Use 'bzr break-lock' to clear it")
1049
 
 
1050
 
    internal_error = False
1051
 
 
1052
 
    def __init__(self, corruption_info, file_data=None):
1053
 
        self.corruption_info = corruption_info
1054
 
        self.file_data = file_data
1055
 
 
1056
 
 
1057
1078
class LockNotHeld(LockError):
1058
1079
 
1059
1080
    _fmt = "Lock not held: %(lock)s"
1098
1119
        BzrError.__init__(self, files=files, files_str=files_str)
1099
1120
 
1100
1121
 
1101
 
class ExcludesUnsupported(BzrError):
1102
 
 
1103
 
    _fmt = ('Excluding paths during commit is not supported by '
1104
 
            'repository at %(repository)r.')
1105
 
 
1106
 
    def __init__(self, repository):
1107
 
        BzrError.__init__(self, repository=repository)
1108
 
 
1109
 
 
1110
1122
class BadCommitMessageEncoding(BzrError):
1111
1123
 
1112
1124
    _fmt = 'The specified commit message contains characters unsupported by '\
1168
1180
class InvalidRevisionSpec(BzrError):
1169
1181
 
1170
1182
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1171
 
            " %(branch_url)s%(extra)s")
 
1183
            " %(branch)s%(extra)s")
1172
1184
 
1173
1185
    def __init__(self, spec, branch, extra=None):
1174
1186
        BzrError.__init__(self, branch=branch, spec=spec)
1175
 
        self.branch_url = getattr(branch, 'user_url', str(branch))
1176
1187
        if extra:
1177
1188
            self.extra = '\n' + str(extra)
1178
1189
        else:
1179
1190
            self.extra = ''
1180
1191
 
1181
1192
 
 
1193
class HistoryMissing(BzrError):
 
1194
 
 
1195
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
1196
 
 
1197
 
1182
1198
class AppendRevisionsOnlyViolation(BzrError):
1183
1199
 
1184
1200
    _fmt = ('Operation denied because it would change the main history,'
1249
1265
            not_ancestor_id=not_ancestor_id)
1250
1266
 
1251
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
 
1252
1279
class NoCommits(BranchError):
1253
1280
 
1254
1281
    _fmt = "Branch %(branch)s has no commits."
1353
1380
 
1354
1381
class WeaveParentMismatch(WeaveError):
1355
1382
 
1356
 
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
 
1383
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1357
1384
 
1358
1385
 
1359
1386
class WeaveInvalidChecksum(WeaveError):
1360
1387
 
1361
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1388
    _fmt = "Text did not match it's checksum: %(message)s"
1362
1389
 
1363
1390
 
1364
1391
class WeaveTextDiffers(WeaveError):
1412
1439
 
1413
1440
class VersionedFileInvalidChecksum(VersionedFileError):
1414
1441
 
1415
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1442
    _fmt = "Text did not match its checksum: %(message)s"
1416
1443
 
1417
1444
 
1418
1445
class KnitError(InternalBzrError):
1514
1541
            problem we can raise the original error (value from sys.exc_info())
1515
1542
        """
1516
1543
        BzrError.__init__(self)
1517
 
        self.context = context
1518
1544
        self.reload_occurred = reload_occurred
1519
1545
        self.exc_info = exc_info
1520
1546
        self.orig_error = exc_info[1]
1602
1628
 
1603
1629
    def __init__(self, exc_info):
1604
1630
        import traceback
1605
 
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1606
1631
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1607
1632
        self.exc_info = exc_info
1608
1633
        traceback_strings = traceback.format_exception(
1647
1672
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1648
1673
 
1649
1674
 
1650
 
class ConnectionTimeout(ConnectionError):
1651
 
 
1652
 
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
1653
 
 
1654
 
 
1655
1675
class InvalidRange(TransportError):
1656
1676
 
1657
1677
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1664
1684
 
1665
1685
class InvalidHttpResponse(TransportError):
1666
1686
 
1667
 
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1687
    _fmt = "Invalid http response for %(path)s: %(msg)s"
1668
1688
 
1669
1689
    def __init__(self, path, msg, orig_error=None):
1670
1690
        self.path = path
1671
 
        if orig_error is None:
1672
 
            orig_error = ''
1673
 
        else:
1674
 
            # This is reached for obscure and unusual errors so we want to
1675
 
            # preserve as much info as possible to ease debug.
1676
 
            orig_error = ': %r' % (orig_error,)
1677
1691
        TransportError.__init__(self, msg, orig_error=orig_error)
1678
1692
 
1679
1693
 
1680
 
class CertificateError(TransportError):
1681
 
 
1682
 
    _fmt = "Certificate error: %(error)s"
1683
 
 
1684
 
    def __init__(self, error):
1685
 
        self.error = error
1686
 
 
1687
 
 
1688
1694
class InvalidHttpRange(InvalidHttpResponse):
1689
1695
 
1690
1696
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1694
1700
        InvalidHttpResponse.__init__(self, path, msg)
1695
1701
 
1696
1702
 
1697
 
class HttpBoundaryMissing(InvalidHttpResponse):
1698
 
    """A multipart response ends with no boundary marker.
1699
 
 
1700
 
    This is a special case caused by buggy proxies, described in
1701
 
    <https://bugs.launchpad.net/bzr/+bug/198646>.
1702
 
    """
1703
 
 
1704
 
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
1705
 
 
1706
 
    def __init__(self, path, msg):
1707
 
        InvalidHttpResponse.__init__(self, path, msg)
1708
 
 
1709
 
 
1710
1703
class InvalidHttpContentType(InvalidHttpResponse):
1711
1704
 
1712
1705
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1740
1733
    _fmt = "Working tree has conflicts."
1741
1734
 
1742
1735
 
1743
 
class ConfigContentError(BzrError):
1744
 
 
1745
 
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
1746
 
 
1747
 
    def __init__(self, filename):
1748
 
        BzrError.__init__(self)
1749
 
        self.filename = filename
1750
 
 
1751
 
 
1752
1736
class ParseConfigError(BzrError):
1753
1737
 
1754
 
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
1755
 
 
1756
1738
    def __init__(self, errors, filename):
1757
 
        BzrError.__init__(self)
1758
 
        self.filename = filename
1759
 
        self.errors = '\n'.join(e.msg for e in errors)
1760
 
 
1761
 
 
1762
 
class ConfigOptionValueError(BzrError):
1763
 
 
1764
 
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
1765
 
 
1766
 
    def __init__(self, name, value):
1767
 
        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)
1768
1744
 
1769
1745
 
1770
1746
class NoEmailInUsername(BzrError):
1778
1754
 
1779
1755
class SigningFailed(BzrError):
1780
1756
 
1781
 
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
 
1757
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1782
1758
 
1783
1759
    def __init__(self, command_line):
1784
1760
        BzrError.__init__(self, command_line=command_line)
1785
1761
 
1786
1762
 
1787
 
class SignatureVerificationFailed(BzrError):
1788
 
 
1789
 
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
1790
 
 
1791
 
    def __init__(self, error):
1792
 
        BzrError.__init__(self, error=error)
1793
 
 
1794
 
 
1795
 
class DependencyNotPresent(BzrError):
1796
 
 
1797
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1798
 
 
1799
 
    def __init__(self, library, error):
1800
 
        BzrError.__init__(self, library=library, error=error)
1801
 
 
1802
 
 
1803
 
class GpgmeNotInstalled(DependencyNotPresent):
1804
 
 
1805
 
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
1806
 
 
1807
 
    def __init__(self, error):
1808
 
        DependencyNotPresent.__init__(self, 'gpgme', error)
1809
 
 
1810
 
 
1811
1763
class WorkingTreeNotRevision(BzrError):
1812
1764
 
1813
1765
    _fmt = ("The working tree for %(basedir)s has changed since"
1929
1881
        self.prefix = prefix
1930
1882
 
1931
1883
 
1932
 
class MalformedTransform(InternalBzrError):
 
1884
class MalformedTransform(BzrError):
1933
1885
 
1934
1886
    _fmt = "Tree transform is malformed %(conflicts)r"
1935
1887
 
1973
1925
    _fmt = "Moving the root directory is not supported at this time"
1974
1926
 
1975
1927
 
1976
 
class TransformRenameFailed(BzrError):
1977
 
 
1978
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
1979
 
 
1980
 
    def __init__(self, from_path, to_path, why, errno):
1981
 
        self.from_path = from_path
1982
 
        self.to_path = to_path
1983
 
        self.why = why
1984
 
        self.errno = errno
1985
 
 
1986
 
 
1987
1928
class BzrMoveFailedError(BzrError):
1988
1929
 
1989
 
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
1990
 
        "%(_has_extra)s%(extra)s")
 
1930
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1991
1931
 
1992
1932
    def __init__(self, from_path='', to_path='', extra=None):
1993
1933
        from bzrlib.osutils import splitpath
1994
1934
        BzrError.__init__(self)
1995
1935
        if extra:
1996
 
            self.extra, self._has_extra = extra, ': '
 
1936
            self.extra = ': ' + str(extra)
1997
1937
        else:
1998
 
            self.extra = self._has_extra = ''
 
1938
            self.extra = ''
1999
1939
 
2000
1940
        has_from = len(from_path) > 0
2001
1941
        has_to = len(to_path) > 0
2022
1962
 
2023
1963
class BzrRenameFailedError(BzrMoveFailedError):
2024
1964
 
2025
 
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
2026
 
        "%(_has_extra)s%(extra)s")
 
1965
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
2027
1966
 
2028
1967
    def __init__(self, from_path, to_path, extra=None):
2029
1968
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2030
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
 
2031
1983
 
2032
1984
class BzrBadParameterNotString(BzrBadParameter):
2033
1985
 
2036
1988
 
2037
1989
class BzrBadParameterMissing(BzrBadParameter):
2038
1990
 
2039
 
    _fmt = "Parameter %(param)s is required but not present."
 
1991
    _fmt = "Parameter $(param)s is required but not present."
2040
1992
 
2041
1993
 
2042
1994
class BzrBadParameterUnicode(BzrBadParameter):
2050
2002
    _fmt = "Parameter %(param)s contains a newline."
2051
2003
 
2052
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
 
2053
2013
class ParamikoNotPresent(DependencyNotPresent):
2054
2014
 
2055
2015
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2290
2250
    """
2291
2251
 
2292
2252
 
2293
 
class GhostTagsNotSupported(BzrError):
2294
 
 
2295
 
    _fmt = "Ghost tags not supported by format %(format)r."
2296
 
 
2297
 
    def __init__(self, format):
2298
 
        self.format = format
2299
 
 
2300
 
 
2301
2253
class BinaryFile(BzrError):
2302
2254
 
2303
2255
    _fmt = "File is binary but should be text."
2666
2618
 
2667
2619
    This is distinct from ErrorFromSmartServer so that it is possible to
2668
2620
    distinguish between the following two cases:
2669
 
 
2670
 
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
2671
 
      and so should provoke a traceback to the user.
2672
 
    - ErrorFromSmartServer was caught but its error_tuple could not be
2673
 
      translated.  This is probably because the server sent us garbage, and
2674
 
      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.
2675
2626
    """
2676
2627
 
2677
2628
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2733
2684
    _fmt = "Container has multiple records with the same name: %(name)s"
2734
2685
 
2735
2686
    def __init__(self, name):
2736
 
        self.name = name.decode("utf-8")
 
2687
        self.name = name
2737
2688
 
2738
2689
 
2739
2690
class NoDestinationAddress(InternalBzrError):
2883
2834
        else:
2884
2835
            more = ' ' + more
2885
2836
        import bzrlib.urlutils as urlutils
2886
 
        user_url = getattr(tree, "user_url", None)
2887
 
        if user_url is None:
2888
 
            display_url = str(tree)
2889
 
        else:
2890
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2837
        display_url = urlutils.unescape_for_display(
 
2838
            tree.user_url, 'ascii')
2891
2839
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2892
2840
 
2893
2841
 
2894
 
class ShelvedChanges(UncommittedChanges):
2895
 
 
2896
 
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
2897
 
            ' (See bzr shelve --list).%(more)s')
2898
 
 
2899
 
 
2900
2842
class MissingTemplateVariable(BzrError):
2901
2843
 
2902
2844
    _fmt = 'Variable {%(name)s} is not available.'
2968
2910
        from bzrlib.osutils import get_user_encoding
2969
2911
        self.path = path
2970
2912
        self.kind = kind
2971
 
        self.user_encoding = get_user_encoding()
2972
 
 
2973
 
 
2974
 
class NoSuchConfig(BzrError):
2975
 
 
2976
 
    _fmt = ('The "%(config_id)s" configuration does not exist.')
2977
 
 
2978
 
    def __init__(self, config_id):
2979
 
        BzrError.__init__(self, config_id=config_id)
2980
 
 
2981
 
 
2982
 
class NoSuchConfigOption(BzrError):
2983
 
 
2984
 
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
2985
 
 
2986
 
    def __init__(self, option_name):
2987
 
        BzrError.__init__(self, option_name=option_name)
 
2913
        self.user_encoding = osutils.get_user_encoding()
2988
2914
 
2989
2915
 
2990
2916
class NoSuchAlias(BzrError):
3035
2961
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
3036
2962
 
3037
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
 
3038
2989
class TipChangeRejected(BzrError):
3039
2990
    """A pre_change_branch_tip hook function may raise this to cleanly and
3040
2991
    explicitly abort a change to a branch tip.
3051
3002
    _fmt = "Shelf corrupt."
3052
3003
 
3053
3004
 
3054
 
class DecompressCorruption(BzrError):
3055
 
 
3056
 
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
3057
 
 
3058
 
    def __init__(self, orig_error=None):
3059
 
        if orig_error is not None:
3060
 
            self.orig_error = ", %s" % (orig_error,)
3061
 
        else:
3062
 
            self.orig_error = ""
3063
 
        BzrError.__init__(self)
3064
 
 
3065
 
 
3066
3005
class NoSuchShelfId(BzrError):
3067
3006
 
3068
3007
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3195
3134
    def __init__(self, bzrdir):
3196
3135
        self.bzrdir = bzrdir
3197
3136
 
3198
 
 
3199
 
class NoWhoami(BzrError):
3200
 
 
3201
 
    _fmt = ('Unable to determine your name.\n'
3202
 
        "Please, set your name with the 'whoami' command.\n"
3203
 
        'E.g. bzr whoami "Your Name <name@example.com>"')
3204
 
 
3205
 
 
3206
 
class InvalidPattern(BzrError):
3207
 
 
3208
 
    _fmt = ('Invalid pattern(s) found. %(msg)s')
3209
 
 
3210
 
    def __init__(self, msg):
3211
 
        self.msg = msg
3212
 
 
3213
 
 
3214
 
class RecursiveBind(BzrError):
3215
 
 
3216
 
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3217
 
        'Please use `bzr unbind` to fix.')
3218
 
 
3219
 
    def __init__(self, branch_url):
3220
 
        self.branch_url = branch_url
3221
 
 
3222
 
 
3223
 
# FIXME: I would prefer to define the config related exception classes in
3224
 
# config.py but the lazy import mechanism proscribes this -- vila 20101222
3225
 
class OptionExpansionLoop(BzrError):
3226
 
 
3227
 
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
3228
 
 
3229
 
    def __init__(self, string, refs):
3230
 
        self.string = string
3231
 
        self.refs = '->'.join(refs)
3232
 
 
3233
 
 
3234
 
class ExpandingUnknownOption(BzrError):
3235
 
 
3236
 
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
3237
 
 
3238
 
    def __init__(self, name, string):
3239
 
        self.name = name
3240
 
        self.string = string
3241
 
 
3242
 
 
3243
 
class NoCompatibleInter(BzrError):
3244
 
 
3245
 
    _fmt = ('No compatible object available for operations from %(source)r '
3246
 
            'to %(target)r.')
3247
 
 
3248
 
    def __init__(self, source, target):
3249
 
        self.source = source
3250
 
        self.target = target
3251
 
 
3252
 
 
3253
 
class HpssVfsRequestNotAllowed(BzrError):
3254
 
 
3255
 
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
3256
 
            "%(method)s, %(arguments)s.")
3257
 
 
3258
 
    def __init__(self, method, arguments):
3259
 
        self.method = method
3260
 
        self.arguments = arguments
3261
 
 
3262
 
 
3263
 
class UnsupportedKindChange(BzrError):
3264
 
 
3265
 
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
3266
 
            "%(path)s not supported by format %(format)r")
3267
 
 
3268
 
    def __init__(self, path, from_kind, to_kind, format):
3269
 
        self.path = path
3270
 
        self.from_kind = from_kind
3271
 
        self.to_kind = to_kind
3272
 
        self.format = format
3273
 
 
3274
 
 
3275
 
class MissingFeature(BzrError):
3276
 
 
3277
 
    _fmt = ("Missing feature %(feature)s not provided by this "
3278
 
            "version of Bazaar or any plugin.")
3279
 
 
3280
 
    def __init__(self, feature):
3281
 
        self.feature = feature
3282
 
 
3283
 
 
3284
 
class PatchSyntax(BzrError):
3285
 
    """Base class for patch syntax errors."""
3286
 
 
3287
 
 
3288
 
class BinaryFiles(BzrError):
3289
 
 
3290
 
    _fmt = 'Binary files section encountered.'
3291
 
 
3292
 
    def __init__(self, orig_name, mod_name):
3293
 
        self.orig_name = orig_name
3294
 
        self.mod_name = mod_name
3295
 
 
3296
 
 
3297
 
class MalformedPatchHeader(PatchSyntax):
3298
 
 
3299
 
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
3300
 
 
3301
 
    def __init__(self, desc, line):
3302
 
        self.desc = desc
3303
 
        self.line = line
3304
 
 
3305
 
 
3306
 
class MalformedHunkHeader(PatchSyntax):
3307
 
 
3308
 
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
3309
 
 
3310
 
    def __init__(self, desc, line):
3311
 
        self.desc = desc
3312
 
        self.line = line
3313
 
 
3314
 
 
3315
 
class MalformedLine(PatchSyntax):
3316
 
 
3317
 
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
3318
 
 
3319
 
    def __init__(self, desc, line):
3320
 
        self.desc = desc
3321
 
        self.line = line
3322
 
 
3323
 
 
3324
 
class PatchConflict(BzrError):
3325
 
 
3326
 
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
3327
 
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
3328
 
 
3329
 
    def __init__(self, line_no, orig_line, patch_line):
3330
 
        self.line_no = line_no
3331
 
        self.orig_line = orig_line.rstrip('\n')
3332
 
        self.patch_line = patch_line.rstrip('\n')
3333
 
 
3334
 
 
3335
 
class FeatureAlreadyRegistered(BzrError):
3336
 
 
3337
 
    _fmt = 'The feature %(feature)s has already been registered.'
3338
 
 
3339
 
    def __init__(self, feature):
3340
 
        self.feature = feature