~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-27 16:27:09 UTC
  • mto: This revision was merged to the branch mainline in revision 6449.
  • Revision ID: jelmer@samba.org-20120127162709-eq21rt2enb9giauw
Fix support for tree-reference unpacking in 2a.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 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
 
636
585
        self.url = url
637
586
 
638
587
 
 
588
class UnstackableLocationError(BzrError):
 
589
 
 
590
    _fmt = "The branch '%(branch_url)s' cannot be stacked on '%(target_url)s'."
 
591
 
 
592
    def __init__(self, branch_url, target_url):
 
593
        BzrError.__init__(self)
 
594
        self.branch_url = branch_url
 
595
        self.target_url = target_url
 
596
 
 
597
 
639
598
class UnstackableRepositoryFormat(BzrError):
640
599
 
641
600
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
670
629
 
671
630
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
672
631
 
673
 
    internal_error = True
 
632
    internal_error = False
674
633
 
675
634
    def __init__(self, path, base, extra=None):
676
635
        BzrError.__init__(self)
692
651
# TODO: Probably this behavior of should be a common superclass
693
652
class NotBranchError(PathError):
694
653
 
695
 
    _fmt = 'Not a branch: "%(path)s".'
 
654
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
696
655
 
697
 
    def __init__(self, path):
 
656
    def __init__(self, path, detail=None, bzrdir=None):
698
657
       import bzrlib.urlutils as urlutils
699
 
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
658
       path = urlutils.unescape_for_display(path, 'ascii')
 
659
       if detail is not None:
 
660
           detail = ': ' + detail
 
661
       self.detail = detail
 
662
       self.bzrdir = bzrdir
 
663
       PathError.__init__(self, path=path)
 
664
 
 
665
    def __repr__(self):
 
666
        return '<%s %r>' % (self.__class__.__name__, self.__dict__)
 
667
 
 
668
    def _format(self):
 
669
        # XXX: Ideally self.detail would be a property, but Exceptions in
 
670
        # Python 2.4 have to be old-style classes so properties don't work.
 
671
        # Instead we override _format.
 
672
        if self.detail is None:
 
673
            if self.bzrdir is not None:
 
674
                try:
 
675
                    self.bzrdir.open_repository()
 
676
                except NoRepositoryPresent:
 
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 = ''
 
687
                else:
 
688
                    self.detail = ': location is a repository'
 
689
            else:
 
690
                self.detail = ''
 
691
        return PathError._format(self)
700
692
 
701
693
 
702
694
class NoSubmitBranch(PathError):
747
739
        self.path = bzrdir.transport.clone('..').base
748
740
 
749
741
 
750
 
class FileInWrongBranch(BzrError):
751
 
 
752
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
753
 
 
754
 
    def __init__(self, branch, path):
755
 
        BzrError.__init__(self)
756
 
        self.branch = branch
757
 
        self.branch_base = branch.base
758
 
        self.path = path
759
 
 
760
 
 
761
742
class UnsupportedFormatError(BzrError):
762
743
 
763
744
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
782
763
        self.bzrdir = bzrdir_format
783
764
 
784
765
 
 
766
class ParseFormatError(BzrError):
 
767
 
 
768
    _fmt = "Parse error on line %(lineno)d of %(format)s format: %(line)s"
 
769
 
 
770
    def __init__(self, format, lineno, line, text):
 
771
        BzrError.__init__(self)
 
772
        self.format = format
 
773
        self.lineno = lineno
 
774
        self.line = line
 
775
        self.text = text
 
776
 
 
777
 
785
778
class IncompatibleRepositories(BzrError):
 
779
    """Report an error that two repositories are not compatible.
 
780
 
 
781
    Note that the source and target repositories are permitted to be strings:
 
782
    this exception is thrown from the smart server and may refer to a
 
783
    repository the client hasn't opened.
 
784
    """
786
785
 
787
786
    _fmt = "%(target)s\n" \
788
787
            "is not compatible with\n" \
