Skip to content

Commit

Permalink
added an example on using fancier kinds of default arguments
Browse files Browse the repository at this point in the history
  • Loading branch information
Wenzel Jakob committed Jan 17, 2016
1 parent d3eec29 commit 140546b
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 2 deletions.
15 changes: 15 additions & 0 deletions example/example11.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,26 @@
*/

#include "example.h"
#include <pybind11/stl.h>

void kw_func(int x, int y) { std::cout << "kw_func(x=" << x << ", y=" << y << ")" << std::endl; }

void kw_func4(const std::vector<int> &entries) {
std::cout << "kw_func4: ";
for (int i : entries)
std::cout << i << " ";
std::cout << endl;
}

void init_ex11(py::module &m) {
m.def("kw_func", &kw_func, py::arg("x"), py::arg("y"));
m.def("kw_func2", &kw_func, py::arg("x") = 100, py::arg("y") = 200);
m.def("kw_func3", [](const char *) { }, py::arg("data") = std::string("Hello world!"));

/* A fancier default argument */
std::vector<int> list;
list.push_back(13);
list.push_back(17);

m.def("kw_func4", &kw_func4, py::arg("myList") = list);
}
6 changes: 5 additions & 1 deletion example/example11.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@

sys.path.append('.')

from example import kw_func, kw_func2, kw_func3
from example import kw_func, kw_func2, kw_func3, kw_func4

print(pydoc.render_doc(kw_func, "Help on %s"))
print(pydoc.render_doc(kw_func2, "Help on %s"))
print(pydoc.render_doc(kw_func3, "Help on %s"))
print(pydoc.render_doc(kw_func4, "Help on %s"))

kw_func(5, 10)
kw_func(5, y=10)
Expand All @@ -29,3 +30,6 @@
kw_func2(x=5, y=10, z=12)
except Exception as e:
print("Caught expected exception: " + str(e))

kw_func4()
kw_func4(myList = [1, 2, 3])
9 changes: 8 additions & 1 deletion example/example11.ref
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@ kkww__ffuunncc22(...)
Help on built-in function kw_func3

kkww__ffuunncc33(...)
Signature : (data : str = u'Hello world!') -> NoneType
Signature : (data : unicode = u'Hello world!') -> NoneType

Help on built-in function kw_func4

kkww__ffuunncc44(...)
Signature : (myList : list<int> = [13L, 17L]) -> NoneType

kw_func(x=5, y=10)
kw_func(x=5, y=10)
Expand All @@ -25,3 +30,5 @@ kw_func(x=5, y=10)
Caught expected exception: Incompatible function arguments. The following argument types are supported:
1. (x : int = 100L, y : int = 200L) -> NoneType

kw_func4: 13 17
kw_func4: 1 2 3

0 comments on commit 140546b

Please sign in to comment.