test_builtin_casters.py 16.8 KB
Newer Older
1
2
import sys

3
4
import pytest

5
import env
6
from pybind11_tests import IncType, UserType
7
8
9
10
11
12
13
14
15
from pybind11_tests import builtin_casters as m


def test_simple_string():
    assert m.string_roundtrip("const char *") == "const char *"


def test_unicode_conversion():
    """Tests unicode conversion and error reporting."""
16
17
18
19
    assert m.good_utf8_string() == "Say utf8‽ 🎂 𝐀"
    assert m.good_utf16_string() == "b‽🎂𝐀z"
    assert m.good_utf32_string() == "a𝐀🎂‽z"
    assert m.good_wchar_string() == "a⸘𝐀z"
20
    if hasattr(m, "has_u8string"):
21
        assert m.good_utf8_u8string() == "Say utf8‽ 🎂 𝐀"
22
23
24
25
26
27
28

    with pytest.raises(UnicodeDecodeError):
        m.bad_utf8_string()

    with pytest.raises(UnicodeDecodeError):
        m.bad_utf16_string()

29
    # These are provided only if they actually fail (they don't when 32-bit)
30
31
32
33
34
35
    if hasattr(m, "bad_utf32_string"):
        with pytest.raises(UnicodeDecodeError):
            m.bad_utf32_string()
    if hasattr(m, "bad_wchar_string"):
        with pytest.raises(UnicodeDecodeError):
            m.bad_wchar_string()
36
37
38
    if hasattr(m, "has_u8string"):
        with pytest.raises(UnicodeDecodeError):
            m.bad_utf8_u8string()
39

40
    assert m.u8_Z() == "Z"
41
42
43
44
    assert m.u8_eacute() == "é"
    assert m.u16_ibang() == "‽"
    assert m.u32_mathbfA() == "𝐀"
    assert m.wchar_heart() == "♥"
45
    if hasattr(m, "has_u8string"):
46
        assert m.u8_char8_Z() == "Z"
47
48
49
50


def test_single_char_arguments():
    """Tests failures for passing invalid inputs to char-accepting functions"""
51

52
    def toobig_message(r):
53
        return f"Character code point not in range({r:#x})"
54

55
56
    toolong_message = "Expected a character, but multi-character string found"

57
58
    assert m.ord_char("a") == 0x61  # simple ASCII
    assert m.ord_char_lv("b") == 0x62
59
    assert (
60
        m.ord_char("é") == 0xE9
61
    )  # requires 2 bytes in utf-8, but can be stuffed in a char
62
    with pytest.raises(ValueError) as excinfo:
63
        assert m.ord_char("Ā") == 0x100  # requires 2 bytes, doesn't fit in a char
64
65
    assert str(excinfo.value) == toobig_message(0x100)
    with pytest.raises(ValueError) as excinfo:
66
        assert m.ord_char("ab")
67
68
    assert str(excinfo.value) == toolong_message

69
70
71
72
73
74
75
    assert m.ord_char16("a") == 0x61
    assert m.ord_char16("é") == 0xE9
    assert m.ord_char16_lv("ê") == 0xEA
    assert m.ord_char16("Ā") == 0x100
    assert m.ord_char16("‽") == 0x203D
    assert m.ord_char16("♥") == 0x2665
    assert m.ord_char16_lv("♡") == 0x2661
76
    with pytest.raises(ValueError) as excinfo:
77
        assert m.ord_char16("🎂") == 0x1F382  # requires surrogate pair
78
79
    assert str(excinfo.value) == toobig_message(0x10000)
    with pytest.raises(ValueError) as excinfo:
80
        assert m.ord_char16("aa")
81
82
    assert str(excinfo.value) == toolong_message

83
84
85
86
87
88
    assert m.ord_char32("a") == 0x61
    assert m.ord_char32("é") == 0xE9
    assert m.ord_char32("Ā") == 0x100
    assert m.ord_char32("‽") == 0x203D
    assert m.ord_char32("♥") == 0x2665
    assert m.ord_char32("🎂") == 0x1F382
89
    with pytest.raises(ValueError) as excinfo:
90
        assert m.ord_char32("aa")
91
92
    assert str(excinfo.value) == toolong_message

