/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 InvalidBranchName(PathError):
714
 
 
715
 
    _fmt = "Invalid branch name: %(name)s"
716
 
 
717
 
    def __init__(self, name):
718
 
        BzrError.__init__(self)
719
 
        self.name = name
720
 
 
721
 
 
722
 
class ParentBranchExists(AlreadyBranchError):
723
 
 
724
 
    _fmt = 'Parent branch already exists: "%(path)s".'
725
 
 
726
 
 
727
747
class BranchExistsWithoutWorkingTree(PathError):
728
748
 
729
749
    _fmt = 'Directory contains a branch, but no working tree \
758
778
        self.path = bzrdir.transport.clone('..').base
759
779
 
760
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
 
761
792
class UnsupportedFormatError(BzrError):
762
793
 
763
794
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
782
813
        self.bzrdir = bzrdir_format
783
814
 
784
815
 
785
 
class ParseFormatError(BzrError):
786
 
 
787
 
    _fmt = "Parse error on line %(lineno)d of %(format)s format: %(line)s"
788
 
 
789
 
    def __init__(self, format, lineno, line, text):
790
 
        BzrError.__init__(self)
791
 
        self.format = format
792
 
        self.lineno = lineno
793
 
        self.line = line
794
 
        self.text = text
795
 
 
796
 
 
797
816
class IncompatibleRepositories(BzrError):
798
817
    """Report an error that two repositories are not compatible.
799
818
 
831
850
        """Construct a new AlreadyVersionedError.
832
851
 
833
852
        :param path: This is the path which is versioned,
834
 
            which should be in a user friendly form.
 
853
        which should be in a user friendly form.
835
854
        :param context_info: If given, this is information about the context,
836
 
            which could explain why this is expected to not be versioned.
 
855
        which could explain why this is expected to not be versioned.
837
856
        """
838
857
        BzrError.__init__(self)
839
858
        self.path = path
852
871
        """Construct a new NotVersionedError.
853
872
 
854
873
        :param path: This is the path which is not versioned,
855
 
            which should be in a user friendly form.
 
874
        which should be in a user friendly form.
856
875
        :param context_info: If given, this is information about the context,
857
 
            which could explain why this is expected to be versioned.
 
876
        which could explain why this is expected to be versioned.
