← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Vincent Ladeuil
  • Date: 2012-03-09 16:48:55 UTC
  • mto: (6437.23.24 2.5)
  • mto: This revision was merged to the branch mainline in revision 6499.
  • Revision ID: v.ladeuil+lp@free.fr-20120309164855-htdn25hp7x65mmir
https://launchpad.net/bugs/940164
Rely on sphinx for texinfo doc generation

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
17
17
"""Exceptions for bzr, and reporting of them.
18
18
"""
19
19
 
20
 
from bzrlib import (
21
 
    osutils,
22
 
    symbol_versioning,
23
 
    )
24
 
from bzrlib.patches import (
25
 
    MalformedHunkHeader,
26
 
    MalformedLine,
27
 
    MalformedPatchHeader,
28
 
    PatchConflict,
29
 
    PatchSyntax,
30
 
    )
31
 
 
 
20
from __future__ import absolute_import
32
21
 
33
22
# TODO: is there any value in providing the .args field used by standard
34
23
# python exceptions?   A list of values with no names seems less useful
54
43
    Base class for errors raised by bzrlib.
55
44
 
56
45
    :cvar internal_error: if True this was probably caused by a bzr bug and
57
 
    should be displayed with a traceback; if False (or absent) this was
58
 
    probably a user or environment error and they don't need the gory details.
59
 
    (That can be overridden by -Derror on the command line.)
 
46
        should be displayed with a traceback; if False (or absent) this was
 
47
        probably a user or environment error and they don't need the gory
 
48
        details.  (That can be overridden by -Derror on the command line.)
60
49
 
61
50
    :cvar _fmt: Format string to display the error; this is expanded
62
 
    by the instance's dict.
 
51
        by the instance's dict.
