~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: 2010-04-06 06:59:03 UTC
  • mfrom: (5051.5.1 subunit)
  • Revision ID: pqm@pqm.ubuntu.com-20100406065903-y9dxgwmog1pmw7dz
Use subunit when running tests in PQM.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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):
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 '\
1210
1180
class InvalidRevisionSpec(BzrError):
1211
1181
 
1212
1182
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1213
 
            " %(branch_url)s%(extra)s")
 
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:
1411
1380
 
1412
1381
class WeaveParentMismatch(WeaveError):
1413
1382
 
1414
 
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
 
1383
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1415
1384
 
1416
1385
 
1417
1386
class WeaveInvalidChecksum(WeaveError):
1418
1387
 
1419
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1388
    _fmt = "Text did not match it's checksum: %(message)s"
1420
1389
 
1421
1390
 
1422
1391
class WeaveTextDiffers(WeaveError):
1470
1439
 
1471
1440
class VersionedFileInvalidChecksum(VersionedFileError):
1472
1441
 
1473
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1442
    _fmt = "Text did not match its checksum: %(message)s"
1474
1443
 
1475
1444
 
1476
1445
class KnitError(InternalBzrError):
1715
1684
 
1716
1685
class InvalidHttpResponse(TransportError):
1717
1686
 
1718
 
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1687
    _fmt = "Invalid http response for %(path)s: %(msg)s"
1719
1688
 
1720
1689
    def __init__(self, path, msg, orig_error=None):
1721
1690
        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
1691
        TransportError.__init__(self, msg, orig_error=orig_error)
1729
1692
 
1730
1693
 
1770
1733
    _fmt = "Working tree has conflicts."
1771
1734
 
1772
1735
 
1773
 
class ConfigContentError(BzrError):
1774
 
 
1775
 
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
1776
 
 
1777
 
    def __init__(self, filename):
1778
 
        BzrError.__init__(self)
1779
 
        self.filename = filename
1780
 
 
1781
 
 
1782
1736
class ParseConfigError(BzrError):
1783
1737
 
1784
 
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
1785
 
 
1786
1738
    def __init__(self, errors, filename):
1787
 
        BzrError.__init__(self)
1788
 
        self.filename = filename
1789
 
        self.errors = '\n'.join(e.msg for e in errors)
 
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)
1790
1744
 
1791
1745
 
1792
1746
class NoEmailInUsername(BzrError):
1800
1754
 
1801
1755
class SigningFailed(BzrError):
1802
1756
 
1803
 
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
 
1757
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1804
1758
 
1805
1759
    def __init__(self, command_line):
1806
1760
        BzrError.__init__(self, command_line=command_line)
1807
1761
 
1808
1762
 
1809
 
class SignatureVerificationFailed(BzrError):
1810
 
 
1811
 
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
1812
 
 
1813
 
    def __init__(self, error):
1814
 
        BzrError.__init__(self, error=error)
1815
 
 
1816
 
 
1817
 
class DependencyNotPresent(BzrError):
1818
 
 
1819
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1820
 
 
1821
 
    def __init__(self, library, error):
1822
 
        BzrError.__init__(self, library=library, error=error)
1823
 
 
1824
 
 
1825
 
class GpgmeNotInstalled(DependencyNotPresent):
1826
 
 
1827
 
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
1828
 
 
1829
 
    def __init__(self, error):
1830
 
        DependencyNotPresent.__init__(self, 'gpgme', error)
1831
 
 
1832
 
 
1833
1763
class WorkingTreeNotRevision(BzrError):
1834
1764
 
1835
1765
    _fmt = ("The working tree for %(basedir)s has changed since"
1995
1925
    _fmt = "Moving the root directory is not supported at this time"
1996
1926
 
1997
1927
 
1998
 
class TransformRenameFailed(BzrError):
1999
 
 
2000
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
2001
 
 
2002
 
    def __init__(self, from_path, to_path, why, errno):
2003
 
        self.from_path = from_path
2004
 
        self.to_path = to_path
2005
 
        self.why = why
2006
 
        self.errno = errno
2007
 
 
2008
 
 
2009
1928
class BzrMoveFailedError(BzrError):
2010
1929
 
2011
 
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
2012
 
        "%(_has_extra)s%(extra)s")
 
