195 lines
7.2 KiB
C++
195 lines
7.2 KiB
C++
/*
|
|
pybind11/embed.h: Support for embedding the interpreter
|
|
|
|
Copyright (c) 2017 Wenzel Jakob <wenzel.jakob@epfl.ch>
|
|
|
|
All rights reserved. Use of this source code is governed by a
|
|
BSD-style license that can be found in the LICENSE file.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "pybind11.h"
|
|
#include "eval.h"
|
|
|
|
#if defined(PYPY_VERSION)
|
|
# error Embedding the interpreter is not supported with PyPy
|
|
#endif
|
|
|
|
#if PY_MAJOR_VERSION >= 3
|
|
# define PYBIND11_EMBEDDED_MODULE_IMPL(name) \
|
|
extern "C" PyObject *pybind11_init_impl_##name() { \
|
|
return pybind11_init_wrapper_##name(); \
|
|
}
|
|
#else
|
|
# define PYBIND11_EMBEDDED_MODULE_IMPL(name) \
|
|
extern "C" void pybind11_init_impl_##name() { \
|
|
pybind11_init_wrapper_##name(); \
|
|
}
|
|
#endif
|
|
|
|
/** \rst
|
|
Add a new module to the table of builtins for the interpreter. Must be
|
|
defined in global scope. The first macro parameter is the name of the
|
|
module (without quotes). The second parameter is the variable which will
|
|
be used as the interface to add functions and classes to the module.
|
|
|
|
.. code-block:: cpp
|
|
|
|
PYBIND11_EMBEDDED_MODULE(example, m) {
|
|
// ... initialize functions and classes here
|
|
m.def("foo", []() {
|
|
return "Hello, World!";
|
|
});
|
|
}
|
|
\endrst */
|
|
#define PYBIND11_EMBEDDED_MODULE(name, variable) \
|
|
static void pybind11_init_##name(pybind11::module &); \
|
|
static PyObject *pybind11_init_wrapper_##name() { \
|
|
auto m = pybind11::module(#name); \
|
|
try { \
|
|
pybind11_init_##name(m); \
|
|
return m.ptr(); \
|
|
} catch (pybind11::error_already_set &e) { \
|
|
PyErr_SetString(PyExc_ImportError, e.what()); \
|
|
return nullptr; \
|
|
} catch (const std::exception &e) { \
|
|
PyErr_SetString(PyExc_ImportError, e.what()); \
|
|
return nullptr; \
|
|
} \
|
|
} \
|
|
PYBIND11_EMBEDDED_MODULE_IMPL(name) \
|
|
pybind11::detail::embedded_module name(#name, pybind11_init_impl_##name); \
|
|
void pybind11_init_##name(pybind11::module &variable)
|
|
|
|
|
|
NAMESPACE_BEGIN(pybind11)
|
|
NAMESPACE_BEGIN(detail)
|
|
|
|
/// Python 2.7/3.x compatible version of `PyImport_AppendInittab` and error checks.
|
|
struct embedded_module {
|
|
#if PY_MAJOR_VERSION >= 3
|
|
using init_t = PyObject *(*)();
|
|
#else
|
|
using init_t = void (*)();
|
|
#endif
|
|
embedded_module(const char *name, init_t init) {
|
|
if (Py_IsInitialized())
|
|
pybind11_fail("Can't add new modules after the interpreter has been initialized");
|
|
|
|
auto result = PyImport_AppendInittab(name, init);
|
|
if (result == -1)
|
|
pybind11_fail("Insufficient memory to add a new module");
|
|
}
|
|
};
|
|
|
|
NAMESPACE_END(detail)
|
|
|
|
/** \rst
|
|
Initialize the Python interpreter. No other pybind11 or CPython API functions can be
|
|
called before this is done; with the exception of `PYBIND11_EMBEDDED_MODULE`. The
|
|
optional parameter can be used to skip the registration of signal handlers (see the
|
|
Python documentation for details). Calling this function again after the interpreter
|
|
has already been initialized is a fatal error.
|
|
\endrst */
|
|
inline void initialize_interpreter(bool init_signal_handlers = true) {
|
|
if (Py_IsInitialized())
|
|
pybind11_fail("The interpreter is already running");
|
|
|
|
Py_InitializeEx(init_signal_handlers ? 1 : 0);
|
|
|
|
// Make .py files in the working directory available by default
|
|
auto sys_path = reinterpret_borrow<list>(module::import("sys").attr("path"));
|
|
sys_path.append(".");
|
|
}
|
|
|
|
/** \rst
|
|
Shut down the Python interpreter. No pybind11 or CPython API functions can be called
|
|
after this. In addition, pybind11 objects must not outlive the interpreter:
|
|
|
|
.. code-block:: cpp
|
|
|
|
{ // BAD
|
|
py::initialize_interpreter();
|
|
auto hello = py::str("Hello, World!");
|
|
py::finalize_interpreter();
|
|
} // <-- BOOM, hello's destructor is called after interpreter shutdown
|
|
|
|
{ // GOOD
|
|
py::initialize_interpreter();
|
|
{ // scoped
|
|
auto hello = py::str("Hello, World!");
|
|
} // <-- OK, hello is cleaned up properly
|
|
py::finalize_interpreter();
|
|
}
|
|
|
|
{ // BETTER
|
|
py::scoped_interpreter guard{};
|
|
auto hello = py::str("Hello, World!");
|
|
}
|
|
|
|
.. warning::
|
|
|
|
The interpreter can be restarted by calling `initialize_interpreter` again.
|
|
Modules created using pybind11 can be safely re-initialized. However, Python
|
|
itself cannot completely unload binary extension modules and there are several
|
|
caveats with regard to interpreter restarting. All the details can be found
|
|
in the CPython documentation. In short, not all interpreter memory may be
|
|
freed, either due to reference cycles or user-created global data.
|
|
|
|
\endrst */
|
|
inline void finalize_interpreter() {
|
|
handle builtins(PyEval_GetBuiltins());
|
|
const char *id = PYBIND11_INTERNALS_ID;
|
|
|
|
// Get the internals pointer (without creating it if it doesn't exist). It's possible for the
|
|
// internals to be created during Py_Finalize() (e.g. if a py::capsule calls `get_internals()`
|
|
// during destruction), so we get the pointer-pointer here and check it after Py_Finalize().
|
|
detail::internals **internals_ptr_ptr = &detail::get_internals_ptr();
|
|
// It could also be stashed in builtins, so look there too:
|
|
if (builtins.contains(id) && isinstance<capsule>(builtins[id]))
|
|
internals_ptr_ptr = capsule(builtins[id]);
|
|
|
|
Py_Finalize();
|
|
|
|
if (internals_ptr_ptr) {
|
|
delete *internals_ptr_ptr;
|
|
*internals_ptr_ptr = nullptr;
|
|
}
|
|
}
|
|
|
|
/** \rst
|
|
Scope guard version of `initialize_interpreter` and `finalize_interpreter`.
|
|
This a move-only guard and only a single instance can exist.
|
|
|
|
.. code-block:: cpp
|
|
|
|
#include <pybind11/embed.h>
|
|
|
|
int main() {
|
|
py::scoped_interpreter guard{};
|
|
py::print(Hello, World!);
|
|
} // <-- interpreter shutdown
|
|
\endrst */
|
|
class scoped_interpreter {
|
|
public:
|
|
scoped_interpreter(bool init_signal_handlers = true) {
|
|
initialize_interpreter(init_signal_handlers);
|
|
}
|
|
|
|
scoped_interpreter(const scoped_interpreter &) = delete;
|
|
scoped_interpreter(scoped_interpreter &&other) noexcept { other.is_valid = false; }
|
|
scoped_interpreter &operator=(const scoped_interpreter &) = delete;
|
|
scoped_interpreter &operator=(scoped_interpreter &&) = delete;
|
|
|
|
~scoped_interpreter() {
|
|
if (is_valid)
|
|
finalize_interpreter();
|
|
}
|
|
|
|
private:
|
|
bool is_valid = true;
|
|
};
|
|
|
|
NAMESPACE_END(pybind11)
|