import pytest from pybind11_tests import ConstructorStats, UserType from pybind11_tests import stl as m def test_vector(doc): """std::vector <-> list""" lst = m.cast_vector() assert lst == [1] lst.append(2) assert m.load_vector(lst) assert m.load_vector(tuple(lst)) assert m.cast_bool_vector() == [True, False] assert m.load_bool_vector([True, False]) assert m.load_bool_vector((True, False)) assert doc(m.cast_vector) == "cast_vector() -> List[int]" assert doc(m.load_vector) == "load_vector(arg0: List[int]) -> bool" # Test regression caused by 936: pointers to stl containers weren't castable assert m.cast_ptr_vector() == ["lvalue", "lvalue"] def test_deque(): """std::deque <-> list""" lst = m.cast_deque() assert lst == [1] lst.append(2) assert m.load_deque(lst) assert m.load_deque(tuple(lst)) def test_array(doc): """std::array <-> list""" lst = m.cast_array() assert lst == [1, 2] assert m.load_array(lst) assert m.load_array(tuple(lst)) assert doc(m.cast_array) == "cast_array() -> Annotated[List[int], FixedSize(2)]" assert ( doc(m.load_array) == "load_array(arg0: Annotated[List[int], FixedSize(2)]) -> bool" ) def test_valarray(doc): """std::valarray <-> list""" lst = m.cast_valarray() assert lst == [1, 4, 9] assert m.load_valarray(lst) assert m.load_valarray(tuple(lst)) assert doc(m.cast_valarray) == "cast_valarray() -> List[int]" assert doc(m.load_valarray) == "load_valarray(arg0: List[int]) -> bool" def test_map(doc): """std::map <-> dict""" d = m.cast_map() assert d == {"key": "value"} assert "key" in d d["key2"] = "value2" assert "key2" in d assert m.load_map(d) assert doc(m.cast_map) == "cast_map() -> Dict[str, str]" assert doc(m.load_map) == "load_map(arg0: Dict[str, str]) -> bool" def test_set(doc): """std::set <-> set""" s = m.cast_set() assert s == {"key1", "key2"} s.add("key3") assert m.load_set(s) assert m.load_set(frozenset(s)) assert doc(m.cast_set) == "cast_set() -> Set[str]" assert doc(m.load_set) == "load_set(arg0: Set[str]) -> bool" def test_recursive_casting(): """Tests that stl casters preserve lvalue/rvalue context for container values""" assert m.cast_rv_vector() == ["rvalue", "rvalue"] assert m.cast_lv_vector() == ["lvalue", "lvalue"] assert m.cast_rv_array() == ["rvalue", "rvalue", "rvalue"] assert m.cast_lv_array() == ["lvalue", "lvalue"] assert m.cast_rv_map() == {"a": "rvalue"} assert m.cast_lv_map() == {"a": "lvalue", "b": "lvalue"} assert m.cast_rv_nested() == [[[{"b": "rvalue", "c": "rvalue"}], [{"a": "rvalue"}]]] assert m.cast_lv_nested() == { "a": [[["lvalue", "lvalue"]], [["lvalue", "lvalue"]]], "b": [[["lvalue", "lvalue"], ["lvalue", "lvalue"]]], } # Issue #853 test case: z = m.cast_unique_ptr_vector() assert z[0].value == 7 assert z[1].value == 42 def test_move_out_container(): """Properties use the `reference_internal` policy by default. If the underlying function returns an rvalue, the policy is automatically changed to `move` to avoid referencing a temporary. In case the return value is a container of user-defined types, the policy also needs to be applied to the elements, not just the container.""" c = m.MoveOutContainer() moved_out_list = c.move_list assert [x.value for x in moved_out_list] == [0, 1, 2] @pytest.mark.skipif(not hasattr(m, "has_optional"), reason="no ") def test_optional(): assert m.double_or_zero(None) == 0 assert m.double_or_zero(42) == 84 pytest.raises(TypeError, m.double_or_zero, "foo") assert m.half_or_none(0) is None assert m.half_or_none(42) == 21 pytest.raises(TypeError, m.half_or_none, "foo") assert m.test_nullopt() == 42 assert m.test_nullopt(None) == 42 assert m.test_nullopt(42) == 42 assert m.test_nullopt(43) == 43 assert m.test_no_assign() == 42 assert m.test_no_assign(None) == 42 assert m.test_no_assign(m.NoAssign(43)) == 43 pytest.raises(TypeError, m.test_no_assign, 43) assert m.nodefer_none_optional(None) holder = m.OptionalHolder() mvalue = holder.member assert mvalue.initialized assert holder.member_initialized() props = m.OptionalProperties() assert int(props.access_by_ref) == 42 assert int(props.access_by_copy) == 42 @pytest.mark.skipif( not hasattr(m, "has_exp_optional"), reason="no " ) def test_exp_optional(): assert m.double_or_zero_exp(None) == 0 assert m.double_or_zero_exp(42) == 84 pytest.raises(TypeError, m.double_or_zero_exp, "foo") assert m.half_or_none_exp(0) is None assert m.half_or_none_exp(42) == 21 pytest.raises(TypeError, m.half_or_none_exp, "foo") assert m.test_nullopt_exp() == 42 assert m.test_nullopt_exp(None) == 42 assert m.test_nullopt_exp(42) == 42 assert m.test_nullopt_exp(43) == 43 assert m.test_no_assign_exp() == 42 assert m.test_no_assign_exp(None) == 42 assert m.test_no_assign_exp(m.NoAssign(43)) == 43 pytest.raises(TypeError, m.test_no_assign_exp, 43) holder = m.OptionalExpHolder() mvalue = holder.member assert mvalue.initialized assert holder.member_initialized() props = m.OptionalExpProperties() assert int(props.access_by_ref) == 42 assert int(props.access_by_copy) == 42 @pytest.mark.skipif(not hasattr(m, "has_boost_optional"), reason="no ") def test_boost_optional(): assert m.double_or_zero_boost(None) == 0 assert m.double_or_zero_boost(42) == 84 pytest.raises(TypeError, m.double_or_zero_boost, "foo") assert m.half_or_none_boost(0) is None assert m.half_or_none_boost(42) == 21 pytest.raises(TypeError, m.half_or_none_boost, "foo") assert m.test_nullopt_boost() == 42 assert m.test_nullopt_boost(None) == 42 assert m.test_nullopt_boost(42) == 42 assert m.test_nullopt_boost(43) == 43 assert m.test_no_assign_boost() == 42 assert m.test_no_assign_boost(None) == 42 assert m.test_no_assign_boost(m.NoAssign(43)) == 43 pytest.raises(TypeError, m.test_no_assign_boost, 43) holder = m.OptionalBoostHolder() mvalue = holder.member assert mvalue.initialized assert holder.member_initialized() props = m.OptionalBoostProperties() assert int(props.access_by_ref) == 42 assert int(props.access_by_copy) == 42 def test_reference_sensitive_optional(): assert m.double_or_zero_refsensitive(None) == 0 assert m.double_or_zero_refsensitive(42) == 84 pytest.raises(TypeError, m.double_or_zero_refsensitive, "foo") assert m.half_or_none_refsensitive(0) is None assert m.half_or_none_refsensitive(42) == 21 pytest.raises(TypeError, m.half_or_none_refsensitive, "foo") assert m.test_nullopt_refsensitive() == 42 assert m.test_nullopt_refsensitive(None) == 42 assert m.test_nullopt_refsensitive(42) == 42 assert m.test_nullopt_refsensitive(43) == 43 assert m.test_no_assign_refsensitive() == 42 assert m.test_no_assign_refsensitive(None) == 42 assert m.test_no_assign_refsensitive(m.NoAssign(43)) == 43 pytest.raises(TypeError, m.test_no_assign_refsensitive, 43) holder = m.OptionalRefSensitiveHolder() mvalue = holder.member assert mvalue.initialized assert holder.member_initialized() props = m.OptionalRefSensitiveProperties() assert int(props.access_by_ref) == 42 assert int(props.access_by_copy) == 42 @pytest.mark.skipif(not hasattr(m, "has_filesystem"), reason="no ") def test_fs_path(): from pathlib import Path class PseudoStrPath: def __fspath__(self): return "foo/bar" class PseudoBytesPath: def __fspath__(self): return b"foo/bar" assert m.parent_path(Path("foo/bar")) == Path("foo") assert m.parent_path("foo/bar") == Path("foo") assert m.parent_path(b"foo/bar") == Path("foo") assert m.parent_path(PseudoStrPath()) == Path("foo") assert m.parent_path(PseudoBytesPath()) == Path("foo") @pytest.mark.skipif(not hasattr(m, "load_variant"), reason="no ") def test_variant(doc): assert m.load_variant(1) == "int" assert m.load_variant("1") == "std::string" assert m.load_variant(1.0) == "double" assert m.load_variant(None) == "std::nullptr_t" assert m.load_variant_2pass(1) == "int" assert m.load_variant_2pass(1.0) == "double" assert m.cast_variant() == (5, "Hello") assert ( doc(m.load_variant) == "load_variant(arg0: Union[int, str, float, None]) -> str" ) @pytest.mark.skipif( not hasattr(m, "load_monostate_variant"), reason="no std::monostate" ) def test_variant_monostate(doc): assert m.load_monostate_variant(None) == "std::monostate" assert m.load_monostate_variant(1) == "int" assert m.load_monostate_variant("1") == "std::string" assert m.cast_monostate_variant() == (None, 5, "Hello") assert ( doc(m.load_monostate_variant) == "load_monostate_variant(arg0: Union[None, int, str]) -> str" ) def test_vec_of_reference_wrapper(): """#171: Can't return reference wrappers (or STL structures containing them)""" assert ( str(m.return_vec_of_reference_wrapper(UserType(4))) == "[UserType(1), UserType(2), UserType(3), UserType(4)]" ) def test_stl_pass_by_pointer(msg): """Passing nullptr or None to an STL container pointer is not expected to work""" with pytest.raises(TypeError) as excinfo: m.stl_pass_by_pointer() # default value is `nullptr` assert ( msg(excinfo.value) == """ stl_pass_by_pointer(): incompatible function arguments. The following argument types are supported: 1. (v: List[int] = None) -> List[int] Invoked with: """ ) with pytest.raises(TypeError) as excinfo: m.stl_pass_by_pointer(None) assert ( msg(excinfo.value) == """ stl_pass_by_pointer(): incompatible function arguments. The following argument types are supported: 1. (v: List[int] = None) -> List[int] Invoked with: None """ ) assert m.stl_pass_by_pointer([1, 2, 3]) == [1, 2, 3] def test_missing_header_message(): """Trying convert `list` to a `std::vector`, or vice versa, without including should result in a helpful suggestion in the error message""" import pybind11_cross_module_tests as cm expected_message = ( "Did you forget to `#include `? Or ,\n" ", , etc. Some automatic\n" "conversions are optional and require extra headers to be included\n" "when compiling your pybind11 module." ) with pytest.raises(TypeError) as excinfo: cm.missing_header_arg([1.0, 2.0, 3.0]) assert expected_message in str(excinfo.value) with pytest.raises(TypeError) as excinfo: cm.missing_header_return() assert expected_message in str(excinfo.value) def test_function_with_string_and_vector_string_arg(): """Check if a string is NOT implicitly converted to a list, which was the behavior before fix of issue #1258""" assert m.func_with_string_or_vector_string_arg_overload(("A", "B")) == 2 assert m.func_with_string_or_vector_string_arg_overload(["A", "B"]) == 2 assert m.func_with_string_or_vector_string_arg_overload("A") == 3 def test_stl_ownership(): cstats = ConstructorStats.get(m.Placeholder) assert cstats.alive() == 0 r = m.test_stl_ownership() assert len(r) == 1 del r assert cstats.alive() == 0 def test_array_cast_sequence(): assert m.array_cast_sequence((1, 2, 3)) == [1, 2, 3] def test_issue_1561(): """check fix for issue #1561""" bar = m.Issue1561Outer() bar.list = [m.Issue1561Inner("bar")] assert bar.list assert bar.list[0].data == "bar" def test_return_vector_bool_raw_ptr(): # Add `while True:` for manual leak checking. v = m.return_vector_bool_raw_ptr() assert isinstance(v, list) assert len(v) == 4513 def test_return_as_bytes_policy(): expected_return_value = b"\xba\xd0\xba\xd0" assert m.invalid_utf8_string_array_as_bytes() == [expected_return_value] with pytest.raises(UnicodeDecodeError): m.invalid_utf8_string_array_as_str() if hasattr(m, "has_optional"): assert m.invalid_utf8_optional_string_as_bytes() == expected_return_value if hasattr(m, "load_variant"): assert m.invalid_utf8_variant_string_as_bytes() == expected_return_value