cppyabm  1.0.17
An agent-based library to integrate C++ and Python
Public Member Functions | List of all members
scoped_interpreter Class Reference

#include <embed.h>

Public Member Functions

 scoped_interpreter (bool init_signal_handlers=true)
 
 scoped_interpreter (const scoped_interpreter &)=delete
 
 scoped_interpreter (scoped_interpreter &&other) noexcept
 
scoped_interpreteroperator= (const scoped_interpreter &)=delete
 
scoped_interpreteroperator= (scoped_interpreter &&)=delete
 
 ~scoped_interpreter ()
 

Detailed Description

\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

Definition at line 181 of file embed.h.

Constructor & Destructor Documentation

◆ scoped_interpreter() [1/3]

scoped_interpreter::scoped_interpreter ( bool  init_signal_handlers = true)
inline

Definition at line 183 of file embed.h.

◆ scoped_interpreter() [2/3]

scoped_interpreter::scoped_interpreter ( const scoped_interpreter )
delete

◆ scoped_interpreter() [3/3]

scoped_interpreter::scoped_interpreter ( scoped_interpreter &&  other)
inlinenoexcept

Definition at line 188 of file embed.h.

◆ ~scoped_interpreter()

scoped_interpreter::~scoped_interpreter ( )
inline

Definition at line 192 of file embed.h.

Member Function Documentation

◆ operator=() [1/2]

scoped_interpreter& scoped_interpreter::operator= ( const scoped_interpreter )
delete

◆ operator=() [2/2]

scoped_interpreter& scoped_interpreter::operator= ( scoped_interpreter &&  )
delete

The documentation for this class was generated from the following file: