exception< type > Class Template Reference

#include <pybind11.h>

Inheritance diagram for exception< type >:

Public Member Functions
	exception ()=default
	exception (handle scope, const char *name, PyObject *base=PyExc_Exception)
void	operator() (const char *message)
Public Member Functions inherited from object
	object ()=default
	__attribute__ ((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...
	__attribute__ ((deprecated("Use obj1.is(obj2) instead"))) bool operator
template<>
void	cast () const
Public Member Functions inherited from object_api< handle >
iterator	begin () const
iterator	end () const
	Return a sentinel which ends iteration. More...
item_accessor	operator[] (handle key) const
item_accessor	operator[] (const char *key) const
	See above (the only difference is that they key is provided as a string literal) More...
obj_attr_accessor	attr (handle key) const
str_attr_accessor	attr (const char *key) const
	See above (the only difference is that they key is provided as a string literal) More...
args_proxy	operator* () const
object	operator* (object_api const &other) const
bool	contains (T &&item) const
	Check if the given item is contained within this object, i.e. item in obj. More...
object	operator() (Args &&...args) const
	__attribute__ ((deprecated("call(...) was deprecated in favor of operator()(...)"))) object call(Args &&... args) const
	Get or set the object's docstring, i.e. obj.__doc__. More...
bool	is (object_api const &other) const
	Equivalent to obj is other in Python. More...
bool	is_none () const
	Equivalent to obj is None in Python. More...
bool	equal (object_api const &other) const
	Equivalent to obj == other in Python. More...
bool	not_equal (object_api const &other) const
bool	operator< (object_api const &other) const
bool	operator<= (object_api const &other) const
bool	operator> (object_api const &other) const
bool	operator>= (object_api const &other) const
object	operator- () const
object	operator- (object_api const &other) const
object	operator~ () const
object	operator+ (object_api const &other) const
object	operator+= (object_api const &other) const
object	operator-= (object_api const &other) const
object	operator*= (object_api const &other) const
object	operator/ (object_api const &other) const
object	operator/= (object_api const &other) const
object	operator| (object_api const &other) const
object	operator|= (object_api const &other) const
object	operator& (object_api const &other) const
object	operator&= (object_api const &other) const
object	operator^ (object_api const &other) const
object	operator^= (object_api const &other) const
object	operator<< (object_api const &other) const
object	operator<<= (object_api const &other) const
object	operator>> (object_api const &other) const
object	operator>>= (object_api const &other) const
int	ref_count () const
	Return the object's current reference count. More...
handle	get_type () const
	Return a handle to the Python type object underlying the instance. More...

Additional Inherited Members
Public Attributes inherited from object
bool	is_borrowed: handle(h) { if (is_borrowed) inc_ref()

Detailed Description

template<typename type>
class pybind11::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 1764 of file pybind11.h.

Constructor & Destructor Documentation

exception() [1/2]

exception ( )

default

exception() [2/2]

exception ( handle  scope, const char *  name, PyObject *  base = PyExc_Exception  )

inline

Definition at line 1767 of file pybind11.h.

Member Function Documentation

operator()()

void operator() ( const char *  message )

inline

Definition at line 1778 of file pybind11.h.

---

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

• pybind11.h