858
877
        """
859
878
        BzrError.__init__(self)
860
879
        self.path = path
928
947
    # original exception is available as e.original_error
929
948
    #
930
949
    # New code should prefer to raise specific subclasses
931
 
    def __init__(self, msg):
932
 
        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
933
955
 
934
956
 
935
957
class LockActive(LockError):
1019
1041
class LockContention(LockError):
1020
1042
 
1021
1043
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
1044
    # TODO: show full url for lock, combining the transport and relative
 
1045
    # bits?
1022
1046
 
1023
1047
    internal_error = False
1024
1048
 
1051
1075
        self.target = target
1052
1076
 
1053
1077
 
1054
 
class LockCorrupt(LockError):
1055
 
 
1056
 
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
1057
 
            "Use 'bzr break-lock' to clear it")
1058
 
 
1059
 
    internal_error = False
1060
 
 
1061
 
    def __init__(self, corruption_info, file_data=None):
1062
 
        self.corruption_info = corruption_info
1063
 
        self.file_data = file_data
1064
 
 
1065
 
 
1066
1078
class LockNotHeld(LockError):
1067
1079
 
1068
1080
    _fmt = "Lock not held: %(lock)s"
1107
1119
        BzrError.__init__(self, files=files, files_str=files_str)
1108
1120
 
1109
1121
 
1110
 
class ExcludesUnsupported(BzrError):
1111
 
 
1112
 
    _fmt = ('Excluding paths during commit is not supported by '
1113
 
            'repository at %(repository)r.')
1114
 
 
1115
 
    def __init__(self, repository):
1116
 
        BzrError.__init__(self, repository=repository)
1117
 
 
1118
 
 
1119
1122
class BadCommitMessageEncoding(BzrError):
1120
1123
 
1121
1124
    _fmt = 'The specified commit message contains characters unsupported by '\
1177
1180
class InvalidRevisionSpec(BzrError):
1178
1181
 
1179
1182
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1180
 
            " %(branch_url)s%(extra)s")
 
1183
            " %(branch)s%(extra)s")
1181
1184
 
1182
1185
    def __init__(self, spec, branch, extra=None):
1183
1186
        BzrError.__init__(self, branch=branch, spec=spec)
1184
 
        self.branch_url = getattr(branch, 'user_url', str(branch))
1185
1187
        if extra:
1186
1188
            self.extra = '\n' + str(extra)
1187
1189
        else:
1188
1190
            self.extra = ''
1189
1191
 
1190
1192
 
 
1193
class HistoryMissing(BzrError):
 
1194
 
 
1195
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
1196
 
 
1197
 
1191
1198
class AppendRevisionsOnlyViolation(BzrError):
1192
1199
 
1193
1200
    _fmt = ('Operation denied because it would change the main history,'
1258
1265
            not_ancestor_id=not_ancestor_id)
1259
1266
 
1260
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
 
1261
1279
class NoCommits(BranchError):
1262
1280
 
1263
1281
    _fmt = "Branch %(branch)s has no commits."
1362
1380
 
1363
1381
class WeaveParentMismatch(WeaveError):
1364
1382
 
1365
 
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
 
1383
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1366
1384
 
1367
1385
 
1368
1386
class WeaveInvalidChecksum(WeaveError):
1369
1387
 
1370
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1388
    _fmt = "Text did not match it's checksum: %(message)s"
1371
1389
 
1372
1390
 
1373
1391
class WeaveTextDiffers(WeaveError):
1421
1439
 
1422
1440
class VersionedFileInvalidChecksum(VersionedFileError):
1423
1441
 
1424
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1442
    _fmt = "Text did not match its checksum: %(message)s"
1425
1443
 
1426
1444
 
1427
1445
class KnitError(InternalBzrError):
1523
1541
            problem we can raise the original error (value from sys.exc_info())
1524
1542
        """
1525
1543
        BzrError.__init__(self)
1526
 
        self.context = context
1527
1544
        self.reload_occurred = reload_occurred
1528
1545
        self.exc_info = exc_info
1529
1546
        self.orig_error = exc_info[1]
1611
1628
 
1612
1629
    def __init__(self, exc_info):
1613
1630
        import traceback
1614
 
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1615
1631
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1616
1632
        self.exc_info = exc_info