813
812
        """Construct a new AlreadyVersionedError.
814
813
 
815
814
        :param path: This is the path which is versioned,
816
 
        which should be in a user friendly form.
 
815
            which should be in a user friendly form.
817
816
        :param context_info: If given, this is information about the context,
818
 
        which could explain why this is expected to not be versioned.
 
817
            which could explain why this is expected to not be versioned.
819
818
        """
820
819
        BzrError.__init__(self)
821
820
        self.path = path
834
833
        """Construct a new NotVersionedError.
835
834
 
836
835
        :param path: This is the path which is not versioned,
837
 
        which should be in a user friendly form.
 
836
            which should be in a user friendly form.
838
837
        :param context_info: If given, this is information about the context,
839
 
        which could explain why this is expected to be versioned.
 
838
            which could explain why this is expected to be versioned.
840
839
        """
841
840
        BzrError.__init__(self)
842
841
        self.path = path
910
909
    # original exception is available as e.original_error
911
910
    #
912
911
    # New code should prefer to raise specific subclasses
913
 
    def __init__(self, message):
914
 
        # Python 2.5 uses a slot for StandardError.message,
915
 
        # so use a different variable name.  We now work around this in
916
 
        # BzrError.__str__, but this member name is kept for compatability.
917
 
        self.msg = message
 
912
    def __init__(self, msg):
 
913
        self.msg = msg
918
914
 
919
915
 
920
916
class LockActive(LockError):
1004
1000
class LockContention(LockError):
1005
1001
 
1006
1002
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
1007
 
    # TODO: show full url for lock, combining the transport and relative
1008
 
    # bits?
1009
1003
 
1010
1004
    internal_error = False
1011
1005
 
1038
1032
        self.target = target
1039
1033
 
1040
1034
 
 
1035
class LockCorrupt(LockError):
 
1036
 
 
1037
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
 
1038
            "Use 'bzr break-lock' to clear it")
 
1039
 
 
1040
    internal_error = False
 
1041
 
 
1042
    def __init__(self, corruption_info, file_data=None):
 
1043
        self.corruption_info = corruption_info
 
1044
        self.file_data = file_data
 
1045
 
 
1046
 
1041
1047
class LockNotHeld(LockError):
1042
1048
 
1043
1049
    _fmt = "Lock not held: %(lock)s"
1082
1088
        BzrError.__init__(self, files=files, files_str=files_str)
1083
1089
 
1084
1090
 
 
1091
class ExcludesUnsupported(BzrError):
 
1092
 
 
1093
    _fmt = ('Excluding paths during commit is not supported by '
 
1094
            'repository at %(repository)r.')
 
1095
 
 
1096
    def __init__(self, repository):
 
1097
        BzrError.__init__(self, repository=repository)
 
1098
 
 
1099
 
1085
1100
class BadCommitMessageEncoding(BzrError):
1086
1101
 
1087
1102
    _fmt = 'The specified commit message contains characters unsupported by '\
1142
1157
 
1143
1158
class InvalidRevisionSpec(BzrError):
1144
1159
 
1145
 
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
1146
 
            " %(branch)s%(extra)s")
 
1160
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1161
            " %(branch_url)s%(extra)s")
1147
1162
 
1148
1163
    def __init__(self, spec, branch, extra=None):
1149
1164
        BzrError.__init__(self, branch=branch, spec=spec)
 
1165
        self.branch_url = getattr(branch, 'user_url', str(branch))
1150
1166
        if extra:
1151
1167
            self.extra = '\n' + str(extra)
1152
1168
        else:
1153
1169
            self.extra = ''
1154
1170
 
1155
1171
 
1156
 
class HistoryMissing(BzrError):
1157
 
 
1158
 
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
1159
 
 
1160
 
 
1161
1172
class AppendRevisionsOnlyViolation(BzrError):
1162
1173
 
1163
1174
    _fmt = ('Operation denied because it would change the main history,'
1228
1239
            not_ancestor_id=not_ancestor_id)
1229
1240
 
1230
1241
 
1231
 
