~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Ian Clatworthy
  • Date: 2009-09-09 15:30:59 UTC
  • mto: (4634.37.2 prepare-2.0)
  • mto: This revision was merged to the branch mainline in revision 4689.
  • Revision ID: ian.clatworthy@canonical.com-20090909153059-sb038agvd38ci2q8
more link fixes in the User Guide

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2013, 2016 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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)
651
702
# TODO: Probably this behavior of should be a common superclass
652
703
class NotBranchError(PathError):
653
704
 
654
 
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
 
705
    _fmt = 'Not a branch: "%(path)s".'
655
706
 
656
 
    def __init__(self, path, detail=None, bzrdir=None):
 
707
    def __init__(self, path):
657
708
       import bzrlib.urlutils as urlutils
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)
 
709
       self.path = urlutils.unescape_for_display(path, 'ascii')
692
710
 
693
711
 
694
712
class NoSubmitBranch(PathError):
700
718
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
701
719
 
702
720
 
703
 
class AlreadyControlDirError(PathError):
704
 
 
705
 
    _fmt = 'A control directory already exists: "%(path)s".'
706
 
 
707
 
 
708
721
class AlreadyBranchError(PathError):
709
722
 
710
723
    _fmt = 'Already a branch: "%(path)s".'
711
724
 
712
725
 
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
726
class BranchExistsWithoutWorkingTree(PathError):
728
727
 
729
728
    _fmt = 'Directory contains a branch, but no working tree \
758
757
        self.path = bzrdir.transport.clone('..').base
759
758
 
760
759
 
 
760
class FileInWrongBranch(BzrError):
 
761
 
 
762
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
763
 
 
764
    def __init__(self, branch, path):
 
765
        BzrError.__init__(self)
 
766
        self.branch = branch
 
767
        self.branch_base = branch.base
 
768
        self.path = path
 
769
 
 
770
 
761
771
class UnsupportedFormatError(BzrError):
762
772
 
763
773
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
782
792
        self.bzrdir = bzrdir_format
783
793
 
784
794
 
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
795
class IncompatibleRepositories(BzrError):
798
796
    """Report an error that two repositories are not compatible.
799
797
 
831
829
        """Construct a new AlreadyVersionedError.
832
830
 
833
831
        :param path: This is the path which is versioned,
834
 
            which should be in a user friendly form.
 
832
        which should be in a user friendly form.
835
833
        :param context_info: If given, this is information about the context,
836
 
            which could explain why this is expected to not be versioned.
 
834
        which could explain why this is expected to not be versioned.
837
835
        """
838
836
        BzrError.__init__(self)
839
837
        self.path = path
852
850
        """Construct a new NotVersionedError.
853
851
 
854
852
        :param path: This is the path which is not versioned,
855
 
            which should be in a user friendly form.
 
853
        which should be in a user friendly form.
856
854
        :param context_info: If given, this is information about the context,
857
 
            which could explain why this is expected to be versioned.
 
855
        which could explain why this is expected to be versioned.
