mirror of
https://github.com/pybind/pybind11.git
synced 2025-02-22 08:29:23 +00:00
b57281bb00
This updates the std::tuple, std::pair and `stl.h` type casters to forward their contained value according to whether the container being cast is an lvalue or rvalue reference. This fixes an issue where subcaster casts were always called with a const lvalue which meant nested type casters didn't have the desired `cast()` overload invoked. For example, this caused Eigen values in a tuple to end up with a readonly flag (issue #935) and made it impossible to return a container of move-only types (issue #853). This fixes both issues by adding templated universal reference `cast()` methods to the various container types that forward container elements according to the container reference type.
176 lines
5.8 KiB
Python
176 lines
5.8 KiB
Python
import pytest
|
|
|
|
from pybind11_tests import stl as m
|
|
from pybind11_tests import UserType
|
|
|
|
|
|
def test_vector(doc):
|
|
"""std::vector <-> list"""
|
|
l = m.cast_vector()
|
|
assert l == [1]
|
|
l.append(2)
|
|
assert m.load_vector(l)
|
|
assert m.load_vector(tuple(l))
|
|
|
|
assert doc(m.cast_vector) == "cast_vector() -> List[int]"
|
|
assert doc(m.load_vector) == "load_vector(arg0: List[int]) -> bool"
|
|
|
|
|
|
def test_array(doc):
|
|
"""std::array <-> list"""
|
|
l = m.cast_array()
|
|
assert l == [1, 2]
|
|
assert m.load_array(l)
|
|
|
|
assert doc(m.cast_array) == "cast_array() -> List[int[2]]"
|
|
assert doc(m.load_array) == "load_array(arg0: List[int[2]]) -> bool"
|
|
|
|
|
|
def test_valarray(doc):
|
|
"""std::valarray <-> list"""
|
|
l = m.cast_valarray()
|
|
assert l == [1, 4, 9]
|
|
assert m.load_valarray(l)
|
|
|
|
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"}
|
|
d["key2"] = "value2"
|
|
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 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 and 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 <optional>')
|
|
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)
|
|
|
|
|
|
@pytest.mark.skipif(not hasattr(m, "has_exp_optional"), reason='no <experimental/optional>')
|
|
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)
|
|
|
|
|
|
@pytest.mark.skipif(not hasattr(m, "load_variant"), reason='no <variant>')
|
|
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"
|
|
|
|
|
|
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:
|
|
""" # noqa: E501 line too long
|
|
|
|
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
|
|
""" # noqa: E501 line too long
|
|
|
|
assert m.stl_pass_by_pointer([1, 2, 3]) == [1, 2, 3]
|