test_call_policies.cpp
Go to the documentation of this file.
1 /*
2  tests/test_call_policies.cpp -- keep_alive and call_guard
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 
12 struct CustomGuard {
13  static bool enabled;
14 
15  CustomGuard() { enabled = true; }
16  ~CustomGuard() { enabled = false; }
17 
18  static const char *report_status() { return enabled ? "guarded" : "unguarded"; }
19 };
20 bool CustomGuard::enabled = false;
21 
23  static bool enabled;
24 
26  ~DependentGuard() { enabled = false; }
27 
28  static const char *report_status() { return enabled ? "guarded" : "unguarded"; }
29 };
30 bool DependentGuard::enabled = false;
31 
32 TEST_SUBMODULE(call_policies, m) {
33  // Parent/Child are used in:
34  // test_keep_alive_argument, test_keep_alive_return_value, test_alive_gc_derived,
35  // test_alive_gc_multi_derived, test_return_none, test_keep_alive_constructor
36  class Child {
37  public:
38  Child() { py::print("Allocating child."); }
39  Child(const Child &) = default;
40  Child(Child &&) = default;
41  ~Child() { py::print("Releasing child."); }
42  };
43  py::class_<Child>(m, "Child").def(py::init<>());
44 
45  class Parent {
46  public:
47  Parent() { py::print("Allocating parent."); }
48  Parent(const Parent &parent) = default;
49  ~Parent() { py::print("Releasing parent."); }
50  void addChild(Child *) {}
51  Child *returnChild() { return new Child(); }
52  Child *returnNullChild() { return nullptr; }
53  static Child *staticFunction(Parent *) { return new Child(); }
54  };
55  py::class_<Parent>(m, "Parent")
56  .def(py::init<>())
57  .def(py::init([](Child *) { return new Parent(); }), py::keep_alive<1, 2>())
58  .def("addChild", &Parent::addChild)
59  .def("addChildKeepAlive", &Parent::addChild, py::keep_alive<1, 2>())
60  .def("returnChild", &Parent::returnChild)
61  .def("returnChildKeepAlive", &Parent::returnChild, py::keep_alive<1, 0>())
62  .def("returnNullChildKeepAliveChild", &Parent::returnNullChild, py::keep_alive<1, 0>())
63  .def("returnNullChildKeepAliveParent", &Parent::returnNullChild, py::keep_alive<0, 1>())
64  .def_static("staticFunction", &Parent::staticFunction, py::keep_alive<1, 0>());
65 
66  m.def("free_function", [](Parent *, Child *) {}, py::keep_alive<1, 2>());
67  m.def("invalid_arg_index", [] {}, py::keep_alive<0, 1>());
68 
69 #if !defined(PYPY_VERSION)
70  // test_alive_gc
71  class ParentGC : public Parent {
72  public:
73  using Parent::Parent;
74  };
75  py::class_<ParentGC, Parent>(m, "ParentGC", py::dynamic_attr()).def(py::init<>());
76 #endif
77 
78  // test_call_guard
79  m.def("unguarded_call", &CustomGuard::report_status);
80  m.def("guarded_call", &CustomGuard::report_status, py::call_guard<CustomGuard>());
81 
82  m.def(
83  "multiple_guards_correct_order",
84  []() {
85  return CustomGuard::report_status() + std::string(" & ")
87  },
88  py::call_guard<CustomGuard, DependentGuard>());
89 
90  m.def(
91  "multiple_guards_wrong_order",
92  []() {
93  return DependentGuard::report_status() + std::string(" & ")
95  },
96  py::call_guard<DependentGuard, CustomGuard>());
97 
98 #if !defined(PYPY_VERSION)
99  // `py::call_guard<py::gil_scoped_release>()` should work in PyPy as well,
100  // but it's unclear how to test it without `PyGILState_GetThisThreadState`.
101  auto report_gil_status = []() {
102  auto is_gil_held = false;
103  if (auto *tstate = py::detail::get_thread_state_unchecked()) {
104  is_gil_held = (tstate == PyGILState_GetThisThreadState());
105  }
106 
107  return is_gil_held ? "GIL held" : "GIL released";
108  };
109 
110  m.def("with_gil", report_gil_status);
111  m.def("without_gil", report_gil_status, py::call_guard<py::gil_scoped_release>());
112 #endif
113 }
Eigen::internal::print
EIGEN_STRONG_INLINE Packet4f print(const Packet4f &a)
Definition: NEON/PacketMath.h:3115
DependentGuard::report_status
static const char * report_status()
Definition: test_call_policies.cpp:28
DependentGuard::DependentGuard
DependentGuard()
Definition: test_call_policies.cpp:25
get_thread_state_unchecked
PyThreadState * get_thread_state_unchecked()
Definition: type_caster_base.h:517
CustomGuard::report_status
static const char * report_status()
Definition: test_call_policies.cpp:18
TEST_SUBMODULE
TEST_SUBMODULE(call_policies, m)
Definition: test_call_policies.cpp:32
CustomGuard
Definition: test_call_policies.cpp:12
CustomGuard::~CustomGuard
~CustomGuard()
Definition: test_call_policies.cpp:16
m
Matrix3f m
Definition: AngleAxis_mimic_euler.cpp:1
init
detail::initimpl::constructor< Args... > init()
Binds an existing constructor taking arguments Args...
Definition: pybind11.h:2006
DependentGuard::~DependentGuard
~DependentGuard()
Definition: test_call_policies.cpp:26
CustomGuard::CustomGuard
CustomGuard()
Definition: test_call_policies.cpp:15
pybind11_tests.h
CustomGuard::enabled
static bool enabled
Definition: test_call_policies.cpp:13
DependentGuard::enabled
static bool enabled
Definition: test_call_policies.cpp:23
DependentGuard
Definition: test_call_policies.cpp:22


gtsam
Author(s):
autogenerated on Fri Nov 1 2024 03:39:26