93
94
95
96
97
    assert m.ord_wchar("a") == 0x61
    assert m.ord_wchar("é") == 0xE9
    assert m.ord_wchar("Ā") == 0x100
    assert m.ord_wchar("‽") == 0x203D
    assert m.ord_wchar("♥") == 0x2665
98
99
    if m.wchar_size == 2:
        with pytest.raises(ValueError) as excinfo:
100
            assert m.ord_wchar("🎂") == 0x1F382  # requires surrogate pair
101
102
        assert str(excinfo.value) == toobig_message(0x10000)
    else:
103
        assert m.ord_wchar("🎂") == 0x1F382
104
    with pytest.raises(ValueError) as excinfo:
105
        assert m.ord_wchar("aa")
106
107
    assert str(excinfo.value) == toolong_message

108
    if hasattr(m, "has_u8string"):
109
110
        assert m.ord_char8("a") == 0x61  # simple ASCII
        assert m.ord_char8_lv("b") == 0x62
111
        assert (
112
            m.ord_char8("é") == 0xE9
113
        )  # requires 2 bytes in utf-8, but can be stuffed in a char
114
        with pytest.raises(ValueError) as excinfo:
115
            assert m.ord_char8("Ā") == 0x100  # requires 2 bytes, doesn't fit in a char
116
117
        assert str(excinfo.value) == toobig_message(0x100)
        with pytest.raises(ValueError) as excinfo:
118
            assert m.ord_char8("ab")
119
120
        assert str(excinfo.value) == toolong_message

121
122
123
124
125
126

def test_bytes_to_string():
    """Tests the ability to pass bytes to C++ string-accepting functions.  Note that this is
    one-way: the only way to return bytes to Python is via the pybind11::bytes class."""
    # Issue #816

127
128
129
130
    assert m.strlen(b"hi") == 2
    assert m.string_length(b"world") == 5
    assert m.string_length("a\x00b".encode()) == 3
    assert m.strlen("a\x00b".encode()) == 1  # C-string limitation
131
132

    # passing in a utf8 encoded string should work
133
    assert m.string_length("💩".encode()) == 4
134
135


kururu002's avatar
kururu002 committed
136
137
138
139
140
141
142
143
144
def test_bytearray_to_string():
    """Tests the ability to pass bytearray to C++ string-accepting functions"""
    assert m.string_length(bytearray(b"Hi")) == 2
    assert m.strlen(bytearray(b"bytearray")) == 9
    assert m.string_length(bytearray()) == 0
    assert m.string_length(bytearray("🦜", "utf-8", "strict")) == 4
    assert m.string_length(bytearray(b"\x80")) == 1


145
146
147
148
@pytest.mark.skipif(not hasattr(m, "has_string_view"), reason="no <string_view>")
def test_string_view(capture):
    """Tests support for C++17 string_view arguments and return values"""
    assert m.string_view_chars("Hi") == [72, 105]
149
    assert m.string_view_chars("Hi 🎂") == [72, 105, 32, 0xF0, 0x9F, 0x8E, 0x82]
150
151
    assert m.string_view16_chars("Hi 🎂") == [72, 105, 32, 0xD83C, 0xDF82]
    assert m.string_view32_chars("Hi 🎂") == [72, 105, 32, 127874]
152
153
    if hasattr(m, "has_u8string"):
        assert m.string_view8_chars("Hi") == [72, 105]
154
        assert m.string_view8_chars("Hi 🎂") == [72, 105, 32, 0xF0, 0x9F, 0x8E, 0x82]
155

156
157
158
    assert m.string_view_return() == "utf8 secret 🎂"
    assert m.string_view16_return() == "utf16 secret 🎂"
    assert m.string_view32_return() == "utf32 secret 🎂"
159
    if hasattr(m, "has_u8string"):
160
        assert m.string_view8_return() == "utf8 secret 🎂"
161
162
163
164

    with capture:
        m.string_view_print("Hi")
        m.string_view_print("utf8 🎂")
165
166
        m.string_view16_print("utf16 🎂")
        m.string_view32_print("utf32 🎂")
167
168
    assert (
        capture
169
        == """
170
171
172
173
174
        Hi 2
        utf8 🎂 9
        utf16 🎂 8
        utf32 🎂 7
    """
175
    )
176
177
178
    if hasattr(m, "has_u8string"):
        with capture:
            m.string_view8_print("Hi")
179
            m.string_view8_print("utf8 🎂")
