test_kwargs_and_defaults.py revision 11986:c12e4625ab56 
1import pytest
2from pybind11_tests import (kw_func0, kw_func1, kw_func2, kw_func3, kw_func4, args_function,
3                            args_kwargs_function, kw_func_udl, kw_func_udl_z, KWClass)
4
5
6def test_function_signatures(doc):
7    assert doc(kw_func0) == "kw_func0(arg0: int, arg1: int) -> str"
8    assert doc(kw_func1) == "kw_func1(x: int, y: int) -> str"
9    assert doc(kw_func2) == "kw_func2(x: int=100, y: int=200) -> str"
10    assert doc(kw_func3) == "kw_func3(data: str='Hello world!') -> None"
11    assert doc(kw_func4) == "kw_func4(myList: List[int]=[13, 17]) -> str"
12    assert doc(kw_func_udl) == "kw_func_udl(x: int, y: int=300) -> str"
13    assert doc(kw_func_udl_z) == "kw_func_udl_z(x: int, y: int=0) -> str"
14    assert doc(args_function) == "args_function(*args) -> tuple"
15    assert doc(args_kwargs_function) == "args_kwargs_function(*args, **kwargs) -> tuple"
16    assert doc(KWClass.foo0) == "foo0(self: m.KWClass, arg0: int, arg1: float) -> None"
17    assert doc(KWClass.foo1) == "foo1(self: m.KWClass, x: int, y: float) -> None"
18
19
20def test_named_arguments(msg):
21    assert kw_func0(5, 10) == "x=5, y=10"
22
23    assert kw_func1(5, 10) == "x=5, y=10"
24    assert kw_func1(5, y=10) == "x=5, y=10"
25    assert kw_func1(y=10, x=5) == "x=5, y=10"
26
27    assert kw_func2() == "x=100, y=200"
28    assert kw_func2(5) == "x=5, y=200"
29    assert kw_func2(x=5) == "x=5, y=200"
30    assert kw_func2(y=10) == "x=100, y=10"
31    assert kw_func2(5, 10) == "x=5, y=10"
32    assert kw_func2(x=5, y=10) == "x=5, y=10"
33
34    with pytest.raises(TypeError) as excinfo:
35        # noinspection PyArgumentList
36        kw_func2(x=5, y=10, z=12)
37    assert msg(excinfo.value) == """
38        kw_func2(): incompatible function arguments. The following argument types are supported:
39            1. (x: int=100, y: int=200) -> str
40
41        Invoked with:
42    """
43
44    assert kw_func4() == "{13 17}"
45    assert kw_func4(myList=[1, 2, 3]) == "{1 2 3}"
46
47    assert kw_func_udl(x=5, y=10) == "x=5, y=10"
48    assert kw_func_udl_z(x=5) == "x=5, y=0"
49
50
51def test_arg_and_kwargs():
52    args = 'arg1_value', 'arg2_value', 3
53    assert args_function(*args) == args
54
55    args = 'a1', 'a2'
56    kwargs = dict(arg3='a3', arg4=4)
57    assert args_kwargs_function(*args, **kwargs) == (args, kwargs)
58