class AmbiguousBase(BzrError):
1232
 
 
1233
 
    def __init__(self, bases):
1234
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1235
 
                DeprecationWarning)
1236
 
        msg = ("The correct base is unclear, because %s are all equally close"
1237
 
                % ", ".join(bases))
1238
 
        BzrError.__init__(self, msg)
1239
 
        self.bases = bases
1240
 
 
1241
 
 
1242
1242
class NoCommits(BranchError):
1243
1243
 
1244
1244
    _fmt = "Branch %(branch)s has no commits."
1260
1260
class BoundBranchOutOfDate(BzrError):
1261
1261
 
1262
1262
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1263
 
            " %(master)s.")
 
1263
            " %(master)s.%(extra_help)s")
1264
1264
 
1265
1265
    def __init__(self, branch, master):
1266
1266
        BzrError.__init__(self)
1267
1267
        self.branch = branch
1268
1268
        self.master = master
 
1269
        self.extra_help = ''
1269
1270
 
1270
1271
 
1271
1272
class CommitToDoubleBoundBranch(BzrError):
1342
1343
 
1343
1344
class WeaveParentMismatch(WeaveError):
1344
1345
 
1345
 
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1346
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
1346
1347
 
1347
1348
 
1348
1349
class WeaveInvalidChecksum(WeaveError):
1349
1350
 
1350
 
    _fmt = "Text did not match it's checksum: %(message)s"
 
1351
    _fmt = "Text did not match its checksum: %(msg)s"
1351
1352
 
1352
1353
 
1353
1354
class WeaveTextDiffers(WeaveError):
1401
1402
 
1402
1403
class VersionedFileInvalidChecksum(VersionedFileError):
1403
1404
 
1404
 
    _fmt = "Text did not match its checksum: %(message)s"
 
1405
    _fmt = "Text did not match its checksum: %(msg)s"
1405
1406
 
1406
1407
 
1407
1408
class KnitError(InternalBzrError):
1503
1504
            problem we can raise the original error (value from sys.exc_info())
1504
1505
        """
1505
1506
        BzrError.__init__(self)
 
1507
        self.context = context
1506
1508
        self.reload_occurred = reload_occurred
1507
1509
        self.exc_info = exc_info
1508
1510
        self.orig_error = exc_info[1]
1590
1592
 
1591
1593
    def __init__(self, exc_info):
1592
1594
        import traceback
 
1595
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1593
1596
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1594
1597
        self.exc_info = exc_info
1595
1598
        traceback_strings = traceback.format_exception(
1634
1637
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1635
1638
 
1636
1639
 
 
1640
class ConnectionTimeout(ConnectionError):
 
1641
 
 
1642
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1643
 
 
1644
 
1637
1645
class InvalidRange(TransportError):
1638
1646
 
1639
1647
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1646
1654
 
1647
1655
class InvalidHttpResponse(TransportError):
1648
1656
 
1649
 
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1657
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
1650
1658
 
1651
1659
    def __init__(self, path, msg, orig_error=None):
1652
1660
        self.path = path
 
1661
        if orig_error is None:
 
1662
            orig_error = ''
 
1663
        else:
 
1664
            # This is reached for obscure and unusual errors so we want to
 
1665
            # preserve as much info as possible to ease debug.
 
1666
            orig_error = ': %r' % (orig_error,)
1653
1667
        TransportError.__init__(self, msg, orig_error=orig_error)
1654
1668
 
1655
1669
 
1662
1676
        InvalidHttpResponse.__init__(self, path, msg)
1663
1677
 
1664
1678
 
 
1679
class HttpBoundaryMissing(InvalidHttpResponse):
 
1680
    """A multipart response ends with no boundary marker.
 
1681
 
 
1682
    This is a special case caused by buggy proxies, described in
 
1683
    <https://bugs.launchpad.net/bzr/+bug/198646>.
 