180
181
        assert (
            capture
182
            == """
183
184
185
            Hi 2
            utf8 🎂 9
        """
186
        )
187
188
189
190

    with capture:
        m.string_view_print("Hi, ascii")
        m.string_view_print("Hi, utf8 🎂")
191
192
        m.string_view16_print("Hi, utf16 🎂")
        m.string_view32_print("Hi, utf32 🎂")
193
194
    assert (
        capture
195
        == """
196
197
198
199
200
        Hi, ascii 9
        Hi, utf8 🎂 13
        Hi, utf16 🎂 12
        Hi, utf32 🎂 11
    """
201
    )
202
203
204
    if hasattr(m, "has_u8string"):
        with capture:
            m.string_view8_print("Hi, ascii")
205
            m.string_view8_print("Hi, utf8 🎂")
206
207
        assert (
            capture
208
            == """
209
210
211
            Hi, ascii 9
            Hi, utf8 🎂 13
        """
212
        )
213

214
    assert m.string_view_bytes() == b"abc \x80\x80 def"
215
216
    assert m.string_view_str() == "abc ‽ def"
    assert m.string_view_from_bytes("abc ‽ def".encode()) == "abc ‽ def"
217
    if hasattr(m, "has_u8string"):
218
219
        assert m.string_view8_str() == "abc ‽ def"
    assert m.string_view_memoryview() == "Have some 🎂".encode()
220
221
222
223

    assert m.bytes_from_type_with_both_operator_string_and_string_view() == b"success"
    assert m.str_from_type_with_both_operator_string_and_string_view() == "success"

224

225
226
227
228
229
230
def test_integer_casting():
    """Issue #929 - out-of-range integer values shouldn't be accepted"""
    assert m.i32_str(-1) == "-1"
    assert m.i64_str(-1) == "-1"
    assert m.i32_str(2000000000) == "2000000000"
    assert m.u32_str(2000000000) == "2000000000"
231
232
    assert m.i64_str(-999999999999) == "-999999999999"
    assert m.u64_str(999999999999) == "999999999999"
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247

    with pytest.raises(TypeError) as excinfo:
        m.u32_str(-1)
    assert "incompatible function arguments" in str(excinfo.value)
    with pytest.raises(TypeError) as excinfo:
        m.u64_str(-1)
    assert "incompatible function arguments" in str(excinfo.value)
    with pytest.raises(TypeError) as excinfo:
        m.i32_str(-3000000000)
    assert "incompatible function arguments" in str(excinfo.value)
    with pytest.raises(TypeError) as excinfo:
        m.i32_str(3000000000)
    assert "incompatible function arguments" in str(excinfo.value)


248
def test_int_convert():
249
    class Int:
250
251
252
        def __int__(self):
            return 42

253
    class NotInt:
254
255
        pass

256
    class Float:
257
258
259
        def __float__(self):
            return 41.99999

260
    class Index:
261
262
263
        def __index__(self):
            return 42

264
    class IntAndIndex:
265
266
267
268
269
270
        def __int__(self):
            return 42

        def __index__(self):
            return 0

271
    class RaisingTypeErrorOnIndex:
272
273
274
275
276
277
        def __index__(self):
            raise TypeError

        def __int__(self):
            return 42

278
    class RaisingValueErrorOnIndex:
279
280
281
282
283
284
285
286
        def __index__(self):
            raise ValueError

        def __int__(self):
            return 42

    convert, noconvert = m.int_passthrough, m.int_passthrough_noconvert

287
    def requires_conversion(v):
288
289
290
291
292
293
294
295
        pytest.raises(TypeError, noconvert, v)

    def cant_convert(v):
        pytest.raises(TypeError, convert, v)

    assert convert(7) == 7
    assert noconvert(7) == 7
    cant_convert(3.14159)
296
    # TODO: Avoid DeprecationWarning in `PyLong_AsLong` (and similar)
297
    # TODO: PyPy 3.8 does not behave like CPython 3.8 here yet (7.3.7)
298
    if (3, 8) <= sys.version_info < (3, 10) and env.CPYTHON:
299
        with env.deprecated_call():
300
301
302
            assert convert(Int()) == 42
    else:
        assert convert(Int()) == 42