63
52
    """
64
53
 
65
54
    internal_error = False
106
95
                # __str__() should always return a 'str' object
107
96
                # never a 'unicode' object.
108
97
                return s
109
 
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
110
 
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
111
 
                % (self.__class__.__name__,
112
 
                   self.__dict__,
113
 
                   getattr(self, '_fmt', None),
114
 
                   e)
 
98
        except Exception, e:
 
99
            pass # just bind to 'e' for formatting below
 
100
        else:
 
101
            e = None
 
102
        return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
103
            % (self.__class__.__name__,
 
104
               self.__dict__,
 
105
               getattr(self, '_fmt', None),
 
106
               e)
115
107
 
116
108
    def __unicode__(self):
117
109
        u = self._format()
140
132
        """Return format string for this exception or None"""
141
133
        fmt = getattr(self, '_fmt', None)
142
134
        if fmt is not None:
143
 
            return fmt
144
 
        fmt = getattr(self, '__doc__', None)
145
 
        if fmt is not None:
146
 
            symbol_versioning.warn("%s uses its docstring as a format, "
147
 
                    "it should use _fmt instead" % self.__class__.__name__,
148
 
                    DeprecationWarning)
149
 
            return fmt
150
 
        return 'Unprintable exception %s: dict=%r, fmt=%r' \
151
 
            % (self.__class__.__name__,
152
 
               self.__dict__,
153
 
               getattr(self, '_fmt', None),
154
 
               )
 
135
            from bzrlib.i18n import gettext
 
136
            return gettext(unicode(fmt)) # _fmt strings should be ascii
155
137
 
156
138
    def __eq__(self, other):
157
139
        if self.__class__ is not other.__class__:
170
152
    internal_error = True
171
153
 
172
154
 
173
 
class BzrNewError(BzrError):
174
 
    """Deprecated error base class."""
175
 
    # base classes should override the docstring with their human-
176
 
    # readable explanation
177
 
 
178
 
    def __init__(self, *args, **kwds):
179
 
        # XXX: Use the underlying BzrError to always generate the args
180
 
        # attribute if it doesn't exist.  We can't use super here, because
181
 
        # exceptions are old-style classes in python2.4 (but new in 2.5).
182
 
        # --bmc, 20060426
183
 
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
184
 
             'please convert %s to use BzrError instead'
185
 
             % self.__class__.__name__,
186
 
             DeprecationWarning,
187
 
             stacklevel=2)
188
 
        BzrError.__init__(self, *args)
189
 
        for key, value in kwds.items():
190
 
            setattr(self, key, value)
191
 
 
192
 
    def __str__(self):
193
 
        try:
194
 
            # __str__() should always return a 'str' object
195
 
            # never a 'unicode' object.
196
 
            s = self.__doc__ % self.__dict__
197
 
            if isinstance(s, unicode):
198
 
                return s.encode('utf8')
199
 
            return s
200
 
        except (TypeError, NameError, ValueError, KeyError), e:
201
 
            return 'Unprintable exception %s(%r): %r' \
202
 
                % (self.__class__.__name__,
203
 
                   self.__dict__, e)
204
 
 
205
 
 
206
155
class AlreadyBuilding(BzrError):
207
156
 
208
157
    _fmt = "The tree builder is already building a tree."
304
253
class RootMissing(InternalBzrError):
305
254
 
306
255
    _fmt = ("The root entry of a tree must be the first entry supplied to "
307
 
        "record_entry_contents.")
 
256
        "the commit builder.")
308
257
 
309
258
 
310
259
class NoPublicBranch(BzrError):
621
570
 
622
571
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
623
572
 
624
 
    def __init__(self, url, extra):
 
573
    def __init__(self, url, extra=""):
625
574
        PathError.__init__(self, url, extra=extra)
626
575
 
627
576
 
680
629
 
681
630
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
682
631
 
683
 
    internal_error = True
 
632
    internal_error = False
684
633
 
685
634
    def __init__(self, path, base, extra=None):
686
635
        BzrError.__init__(self)
713
662
       self.bzrdir = bzrdir
714
663
       PathError.__init__(self, path=path)
715
664
 
 
665
    def __repr__(self):
 
666
        return '<%s %r>' % (self.__class__.__name__, self.__dict__)
 
667
 
716
668
    def _format(self):
717
669
        # XXX: Ideally self.detail would be a property, but Exceptions in
718
670
        # Python 2.4 have to be old-style classes so properties don't work.
723
675
                    self.bzrdir.open_repository()
724
676
                except NoRepositoryPresent:
725
677
                    self.detail = ''
 
678
                except Exception:
 
679
                    # Just ignore unexpected errors.  Raising arbitrary errors
 
680
                    # during str(err) can provoke strange bugs.  Concretely
 
681
                    # Launchpad's codehosting managed to raise NotBranchError
 
682
                    # here, and then get stuck in an infinite loop/recursion
 
683
                    # trying to str() that error.  All this error really cares
 
684
                    # about that there's no working repository there, and if
 
685
                    # open_repository() fails, there probably isn't.
 
686
                    self.detail = ''
726
687
                else:
727
688
                    self.detail = ': location is a repository'
728
689
            else:
739
700
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
740
701
 
741
702
 
 
703
class AlreadyControlDirError(PathError):
 
704
 
 
705
    _fmt = 'A control directory already exists: "%(path)s".'
 
706
 
 
707
 
742
708
class AlreadyBranchError(PathError):
743
709
 
744
710
    _fmt = 'Already a branch: "%(path)s".'
745
711
 
746
712
 
 
713
class ParentBranchExists(AlreadyBranchError):
 
714
 
 
715
    _fmt = 'Parent branch already exists: "%(path)s".'
 
716
 
 
717
 
747
718
class BranchExistsWithoutWorkingTree(PathError):
748
719
 
749
720
    _fmt = 'Directory contains a branch, but no working tree \
778
749
        self.path = bzrdir.transport.clone('..').base
779
750
 
780
751
 
781
 
class FileInWrongBranch(BzrError):
782
 
 
783
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
784
 
 
785
 
    def __init__(self, branch, path):
786
 
        BzrError.__init__(self)
787
 
        self.branch = branch
788
 
        self.branch_base = branch.base
789
 
        self.path = path
790
 
 
791
 
 
792
752
class UnsupportedFormatError(BzrError):
793
753
 
794
754
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
813
773
        self.bzrdir = bzrdir_format
814
774
 
815
775
 
 
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
 
816
788
class IncompatibleRepositories(BzrError):
817
789
    """Report an error that two repositories are not compatible.
818
790
 
850
822
        """Construct a new AlreadyVersionedError.
851
823
 
852
824
        :param path: This is the path which is versioned,
853
 
        which should be in a user friendly form.
 
825
            which should be in a user friendly form.
854
826
        :param context_info: If given, this is information about the context,
855
 
        which could explain why this is expected to not be versioned.
 
827
            which could explain why this is expected to not be versioned.
856
828
        """