1684
    """
 
1685
 
 
1686
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
 
1687
 
 
1688
    def __init__(self, path, msg):
 
1689
        InvalidHttpResponse.__init__(self, path, msg)
 
1690
 
 
1691
 
1665
1692
class InvalidHttpContentType(InvalidHttpResponse):
1666
1693
 
1667
1694
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1695
1722
    _fmt = "Working tree has conflicts."
1696
1723
 
1697
1724
 
 
1725
class ConfigContentError(BzrError):
 
1726
 
 
1727
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
 
1728
 
 
1729
    def __init__(self, filename):
 
1730
        BzrError.__init__(self)
 
1731
        self.filename = filename
 
1732
 
 
1733
 
1698
1734
class ParseConfigError(BzrError):
1699
1735
 
 
1736
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
 
1737
 
1700
1738
    def __init__(self, errors, filename):
1701
 
        if filename is None:
1702
 
            filename = ""
1703
 
        message = "Error(s) parsing config file %s:\n%s" % \
1704
 
            (filename, ('\n'.join(e.msg for e in errors)))
1705
 
        BzrError.__init__(self, message)
 
1739
        BzrError.__init__(self)
 
1740
        self.filename = filename
 
1741
        self.errors = '\n'.join(e.msg for e in errors)
 
1742
 
 
1743
 
 
1744
class ConfigOptionValueError(BzrError):
 
1745
 
 
1746
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
1747
 
 
1748
    def __init__(self, name, value):
 
1749
        BzrError.__init__(self, name=name, value=value)
1706
1750
 
1707
1751
 
1708
1752
class NoEmailInUsername(BzrError):
1716
1760
 
1717
1761
class SigningFailed(BzrError):
1718
1762
 
1719
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1763
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
1720
1764
 
1721
1765
    def __init__(self, command_line):
1722
1766
        BzrError.__init__(self, command_line=command_line)
1723
1767
 
1724
1768
 
 
1769
class SignatureVerificationFailed(BzrError):
 
1770
 
 
1771
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
 
1772
 
 
1773
    def __init__(self, error):
 
1774
        BzrError.__init__(self, error=error)
 
1775
 
 
1776
 
 
1777
class DependencyNotPresent(BzrError):
 
1778
 
 
1779
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1780
 
 
1781
    def __init__(self, library, error):
 
1782
        BzrError.__init__(self, library=library, error=error)
 
1783
 
 
1784
 
 
1785
class GpgmeNotInstalled(DependencyNotPresent):
 
1786
 
 
1787
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
 
1788
 
 
1789
    def __init__(self, error):
 
1790
        DependencyNotPresent.__init__(self, 'gpgme', error)
 
1791
 
 
1792
 
1725
1793
class WorkingTreeNotRevision(BzrError):
1726
1794
 
1727
1795
    _fmt = ("The working tree for %(basedir)s has changed since"
1843
1911
        self.prefix = prefix
1844
1912
 
1845
1913
 
1846
 
class MalformedTransform(BzrError):
 
1914
class MalformedTransform(InternalBzrError):
1847
1915
 
1848
1916
    _fmt = "Tree transform is malformed %(conflicts)r"
1849
1917
 
1887
1955
    _fmt = "Moving the root directory is not supported at this time"
1888
1956
 
1889
1957
 
 
1958
class TransformRenameFailed(BzrError):
 
1959
 
 
1960
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
1961
 
 
1962
    def __init__(self, from_path, to_path, why, errno):
 
1963
        self.from_path = from_path
 
1964
        self.to_path = to_path
 
1965
        self.why = why
 
1966
        self.errno = errno
 
1967
 
 
1968
 
1890
1969
class BzrMoveFailedError(BzrError):
1891
1970
 
1892
 
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1971
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
 
1972
        "%(_has_extra)s%(extra)s")
1893
1973
 
1894
1974
    def __init__(self, from_path='', to_path='', extra=None):
1895
1975
        from bzrlib.osutils import splitpath
1896
1976
        BzrError.__init__(self)
1897
1977
        if extra:
1898
 
            self.extra = ': ' + str(extra)
 
1978
            self.extra, self._has_extra = extra, ': '
1899
1979
        else:
1900
 
            self.extra = ''
 
1980
            self.extra = self._has_extra = ''
1901
1981
 
1902
1982
        has_from = len(from_path) > 0
1903
1983
        has_to = len(to_path) > 0
1924
2004
 
1925
2005
class BzrRenameFailedError(BzrMoveFailedError):
1926
2006
 
1927
 
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
2007
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
 
2008
        "%(_has_extra)s%(extra)s")
1928
2009
 
1929
2010
    def __init__(self, from_path, to_path, extra=None):
1930
2011
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1931
2012
 
1932
 
class BzrRemoveChangedFilesError(BzrError):
1933
 
    """Used when user is trying to remove changed files."""
1934
 
 
1935
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
1936
 
        "%(changes_as_text)s"
1937
 
        "Use --keep to not delete them, or --force to delete them regardless.")
1938
 
 
1939
 
    def __init__(self, tree_delta):
1940
 
        BzrError.__init__(self)
1941
 
        self.changes_as_text = tree_delta.get_changes_as_text()
1942
 
        #self.paths_as_string = '\n'.join(changed_files)
1943
 
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
1944
 
 
1945
2013
 
1946
2014
class BzrBadParameterNotString(BzrBadParameter):
1947
2015
 
1950
2018
 
1951
2019
class BzrBadParameterMissing(BzrBadParameter):
1952
2020
 
1953
 
    _fmt = "Parameter $(param)s is required but not present."
 
2021
    _fmt = "Parameter %(param)s is required but not present."
1954
2022
 
1955
2023
 
1956
2024
class BzrBadParameterUnicode(BzrBadParameter):
1964
2032
    _fmt = "Parameter %(param)s contains a newline."
1965
2033
 
1966
2034
 
1967
 
class DependencyNotPresent(BzrError):
1968
 
 
1969
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1970
 
 
1971
 
    def __init__(self, library, error):
1972
 
        BzrError.__init__(self, library=library, error=error)
1973
 
 
1974
 
 
1975
2035
class ParamikoNotPresent(DependencyNotPresent):
1976
2036
 
1977
2037
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
1996
2056
 
1997
2057
class BadConversionTarget(BzrError):
1998
2058
 
1999
 
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
2059
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
2060
            "    %(problem)s"
2000
2061
 
2001
 
    def __init__(self, problem, format):
 
2062
    def __init__(self, problem, format, from_format=None):
2002
2063
        BzrError.__init__(self)
2003
2064
        self.problem = problem
2004
2065
        self.format = format
 
2066
        self.from_format = from_format or '(unspecified)'
2005
2067
 
2006
2068
 
2007
2069
class NoDiffFound(BzrError):
2083
2145
 
2084
2146
class OutOfDateTree(BzrError):
2085
2147
 
2086
 
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
2148
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
2087
2149
 
2088
 
    def __init__(self, tree):
 
2150
    def __init__(self, tree, more=None):
 
2151
        if more is None:
 
2152
            more = ''
 
2153
        else:
 
2154
            more = ' ' + more
2089
2155
        BzrError.__init__(self)
2090
2156
        self.tree = tree
 
2157
        self.more = more
2091
2158
 
2092
2159
 
2093
2160
class PublicBranchOutOfDate(BzrError):
2131
2198
 
2132
2199
    def __init__(self, repo):
2133
2200
        BzrError.__init__(self)
2134
 
        self.repo_path = repo.bzrdir.root_transport.base
 
2201
        self.repo_path = repo.user_url
2135
2202
 
2136
2203
 
2137
2204
class InconsistentDelta(BzrError):
2147
2214
        self.reason = reason
2148
2215
 
2149
2216
 
 
2217
class InconsistentDeltaDelta(InconsistentDelta):
 
2218
    """Used when we get a delta that is not valid."""
 
2219
 
 
2220
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
2221
            "\nreason: %(reason)s")
 
2222
 
 
2223
    def __init__(self, delta, reason):
 
2224
        BzrError.__init__(self)
 
2225
        self.delta = delta
 
2226
        self.reason = reason
 
2227
 
 
2228
 
2150
2229
class UpgradeRequired(BzrError):
2151
2230
 
2152
2231
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
2193
2272
    """
