test_virtual_functions.py 11.1 KB
Newer Older
1
# -*- coding: utf-8 -*-
Dean Moldovan's avatar
Dean Moldovan committed
2
import pytest
3
4

from pybind11_tests import virtual_functions as m
Dean Moldovan's avatar
Dean Moldovan committed
5
6
7
8
from pybind11_tests import ConstructorStats


def test_override(capture, msg):
9
    class ExtendedExampleVirt(m.ExampleVirt):
Dean Moldovan's avatar
Dean Moldovan committed
10
11
12
13
14
15
16
17
18
19
20
21
        def __init__(self, state):
            super(ExtendedExampleVirt, self).__init__(state + 1)
            self.data = "Hello world"

        def run(self, value):
            print('ExtendedExampleVirt::run(%i), calling parent..' % value)
            return super(ExtendedExampleVirt, self).run(value + 1)

        def run_bool(self):
            print('ExtendedExampleVirt::run_bool()')
            return False

22
23
24
        def get_string1(self):
            return "override1"

Dean Moldovan's avatar
Dean Moldovan committed
25
26
27
        def pure_virtual(self):
            print('ExtendedExampleVirt::pure_virtual(): %s' % self.data)

28
29
30
31
32
33
34
    class ExtendedExampleVirt2(ExtendedExampleVirt):
        def __init__(self, state):
            super(ExtendedExampleVirt2, self).__init__(state + 1)

        def get_string2(self):
            return "override2"

35
    ex12 = m.ExampleVirt(10)
Dean Moldovan's avatar
Dean Moldovan committed
36
    with capture:
37
        assert m.runExampleVirt(ex12, 20) == 30
38
39
40
    assert capture == """
        Original implementation of ExampleVirt::run(state=10, value=20, str1=default1, str2=default2)
    """  # noqa: E501 line too long
Dean Moldovan's avatar
Dean Moldovan committed
41
42

    with pytest.raises(RuntimeError) as excinfo:
43
        m.runExampleVirtVirtual(ex12)
Dean Moldovan's avatar
Dean Moldovan committed
44
45
46
47
    assert msg(excinfo.value) == 'Tried to call pure virtual function "ExampleVirt::pure_virtual"'

    ex12p = ExtendedExampleVirt(10)
    with capture:
48
        assert m.runExampleVirt(ex12p, 20) == 32
Dean Moldovan's avatar
Dean Moldovan committed
49
50
    assert capture == """
        ExtendedExampleVirt::run(20), calling parent..
51
        Original implementation of ExampleVirt::run(state=11, value=21, str1=override1, str2=default2)
52
    """  # noqa: E501 line too long
Dean Moldovan's avatar
Dean Moldovan committed
53
    with capture:
54
        assert m.runExampleVirtBool(ex12p) is False
Dean Moldovan's avatar
Dean Moldovan committed
55
56
    assert capture == "ExtendedExampleVirt::run_bool()"
    with capture:
57
        m.runExampleVirtVirtual(ex12p)
Dean Moldovan's avatar
Dean Moldovan committed
58
59
    assert capture == "ExtendedExampleVirt::pure_virtual(): Hello world"

60
61
    ex12p2 = ExtendedExampleVirt2(15)
    with capture:
62
        assert m.runExampleVirt(ex12p2, 50) == 68
63
64
65
    assert capture == """
        ExtendedExampleVirt::run(50), calling parent..
        Original implementation of ExampleVirt::run(state=17, value=51, str1=override1, str2=override2)
66
    """  # noqa: E501 line too long
67

68
    cstats = ConstructorStats.get(m.ExampleVirt)
69
70
    assert cstats.alive() == 3
    del ex12, ex12p, ex12p2
Dean Moldovan's avatar
Dean Moldovan committed
71
    assert cstats.alive() == 0
72
    assert cstats.values() == ['10', '11', '17']
Dean Moldovan's avatar
Dean Moldovan committed
73
74
75
76
    assert cstats.copy_constructions == 0
    assert cstats.move_constructions >= 0