857
829
        BzrError.__init__(self)
858
830
        self.path = path
871
843
        """Construct a new NotVersionedError.
872
844
 
873
845
        :param path: This is the path which is not versioned,
874
 
        which should be in a user friendly form.
 
846
            which should be in a user friendly form.
875
847
        :param context_info: If given, this is information about the context,
876
 
        which could explain why this is expected to be versioned.
 
848
            which could explain why this is expected to be versioned.
877
849
        """
878
850
        BzrError.__init__(self)
879
851
        self.path = path
947
919
    # original exception is available as e.original_error
948
920
    #
949
921
    # New code should prefer to raise specific subclasses
950
 
    def __init__(self, message):
951
 
        # Python 2.5 uses a slot for StandardError.message,
952
 
        # so use a different variable name.  We now work around this in
953
 
        # BzrError.__str__, but this member name is kept for compatability.
954
 
        self.msg = message
 
922
    def __init__(self, msg):
 
923
        self.msg = msg
955
924
 
956
925
 
957
926
class LockActive(LockError):
1041
1010
class LockContention(LockError):
1042
1011
 
1043
1012
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
1044
 
    # TODO: show full url for lock, combining the transport and relative
1045
 
    # bits?
1046
1013
 
1047
1014
    internal_error = False
1048
1015
 
1075
1042
        self.target = target
1076
1043
 
1077
1044
 
 
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
 
1078
1057
class LockNotHeld(LockError):
1079
1058
 
1080
1059
    _fmt = "Lock not held: %(lock)s"
1119
1098
        BzrError.__init__(self, files=files, files_str=files_str)
1120
1099
 
1121
1100
 
 
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
 
1122
1110
class BadCommitMessageEncoding(BzrError):
1123
1111
 
1124
1112
    _fmt = 'The specified commit message contains characters unsupported by '\
1180
1168
class InvalidRevisionSpec(BzrError):
1181
1169
 
1182
1170
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1183
 
            " %(branch)s%(extra)s")
 
1171
            " %(branch_url)s%(extra)s")
1184
1172
 
1185
1173
    def __init__(self, spec, branch, extra=None):
1186
1174
        BzrError.__init__(self, branch=branch, spec=spec)
 
1175
        self.branch_url = getattr(branch, 'user_url', str(branch))
1187
1176
        if extra:
1188
1177
            self.extra = '\n' + str(extra)
1189
1178
        else:
1190
1179
            self.extra = ''
1191
1180
 
1192
1181
 
1193
 
class HistoryMissing(BzrError):
1194
 
 
1195
 
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
1196
 
 
1197
 
 
1198
1182
class AppendRevisionsOnlyViolation(BzrError):
1199
1183
 
1200
1184
    _fmt = ('Operation denied because it would change the main history,'
1265
1249
            not_ancestor_id=not_ancestor_id)
1266
1250
 
1267
1251
 
1268
 
class AmbiguousBase(BzrError):
1269
 
 
1270
 
    def __init__(self, bases):
1271
 
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1272
 
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1273
 
        msg = ("The correct base is unclear, because %s are all equally close"
1274
 
                % ", ".join(bases))
1275
 
        BzrError.__init__(self, msg)
1276
 
        self.bases = bases
1277
 
 
1278
 
 
1279
1252
class NoCommits(BranchError):
1280
1253
 
1281
1254
    _fmt = "Branch %(branch)s has no commits."
1380
1353
 
1381
1354
class WeaveParentMismatch(WeaveError):
1382
1355
 
1383
 
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1356
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
1384
1357
 
1385
1358
 
1386
1359
class WeaveInvalidChecksum(WeaveError):
1387
1360
 
1388
 
    _fmt = "Text did not match it's checksum: %(message)s"
 
1361
    _fmt = "Text did not match its checksum: %(msg)s"
1389
1362
 
1390
1363
 
1391
1364
class WeaveTextDiffers(WeaveError):
1439
1412
 
1440
1413
class VersionedFileInvalidChecksum(VersionedFileError):
1441
1414
 
1442
 
    _fmt = "Text did not match its checksum: %(message)s"
 
1415
    _fmt = "Text did not match its checksum: %(msg)s"
1443
1416
 
1444
1417
 