2194
2273
 
2195
2274
 
 
2275
class GhostTagsNotSupported(BzrError):
 
2276
 
 
2277
    _fmt = "Ghost tags not supported by format %(format)r."
 
2278
 
 
2279
    def __init__(self, format):
 
2280
        self.format = format
 
2281
 
 
2282
 
2196
2283
class BinaryFile(BzrError):
2197
2284
 
2198
2285
    _fmt = "File is binary but should be text."
2561
2648
 
2562
2649
    This is distinct from ErrorFromSmartServer so that it is possible to
2563
2650
    distinguish between the following two cases:
2564
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2565
 
        and so should provoke a traceback to the user.
2566
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2567
 
        translated.  This is probably because the server sent us garbage, and
2568
 
        should not provoke a traceback.
 
2651
 
 
2652
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2653
      and so should provoke a traceback to the user.
 
2654
    - ErrorFromSmartServer was caught but its error_tuple could not be
 
2655
      translated.  This is probably because the server sent us garbage, and
 
2656
      should not provoke a traceback.
2569
2657
    """
2570
2658
 
2571
2659
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2627
2715
    _fmt = "Container has multiple records with the same name: %(name)s"
2628
2716
 
2629
2717
    def __init__(self, name):
2630
 
        self.name = name
 
2718
        self.name = name.decode("utf-8")
2631
2719
 
2632
2720
 
2633
2721
class NoDestinationAddress(InternalBzrError):
2697
2785
 
2698
2786
    def __init__(self, bzrdir):
2699
2787
        import bzrlib.urlutils as urlutils
2700
 
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2788
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
2701
2789
                                                    'ascii')
2702
2790
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2703
2791
 
2768
2856
 
2769
2857
class UncommittedChanges(BzrError):
2770
2858
 
2771
 
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
 
2859
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2860
            ' (See bzr status).%(more)s')
2772
2861
 
2773
 
    def __init__(self, tree):
 
2862
    def __init__(self, tree, more=None):
 
2863
        if more is None:
 
2864
            more = ''
 
2865
        else:
 
2866
            more = ' ' + more
2774
2867
        import bzrlib.urlutils as urlutils
2775
 
        display_url = urlutils.unescape_for_display(
2776
 
            tree.bzrdir.root_transport.base, 'ascii')
2777
 
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
2868
        user_url = getattr(tree, "user_url", None)
 
2869
        if user_url is None:
 
2870
            display_url = str(tree)
 
2871
        else:
 
2872
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2873
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2874
 
 
2875
 
 
2876
class ShelvedChanges(UncommittedChanges):
 
2877
 
 
2878
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2879
            ' (See bzr shelve --list).%(more)s')
2778
2880
 
2779
2881
 
2780
2882
class MissingTemplateVariable(BzrError):
2848
2950
        from bzrlib.osutils import get_user_encoding
2849
2951
        self.path = path
2850
2952
        self.kind = kind
2851
 
        self.user_encoding = osutils.get_user_encoding()
 
2953
        self.user_encoding = get_user_encoding()
 
2954
 
 
2955
 
 
2956
class NoSuchConfig(BzrError):
 
2957
 
 
2958
    _fmt = ('The "%(config_id)s" configuration does not exist.')
 
2959
 
 
2960
    def __init__(self, config_id):
 
2961
        BzrError.__init__(self, config_id=config_id)
 
2962
 
 
2963
 
 
2964
class NoSuchConfigOption(BzrError):
 
2965
 
 
2966
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
 
2967
 
 
2968
    def __init__(self, option_name):
 
2969
        BzrError.__init__(self, option_name=option_name)
2852
2970
 
2853
2971
 
2854
2972
class NoSuchAlias(BzrError):
2886
3004
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2887
3005
 
2888
3006
    def __init__(self, host, port, orig_error):
 
3007
        # nb: in python2.4 socket.error doesn't have a useful repr
2889
3008
        BzrError.__init__(self, host=host, port=port,
2890
 
            orig_error=orig_error[1])
 
3009
            orig_error=repr(orig_error.args))
2891
3010
 
2892
3011
 
2893
3012
class UnknownRules(BzrError):
2898
3017
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
2899
3018
 
2900
3019
 
2901
 
class HookFailed(BzrError):
2902
 
    """Raised when a pre_change_branch_tip hook function fails anything other
