/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-05-19 10:51:37 UTC
  • mfrom: (5891.1.3 api-docs)
  • Revision ID: pqm@pqm.ubuntu.com-20110519105137-amzagrral2ldm1lq
(spiv) Fix the formatting of more docstrings. (Andrew Bennetts)

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
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):
1735
1766
 
1736
1767
class ParseConfigError(BzrError):
1737
1768
 
 
1769
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
 
1770
 
1738
1771
    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)
 
1772
        BzrError.__init__(self)
 
1773
        self.filename = filename
 
1774
        self.errors = '\n'.join(e.msg for e in errors)
1744
1775
 
1745
1776
 
1746
1777
class NoEmailInUsername(BzrError):
1925
1956
    _fmt = "Moving the root directory is not supported at this time"
1926
1957
 
1927
1958
 
 
1959
class TransformRenameFailed(BzrError):
 
1960
 
 
1961
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
1962
 
 
1963
    def __init__(self, from_path, to_path, why, errno):
 
1964
        self.from_path = from_path
 
1965
        self.to_path = to_path
 
1966
        self.why = why
 
1967
        self.errno = errno
 
1968
 
 
1969
 
1928
1970
class BzrMoveFailedError(BzrError):
1929
1971
 
1930
 
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1972
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
 
1973
        "%(_has_extra)s%(extra)s")
1931
1974
 
1932
1975
    def __init__(self, from_path='', to_path='', extra=None):
1933
1976
        from bzrlib.osutils import splitpath
1934
1977
        BzrError.__init__(self)
1935
1978
        if extra:
1936
 
            self.extra = ': ' + str(extra)
 
1979
            self.extra, self._has_extra = extra, ': '
1937
1980
        else:
1938
 
            self.extra = ''
 
1981
            self.extra = self._has_extra = ''
1939
1982
 
1940
1983
        has_from = len(from_path) > 0
1941
1984
        has_to = len(to_path) > 0
1962
2005
 
1963
2006
class BzrRenameFailedError(BzrMoveFailedError):
1964
2007
 
1965
 
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
2008
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
 
2009
        "%(_has_extra)s%(extra)s")
1966
2010
 
1967
2011
    def __init__(self, from_path, to_path, extra=None):
1968
2012
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1969
2013
 
 
2014
 
1970
2015
class BzrRemoveChangedFilesError(BzrError):
1971
2016
    """Used when user is trying to remove changed files."""
1972
2017
 
1975
2020
        "Use --keep to not delete them, or --force to delete them regardless.")
1976
2021
 
1977
2022
    def __init__(self, tree_delta):
 
2023
        symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
 
2024
            "BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
1978
2025
        BzrError.__init__(self)
1979
2026
        self.changes_as_text = tree_delta.get_changes_as_text()
1980
2027
        #self.paths_as_string = '\n'.join(changed_files)
1988
2035
 
1989
2036
class BzrBadParameterMissing(BzrBadParameter):
1990
2037
 
1991
 
    _fmt = "Parameter $(param)s is required but not present."
 
2038
    _fmt = "Parameter %(param)s is required but not present."
1992
2039
 
1993
2040
 
1994
2041
class BzrBadParameterUnicode(BzrBadParameter):
2618
2665
 
2619
2666
    This is distinct from ErrorFromSmartServer so that it is possible to
2620
2667
    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.
 
2668
 
 
2669
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2670
      and so should provoke a traceback to the user.
 
2671
    - ErrorFromSmartServer was caught but its error_tuple could not be
 
2672
      translated.  This is probably because the server sent us garbage, and
 
2673
      should not provoke a traceback.
2626
2674
    """
2627
2675
 
2628
2676
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2834
2882
        else:
2835
2883
            more = ' ' + more
2836
2884
        import bzrlib.urlutils as urlutils
2837
 
        display_url = urlutils.unescape_for_display(
2838
 
            tree.user_url, 'ascii')
 
2885
        user_url = getattr(tree, "user_url", None)
 
2886
        if user_url is None:
 
2887
            display_url = str(tree)
 
2888
        else:
 
2889
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
2839
2890
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2840
2891
 
2841
2892
 
 
2893
class ShelvedChanges(UncommittedChanges):
 
2894
 
 
2895
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2896
            ' (See bzr shelve --list).%(more)s')
 
2897
 
 
2898
 
2842
2899
class MissingTemplateVariable(BzrError):
2843
2900
 
2844
2901
    _fmt = 'Variable {%(name)s} is not available.'
2913
2970
        self.user_encoding = osutils.get_user_encoding()
2914
2971
 
2915
2972
 
 
2973
class NoSuchConfig(BzrError):
 
2974
 
 
2975
    _fmt = ('The "%(config_id)s" configuration does not exist.')
 
2976
 
 
2977
    def __init__(self, config_id):
 
2978
        BzrError.__init__(self, config_id=config_id)
 
2979
 
 
2980
 
 
2981
class NoSuchConfigOption(BzrError):
 
2982
 
 
2983
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
 
2984
 
 
2985
    def __init__(self, option_name):
 
2986
        BzrError.__init__(self, option_name=option_name)
 
2987
 
 
2988
 
2916
2989
class NoSuchAlias(BzrError):
2917
2990
 
2918
2991
    _fmt = ('The alias "%(alias_name)s" does not exist.')
3134
3207
    def __init__(self, bzrdir):
3135
3208
        self.bzrdir = bzrdir
3136
3209
 
 
3210
 
 
3211
class NoWhoami(BzrError):
 
3212
 
 
3213
    _fmt = ('Unable to determine your name.\n'
 
3214
        "Please, set your name with the 'whoami' command.\n"
 
3215
        'E.g. bzr whoami "Your Name <name@example.com>"')
 
3216
 
 
3217
 
 
3218
class InvalidPattern(BzrError):
 
3219
 
 
3220
    _fmt = ('Invalid pattern(s) found. %(msg)s')
 
3221
 
 
3222
    def __init__(self, msg):
 
3223
        self.msg = msg
 
3224
 
 
3225
 
 
3226
class RecursiveBind(BzrError):
 
3227
 
 
3228
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
 
3229
        'Please use `bzr unbind` to fix.')
 
3230
 
 
3231
    def __init__(self, branch_url):
 
3232
        self.branch_url = branch_url
 
3233
 
 
3234
 
 
3235
# FIXME: I would prefer to define the config related exception classes in
 
3236
# config.py but the lazy import mechanism proscribes this -- vila 20101222
 
3237
class OptionExpansionLoop(BzrError):
 
3238
 
 
3239
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
 
3240
 
 
3241
    def __init__(self, string, refs):
 
3242
        self.string = string
 
3243
        self.refs = '->'.join(refs)
 
3244
 
 
3245
 
 
3246
class ExpandingUnknownOption(BzrError):
 
3247
 
 
3248
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
 
3249
 
 
3250
    def __init__(self, name, string):
 
3251
        self.name = name
 
3252
        self.string = string
 
3253
 
 
3254
 
 
3255
class NoCompatibleInter(BzrError):
 
3256
 
 
3257
    _fmt = ('No compatible object available for operations from %(source)r '
 
3258
            'to %(target)r.')
 
3259
 
 
3260
    def __init__(self, source, target):
 
3261
        self.source = source
 
3262
        self.target = target