1445
1418
class KnitError(InternalBzrError):
1541
1514
            problem we can raise the original error (value from sys.exc_info())
1542
1515
        """
1543
1516
        BzrError.__init__(self)
 
1517
        self.context = context
1544
1518
        self.reload_occurred = reload_occurred
1545
1519
        self.exc_info = exc_info
1546
1520
        self.orig_error = exc_info[1]
1628
1602
 
1629
1603
    def __init__(self, exc_info):
1630
1604
        import traceback
 
1605
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1631
1606
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1632
1607
        self.exc_info = exc_info
1633
1608
        traceback_strings = traceback.format_exception(
1672
1647
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1673
1648
 
1674
1649
 
 
1650
class ConnectionTimeout(ConnectionError):
 
1651
 
 
1652
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1653
 
 
1654
 
1675
1655
class InvalidRange(TransportError):
1676
1656
 
1677
1657
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1684
1664
 
1685
1665
class InvalidHttpResponse(TransportError):
1686
1666
 
1687
 
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1667
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
1688
1668
 
1689
1669
    def __init__(self, path, msg, orig_error=None):
1690
1670
        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,)
1691
1677
        TransportError.__init__(self, msg, orig_error=orig_error)
1692
1678
 
1693
1679
 
 
1680
class CertificateError(TransportError):
 
1681
 
 
1682
    _fmt = "Certificate error: %(error)s"
 
1683
 
 
1684
    def __init__(self, error):
 
1685
        self.error = error
 
1686
 
 
1687
 
1694
1688
class InvalidHttpRange(InvalidHttpResponse):
1695
1689
 
1696
1690
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1700
1694
        InvalidHttpResponse.__init__(self, path, msg)
1701
1695
 
1702
1696
 
 
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
 
1703
1710
class InvalidHttpContentType(InvalidHttpResponse):
1704
1711
 
1705
1712
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1733
1740
    _fmt = "Working tree has conflicts."
1734
1741
 
1735
1742
 
 
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
 
1736
1752
class ParseConfigError(BzrError):
1737
1753
 
 
1754
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
 
1755
 
1738
1756
    def __init__(self, errors, filename):
1739
 
        if filename is None:
1740
 
            filename = ""
1741
 
        message = "Error(s) parsing config file %s:\n%s" % \
1742
 
            (filename, ('\n'.join(e.msg for e in errors)))
1743
 
        BzrError.__init__(self, message)
 
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".\n'
 
1765
            'See ``bzr help %(name)s``')
 
1766
 
 
1767
    def __init__(self, name, value):
 
1768
        BzrError.__init__(self, name=name, value=value)
1744
1769
 
1745
1770
 
1746
1771
class NoEmailInUsername(BzrError):
1754
1779
 
1755
1780
class SigningFailed(BzrError):
1756
1781
 
1757
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1782
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
1758
1783
 
1759
1784
    def __init__(self, command_line):
1760
1785
        BzrError.__init__(self, command_line=command_line)
1761
1786
 
1762
1787
 
 
1788
class SignatureVerificationFailed(BzrError):
 
1789
 
 
1790
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
 
1791
 
 
1792
    def __init__(self, error):
 
1793
        BzrError.__init__(self, error=error)
 
1794
 
 
1795
 
 
1796
class DependencyNotPresent(BzrError):
 
1797
 
 
1798
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1799
 
 
1800
    def __init__(self, library, error):
 
1801
        BzrError.__init__(self, library=library, error=error)
 
1802
 
 
1803
 
 
1804
class GpgmeNotInstalled(DependencyNotPresent):
 
1805
 
 
1806
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
 
1807
 
 
1808
    def __init__(self, error):
 
1809
        DependencyNotPresent.__init__(self, 'gpgme', error)
 
1810
 
 
1811
 
1763
1812
class WorkingTreeNotRevision(BzrError):
1764
1813
 
1765
1814
    _fmt = ("The working tree for %(basedir)s has changed since"
1881
1930
        self.prefix = prefix
1882
1931
 
1883
1932
 
1884
 
class MalformedTransform(BzrError):
 
1933
class MalformedTransform(InternalBzrError):
1885
1934
 
1886
1935
    _fmt = "Tree transform is malformed %(conflicts)r"
1887
1936
 
1925
1974
    _fmt = "Moving the root directory is not supported at this time"
1926
1975
 
1927
1976
 
 
1977
class TransformRenameFailed(BzrError):
 
1978
 
 
1979
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
1980
 
 
1981
    def __init__(self, from_path, to_path, why, errno):
 
1982
        self.from_path = from_path
 
1983
        self.to_path = to_path
 
1984
        self.why = why
 
1985
        self.errno = errno
 
1986
 
 
1987
 
1928
1988
class BzrMoveFailedError(BzrError):
1929
1989
 
1930
 
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1990
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
 
1991
        "%(_has_extra)s%(extra)s")
1931
1992
 
1932
1993
    def __init__(self, from_path='', to_path='', extra=None):
1933
1994
        from bzrlib.osutils import splitpath
1934
1995
        BzrError.__init__(self)
1935
1996
        if extra:
1936
 
            self.extra = ': ' + str(extra)
 
1997
            self.extra, self._has_extra = extra, ': '
1937
1998
        else:
1938
 
            self.extra = ''
 
1999
            self.extra = self._has_extra = ''
1939
2000
 
1940
2001
        has_from = len(from_path) > 0
1941
2002
        has_to = len(to_path) > 0
1962
2023
 
1963
2024
class BzrRenameFailedError(BzrMoveFailedError):
1964
2025
 
1965
 
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
2026
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
 
2027
        "%(_has_extra)s%(extra)s")
1966
2028
 
1967
2029
    def __init__(self, from_path, to_path, extra=None):
1968
2030
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1969
2031
 
1970
 
class BzrRemoveChangedFilesError(BzrError):
1971
 
    """Used when user is trying to remove changed files."""
1972
 
 
1973
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
1974
 
        "%(changes_as_text)s"
1975
 
        "Use --keep to not delete them, or --force to delete them regardless.")
1976
 
 
1977
 
    def __init__(self, tree_delta):
1978
 
        BzrError.__init__(self)
1979
 
        self.changes_as_text = tree_delta.get_changes_as_text()
1980
 
        #self.paths_as_string = '\n'.join(changed_files)
1981
 
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
1982
 
 
1983
2032
 
1984
2033
class BzrBadParameterNotString(BzrBadParameter):
1985
2034
 
1988
2037
 
1989
2038
class BzrBadParameterMissing(BzrBadParameter):
1990
2039
 
1991
 
    _fmt = "Parameter $(param)s is required but not present."
 
2040
    _fmt = "Parameter %(param)s is required but not present."
1992
2041
 
1993
2042
 
1994
2043
class BzrBadParameterUnicode(BzrBadParameter):
2002
2051
    _fmt = "Parameter %(param)s contains a newline."
2003
2052
 
2004
2053
 
2005
 
class DependencyNotPresent(BzrError):
2006
 
 
2007
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
2008
 
 
2009
 
    def __init__(self, library, error):
2010
 
        BzrError.__init__(self, library=library, error=error)
2011
 
 
2012
 
 
2013
2054
class ParamikoNotPresent(DependencyNotPresent):
2014
2055
 
2015
2056
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2250
2291
    """
