boostorg / boostorg/python

with_custodian_and_ward doesn't guarantee destructor ordering

Open
#128 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
537
Forks
223
Avg merge
11h 22m
Merged PRs (30d)
2

Description

The weakref trick used by `with_custodian_and_ward` relies on the nurse object being cleared before it calls the callback which drops the reference to the patient. This is mostly but not always true: when the cyclic garbage collector runs, it first makes all weakref callbacks before freeing the garbage (at least in Python 2.7.12). This can lead to the patient's destructor running before the nurse's, with dire consequences if the nurse references the patient in its destructor.

pybind11 uses the same weakref trick and suffers the same bug: https://github.com/pybind/pybind11/issues/856.

## Example code

keepalive.cpp:
```c++
#include
#include

namespace py = boost::python;

class B;

class A {
private:
B &b;
public:
A(B &b) : b(b) {}
~A() { std::cerr << "In A::~A()\n"; }
};

class B {
public:
~B() { std::cerr << "In B::~B()\n"; }
};

BOOST_PYTHON_MODULE(keepalive) {
py::class_("A", py::init()[py::with_custodian_and_ward<1, 2>()]);
py::class_("B");
}
```

test.py:
```python
#!/usr/bin/env python
from keepalive import A, B

lst = [A(B())]
lst.append(lst)
del lst
```

Output:
```
In B::~B()
In A::~A()
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.