858
856
        """
859
857
        BzrError.__init__(self)
860
858
        self.path = path
928
926
    # original exception is available as e.original_error
929
927
    #
930
928
    # New code should prefer to raise specific subclasses
931
 
    def __init__(self, msg):
932
 
        self.msg = msg
 
929
    def __init__(self, message):
 
930
        # Python 2.5 uses a slot for StandardError.message,
 
931
        # so use a different variable name.  We now work around this in
 
932
        # BzrError.__str__, but this member name is kept for compatability.
 
933
        self.msg = message
933
934
 
934
935
 
935
936
class LockActive(LockError):
1019
1020
class LockContention(LockError):
1020
1021
 
1021
1022
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
1023
    # TODO: show full url for lock, combining the transport and relative
 
1024
    # bits?
1022
1025
 
1023
1026
    internal_error = False
1024
1027
 
1051
1054
        self.target = target
1052
1055
 
1053
1056
 
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
1057
class LockNotHeld(LockError):
1067
1058
 
1068
1059
    _fmt = "Lock not held: %(lock)s"
1107
1098
        BzrError.__init__(self, files=files, files_str=files_str)
1108
1099
 
1109
1100
 
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
1101
class BadCommitMessageEncoding(BzrError):
1120
1102
 
1121
1103
    _fmt = 'The specified commit message contains characters unsupported by '\
1176
1158
 
1177
1159
class InvalidRevisionSpec(BzrError):
1178
1160
 
1179
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1180
 
            " %(branch_url)s%(extra)s")
 
1161
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1162
            " %(branch)s%(extra)s")
1181
1163
 
1182
1164
    def __init__(self, spec, branch, extra=None):
1183
1165
        BzrError.__init__(self, branch=branch, spec=spec)
1184
 
        self.branch_url = getattr(branch, 'user_url', str(branch))
1185
1166
        if extra:
1186
1167
            self.extra = '\n' + str(extra)
1187
1168
        else:
1188
1169
            self.extra = ''
1189
1170
 
1190
1171
 
 
1172
class HistoryMissing(BzrError):
 
1173
 
 
1174
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
1175
 
 
1176
 
1191
1177
class AppendRevisionsOnlyViolation(BzrError):
1192
1178
 
1193
1179
    _fmt = ('Operation denied because it would change the main history,'
1258
1244
            not_ancestor_id=not_ancestor_id)
1259
1245
 
1260
1246
 
 
1247
class AmbiguousBase(BzrError):
 
1248
 
 
1249
    def __init__(self, bases):
 
1250
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
1251
                DeprecationWarning)
 
1252
        msg = ("The correct base is unclear, because %s are all equally close"
 
1253
                % ", ".join(bases))
 
1254
        BzrError.__init__(self, msg)
 
1255
        self.bases = bases
 
1256
 
 
1257
 
1261
1258
class NoCommits(BranchError):
1262
1259
 
1263
1260
    _fmt = "Branch %(branch)s has no commits."
1279
1276
class BoundBranchOutOfDate(BzrError):
1280
1277
 
1281
1278
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1282
 
            " %(master)s.%(extra_help)s")
 
1279
            " %(master)s.")
1283
1280
 
1284
1281
    def __init__(self, branch, master):
1285
1282
        BzrError.__init__(self)
1286
1283
        self.branch = branch
1287
1284
        self.master = master
1288
 
        self.extra_help = ''
1289
1285
 
1290
1286
 
1291
1287
class CommitToDoubleBoundBranch(BzrError):
1362
1358
 
1363
1359
class WeaveParentMismatch(WeaveError):
1364
1360
 
1365
 
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
 
1361
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1366
1362
 
1367
1363
 
1368
1364
class WeaveInvalidChecksum(WeaveError):
1369
1365
 
1370
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1366
    _fmt = "Text did not match it's checksum: %(message)s"
1371
1367
 
1372
1368
 
1373
1369
class WeaveTextDiffers(WeaveError):
1421
1417
 
1422
1418
class VersionedFileInvalidChecksum(VersionedFileError):
1423
1419
 
1424
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1420
    _fmt = "Text did not match its checksum: %(message)s"
1425
1421
 
1426
1422
 
1427
1423
class KnitError(InternalBzrError):
1523
1519
            problem we can raise the original error (value from sys.exc_info())
1524
1520
        """
1525
1521
        BzrError.__init__(self)
1526
 
        self.context = context
1527
1522
        self.reload_occurred = reload_occurred
1528
1523
        self.exc_info = exc_info
1529
1524
        self.orig_error = exc_info[1]
1611
1606
 
1612
1607
    def __init__(self, exc_info):
1613
1608
        import traceback
1614
 
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1615
1609
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1616
1610
        self.exc_info = exc_info
