exception< type > Class Template Reference

#include <pybind11.h>

Inheritance diagram for exception< type >:

Public Member Functions
	exception ()=default
	exception (handle scope, const char *name, handle base=PyExc_Exception)
void	operator() (const char *message)
Public Member Functions inherited from object
	object ()=default
	PYBIND11_DEPRECATED ("Use reinterpret_borrow<object>() or reinterpret_steal<object>()") object(handle h
	object (const object &o)
	Copy constructor; always increases the reference count. More...
	object (object &&other) noexcept
	Move constructor; steals the object from other and preserves its reference count. More...
	~object ()
	Destructor; automatically calls handle::dec_ref() More...
handle	release ()
object &	operator= (const object &other)
object &	operator= (object &&other) noexcept
template<typename T >
T	cast () const &
template<typename T >
T	cast () &&
	object (handle h, borrowed_t)
	object (handle h, stolen_t)
template<typename T >
T	cast () const &
template<typename T >
T	cast () &&
template<>
void	cast () const &
template<>
void	cast () &&
Public Member Functions inherited from handle
	handle ()=default
	The default constructor creates a handle with a nullptr-valued pointer. More...
	handle (PyObject *ptr)
	Creates a handle from the given raw Python object pointer. More...
PyObject *	ptr () const
	Return the underlying PyObject * pointer. More...
PyObject *&	ptr ()
const handle &	inc_ref () const &
const handle &	dec_ref () const &
template<typename T >
T	cast () const
	operator bool () const
	Return true when the handle wraps a valid Python object. More...
bool	operator== (const handle &h) const
bool	operator!= (const handle &h) const
bool	check () const
template<>
void	cast () const

Additional Inherited Members
Public Attributes inherited from object
bool	is_borrowed: handle(h) { if (is_borrowed) inc_ref()
Protected Attributes inherited from handle
PyObject *	m_ptr = nullptr

Detailed Description

template<typename type>
class exception< type >

Wrapper to generate a new Python exception type.

This should only be used with PyErr_SetString for now. It is not (yet) possible to use as a py::base. Template type argument is reserved for future use.

Definition at line 2004 of file pybind11.h.

Constructor & Destructor Documentation

exception() [1/2]

template<typename type >

exception< type >::exception ( )

default

exception() [2/2]

template<typename type >

exception< type >::exception ( handle  scope, const char *  name, handle  base = PyExc_Exception  )

inline

Definition at line 2007 of file pybind11.h.

Member Function Documentation

operator()()

template<typename type >

void exception< type >::operator() ( const char *  message )

inline

Definition at line 2018 of file pybind11.h.

---

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

• /Users/matin/Downloads/testProjs/CppyABM/examples/Cppy/build/_deps/pybind11-src/include/pybind11/pybind11.h