2903
 
    than TipChangeRejected.
2904
 
    """
2905
 
 
2906
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2907
 
            "%(traceback_text)s%(exc_value)s")
2908
 
 
2909
 
    def __init__(self, hook_stage, hook_name, exc_info):
2910
 
        import traceback
2911
 
        self.hook_stage = hook_stage
2912
 
        self.hook_name = hook_name
2913
 
        self.exc_info = exc_info
2914
 
        self.exc_type = exc_info[0]
2915
 
        self.exc_value = exc_info[1]
2916
 
        self.exc_tb = exc_info[2]
2917
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
2918
 
 
2919
 
 
2920
3020
class TipChangeRejected(BzrError):
2921
3021
    """A pre_change_branch_tip hook function may raise this to cleanly and
2922
3022
    explicitly abort a change to a branch tip.
2933
3033
    _fmt = "Shelf corrupt."
2934
3034
 
2935
3035
 
 
3036
class DecompressCorruption(BzrError):
 
3037
 
 
3038
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
 
3039
 
 
3040
    def __init__(self, orig_error=None):
 
3041
        if orig_error is not None:
 
3042
            self.orig_error = ", %s" % (orig_error,)
 
3043
        else:
 
3044
            self.orig_error = ""
 
3045
        BzrError.__init__(self)
 
