scoped_interpreter Class Reference

\rst Scope guard version of initialize_interpreter and finalize_interpreter. More...

#include </builds/ipbus/ipbus-software/uhal/python/pybind11-python2/include/pybind11/embed.h>

Public Member Functions
	scoped_interpreter (bool init_signal_handlers=true, int argc=0, const char *const *argv=nullptr, bool add_program_dir_to_path=true)
	scoped_interpreter (const scoped_interpreter &)=delete
	scoped_interpreter (scoped_interpreter &&other) noexcept
scoped_interpreter &	operator= (const scoped_interpreter &)=delete
scoped_interpreter &	operator= (scoped_interpreter &&)=delete
	~scoped_interpreter ()
	scoped_interpreter (bool init_signal_handlers=true, int argc=0, const char *const *argv=nullptr, bool add_program_dir_to_path=true)
	scoped_interpreter (PyConfig *config, int argc=0, const char *const *argv=nullptr, bool add_program_dir_to_path=true)
	scoped_interpreter (const scoped_interpreter &)=delete
	scoped_interpreter (scoped_interpreter &&other) noexcept
scoped_interpreter &	operator= (const scoped_interpreter &)=delete
scoped_interpreter &	operator= (scoped_interpreter &&)=delete
	~scoped_interpreter ()

Private Attributes
bool	is_valid = true

Detailed Description

\rst Scope guard version of initialize_interpreter and finalize_interpreter.

This a move-only guard and only a single instance can exist.

See initialize_interpreter for a discussion of its constructor arguments.

.. code-block:: cpp

#include <pybind11/embed.h>

int main() {
    py::scoped_interpreter guard{};
    py::print(Hello, World!);
} // <-- interpreter shutdown

\endrst

Definition at line 278 of file embed.h.

Constructor & Destructor Documentation

scoped_interpreter() [1/7]

scoped_interpreter::scoped_interpreter ( bool  init_signal_handlers = true, int  argc = 0, const char *const *  argv = nullptr, bool  add_program_dir_to_path = true  )

inlineexplicit

Definition at line 280 of file embed.h.

References initialize_interpreter().

scoped_interpreter() [2/7]

scoped_interpreter::scoped_interpreter ( const scoped_interpreter &  )

delete

scoped_interpreter() [3/7]

scoped_interpreter::scoped_interpreter ( scoped_interpreter &&  other )

inlinenoexcept

Definition at line 288 of file embed.h.

~scoped_interpreter() [1/2]

scoped_interpreter::~scoped_interpreter ( )

inline

Definition at line 292 of file embed.h.

References finalize_interpreter(), and is_valid.

scoped_interpreter() [4/7]

scoped_interpreter::scoped_interpreter ( bool  init_signal_handlers = true, int  argc = 0, const char *const *  argv = nullptr, bool  add_program_dir_to_path = true  )

inlineexplicit

Definition at line 286 of file embed.h.

References initialize_interpreter().

scoped_interpreter() [5/7]

scoped_interpreter::scoped_interpreter ( PyConfig *  config, int  argc = 0, const char *const *  argv = nullptr, bool  add_program_dir_to_path = true  )

inlineexplicit

Definition at line 294 of file embed.h.

References initialize_interpreter().

scoped_interpreter() [6/7]

scoped_interpreter::scoped_interpreter ( const scoped_interpreter &  )

delete

scoped_interpreter() [7/7]

scoped_interpreter::scoped_interpreter ( scoped_interpreter &&  other )

inlinenoexcept

Definition at line 303 of file embed.h.

~scoped_interpreter() [2/2]

scoped_interpreter::~scoped_interpreter ( )

inline

Definition at line 307 of file embed.h.

References finalize_interpreter(), and is_valid.

Member Function Documentation

operator=() [1/4]

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

delete

operator=() [2/4]

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

delete

operator=() [3/4]

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

delete

operator=() [4/4]

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

delete

Member Data Documentation

is_valid

bool scoped_interpreter::is_valid = true

private

Definition at line 299 of file embed.h.

Referenced by ~scoped_interpreter().

---

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

• python/pybind11-python2/include/pybind11/embed.h
• python/pybind11/include/pybind11/embed.h