~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-08-17 18:13:57 UTC
  • mfrom: (5268.7.29 transport-segments)
  • Revision ID: pqm@pqm.ubuntu.com-20110817181357-y5q5eth1hk8bl3om
(jelmer) Allow specifying the colocated branch to use in the branch URL,
 and retrieving the branch name using ControlDir._get_selected_branch.
 (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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 details.
59
 
    (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
 
59
        details.  (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
 
        "record_entry_contents.")
 
307
        "the commit builder.")
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 = True
 
683
    internal_error = False
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
 
716
719
    def _format(self):
717
720
        # XXX: Ideally self.detail would be a property, but Exceptions in
718
721
        # Python 2.4 have to be old-style classes so properties don't work.
723
726
                    self.bzrdir.open_repository()
724
727
                except NoRepositoryPresent:
725
728
                    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 = ''
726
738
                else:
727
739
                    self.detail = ': location is a repository'
728
740
            else:
782
794
 
783
795
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
784
796
 
 
797
    # use PathNotChild instead
 
798
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 3, 0)))
785
799
    def __init__(self, branch, path):
786
800
        BzrError.__init__(self)
787
801
        self.branch = branch
850
864
        """Construct a new AlreadyVersionedError.
851
865
 
852
866
        :param path: This is the path which is versioned,
853
 
        which should be in a user friendly form.
 
867
            which should be in a user friendly form.
854
868
        :param context_info: If given, this is information about the context,
855
 
        which could explain why this is expected to not be versioned.
 
869
            which could explain why this is expected to not be versioned.
856
870
        """
857
871
        BzrError.__init__(self)
858
872
        self.path = path
871
885
        """Construct a new NotVersionedError.
872
886
 
873
887
        :param path: This is the path which is not versioned,
874
 
        which should be in a user friendly form.
 
888
            which should be in a user friendly form.
875
889
        :param context_info: If given, this is information about the context,
876
 
        which could explain why this is expected to be versioned.
 
890
            which could explain why this is expected to be versioned.
877
891
        """
878
892
        BzrError.__init__(self)
879
893
        self.path = path
947
961
    # original exception is available as e.original_error
948
962
    #
949
963
    # New code should prefer to raise specific subclasses
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
 
964
    def __init__(self, msg):
 
965
        self.msg = msg
955
966
 
956
967
 
957
968
class LockActive(LockError):
1041
1052
class LockContention(LockError):
1042
1053
 
1043
1054
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
1044
 
    # TODO: show full url for lock, combining the transport and relative
1045
 
    # bits?
1046
1055
 
1047
1056
    internal_error = False
1048
1057
 
1075
1084
        self.target = target
1076
1085
 
1077
1086
 
 
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
 
1078
1099
class LockNotHeld(LockError):
1079
1100
 
1080
1101
    _fmt = "Lock not held: %(lock)s"
1119
1140
        BzrError.__init__(self, files=files, files_str=files_str)
1120
1141
 
1121
1142
 
 
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
 
1122
1152
class BadCommitMessageEncoding(BzrError):
1123
1153
 
1124
1154
    _fmt = 'The specified commit message contains characters unsupported by '\
1180
1210
class InvalidRevisionSpec(BzrError):
1181
1211
 
1182
1212
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1183
 
            " %(branch)s%(extra)s")
 
1213
            " %(branch_url)s%(extra)s")
1184
1214
 
1185
1215
    def __init__(self, spec, branch, extra=None):
1186
1216
        BzrError.__init__(self, branch=branch, spec=spec)
 
1217
        self.branch_url = getattr(branch, 'user_url', str(branch))
1187
1218
        if extra:
1188
1219
            self.extra = '\n' + str(extra)
1189
1220
        else:
1380
1411
 
1381
1412
class WeaveParentMismatch(WeaveError):
1382
1413
 
1383
 
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1414
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
1384
1415
 
1385
1416
 
1386
1417
class WeaveInvalidChecksum(WeaveError):
1387
1418
 
1388
 
    _fmt = "Text did not match it's checksum: %(message)s"
 
1419
    _fmt = "Text did not match its checksum: %(msg)s"
1389
1420
 
1390
1421
 
1391
1422
class WeaveTextDiffers(WeaveError):
1439
1470
 
1440
1471
class VersionedFileInvalidChecksum(VersionedFileError):
1441
1472
 
1442
 
    _fmt = "Text did not match its checksum: %(message)s"
 
1473
    _fmt = "Text did not match its checksum: %(msg)s"
1443
1474
 
1444
1475
 
1445
1476
class KnitError(InternalBzrError):
1684
1715
 
1685
1716
class InvalidHttpResponse(TransportError):
1686
1717
 
1687
 
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1718
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
1688
1719
 
1689
1720
    def __init__(self, path, msg, orig_error=None):
1690
1721
        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,)
1691
1728
        TransportError.__init__(self, msg, orig_error=orig_error)
1692
1729
 
1693
1730
 
1700
1737
        InvalidHttpResponse.__init__(self, path, msg)
1701
1738
 
1702
1739
 
 
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
 
1703
1753
class InvalidHttpContentType(InvalidHttpResponse):
1704
1754
 
1705
1755
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1733
1783
    _fmt = "Working tree has conflicts."
1734
1784
 
1735
1785
 
 
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
 
