← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Patch Queue Manager
  • Date: 2016-02-01 19:13:13 UTC
  • mfrom: (6614.2.2 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20160201191313-wdfvmfff1djde6oq
(vila) Release 2.7.0 (Vincent Ladeuil)

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-2013, 2016 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 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
 
 
 
20
from __future__ import absolute_import
32
21
 
33
22
# TODO: is there any value in providing the .args field used by standard
34
23
# python exceptions?   A list of values with no names seems less useful
106
95
                # __str__() should always return a 'str' object
107
96
                # never a 'unicode' object.
108
97
                return s
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)
 
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)
115
107
 
116
108
    def __unicode__(self):
117
109
        u = self._format()
140
132
        """Return format string for this exception or None"""
141
133
        fmt = getattr(self, '_fmt', None)
142
134
        if fmt is not None:
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
 
               )
 
135
            from bzrlib.i18n import gettext
 
136
            return gettext(unicode(fmt)) # _fmt strings should be ascii
155
137
 
156
138
    def __eq__(self, other):
157
139
        if self.__class__ is not other.__class__:
170
152
    internal_error = True
171
153
 
172
154
 
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
 
 
206
155
class AlreadyBuilding(BzrError):
207
156
 
208
157
    _fmt = "The tree builder is already building a tree."
751
700
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
752
701
 
753
702
 
 
703
class AlreadyControlDirError(PathError):
 
704
 
 
705
    _fmt = 'A control directory already exists: "%(path)s".'
 
706
 
 
707
 
754
708
class AlreadyBranchError(PathError):
755
709
 
756
710
    _fmt = 'Already a branch: "%(path)s".'
757
711
 
758
712
 
 
713
class InvalidBranchName(PathError):
 
714
 
 
715
    _fmt = "Invalid branch name: %(name)s"
 
716
 
 
717
    def __init__(self, name):
 
718
        BzrError.__init__(self)
 
719
        self.name = name
 
720
 
 
721
 
 
722
class ParentBranchExists(AlreadyBranchError):
 
723
 
 
724
    _fmt = 'Parent branch already exists: "%(path)s".'
 
725
 
 
726
 
759
727
class BranchExistsWithoutWorkingTree(PathError):
760
728
 
761
729
    _fmt = 'Directory contains a branch, but no working tree \
790
758
        self.path = bzrdir.transport.clone('..').base
791
759
 
792
760
 
793
 
class FileInWrongBranch(BzrError):
794
 
 
795
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
796
 
 
797
 
    # use PathNotChild instead
798
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 3, 0)))
799
 
    def __init__(self, branch, path):
800
 
        BzrError.__init__(self)
801
 
        self.branch = branch
802
 
        self.branch_base = branch.base
803
 
        self.path = path
804
 
 
805
 
 
806
761
class UnsupportedFormatError(BzrError):
807
762
 
808
763
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
827
782
        self.bzrdir = bzrdir_format
828
783
 
829
784
 
 
785
class ParseFormatError(BzrError):
 
786
 
 
787
    _fmt = "Parse error on line %(lineno)d of %(format)s format: %(line)s"
 
788
 
 
789
    def __init__(self, format, lineno, line, text):
 
790
        BzrError.__init__(self)
 
791
        self.format = format
 
792
        self.lineno = lineno
 
793
        self.line = line
 
794
        self.text = text
 
795
 
 
796
 
830
797
class IncompatibleRepositories(BzrError):
831
798
    """Report an error that two repositories are not compatible.
832
799
 
1221
1188
            self.extra = ''
1222
1189
 
1223
1190
 
1224
 
class HistoryMissing(BzrError):
1225
 
 
1226
 
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
1227
 
 
1228
 
 
1229
1191
class AppendRevisionsOnlyViolation(BzrError):
1230
1192
 
1231
1193
    _fmt = ('Operation denied because it would change the main history,'
1296
1258
            not_ancestor_id=not_ancestor_id)
1297
1259
 
1298
1260
 
1299
 
class AmbiguousBase(BzrError):
1300
 
 
1301
 
    def __init__(self, bases):
1302
 
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1303
 
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1304
 
        msg = ("The correct base is unclear, because %s are all equally close"
1305
 
                % ", ".join(bases))
1306
 
        BzrError.__init__(self, msg)
1307
 
        self.bases = bases
1308
 
 
1309
 
 
1310
1261
class NoCommits(BranchError):
1311
1262
 
1312
1263
    _fmt = "Branch %(branch)s has no commits."
1572
1523
            problem we can raise the original error (value from sys.exc_info())
1573
1524
        """
1574
1525
        BzrError.__init__(self)
 
1526
        self.context = context
1575
1527
        self.reload_occurred = reload_occurred
1576
1528
        self.exc_info = exc_info
1577
1529
        self.orig_error = exc_info[1]
1659
1611
 
1660
1612
    def __init__(self, exc_info):
1661
1613
        import traceback
 
