~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Vincent Ladeuil
  • Date: 2017-01-17 13:48:10 UTC
  • mfrom: (6615.3.6 merges)
  • mto: This revision was merged to the branch mainline in revision 6620.
  • Revision ID: v.ladeuil+lp@free.fr-20170117134810-j9p3lidfy6pfyfsc
Merge 2.7, resolving conflicts

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2013, 2016 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
 
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 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
 
747
727
class BranchExistsWithoutWorkingTree(PathError):
748
728
 
749
729
    _fmt = 'Directory contains a branch, but no working tree \
778
758
        self.path = bzrdir.transport.clone('..').base
779
759
 
780
760
 
781
 
class FileInWrongBranch(BzrError):
782
 
 
783
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
784
 
 
785
 
    # use PathNotChild instead
786
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 3, 0)))
787
 
    def __init__(self, branch, path):
788
 
        BzrError.__init__(self)
789
 
        self.branch = branch
790
 
        self.branch_base = branch.base
791
 
        self.path = path
792
 
 
793
 
 
794
761
class UnsupportedFormatError(BzrError):
795
762
 
796
763
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
815
782
        self.bzrdir = bzrdir_format
816
783
 
817
784
 
 
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
 
818
797
class IncompatibleRepositories(BzrError):
819
798
    """Report an error that two repositories are not compatible.
820
799
 
852
831
        """Construct a new AlreadyVersionedError.
853
832
 
854
833
        :param path: This is the path which is versioned,
855
 
        which should be in a user friendly form.
 
834
            which should be in a user friendly form.
856
835
        :param context_info: If given, this is information about the context,
857
 
        which could explain why this is expected to not be versioned.
 
836
            which could explain why this is expected to not be versioned.
858
837
        """
859
838
        BzrError.__init__(self)
860
839
        self.path = path
873
852
        """Construct a new NotVersionedError.
874
853
 
875
854
        :param path: This is the path which is not versioned,
876
 
        which should be in a user friendly form.
 
855
            which should be in a user friendly form.
877
856
        :param context_info: If given, this is information about the context,
878
 
        which could explain why this is expected to be versioned.
 
857
            which could explain why this is expected to be versioned.
879
858
        """
880
859
        BzrError.__init__(self)
881
860
        self.path = path
1128
1107
        BzrError.__init__(self, files=files, files_str=files_str)
1129
1108
 
1130
1109
 
 
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
 
1131
1119
class BadCommitMessageEncoding(BzrError):
1132
1120
 
1133
1121
    _fmt = 'The specified commit message contains characters unsupported by '\
1200
1188
            self.extra = ''
1201
1189
 
1202
1190
 
1203
 
class HistoryMissing(BzrError):
1204
 
 
1205
 
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
1206
 
 
1207
 
 
1208
1191
class AppendRevisionsOnlyViolation(BzrError):
1209
1192
 
1210
1193
    _fmt = ('Operation denied because it would change the main history,'
1275
1258
            not_ancestor_id=not_ancestor_id)
1276
1259
 
1277
1260
 
1278
 
class AmbiguousBase(BzrError):
1279
 
 
1280
 
    def __init__(self, bases):
1281
 
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1282
 
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1283
 
        msg = ("The correct base is unclear, because %s are all equally close"
1284
 
                % ", ".join(bases))
1285
 
        BzrError.__init__(self, msg)
1286
 
        self.bases = bases
1287
 
 
1288
 
 
1289
1261
class NoCommits(BranchError):
1290
1262
 
1291
1263
    _fmt = "Branch %(branch)s has no commits."
1551
1523
            problem we can raise the original error (value from sys.exc_info())
1552
1524
        """
1553
1525
        BzrError.__init__(self)
 
1526
        self.context = context
1554
1527
        self.reload_occurred = reload_occurred
1555
1528
        self.exc_info = exc_info
1556
1529
        self.orig_error = exc_info[1]
1638
1611
 
1639
1612
    def __init__(self, exc_info):
1640
1613
        import traceback
 
1614
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1641
1615
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1642
1616
        self.exc_info = exc_info