1930
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
2013
1931
 
2014
1932
    def __init__(self, from_path='', to_path='', extra=None):
2015
1933
        from bzrlib.osutils import splitpath
2016
1934
        BzrError.__init__(self)
2017
1935
        if extra:
2018
 
            self.extra, self._has_extra = extra, ': '
 
1936
            self.extra = ': ' + str(extra)
2019
1937
        else:
2020
 
            self.extra = self._has_extra = ''
 
1938
            self.extra = ''
2021
1939
 
2022
1940
        has_from = len(from_path) > 0
2023
1941
        has_to = len(to_path) > 0
2044
1962
 
2045
1963
class BzrRenameFailedError(BzrMoveFailedError):
2046
1964
 
2047
 
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
2048
 
        "%(_has_extra)s%(extra)s")
 
1965
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
2049
1966
 
2050
1967
    def __init__(self, from_path, to_path, extra=None):
2051
1968
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2052
1969
 
2053
 
 
2054
1970
class BzrRemoveChangedFilesError(BzrError):
2055
1971
    """Used when user is trying to remove changed files."""
2056
1972
 
2059
1975
        "Use --keep to not delete them, or --force to delete them regardless.")
2060
1976
 
2061
1977
    def __init__(self, tree_delta):
2062
 
        symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
2063
 
            "BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
2064
1978
        BzrError.__init__(self)
2065
1979
        self.changes_as_text = tree_delta.get_changes_as_text()
2066
1980
        #self.paths_as_string = '\n'.join(changed_files)
2074
1988
 
2075
1989
class BzrBadParameterMissing(BzrBadParameter):
2076
1990
 
2077
 
    _fmt = "Parameter %(param)s is required but not present."
 
1991
    _fmt = "Parameter $(param)s is required but not present."
2078
1992
 
2079
1993
 
2080
1994
class BzrBadParameterUnicode(BzrBadParameter):
2088
2002
    _fmt = "Parameter %(param)s contains a newline."
2089
2003
 
2090
2004
 
 
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
 
2091
2013
class ParamikoNotPresent(DependencyNotPresent):
2092
2014
 
2093
2015
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2254
2176
 
2255
2177
    def __init__(self, repo):
2256
2178
        BzrError.__init__(self)
2257
 
        self.repo_path = repo.user_url
 
2179
        self.repo_path = repo.bzrdir.root_transport.base
2258
2180
 
2259
2181
 
2260
2182
class InconsistentDelta(BzrError):
2696
2618
 
2697
2619
    This is distinct from ErrorFromSmartServer so that it is possible to
2698
2620
    distinguish between the following two cases:
2699
 
 
2700
 
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
2701
 
      and so should provoke a traceback to the user.
2702
 
    - ErrorFromSmartServer was caught but its error_tuple could not be
2703
 
      translated.  This is probably because the server sent us garbage, and