77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def test_alias_delay_initialization1(capture):
    """`A` only initializes its trampoline class when we inherit from it

    If we just create and use an A instance directly, the trampoline initialization is
    bypassed and we only initialize an A() instead (for performance reasons).
    """
    class B(m.A):
        def __init__(self):
            super(B, self).__init__()

        def f(self):
            print("In python f()")

    # C++ version
    with capture:
        a = m.A()
        m.call_f(a)
        del a
        pytest.gc_collect()
    assert capture == "A.f()"

    # Python version
    with capture:
        b = B()
        m.call_f(b)
        del b
        pytest.gc_collect()
    assert capture == """
        PyA.PyA()
        PyA.f()
        In python f()
        PyA.~PyA()
    """


def test_alias_delay_initialization2(capture):
    """`A2`, unlike the above, is configured to always initialize the alias

    While the extra initialization and extra class layer has small virtual dispatch
    performance penalty, it also allows us to do more things with the trampoline
    class such as defining local variables and performing construction/destruction.
    """
    class B2(m.A2):
        def __init__(self):
            super(B2, self).__init__()
Dean Moldovan's avatar
Dean Moldovan committed
122

123
124
125
126
127
128
129
130
131
        def f(self):
            print("In python B2.f()")

    # No python subclass version
    with capture:
        a2 = m.A2()
        m.call_f(a2)
        del a2
        pytest.gc_collect()
132
133
134
135
        a3 = m.A2(1)
        m.call_f(a3)
        del a3
        pytest.gc_collect()
136
137
138
139
140
    assert capture == """
        PyA2.PyA2()
        PyA2.f()
        A2.f()
        PyA2.~PyA2()
141
142
143
144
        PyA2.PyA2()
        PyA2.f()
        A2.f()
        PyA2.~PyA2()
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
    """

    # Python subclass version
    with capture:
        b2 = B2()
        m.call_f(b2)
        del b2
        pytest.gc_collect()
    assert capture == """
        PyA2.PyA2()
        PyA2.f()
        In python B2.f()
        PyA2.~PyA2()
    """


161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# PyPy: Reference count > 1 causes call with noncopyable instance
# to fail in ncv1.print_nc()
@pytest.unsupported_on_pypy
@pytest.mark.skipif(not hasattr(m, "NCVirt"), reason="NCVirt test broken on ICPC")
def test_move_support():
    class NCVirtExt(m.NCVirt):
        def get_noncopyable(self, a, b):
            # Constructs and returns a new instance:
            nc = m.NonCopyable(a * a, b * b)
            return nc

        def get_movable(self, a, b):
            # Return a referenced copy
            self.movable = m.Movable(a, b)
            return self.movable

    class NCVirtExt2(m.NCVirt):
        def get_noncopyable(self, a, b):
            # Keep a reference: this is going to throw an exception
            self.nc = m.NonCopyable(a, b)
            return self.nc

        def get_movable(self, a, b):
            # Return a new instance without storing it
            return m.Movable(a, b)

    ncv1 = NCVirtExt()
    assert ncv1.print_nc(2, 3) == "36"
    assert ncv1.print_movable(4, 5) == "9"
    ncv2 = NCVirtExt2()
    assert ncv2.print_movable(7, 7) == "14"
    # Don't check the exception message here because it differs under debug/non-debug mode
    with pytest.raises(RuntimeError):
        ncv2.print_nc(9, 9)

    nc_stats = ConstructorStats.get(m.NonCopyable)
    mv_stats = ConstructorStats.get(m.Movable)
    assert nc_stats.alive() == 1
    assert mv_stats.alive() == 1
    del ncv1, ncv2
    assert nc_stats.alive() == 0
    assert mv_stats.alive() == 0
    assert nc_stats.values() == ['4', '9', '9', '9']
    assert mv_stats.values() == ['4', '5', '7', '7']
    assert nc_stats.copy_constructions == 0
    assert mv_stats.copy_constructions == 1
    assert nc_stats.move_constructions >= 0
    assert mv_stats.move_constructions >= 0


