test_pytypes.cpp revision 12391
112391Sjason@lowepower.com/* 212391Sjason@lowepower.com tests/test_pytypes.cpp -- Python type casters 312391Sjason@lowepower.com 412391Sjason@lowepower.com Copyright (c) 2017 Wenzel Jakob <wenzel.jakob@epfl.ch> 512391Sjason@lowepower.com 612391Sjason@lowepower.com All rights reserved. Use of this source code is governed by a 712391Sjason@lowepower.com BSD-style license that can be found in the LICENSE file. 812391Sjason@lowepower.com*/ 912391Sjason@lowepower.com 1012391Sjason@lowepower.com#include "pybind11_tests.h" 1112391Sjason@lowepower.com 1212391Sjason@lowepower.com 1312391Sjason@lowepower.comTEST_SUBMODULE(pytypes, m) { 1412391Sjason@lowepower.com // test_list 1512391Sjason@lowepower.com m.def("get_list", []() { 1612391Sjason@lowepower.com py::list list; 1712391Sjason@lowepower.com list.append("value"); 1812391Sjason@lowepower.com py::print("Entry at position 0:", list[0]); 1912391Sjason@lowepower.com list[0] = py::str("overwritten"); 2012391Sjason@lowepower.com return list; 2112391Sjason@lowepower.com }); 2212391Sjason@lowepower.com m.def("print_list", [](py::list list) { 2312391Sjason@lowepower.com int index = 0; 2412391Sjason@lowepower.com for (auto item : list) 2512391Sjason@lowepower.com py::print("list item {}: {}"_s.format(index++, item)); 2612391Sjason@lowepower.com }); 2712391Sjason@lowepower.com 2812391Sjason@lowepower.com // test_set 2912391Sjason@lowepower.com m.def("get_set", []() { 3012391Sjason@lowepower.com py::set set; 3112391Sjason@lowepower.com set.add(py::str("key1")); 3212391Sjason@lowepower.com set.add("key2"); 3312391Sjason@lowepower.com set.add(std::string("key3")); 3412391Sjason@lowepower.com return set; 3512391Sjason@lowepower.com }); 3612391Sjason@lowepower.com m.def("print_set", [](py::set set) { 3712391Sjason@lowepower.com for (auto item : set) 3812391Sjason@lowepower.com py::print("key:", item); 3912391Sjason@lowepower.com }); 4012391Sjason@lowepower.com 4112391Sjason@lowepower.com // test_dict 4212391Sjason@lowepower.com m.def("get_dict", []() { return py::dict("key"_a="value"); }); 4312391Sjason@lowepower.com m.def("print_dict", [](py::dict dict) { 4412391Sjason@lowepower.com for (auto item : dict) 4512391Sjason@lowepower.com py::print("key: {}, value={}"_s.format(item.first, item.second)); 4612391Sjason@lowepower.com }); 4712391Sjason@lowepower.com m.def("dict_keyword_constructor", []() { 4812391Sjason@lowepower.com auto d1 = py::dict("x"_a=1, "y"_a=2); 4912391Sjason@lowepower.com auto d2 = py::dict("z"_a=3, **d1); 5012391Sjason@lowepower.com return d2; 5112391Sjason@lowepower.com }); 5212391Sjason@lowepower.com 5312391Sjason@lowepower.com // test_str 5412391Sjason@lowepower.com m.def("str_from_string", []() { return py::str(std::string("baz")); }); 5512391Sjason@lowepower.com m.def("str_from_bytes", []() { return py::str(py::bytes("boo", 3)); }); 5612391Sjason@lowepower.com m.def("str_from_object", [](const py::object& obj) { return py::str(obj); }); 5712391Sjason@lowepower.com m.def("repr_from_object", [](const py::object& obj) { return py::repr(obj); }); 5812391Sjason@lowepower.com 5912391Sjason@lowepower.com m.def("str_format", []() { 6012391Sjason@lowepower.com auto s1 = "{} + {} = {}"_s.format(1, 2, 3); 6112391Sjason@lowepower.com auto s2 = "{a} + {b} = {c}"_s.format("a"_a=1, "b"_a=2, "c"_a=3); 6212391Sjason@lowepower.com return py::make_tuple(s1, s2); 6312391Sjason@lowepower.com }); 6412391Sjason@lowepower.com 6512391Sjason@lowepower.com // test_bytes 6612391Sjason@lowepower.com m.def("bytes_from_string", []() { return py::bytes(std::string("foo")); }); 6712391Sjason@lowepower.com m.def("bytes_from_str", []() { return py::bytes(py::str("bar", 3)); }); 6812391Sjason@lowepower.com 6912391Sjason@lowepower.com // test_capsule 7012391Sjason@lowepower.com m.def("return_capsule_with_destructor", []() { 7112391Sjason@lowepower.com py::print("creating capsule"); 7212391Sjason@lowepower.com return py::capsule([]() { 7312391Sjason@lowepower.com py::print("destructing capsule"); 7412391Sjason@lowepower.com }); 7512391Sjason@lowepower.com }); 7612391Sjason@lowepower.com 7712391Sjason@lowepower.com m.def("return_capsule_with_destructor_2", []() { 7812391Sjason@lowepower.com py::print("creating capsule"); 7912391Sjason@lowepower.com return py::capsule((void *) 1234, [](void *ptr) { 8012391Sjason@lowepower.com py::print("destructing capsule: {}"_s.format((size_t) ptr)); 8112391Sjason@lowepower.com }); 8212391Sjason@lowepower.com }); 8312391Sjason@lowepower.com 8412391Sjason@lowepower.com m.def("return_capsule_with_name_and_destructor", []() { 8512391Sjason@lowepower.com auto capsule = py::capsule((void *) 1234, "pointer type description", [](PyObject *ptr) { 8612391Sjason@lowepower.com if (ptr) { 8712391Sjason@lowepower.com auto name = PyCapsule_GetName(ptr); 8812391Sjason@lowepower.com py::print("destructing capsule ({}, '{}')"_s.format( 8912391Sjason@lowepower.com (size_t) PyCapsule_GetPointer(ptr, name), name 9012391Sjason@lowepower.com )); 9112391Sjason@lowepower.com } 9212391Sjason@lowepower.com }); 9312391Sjason@lowepower.com void *contents = capsule; 9412391Sjason@lowepower.com py::print("created capsule ({}, '{}')"_s.format((size_t) contents, capsule.name())); 9512391Sjason@lowepower.com return capsule; 9612391Sjason@lowepower.com }); 9712391Sjason@lowepower.com 9812391Sjason@lowepower.com // test_accessors 9912391Sjason@lowepower.com m.def("accessor_api", [](py::object o) { 10012391Sjason@lowepower.com auto d = py::dict(); 10112391Sjason@lowepower.com 10212391Sjason@lowepower.com d["basic_attr"] = o.attr("basic_attr"); 10312391Sjason@lowepower.com 10412391Sjason@lowepower.com auto l = py::list(); 10512391Sjason@lowepower.com for (const auto &item : o.attr("begin_end")) { 10612391Sjason@lowepower.com l.append(item); 10712391Sjason@lowepower.com } 10812391Sjason@lowepower.com d["begin_end"] = l; 10912391Sjason@lowepower.com 11012391Sjason@lowepower.com d["operator[object]"] = o.attr("d")["operator[object]"_s]; 11112391Sjason@lowepower.com d["operator[char *]"] = o.attr("d")["operator[char *]"]; 11212391Sjason@lowepower.com 11312391Sjason@lowepower.com d["attr(object)"] = o.attr("sub").attr("attr_obj"); 11412391Sjason@lowepower.com d["attr(char *)"] = o.attr("sub").attr("attr_char"); 11512391Sjason@lowepower.com try { 11612391Sjason@lowepower.com o.attr("sub").attr("missing").ptr(); 11712391Sjason@lowepower.com } catch (const py::error_already_set &) { 11812391Sjason@lowepower.com d["missing_attr_ptr"] = "raised"_s; 11912391Sjason@lowepower.com } 12012391Sjason@lowepower.com try { 12112391Sjason@lowepower.com o.attr("missing").attr("doesn't matter"); 12212391Sjason@lowepower.com } catch (const py::error_already_set &) { 12312391Sjason@lowepower.com d["missing_attr_chain"] = "raised"_s; 12412391Sjason@lowepower.com } 12512391Sjason@lowepower.com 12612391Sjason@lowepower.com d["is_none"] = o.attr("basic_attr").is_none(); 12712391Sjason@lowepower.com 12812391Sjason@lowepower.com d["operator()"] = o.attr("func")(1); 12912391Sjason@lowepower.com d["operator*"] = o.attr("func")(*o.attr("begin_end")); 13012391Sjason@lowepower.com 13112391Sjason@lowepower.com // Test implicit conversion 13212391Sjason@lowepower.com py::list implicit_list = o.attr("begin_end"); 13312391Sjason@lowepower.com d["implicit_list"] = implicit_list; 13412391Sjason@lowepower.com py::dict implicit_dict = o.attr("__dict__"); 13512391Sjason@lowepower.com d["implicit_dict"] = implicit_dict; 13612391Sjason@lowepower.com 13712391Sjason@lowepower.com return d; 13812391Sjason@lowepower.com }); 13912391Sjason@lowepower.com 14012391Sjason@lowepower.com m.def("tuple_accessor", [](py::tuple existing_t) { 14112391Sjason@lowepower.com try { 14212391Sjason@lowepower.com existing_t[0] = 1; 14312391Sjason@lowepower.com } catch (const py::error_already_set &) { 14412391Sjason@lowepower.com // --> Python system error 14512391Sjason@lowepower.com // Only new tuples (refcount == 1) are mutable 14612391Sjason@lowepower.com auto new_t = py::tuple(3); 14712391Sjason@lowepower.com for (size_t i = 0; i < new_t.size(); ++i) { 14812391Sjason@lowepower.com new_t[i] = i; 14912391Sjason@lowepower.com } 15012391Sjason@lowepower.com return new_t; 15112391Sjason@lowepower.com } 15212391Sjason@lowepower.com return py::tuple(); 15312391Sjason@lowepower.com }); 15412391Sjason@lowepower.com 15512391Sjason@lowepower.com m.def("accessor_assignment", []() { 15612391Sjason@lowepower.com auto l = py::list(1); 15712391Sjason@lowepower.com l[0] = 0; 15812391Sjason@lowepower.com 15912391Sjason@lowepower.com auto d = py::dict(); 16012391Sjason@lowepower.com d["get"] = l[0]; 16112391Sjason@lowepower.com auto var = l[0]; 16212391Sjason@lowepower.com d["deferred_get"] = var; 16312391Sjason@lowepower.com l[0] = 1; 16412391Sjason@lowepower.com d["set"] = l[0]; 16512391Sjason@lowepower.com var = 99; // this assignment should not overwrite l[0] 16612391Sjason@lowepower.com d["deferred_set"] = l[0]; 16712391Sjason@lowepower.com d["var"] = var; 16812391Sjason@lowepower.com 16912391Sjason@lowepower.com return d; 17012391Sjason@lowepower.com }); 17112391Sjason@lowepower.com 17212391Sjason@lowepower.com // test_constructors 17312391Sjason@lowepower.com m.def("default_constructors", []() { 17412391Sjason@lowepower.com return py::dict( 17512391Sjason@lowepower.com "str"_a=py::str(), 17612391Sjason@lowepower.com "bool"_a=py::bool_(), 17712391Sjason@lowepower.com "int"_a=py::int_(), 17812391Sjason@lowepower.com "float"_a=py::float_(), 17912391Sjason@lowepower.com "tuple"_a=py::tuple(), 18012391Sjason@lowepower.com "list"_a=py::list(), 18112391Sjason@lowepower.com "dict"_a=py::dict(), 18212391Sjason@lowepower.com "set"_a=py::set() 18312391Sjason@lowepower.com ); 18412391Sjason@lowepower.com }); 18512391Sjason@lowepower.com 18612391Sjason@lowepower.com m.def("converting_constructors", [](py::dict d) { 18712391Sjason@lowepower.com return py::dict( 18812391Sjason@lowepower.com "str"_a=py::str(d["str"]), 18912391Sjason@lowepower.com "bool"_a=py::bool_(d["bool"]), 19012391Sjason@lowepower.com "int"_a=py::int_(d["int"]), 19112391Sjason@lowepower.com "float"_a=py::float_(d["float"]), 19212391Sjason@lowepower.com "tuple"_a=py::tuple(d["tuple"]), 19312391Sjason@lowepower.com "list"_a=py::list(d["list"]), 19412391Sjason@lowepower.com "dict"_a=py::dict(d["dict"]), 19512391Sjason@lowepower.com "set"_a=py::set(d["set"]), 19612391Sjason@lowepower.com "memoryview"_a=py::memoryview(d["memoryview"]) 19712391Sjason@lowepower.com ); 19812391Sjason@lowepower.com }); 19912391Sjason@lowepower.com 20012391Sjason@lowepower.com m.def("cast_functions", [](py::dict d) { 20112391Sjason@lowepower.com // When converting between Python types, obj.cast<T>() should be the same as T(obj) 20212391Sjason@lowepower.com return py::dict( 20312391Sjason@lowepower.com "str"_a=d["str"].cast<py::str>(), 20412391Sjason@lowepower.com "bool"_a=d["bool"].cast<py::bool_>(), 20512391Sjason@lowepower.com "int"_a=d["int"].cast<py::int_>(), 20612391Sjason@lowepower.com "float"_a=d["float"].cast<py::float_>(), 20712391Sjason@lowepower.com "tuple"_a=d["tuple"].cast<py::tuple>(), 20812391Sjason@lowepower.com "list"_a=d["list"].cast<py::list>(), 20912391Sjason@lowepower.com "dict"_a=d["dict"].cast<py::dict>(), 21012391Sjason@lowepower.com "set"_a=d["set"].cast<py::set>(), 21112391Sjason@lowepower.com "memoryview"_a=d["memoryview"].cast<py::memoryview>() 21212391Sjason@lowepower.com ); 21312391Sjason@lowepower.com }); 21412391Sjason@lowepower.com 21512391Sjason@lowepower.com m.def("get_implicit_casting", []() { 21612391Sjason@lowepower.com py::dict d; 21712391Sjason@lowepower.com d["char*_i1"] = "abc"; 21812391Sjason@lowepower.com const char *c2 = "abc"; 21912391Sjason@lowepower.com d["char*_i2"] = c2; 22012391Sjason@lowepower.com d["char*_e"] = py::cast(c2); 22112391Sjason@lowepower.com d["char*_p"] = py::str(c2); 22212391Sjason@lowepower.com 22312391Sjason@lowepower.com d["int_i1"] = 42; 22412391Sjason@lowepower.com int i = 42; 22512391Sjason@lowepower.com d["int_i2"] = i; 22612391Sjason@lowepower.com i++; 22712391Sjason@lowepower.com d["int_e"] = py::cast(i); 22812391Sjason@lowepower.com i++; 22912391Sjason@lowepower.com d["int_p"] = py::int_(i); 23012391Sjason@lowepower.com 23112391Sjason@lowepower.com d["str_i1"] = std::string("str"); 23212391Sjason@lowepower.com std::string s2("str1"); 23312391Sjason@lowepower.com d["str_i2"] = s2; 23412391Sjason@lowepower.com s2[3] = '2'; 23512391Sjason@lowepower.com d["str_e"] = py::cast(s2); 23612391Sjason@lowepower.com s2[3] = '3'; 23712391Sjason@lowepower.com d["str_p"] = py::str(s2); 23812391Sjason@lowepower.com 23912391Sjason@lowepower.com py::list l(2); 24012391Sjason@lowepower.com l[0] = 3; 24112391Sjason@lowepower.com l[1] = py::cast(6); 24212391Sjason@lowepower.com l.append(9); 24312391Sjason@lowepower.com l.append(py::cast(12)); 24412391Sjason@lowepower.com l.append(py::int_(15)); 24512391Sjason@lowepower.com 24612391Sjason@lowepower.com return py::dict( 24712391Sjason@lowepower.com "d"_a=d, 24812391Sjason@lowepower.com "l"_a=l 24912391Sjason@lowepower.com ); 25012391Sjason@lowepower.com }); 25112391Sjason@lowepower.com 25212391Sjason@lowepower.com // test_print 25312391Sjason@lowepower.com m.def("print_function", []() { 25412391Sjason@lowepower.com py::print("Hello, World!"); 25512391Sjason@lowepower.com py::print(1, 2.0, "three", true, std::string("-- multiple args")); 25612391Sjason@lowepower.com auto args = py::make_tuple("and", "a", "custom", "separator"); 25712391Sjason@lowepower.com py::print("*args", *args, "sep"_a="-"); 25812391Sjason@lowepower.com py::print("no new line here", "end"_a=" -- "); 25912391Sjason@lowepower.com py::print("next print"); 26012391Sjason@lowepower.com 26112391Sjason@lowepower.com auto py_stderr = py::module::import("sys").attr("stderr"); 26212391Sjason@lowepower.com py::print("this goes to stderr", "file"_a=py_stderr); 26312391Sjason@lowepower.com 26412391Sjason@lowepower.com py::print("flush", "flush"_a=true); 26512391Sjason@lowepower.com 26612391Sjason@lowepower.com py::print("{a} + {b} = {c}"_s.format("a"_a="py::print", "b"_a="str.format", "c"_a="this")); 26712391Sjason@lowepower.com }); 26812391Sjason@lowepower.com 26912391Sjason@lowepower.com m.def("print_failure", []() { py::print(42, UnregisteredType()); }); 27012391Sjason@lowepower.com 27112391Sjason@lowepower.com m.def("hash_function", [](py::object obj) { return py::hash(obj); }); 27212391Sjason@lowepower.com} 273