2704
 
      should not provoke a traceback.
 
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.
2705
2626
    """
2706
2627
 
2707
2628
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2833
2754
 
2834
2755
    def __init__(self, bzrdir):
2835
2756
        import bzrlib.urlutils as urlutils
2836
 
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2757
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
2837
2758
                                                    'ascii')
2838
2759
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2839
2760
 
2913
2834
        else:
2914
2835
            more = ' ' + more
2915
2836
        import bzrlib.urlutils as urlutils
2916
 
        user_url = getattr(tree, "user_url", None)
2917
 
        if user_url is None:
2918
 
            display_url = str(tree)
2919
 
        else:
2920
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2837
        display_url = urlutils.unescape_for_display(
 
2838
            tree.bzrdir.root_transport.base, 'ascii')
2921
2839
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2922
2840
 
2923
2841
 
2924
 
class ShelvedChanges(UncommittedChanges):
2925
 
 
2926
 
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
2927
 
            ' (See bzr shelve --list).%(more)s')
2928
 
 
2929
 
 
2930
2842
class MissingTemplateVariable(BzrError):
2931
2843
 
2932
2844
    _fmt = 'Variable {%(name)s} is not available.'
3001
2913
        self.user_encoding = osutils.get_user_encoding()
3002
2914
 
3003
2915
 
3004
 
class NoSuchConfig(BzrError):
3005
 
 
3006
 
    _fmt = ('The "%(config_id)s" configuration does not exist.')
3007
 
 
3008
 
    def __init__(self, config_id):
3009
 
        BzrError.__init__(self, config_id=config_id)
3010
 
 
3011
 
 
3012
 
class NoSuchConfigOption(BzrError):
3013
 
 
3014
 
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
3015
 
 
3016
 
    def __init__(self, option_name):
3017
 
        BzrError.__init__(self, option_name=option_name)
3018
 
 
3019
 
 
3020
2916
class NoSuchAlias(BzrError):
3021
2917
 
3022
2918
    _fmt = ('The alias "%(alias_name)s" does not exist.')
3106
3002
    _fmt = "Shelf corrupt."
3107
3003
 
3108
3004
 
3109
 
class DecompressCorruption(BzrError):
3110
 
 
3111
 
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
3112
 
 
3113
 
    def __init__(self, orig_error=None):
3114
 
        if orig_error is not None:
3115
 
            self.orig_error = ", %s" % (orig_error,)
3116
 
        else:
3117
 
            self.orig_error = ""
3118
 
        BzrError.__init__(self)
3119
 
 
3120
 
 
3121
3005
class NoSuchShelfId(BzrError):
3122
3006
 
3123
3007
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3250
3134
    def __init__(self, bzrdir):
3251
3135
        self.bzrdir = bzrdir
3252
3136
 
3253
 
 
3254
 
class NoWhoami(BzrError):
3255
 
 
3256
 
    _fmt = ('Unable to determine your name.\n'
3257
 
        "Please, set your name with the 'whoami' command.\n"
3258
 
        'E.g. bzr whoami "Your Name <name@example.com>"')
3259
 
 
3260
 
 
3261
 
class InvalidPattern(BzrError):
3262
 
 
3263
 
    _fmt = ('Invalid pattern(s) found. %(msg)s')
3264
 
 
3265
 
    def __init__(self, msg):
3266
 
        self.msg = msg
3267
 
 
3268
 
 
3269
 
class RecursiveBind(BzrError):
3270
 
 
3271
 
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3272
 
        'Please use `bzr unbind` to fix.')
3273
 
 
3274
 
    def __init__(self, branch_url):
3275
 
        self.branch_url = branch_url
3276
 
 
3277
 
 
3278
 
# FIXME: I would prefer to define the config related exception classes in
3279
 
# config.py but the lazy import mechanism proscribes this -- vila 20101222
3280
 
class OptionExpansionLoop(BzrError):
3281
 
 
3282
 
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
3283
 
 
3284
 
    def __init__(self, string, refs):
3285
 
        self.string = string
3286
 
        self.refs = '->'.join(refs)
3287
 
 
3288
 
 
3289
 
class ExpandingUnknownOption(BzrError):
3290
 
 
3291
 
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
3292
 
 
3293
 
    def __init__(self, name, string):
3294
 
        self.name = name
3295
 
        self.string = string
3296
 
 
3297
 
 
3298
 
class NoCompatibleInter(BzrError):
3299
 
 
3300
 
    _fmt = ('No compatible object available for operations from %(source)r '
3301
 
            'to %(target)r.')
3302
 
 
3303
 
    def __init__(self, source, target):
3304
 
        self.source = source
3305
 
        self.target = target