def test_dispatch_issue(msg):
    """#159: virtual function dispatch has problems with similar-named functions"""
    class PyClass1(m.DispatchIssue):
        def dispatch(self):
            return "Yay.."

    class PyClass2(m.DispatchIssue):
        def dispatch(self):
            with pytest.raises(RuntimeError) as excinfo:
                super(PyClass2, self).dispatch()
            assert msg(excinfo.value) == 'Tried to call pure virtual function "Base::dispatch"'

            p = PyClass1()
            return m.dispatch_issue_go(p)

    b = PyClass2()
    assert m.dispatch_issue_go(b) == "Yay.."


def test_override_ref():
Unknown's avatar
Unknown committed
231
    """#392/397: overriding reference-returning functions"""
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
    o = m.OverrideTest("asdf")

    # Not allowed (see associated .cpp comment)
    # i = o.str_ref()
    # assert o.str_ref() == "asdf"
    assert o.str_value() == "asdf"

    assert o.A_value().value == "hi"
    a = o.A_ref()
    assert a.value == "hi"
    a.value = "bye"
    assert a.value == "bye"


def test_inherited_virtuals():
247
    class AR(m.A_Repeat):
Dean Moldovan's avatar
Dean Moldovan committed
248
249
250
        def unlucky_number(self):
            return 99

251
    class AT(m.A_Tpl):
Dean Moldovan's avatar
Dean Moldovan committed
252
253
254
        def unlucky_number(self):
            return 999

255
    obj = AR()
256
    assert obj.say_something(3) == "hihihi"
Dean Moldovan's avatar
Dean Moldovan committed
257
    assert obj.unlucky_number() == 99
258
    assert obj.say_everything() == "hi 99"
Dean Moldovan's avatar
Dean Moldovan committed
259

260
    obj = AT()
261
    assert obj.say_something(3) == "hihihi"
Dean Moldovan's avatar
Dean Moldovan committed
262
    assert obj.unlucky_number() == 999
263
    assert obj.say_everything() == "hi 999"
Dean Moldovan's avatar
Dean Moldovan committed
264

265
    for obj in [m.B_Repeat(), m.B_Tpl()]:
266
        assert obj.say_something(3) == "B says hi 3 times"
Dean Moldovan's avatar
Dean Moldovan committed
267
268
        assert obj.unlucky_number() == 13
        assert obj.lucky_number() == 7.0
269
        assert obj.say_everything() == "B says hi 1 times 13"
Dean Moldovan's avatar
Dean Moldovan committed
270

271
    for obj in [m.C_Repeat(), m.C_Tpl()]:
272
        assert obj.say_something(3) == "B says hi 3 times"
Dean Moldovan's avatar
Dean Moldovan committed
273
274
        assert obj.unlucky_number() == 4444
        assert obj.lucky_number() == 888.0
275
        assert obj.say_everything() == "B says hi 1 times 4444"
Dean Moldovan's avatar
Dean Moldovan committed
276

277
    class CR(m.C_Repeat):
Dean Moldovan's avatar
Dean Moldovan committed
278
        def lucky_number(self):
279
            return m.C_Repeat.lucky_number(self) + 1.25
Dean Moldovan's avatar
Dean Moldovan committed
280

281
    obj = CR()
282
    assert obj.say_something(3) == "B says hi 3 times"
Dean Moldovan's avatar
Dean Moldovan committed
283
284
    assert obj.unlucky_number() == 4444
    assert obj.lucky_number() == 889.25
285
    assert obj.say_everything() == "B says hi 1 times 4444"
Dean Moldovan's avatar
Dean Moldovan committed
286

287
    class CT(m.C_Tpl):
Dean Moldovan's avatar
Dean Moldovan committed
288
289
        pass

290
    obj = CT()
291
    assert obj.say_something(3) == "B says hi 3 times"
Dean Moldovan's avatar
Dean Moldovan committed
292
293
    assert obj.unlucky_number() == 4444
    assert obj.lucky_number() == 888.0
