~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Vincent Ladeuil
  • Date: 2012-03-13 17:25:29 UTC
  • mfrom: (6499 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6501.
  • Revision ID: v.ladeuil+lp@free.fr-20120313172529-i0suyjnepsor25i7
Merge trunk

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."
621
570
 
622
571
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
623
572
 
624
 
    def __init__(self, url, extra):
 
573
    def __init__(self, url, extra=""):
625
574
        PathError.__init__(self, url, extra=extra)
626
575
 
627
576
 
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"
1728
1686
        TransportError.__init__(self, msg, orig_error=orig_error)
1729
1687
 
1730
1688
 
 
1689
class CertificateError(TransportError):
 
1690
 
 
1691
    _fmt = "Certificate error: %(error)s"
 
1692
 
 
1693
    def __init__(self, error):
 
1694
        self.error = error
 
1695
 
 
1696
 
1731
1697
class InvalidHttpRange(InvalidHttpResponse):
1732
1698
 
1733
1699
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1737
1703
        InvalidHttpResponse.__init__(self, path, msg)
1738
1704
 
1739
1705
 
 
1706
class HttpBoundaryMissing(InvalidHttpResponse):
 
1707
    """A multipart response ends with no boundary marker.
 
1708
 
 
1709
    This is a special case caused by buggy proxies, described in
 
1710
    <https://bugs.launchpad.net/bzr/+bug/198646>.
 
1711
    """
 
1712
 
 
1713
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
 
1714
 
 
1715
    def __init__(self, path, msg):
 
1716
        InvalidHttpResponse.__init__(self, path, msg)
 
1717
 
 
1718
 
1740
1719
class InvalidHttpContentType(InvalidHttpResponse):
1741
1720
 
1742
1721
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1789
1768
        self.errors = '\n'.join(e.msg for e in errors)
1790
1769
 
1791
1770
 
 
1771
class ConfigOptionValueError(BzrError):
 
1772
 
 
1773
    _fmt = ('Bad value "%(value)s" for option "%(name)s".\n'
 
1774
            'See ``bzr help %(name)s``')
 
1775
 
 
1776
    def __init__(self, name, value):
 
1777
        BzrError.__init__(self, name=name, value=value)
 
1778
 
 
1779
 
1792
1780
class NoEmailInUsername(BzrError):
1793
1781
 
1794
1782
    _fmt = "%(username)r does not seem to contain a reasonable email address"
1951
1939
        self.prefix = prefix
1952
1940
 
1953
1941
 
1954
 
class MalformedTransform(BzrError):
 
1942
class MalformedTransform(InternalBzrError):
1955
1943
 
1956
1944
    _fmt = "Tree transform is malformed %(conflicts)r"
1957
1945
 
2051
2039
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2052
2040
 
2053
2041
 
2054
 
class BzrRemoveChangedFilesError(BzrError):
2055
 
    """Used when user is trying to remove changed files."""
2056
 
 
2057
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
2058
 
        "%(changes_as_text)s"
2059
 
        "Use --keep to not delete them, or --force to delete them regardless.")
2060
 
 
2061
 
    def __init__(self, tree_delta):
2062
 
        symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
2063
 
            "BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
2064
 
        BzrError.__init__(self)
2065
 
        self.changes_as_text = tree_delta.get_changes_as_text()
2066
 
        #self.paths_as_string = '\n'.join(changed_files)
2067
 
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
2068
 
 
2069
 
 
2070
2042
class BzrBadParameterNotString(BzrBadParameter):
2071
2043
 
2072
2044
    _fmt = "Parameter %(param)s is not a string or unicode string."
2328
2300
    """
2329
2301
 
2330
2302
 
 
2303
class GhostTagsNotSupported(BzrError):
 
2304
 
 
2305
    _fmt = "Ghost tags not supported by format %(format)r."
 
2306
 
 
2307
    def __init__(self, format):
 
2308
        self.format = format
 
2309
 
 
2310
 
2331
2311
class BinaryFile(BzrError):
2332
2312
 
2333
2313
    _fmt = "File is binary but should be text."
2763
2743
    _fmt = "Container has multiple records with the same name: %(name)s"
2764
2744
 
2765
2745
    def __init__(self, name):
2766
 
        self.name = name
 
2746
        self.name = name.decode("utf-8")
2767
2747
 
2768
2748
 
2769
2749
class NoDestinationAddress(InternalBzrError):
2797
2777
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2798
2778
 
2799
2779
 
2800
 
class UnknownMailClient(BzrError):
2801
 
 
2802
 
    _fmt = "Unknown mail client: %(mail_client)s"
2803
 
 
2804
 
    def __init__(self, mail_client):
2805
 
        BzrError.__init__(self, mail_client=mail_client)
2806
 
 
2807
 
 
2808
2780
class MailClientNotFound(BzrError):
2809
2781
 
2810
2782
    _fmt = "Unable to find mail client with the following names:"\
2998
2970
        from bzrlib.osutils import get_user_encoding
2999
2971
        self.path = path
3000
2972
        self.kind = kind
3001
 
        self.user_encoding = osutils.get_user_encoding()
 
2973
        self.user_encoding = get_user_encoding()
3002
2974
 
3003
2975
 
3004
2976
class NoSuchConfig(BzrError):
3065
3037
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
3066
3038
 
3067
3039
 
3068
 
class HookFailed(BzrError):
3069
 
    """Raised when a pre_change_branch_tip hook function fails anything other
