← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: John Arbash Meinel
  • Date: 2010-01-13 16:23:07 UTC
  • mto: (4634.119.7 2.0)
  • mto: This revision was merged to the branch mainline in revision 4959.
  • Revision ID: john@arbash-meinel.com-20100113162307-0bs82td16gzih827
Update the MANIFEST.in file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 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):
739
757
        self.path = bzrdir.transport.clone('..').base
740
758
 
741
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
 
742
771
class UnsupportedFormatError(BzrError):
743
772
 
744
773
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
800
829
        """Construct a new AlreadyVersionedError.
801
830
 
802
831
        :param path: This is the path which is versioned,
803
 
            which should be in a user friendly form.
 
832
        which should be in a user friendly form.
804
833
        :param context_info: If given, this is information about the context,
805
 
            which could explain why this is expected to not be versioned.
 
834
        which could explain why this is expected to not be versioned.
806
835
        """
807
836
        BzrError.__init__(self)
808
837
        self.path = path
821
850
        """Construct a new NotVersionedError.
822
851
 
823
852
        :param path: This is the path which is not versioned,
824
 
            which should be in a user friendly form.
 
853
        which should be in a user friendly form.
825
854
        :param context_info: If given, this is information about the context,
826
 
            which could explain why this is expected to be versioned.
 
855
        which could explain why this is expected to be versioned.
827
856
        """
828
857
        BzrError.__init__(self)
829
858
        self.path = path
897
926
    # original exception is available as e.original_error
898
927
    #
899
928
    # New code should prefer to raise specific subclasses
900
 
    def __init__(self, msg):
901
 
        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
902
934
 
903
935
 
904
936
class LockActive(LockError):
988
1020
class LockContention(LockError):
989
1021
 
990
1022
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
1023
    # TODO: show full url for lock, combining the transport and relative
 
1024
    # bits?
991
1025
 
992
1026
    internal_error = False
993
1027
 
1020
1054
        self.target = target
1021
1055
 
1022
1056
 
1023
 
class LockCorrupt(LockError):
1024
 
 
1025
 
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
1026
 
            "Use 'bzr break-lock' to clear it")
1027
 
 
1028
 
    internal_error = False
1029
 
 
1030
 
    def __init__(self, corruption_info, file_data=None):
1031
 
        self.corruption_info = corruption_info
1032
 
        self.file_data = file_data
1033
 
 
1034
 
 
1035
1057
class LockNotHeld(LockError):
1036
1058
 
1037
1059
    _fmt = "Lock not held: %(lock)s"
1076
1098
        BzrError.__init__(self, files=files, files_str=files_str)
1077
1099
 
1078
1100
 
1079
 
class ExcludesUnsupported(BzrError):
1080
 
 
1081
 
    _fmt = ('Excluding paths during commit is not supported by '
1082
 
            'repository at %(repository)r.')
1083
 
 
1084
 
    def __init__(self, repository):
1085
 
        BzrError.__init__(self, repository=repository)
1086
 
 
1087
 
 
1088
1101
class BadCommitMessageEncoding(BzrError):
1089
1102
 
1090
1103
    _fmt = 'The specified commit message contains characters unsupported by '\
1145
1158
 
1146
1159
class InvalidRevisionSpec(BzrError):
1147
1160
 
1148
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1149
 
            " %(branch_url)s%(extra)s")
 
1161
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1162
            " %(branch)s%(extra)s")
1150
1163
 
1151
1164
    def __init__(self, spec, branch, extra=None):
1152
1165
        BzrError.__init__(self, branch=branch, spec=spec)
1153
 
        self.branch_url = getattr(branch, 'user_url', str(branch))
1154
1166
        if extra:
1155
1167
            self.extra = '\n' + str(extra)
1156
1168
        else:
1157
1169
            self.extra = ''
1158
1170
 
1159
1171
 
 
1172
class HistoryMissing(BzrError):
 
1173
 
 
1174
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
1175
 
 
1176
 
1160
1177
class AppendRevisionsOnlyViolation(BzrError):
1161
1178
 
1162
1179
    _fmt = ('Operation denied because it would change the main history,'
1227
1244
            not_ancestor_id=not_ancestor_id)
1228
1245
 
1229
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
 
1230
1258
class NoCommits(BranchError):
1231
1259
 
1232
1260
    _fmt = "Branch %(branch)s has no commits."
1248
1276
class BoundBranchOutOfDate(BzrError):
1249
1277
 
1250
1278
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1251
 
            " %(master)s.%(extra_help)s")
 
1279
            " %(master)s.")
