mirror of
https://github.com/pybind/pybind11.git
synced 2026-06-06 06:11:25 +00:00
Improve constructor/destructor tracking
This commit rewrites the examples that look for constructor/destructor calls to do so via static variable tracking rather than output parsing. The added ConstructorStats class provides methods to keep track of constructors and destructors, number of default/copy/move constructors, and number of copy/move assignments. It also provides a mechanism for storing values (e.g. for value construction), and then allows all of this to be checked at the end of a test by getting the statistics for a C++ (or python mapping) class. By not relying on the precise pattern of constructions/destructions, but rather simply ensuring that every construction is matched with a destruction on the same object, we ensure that everything that gets created also gets destroyed as expected. This replaces all of the various "std::cout << whatever" code in constructors/destructors with `print_created(this)`/`print_destroyed(this)`/etc. functions which provide similar output, but now has a unified format across the different examples, including a new ### prefix that makes mixed example output and lifecycle events easier to distinguish. With this change, relaxed mode is no longer needed, which enables testing for proper destruction under MSVC, and under any other compiler that generates code calling extra constructors, or optimizes away any constructors. GCC/clang are used as the baseline for move constructors; the tests are adapted to allow more move constructors to be evoked (but other types are constructors much have matching counts). This commit also disables output buffering of tests, as the buffering sometimes results in C++ output ending up in the middle of python output (or vice versa), depending on the OS/python version.
This commit is contained in:
@@ -8,18 +8,16 @@
|
||||
*/
|
||||
|
||||
#include "example.h"
|
||||
#include "constructor-stats.h"
|
||||
#include <pybind11/functional.h>
|
||||
|
||||
/* This is an example class that we'll want to be able to extend from Python */
|
||||
class ExampleVirt {
|
||||
public:
|
||||
ExampleVirt(int state) : state(state) {
|
||||
cout << "Constructing ExampleVirt.." << endl;
|
||||
}
|
||||
|
||||
~ExampleVirt() {
|
||||
cout << "Destructing ExampleVirt.." << endl;
|
||||
}
|
||||
ExampleVirt(int state) : state(state) { print_created(this, state); }
|
||||
ExampleVirt(const ExampleVirt &e) : state(e.state) { print_copy_created(this); }
|
||||
ExampleVirt(ExampleVirt &&e) : state(e.state) { print_move_created(this); e.state = 0; }
|
||||
~ExampleVirt() { print_destroyed(this); }
|
||||
|
||||
virtual int run(int value) {
|
||||
std::cout << "Original implementation of ExampleVirt::run(state=" << state
|
||||
@@ -71,8 +69,8 @@ public:
|
||||
|
||||
class NonCopyable {
|
||||
public:
|
||||
NonCopyable(int a, int b) : value{new int(a*b)} {}
|
||||
NonCopyable(NonCopyable &&) = default;
|
||||
NonCopyable(int a, int b) : value{new int(a*b)} { print_created(this, a, b); }
|
||||
NonCopyable(NonCopyable &&o) { value = std::move(o.value); print_move_created(this); }
|
||||
NonCopyable(const NonCopyable &) = delete;
|
||||
NonCopyable() = delete;
|
||||
void operator=(const NonCopyable &) = delete;
|
||||
@@ -80,7 +78,7 @@ public:
|
||||
std::string get_value() const {
|
||||
if (value) return std::to_string(*value); else return "(null)";
|
||||
}
|
||||
~NonCopyable() { std::cout << "NonCopyable destructor @ " << this << "; value = " << get_value() << std::endl; }
|
||||
~NonCopyable() { print_destroyed(this); }
|
||||
|
||||
private:
|
||||
std::unique_ptr<int> value;
|
||||
@@ -90,11 +88,11 @@ private:
|
||||
// when it is not referenced elsewhere, but copied if it is still referenced.
|
||||
class Movable {
|
||||
public:
|
||||
Movable(int a, int b) : value{a+b} {}
|
||||
Movable(const Movable &m) { value = m.value; std::cout << "Movable @ " << this << " copy constructor" << std::endl; }
|
||||
Movable(Movable &&m) { value = std::move(m.value); std::cout << "Movable @ " << this << " move constructor" << std::endl; }
|
||||
Movable(int a, int b) : value{a+b} { print_created(this, a, b); }
|
||||
Movable(const Movable &m) { value = m.value; print_copy_created(this); }
|
||||
Movable(Movable &&m) { value = std::move(m.value); print_move_created(this); }
|
||||
int get_value() const { return value; }
|
||||
~Movable() { std::cout << "Movable destructor @ " << this << "; value = " << get_value() << std::endl; }
|
||||
~Movable() { print_destroyed(this); }
|
||||
private:
|
||||
int value;
|
||||
};
|
||||
@@ -305,5 +303,6 @@ void init_ex_virtual_functions(py::module &m) {
|
||||
m.def("runExampleVirtBool", &runExampleVirtBool);
|
||||
m.def("runExampleVirtVirtual", &runExampleVirtVirtual);
|
||||
|
||||
m.def("cstats_debug", &ConstructorStats::get<ExampleVirt>);
|
||||
initialize_inherited_virtuals(m);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user