test_exceptions.py 6.59 KB
Newer Older
1
# -*- coding: utf-8 -*-
2
3
import sys

Dean Moldovan's avatar
Dean Moldovan committed
4
5
import pytest

6
from pybind11_tests import exceptions as m
7
import pybind11_cross_module_tests as cm
Dean Moldovan's avatar
Dean Moldovan committed
8

9

10
def test_std_exception(msg):
11
    with pytest.raises(RuntimeError) as excinfo:
12
        m.throw_std_exception()
13
14
15
    assert msg(excinfo.value) == "This exception was intentionally thrown."


16
17
def test_error_already_set(msg):
    with pytest.raises(RuntimeError) as excinfo:
18
        m.throw_already_set(False)
19
20
21
    assert msg(excinfo.value) == "Unknown internal error occurred"

    with pytest.raises(ValueError) as excinfo:
22
        m.throw_already_set(True)
23
24
25
    assert msg(excinfo.value) == "foo"


26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def test_cross_module_exceptions():
    with pytest.raises(RuntimeError) as excinfo:
        cm.raise_runtime_error()
    assert str(excinfo.value) == "My runtime error"

    with pytest.raises(ValueError) as excinfo:
        cm.raise_value_error()
    assert str(excinfo.value) == "My value error"

    with pytest.raises(ValueError) as excinfo:
        cm.throw_pybind_value_error()
    assert str(excinfo.value) == "pybind11 value error"

    with pytest.raises(TypeError) as excinfo:
        cm.throw_pybind_type_error()
    assert str(excinfo.value) == "pybind11 type error"

    with pytest.raises(StopIteration) as excinfo:
        cm.throw_stop_iteration()


47
48
def test_python_call_in_catch():
    d = {}
49
    assert m.python_call_in_destructor(d) is True
50
51
52
    assert d["good"] is True


53
54
55
56
57
58
59
60
61
62
def ignore_pytest_unraisable_warning(f):
    unraisable = "PytestUnraisableExceptionWarning"
    if hasattr(pytest, unraisable):  # Python >= 3.8 and pytest >= 6
        dec = pytest.mark.filterwarnings("ignore::pytest.{}".format(unraisable))
        return dec(f)
    else:
        return f


@ignore_pytest_unraisable_warning
63
64
65
66
def test_python_alreadyset_in_destructor(monkeypatch, capsys):
    hooked = False
    triggered = [False]  # mutable, so Python 2.7 closure can modify it

67
    if hasattr(sys, "unraisablehook"):  # Python 3.8+
68
        hooked = True
69
70
        # Don't take `sys.unraisablehook`, as that's overwritten by pytest
        default_hook = sys.__unraisablehook__
71
72
73

        def hook(unraisable_hook_args):
            exc_type, exc_value, exc_tb, err_msg, obj = unraisable_hook_args
74
            if obj == "already_set demo":
75
76
77
78
79
                triggered[0] = True
            default_hook(unraisable_hook_args)
            return

        # Use monkeypatch so pytest can apply and remove the patch as appropriate
80
        monkeypatch.setattr(sys, "unraisablehook", hook)
81

82
    assert m.python_alreadyset_in_destructor("already_set demo") is True
83
84
85
86
87
    if hooked:
        assert triggered[0] is True

    _, captured_stderr = capsys.readouterr()
    # Error message is different in Python 2 and 3, check for words that appear in both
88
    assert "ignored" in captured_stderr and "already_set demo" in captured_stderr
89
90


91
def test_exception_matches():
92
93
94
    assert m.exception_matches()
    assert m.exception_matches_base()
    assert m.modulenotfound_exception_matches_base()
95
96


Dean Moldovan's avatar
Dean Moldovan committed
97
def test_custom(msg):
98
99
100
    # Can we catch a MyException?
    with pytest.raises(m.MyException) as excinfo:
        m.throws1()
Dean Moldovan's avatar
Dean Moldovan committed
101
102
103
104
    assert msg(excinfo.value) == "this error should go to a custom type"

    # Can we translate to standard Python exceptions?
    with pytest.raises(RuntimeError) as excinfo:
105
        m.throws2()