1643
1617
        traceback_strings = traceback.format_exception(
1682
1656
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1683
1657
 
1684
1658
 
 
1659
class ConnectionTimeout(ConnectionError):
 
1660
 
 
1661
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1662
 
 
1663
 
1685
1664
class InvalidRange(TransportError):
1686
1665
 
1687
1666
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1694
1673
 
1695
1674
class InvalidHttpResponse(TransportError):
1696
1675
 
1697
 
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1676
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
1698
1677
 
1699
1678
    def __init__(self, path, msg, orig_error=None):
1700
1679
        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,)
1701
1686
        TransportError.__init__(self, msg, orig_error=orig_error)
1702
1687
 
1703
1688
 
1710
1695
        InvalidHttpResponse.__init__(self, path, msg)
1711
1696
 
1712
1697
 
 
1698
class HttpBoundaryMissing(InvalidHttpResponse):
 
1699
    """A multipart response ends with no boundary marker.
 
1700
 
 
1701
    This is a special case caused by buggy proxies, described in
 
1702
    <https://bugs.launchpad.net/bzr/+bug/198646>.
 
1703
    """
 
1704
 
 
1705
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
 
1706
 
 
1707
    def __init__(self, path, msg):
 
1708
        InvalidHttpResponse.__init__(self, path, msg)
 
1709
 
 
1710
 
1713
1711
class InvalidHttpContentType(InvalidHttpResponse):
1714
1712
 
1715
1713
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1743
1741
    _fmt = "Working tree has conflicts."
1744
1742
 
1745
1743
 
 
1744
class ConfigContentError(BzrError):
 
1745
 
 
1746
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
 
1747
 
 
1748
    def __init__(self, filename):
 
1749
        BzrError.__init__(self)
 
1750
        self.filename = filename
 
1751
 
 
1752
 
1746
1753
class ParseConfigError(BzrError):
1747
1754
 
 
1755
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
 
1756
 
1748
1757
    def __init__(self, errors, filename):
1749
 
        if filename is None:
1750
 
            filename = ""
1751
 
        message = "Error(s) parsing config file %s:\n%s" % \
1752
 
            (filename, ('\n'.join(e.msg for e in errors)))
1753
 
        BzrError.__init__(self, message)
 
1758
        BzrError.__init__(self)
 
1759
        self.filename = filename
 
1760
        self.errors = '\n'.join(e.msg for e in errors)
 
1761
 
 
1762
 
 
1763
class ConfigOptionValueError(BzrError):
 
1764
 
 
1765
    _fmt = ('Bad value "%(value)s" for option "%(name)s".\n'
 
1766
            'See ``bzr help %(name)s``')
 
1767
 
 
1768
    def __init__(self, name, value):
 
1769
        BzrError.__init__(self, name=name, value=value)
1754
1770
 
1755
1771
 
1756
1772
class NoEmailInUsername(BzrError):
1764
1780
 
1765
1781
class SigningFailed(BzrError):
1766
1782
 
1767
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1783
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
1768
1784
 
1769
1785
    def __init__(self, command_line):
1770
1786
        BzrError.__init__(self, command_line=command_line)
1771
1787
 
1772
1788
 
 
1789
class SignatureVerificationFailed(BzrError):
 
1790
 
 
1791
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
 
1792
 
 
1793
    def __init__(self, error):
 
1794
        BzrError.__init__(self, error=error)
 
1795
 
 
1796
 
 
1797
class DependencyNotPresent(BzrError):
 
1798
 
 
1799
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1800
 
 
1801
    def __init__(self, library, error):
 
1802
        BzrError.__init__(self, library=library, error=error)
 
1803
 
 
1804
 
 
1805
class GpgmeNotInstalled(DependencyNotPresent):
 
1806
 
 
1807
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
 
1808
 
 
1809
    def __init__(self, error):
 
1810
        DependencyNotPresent.__init__(self, 'gpgme', error)
 
1811
 
 
1812
 
1773
1813
class WorkingTreeNotRevision(BzrError):
1774
1814
 
1775
1815
    _fmt = ("The working tree for %(basedir)s has changed since"
1891
1931
        self.prefix = prefix
1892
1932
 
1893
1933
 
1894
 
class MalformedTransform(BzrError):
 
1934
class MalformedTransform(InternalBzrError):
1895
1935
 
1896
1936
    _fmt = "Tree transform is malformed %(conflicts)r"
1897
1937
 
1948
1988
 
1949
1989
class BzrMoveFailedError(BzrError):
1950
1990
 
1951
 
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1991
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
 
1992
        "%(_has_extra)s%(extra)s")
