Skip to content

Document using atexit for module destructors #1169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 24, 2017
Merged

Document using atexit for module destructors #1169

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d61ac9d
Document using atexit for module destructors
bmerry Nov 6, 2017
37a03cb
Redo atexit documentation
bmerry Nov 7, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/advanced/misc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,21 @@ avoids this issue involves weak reference with a cleanup callback:
// Create a weak reference with a cleanup callback and initially leak it
(void) py::weakref(m.attr("BaseClass"), cleanup_callback).release();

.. note::

PyPy (at least version 5.9) does not garbage collect objects when the
interpreter exits. An alternative approach (which also works on CPython) is to use
the :py:mod:`atexit` module [#f7]_, for example:

.. code-block:: cpp

auto atexit = py::module::import("atexit");
atexit.attr("register")(py::cpp_function([]() {
// perform cleanup here -- this function is called with the GIL held
}));

.. [#f7] https://docs.python.org/3/library/atexit.html


Generating documentation using Sphinx
=====================================
Expand Down