1252
1280
 
1253
1281
    def __init__(self, branch, master):
1254
1282
        BzrError.__init__(self)
1255
1283
        self.branch = branch
1256
1284
        self.master = master
1257
 
        self.extra_help = ''
1258
1285
 
1259
1286
 
1260
1287
class CommitToDoubleBoundBranch(BzrError):
1331
1358
 
1332
1359
class WeaveParentMismatch(WeaveError):
1333
1360
 
1334
 
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
 
1361
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1335
1362
 
1336
1363
 
1337
1364
class WeaveInvalidChecksum(WeaveError):
1338
1365
 
1339
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1366
    _fmt = "Text did not match it's checksum: %(message)s"
1340
1367
 
1341
1368
 
1342
1369
class WeaveTextDiffers(WeaveError):
1390
1417
 
1391
1418
class VersionedFileInvalidChecksum(VersionedFileError):
1392
1419
 
1393
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1420
    _fmt = "Text did not match its checksum: %(message)s"
1394
1421
 
1395
1422
 
1396
1423
class KnitError(InternalBzrError):
1492
1519
            problem we can raise the original error (value from sys.exc_info())
1493
1520
        """
1494
1521
        BzrError.__init__(self)
1495
 
        self.context = context
1496
1522
        self.reload_occurred = reload_occurred
1497
1523
        self.exc_info = exc_info
1498
1524
        self.orig_error = exc_info[1]
1580
1606
 
1581
1607
    def __init__(self, exc_info):
1582
1608
        import traceback
1583
 
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1584
1609
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1585
1610
        self.exc_info = exc_info
1586
1611
        traceback_strings = traceback.format_exception(
1625
1650
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1626
1651
 
1627
1652
 
1628
 
class ConnectionTimeout(ConnectionError):
1629
 
 
1630
 
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
1631
 
 
1632
 
 
1633
1653
class InvalidRange(TransportError):
1634
1654
 
1635
1655
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1642
1662
 
1643
1663
class InvalidHttpResponse(TransportError):
1644
1664
 
1645
 
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1665
    _fmt = "Invalid http response for %(path)s: %(msg)s"
1646
1666
 
1647
1667
    def __init__(self, path, msg, orig_error=None):
1648
1668
        self.path = path
1649
 
        if orig_error is None:
1650
 
            orig_error = ''
1651
 
        else:
1652
 
            # This is reached for obscure and unusual errors so we want to
1653
 
            # preserve as much info as possible to ease debug.
1654
 
            orig_error = ': %r' % (orig_error,)
1655
1669
        TransportError.__init__(self, msg, orig_error=orig_error)
1656
1670
 
1657
1671
 
1664
1678
        InvalidHttpResponse.__init__(self, path, msg)
1665
1679
 
1666
1680
 
1667
 
class HttpBoundaryMissing(InvalidHttpResponse):
1668
 
    """A multipart response ends with no boundary marker.
1669
 
 
1670
 
    This is a special case caused by buggy proxies, described in
1671
 
    <https://bugs.launchpad.net/bzr/+bug/198646>.