2251
2292
 
2252
2293
 
 
2294
class GhostTagsNotSupported(BzrError):
 
2295
 
 
2296
    _fmt = "Ghost tags not supported by format %(format)r."
 
2297
 
 
2298
    def __init__(self, format):
 
2299
        self.format = format
 
2300
 
 
2301
 
2253
2302
class BinaryFile(BzrError):
2254
2303
 
2255
2304
    _fmt = "File is binary but should be text."
2618
2667
 
2619
2668
    This is distinct from ErrorFromSmartServer so that it is possible to
2620
2669
    distinguish between the following two cases:
2621
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2622
 
        and so should provoke a traceback to the user.
2623
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2624
 
        translated.  This is probably because the server sent us garbage, and
2625
 
        should not provoke a traceback.
 
2670
 
 
2671
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2672
      and so should provoke a traceback to the user.
 
2673
    - ErrorFromSmartServer was caught but its error_tuple could not be
 
2674
      translated.  This is probably because the server sent us garbage, and
 
2675
      should not provoke a traceback.
2626
2676
    """
2627
2677
 
2628
2678
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2684
2734
    _fmt = "Container has multiple records with the same name: %(name)s"
2685
2735
 
2686
2736
    def __init__(self, name):
2687
 
        self.name = name
 
2737
        self.name = name.decode("utf-8")
2688
2738
 
2689
2739
 
2690
2740
class NoDestinationAddress(InternalBzrError):
2834
2884
        else:
2835
2885
            more = ' ' + more
2836
2886
        import bzrlib.urlutils as urlutils
2837
 
        display_url = urlutils.unescape_for_display(
2838
 
            tree.user_url, 'ascii')
 
2887
        user_url = getattr(tree, "user_url", None)
 
2888
        if user_url is None:
 
2889
            display_url = str(tree)
 
2890
        else:
 
2891
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
2839
2892
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2840
2893
 
2841
2894
 
 
2895
class ShelvedChanges(UncommittedChanges):
 
2896
 
 
2897
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2898
            ' (See bzr shelve --list).%(more)s')
 
2899
 
 
2900
 
2842
2901
class MissingTemplateVariable(BzrError):
2843
2902
 
2844
2903
    _fmt = 'Variable {%(name)s} is not available.'
2910
2969
        from bzrlib.osutils import get_user_encoding
2911
2970
        self.path = path
2912
2971
        self.kind = kind
2913
 
        self.user_encoding = osutils.get_user_encoding()
 
2972
        self.user_encoding = get_user_encoding()
 
2973
 
 
2974
 
 
2975
class NoSuchConfig(BzrError):
 
2976
 
 
2977
    _fmt = ('The "%(config_id)s" configuration does not exist.')
 
2978
 
 
2979
    def __init__(self, config_id):
 
2980
        BzrError.__init__(self, config_id=config_id)
 
2981
 
 
2982
 
 
2983
class NoSuchConfigOption(BzrError):
 
2984
 
 
2985
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
 
2986
 
 
2987
    def __init__(self, option_name):
 
2988
        BzrError.__init__(self, option_name=option_name)
2914
2989
 
2915
2990
 
2916
2991
class NoSuchAlias(BzrError):
2961
3036
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
2962
3037
 
2963
3038
 
2964
 
class HookFailed(BzrError):
2965
 
    """Raised when a pre_change_branch_tip hook function fails anything other