1952
1993
 
1953
1994
    def __init__(self, from_path='', to_path='', extra=None):
1954
1995
        from bzrlib.osutils import splitpath
1955
1996
        BzrError.__init__(self)
1956
1997
        if extra:
1957
 
            self.extra = ': ' + str(extra)
 
1998
            self.extra, self._has_extra = extra, ': '
1958
1999
        else:
1959
 
            self.extra = ''
 
2000
            self.extra = self._has_extra = ''
1960
2001
 
1961
2002
        has_from = len(from_path) > 0
1962
2003
        has_to = len(to_path) > 0
1983
2024
 
1984
2025
class BzrRenameFailedError(BzrMoveFailedError):
1985
2026
 
1986
 
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
2027
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
 
2028
        "%(_has_extra)s%(extra)s")
1987
2029
 
1988
2030
    def __init__(self, from_path, to_path, extra=None):
1989
2031
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1990
2032
 
1991
 
class BzrRemoveChangedFilesError(BzrError):
1992
 
    """Used when user is trying to remove changed files."""
1993
 
 
1994
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
1995
 
        "%(changes_as_text)s"
1996
 
        "Use --keep to not delete them, or --force to delete them regardless.")
1997
 
 
1998
 
    def __init__(self, tree_delta):
1999
 
        symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
2000
 
            "BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
2001
 
        BzrError.__init__(self)
2002
 
        self.changes_as_text = tree_delta.get_changes_as_text()
2003
 
        #self.paths_as_string = '\n'.join(changed_files)
2004
 
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
2005
 
 
2006
2033
 
2007
2034
class BzrBadParameterNotString(BzrBadParameter):
2008
2035
 
2011
2038
 
2012
2039
class BzrBadParameterMissing(BzrBadParameter):
2013
2040
 
2014
 
    _fmt = "Parameter $(param)s is required but not present."
 
2041
    _fmt = "Parameter %(param)s is required but not present."
2015
2042
 
2016
2043
 
2017
2044
class BzrBadParameterUnicode(BzrBadParameter):
2025
2052
    _fmt = "Parameter %(param)s contains a newline."
2026
2053
 
2027
2054
 
2028
 
class DependencyNotPresent(BzrError):
2029
 
 
2030
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
2031
 
 
2032
 
    def __init__(self, library, error):
2033
 
        BzrError.__init__(self, library=library, error=error)
2034
 
 
2035
 
 
2036
2055
class ParamikoNotPresent(DependencyNotPresent):
2037
2056
 
2038
2057
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2273
2292
    """
2274
2293
 
2275
2294
 
 
2295
class GhostTagsNotSupported(BzrError):
 
2296
 
 
2297
    _fmt = "Ghost tags not supported by format %(format)r."
 
2298
 
 
2299
    def __init__(self, format):
 
2300
        self.format = format
 
2301
 
 
2302
 
2276
2303
class BinaryFile(BzrError):
2277
2304
 
2278
2305
    _fmt = "File is binary but should be text."
2641
2668
 
2642
2669
    This is distinct from ErrorFromSmartServer so that it is possible to
2643
2670
    distinguish between the following two cases:
2644
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2645
 
        and so should provoke a traceback to the user.
2646
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2647
 
        translated.  This is probably because the server sent us garbage, and
2648
 
        should not provoke a traceback.
 
2671
 
 
2672
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2673
      and so should provoke a traceback to the user.
 
2674
    - ErrorFromSmartServer was caught but its error_tuple could not be
 
2675
      translated.  This is probably because the server sent us garbage, and
 
2676
      should not provoke a traceback.
2649
2677
    """
2650
2678
 
2651
2679
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2707
2735
    _fmt = "Container has multiple records with the same name: %(name)s"
2708
2736
 
2709
2737
    def __init__(self, name):
2710
 
        self.name = name
 
2738
        self.name = name.decode("utf-8")
2711
2739
 
2712
2740
 
2713
2741
class NoDestinationAddress(InternalBzrError):
2741
2769
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2742
2770
 
2743
2771
 
2744
 
class UnknownMailClient(BzrError):
2745
 
 
2746
 
    _fmt = "Unknown mail client: %(mail_client)s"