303
304
305
306
307
308
309
310
311
312
313
314
315
316
    requires_conversion(Int())
    cant_convert(NotInt())
    cant_convert(Float())

    # Before Python 3.8, `PyLong_AsLong` does not pick up on `obj.__index__`,
    # but pybind11 "backports" this behavior.
    assert convert(Index()) == 42
    assert noconvert(Index()) == 42
    assert convert(IntAndIndex()) == 0  # Fishy; `int(DoubleThought)` == 42
    assert noconvert(IntAndIndex()) == 0
    assert convert(RaisingTypeErrorOnIndex()) == 42
    requires_conversion(RaisingTypeErrorOnIndex())
    assert convert(RaisingValueErrorOnIndex()) == 42
    requires_conversion(RaisingValueErrorOnIndex())
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331


def test_numpy_int_convert():
    np = pytest.importorskip("numpy")

    convert, noconvert = m.int_passthrough, m.int_passthrough_noconvert

    def require_implicit(v):
        pytest.raises(TypeError, noconvert, v)

    # `np.intc` is an alias that corresponds to a C++ `int`
    assert convert(np.intc(42)) == 42
    assert noconvert(np.intc(42)) == 42

    # The implicit conversion from np.float32 is undesirable but currently accepted.
332
    # TODO: Avoid DeprecationWarning in `PyLong_AsLong` (and similar)
333
334
    # TODO: PyPy 3.8 does not behave like CPython 3.8 here yet (7.3.7)
    # https://github.com/pybind/pybind11/issues/3408
335
    if (3, 8) <= sys.version_info < (3, 10) and env.CPYTHON:
336
        with env.deprecated_call():
337
338
339
            assert convert(np.float32(3.14159)) == 3
    else:
        assert convert(np.float32(3.14159)) == 3
340
341
342
    require_implicit(np.float32(3.14159))


343
344
345
346
347
348
349
def test_tuple(doc):
    """std::pair <-> tuple & std::tuple <-> tuple"""
    assert m.pair_passthrough((True, "test")) == ("test", True)
    assert m.tuple_passthrough((True, "test", 5)) == (5, "test", True)
    # Any sequence can be cast to a std::pair or std::tuple
    assert m.pair_passthrough([True, "test"]) == ("test", True)
    assert m.tuple_passthrough([True, "test", 5]) == (5, "test", True)
350
    assert m.empty_tuple() == ()
351

352
353
354
    assert (
        doc(m.pair_passthrough)
        == """
355
356
357
358
        pair_passthrough(arg0: Tuple[bool, str]) -> Tuple[str, bool]

        Return a pair in reversed order
    """
359
360
361
362
    )
    assert (
        doc(m.tuple_passthrough)
        == """
363
364
365
366
        tuple_passthrough(arg0: Tuple[bool, str, int]) -> Tuple[int, str, bool]

        Return a triple in reversed order
    """
367
    )
368

369
370
371
372
373
374
375
    assert m.rvalue_pair() == ("rvalue", "rvalue")
    assert m.lvalue_pair() == ("lvalue", "lvalue")
    assert m.rvalue_tuple() == ("rvalue", "rvalue", "rvalue")
    assert m.lvalue_tuple() == ("lvalue", "lvalue", "lvalue")
    assert m.rvalue_nested() == ("rvalue", ("rvalue", ("rvalue", "rvalue")))
    assert m.lvalue_nested() == ("lvalue", ("lvalue", ("lvalue", "lvalue")))

376
377
    assert m.int_string_pair() == (2, "items")

378
379
380
381
382
383
384
385

def test_builtins_cast_return_none():
    """Casters produced with PYBIND11_TYPE_CASTER() should convert nullptr to None"""
    assert m.return_none_string() is None
    assert m.return_none_char() is None
    assert m.return_none_bool() is None
    assert m.return_none_int() is None
    assert m.return_none_float() is None
386
    assert m.return_none_pair() is None
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406


def test_none_deferred():
    """None passed as various argument types should defer to other overloads"""
    assert not m.defer_none_cstring("abc")
    assert m.defer_none_cstring(None)
    assert not m.defer_none_custom(UserType())
    assert m.defer_none_custom(None)
    assert m.nodefer_none_void(None)


def test_void_caster():
    assert m.load_nullptr_t(None) is None
    assert m.cast_nullptr_t() is None