2966
 
    than TipChangeRejected.
2967
 
 
2968
 
    Note that this exception is no longer raised, and the import is only left
2969
 
    to be nice to code which might catch it in a plugin.
2970
 
    """
2971
 
 
2972
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2973
 
            "%(traceback_text)s%(exc_value)s")
2974
 
 
2975
 
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
2976
 
        if warn:
2977
 
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
2978
 
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
2979
 
        import traceback
2980
 
        self.hook_stage = hook_stage
2981
 
        self.hook_name = hook_name
2982
 
        self.exc_info = exc_info
2983
 
        self.exc_type = exc_info[0]
2984
 
        self.exc_value = exc_info[1]
2985
 
        self.exc_tb = exc_info[2]
2986
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
2987
 
 
2988
 
 
2989
3039
class TipChangeRejected(BzrError):
2990
3040
    """A pre_change_branch_tip hook function may raise this to cleanly and
2991
3041
    explicitly abort a change to a branch tip.
3002
3052
    _fmt = "Shelf corrupt."
3003
3053
 
3004
3054
 
 
3055
class DecompressCorruption(BzrError):
 
3056
 
 
3057
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
 
3058
 
 
3059
    def __init__(self, orig_error=None):
 
3060
        if orig_error is not None:
 
3061
            self.orig_error = ", %s" % (orig_error,)
 
3062
        else:
 
3063
            self.orig_error = ""
 
3064
        BzrError.__init__(self)
 
3065
 
 
3066
 
3005
3067
class NoSuchShelfId(BzrError):
3006
3068
 
3007
3069
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3134
3196
    def __init__(self, bzrdir):
3135
3197
        self.bzrdir = bzrdir
3136
3198
 
 
3199
 
 
3200
class NoWhoami(BzrError):
 
3201
 
 
3202
    _fmt = ('Unable to determine your name.\n'
 
3203
        "Please, set your name with the 'whoami' command.\n"
 
3204
        'E.g. bzr whoami "Your Name <name@example.com>"')
 
3205
 
 
3206
 
 
3207
class InvalidPattern(BzrError):
 
3208
 
 
3209
    _fmt = ('Invalid pattern(s) found. %(msg)s')
 
3210
 
 
3211
    def __init__(self, msg):
 
3212
        self.msg = msg
 
