~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: John Arbash Meinel
  • Date: 2010-02-16 16:08:40 UTC
  • mfrom: (4797.2.15 2.1)
  • mto: (4797.2.16 2.1)
  • mto: This revision was merged to the branch mainline in revision 5037.
  • Revision ID: john@arbash-meinel.com-20100216160840-xwbpuu0v89gq8lej
Tags: bzr-2.1.0
bring in the latest 2.1 changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
54
54
    Base class for errors raised by bzrlib.
55
55
 
56
56
    :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
59
 
        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.)
60
60
 
61
61
    :cvar _fmt: Format string to display the error; this is expanded
62
 
        by the instance's dict.
 
62
    by the instance's dict.
63
63
    """
64
64
 
65
65
    internal_error = False
304
304
class RootMissing(InternalBzrError):
305
305
 
306
306
    _fmt = ("The root entry of a tree must be the first entry supplied to "
307
 
        "the commit builder.")
 
307
        "record_entry_contents.")
308
308
 
309
309
 
310
310
class NoPublicBranch(BzrError):
621
621
 
622
622
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
623
623
 
624
 
    def __init__(self, url, extra=""):
 
624
    def __init__(self, url, extra):
625
625
        PathError.__init__(self, url, extra=extra)
626
626
 
627
627
 
680
680
 
681
681
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
682
682
 
683
 
    internal_error = False
 
683
    internal_error = True
684
684
 
685
685
    def __init__(self, path, base, extra=None):
686
686
        BzrError.__init__(self)
713
713
       self.bzrdir = bzrdir
714
714
       PathError.__init__(self, path=path)
715
715
 
716
 
    def __repr__(self):
717
 
        return '<%s %r>' % (self.__class__.__name__, self.__dict__)
718
 
 
719
716
    def _format(self):
720
717
        # XXX: Ideally self.detail would be a property, but Exceptions in
721
718
        # Python 2.4 have to be old-style classes so properties don't work.
726
723
                    self.bzrdir.open_repository()
727
724
                except NoRepositoryPresent:
728
725
                    self.detail = ''
729
 
                except Exception:
730
 
                    # Just ignore unexpected errors.  Raising arbitrary errors
731
 
                    # during str(err) can provoke strange bugs.  Concretely
732
 
                    # Launchpad's codehosting managed to raise NotBranchError
733
 
                    # here, and then get stuck in an infinite loop/recursion
734
 
                    # trying to str() that error.  All this error really cares
735
 
                    # about that there's no working repository there, and if
736
 
                    # open_repository() fails, there probably isn't.
737
 
                    self.detail = ''
738
726
                else:
739
727
                    self.detail = ': location is a repository'
740
728
            else:
794
782
 
795
783
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
796
784
 
797
 
    # use PathNotChild instead
798
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 3, 0)))
799
785
    def __init__(self, branch, path):
800
786
        BzrError.__init__(self)
801
787
        self.branch = branch
864
850
        """Construct a new AlreadyVersionedError.
865
851
 
866
852
        :param path: This is the path which is versioned,
867
 
            which should be in a user friendly form.
 
853
        which should be in a user friendly form.
868
854
        :param context_info: If given, this is information about the context,
869
 
            which could explain why this is expected to not be versioned.
 
855
        which could explain why this is expected to not be versioned.
870
856
        """
871
857
        BzrError.__init__(self)
872
858
        self.path = path
885
871
        """Construct a new NotVersionedError.
886
872
 
887
873
        :param path: This is the path which is not versioned,
888
 
            which should be in a user friendly form.
 
874
        which should be in a user friendly form.
889
875
        :param context_info: If given, this is information about the context,
890
 
            which could explain why this is expected to be versioned.
 
876
        which could explain why this is expected to be versioned.