3046
 
 
3047
 
2936
3048
class NoSuchShelfId(BzrError):
2937
3049
 
2938
3050
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3034
3146
    def __init__(self, source_branch, target_branch):
3035
3147
        self.source_branch = source_branch
3036
3148
        self.target_branch = target_branch
 
3149
 
 
3150
 
 
3151
class NoRoundtrippingSupport(BzrError):
 
3152
 
 
3153
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
3154
            "%(target_branch)r.")
 
3155
 
 
3156
    internal_error = True
 
3157
 
 
3158
    def __init__(self, source_branch, target_branch):
 
3159
        self.source_branch = source_branch
 
3160
        self.target_branch = target_branch
 
3161
 
 
3162
 
 
3163
class FileTimestampUnavailable(BzrError):
 
3164
 
 
3165
    _fmt = "The filestamp for %(path)s is not available."
 
3166
 
 
3167
    internal_error = True
 
3168
 
 
3169
    def __init__(self, path):
 
3170
        self.path = path
 
3171
 
 
3172
 
 
3173
class NoColocatedBranchSupport(BzrError):
 
3174
 
 
3175
    _fmt = ("%(bzrdir)r does not support co-located branches.")
 
3176
 
 
3177
    def __init__(self, bzrdir):
 
3178
        self.bzrdir = bzrdir
 
3179
 
 
3180
 
 
3181
class NoWhoami(BzrError):
 
3182
 
 
3183
    _fmt = ('Unable to determine your name.\n'
 
3184
        "Please, set your name with the 'whoami' command.\n"
 
3185
        'E.g. bzr whoami "Your Name <name@example.com>"')
 
3186
 
 
3187
 
 
3188
class InvalidPattern(BzrError):
 
3189
 
 
3190
    _fmt = ('Invalid pattern(s) found. %(msg)s')
 
3191
 
 
3192
    def __init__(self, msg):
 
3193
        self.msg = msg
 
3194
 
 
3195
 
 
3196
class RecursiveBind(BzrError):
 
3197
 
 
3198
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
 
3199
        'Please use `bzr unbind` to fix.')
 
3200
 
 
3201
    def __init__(self, branch_url):
 
3202
        self.branch_url = branch_url
 
3203
 
 
3204
 
 
3205
# FIXME: I would prefer to define the config related exception classes in
 