1617
1633
        traceback_strings = traceback.format_exception(
1656
1672
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1657
1673
 
1658
1674
 
1659
 
class ConnectionTimeout(ConnectionError):
1660
 
 
1661
 
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
1662
 
 
1663
 
 
1664
1675
class InvalidRange(TransportError):
1665
1676
 
1666
1677
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1673
1684
 
1674
1685
class InvalidHttpResponse(TransportError):
1675
1686
 
1676
 
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1687
    _fmt = "Invalid http response for %(path)s: %(msg)s"
1677
1688
 
1678
1689
    def __init__(self, path, msg, orig_error=None):
1679
1690
        self.path = path
1680
 
        if orig_error is None:
1681
 
            orig_error = ''
1682
 
        else:
1683
 
            # This is reached for obscure and unusual errors so we want to
1684
 
            # preserve as much info as possible to ease debug.
1685
 
            orig_error = ': %r' % (orig_error,)
1686
1691
        TransportError.__init__(self, msg, orig_error=orig_error)
1687
1692
 
1688
1693
 
1689
 
class CertificateError(TransportError):
1690
 
 
1691
 
    _fmt = "Certificate error: %(error)s"
1692
 
 
1693
 
    def __init__(self, error):
1694
 
        self.error = error
1695
 
 
1696
 
 
1697
1694
class InvalidHttpRange(InvalidHttpResponse):
1698
1695
 
1699
1696
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1703
1700
        InvalidHttpResponse.__init__(self, path, msg)
1704
1701
 
1705
1702
 
1706
 
class HttpBoundaryMissing(InvalidHttpResponse):
1707
 
    """A multipart response ends with no boundary marker.
1708
 
 
1709
 
    This is a special case caused by buggy proxies, described in
1710
 
    <https://bugs.launchpad.net/bzr/+bug/198646>.
1711
 
    """
1712
 
 
1713
 
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
1714
 
 
1715
 
    def __init__(self, path, msg):
1716
 
        InvalidHttpResponse.__init__(self, path, msg)
1717
 
 
1718
 
 
1719
1703
class InvalidHttpContentType(InvalidHttpResponse):
1720
1704
 
1721
1705
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1749
1733
    _fmt = "Working tree has conflicts."
1750
1734
 
1751
1735
 
1752
 
class ConfigContentError(BzrError):
1753
 
 
1754
 
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
1755
 
 
1756
 
    def __init__(self, filename):
1757
 
        BzrError.__init__(self)
1758
 
        self.filename = filename
1759
 
 
1760
 
 
1761
1736
class ParseConfigError(BzrError):
1762
1737
 
1763
 
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
1764
 
 
1765
1738
    def __init__(self, errors, filename):
1766
 
        BzrError.__init__(self)
1767
 
        self.filename = filename
1768
 
        self.errors = '\n'.join(e.msg for e in errors)
1769
 
 
1770
 
 
1771
 
class ConfigOptionValueError(BzrError):
1772
 
 
1773
 
    _fmt = ('Bad value "%(value)s" for option "%(name)s".\n'
1774
 
            'See ``bzr help %(name)s``')
1775
 
 
1776
 
    def __init__(self, name, value):
1777
 
        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)
1778
1744
 
1779
1745
 
1780
1746
class NoEmailInUsername(BzrError):
1788
1754
 
1789
1755
class SigningFailed(BzrError):
1790
1756
 
1791
 
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
 
1757
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1792
1758
 
1793
1759
    def __init__(self, command_line):
1794
1760
        BzrError.__init__(self, command_line=command_line)
1795
1761
 
1796
1762
 
1797
 
class SignatureVerificationFailed(BzrError):
1798
 
 
1799
 
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
1800
 
 
1801
 
    def __init__(self, error):
1802
 
        BzrError.__init__(self, error=error)
1803
 
 
1804
 
 
1805
 
class DependencyNotPresent(BzrError):
1806
 
 
1807
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1808
 
 
1809
 
    def __init__(self, library, error):
1810
 
        BzrError.__init__(self, library=library, error=error)
1811
 
 
1812
 
 
1813
 
class GpgmeNotInstalled(DependencyNotPresent):
1814
 
 
1815
 
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
1816
 
 
1817
 
    def __init__(self, error):
1818
 
        DependencyNotPresent.__init__(self, 'gpgme', error)
1819
 
 
1820
 
 
1821
1763
class WorkingTreeNotRevision(BzrError):
1822
1764
 
1823
1765
    _fmt = ("The working tree for %(basedir)s has changed since"
1939
1881
        self.prefix = prefix
1940
1882
 
1941
1883
 
1942
 
class MalformedTransform(InternalBzrError):
 
1884
class MalformedTransform(BzrError):
1943
1885
 
1944
1886
    _fmt = "Tree transform is malformed %(conflicts)r"
1945
1887
 
1983
1925
    _fmt = "Moving the root directory is not supported at this time"
1984
1926
 
1985
1927
 
1986
 
class TransformRenameFailed(BzrError):
1987
 
 
1988
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
1989
 
 
1990
 
    def __init__(self, from_path, to_path, why, errno):
1991
 
        self.from_path = from_path
1992
 
        self.to_path = to_path
1993
 
        self.why = why
1994
 
        self.errno = errno
1995
 
 
1996
 
 
1997
1928
class BzrMoveFailedError(BzrError):
1998
1929
 
1999
 
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
2000
 
        "%(_has_extra)s%(extra)s")
 
1930
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
2001
1931
 
2002
1932
    def __init__(self, from_path='', to_path='', extra=None):
2003
1933
        from bzrlib.osutils import splitpath