1617
1611
        traceback_strings = traceback.format_exception(
1656
1650
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1657
1651
 
1658
1652
 
1659
 
class ConnectionTimeout(ConnectionError):
1660
 
 
1661
 
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
1662
 
 
1663
 
 
1664
1653
class InvalidRange(TransportError):
1665
1654
 
1666
1655
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1673
1662
 
1674
1663
class InvalidHttpResponse(TransportError):
1675
1664
 
1676
 
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1665
    _fmt = "Invalid http response for %(path)s: %(msg)s"
1677
1666
 
1678
1667
    def __init__(self, path, msg, orig_error=None):
1679
1668
        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
1669
        TransportError.__init__(self, msg, orig_error=orig_error)
1687
1670
 
1688
1671
 
1695
1678
        InvalidHttpResponse.__init__(self, path, msg)
1696
1679
 
1697
1680
 
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
 
 
1711
1681
class InvalidHttpContentType(InvalidHttpResponse):
1712
1682
 
1713
1683
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1741
1711
    _fmt = "Working tree has conflicts."
1742
1712
 
1743
1713
 
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
 
 
1753
1714
class ParseConfigError(BzrError):
1754
1715
 
1755
 
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
1756
 
 
1757
1716
    def __init__(self, errors, filename):
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)
 
1717
        if filename is None:
 
1718
            filename = ""
 
1719
        message = "Error(s) parsing config file %s:\n%s" % \
 
1720
            (filename, ('\n'.join(e.msg for e in errors)))
 
1721
        BzrError.__init__(self, message)
1770
1722
 
1771
1723
 
1772
1724
class NoEmailInUsername(BzrError):
1780
1732
 
1781
1733
class SigningFailed(BzrError):
1782
1734
 
1783
 
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
 
1735
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1784
1736
 
1785
1737
    def __init__(self, command_line):
1786
1738
        BzrError.__init__(self, command_line=command_line)
1787
1739
 
1788
1740
 
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
 
 
1813
1741
class WorkingTreeNotRevision(BzrError):
1814
1742
 
1815
1743
    _fmt = ("The working tree for %(basedir)s has changed since"
1931
1859
        self.prefix = prefix
1932
1860
 
1933
1861
 
1934
 
class MalformedTransform(InternalBzrError):
 
1862
class MalformedTransform(BzrError):
1935
1863
 
1936
1864
    _fmt = "Tree transform is malformed %(conflicts)r"
1937
1865
 
1975
1903
    _fmt = "Moving the root directory is not supported at this time"
1976
1904
 
1977
1905
 
1978
 
class TransformRenameFailed(BzrError):
1979
 
 
1980
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
1981
 
 
1982
 
    def __init__(self, from_path, to_path, why, errno):
1983
 
        self.from_path = from_path
1984
 
        self.to_path = to_path
1985
 
        self.why = why
1986
 
        self.errno = errno
1987
 
 
1988
 
 
1989
1906
class BzrMoveFailedError(BzrError):
1990
1907
 
1991
 
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
1992
 
        "%(_has_extra)s%(extra)s")
 
1908
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1993
1909
 
1994
1910
    def __init__(self, from_path='', to_path='', extra=None):
1995
1911
        from bzrlib.osutils import splitpath
1996
1912
        BzrError.__init__(self)
1997
1913
        if extra:
1998
 
            self.extra, self._has_extra = extra, ': '
 
1914
            self.extra = ': ' + str(extra)
1999
1915
        else:
2000
 
            self.extra = self._has_extra = ''
 
1916
            self.extra = ''
2001
1917
 
2002
1918
        has_from = len(from_path) > 0
2003
1919
        has_to = len(to_path) > 0
2024
1940
 
2025
1941
class BzrRenameFailedError(BzrMoveFailedError):
2026
1942
 
2027
 
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
2028
 
        "%(_has_extra)s%(extra)s")
 
1943
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
2029
1944
 
2030
1945
    def __init__(self, from_path, to_path, extra=None):
2031
1946
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2032
1947
 
 
1948
class BzrRemoveChangedFilesError(BzrError):
 
1949
    """Used when user is trying to remove changed files."""
 
1950
 
 
1951
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
1952
        "%(changes_as_text)s"
 