1672
 
    """
1673
 
 
1674
 
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
1675
 
 
1676
 
    def __init__(self, path, msg):
1677
 
        InvalidHttpResponse.__init__(self, path, msg)
1678
 
 
1679
 
 
1680
1681
class InvalidHttpContentType(InvalidHttpResponse):
1681
1682
 
1682
1683
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1710
1711
    _fmt = "Working tree has conflicts."
1711
1712
 
1712
1713
 
1713
 
class ConfigContentError(BzrError):
1714
 
 
1715
 
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
1716
 
 
1717
 
    def __init__(self, filename):
1718
 
        BzrError.__init__(self)
1719
 
        self.filename = filename
1720
 
 
1721
 
 
1722
1714
class ParseConfigError(BzrError):
1723
1715
 
1724
 
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
1725
 
 
1726
1716
    def __init__(self, errors, filename):
1727
 
        BzrError.__init__(self)
1728
 
        self.filename = filename
1729
 
        self.errors = '\n'.join(e.msg for e in errors)
1730
 
 
1731
 
 
1732
 
class ConfigOptionValueError(BzrError):
1733
 
 
1734
 
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
1735
 
 
1736
 
    def __init__(self, name, value):
1737
 
        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)
1738
1722
 
1739
1723
 
1740
1724
class NoEmailInUsername(BzrError):
1748
1732
 
1749
1733
class SigningFailed(BzrError):
1750
1734
 
1751
 
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
 
1735
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1752
1736
 
1753
1737
    def __init__(self, command_line):
1754
1738
        BzrError.__init__(self, command_line=command_line)
1755
1739
 
1756
1740
 
1757
 
class SignatureVerificationFailed(BzrError):
1758
 
 
1759
 
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
1760
 
 
1761
 
    def __init__(self, error):
1762
 
        BzrError.__init__(self, error=error)
1763
 
 
1764
 
 
1765
 
class DependencyNotPresent(BzrError):
1766
 
 
1767
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1768
 
 
1769
 
    def __init__(self, library, error):
1770
 
        BzrError.__init__(self, library=library, error=error)
1771
 
 
1772
 
 
1773
 
class GpgmeNotInstalled(DependencyNotPresent):
1774
 
 
1775
 
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
1776
 
 
1777
 
    def __init__(self, error):
1778
 
        DependencyNotPresent.__init__(self, 'gpgme', error)
1779
 
 
1780
 
 
1781
1741
class WorkingTreeNotRevision(BzrError):
1782
1742
 
1783
1743
    _fmt = ("The working tree for %(basedir)s has changed since"
1899
1859
        self.prefix = prefix
1900
1860
 
1901
1861
 
1902
 
class MalformedTransform(InternalBzrError):
 
1862
class MalformedTransform(BzrError):
1903
1863
 
1904
1864
    _fmt = "Tree transform is malformed %(conflicts)r"
1905
1865
 
1943
1903
    _fmt = "Moving the root directory is not supported at this time"
1944
1904
 
1945
1905
 
1946
 
class TransformRenameFailed(BzrError):
1947
 
 
1948
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
1949
 
 
1950
 
    def __init__(self, from_path, to_path, why, errno):
1951
 
        self.from_path = from_path
1952
 
        self.to_path = to_path
1953
 
        self.why = why
1954
 
        self.errno = errno
1955
 
 
1956
 
 
1957
1906
class BzrMoveFailedError(BzrError):
1958
1907
 
1959
 
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
1960
 
        "%(_has_extra)s%(extra)s")
 
1908
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1961
1909
 
1962
1910
    def __init__(self, from_path='', to_path='', extra=None):
1963
1911
        from bzrlib.osutils import splitpath
1964
1912
        BzrError.__init__(self)
1965
1913
        if extra:
1966
 
            self.extra, self._has_extra = extra, ': '
 
1914
            self.extra = ': ' + str(extra)
1967
1915
        else:
1968
 
            self.extra = self._has_extra = ''
 
1916
            self.extra = ''
1969
1917
 
1970
1918
        has_from = len(from_path) > 0
1971
1919
        has_to = len(to_path) > 0
1992
1940
 
1993
1941
class BzrRenameFailedError(BzrMoveFailedError):
1994
1942
 
1995
 
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
1996
 
        "%(_has_extra)s%(extra)s")
 
1943
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
1997
1944
 
1998
1945
    def __init__(self, from_path, to_path, extra=None):
1999
1946
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2000
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
 
2001
1961
 
2002
1962
class BzrBadParameterNotString(BzrBadParameter):
2003
1963
 
2006
1966
 
2007
1967
class BzrBadParameterMissing(BzrBadParameter):
2008
1968
 
2009
 
    _fmt = "Parameter %(param)s is required but not present."
 
1969
    _fmt = "Parameter $(param)s is required but not present."
2010
1970
 
2011
1971
 
2012
1972
class BzrBadParameterUnicode(BzrBadParameter):
2020
1980
    _fmt = "Parameter %(param)s contains a newline."
2021
1981
 
2022
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
 
2023
1991
class ParamikoNotPresent(DependencyNotPresent):
2024
1992
 
2025
1993
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2186
2154
 
2187
2155
    def __init__(self, repo):
2188
2156
        BzrError.__init__(self)
2189
 
        self.repo_path = repo.user_url
 
2157
        self.repo_path = repo.bzrdir.root_transport.base
2190
2158
 
2191
2159
 
2192
2160
class InconsistentDelta(BzrError):
2260
2228
    """
2261
2229
 
2262
2230
 
2263
 
class GhostTagsNotSupported(BzrError):
2264
 
 
2265
 
    _fmt = "Ghost tags not supported by format %(format)r."
2266
 
 
2267
 
    def __init__(self, format):
2268
 
        self.format = format
2269
 
 
2270
 
 
2271
2231
class BinaryFile(BzrError):
2272
2232
 
2273
2233
    _fmt = "File is binary but should be text."
2636
2596
 
2637
2597
    This is distinct from ErrorFromSmartServer so that it is possible to