2747
 
 
2748
 
    def __init__(self, mail_client):
2749
 
        BzrError.__init__(self, mail_client=mail_client)
2750
 
 
2751
 
 
2752
2772
class MailClientNotFound(BzrError):
2753
2773
 
2754
2774
    _fmt = "Unable to find mail client with the following names:"\
2865
2885
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2866
2886
 
2867
2887
 
 
2888
class StoringUncommittedNotSupported(BzrError):
 
2889
 
 
2890
    _fmt = ('Branch "%(display_url)s" does not support storing uncommitted'
 
2891
            ' changes.')
 
2892
 
 
2893
    def __init__(self, branch):
 
2894
        import bzrlib.urlutils as urlutils
 
2895
        user_url = getattr(branch, "user_url", None)
 
2896
        if user_url is None:
 
2897
            display_url = str(branch)
 
2898
        else:
 
2899
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2900
        BzrError.__init__(self, branch=branch, display_url=display_url)
 
2901
 
 
2902
 
2868
2903
class ShelvedChanges(UncommittedChanges):
2869
2904
 
2870
2905
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
2942
2977
        from bzrlib.osutils import get_user_encoding
2943
2978
        self.path = path
2944
2979
        self.kind = kind
2945
 
        self.user_encoding = osutils.get_user_encoding()
 
2980
        self.user_encoding = get_user_encoding()
 
2981
 
 
2982
 
 
2983
class NoSuchConfig(BzrError):
 
2984
 
 
2985
    _fmt = ('The "%(config_id)s" configuration does not exist.')
 
2986
 
 
2987
    def __init__(self, config_id):
 
2988
        BzrError.__init__(self, config_id=config_id)
 
2989
 
 
2990
 
 
2991
class NoSuchConfigOption(BzrError):
 
2992
 
 
2993
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
 
2994
 
 
2995
    def __init__(self, option_name):
 
2996
        BzrError.__init__(self, option_name=option_name)
2946
2997
 
2947
2998
 
2948
2999
class NoSuchAlias(BzrError):
2993
3044
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
2994
3045
 
2995
3046
 
2996
 
class HookFailed(BzrError):
2997
 
    """Raised when a pre_change_branch_tip hook function fails anything other
2998
 
    than TipChangeRejected.
2999
 
 
3000
 
    Note that this exception is no longer raised, and the import is only left
3001
 
    to be nice to code which might catch it in a plugin.
3002
 
    """
3003
 
 
3004
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
3005
 
            "%(traceback_text)s%(exc_value)s")
3006
 
 
3007
 
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
3008
 
        if warn:
3009
 
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
3010
 
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
3011
 
        import traceback
3012
 
        self.hook_stage = hook_stage
3013
 
        self.hook_name = hook_name
3014
 
        self.exc_info = exc_info
3015
 
        self.exc_type = exc_info[0]
3016
 
        self.exc_value = exc_info[1]
3017
 
        self.exc_tb = exc_info[2]