2004
1934
        BzrError.__init__(self)
2005
1935
        if extra:
2006
 
            self.extra, self._has_extra = extra, ': '
 
1936
            self.extra = ': ' + str(extra)
2007
1937
        else:
2008
 
            self.extra = self._has_extra = ''
 
1938
            self.extra = ''
2009
1939
 
2010
1940
        has_from = len(from_path) > 0
2011
1941
        has_to = len(to_path) > 0
2032
1962
 
2033
1963
class BzrRenameFailedError(BzrMoveFailedError):
2034
1964
 
2035
 
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
2036
 
        "%(_has_extra)s%(extra)s")
 
1965
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
2037
1966
 
2038
1967
    def __init__(self, from_path, to_path, extra=None):
2039
1968
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2040
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
 
2041
1983
 
2042
1984
class BzrBadParameterNotString(BzrBadParameter):
2043
1985
 
2046
1988
 
2047
1989
class BzrBadParameterMissing(BzrBadParameter):
2048
1990
 
2049
 
    _fmt = "Parameter %(param)s is required but not present."
 
1991
    _fmt = "Parameter $(param)s is required but not present."
2050
1992
 
2051
1993
 
2052
1994
class BzrBadParameterUnicode(BzrBadParameter):
2060
2002
    _fmt = "Parameter %(param)s contains a newline."
2061
2003
 
2062
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
 
2063
2013
class ParamikoNotPresent(DependencyNotPresent):
2064
2014
 
2065
2015
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2300
2250
    """
2301
2251
 
2302
2252
 
2303
 
class GhostTagsNotSupported(BzrError):
2304
 
 
2305
 
    _fmt = "Ghost tags not supported by format %(format)r."
2306
 
 
2307
 
    def __init__(self, format):
2308
 
        self.format = format
2309
 
 
2310
 
 
2311
2253
class BinaryFile(BzrError):
2312
2254
 
2313
2255
    _fmt = "File is binary but should be text."
2676
2618
 
2677
2619
    This is distinct from ErrorFromSmartServer so that it is possible to
2678
2620
    distinguish between the following two cases:
2679
 
 
2680
 
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
2681
 
      and so should provoke a traceback to the user.
2682
 
    - ErrorFromSmartServer was caught but its error_tuple could not be
2683
 
      translated.  This is probably because the server sent us garbage, and
2684
 
      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.
2685
2626
    """
2686
2627
 
2687
2628
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2743
2684
    _fmt = "Container has multiple records with the same name: %(name)s"
2744
2685
 
2745
2686
    def __init__(self, name):
2746
 
        self.name = name.decode("utf-8")
 
2687
        self.name = name
2747
2688
 
2748
2689
 
2749
2690
class NoDestinationAddress(InternalBzrError):
2777
2718
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2778
2719
 
2779
2720
 
 
2721
class UnknownMailClient(BzrError):
 
2722
 
 
2723
    _fmt = "Unknown mail client: %(mail_client)s"
 
2724
 
 
2725
    def __init__(self, mail_client):
 
2726
        BzrError.__init__(self, mail_client=mail_client)
 
2727
 
 
2728
 
2780
2729
class MailClientNotFound(BzrError):
2781
2730
 
2782
2731
    _fmt = "Unable to find mail client with the following names:"\
2885
2834
        else:
2886
2835
            more = ' ' + more
2887
2836
        import bzrlib.urlutils as urlutils
2888
 
        user_url = getattr(tree, "user_url", None)
2889
 
        if user_url is None:
2890
 
            display_url = str(tree)
2891
 
        else:
2892
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2837
        display_url = urlutils.unescape_for_display(
 
2838
            tree.user_url, 'ascii')
2893
2839
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2894
2840
 
2895
2841
 
2896
 
class StoringUncommittedNotSupported(BzrError):
2897
 
 
2898
 
    _fmt = ('Branch "%(display_url)s" does not support storing uncommitted'
2899
 
            ' changes.')
2900
 
 
2901
 
    def __init__(self, branch):
2902
 
        import bzrlib.urlutils as urlutils