2638
2598
    distinguish between the following two cases:
2639
 
 
2640
 
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
2641
 
      and so should provoke a traceback to the user.
2642
 
    - ErrorFromSmartServer was caught but its error_tuple could not be
2643
 
      translated.  This is probably because the server sent us garbage, and
2644
 
      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.
2645
2604
    """
2646
2605
 
2647
2606
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2703
2662
    _fmt = "Container has multiple records with the same name: %(name)s"
2704
2663
 
2705
2664
    def __init__(self, name):
2706
 
        self.name = name.decode("utf-8")
 
2665
        self.name = name
2707
2666
 
2708
2667
 
2709
2668
class NoDestinationAddress(InternalBzrError):
2773
2732
 
2774
2733
    def __init__(self, bzrdir):
2775
2734
        import bzrlib.urlutils as urlutils
2776
 
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2735
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
2777
2736
                                                    'ascii')
2778
2737
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2779
2738
 
2853
2812
        else:
2854
2813
            more = ' ' + more
2855
2814
        import bzrlib.urlutils as urlutils
2856
 
        user_url = getattr(tree, "user_url", None)
2857
 
        if user_url is None:
2858
 
            display_url = str(tree)
2859
 
        else:
2860
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2815
        display_url = urlutils.unescape_for_display(
 
2816
            tree.bzrdir.root_transport.base, 'ascii')
2861
2817
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2862
2818
 
2863
2819
 
2864
 
class ShelvedChanges(UncommittedChanges):
2865
 
 
2866
 
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
2867
 
            ' (See bzr shelve --list).%(more)s')
2868
 
 
2869
 
 
2870
2820
class MissingTemplateVariable(BzrError):
2871
2821
 
2872
2822
    _fmt = 'Variable {%(name)s} is not available.'
2938
2888
        from bzrlib.osutils import get_user_encoding
2939
2889
        self.path = path
2940
2890
        self.kind = kind
2941
 
        self.user_encoding = get_user_encoding()
2942
 
 
2943
 
 
2944
 
class NoSuchConfig(BzrError):
2945
 
 
2946
 
    _fmt = ('The "%(config_id)s" configuration does not exist.')
2947
 
 
2948
 
    def __init__(self, config_id):
2949
 
        BzrError.__init__(self, config_id=config_id)
2950
 
 
2951
 
 
2952
 
class NoSuchConfigOption(BzrError):
2953
 
 
2954
 
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
2955
 
 
2956
 
    def __init__(self, option_name):
2957
 
        BzrError.__init__(self, option_name=option_name)
 
2891
        self.user_encoding = osutils.get_user_encoding()
2958
2892
 
2959
2893
 
2960
2894
class NoSuchAlias(BzrError):
3005
2939
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
3006
2940
 
3007
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
 
3008
2961
class TipChangeRejected(BzrError):
3009
2962
    """A pre_change_branch_tip hook function may raise this to cleanly and
3010
2963
    explicitly abort a change to a branch tip.
3021
2974
    _fmt = "Shelf corrupt."
3022
2975
 
3023
2976
 
3024
 
class DecompressCorruption(BzrError):
3025
 
 
3026
 
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
3027
 
 
3028
 
    def __init__(self, orig_error=None):
3029
 
        if orig_error is not None:
3030
 
            self.orig_error = ", %s" % (orig_error,)
3031
 
        else:
3032
 
            self.orig_error = ""
3033
 
        BzrError.__init__(self)
3034
 
 
3035
 
 
3036
2977
class NoSuchShelfId(BzrError):
3037
2978
 
3038
2979
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3134
3075
    def __init__(self, source_branch, target_branch):
3135
3076
        self.source_branch = source_branch
3136
3077
        self.target_branch = target_branch
3137
 
 
3138
 
 
3139
 
class NoRoundtrippingSupport(BzrError):
3140
 
 
3141
 
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
3142
 
            "%(target_branch)r.")
3143
 
 
3144
 
    internal_error = True
3145
 
 
3146
 
    def __init__(self, source_branch, target_branch):
3147
 
        self.source_branch = source_branch
3148
 
        self.target_branch = target_branch
3149
 
 
3150
 
 
3151
 
class FileTimestampUnavailable(BzrError):
3152
 
 
3153
 
    _fmt = "The filestamp for %(path)s is not available."
3154
 
 
3155
 
    internal_error = True
3156
 
 
3157
 
    def __init__(self, path):
3158
 
        self.path = path
3159
 
 
3160
 
 
3161
 