891
877
        """
892
878
        BzrError.__init__(self)
893
879
        self.path = path
961
947
    # original exception is available as e.original_error
962
948
    #
963
949
    # New code should prefer to raise specific subclasses
964
 
    def __init__(self, msg):
965
 
        self.msg = msg
 
950
    def __init__(self, message):
 
951
        # Python 2.5 uses a slot for StandardError.message,
 
952
        # so use a different variable name.  We now work around this in
 
953
        # BzrError.__str__, but this member name is kept for compatability.
 
954
        self.msg = message
966
955
 
967
956
 
968
957
class LockActive(LockError):
1052
1041
class LockContention(LockError):
1053
1042
 
1054
1043
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
1044
    # TODO: show full url for lock, combining the transport and relative
 
1045
    # bits?
1055
1046
 
1056
1047
    internal_error = False
1057
1048
 
1084
1075
        self.target = target
1085
1076
 
1086
1077
 
1087
 
class LockCorrupt(LockError):
1088
 
 
1089
 
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
1090
 
            "Use 'bzr break-lock' to clear it")
1091
 
 
1092
 
    internal_error = False
1093
 
 
1094
 
    def __init__(self, corruption_info, file_data=None):
1095
 
        self.corruption_info = corruption_info
1096
 
        self.file_data = file_data
1097
 
 
1098
 
 
1099
1078
class LockNotHeld(LockError):
1100
1079
 
1101
1080
    _fmt = "Lock not held: %(lock)s"
1140
1119
        BzrError.__init__(self, files=files, files_str=files_str)
1141
1120
 
1142
1121
 
1143
 
class ExcludesUnsupported(BzrError):
1144
 
 
1145
 
    _fmt = ('Excluding paths during commit is not supported by '
1146
 
            'repository at %(repository)r.')
1147
 
 
1148
 
    def __init__(self, repository):
1149
 
        BzrError.__init__(self, repository=repository)
1150
 
 
1151
 
 
1152
1122
class BadCommitMessageEncoding(BzrError):
1153
1123
 
1154
1124
    _fmt = 'The specified commit message contains characters unsupported by '\
1209
1179
 
1210
1180
class InvalidRevisionSpec(BzrError):
1211
1181
 
1212
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1213
 
            " %(branch_url)s%(extra)s")
 
1182
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1183
            " %(branch)s%(extra)s")
1214
1184
 
1215
1185
    def __init__(self, spec, branch, extra=None):
1216
1186
        BzrError.__init__(self, branch=branch, spec=spec)
1217
 
        self.branch_url = getattr(branch, 'user_url', str(branch))
1218
1187
        if extra:
1219
1188
            self.extra = '\n' + str(extra)
1220
1189
        else:
1328
1297
class BoundBranchOutOfDate(BzrError):
1329
1298
 
1330
1299
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1331
 
            " %(master)s.%(extra_help)s")
 
1300
            " %(master)s.")
1332
1301
 
1333
1302
    def __init__(self, branch, master):
1334
1303
        BzrError.__init__(self)
1335
1304
        self.branch = branch
1336
1305
        self.master = master
1337
 
        self.extra_help = ''
1338
1306
 
1339
1307
 
1340
1308
class CommitToDoubleBoundBranch(BzrError):
1411
1379
 
1412
1380
class WeaveParentMismatch(WeaveError):
1413
1381
 
1414
 
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
 
1382
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1415
1383
 
1416
1384
 
1417
1385
class WeaveInvalidChecksum(WeaveError):
1418
1386
 
1419
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1387
    _fmt = "Text did not match it's checksum: %(message)s"
1420
1388
 
1421
1389
 
1422
1390
class WeaveTextDiffers(WeaveError):
1470
1438
 
1471
1439
class VersionedFileInvalidChecksum(VersionedFileError):
1472
1440
 
1473
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1441
    _fmt = "Text did not match its checksum: %(message)s"
1474
1442
 
1475
1443
 
1476
1444
class KnitError(InternalBzrError):
1715
1683
 
1716
1684
class InvalidHttpResponse(TransportError):
1717
1685
 
1718
 
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1686
    _fmt = "Invalid http response for %(path)s: %(msg)s"
1719
1687
 
1720
1688
    def __init__(self, path, msg, orig_error=None):
1721
1689
        self.path = path
1722
 
        if orig_error is None:
1723
 
            orig_error = ''
1724
 
        else:
1725
 
            # This is reached for obscure and unusual errors so we want to
1726
 
            # preserve as much info as possible to ease debug.
1727
 
            orig_error = ': %r' % (orig_error,)
1728
1690
        TransportError.__init__(self, msg, orig_error=orig_error)
1729
1691
 
1730
1692
 
1737
1699
        InvalidHttpResponse.__init__(self, path, msg)
1738
1700
 
1739
1701
 
1740
 
class HttpBoundaryMissing(InvalidHttpResponse):
1741
 
    """A multipart response ends with no boundary marker.