1614
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1662
1615
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1663
1616
        self.exc_info = exc_info
1664
1617
        traceback_strings = traceback.format_exception(
1703
1656
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1704
1657
 
1705
1658
 
 
1659
class ConnectionTimeout(ConnectionError):
 
1660
 
 
1661
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1662
 
 
1663
 
1706
1664
class InvalidRange(TransportError):
1707
1665
 
1708
1666
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1804
1762
 
1805
1763
class ConfigOptionValueError(BzrError):
1806
1764
 
1807
 
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
1765
    _fmt = ('Bad value "%(value)s" for option "%(name)s".\n'
 
1766
            'See ``bzr help %(name)s``')
1808
1767
 
1809
1768
    def __init__(self, name, value):
1810
1769
        BzrError.__init__(self, name=name, value=value)
1972
1931
        self.prefix = prefix
1973
1932
 
1974
1933
 
1975
 
class MalformedTransform(BzrError):
 
1934
class MalformedTransform(InternalBzrError):
1976
1935
 
1977
1936
    _fmt = "Tree transform is malformed %(conflicts)r"
1978
1937
 
2072
2031
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2073
2032
 
2074
2033
 
2075
 
class BzrRemoveChangedFilesError(BzrError):
2076
 
    """Used when user is trying to remove changed files."""
2077
 
 
2078
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
2079
 
        "%(changes_as_text)s"
2080
 
        "Use --keep to not delete them, or --force to delete them regardless.")
2081
 
 
2082
 
    def __init__(self, tree_delta):
2083
 
        symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
2084
 
            "BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
2085
 
        BzrError.__init__(self)
2086
 
        self.changes_as_text = tree_delta.get_changes_as_text()
2087
 
        #self.paths_as_string = '\n'.join(changed_files)
2088
 
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
2089
 
 
2090
 
 
2091
2034
class BzrBadParameterNotString(BzrBadParameter):
2092
2035
 
2093
2036
    _fmt = "Parameter %(param)s is not a string or unicode string."
2349
2292
    """
2350
2293
 
2351
2294
 
 
2295
class GhostTagsNotSupported(BzrError):
 
2296
 
 
2297
    _fmt = "Ghost tags not supported by format %(format)r."
 
2298
 
 
2299
    def __init__(self, format):
 
2300
        self.format = format
 
2301
 
 
2302
 
2352
2303
class BinaryFile(BzrError):
2353
2304
 
2354
2305
    _fmt = "File is binary but should be text."
2784
2735
    _fmt = "Container has multiple records with the same name: %(name)s"
2785
2736
 
2786
2737
    def __init__(self, name):
2787
 
        self.name = name
 
2738
        self.name = name.decode("utf-8")
2788
2739
 
2789
2740
 
2790
2741
class NoDestinationAddress(InternalBzrError):
2818
2769
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2819
2770
 
2820
2771
 
2821
 
class UnknownMailClient(BzrError):
2822
 
 
2823
 
    _fmt = "Unknown mail client: %(mail_client)s"
2824
 
 
2825
 
    def __init__(self, mail_client):
2826
 
        BzrError.__init__(self, mail_client=mail_client)
2827
 
 
2828
 
 
2829
2772
class MailClientNotFound(BzrError):
2830
2773
 
2831
2774
    _fmt = "Unable to find mail client with the following names:"\
2942
2885
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2943
2886
 
2944
2887
 
 
2888
class StoringUncommittedNotSupported(BzrError):
 
2889
 
 
2890
    _fmt = ('Branch "%(display_url)s" does not support storing uncommitted'
 
2891
            ' changes.')
 
2892
 
 
2893
    def __init__(self, branch):
 
2894
        import bzrlib.urlutils as urlutils
 
2895
        user_url = getattr(branch, "user_url", None)
 
2896
        if user_url is None:
 
2897
            display_url = str(branch)
 
2898
        else:
 
2899
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2900
        BzrError.__init__(self, branch=branch, display_url=display_url)
 
2901
 
 
2902
 
2945
2903
class ShelvedChanges(UncommittedChanges):
2946
2904
 
2947
2905
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
3019
2977
        from bzrlib.osutils import get_user_encoding
3020
2978
        self.path = path
3021
2979
        self.kind = kind
3022
 
        self.user_encoding = osutils.get_user_encoding()
 
2980
        self.user_encoding = get_user_encoding()
3023
2981
 
3024
2982
 
3025
2983
class NoSuchConfig(BzrError):
3086
3044
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
3087
3045
 
3088
3046
 
3089
 
class HookFailed(BzrError):
3090
 
    """Raised when a pre_change_branch_tip hook function fails anything other
3091
 
    than TipChangeRejected.
3092
 
 
3093
 
    Note that this exception is no longer raised, and the import is only left
3094
 
    to be nice to code which might catch it in a plugin.
