test_kwargs_and_defaults.cpp revision 11986:c12e4625ab56 
1/*
2    tests/test_kwargs_and_defaults.cpp -- keyword arguments and default values
3
4    Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch>
5
6    All rights reserved. Use of this source code is governed by a
7    BSD-style license that can be found in the LICENSE file.
8*/
9
10#include "pybind11_tests.h"
11#include <pybind11/stl.h>
12
13std::string kw_func(int x, int y) { return "x=" + std::to_string(x) + ", y=" + std::to_string(y); }
14
15std::string kw_func4(const std::vector<int> &entries) {
16    std::string ret = "{";
17    for (int i : entries)
18        ret += std::to_string(i) + " ";
19    ret.back() = '}';
20    return ret;
21}
22
23py::tuple args_function(py::args args) {
24    return args;
25}
26
27py::tuple args_kwargs_function(py::args args, py::kwargs kwargs) {
28    return py::make_tuple(args, kwargs);
29}
30
31struct KWClass {
32    void foo(int, float) {}
33};
34
35test_initializer arg_keywords_and_defaults([](py::module &m) {
36    m.def("kw_func0", &kw_func);
37    m.def("kw_func1", &kw_func, py::arg("x"), py::arg("y"));
38    m.def("kw_func2", &kw_func, py::arg("x") = 100, py::arg("y") = 200);
39    m.def("kw_func3", [](const char *) { }, py::arg("data") = std::string("Hello world!"));
40
41    /* A fancier default argument */
42    std::vector<int> list;
43    list.push_back(13);
44    list.push_back(17);
45    m.def("kw_func4", &kw_func4, py::arg("myList") = list);
46
47    m.def("args_function", &args_function);
48    m.def("args_kwargs_function", &args_kwargs_function);
49
50    m.def("kw_func_udl", &kw_func, "x"_a, "y"_a=300);
51    m.def("kw_func_udl_z", &kw_func, "x"_a, "y"_a=0);
52
53    py::class_<KWClass>(m, "KWClass")
54        .def("foo0", &KWClass::foo)
55        .def("foo1", &KWClass::foo, "x"_a, "y"_a);
56});
57