1742
 
 
1743
 
    This is a special case caused by buggy proxies, described in
1744
 
    <https://bugs.launchpad.net/bzr/+bug/198646>.
1745
 
    """
1746
 
 
1747
 
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
1748
 
 
1749
 
    def __init__(self, path, msg):
1750
 
        InvalidHttpResponse.__init__(self, path, msg)
1751
 
 
1752
 
 
1753
1702
class InvalidHttpContentType(InvalidHttpResponse):
1754
1703
 
1755
1704
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1783
1732
    _fmt = "Working tree has conflicts."
1784
1733
 
1785
1734
 
1786
 
class ConfigContentError(BzrError):
1787
 
 
1788
 
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
1789
 
 
1790
 
    def __init__(self, filename):
1791
 
        BzrError.__init__(self)
1792
 
        self.filename = filename
1793
 
 
1794
 
 
1795
1735
class ParseConfigError(BzrError):
1796
1736
 
1797
 
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
1798
 
 
1799
1737
    def __init__(self, errors, filename):
1800
 
        BzrError.__init__(self)
1801
 
        self.filename = filename
1802
 
        self.errors = '\n'.join(e.msg for e in errors)
1803
 
 
1804
 
 
1805
 
class ConfigOptionValueError(BzrError):
1806
 
 
1807
 
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
1808
 
 
1809
 
    def __init__(self, name, value):
1810
 
        BzrError.__init__(self, name=name, value=value)
 
1738
        if filename is None:
 
1739
            filename = ""
 
1740
        message = "Error(s) parsing config file %s:\n%s" % \
 
1741
            (filename, ('\n'.join(e.msg for e in errors)))
 
1742
        BzrError.__init__(self, message)
1811
1743
 
1812
1744
 
1813
1745
class NoEmailInUsername(BzrError):
1821
1753
 
1822
1754
class SigningFailed(BzrError):
1823
1755
 
1824
 
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
 
1756
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1825
1757
 
1826
1758
    def __init__(self, command_line):
1827
1759
        BzrError.__init__(self, command_line=command_line)
1828
1760
 
1829
1761
 
1830
 
class SignatureVerificationFailed(BzrError):
1831
 
 
1832
 
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
1833
 
 
1834
 
    def __init__(self, error):
1835
 
        BzrError.__init__(self, error=error)
1836
 
 
1837
 
 
1838
 
class DependencyNotPresent(BzrError):
1839
 
 
1840
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1841
 
 
1842
 
    def __init__(self, library, error):
1843
 
        BzrError.__init__(self, library=library, error=error)
1844
 
 
1845
 
 
1846
 
class GpgmeNotInstalled(DependencyNotPresent):
1847
 
 
1848
 
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
1849
 
 
1850
 
    def __init__(self, error):
1851
 
        DependencyNotPresent.__init__(self, 'gpgme', error)
1852
 
 
1853
 
 
1854
1762
class WorkingTreeNotRevision(BzrError):
1855
1763
 
1856
1764
    _fmt = ("The working tree for %(basedir)s has changed since"
2016
1924
    _fmt = "Moving the root directory is not supported at this time"
2017
1925
 
2018
1926
 
2019
 
class TransformRenameFailed(BzrError):
2020
 
 
2021
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
2022
 
 
2023
 
    def __init__(self, from_path, to_path, why, errno):
2024
 
        self.from_path = from_path
2025
 
        self.to_path = to_path
2026
 
        self.why = why
2027
 
        self.errno = errno
2028
 
 
2029
 
 
2030
1927
class BzrMoveFailedError(BzrError):
2031
1928
 
2032
 
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
2033
 
        "%(_has_extra)s%(extra)s")
 
1929
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
2034
1930
 
2035
1931
    def __init__(self, from_path='', to_path='', extra=None):
2036
1932
        from bzrlib.osutils import splitpath
2037
1933
        BzrError.__init__(self)
2038
1934
        if extra:
2039
 
            self.extra, self._has_extra = extra, ': '
 
1935
            self.extra = ': ' + str(extra)
2040
1936
        else:
2041
 
            self.extra = self._has_extra = ''
 
1937
            self.extra = ''
2042
1938
 
2043
1939
        has_from = len(from_path) > 0
2044
1940
        has_to = len(to_path) > 0
2065
1961
 
2066
1962
class BzrRenameFailedError(BzrMoveFailedError):
2067
1963
 
2068
 
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
2069
 
        "%(_has_extra)s%(extra)s")
 
1964
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
2070
1965
 
2071
1966
    def __init__(self, from_path, to_path, extra=None):
2072
1967
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2073
1968
 
2074
 
 
2075
1969
class BzrRemoveChangedFilesError(BzrError):
2076
1970
    """Used when user is trying to remove changed files."""
2077
1971
 
2080
1974
        "Use --keep to not delete them, or --force to delete them regardless.")
2081
1975
 
2082
1976
    def __init__(self, tree_delta):
2083
 
        symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
2084
 
            "BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
2085
1977
        BzrError.__init__(self)
2086
1978
        self.changes_as_text = tree_delta.get_changes_as_text()
2087
1979
        #self.paths_as_string = '\n'.join(changed_files)
2095
1987
 
2096
1988
class BzrBadParameterMissing(BzrBadParameter):
2097
1989
 
2098
 
    _fmt = "Parameter %(param)s is required but not present."
 
1990
    _fmt = "Parameter $(param)s is required but not present."
2099
1991
 
2100
1992
 
2101
1993
class BzrBadParameterUnicode(BzrBadParameter):
2109
2001
    _fmt = "Parameter %(param)s contains a newline."
2110
2002
 
2111
2003
 
 
2004
class DependencyNotPresent(BzrError):
 
2005
 
 
2006
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
2007
 
 
2008
    def __init__(self, library, error):
 
2009
        BzrError.__init__(self, library=library, error=error)
 
2010
 
 
2011
 
2112
2012
class ParamikoNotPresent(DependencyNotPresent):
2113
2013
 
2114
2014
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2275
2175
 
2276
2176
    def __init__(self, repo):
2277
2177
        BzrError.__init__(self)
2278
 
        self.repo_path = repo.user_url
 
2178
        self.repo_path = repo.bzrdir.root_transport.base
2279
2179
 
2280
2180
 
2281
2181
class InconsistentDelta(BzrError):
2717
2617
 
2718
2618
    This is distinct from ErrorFromSmartServer so that it is possible to
2719
2619
    distinguish between the following two cases:
2720
 
 
2721
 
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
2722
 
      and so should provoke a traceback to the user.
2723
 
    - ErrorFromSmartServer was caught but its error_tuple could not be
2724
 
      translated.  This is probably because the server sent us garbage, and
2725
 
      should not provoke a traceback.
 
2620
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2621
        and so should provoke a traceback to the user.
 
2622
      - ErrorFromSmartServer was caught but its error_tuple could not be
 
2623
        translated.  This is probably because the server sent us garbage, and
 
2624
        should not provoke a traceback.
2726
2625
    """