1953
        "Use --keep to not delete them, or --force to delete them regardless.")
 
1954
 
 
1955
    def __init__(self, tree_delta):
 
1956
        BzrError.__init__(self)
 
1957
        self.changes_as_text = tree_delta.get_changes_as_text()
 
1958
        #self.paths_as_string = '\n'.join(changed_files)
 
1959
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
1960
 
2033
1961
 
2034
1962
class BzrBadParameterNotString(BzrBadParameter):
2035
1963
 
2038
1966
 
2039
1967
class BzrBadParameterMissing(BzrBadParameter):
2040
1968
 
2041
 
    _fmt = "Parameter %(param)s is required but not present."
 
1969
    _fmt = "Parameter $(param)s is required but not present."
2042
1970
 
2043
1971
 
2044
1972
class BzrBadParameterUnicode(BzrBadParameter):
2052
1980
    _fmt = "Parameter %(param)s contains a newline."
2053
1981
 
2054
1982
 
 
1983
class DependencyNotPresent(BzrError):
 
1984
 
 
1985
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1986
 
 
1987
    def __init__(self, library, error):
 
1988
        BzrError.__init__(self, library=library, error=error)
 
1989
 
 
1990
 
2055
1991
class ParamikoNotPresent(DependencyNotPresent):
2056
1992
 
2057
1993
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2218
2154
 
2219
2155
    def __init__(self, repo):
2220
2156
        BzrError.__init__(self)
2221
 
        self.repo_path = repo.user_url
 
2157
        self.repo_path = repo.bzrdir.root_transport.base
2222
2158
 
2223
2159
 
2224
2160
class InconsistentDelta(BzrError):
2292
2228
    """
2293
2229
 
2294
2230
 
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
 
 
2303
2231
class BinaryFile(BzrError):
2304
2232
 
2305
2233
    _fmt = "File is binary but should be text."
2668
2596
 
2669
2597
    This is distinct from ErrorFromSmartServer so that it is possible to
2670
2598
    distinguish between the following two cases:
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.
 
2599
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2600
        and so should provoke a traceback to the user.
 
2601
      - ErrorFromSmartServer was caught but its error_tuple could not be
 
2602
        translated.  This is probably because the server sent us garbage, and
 
2603
        should not provoke a traceback.
2677
2604
    """
2678
2605
 
2679
2606
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2735
2662
    _fmt = "Container has multiple records with the same name: %(name)s"
2736
2663
 
2737
2664
    def __init__(self, name):
2738
 
        self.name = name.decode("utf-8")
 
2665
        self.name = name
2739
2666
 
2740
2667
 
2741
2668
class NoDestinationAddress(InternalBzrError):
2769
2696
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2770
2697
 
2771
2698
 
 
2699
class UnknownMailClient(BzrError):
 
2700
 
 
2701
    _fmt = "Unknown mail client: %(mail_client)s"
 
2702
 
 
2703
    def __init__(self, mail_client):
 
2704
        BzrError.__init__(self, mail_client=mail_client)
 
2705
 
 
2706
 
2772
2707
class MailClientNotFound(BzrError):
2773
2708
 
2774
2709
    _fmt = "Unable to find mail client with the following names:"\
2797
2732
 
2798
2733
    def __init__(self, bzrdir):
2799
2734
        import bzrlib.urlutils as urlutils
2800
 
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2735
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
2801
2736
                                                    'ascii')
2802
2737
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2803
2738
 
2877
2812
        else:
2878
2813
            more = ' ' + more
2879
2814
        import bzrlib.urlutils as urlutils
2880
 
        user_url = getattr(tree, "user_url", None)
2881
 
        if user_url is None:
2882
 
            display_url = str(tree)
2883
 
        else:
2884
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2815
        display_url = urlutils.unescape_for_display(
 
2816
            tree.bzrdir.root_transport.base, 'ascii')
2885
2817
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2886
2818
 
2887
2819
 
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
 
 
2903
 