2903
 
        user_url = getattr(branch, "user_url", None)
2904
 
        if user_url is None:
2905
 
            display_url = str(branch)
2906
 
        else:
2907
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
2908
 
        BzrError.__init__(self, branch=branch, display_url=display_url)
2909
 
 
2910
 
 
2911
 
class ShelvedChanges(UncommittedChanges):
2912
 
 
2913
 
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
2914
 
            ' (See bzr shelve --list).%(more)s')
2915
 
 
2916
 
 
2917
2842
class MissingTemplateVariable(BzrError):
2918
2843
 
2919
2844
    _fmt = 'Variable {%(name)s} is not available.'
2985
2910
        from bzrlib.osutils import get_user_encoding
2986
2911
        self.path = path
2987
2912
        self.kind = kind
2988
 
        self.user_encoding = get_user_encoding()
2989
 
 
2990
 
 
2991
 
class NoSuchConfig(BzrError):
2992
 
 
2993
 
    _fmt = ('The "%(config_id)s" configuration does not exist.')
2994
 
 
2995
 
    def __init__(self, config_id):
2996
 
        BzrError.__init__(self, config_id=config_id)
2997
 
 
2998
 
 
2999
 
class NoSuchConfigOption(BzrError):
3000
 
 
3001
 
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
3002
 
 
3003
 
    def __init__(self, option_name):
3004
 
        BzrError.__init__(self, option_name=option_name)
 
2913
        self.user_encoding = osutils.get_user_encoding()
3005
2914
 
3006
2915
 
3007
2916
class NoSuchAlias(BzrError):
3052
2961
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
3053
2962
 
3054
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
 