class NoColocatedBranchSupport(BzrError):
3162
 
 
3163
 
    _fmt = ("%(bzrdir)r does not support co-located branches.")
3164
 
 
3165
 
    def __init__(self, bzrdir):
3166
 
        self.bzrdir = bzrdir
3167
 
 
3168
 
 
3169
 
class NoWhoami(BzrError):
3170
 
 
3171
 
    _fmt = ('Unable to determine your name.\n'
3172
 
        "Please, set your name with the 'whoami' command.\n"
3173
 
        'E.g. bzr whoami "Your Name <name@example.com>"')
3174
 
 
3175
 
 
3176
 
class InvalidPattern(BzrError):
3177
 
 
3178
 
    _fmt = ('Invalid pattern(s) found. %(msg)s')
3179
 
 
3180
 
    def __init__(self, msg):
3181
 
        self.msg = msg
3182
 
 
3183
 
 
3184
 
class RecursiveBind(BzrError):
3185
 
 
3186
 
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3187
 
        'Please use `bzr unbind` to fix.')
3188
 
 
3189
 
    def __init__(self, branch_url):
3190
 
        self.branch_url = branch_url
3191
 
 
3192
 
 
3193
 
# FIXME: I would prefer to define the config related exception classes in
3194
 
# config.py but the lazy import mechanism proscribes this -- vila 20101222
3195
 
class OptionExpansionLoop(BzrError):
3196
 
 
3197
 
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
3198
 
 
3199
 
    def __init__(self, string, refs):
3200
 
        self.string = string
3201
 
        self.refs = '->'.join(refs)
3202
 
 
3203
 
 
3204
 
class ExpandingUnknownOption(BzrError):
3205
 
 
3206
 
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
3207
 
 
3208
 
    def __init__(self, name, string):
3209
 
        self.name = name
3210
 
        self.string = string
3211
 
 
3212
 
 
3213
 
class NoCompatibleInter(BzrError):
3214
 
 
3215
 
    _fmt = ('No compatible object available for operations from %(source)r '
3216
 
            'to %(target)r.')
3217
 
 
3218
 
    def __init__(self, source, target):
3219
 
        self.source = source
3220
 
        self.target = target
3221
 
 
3222
 
 
3223
 
class HpssVfsRequestNotAllowed(BzrError):
3224
 
 
3225
 
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
3226
 
            "%(method)s, %(arguments)s.")
3227
 
 
3228
 
    def __init__(self, method, arguments):
3229
 
        self.method = method
3230
 
        self.arguments = arguments
3231
 
 
3232
 
 
3233
 
class UnsupportedKindChange(BzrError):
3234
 
 
3235
 
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
3236
 
            "%(path)s not supported by format %(format)r")
3237
 
 
3238
 
    def __init__(self, path, from_kind, to_kind, format):
3239
 
        self.path = path
3240
 
        self.from_kind = from_kind
3241
 
        self.to_kind = to_kind
3242
 
        self.format = format
3243
 
 
3244
 
 
3245
 
class PatchSyntax(BzrError):
3246
 
    """Base class for patch syntax errors."""
3247
 
 
3248
 
 
3249
 
class BinaryFiles(BzrError):
3250
 
 
3251
 
    _fmt = 'Binary files section encountered.'
3252
 
 
3253
 
    def __init__(self, orig_name, mod_name):
3254
 
        self.orig_name = orig_name
3255
 
        self.mod_name = mod_name
3256
 
 
3257
 
 
3258
 
class MalformedPatchHeader(PatchSyntax):
3259
 
 
3260
 
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
3261
 
 
3262
 
    def __init__(self, desc, line):
3263
 
        self.desc = desc
3264
 
        self.line = line
3265
 
 
3266
 
 
3267
 
class MalformedHunkHeader(PatchSyntax):
3268
 
 
3269
 
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
3270
 
 
3271
 
    def __init__(self, desc, line):
3272
 
        self.desc = desc
3273
 
        self.line = line
3274
 
 
3275
 
 
3276
 
class MalformedLine(PatchSyntax):
3277
 
 
3278
 
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
3279
 
 
3280
 
    def __init__(self, desc, line):
3281
 
        self.desc = desc
3282
 
        self.line = line
3283
 
 
3284
 
 
3285
 
class PatchConflict(BzrError):
3286
 
 
3287
 
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
3288
 
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
3289
 
 
3290
 
    def __init__(self, line_no, orig_line, patch_line):
3291
 
        self.line_no = line_no
3292
 
        self.orig_line = orig_line.rstrip('\n')
3293
 
        self.patch_line = patch_line.rstrip('\n')