def test_reference_wrapper():
    """std::reference_wrapper for builtin and user types"""
    assert m.refwrap_builtin(42) == 420
    assert m.refwrap_usertype(UserType(42)) == 42
407
    assert m.refwrap_usertype_const(UserType(42)) == 42
408
409
410
411
412
413
414
415
416

    with pytest.raises(TypeError) as excinfo:
        m.refwrap_builtin(None)
    assert "incompatible function arguments" in str(excinfo.value)

    with pytest.raises(TypeError) as excinfo:
        m.refwrap_usertype(None)
    assert "incompatible function arguments" in str(excinfo.value)

417
418
419
    assert m.refwrap_lvalue().value == 1
    assert m.refwrap_lvalue_const().value == 1

420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
    a1 = m.refwrap_list(copy=True)
    a2 = m.refwrap_list(copy=True)
    assert [x.value for x in a1] == [2, 3]
    assert [x.value for x in a2] == [2, 3]
    assert not a1[0] is a2[0] and not a1[1] is a2[1]

    b1 = m.refwrap_list(copy=False)
    b2 = m.refwrap_list(copy=False)
    assert [x.value for x in b1] == [1, 2]
    assert [x.value for x in b2] == [1, 2]
    assert b1[0] is b2[0] and b1[1] is b2[1]

    assert m.refwrap_iiw(IncType(5)) == 5
    assert m.refwrap_call_iiw(IncType(10), m.refwrap_iiw) == [10, 10, 10, 10]


def test_complex_cast():
    """std::complex casts"""
    assert m.complex_cast(1) == "1.0"
    assert m.complex_cast(2j) == "(0.0, 2.0)"
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461


def test_bool_caster():
    """Test bool caster implicit conversions."""
    convert, noconvert = m.bool_passthrough, m.bool_passthrough_noconvert

    def require_implicit(v):
        pytest.raises(TypeError, noconvert, v)

    def cant_convert(v):
        pytest.raises(TypeError, convert, v)

    # straight up bool
    assert convert(True) is True
    assert convert(False) is False
    assert noconvert(True) is True
    assert noconvert(False) is False

    # None requires implicit conversion
    require_implicit(None)
    assert convert(None) is False

462
    class A:
463
464
465
466
467
468
469
470
471
        def __init__(self, x):
            self.x = x

        def __nonzero__(self):
            return self.x

        def __bool__(self):
            return self.x

472
    class B:
473
474
475
476
477
478
479
480
481
482
483
484
485
        pass

    # Arbitrary objects are not accepted
    cant_convert(object())
    cant_convert(B())

    # Objects with __nonzero__ / __bool__ defined can be converted
    require_implicit(A(True))
    assert convert(A(True)) is True
    assert convert(A(False)) is False


def test_numpy_bool():
486
487
    np = pytest.importorskip("numpy")

488
489
    convert, noconvert = m.bool_passthrough, m.bool_passthrough_noconvert

490
491
492
    def cant_convert(v):
        pytest.raises(TypeError, convert, v)

493
494
495
496
497
    # np.bool_ is not considered implicit
    assert convert(np.bool_(True)) is True
    assert convert(np.bool_(False)) is False
    assert noconvert(np.bool_(True)) is True
    assert noconvert(np.bool_(False)) is False
498
    cant_convert(np.zeros(2, dtype="int"))
499
500
501
502
503


def test_int_long():
    assert isinstance(m.int_cast(), int)
    assert isinstance(m.long_cast(), int)
504
    assert isinstance(m.longlong_cast(), int)
Wenzel Jakob's avatar
Wenzel Jakob committed
505
506
507
508


def test_void_caster_2():
    assert m.test_void_caster()
509
510
511
512


def test_const_ref_caster():
    """Verifies that const-ref is propagated through type_caster cast_op.
luzpaz's avatar
luzpaz committed
513
    The returned ConstRefCasted type is a minimal type that is constructed to
514
515
516
517
518
519
520
521
522
523
524
525
526
    reference the casting mode used.
    """
    x = False
    assert m.takes(x) == 1
    assert m.takes_move(x) == 1

    assert m.takes_ptr(x) == 3
    assert m.takes_ref(x) == 2
    assert m.takes_ref_wrap(x) == 2

    assert m.takes_const_ptr(x) == 5
    assert m.takes_const_ref(x) == 4
    assert m.takes_const_ref_wrap(x) == 4