~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Martin Packman
  • Date: 2012-01-05 09:50:04 UTC
  • mfrom: (6424 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6426.
  • Revision ID: martin.packman@canonical.com-20120105095004-mia9xb7y0efmto0v
Merge bzr.dev to resolve conflicts in bzrlib.builtins

Show diffs side-by-side

added added

removed removed

Lines of Context:
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."
790
739
        self.path = bzrdir.transport.clone('..').base
791
740
 
792
741
 
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
742
class UnsupportedFormatError(BzrError):
807
743
 
808
744
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
827
763
        self.bzrdir = bzrdir_format
828
764
 
829
765
 
 
766
class ParseFormatError(BzrError):
 
767
 
 
768
    _fmt = "Parse error on line %(lineno)d of %(format)s format: %(line)s"
 
769
 
 
770
    def __init__(self, format, lineno, line, text):
 
771
        BzrError.__init__(self)
 
772
        self.format = format
 
773
        self.lineno = lineno
 
774
        self.line = line
 
775
        self.text = text
 
776
 
 
777
 
830
778
class IncompatibleRepositories(BzrError):
831
779
    """Report an error that two repositories are not compatible.
832
780
 
1221
1169
            self.extra = ''
1222
1170
 
1223
1171
 
1224
 
class HistoryMissing(BzrError):
1225
 
 
1226
 
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
1227
 
 
1228
 
 
1229
1172
class AppendRevisionsOnlyViolation(BzrError):
1230
1173
 
1231
1174
    _fmt = ('Operation denied because it would change the main history,'
1296
1239
            not_ancestor_id=not_ancestor_id)
1297
1240
 
1298
1241
 
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
1242
class NoCommits(BranchError):
1311
1243
 
1312
1244
    _fmt = "Branch %(branch)s has no commits."
1572
1504
            problem we can raise the original error (value from sys.exc_info())
1573
1505
        """
1574
1506
        BzrError.__init__(self)
 
1507
        self.context = context
1575
1508
        self.reload_occurred = reload_occurred
1576
1509
        self.exc_info = exc_info
1577
1510
        self.orig_error = exc_info[1]
1659
1592
 
1660
1593
    def __init__(self, exc_info):
1661
1594
        import traceback
 
1595
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1662
1596
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1663
1597
        self.exc_info = exc_info
1664
1598
        traceback_strings = traceback.format_exception(
1703
1637
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1704
1638
 
1705
1639
 
 
1640
class ConnectionTimeout(ConnectionError):
 
1641
 
 
1642
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1643
 
 
1644
 
1706
1645
class InvalidRange(TransportError):
1707
1646
 
1708
1647
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1972
1911
        self.prefix = prefix
1973
1912
 
1974
1913
 
1975
 
class MalformedTransform(BzrError):
 
1914
class MalformedTransform(InternalBzrError):
1976
1915
 
1977
1916
    _fmt = "Tree transform is malformed %(conflicts)r"
1978
1917
 
2072
2011
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2073
2012
 
2074
2013
 
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
2014
class BzrBadParameterNotString(BzrBadParameter):
2092
2015
 
2093
2016
    _fmt = "Parameter %(param)s is not a string or unicode string."
2349
2272
    """
2350
2273
 
2351
2274
 
 
2275
class GhostTagsNotSupported(BzrError):
 
2276
 
 
2277
    _fmt = "Ghost tags not supported by format %(format)r."
 
2278
 
 
2279
    def __init__(self, format):
 
2280
        self.format = format
 
2281
 
 
2282
 
2352
2283
class BinaryFile(BzrError):
2353
2284
 
2354
2285
    _fmt = "File is binary but should be text."
2784
2715
    _fmt = "Container has multiple records with the same name: %(name)s"
2785
2716
 
2786
2717
    def __init__(self, name):
2787
 
        self.name = name
 
2718
        self.name = name.decode("utf-8")
2788
2719
 
2789
2720
 
2790
2721
class NoDestinationAddress(InternalBzrError):
3019
2950
        from bzrlib.osutils import get_user_encoding
3020
2951
        self.path = path
3021
2952
        self.kind = kind
3022
 
        self.user_encoding = osutils.get_user_encoding()
 
2953
        self.user_encoding = get_user_encoding()
3023
2954
 
3024
2955
 
3025
2956
class NoSuchConfig(BzrError):
3086
3017
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
3087
3018
 
3088
3019
 
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
3020
class TipChangeRejected(BzrError):
3115
3021
    """A pre_change_branch_tip hook function may raise this to cleanly and
3116
3022
    explicitly abort a change to a branch tip.
3334
3240
    def __init__(self, method, arguments):
3335
3241
        self.method = method
3336
3242
        self.arguments = arguments
 
3243
 
 
3244
 
 
3245
class UnsupportedKindChange(BzrError):
 
3246
 
 
3247
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
 
3248
            "%(path)s not supported by format %(format)r")
 
3249
 
 
3250
    def __init__(self, path, from_kind, to_kind, format):
 
3251
        self.path = path
 
3252
        self.from_kind = from_kind
 
3253
        self.to_kind = to_kind
 
3254
        self.format = format
 
3255
 
 
3256
 
 
3257
class MissingFeature(BzrError):
 
3258
 
 
3259
    _fmt = ("Missing feature %(feature)s not provided by this "
 
3260
            "version of Bazaar or any plugin.")
 
3261
 
 
3262
    def __init__(self, feature):
 
3263
        self.feature = feature
 
3264
 
 
3265
 
 
3266
class PatchSyntax(BzrError):
 
3267
    """Base class for patch syntax errors."""
 
3268
 
 
3269
 
 
3270
class BinaryFiles(BzrError):
 
3271
 
 
3272
    _fmt = 'Binary files section encountered.'
 
3273
 
 
3274
    def __init__(self, orig_name, mod_name):
 
3275
        self.orig_name = orig_name
 
3276
        self.mod_name = mod_name
 
3277
 
 
3278
 
 
3279
class MalformedPatchHeader(PatchSyntax):
 
3280
 
 
3281
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
 
3282
 
 
3283
    def __init__(self, desc, line):
 
3284
        self.desc = desc
 
3285
        self.line = line
 
3286
 
 
3287
 
 
3288
class MalformedHunkHeader(PatchSyntax):
 
3289
 
 
3290
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
 
3291
 
 
3292
    def __init__(self, desc, line):
 
3293
        self.desc = desc
 
3294
        self.line = line
 
3295
 
 
3296
 
 
3297
class MalformedLine(PatchSyntax):
 
3298
 
 
3299
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
 
3300
 
 
3301
    def __init__(self, desc, line):
 
3302
        self.desc = desc
 
3303
        self.line = line
 
3304
 
 
3305
 
 
3306
class PatchConflict(BzrError):
 
3307
 
 
3308
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
 
3309
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
 
3310
 
 
3311
    def __init__(self, line_no, orig_line, patch_line):
 
3312
        self.line_no = line_no
 
3313
        self.orig_line = orig_line.rstrip('\n')
 
3314
        self.patch_line = patch_line.rstrip('\n')
 
3315
 
 
3316
 
 
3317
class FeatureAlreadyRegistered(BzrError):
 
3318
 
 
3319
    _fmt = 'The feature %(feature)s has already been registered.'
 
3320
 
 
3321
    def __init__(self, feature):
 
3322
        self.feature = feature