3070
 
    than TipChangeRejected.
3071
 
 
3072
 
    Note that this exception is no longer raised, and the import is only left
3073
 
    to be nice to code which might catch it in a plugin.
3074
 
    """
3075
 
 
3076
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
3077
 
            "%(traceback_text)s%(exc_value)s")
3078
 
 
3079
 
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
3080
 
        if warn:
3081
 
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
3082
 
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
3083
 
        import traceback
3084
 
        self.hook_stage = hook_stage
3085
 
        self.hook_name = hook_name
3086
 
        self.exc_info = exc_info
3087
 
        self.exc_type = exc_info[0]
3088
 
        self.exc_value = exc_info[1]
3089
 
        self.exc_tb = exc_info[2]
3090
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
3091
 
 
3092
 
 
3093
3040
class TipChangeRejected(BzrError):
3094
3041
    """A pre_change_branch_tip hook function may raise this to cleanly and
3095
3042
    explicitly abort a change to a branch tip.
3303
3250
    def __init__(self, source, target):
3304
3251
        self.source = source
3305
3252
        self.target = target
 
3253
 
 
3254
 
 
3255
class HpssVfsRequestNotAllowed(BzrError):
 
3256
 
 
3257
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
 
3258
            "%(method)s, %(arguments)s.")
 
3259
 
 
3260
    def __init__(self, method, arguments):
 
3261
        self.method = method
 
3262
        self.arguments = arguments
 
3263
 
 
3264
 
 
3265
class UnsupportedKindChange(BzrError):
 
3266
 
 
3267
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
 
3268
            "%(path)s not supported by format %(format)r")
 
3269
 
 
3270
    def __init__(self, path, from_kind, to_kind, format):
 
3271
        self.path = path
 
3272
        self.from_kind = from_kind
 
3273
        self.to_kind = to_kind
 
3274
        self.format = format
 
3275
 
 
3276
 
 
3277
class MissingFeature(BzrError):
 
3278
 
 
3279
    _fmt = ("Missing feature %(feature)s not provided by this "
 
3280
            "version of Bazaar or any plugin.")
 
3281
 
 
3282
    def __init__(self, feature):
 
3283
        self.feature = feature
 
3284
 
 
3285
 
 
3286
class PatchSyntax(BzrError):
 
3287
    """Base class for patch syntax errors."""
 
3288
 
 
3289
 
 
3290
class BinaryFiles(BzrError):
 
3291
 
 
3292
    _fmt = 'Binary files section encountered.'
 
3293
 
 
3294
    def __init__(self, orig_name, mod_name):
 
3295
        self.orig_name = orig_name
 
3296
        self.mod_name = mod_name
 
3297
 
 
3298
 
 
3299
class MalformedPatchHeader(PatchSyntax):
 
3300
 
 
3301
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
 
3302
 
 
3303
    def __init__(self, desc, line):
 
3304
        self.desc = desc
 
3305
        self.line = line
 
3306
 
 
3307
 
 
3308
class MalformedHunkHeader(PatchSyntax):
 
3309
 
 
3310
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
 
3311
 
 
3312
    def __init__(self, desc, line):
 
3313
        self.desc = desc
 
3314
        self.line = line
 
3315
 
 
3316
 
 
3317
class MalformedLine(PatchSyntax):
 
3318
 
 
3319
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
 
3320
 
 
3321
    def __init__(self, desc, line):
 
3322
        self.desc = desc
 
3323
        self.line = line
 
3324
 
 
3325
 
 
3326
class PatchConflict(BzrError):
 
3327
 
 
3328
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
 
3329
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
 
3330
 
 
3331
    def __init__(self, line_no, orig_line, patch_line):
 
3332
        self.line_no = line_no
 
3333
        self.orig_line = orig_line.rstrip('\n')
 
3334
        self.patch_line = patch_line.rstrip('\n')
 
3335
 
 
3336
 
 
3337
class FeatureAlreadyRegistered(BzrError):
 
3338
 
 
3339
    _fmt = 'The feature %(feature)s has already been registered.'
 
3340
 
 
3341
    def __init__(self, feature):
 
3342
        self.feature = feature