2015-07-05 18:05:44 +00:00
|
|
|
/*
|
|
|
|
|
example/example.cpp -- pybind example plugin
|
|
|
|
|
|
2016-04-17 18:21:41 +00:00
|
|
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch>
|
2015-07-05 18:05:44 +00:00
|
|
|
|
|
|
|
|
All rights reserved. Use of this source code is governed by a
|
|
|
|
|
BSD-style license that can be found in the LICENSE file.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#include "example.h"
|
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.
2016-08-07 17:05:26 +00:00
|
|
|
#include "constructor-stats.h"
|
2015-07-05 18:05:44 +00:00
|
|
|
|
Rename examples files, as per #288
This renames example files from `exampleN` to `example-description`.
Specifically, the following renaming is applied:
example1 -> example-methods-and-attributes
example2 -> example-python-types
example3 -> example-operator-overloading
example4 -> example-constants-and-functions
example5 -> example-callbacks (*)
example6 -> example-sequence-and-iterators
example7 -> example-buffers
example8 -> example-custom-ref-counting
example9 -> example-modules
example10 -> example-numpy-vectorize
example11 -> example-arg-keywords-and-defaults
example12 -> example-virtual-functions
example13 -> example-keep-alive
example14 -> example-opaque-types
example15 -> example-pickling
example16 -> example-inheritance
example17 -> example-stl-binders
example18 -> example-eval
example19 -> example-custom-exceptions
* the inheritance parts of example5 are moved into example-inheritance
(previously example16), and the remainder is left as example-callbacks.
This commit also renames the internal variables ("Example1",
"Example2", "Example4", etc.) into non-numeric names ("ExampleMandA",
"ExamplePythonTypes", "ExampleWithEnum", etc.) to correspond to the
file renaming.
The order of tests is preserved, but this can easily be changed if
there is some more natural ordering by updating the list in
examples/CMakeLists.txt.
2016-07-18 20:43:18 +00:00
|
|
|
void init_ex_methods_and_attributes(py::module &);
|
|
|
|
|
void init_ex_python_types(py::module &);
|
|
|
|
|
void init_ex_operator_overloading(py::module &);
|
|
|
|
|
void init_ex_constants_and_functions(py::module &);
|
|
|
|
|
void init_ex_callbacks(py::module &);
|
|
|
|
|
void init_ex_sequences_and_iterators(py::module &);
|
|
|
|
|
void init_ex_buffers(py::module &);
|
|
|
|
|
void init_ex_smart_ptr(py::module &);
|
|
|
|
|
void init_ex_modules(py::module &);
|
|
|
|
|
void init_ex_numpy_vectorize(py::module &);
|
|
|
|
|
void init_ex_arg_keywords_and_defaults(py::module &);
|
|
|
|
|
void init_ex_virtual_functions(py::module &);
|
|
|
|
|
void init_ex_keep_alive(py::module &);
|
|
|
|
|
void init_ex_opaque_types(py::module &);
|
|
|
|
|
void init_ex_pickling(py::module &);
|
|
|
|
|
void init_ex_inheritance(py::module &);
|
|
|
|
|
void init_ex_stl_binder_vector(py::module &);
|
|
|
|
|
void init_ex_eval(py::module &);
|
|
|
|
|
void init_ex_custom_exceptions(py::module &);
|
2016-06-19 14:50:31 +00:00
|
|
|
void init_ex20(py::module &);
|
2016-03-10 12:24:10 +00:00
|
|
|
void init_issues(py::module &);
|
2015-07-05 18:05:44 +00:00
|
|
|
|
2016-05-05 18:33:54 +00:00
|
|
|
#if defined(PYBIND11_TEST_EIGEN)
|
|
|
|
|
void init_eigen(py::module &);
|
|
|
|
|
#endif
|
|
|
|
|
|
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.
2016-08-07 17:05:26 +00:00
|
|
|
void bind_ConstructorStats(py::module &m) {
|
|
|
|
|
py::class_<ConstructorStats>(m, "ConstructorStats")
|
|
|
|
|
.def("alive", &ConstructorStats::alive)
|
|
|
|
|
.def("values", &ConstructorStats::values)
|
|
|
|
|
.def_readwrite("default_constructions", &ConstructorStats::default_constructions)
|
|
|
|
|
.def_readwrite("copy_assignments", &ConstructorStats::copy_assignments)
|
|
|
|
|
.def_readwrite("move_assignments", &ConstructorStats::move_assignments)
|
|
|
|
|
.def_readwrite("copy_constructions", &ConstructorStats::copy_constructions)
|
|
|
|
|
.def_readwrite("move_constructions", &ConstructorStats::move_constructions)
|
|
|
|
|
.def_static("get", (ConstructorStats &(*)(py::object)) &ConstructorStats::get, py::return_value_policy::reference_internal)
|
|
|
|
|
;
|
|
|
|
|
}
|
|
|
|
|
|
2015-10-18 14:48:30 +00:00
|
|
|
PYBIND11_PLUGIN(example) {
|
2015-07-05 18:05:44 +00:00
|
|
|
py::module m("example", "pybind example plugin");
|
|
|
|
|
|
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.
2016-08-07 17:05:26 +00:00
|
|
|
bind_ConstructorStats(m);
|
|
|
|
|
|
Rename examples files, as per #288
This renames example files from `exampleN` to `example-description`.
Specifically, the following renaming is applied:
example1 -> example-methods-and-attributes
example2 -> example-python-types
example3 -> example-operator-overloading
example4 -> example-constants-and-functions
example5 -> example-callbacks (*)
example6 -> example-sequence-and-iterators
example7 -> example-buffers
example8 -> example-custom-ref-counting
example9 -> example-modules
example10 -> example-numpy-vectorize
example11 -> example-arg-keywords-and-defaults
example12 -> example-virtual-functions
example13 -> example-keep-alive
example14 -> example-opaque-types
example15 -> example-pickling
example16 -> example-inheritance
example17 -> example-stl-binders
example18 -> example-eval
example19 -> example-custom-exceptions
* the inheritance parts of example5 are moved into example-inheritance
(previously example16), and the remainder is left as example-callbacks.
This commit also renames the internal variables ("Example1",
"Example2", "Example4", etc.) into non-numeric names ("ExampleMandA",
"ExamplePythonTypes", "ExampleWithEnum", etc.) to correspond to the
file renaming.
The order of tests is preserved, but this can easily be changed if
there is some more natural ordering by updating the list in
examples/CMakeLists.txt.
2016-07-18 20:43:18 +00:00
|
|
|
init_ex_methods_and_attributes(m);
|
|
|
|
|
init_ex_python_types(m);
|
|
|
|
|
init_ex_operator_overloading(m);
|
|
|
|
|
init_ex_constants_and_functions(m);
|
|
|
|
|
init_ex_callbacks(m);
|
|
|
|
|
init_ex_sequences_and_iterators(m);
|
|
|
|
|
init_ex_buffers(m);
|
|
|
|
|
init_ex_smart_ptr(m);
|
|
|
|
|
init_ex_modules(m);
|
|
|
|
|
init_ex_numpy_vectorize(m);
|
|
|
|
|
init_ex_arg_keywords_and_defaults(m);
|
|
|
|
|
init_ex_virtual_functions(m);
|
|
|
|
|
init_ex_keep_alive(m);
|
|
|
|
|
init_ex_opaque_types(m);
|
|
|
|
|
init_ex_pickling(m);
|
|
|
|
|
init_ex_inheritance(m);
|
|
|
|
|
init_ex_stl_binder_vector(m);
|
|
|
|
|
init_ex_eval(m);
|
|
|
|
|
init_ex_custom_exceptions(m);
|
2016-06-19 14:50:31 +00:00
|
|
|
init_ex20(m);
|
2016-03-10 12:24:10 +00:00
|
|
|
init_issues(m);
|
2015-07-05 18:05:44 +00:00
|
|
|
|
2016-05-05 18:33:54 +00:00
|
|
|
#if defined(PYBIND11_TEST_EIGEN)
|
|
|
|
|
init_eigen(m);
|
|
|
|
|
#endif
|
|
|
|
|
|
2015-07-05 18:05:44 +00:00
|
|
|
return m.ptr();
|
|
|
|
|
}
|