2727
2626
 
2728
2627
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2854
2753
 
2855
2754
    def __init__(self, bzrdir):
2856
2755
        import bzrlib.urlutils as urlutils
2857
 
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2756
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
2858
2757
                                                    'ascii')
2859
2758
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2860
2759
 
2934
2833
        else:
2935
2834
            more = ' ' + more
2936
2835
        import bzrlib.urlutils as urlutils
2937
 
        user_url = getattr(tree, "user_url", None)
2938
 
        if user_url is None:
2939
 
            display_url = str(tree)
2940
 
        else:
2941
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2836
        display_url = urlutils.unescape_for_display(
 
2837
            tree.bzrdir.root_transport.base, 'ascii')
2942
2838
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2943
2839
 
2944
2840
 
2945
 
class ShelvedChanges(UncommittedChanges):
2946
 
 
2947
 
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
2948
 
            ' (See bzr shelve --list).%(more)s')
2949
 
 
2950
 
 
2951
2841
class MissingTemplateVariable(BzrError):
2952
2842
 
2953
2843
    _fmt = 'Variable {%(name)s} is not available.'
3022
2912
        self.user_encoding = osutils.get_user_encoding()
3023
2913
 
3024
2914
 
3025
 
class NoSuchConfig(BzrError):
3026
 
 
3027
 
    _fmt = ('The "%(config_id)s" configuration does not exist.')