3213
 
 
3214
 
 
3215
class RecursiveBind(BzrError):
 
3216
 
 
3217
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
 
3218
        'Please use `bzr unbind` to fix.')
 
3219
 
 
3220
    def __init__(self, branch_url):
 
3221
        self.branch_url = branch_url
 
3222
 
 
3223
 
 
3224
# FIXME: I would prefer to define the config related exception classes in
 
3225
# config.py but the lazy import mechanism proscribes this -- vila 20101222
 
3226
class OptionExpansionLoop(BzrError):
 
3227
 
 
3228
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
 
3229
 
 
3230
    def __init__(self, string, refs):
 
3231
        self.string = string
 
3232
        self.refs = '->'.join(refs)
 
3233
 
 
3234
 
 
3235
class ExpandingUnknownOption(BzrError):
 
3236
 
 
3237
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
 
3238
 
 
3239
    def __init__(self, name, string):
 
3240
        self.name = name
 
3241
        self.string = string
 
3242
 
 
3243
 
 
3244
class NoCompatibleInter(BzrError):
 
3245
 
 
3246
    _fmt = ('No compatible object available for operations from %(source)r '
 
3247
            'to %(target)r.')
 
3248
 
 
3249
    def __init__(self, source, target):
 
3250
        self.source = source
 
3251
        self.target = target
 
3252
 
 
3253
 
 
3254
class HpssVfsRequestNotAllowed(BzrError):
 
3255
 
 
3256
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
 
3257
            "%(method)s, %(arguments)s.")
 
3258
 
 
3259
    def __init__(self, method, arguments):
 
3260
        self.method = method
 
3261
        self.arguments = arguments
 
3262
 
 
3263
 
 
3264
class UnsupportedKindChange(BzrError):
 
3265
 
 
3266
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
 
3267
            "%(path)s not supported by format %(format)r")
 
3268
 
 
3269
    def __init__(self, path, from_kind, to_kind, format):
 
3270
        self.path = path
 
3271
        self.from_kind = from_kind
 
3272
        self.to_kind = to_kind
 
3273
        self.format = format
 
3274
 
 
3275
 
 
3276
class MissingFeature(BzrError):
 
3277
 
 
3278
    _fmt = ("Missing feature %(feature)s not provided by this "
 
3279
            "version of Bazaar or any plugin.")
 
3280
 
 
3281
    def __init__(self, feature):
 
3282
        self.feature = feature
 
3283
 
 
3284
 
 
3285
class PatchSyntax(BzrError):
 
3286
    """Base class for patch syntax errors."""
 
3287
 
 
3288
 
 
3289
class BinaryFiles(BzrError):
 
3290
 
 
3291
    _fmt = 'Binary files section encountered.'
 
3292
 
 
3293
    def __init__(self, orig_name, mod_name):
 
3294
        self.orig_name = orig_name
 
3295
        self.mod_name = mod_name
 
3296
 
 
3297
 
 
3298
class MalformedPatchHeader(PatchSyntax):
 
3299
 
 
3300
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
 
3301
 
 
3302
    def __init__(self, desc, line):
 
3303
        self.desc = desc
 
3304
        self.line = line
 
3305
 
 
3306
 
 
3307
class MalformedHunkHeader(PatchSyntax):
 
3308
 
 
3309
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
 
3310
 
 
3311
    def __init__(self, desc, line):
 
3312
        self.desc = desc
 
3313
        self.line = line
 
3314
 
 
3315
 
 
3316
class MalformedLine(PatchSyntax):
 
3317
 
 
3318
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
 
3319
 
 
3320
    def __init__(self, desc, line):
 
3321
        self.desc = desc
 
3322
        self.line = line
 
3323
 
 
3324
 
 
3325
class PatchConflict(BzrError):
 
3326
 
 
3327
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
 
3328
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
 
3329
 
 
3330
    def __init__(self, line_no, orig_line, patch_line):
 
3331
        self.line_no = line_no
 
3332
        self.orig_line = orig_line.rstrip('\n')
 
3333
        self.patch_line = patch_line.rstrip('\n')
 
3334
 
 
3335
 
 
3336
class FeatureAlreadyRegistered(BzrError):
 
3337
 
 
3338
    _fmt = 'The feature %(feature)s has already been registered.'
 
3339
 
 
3340
    def __init__(self, feature):
 
3341
        self.feature = feature