1736
1795
class ParseConfigError(BzrError):
1737
1796
 
 
1797
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
 
1798
 
1738
1799
    def __init__(self, errors, filename):
1739
 
        if filename is None:
1740
 
            filename = ""
1741
 
        message = "Error(s) parsing config file %s:\n%s" % \
1742
 
            (filename, ('\n'.join(e.msg for e in errors)))
1743
 
        BzrError.__init__(self, message)
 
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)
1744
1811
 
1745
1812
 
1746
1813
class NoEmailInUsername(BzrError):
1754
1821
 
1755
1822
class SigningFailed(BzrError):
1756
1823
 
1757
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1824
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
1758
1825
 
1759
1826
    def __init__(self, command_line):
1760
1827
        BzrError.__init__(self, command_line=command_line)
1761
1828
 
1762
1829
 
 
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
 
1763
1854
class WorkingTreeNotRevision(BzrError):
1764
1855
 
1765
1856
    _fmt = ("The working tree for %(basedir)s has changed since"
1925
2016
    _fmt = "Moving the root directory is not supported at this time"
1926
2017
 
1927
2018
 
 
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
 
1928
2030
class BzrMoveFailedError(BzrError):
1929
2031
 
1930
 
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
2032
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
 
2033
        "%(_has_extra)s%(extra)s")
1931
2034
 
1932
2035
    def __init__(self, from_path='', to_path='', extra=None):
1933
2036
        from bzrlib.osutils import splitpath
1934
2037
        BzrError.__init__(self)
1935
2038
        if extra:
1936
 
            self.extra = ': ' + str(extra)
 
2039
            self.extra, self._has_extra = extra, ': '
1937
2040
        else:
1938
 
            self.extra = ''
 
2041
            self.extra = self._has_extra = ''
1939
2042
 
1940
2043
        has_from = len(from_path) > 0
1941
2044
        has_to = len(to_path) > 0
1962
2065
 
1963
2066
class BzrRenameFailedError(BzrMoveFailedError):
1964
2067
 
1965
 
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
2068
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
 
2069
        "%(_has_extra)s%(extra)s")
1966
2070
 
1967
2071
    def __init__(self, from_path, to_path, extra=None):
1968
2072
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1969
2073
 
 
2074
 
1970
2075
class BzrRemoveChangedFilesError(BzrError):
1971
2076
    """Used when user is trying to remove changed files."""
1972
2077
 
1975
2080
        "Use --keep to not delete them, or --force to delete them regardless.")
1976
2081
 
1977
2082
    def __init__(self, tree_delta):
 
2083
        symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
 
2084
            "BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
1978
2085
        BzrError.__init__(self)
1979
2086
        self.changes_as_text = tree_delta.get_changes_as_text()
1980
2087
        #self.paths_as_string = '\n'.join(changed_files)
1988
2095
 
1989
2096
class BzrBadParameterMissing(BzrBadParameter):
1990
2097
 
1991
 
    _fmt = "Parameter $(param)s is required but not present."
 
2098
    _fmt = "Parameter %(param)s is required but not present."
1992
2099
 
1993
2100
 
1994
2101
class BzrBadParameterUnicode(BzrBadParameter):
2002
2109
    _fmt = "Parameter %(param)s contains a newline."
2003
2110
 
2004
2111
 
2005
 
class DependencyNotPresent(BzrError):
2006
 
 
2007
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
2008
 
 
2009
 
    def __init__(self, library, error):
2010
 
        BzrError.__init__(self, library=library, error=error)
2011
 
 
2012
 
 
2013
2112
class ParamikoNotPresent(DependencyNotPresent):
2014
2113
 
2015
2114
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2618
2717
 
2619
2718
    This is distinct from ErrorFromSmartServer so that it is possible to
2620
2719
    distinguish between the following two cases:
2621
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2622
 
        and so should provoke a traceback to the user.
2623
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2624
 
        translated.  This is probably because the server sent us garbage, and
2625
 
        should not provoke a traceback.
 
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.
2626
2726
    """
2627
2727
 
2628
2728
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2834
2934
        else:
2835
2935
            more = ' ' + more
2836
2936
        import bzrlib.urlutils as urlutils
2837
 
        display_url = urlutils.unescape_for_display(
2838
 
            tree.user_url, 'ascii')
 
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')
2839
2942
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2840
2943
 
2841
2944
 
 
2945
class ShelvedChanges(UncommittedChanges):
 
2946
 
 
2947
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2948
            ' (See bzr shelve --list).%(more)s')
 
2949
 
 
2950
 
2842
2951
class MissingTemplateVariable(BzrError):
2843
2952
 
2844
2953
    _fmt = 'Variable {%(name)s} is not available.'
2913
3022
        self.user_encoding = osutils.get_user_encoding()
2914
3023
 
2915
3024
 
 
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
 
2916
3041
class NoSuchAlias(BzrError):
2917
3042
 
2918
3043
    _fmt = ('The alias "%(alias_name)s" does not exist.')
3002
3127
    _fmt = "Shelf corrupt."
3003
3128
 
3004
3129
 
 
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
 
3005
3142
class NoSuchShelfId(BzrError):
3006
3143
 
3007
3144
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3134
3271
    def __init__(self, bzrdir):
3135
3272
        self.bzrdir = bzrdir
3136
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