3206
# config.py but the lazy import mechanism proscribes this -- vila 20101222
 
3207
class OptionExpansionLoop(BzrError):
 
3208
 
 
3209
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
 
3210
 
 
3211
    def __init__(self, string, refs):
 
3212
        self.string = string
 
3213
        self.refs = '->'.join(refs)
 
3214
 
 
3215
 
 
3216
class ExpandingUnknownOption(BzrError):
 
3217
 
 
3218
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
 
3219
 
 
3220
    def __init__(self, name, string):
 
3221
        self.name = name
 
3222
        self.string = string
 
3223
 
 
3224
 
 
3225
class NoCompatibleInter(BzrError):
 
3226
 
 
3227
    _fmt = ('No compatible object available for operations from %(source)r '
 
3228
            'to %(target)r.')
 
3229
 
 
3230
    def __init__(self, source, target):
 
3231
        self.source = source
 
3232
        self.target = target
 
3233
 
 
3234
 
 
3235
class HpssVfsRequestNotAllowed(BzrError):
 
3236
 
 
3237
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
 
3238
            "%(method)s, %(arguments)s.")
 
3239
 
 
3240
    def __init__(self, method, arguments):
 
3241
        self.method = method
 
3242
        self.arguments = arguments
 
3243
 
 
3244
 
 
3245
class UnsupportedKindChange(BzrError):
 
3246
 
 
3247
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
 
3248
            "%(path)s not supported by format %(format)r")
 
3249
 
 
3250
    def __init__(self, path, from_kind, to_kind, format):
 
3251
        self.path = path
 
3252
        self.from_kind = from_kind
 
3253
        self.to_kind = to_kind
 
3254
        self.format = format
 
3255
 
 
3256
 
 
3257
class MissingFeature(BzrError):
 
3258
 
 
3259
    _fmt = ("Missing feature %(feature)s not provided by this "
 
3260
            "version of Bazaar or any plugin.")
 
3261
 
 
3262
    def __init__(self, feature):
 
3263
        self.feature = feature
 
3264
 
 
3265
 
 
3266
class PatchSyntax(BzrError):
 
3267
    """Base class for patch syntax errors."""
 
3268
 
 
3269
 
 
3270
class BinaryFiles(BzrError):
 
3271
 
 
3272
    _fmt = 'Binary files section encountered.'
 
3273
 
 
3274
    def __init__(self, orig_name, mod_name):
 
3275
        self.orig_name = orig_name
 
3276
        self.mod_name = mod_name
 
3277
 
 
3278
 
 
3279
class MalformedPatchHeader(PatchSyntax):
 
3280
 
 
3281
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
 
3282
 
 
3283
    def __init__(self, desc, line):
 
3284
        self.desc = desc
 
3285
        self.line = line
 
3286
 
 
3287
 
 
3288
class MalformedHunkHeader(PatchSyntax):
 
3289
 
 
3290
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
 
3291
 
 
3292
    def __init__(self, desc, line):
 
3293
        self.desc = desc
 
3294
        self.line = line
 
3295
 
 
3296
 
 
3297
class MalformedLine(PatchSyntax):
 
3298
 
 
3299
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
 
3300
 
 
3301
    def __init__(self, desc, line):
 
3302
        self.desc = desc
 
3303
        self.line = line
 
3304
 
 
3305
 
 
3306
class PatchConflict(BzrError):
 
3307
 
 
3308
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
 
3309
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
 
3310
 
 
3311
    def __init__(self, line_no, orig_line, patch_line):
 
3312
        self.line_no = line_no
 
3313
        self.orig_line = orig_line.rstrip('\n')
 
3314
        self.patch_line = patch_line.rstrip('\n')
 
3315
 
 
3316
 
 
3317
class FeatureAlreadyRegistered(BzrError):
 
3318
 
 
3319
    _fmt = 'The feature %(feature)s has already been registered.'
 
3320
 
 
3321
    def __init__(self, feature):
 
3322
        self.feature = feature