test_kwargs_and_defaults.cpp revision 12391
111986Sandreas.sandberg@arm.com/* 211986Sandreas.sandberg@arm.com tests/test_kwargs_and_defaults.cpp -- keyword arguments and default values 311986Sandreas.sandberg@arm.com 411986Sandreas.sandberg@arm.com Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> 511986Sandreas.sandberg@arm.com 611986Sandreas.sandberg@arm.com All rights reserved. Use of this source code is governed by a 711986Sandreas.sandberg@arm.com BSD-style license that can be found in the LICENSE file. 811986Sandreas.sandberg@arm.com*/ 911986Sandreas.sandberg@arm.com 1011986Sandreas.sandberg@arm.com#include "pybind11_tests.h" 1111986Sandreas.sandberg@arm.com#include <pybind11/stl.h> 1211986Sandreas.sandberg@arm.com 1312391Sjason@lowepower.comTEST_SUBMODULE(kwargs_and_defaults, m) { 1412391Sjason@lowepower.com auto kw_func = [](int x, int y) { return "x=" + std::to_string(x) + ", y=" + std::to_string(y); }; 1511986Sandreas.sandberg@arm.com 1612391Sjason@lowepower.com // test_named_arguments 1712391Sjason@lowepower.com m.def("kw_func0", kw_func); 1812391Sjason@lowepower.com m.def("kw_func1", kw_func, py::arg("x"), py::arg("y")); 1912391Sjason@lowepower.com m.def("kw_func2", kw_func, py::arg("x") = 100, py::arg("y") = 200); 2011986Sandreas.sandberg@arm.com m.def("kw_func3", [](const char *) { }, py::arg("data") = std::string("Hello world!")); 2111986Sandreas.sandberg@arm.com 2211986Sandreas.sandberg@arm.com /* A fancier default argument */ 2312391Sjason@lowepower.com std::vector<int> list{{13, 17}}; 2412391Sjason@lowepower.com m.def("kw_func4", [](const std::vector<int> &entries) { 2512391Sjason@lowepower.com std::string ret = "{"; 2612391Sjason@lowepower.com for (int i : entries) 2712391Sjason@lowepower.com ret += std::to_string(i) + " "; 2812391Sjason@lowepower.com ret.back() = '}'; 2912391Sjason@lowepower.com return ret; 3012391Sjason@lowepower.com }, py::arg("myList") = list); 3111986Sandreas.sandberg@arm.com 3212391Sjason@lowepower.com m.def("kw_func_udl", kw_func, "x"_a, "y"_a=300); 3312391Sjason@lowepower.com m.def("kw_func_udl_z", kw_func, "x"_a, "y"_a=0); 3411986Sandreas.sandberg@arm.com 3512391Sjason@lowepower.com // test_args_and_kwargs 3612391Sjason@lowepower.com m.def("args_function", [](py::args args) -> py::tuple { return args; }); 3712391Sjason@lowepower.com m.def("args_kwargs_function", [](py::args args, py::kwargs kwargs) { 3812391Sjason@lowepower.com return py::make_tuple(args, kwargs); 3912391Sjason@lowepower.com }); 4011986Sandreas.sandberg@arm.com 4112391Sjason@lowepower.com // test_mixed_args_and_kwargs 4212391Sjason@lowepower.com m.def("mixed_plus_args", [](int i, double j, py::args args) { 4312391Sjason@lowepower.com return py::make_tuple(i, j, args); 4412391Sjason@lowepower.com }); 4512391Sjason@lowepower.com m.def("mixed_plus_kwargs", [](int i, double j, py::kwargs kwargs) { 4612391Sjason@lowepower.com return py::make_tuple(i, j, kwargs); 4712391Sjason@lowepower.com }); 4812391Sjason@lowepower.com auto mixed_plus_both = [](int i, double j, py::args args, py::kwargs kwargs) { 4912391Sjason@lowepower.com return py::make_tuple(i, j, args, kwargs); 5012391Sjason@lowepower.com }; 5112391Sjason@lowepower.com m.def("mixed_plus_args_kwargs", mixed_plus_both); 5212391Sjason@lowepower.com 5312391Sjason@lowepower.com m.def("mixed_plus_args_kwargs_defaults", mixed_plus_both, 5412391Sjason@lowepower.com py::arg("i") = 1, py::arg("j") = 3.14159); 5512391Sjason@lowepower.com 5612391Sjason@lowepower.com // pybind11 won't allow these to be bound: args and kwargs, if present, must be at the end. 5712391Sjason@lowepower.com // Uncomment these to test that the static_assert is indeed working: 5812391Sjason@lowepower.com// m.def("bad_args1", [](py::args, int) {}); 5912391Sjason@lowepower.com// m.def("bad_args2", [](py::kwargs, int) {}); 6012391Sjason@lowepower.com// m.def("bad_args3", [](py::kwargs, py::args) {}); 6112391Sjason@lowepower.com// m.def("bad_args4", [](py::args, int, py::kwargs) {}); 6212391Sjason@lowepower.com// m.def("bad_args5", [](py::args, py::kwargs, int) {}); 6312391Sjason@lowepower.com// m.def("bad_args6", [](py::args, py::args) {}); 6412391Sjason@lowepower.com// m.def("bad_args7", [](py::kwargs, py::kwargs) {}); 6512391Sjason@lowepower.com 6612391Sjason@lowepower.com // test_function_signatures (along with most of the above) 6712391Sjason@lowepower.com struct KWClass { void foo(int, float) {} }; 6811986Sandreas.sandberg@arm.com py::class_<KWClass>(m, "KWClass") 6911986Sandreas.sandberg@arm.com .def("foo0", &KWClass::foo) 7011986Sandreas.sandberg@arm.com .def("foo1", &KWClass::foo, "x"_a, "y"_a); 7112391Sjason@lowepower.com} 72