class ShelvedChanges(UncommittedChanges):
2904
 
 
2905
 
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
2906
 
            ' (See bzr shelve --list).%(more)s')
2907
 
 
2908
 
 
2909
2820
class MissingTemplateVariable(BzrError):
2910
2821
 
2911
2822
    _fmt = 'Variable {%(name)s} is not available.'
2977
2888
        from bzrlib.osutils import get_user_encoding
2978
2889
        self.path = path
2979
2890
        self.kind = kind
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)
 
2891
        self.user_encoding = osutils.get_user_encoding()
2997
2892
 
2998
2893
 
2999
2894
class NoSuchAlias(BzrError):
3044
2939
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
3045
2940
 
3046
2941
 
 
2942
class HookFailed(BzrError):
 
2943
    """Raised when a pre_change_branch_tip hook function fails anything other
 
2944
    than TipChangeRejected.
 
2945
    """
 
2946
 
 
2947
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
 
2948
            "%(traceback_text)s%(exc_value)s")
 
2949
 
 
2950
    def __init__(self, hook_stage, hook_name, exc_info):
 
2951
        import traceback
 
2952
        self.hook_stage = hook_stage
 
2953
        self.hook_name = hook_name
 
2954
        self.exc_info = exc_info
 
2955
        self.exc_type = exc_info[0]
 
2956
        self.exc_value = exc_info[1]
 
2957
        self.exc_tb = exc_info[2]
 
2958
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
 
2959
 
 
2960
 
3047
2961
class TipChangeRejected(BzrError):
3048
2962
    """A pre_change_branch_tip hook function may raise this to cleanly and
3049
2963
    explicitly abort a change to a branch tip.
3060
2974
    _fmt = "Shelf corrupt."
3061
2975
 
3062
2976
 
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
 
 
3075
2977
class NoSuchShelfId(BzrError):
3076
2978
 
3077
2979
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3173
3075
    def __init__(self, source_branch, target_branch):
3174
3076
        self.source_branch = source_branch
3175
3077
        self.target_branch = target_branch
3176
 
 
3177
 
 
3178
 
class NoRoundtrippingSupport(BzrError):
3179
 
 
3180
 
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
3181
 
            "%(target_branch)r.")
3182
 
 
3183
 
    internal_error = True
3184
 
 
3185
 
    def __init__(self, source_branch, target_branch):
3186
 
        self.source_branch = source_branch
3187
 
        self.target_branch = target_branch
3188
 
 
3189
 
 
3190
 
class FileTimestampUnavailable(BzrError):
3191
 
 
3192
 
    _fmt = "The filestamp for %(path)s is not available."
3193
 
 
3194
 
    internal_error = True
3195
 
 
3196
 
    def __init__(self, path):
3197
 
        self.path = path
3198
 
 
3199
 
 
3200
 
class NoColocatedBranchSupport(BzrError):
3201
 
 
3202
 
    _fmt = ("%(bzrdir)r does not support co-located branches.")
3203
 
 
3204
 
    def __init__(self, bzrdir):
3205
 
        self.bzrdir = bzrdir
3206
 
 
3207
 
 
3208
 
class NoWhoami(BzrError):
3209
 
 
3210
 
    _fmt = ('Unable to determine your name.\n'
3211
 
        "Please, set your name with the 'whoami' command.\n"
3212
 
        'E.g. bzr whoami "Your Name <name@example.com>"')
3213
 
 
3214
 
 
3215
 
class InvalidPattern(BzrError):
3216
 
 
3217
 
    _fmt = ('Invalid pattern(s) found. %(msg)s')
3218
 
 
3219
 
    def __init__(self, msg):
3220
 
        self.msg = msg
3221
 
 
3222
 
 
3223
 
class RecursiveBind(BzrError):
3224
 
 
3225
 
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3226
 
        'Please use `bzr unbind` to fix.')
3227
 
 
3228
 
    def __init__(self, branch_url):
3229
 
        self.branch_url = branch_url
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.')