3095
 
    """
3096
 
 
3097
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
3098
 
            "%(traceback_text)s%(exc_value)s")
3099
 
 
3100
 
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
3101
 
        if warn:
3102
 
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
3103
 
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
3104
 
        import traceback
3105
 
        self.hook_stage = hook_stage
3106
 
        self.hook_name = hook_name
3107
 
        self.exc_info = exc_info
3108
 
        self.exc_type = exc_info[0]
3109
 
        self.exc_value = exc_info[1]
3110
 
        self.exc_tb = exc_info[2]
3111
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
3112
 
 
3113
 
 
3114
3047
class TipChangeRejected(BzrError):
3115
3048
    """A pre_change_branch_tip hook function may raise this to cleanly and
3116
3049
    explicitly abort a change to a branch tip.
3309
3242
 
3310
3243
class ExpandingUnknownOption(BzrError):
3311
3244
 
3312
 
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
 
3245
    _fmt = 'Option "%(name)s" is not defined while expanding "%(string)s".'
3313
3246
 
3314
3247
    def __init__(self, name, string):
3315
3248
        self.name = name
3316
3249
        self.string = string
3317
3250
 
3318
3251
 
 
3252
class IllegalOptionName(BzrError):
 
3253
 
 
3254
    _fmt = 'Option "%(name)s" is not allowed.'
 
3255
 
 
3256
    def __init__(self, name):
 
3257
        self.name = name
 
3258
 
 
3259
 
3319
3260
class NoCompatibleInter(BzrError):
3320
3261
 
3321
3262
    _fmt = ('No compatible object available for operations from %(source)r '
3324
3265
    def __init__(self, source, target):
3325
3266
        self.source = source
3326
3267
        self.target = target
 
3268
 
 
3269
 
 
3270
class HpssVfsRequestNotAllowed(BzrError):
 
3271
 
 
3272
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
 
3273
            "%(method)s, %(arguments)s.")
 
3274
 
 
3275
    def __init__(self, method, arguments):
 
3276
        self.method = method
 
3277
        self.arguments = arguments
 
3278
 
 
3279
 
 
3280
class UnsupportedKindChange(BzrError):
 
3281
 
 
3282
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
 
3283
            "%(path)s not supported by format %(format)r")
 
3284
 
 
3285
    def __init__(self, path, from_kind, to_kind, format):
 
3286
        self.path = path
 
3287
        self.from_kind = from_kind
 
3288
        self.to_kind = to_kind
 
3289
        self.format = format
 
3290
 
 
3291
 
 
3292
class MissingFeature(BzrError):
 
3293
 
 
3294
    _fmt = ("Missing feature %(feature)s not provided by this "
 
3295
            "version of Bazaar or any plugin.")
 
3296
 
 
3297
    def __init__(self, feature):
 
3298
        self.feature = feature
 
3299
 
 
3300
 
 
3301
class PatchSyntax(BzrError):
 
3302
    """Base class for patch syntax errors."""
 
3303
 
 
3304
 
 
3305
class BinaryFiles(BzrError):
 
3306
 
 
3307
    _fmt = 'Binary files section encountered.'
 
3308
 
 
3309
    def __init__(self, orig_name, mod_name):
 
3310
        self.orig_name = orig_name
 
3311
        self.mod_name = mod_name
 
3312
 
 
3313
 
 
3314
class MalformedPatchHeader(PatchSyntax):
 
3315
 
 
3316
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
 
3317
 
 
3318
    def __init__(self, desc, line):
 
3319
        self.desc = desc
 
3320
        self.line = line
 
3321
 
 
3322
 
 
3323
class MalformedHunkHeader(PatchSyntax):
 
3324
 
 
3325
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
 
3326
 
 
3327
    def __init__(self, desc, line):
 
3328
        self.desc = desc
 
3329
        self.line = line
 
3330
 
 
3331
 
 
3332
class MalformedLine(PatchSyntax):
 
3333
 
 
3334
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
 
3335
 
 
3336
    def __init__(self, desc, line):
 
3337
        self.desc = desc
 
3338
        self.line = line
 
3339
 
 
3340
 
 
3341
class PatchConflict(BzrError):
 
3342
 
 
3343
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
 
3344
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
 
3345
 
 
3346
    def __init__(self, line_no, orig_line, patch_line):
 
3347
        self.line_no = line_no
 
3348
        self.orig_line = orig_line.rstrip('\n')
 
3349
        self.patch_line = patch_line.rstrip('\n')
 
3350
 
 
3351
 
 
3352
class FeatureAlreadyRegistered(BzrError):
 
3353
 
 
3354
    _fmt = 'The feature %(feature)s has already been registered.'
 
3355
 
 
3356
    def __init__(self, feature):
 
3357
        self.feature = feature
 
3358
 
 
3359
 
 
3360
class ChangesAlreadyStored(BzrCommandError):
 
3361
 
 
3362
    _fmt = ('Cannot store uncommitted changes because this branch already'
 
3363
            ' stores uncommitted changes.')