3018
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
3019
 
 
3020
 
 
3021
3047
class TipChangeRejected(BzrError):
3022
3048
    """A pre_change_branch_tip hook function may raise this to cleanly and
3023
3049
    explicitly abort a change to a branch tip.
3034
3060
    _fmt = "Shelf corrupt."
3035
3061
 
3036
3062
 
 
3063
class DecompressCorruption(BzrError):
 
3064
 
 
3065
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
 
3066
 
 
3067
    def __init__(self, orig_error=None):
 
3068
        if orig_error is not None:
 
3069
            self.orig_error = ", %s" % (orig_error,)
 
3070
        else:
 
3071
            self.orig_error = ""
 
3072
        BzrError.__init__(self)
 
3073
 
 
3074
 
3037
3075
class NoSuchShelfId(BzrError):
3038
3076
 
3039
3077
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3190
3228
    def __init__(self, branch_url):
3191
3229
        self.branch_url = branch_url
3192
3230
 
 
3231
 
 
3232
# FIXME: I would prefer to define the config related exception classes in
 
3233
# config.py but the lazy import mechanism proscribes this -- vila 20101222
 
3234
class OptionExpansionLoop(BzrError):
 
3235
 
 
3236
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
 
3237
 
 
3238
    def __init__(self, string, refs):
 
3239
        self.string = string
 
3240
        self.refs = '->'.join(refs)
 
3241
 
 
3242
 
 
3243
class ExpandingUnknownOption(BzrError):
 
3244
 
 
3245
    _fmt = 'Option "%(name)s" is not defined while expanding "%(string)s".'
 
3246
 
 
3247
    def __init__(self, name, string):
 
3248
        self.name = name
 
3249
        self.string = string
 
3250
 
 
3251
 
 
3252
class IllegalOptionName(BzrError):
 
3253
 
 
3254
    _fmt = 'Option "%(name)s" is not allowed.'
 
3255
 
 
3256
    def __init__(self, name):
 
3257
        self.name = name
 
3258
 
 
3259
 
 
3260
class NoCompatibleInter(BzrError):
 
3261
 
 
3262
    _fmt = ('No compatible object available for operations from %(source)r '
 
3263
            'to %(target)r.')
 
3264
 
 
3265
    def __init__(self, source, target):
 
3266
        self.source = source
 
3267
        self.target = target
 
3268
 
 
3269
 
 
3270
class HpssVfsRequestNotAllowed(BzrError):
 
3271
 
 
3272
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
 
3273
            "%(method)s, %(arguments)s.")
 
3274
 
 
3275
    def __init__(self, method, arguments):
 
3276
        self.method = method
 
3277
        self.arguments = arguments
 
3278
 
 
3279
 
 
3280
class UnsupportedKindChange(BzrError):
 
3281
 
 
3282
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
 
3283
            "%(path)s not supported by format %(format)r")
 
3284
 
 
3285
    def __init__(self, path, from_kind, to_kind, format):
 
3286
        self.path = path
 
3287
        self.from_kind = from_kind
 
3288
        self.to_kind = to_kind
 
3289
        self.format = format
 
3290
 
 
3291
 
 
3292
class MissingFeature(BzrError):
 
3293
 
 
3294
    _fmt = ("Missing feature %(feature)s not provided by this "
 
3295
            "version of Bazaar or any plugin.")
 
3296
 
 
3297
    def __init__(self, feature):
 
3298
        self.feature = feature
 
3299
 
 
3300
 
 
3301
class PatchSyntax(BzrError):
 
3302
    """Base class for patch syntax errors."""
 
3303
 
 
3304
 
 
3305
class BinaryFiles(BzrError):
 
3306
 
 
3307
    _fmt = 'Binary files section encountered.'
 
3308
 
 
3309
    def __init__(self, orig_name, mod_name):
 
3310
        self.orig_name = orig_name
 
3311
        self.mod_name = mod_name
 
3312
 
 
3313
 
 
3314
class MalformedPatchHeader(PatchSyntax):
 
3315
 
 
3316
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
 
3317
 
 
3318
    def __init__(self, desc, line):
 
3319
        self.desc = desc
 
3320
        self.line = line
 
3321
 
 
3322
 
 
3323
class MalformedHunkHeader(PatchSyntax):
 
3324
 
 
3325
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
 
3326
 
 
3327
    def __init__(self, desc, line):
 
3328
        self.desc = desc
 
3329
        self.line = line
 
3330
 
 
3331
 
 
3332
class MalformedLine(PatchSyntax):
 
3333
 
 
3334
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
 
3335
 
 
3336
    def __init__(self, desc, line):
 
3337
        self.desc = desc
 
3338
        self.line = line
 
3339
 
 
3340
 
 
3341
class PatchConflict(BzrError):
 
3342
 
 
3343
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
 
3344
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
 
3345
 
 
3346
    def __init__(self, line_no, orig_line, patch_line):
 
3347
        self.line_no = line_no
 
3348
        self.orig_line = orig_line.rstrip('\n')
 
3349
        self.patch_line = patch_line.rstrip('\n')
 
3350
 
 
3351
 
 
3352
class FeatureAlreadyRegistered(BzrError):
 
3353
 
 
3354
    _fmt = 'The feature %(feature)s has already been registered.'
 
3355
 
 
3356
    def __init__(self, feature):
 
3357
        self.feature = feature
 
3358
 
 
3359
 
 
3360
class ChangesAlreadyStored(BzrCommandError):
 
3361
 
 
3362
    _fmt = ('Cannot store uncommitted changes because this branch already'
 
3363
            ' stores uncommitted changes.')