1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
|
#include <string.h>
#include <nanobind/nanobind.h>
#include <nanobind/stl/function.h>
#include <nanobind/stl/pair.h>
#include <nanobind/stl/string.h>
#include <nanobind/stl/vector.h>
namespace nb = nanobind;
using namespace nb::literals;
int call_guard_value = 0;
struct my_call_guard {
my_call_guard() { call_guard_value = 1; }
~my_call_guard() { call_guard_value = 2; }
};
// Example call policy for use with nb::call_policy<>. Each call will add
// an entry to `calls` containing the arguments tuple and return value.
// The return value will be recorded as "<unfinished>" if the function
// did not return (still executing or threw an exception) and as
// "<return conversion failed>" if the function returned something that we
// couldn't convert to a Python object.
// Additional features to test particular interactions:
// - the precall hook will throw if any arguments are not strings
// - any argument equal to "swapfrom" will be replaced by a temporary
// string object equal to "swapto", which will be destroyed at end of call
// - the postcall hook will throw if any argument equals "postthrow"
struct example_policy {
static inline std::vector<std::pair<nb::tuple, nb::object>> calls;
static void precall(PyObject **args, size_t nargs,
nb::detail::cleanup_list *cleanup) {
PyObject* tup = PyTuple_New(nargs);
for (size_t i = 0; i < nargs; ++i) {
if (!PyUnicode_CheckExact(args[i])) {
Py_DECREF(tup);
throw std::runtime_error("expected only strings");
}
if (0 == PyUnicode_CompareWithASCIIString(args[i], "swapfrom")) {
nb::object replacement = nb::cast("swapto");
args[i] = replacement.ptr();
cleanup->append(replacement.release().ptr());
}
Py_INCREF(args[i]);
PyTuple_SetItem(tup, i, args[i]);
}
calls.emplace_back(nb::steal<nb::tuple>(tup), nb::cast("<unfinished>"));
}
static void postcall(PyObject **args, size_t nargs, nb::handle ret) {
if (!ret.is_valid()) {
calls.back().second = nb::cast("<return conversion failed>");
} else {
calls.back().second = nb::borrow(ret);
}
for (size_t i = 0; i < nargs; ++i) {
if (0 == PyUnicode_CompareWithASCIIString(args[i], "postthrow")) {
throw std::runtime_error("postcall exception");
}
}
}
};
struct numeric_string {
unsigned long number;
};
template <> struct nb::detail::type_caster<numeric_string> {
NB_TYPE_CASTER(numeric_string, const_name("str"))
bool from_python(handle h, uint8_t flags, cleanup_list* cleanup) noexcept {
make_caster<const char*> str_caster;
if (!str_caster.from_python(h, flags, cleanup))
return false;
const char* str = str_caster.operator cast_t<const char*>();
if (!str)
return false;
char* endp;
value.number = strtoul(str, &endp, 10);
return *str && !*endp;
}
static handle from_cpp(numeric_string, rv_policy, handle) noexcept {
return nullptr;
}
};
int test_31(int i) noexcept { return i; }
NB_MODULE(test_functions_ext, m) {
m.doc() = "function testcase";
// Function without inputs/outputs
m.def("test_01", []() { });
// Simple binary function (via function pointer)
auto test_02 = [](int up, int down) -> int { return up - down; };
m.def("test_02", (int (*)(int, int)) test_02, "up"_a = 8, "down"_a = 1);
// Simple binary function with capture object
int i = 42;
m.def("test_03", [i](int j, int k) -> int { return i + j - k; });
// Large capture object requiring separate storage
uint64_t k = 10, l = 11, m_ = 12, n = 13, o = 14;
m.def("test_04", [k, l, m_, n, o]() -> int { return (int) (k + l + m_ + n + o); });
// Overload chain with two docstrings
m.def("test_05", [](int) -> int { return 1; }, "doc_1");
nb::object first_overload = m.attr("test_05");
m.def("test_05", [](float) -> int { return 2; }, "doc_2");
#if !defined(PYPY_VERSION) && !defined(Py_GIL_DISABLED)
// Make sure we don't leak the previous member of the overload chain
// (pypy's refcounts are bogus and will not help us with this check)
if (first_overload.ptr()->ob_refcnt != 1) {
throw std::runtime_error("Overload was leaked!");
}
#endif
first_overload.reset();
// Test an overload chain that always repeats the same docstring
m.def("test_05b", [](int) -> int { return 1; }, "doc_1");
m.def("test_05b", [](float) -> int { return 2; }, "doc_1");
// Test an overload chain with an empty docstring
m.def("test_05c", [](int) -> int { return 1; }, "doc_1");
m.def("test_05c", [](float) -> int { return 2; }, "");
/// Function raising an exception
m.def("test_06", []() { throw std::runtime_error("oops!"); });
/// Function taking some positional/keyword args and nb::[kw]args
m.def("test_07", [](int, int, nb::args args, nb::kwargs kwargs) {
return std::make_pair(args.size(), kwargs.size());
});
/// As above, but with nb::arg annotations
m.def("test_07", [](int, int, nb::args args, nb::kwargs kwargs) {
return std::make_pair(args.size(), kwargs.size());
}, "a"_a, "b"_a, "myargs"_a, "mykwargs"_a);
/// Test successful/unsuccessful tuple conversion, with rich output types
m.def("test_tuple", []() -> nb::typed<nb::tuple, std::string, int> {
return nb::make_tuple("Hello", 123); });
m.def("test_bad_tuple", []() -> nb::typed<nb::object, std::pair<std::string, nb::object>> {
struct Foo{}; return nb::make_tuple("Hello", Foo()); });
/// Perform a Python function call from C++
m.def("test_call_1", [](nb::typed<nb::object, std::function<int(int)>> o) {
return o(1);
});
m.def("test_call_2", [](nb::typed<nb::callable, void(int, int)> o) {
return o(1, 2);
});
/// Test expansion of args/kwargs-style arguments
m.def("test_call_extra", [](nb::typed<nb::callable, void(...)> o,
nb::args args, nb::kwargs kwargs) {
return o(1, 2, *args, **kwargs, "extra"_a = 5);
});
/// Test list manipulation
m.def("test_list", [](nb::list l) {
int result = 0;
for (size_t i = 0; i < l.size(); ++i)
result += nb::cast<int>(l[i]);
l[2] = 123;
l.append(result);
});
/// Test tuple manipulation
m.def("test_tuple", [](nb::typed<nb::tuple, int, nb::ellipsis> l) {
int result = 0;
for (size_t i = 0; i < l.size(); ++i)
result += nb::cast<int>(l[i]);
return result;
});
/// Test call_guard feature
m.def("test_call_guard_wrapper_rvalue_ref", [](int&& i) { return i; },
nb::call_guard<my_call_guard>());
m.def("test_call_guard", []() {
return call_guard_value;
}, nb::call_guard<my_call_guard>());
m.def("call_guard_value", []() { return call_guard_value; });
m.def("test_release_gil", []() -> bool {
#if defined(Py_LIMITED_API)
return false;
#else
return PyGILState_Check();
#endif
}, nb::call_guard<nb::gil_scoped_release>());
m.def("test_print", []{
nb::print("Test 1");
nb::print("Test 2"_s);
});
m.def("test_iter", [](nb::object in) {
nb::list l;
for (nb::handle h : in)
l.append(h);
return l;
});
m.def("test_iter_tuple", [](nb::tuple in) {
nb::list l;
for (nb::handle h : in)
l.append(h);
return l;
});
m.def("test_iter_list", [](nb::list in) {
nb::list l;
for (nb::handle h : in)
l.append(h);
return l;
});
// Overload chain with a raw docstring that has precedence
m.def("test_08", [](int) -> int { return 1; }, "first docstring");
m.def("test_08", [](float) -> int { return 2; },
nb::sig("def test_08(x: typing.Annotated[float, 'foo']) -> int"),
"another docstring");
// Manual type check
m.def("test_09", [](nb::type_object t) -> bool { return t.is(&PyBool_Type); });
// nb::dict iterator
m.def("test_10", [](nb::dict d) {
nb::dict result;
for (auto [k, v] : d)
result[k] = v;
return result;
});
m.def("test_10_contains", [](nb::dict d) {
return d.contains("foo"_s);
});
// Test implicit conversion of various types
m.def("test_11_sl", [](signed long x) { return x; });
m.def("test_11_ul", [](unsigned long x) { return x; });
m.def("test_11_sll", [](signed long long x) { return x; });
m.def("test_11_ull", [](unsigned long long x) { return x; });
// Test string caster
m.def("test_12", [](const char *c) { return nb::str(c); });
m.def("test_13", []() -> const char * { return "test"; });
m.def("test_14", [](nb::object o) -> const char * { return nb::cast<const char *>(o); });
// Test bytes type
m.def("test_15", [](nb::bytes o) -> const char * { return o.c_str(); });
m.def("test_15_d", [](nb::bytes o) { return nb::bytes(o.data(), o.size()); });
m.def("test_16", [](const char *c) { return nb::bytes(c); });
m.def("test_17", [](nb::bytes c) { return c.size(); });
m.def("test_18", [](const char *c, int size) { return nb::bytes(c, size); });
// Test int type
m.def("test_19", [](nb::int_ i) { return i + nb::int_(123); });
m.def("test_20", [](nb::str s) { return nb::int_(s) + nb::int_(123); });
m.def("test_21", [](nb::int_ i) { return (int) i; });
m.def("test_21_f", [](nb::float_ f) { return nb::int_(f); });
m.def("test_21_g", []() { return nb::int_(1.5); });
m.def("test_21_h", []() { return nb::int_(1e50); });
// Test floating-point
m.def("test_21_dnc", [](double d) { return d + 1.0; }, nb::arg().noconvert());
m.def("test_21_fnc", [](float f) { return f + 1.0f; }, nb::arg().noconvert());
// Test capsule wrapper
m.def("test_22", []() -> void * { return (void*) 1; });
m.def("test_23", []() -> void * { return nullptr; });
m.def("test_24", [](void *p) { return (uintptr_t) p; }, "p"_a.none());
// Test slice
m.def("test_25", [](nb::slice s) { return s; });
m.def("test_26", []() { return nb::slice(4); });
m.def("test_27", []() {
nb::slice s(2, 10);
auto tpl = s.compute(7);
if (tpl.get<0>() != 2) return nb::slice(400); // fail
auto [start, stop, step, slice_length] = tpl;
if (start != 2) return nb::slice(401); // fail
if (stop != 7) return nb::slice(402); // fail
if (step != 1) return nb::slice(403); // fail
if (slice_length != 5) return nb::slice(404); // fail
return s;
});
m.def("test_28", []() { return nb::slice(5, -5, -2); });
// Test ellipsis
m.def("test_29", [](nb::ellipsis) { return nb::ellipsis(); });
// Traceback test
m.def("test_30", [](nb::callable f) -> std::string {
nb::gil_scoped_release g;
try {
nb::gil_scoped_acquire g2;
f();
} catch (const nb::python_error &e) {
return e.what();
}
return "Unknown";
});
m.def("test_31", &test_31);
m.def("test_32", [](int i) noexcept { return i; });
m.def("identity_i8", [](int8_t i) { return i; });
m.def("identity_u8", [](uint8_t i) { return i; });
m.def("identity_i16", [](int16_t i) { return i; });
m.def("identity_u16", [](uint16_t i) { return i; });
m.def("identity_i32", [](int32_t i) { return i; });
m.def("identity_u32", [](uint32_t i) { return i; });
m.def("identity_i64", [](int64_t i) { return i; });
m.def("identity_u64", [](uint64_t i) { return i; });
m.attr("test_33") = nb::cpp_function([](nb::object self, int y) {
return nb::cast<int>(self.attr("x")) + y;
}, nb::is_method());
m.attr("test_34") = nb::cpp_function([](nb::object self, int y) {
return nb::cast<int>(self.attr("x")) * y;
}, nb::arg("y"), nb::is_method());
m.def("test_35", []() {
const char *name = "Foo";
auto callback = [=]() {
return "Test {}"_s.format(name);
};
return nb::cpp_function(callback);
});
m.def("test_cast_char", [](nb::handle h) {
return nb::cast<char>(h);
});
m.def("test_cast_str", [](nb::handle h) {
return nb::cast<const char *>(h);
});
m.def("test_set", []() {
nb::set s;
s.add("123");
s.add(123);
return s;
});
m.def("test_set_contains", [](nb::set s, nb::handle h) { return s.contains(h); });
m.def("test_frozenset", []() {
return nb::frozenset(nb::make_tuple("123", 123));
});
m.def("test_frozenset_contains", [](nb::frozenset s, nb::handle h) {
return s.contains(h);
});
m.def("test_del_list", [](nb::list l) { nb::del(l[2]); });
m.def("test_del_dict", [](nb::dict l) { nb::del(l["a"]); });
static int imut = 10;
static const int iconst = 100;
m.def("test_ptr_return", []() { return std::make_pair(&imut, &iconst); });
// These are caught at compile time, uncomment and rebuild to verify:
// No nb::arg annotations:
//m.def("bad_args1", [](nb::args, int) {});
// kw_only in wrong place (1):
//m.def("bad_args2", [](nb::args, int) {}, nb::kw_only(), "args"_a, "i"_a);
// kw_only in wrong place (2):
//m.def("bad_args3", [](nb::args, int) {}, "args"_a, "i"_a, nb::kw_only());
// kw_only in wrong place (3):
//m.def("bad_args4", [](int, nb::kwargs) {}, "i"_a, "kwargs"_a, nb::kw_only());
// kw_only specified twice:
//m.def("bad_args5", [](int, int) {}, nb::kw_only(), "i"_a, nb::kw_only(), "j"_a);
m.def("test_args_kwonly",
[](int i, double j, nb::args args, int z) {
return nb::make_tuple(i, j, args, z);
}, "i"_a, "j"_a, "args"_a, "z"_a);
m.def("test_args_kwonly_kwargs",
[](int i, double j, nb::args args, int z, nb::kwargs kwargs) {
return nb::make_tuple(i, j, args, z, kwargs);
}, "i"_a, "j"_a, "args"_a, nb::kw_only(), "z"_a, "kwargs"_a);
m.def("test_kwonly_kwargs",
[](int i, double j, nb::kwargs kwargs) {
return nb::make_tuple(i, j, kwargs);
}, "i"_a, nb::kw_only(), "j"_a, "kwargs"_a);
m.def("test_kw_only_all",
[](int i, int j) { return nb::make_tuple(i, j); },
nb::kw_only(), "i"_a, "j"_a);
m.def("test_kw_only_some",
[](int i, int j, int k) { return nb::make_tuple(i, j, k); },
nb::arg(), nb::kw_only(), "j"_a, "k"_a);
m.def("test_kw_only_with_defaults",
[](int i, int j, int k, int z) { return nb::make_tuple(i, j, k, z); },
nb::arg() = 3, "j"_a = 4, nb::kw_only(), "k"_a = 5, "z"_a);
m.def("test_kw_only_mixed",
[](int i, int j) { return nb::make_tuple(i, j); },
"i"_a, nb::kw_only(), "j"_a);
struct kw_only_methods {
kw_only_methods(int _v) : v(_v) {}
int v;
};
nb::class_<kw_only_methods>(m, "kw_only_methods")
.def(nb::init<int>(), nb::kw_only(), "v"_a)
.def_rw("v", &kw_only_methods::v)
.def("method_2k",
[](kw_only_methods&, int i, int j) { return nb::make_tuple(i, j); },
nb::kw_only(), "i"_a = 1, "j"_a = 2)
.def("method_1p1k",
[](kw_only_methods&, int i, int j) { return nb::make_tuple(i, j); },
"i"_a = 1, nb::kw_only(), "j"_a = 2);
m.def("test_any", [](nb::any a) { return a; } );
m.def("test_wrappers_list", []{
nb::list l1, l2;
l1.append(1);
l2.append(2);
l1.extend(l2);
bool b = nb::len(l1) == 2 && nb::len(l2) == 1 &&
l1[0].equal(nb::int_(1)) && l1[1].equal(nb::int_(2));
l1.clear();
return b && nb::len(l1) == 0;
});
m.def("test_wrappers_dict", []{
nb::dict d1, d2;
d1["a"] = 1;
d2["b"] = 2;
d1.update(d2);
bool b = nb::len(d1) == 2 && nb::len(d2) == 1 &&
d1["a"].equal(nb::int_(1)) &&
d1["b"].equal(nb::int_(2));
d1.clear();
return b && nb::len(d1) == 0;
});
m.def("test_wrappers_set", []{
nb::set s;
s.add("a");
s.add("b");
bool b = nb::len(s) == 2 && s.contains("a") && s.contains("b");
b &= s.discard("a");
b &= !s.discard("q");
b &= !s.contains("a") && s.contains("b");
s.clear();
b &= s.size() == 0;
return b;
});
m.def("hash_it", [](nb::handle h) { return nb::hash(h); });
m.def("isinstance_", [](nb::handle inst, nb::handle cls) {
return nb::isinstance(inst, cls);
});
// Test bytearray type
m.def("test_bytearray_new", []() { return nb::bytearray(); });
m.def("test_bytearray_new", [](const char *c, int size) { return nb::bytearray(c, size); });
m.def("test_bytearray_copy", [](nb::bytearray o) { return nb::bytearray(o.c_str(), o.size()); });
m.def("test_bytearray_c_str", [](nb::bytearray o) -> const char * { return o.c_str(); });
m.def("test_bytearray_size", [](nb::bytearray o) { return o.size(); });
m.def("test_bytearray_resize", [](nb::bytearray c, int size) { return c.resize(size); });
// Test call_policy feature
m.def("test_call_policy",
[](const char* s, numeric_string n) -> const char* {
if (0 == strcmp(s, "returnfail")) {
return "not utf8 \xff";
}
if (n.number > strlen(s)) {
throw std::runtime_error("offset too large");
}
return s + n.number;
},
nb::call_policy<example_policy>());
m.def("call_policy_record",
[]() {
auto ret = std::move(example_policy::calls);
return ret;
});
m.def("abi_tag", [](){ return nb::detail::abi_tag(); });
// Test the nb::fallback type
m.def("test_fallback_1", [](double){ return 0; });
m.def("test_fallback_1", [](nb::handle){ return 1; });
m.def("test_fallback_2", [](double) { return 0; });
m.def("test_fallback_2", [](nb::fallback){ return 1; });
m.def("test_get_dict_default", [](nb::dict l) { return l.get("key", nb::int_(123)); });
}
|