294
    assert obj.say_everything() == "B says hi 1 times 4444"
Dean Moldovan's avatar
Dean Moldovan committed
295

296
    class CCR(CR):
Dean Moldovan's avatar
Dean Moldovan committed
297
        def lucky_number(self):
298
            return CR.lucky_number(self) * 10
Dean Moldovan's avatar
Dean Moldovan committed
299

300
    obj = CCR()
301
    assert obj.say_something(3) == "B says hi 3 times"
Dean Moldovan's avatar
Dean Moldovan committed
302
303
    assert obj.unlucky_number() == 4444
    assert obj.lucky_number() == 8892.5
304
    assert obj.say_everything() == "B says hi 1 times 4444"
Dean Moldovan's avatar
Dean Moldovan committed
305

306
    class CCT(CT):
Dean Moldovan's avatar
Dean Moldovan committed
307
        def lucky_number(self):
308
            return CT.lucky_number(self) * 1000
Dean Moldovan's avatar
Dean Moldovan committed
309

310
    obj = CCT()
311
    assert obj.say_something(3) == "B says hi 3 times"
Dean Moldovan's avatar
Dean Moldovan committed
312
313
    assert obj.unlucky_number() == 4444
    assert obj.lucky_number() == 888000.0
314
    assert obj.say_everything() == "B says hi 1 times 4444"
Dean Moldovan's avatar
Dean Moldovan committed
315

316
    class DR(m.D_Repeat):
Dean Moldovan's avatar
Dean Moldovan committed
317
318
319
320
321
322
        def unlucky_number(self):
            return 123

        def lucky_number(self):
            return 42.0

323
    for obj in [m.D_Repeat(), m.D_Tpl()]:
324
        assert obj.say_something(3) == "B says hi 3 times"
Dean Moldovan's avatar
Dean Moldovan committed
325
326
        assert obj.unlucky_number() == 4444
        assert obj.lucky_number() == 888.0
327
        assert obj.say_everything() == "B says hi 1 times 4444"
Dean Moldovan's avatar
Dean Moldovan committed
328

329
    obj = DR()
330
    assert obj.say_something(3) == "B says hi 3 times"
Dean Moldovan's avatar
Dean Moldovan committed
331
332
    assert obj.unlucky_number() == 123
    assert obj.lucky_number() == 42.0
333
    assert obj.say_everything() == "B says hi 1 times 123"
Dean Moldovan's avatar
Dean Moldovan committed
334

335
    class DT(m.D_Tpl):
Dean Moldovan's avatar
Dean Moldovan committed
336
        def say_something(self, times):
337
            return "DT says:" + (' quack' * times)
Dean Moldovan's avatar
Dean Moldovan committed
338
339
340
341
342
343
344

        def unlucky_number(self):
            return 1234

        def lucky_number(self):
            return -4.25

345
346
    obj = DT()
    assert obj.say_something(3) == "DT says: quack quack quack"
Dean Moldovan's avatar
Dean Moldovan committed
347
348
    assert obj.unlucky_number() == 1234
    assert obj.lucky_number() == -4.25
349
    assert obj.say_everything() == "DT says: quack 1234"
350

351
    class DT2(DT):
352
        def say_something(self, times):
353
            return "DT2: " + ('QUACK' * times)
354
355
356
357

        def unlucky_number(self):
            return -3

358
    class BT(m.B_Tpl):
359
        def say_something(self, times):
360
361
            return "BT" * times

362
363
        def unlucky_number(self):
            return -7
364

365
366
367
        def lucky_number(self):
            return -1.375

368
369
    obj = BT()
    assert obj.say_something(3) == "BTBTBT"
370
371
    assert obj.unlucky_number() == -7
    assert obj.lucky_number() == -1.375
372
    assert obj.say_everything() == "BT -7"
373
374
375
376
377
378


def test_issue_1454():
    # Fix issue #1454 (crash when acquiring/releasing GIL on another thread in Python 2.7)
    m.test_gil()
    m.test_gil_from_thread()