Dean Moldovan's avatar
Dean Moldovan committed
106
107
108
109
    assert msg(excinfo.value) == "this error should go to a standard Python exception"

    # Can we handle unknown exceptions?
    with pytest.raises(RuntimeError) as excinfo:
110
        m.throws3()
Dean Moldovan's avatar
Dean Moldovan committed
111
112
113
    assert msg(excinfo.value) == "Caught an unknown exception!"

    # Can we delegate to another handler by rethrowing?
114
115
    with pytest.raises(m.MyException) as excinfo:
        m.throws4()
Dean Moldovan's avatar
Dean Moldovan committed
116
117
    assert msg(excinfo.value) == "this error is rethrown"

118
    # Can we fall-through to the default handler?
Dean Moldovan's avatar
Dean Moldovan committed
119
    with pytest.raises(RuntimeError) as excinfo:
120
        m.throws_logic_error()
121
122
123
    assert (
        msg(excinfo.value) == "this error should fall through to the standard handler"
    )
124

125
126
127
128
    # OverFlow error translation.
    with pytest.raises(OverflowError) as excinfo:
        m.throws_overflow_error()

129
    # Can we handle a helper-declared exception?
130
131
    with pytest.raises(m.MyException5) as excinfo:
        m.throws5()
132
133
134
    assert msg(excinfo.value) == "this is a helper-defined translated exception"

    # Exception subclassing:
135
136
    with pytest.raises(m.MyException5) as excinfo:
        m.throws5_1()
137
    assert msg(excinfo.value) == "MyException5 subclass"
138
    assert isinstance(excinfo.value, m.MyException5_1)
139

140
141
    with pytest.raises(m.MyException5_1) as excinfo:
        m.throws5_1()
142
143
    assert msg(excinfo.value) == "MyException5 subclass"

144
    with pytest.raises(m.MyException5) as excinfo:
145
        try:
146
147
            m.throws5()
        except m.MyException5_1:
148
149
            raise RuntimeError("Exception error: caught child from parent")
    assert msg(excinfo.value) == "this is a helper-defined translated exception"
Jason Rhinelander's avatar
Jason Rhinelander committed
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181


def test_nested_throws(capture):
    """Tests nested (e.g. C++ -> Python -> C++) exception handling"""

    def throw_myex():
        raise m.MyException("nested error")

    def throw_myex5():
        raise m.MyException5("nested error 5")

    # In the comments below, the exception is caught in the first step, thrown in the last step

    # C++ -> Python
    with capture:
        m.try_catch(m.MyException5, throw_myex5)
    assert str(capture).startswith("MyException5: nested error 5")

    # Python -> C++ -> Python
    with pytest.raises(m.MyException) as excinfo:
        m.try_catch(m.MyException5, throw_myex)
    assert str(excinfo.value) == "nested error"

    def pycatch(exctype, f, *args):
        try:
            f(*args)
        except m.MyException as e:
            print(e)

    # C++ -> Python -> C++ -> Python
    with capture:
        m.try_catch(
182
183
184
185
186
187
188
            m.MyException5,
            pycatch,
            m.MyException,
            m.try_catch,
            m.MyException,
            throw_myex5,
        )
Jason Rhinelander's avatar
Jason Rhinelander committed
189
190
191
192
193
194
195
196
197
198
199
    assert str(capture).startswith("MyException5: nested error 5")

    # C++ -> Python -> C++
    with capture:
        m.try_catch(m.MyException, pycatch, m.MyException5, m.throws4)
    assert capture == "this error is rethrown"

    # Python -> C++ -> Python -> C++
    with pytest.raises(m.MyException5) as excinfo:
        m.try_catch(m.MyException, pycatch, m.MyException, m.throws5)
    assert str(excinfo.value) == "this is a helper-defined translated exception"
200
201
202
203
204
205
206
207
208
209


# This can often happen if you wrap a pybind11 class in a Python wrapper
def test_invalid_repr():
    class MyRepr(object):
        def __repr__(self):
            raise AttributeError("Example error")

    with pytest.raises(TypeError):
        m.simple_bool_passthrough(MyRepr())