3028
 
 
3029
 
    def __init__(self, config_id):
3030
 
        BzrError.__init__(self, config_id=config_id)
3031
 
 
3032
 
 
3033
 
class NoSuchConfigOption(BzrError):
3034
 
 
3035
 
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
3036
 
 
3037
 
    def __init__(self, option_name):
3038
 
        BzrError.__init__(self, option_name=option_name)
3039
 
 
3040
 
 
3041
2915
class NoSuchAlias(BzrError):
3042
2916
 
3043
2917
    _fmt = ('The alias "%(alias_name)s" does not exist.')
3127
3001
    _fmt = "Shelf corrupt."
3128
3002
 
3129
3003
 
3130
 
class DecompressCorruption(BzrError):
3131
 
 
3132
 
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
3133
 
 
3134
 
    def __init__(self, orig_error=None):
3135
 
        if orig_error is not None:
3136
 
            self.orig_error = ", %s" % (orig_error,)
3137
 
        else:
3138
 
            self.orig_error = ""
3139
 
        BzrError.__init__(self)
3140
 
 
3141
 
 
3142
3004
class NoSuchShelfId(BzrError):
3143
3005
 
3144
3006
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3262
3124
 
3263
3125
    def __init__(self, path):
3264
3126
        self.path = path
3265
 
 
3266
 
 
3267
 
class NoColocatedBranchSupport(BzrError):
3268
 
 
3269
 
    _fmt = ("%(bzrdir)r does not support co-located branches.")
3270
 
 
3271
 
    def __init__(self, bzrdir):
3272
 
        self.bzrdir = bzrdir
3273
 
 
3274
 
 
3275
 
class NoWhoami(BzrError):
3276
 
 
3277
 
    _fmt = ('Unable to determine your name.\n'
3278
 
        "Please, set your name with the 'whoami' command.\n"
3279
 
        'E.g. bzr whoami "Your Name <name@example.com>"')
3280
 
 
3281
 
 
3282
 
class InvalidPattern(BzrError):
3283
 
 
3284
 
    _fmt = ('Invalid pattern(s) found. %(msg)s')
3285
 
 
3286
 
    def __init__(self, msg):
3287
 
        self.msg = msg
3288
 
 
3289
 
 
3290
 
class RecursiveBind(BzrError):
3291
 
 
3292
 
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3293
 
        'Please use `bzr unbind` to fix.')
3294
 
 
3295
 
    def __init__(self, branch_url):
3296
 
        self.branch_url = branch_url
3297
 
 
3298
 
 
3299
 
# FIXME: I would prefer to define the config related exception classes in
3300
 
# config.py but the lazy import mechanism proscribes this -- vila 20101222
3301
 
class OptionExpansionLoop(BzrError):
3302
 
 
3303
 
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
3304
 
 
3305
 
    def __init__(self, string, refs):
3306
 
        self.string = string
3307
 
        self.refs = '->'.join(refs)
3308
 
 
3309
 
 
3310
 
class ExpandingUnknownOption(BzrError):
3311
 
 
3312
 
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
3313
 
 
3314
 
    def __init__(self, name, string):
3315
 
        self.name = name
3316
 
        self.string = string
3317
 
 
3318
 
 
3319
 
class NoCompatibleInter(BzrError):
3320
 
 
3321
 
    _fmt = ('No compatible object available for operations from %(source)r '
3322
 
            'to %(target)r.')
3323
 
 
3324
 
    def __init__(self, source, target):
3325
 
        self.source = source
3326
 
        self.target = target