First iteration of consume call policy. Noisy, ugly, and incomplete.

some cleanup

Author: torokati44

include/pybind11/attr.h

@@ -44,6 +44,9 @@ template <typename T> struct base {
 /// Keep patient alive while nurse lives
 template <size_t Nurse, size_t Patient> struct keep_alive { };
 
+/// Give ownership of parameter to the called function
+template <size_t Consumed> struct consume { };
+
 /// Annotation indicating that a class is involved in a multiple inheritance relationship
 struct multiple_inheritance { };
 
@@ -117,6 +120,7 @@ enum op_type : int;
 struct undefined_t;
 template <op_id id, op_type ot, typename L = undefined_t, typename R = undefined_t> struct op_;
 inline void keep_alive_impl(size_t Nurse, size_t Patient, function_call &call, handle ret);
+inline void consume_impl(size_t Consumed, function_call &call);
 
 /// Internal data structure which holds metadata about a keyword argument
 struct argument_record {
@@ -450,6 +454,13 @@ template <size_t Nurse, size_t Patient> struct process_attribute<keep_alive<Nurs
     static void postcall(function_call &call, handle ret) { keep_alive_impl(Nurse, Patient, call, ret); }
 };
 
+template <size_t Consumed> struct process_attribute<consume<Consumed>> : public process_attribute_default<consume<Consumed>> {
+    template <size_t C = Consumed, enable_if_t<C != 0, int> = 0>
+    static void precall(function_call &call) {
+        consume_impl(Consumed, call);
+    }
+};
+
 /// Recursively iterate over variadic template arguments
 template <typename... Args> struct process_attributes {
     static void init(const Args&... args, function_record *r) {

include/pybind11/pybind11.h

@@ -1508,6 +1508,31 @@ PYBIND11_NOINLINE inline void keep_alive_impl(size_t Nurse, size_t Patient, func
     keep_alive_impl(get_arg(Nurse), get_arg(Patient));
 }
 
+// template<typename holder_type> // ???
+inline void consume_impl(handle consumed) {
+    if (!consumed)
+        pybind11_fail("Could not activate consume!");
+
+    if (consumed.is_none())
+        return; /* Nothing to consume */
+
+    // auto tinfo = all_type_info(Py_TYPE(consumed.ptr())); // ???
+
+    //consumed.dec_ref(); ???
+
+    // del the name of consumed from the Python scope somehow ...
+
+    auto inst = reinterpret_cast<detail::instance *>(consumed.ptr());
+    auto &holder = values_and_holders(inst).begin()->holder<  std::unique_ptr  <void*>  >(); // holder_type ???
+    holder.release();
+}
+
+PYBIND11_NOINLINE inline void consume_impl(size_t Consumed, function_call &call) {
+    consume_impl(
+        Consumed == 0 ? handle() : Consumed <= call.args.size() ? call.args[Consumed - 1] : handle()
+    );
+}
+
 inline std::pair<decltype(internals::registered_types_py)::iterator, bool> all_type_info_get_cache(PyTypeObject *type) {
     auto res = get_internals().registered_types_py
 #ifdef __cpp_lib_unordered_map_try_emplace

tests/CMakeLists.txt

@@ -29,6 +29,7 @@ set(PYBIND11_TEST_FILES
   test_buffers.cpp
   test_builtin_casters.cpp
   test_call_policies.cpp
+  test_consume.cpp
   test_callbacks.cpp
   test_chrono.cpp
   test_class.cpp

tests/test_consume.cpp

@@ -0,0 +1,50 @@
+/*
+    tests/test_consume.cpp -- consume call policy
+
+    Copyright (c) 2016 Wenzel Jakob <[email protected]>
+    Copyright (c) 2017 Attila Török <[email protected]>
+
+    All rights reserved. Use of this source code is governed by a
+    BSD-style license that can be found in the LICENSE file.
+*/
+
+#include "pybind11_tests.h"
+
+class Box {
+    int size;
+    static int num_boxes;
+
+public:
+    Box(int size): size(size) { py::print("Box created."); ++num_boxes; }
+    ~Box() { py::print("Box destroyed."); --num_boxes; }
+
+    int get_size() { return size; }
+    static int get_num_boxes() { return num_boxes; }
+};
+
+int Box::num_boxes = 0;
+
+class Filter {
+    int threshold;
+
+public:
+    Filter(int threshold): threshold(threshold) { py::print("Filter created."); }
+    ~Filter() { py::print("Filter destroyed."); }
+
+    void process(Box *box) { // ownership of box is taken
+        py::print("Box is processed by Filter.");
+        if (box->get_size() > threshold)
+            delete box;
+        // otherwise the box is leaked
+    };
+};
+
+test_initializer consume([](py::module &m) {
+    py::class_<Box>(m, "Box")
+        .def(py::init<int>())
+        .def_static("get_num_boxes", &Box::get_num_boxes);
+
+    py::class_<Filter>(m, "Filter")
+        .def(py::init<int>())
+        .def("process", &Filter::process, py::consume<2>());
+});

tests/test_consume.py

@@ -0,0 +1,42 @@
+import pytest
+
+
+def test_consume_argument(capture):
+    from pybind11_tests import Box, Filter
+
+    with capture:
+        filt = Filter(4)
+    assert capture == "Filter created."
+    with capture:
+        box_1 = Box(1)
+        box_8 = Box(8)
+    assert capture == """
+        Box created.
+        Box created.
+    """
+
+    assert Box.get_num_boxes() == 2
+
+    with capture:
+        filt.process(box_1)  # box_1 is not big enough, but process() leaks it
+    assert capture == "Box is processed by Filter."
+
+    assert Box.get_num_boxes() == 2
+
+    with capture:
+        filt.process(box_8)  # box_8 is destroyed by process() of filt
+    assert capture == """
+        Box is processed by Filter.
+        Box destroyed.
+    """
+
+    assert Box.get_num_boxes() == 1  # box_1 still exists somehow, but we can't access it
+
+    with capture:
+        del filt
+        del box_1
+        del box_8
+        pytest.gc_collect()
+    assert capture == "Filter destroyed."
+
+    assert Box.get_num_boxes() == 1  # 1 box is leaked, and we can't do anything