3055
2989
class TipChangeRejected(BzrError):
3056
2990
    """A pre_change_branch_tip hook function may raise this to cleanly and
3057
2991
    explicitly abort a change to a branch tip.
3068
3002
    _fmt = "Shelf corrupt."
3069
3003
 
3070
3004
 
3071
 
class DecompressCorruption(BzrError):
3072
 
 
3073
 
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
3074
 
 
3075
 
    def __init__(self, orig_error=None):
3076
 
        if orig_error is not None:
3077
 
            self.orig_error = ", %s" % (orig_error,)
3078
 
        else:
3079
 
            self.orig_error = ""
3080
 
        BzrError.__init__(self)
3081
 
 
3082
 
 
3083
3005
class NoSuchShelfId(BzrError):
3084
3006
 
3085
3007
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3212
3134
    def __init__(self, bzrdir):
3213
3135
        self.bzrdir = bzrdir
3214
3136
 
3215
 
 
3216
 
class NoWhoami(BzrError):
3217
 
 
3218
 
    _fmt = ('Unable to determine your name.\n'
3219
 
        "Please, set your name with the 'whoami' command.\n"
3220
 
        'E.g. bzr whoami "Your Name <name@example.com>"')
3221
 
 
3222
 
 
3223
 
class InvalidPattern(BzrError):
3224
 
 
3225
 
    _fmt = ('Invalid pattern(s) found. %(msg)s')
3226
 
 
3227
 
    def __init__(self, msg):
3228
 
        self.msg = msg
3229
 
 
3230
 
 
3231
 
class RecursiveBind(BzrError):
3232
 
 
3233
 
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3234
 
        'Please use `bzr unbind` to fix.')
3235
 
 
3236
 
    def __init__(self, branch_url):
3237
 
        self.branch_url = branch_url
3238
 
 
3239
 
 
3240
 
# FIXME: I would prefer to define the config related exception classes in
3241
 
# config.py but the lazy import mechanism proscribes this -- vila 20101222
3242
 
class OptionExpansionLoop(BzrError):
3243
 
 
3244
 
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
3245
 
 
3246
 
    def __init__(self, string, refs):
3247
 
        self.string = string
3248
 
        self.refs = '->'.join(refs)
3249
 
 
3250
 
 
3251
 
class ExpandingUnknownOption(BzrError):
3252
 
 
3253
 
    _fmt = 'Option "%(name)s" is not defined while expanding "%(string)s".'
3254
 
 
3255
 
    def __init__(self, name, string):
3256
 
        self.name = name
3257
 
        self.string = string
3258
 
 
3259
 
 
3260
 
class IllegalOptionName(BzrError):
3261
 
 
3262
 
    _fmt = 'Option "%(name)s" is not allowed.'
3263
 
 
3264
 
    def __init__(self, name):
3265
 
        self.name = name
3266
 
 
3267
 
 
3268
 
class NoCompatibleInter(BzrError):
3269
 
 
3270
 
    _fmt = ('No compatible object available for operations from %(source)r '
3271
 
            'to %(target)r.')
3272
 
 
3273
 
    def __init__(self, source, target):
3274
 
        self.source = source
3275
 
        self.target = target
3276
 
 
3277
 
 
3278
 
class HpssVfsRequestNotAllowed(BzrError):
3279
 
 
3280
 
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
3281
 
            "%(method)s, %(arguments)s.")
3282
 
 
3283
 
    def __init__(self, method, arguments):
3284
 
        self.method = method
3285
 
        self.arguments = arguments
3286
 
 
3287
 
 
3288
 
class UnsupportedKindChange(BzrError):
3289
 
 
3290
 
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
3291
 
            "%(path)s not supported by format %(format)r")
3292
 
 
3293
 
    def __init__(self, path, from_kind, to_kind, format):
3294
 
        self.path = path
3295
 
        self.from_kind = from_kind
3296
 
        self.to_kind = to_kind
3297
 
        self.format = format
3298
 
 
3299
 
 
3300
 
class MissingFeature(BzrError):
3301
 
 
3302
 
    _fmt = ("Missing feature %(feature)s not provided by this "
3303
 
            "version of Bazaar or any plugin.")
3304
 
 
3305
 
    def __init__(self, feature):
3306
 
        self.feature = feature
3307
 
 
3308
 
 
3309
 
class PatchSyntax(BzrError):
3310
 
    """Base class for patch syntax errors."""
3311
 
 
3312
 
 
3313
 
class BinaryFiles(BzrError):
3314
 
 
3315
 
    _fmt = 'Binary files section encountered.'
3316
 
 
3317
 
    def __init__(self, orig_name, mod_name):
3318
 
        self.orig_name = orig_name
3319
 
        self.mod_name = mod_name
3320
 
 
3321
 
 
3322
 
class MalformedPatchHeader(PatchSyntax):
3323
 
 
3324
 
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
3325
 
 
3326
 
    def __init__(self, desc, line):
3327
 
        self.desc = desc
3328
 
        self.line = line
3329
 
 
3330
 
 
3331
 
class MalformedHunkHeader(PatchSyntax):
3332
 
 
3333
 
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
3334
 
 
3335
 
    def __init__(self, desc, line):
3336
 
        self.desc = desc
3337
 
        self.line = line
3338
 
 
3339
 
 
3340
 
class MalformedLine(PatchSyntax):
3341
 
 
3342
 
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
3343
 
 
3344
 
    def __init__(self, desc, line):
3345
 
        self.desc = desc
3346
 
        self.line = line
3347
 
 
3348
 
 
3349
 
class PatchConflict(BzrError):
3350
 
 
3351
 
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
3352
 
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
3353
 
 
3354
 
    def __init__(self, line_no, orig_line, patch_line):
3355
 
        self.line_no = line_no
3356
 
        self.orig_line = orig_line.rstrip('\n')
3357
 
        self.patch_line = patch_line.rstrip('\n')
3358
 
 
3359
 
 
3360
 
class FeatureAlreadyRegistered(BzrError):
3361
 
 
3362
 
    _fmt = 'The feature %(feature)s has already been registered.'
3363
 
 
3364
 
    def __init__(self, feature):
3365
 
        self.feature = feature
3366
 
 
3367
 
 
3368
 
class ChangesAlreadyStored(BzrCommandError):
3369
 
 
3370
 
    _fmt = ('Cannot store uncommitted changes because this branch already'
3371
 
            ' stores uncommitted changes.')