mds_utils::python::Tuple Class Reference

Wraps a Python tuple. More...

#include <mds_utils/python/tuple.hpp>

Inheritance diagram for mds_utils::python::Tuple:

Public Member Functions
	Tuple ()
	The default constructor.
	Tuple (size_t len)
	Builds a tuple of specified length but with uninitialized elements. More...
	Tuple (PyObject *po)
	Constructs a new Tuple from a Python sequence. More...
	Tuple (const Tuple &rhs)
	The copy constructor.
	Tuple (Tuple &&rhs)
	The move constructor.
	Tuple (ProxyAttr &&rhs)
	The move constructor from ProxyAttr objects.
Tuple &	operator= (Tuple &&rhs)
	The move assignment.
Tuple &	operator= (const Tuple &rhs)
	The standard assignment.
Public Member Functions inherited from mds_utils::python::Sequence_Base< Tuple >
	Sequence_Base ()
	Default constructor. More...
	Sequence_Base (size_t len)
	Creates a sequence of the desired length. More...
	Sequence_Base (PyObject *po)
	Constructs a new Sequence_Base from a Python sequence. More...
	Sequence_Base (Sequence_Base &&rhs)
	Move constructor.
	Sequence_Base (const Sequence_Base &rhs)
	The copy-constructor.
	Sequence_Base (ProxyAttr &&rhs)
	Move constructor from ProxyAttr object. More...
Sequence_Base< Tuple > &	operator= (Sequence_Base< Tuple > &&rhs)
	Move assignment.
Sequence_Base< Tuple > &	operator= (const Sequence_Base< Tuple > &rhs)
	The standard assignment.
void	set (const seq_T &seq)
	Sets a Python sequence from a Boost Fusion sequence. More...
void	set (FwIt b, FwIt e)
	Sets a Python sequence from a range of values. More...
void	set (const Obj &o)
	Sets a Python sequence from another Python sequence. More...
void	del (long i)
	Deletes the item in position i.
size_t	len () const
	Returns the length of the sequence.
ProxyElem	operator[] (long i)
	Element access. More...
Public Member Functions inherited from mds_utils::python::Obj
	Obj ()
	Default constructor.
	Obj (const Obj &rhs)
	The copy-constructor. More...
	Obj (Obj &&rhs)
	Move constructor. More...
	Obj (ProxyAttr &&rhs)
	Move constructor from ProxyAttr objects. More...
	Obj (PyObject *po)
	Construct from a Python object. More...
Obj &	operator= (const Obj &rhs)
	Standard assignment.
Obj &	operator= (Obj &&rhs)
	Move assignment.
virtual Obj &	operator= (PyObject *po)
	Assignment from a Python object. More...
template<class T >
Obj &	operator= (const T &val)
	Assignment from a value. More...
virtual	~Obj ()
	Destructor.
PyObject *	getPyObject () const
	Returns the underlying PyObject. More...
	operator PyObject * () const
	Automatic type conversion towards a Python object. More...
virtual PyObject *	transfer ()
	Returns the Python object with transferred ownership. More...
virtual void	incref ()
	Increments the reference count using Py_XINCREF. More...
virtual void	decref ()
	Decrements the reference count using Py_XDECREF.
void	reset ()
	Resets the object to the state given by the default constructor.
void	get_ownership ()
	Used in place of incref, when the wrapped PyObject* was increfed already.
bool	has_attr (const std::string &name) const
	Tests if the object has a particular attribute.
ProxyAttr	attr (const std::string &name)
	Retrieves an attribute. More...
bool	is_callable () const
	Checks if the object is callable. More...
Obj	operator() ()
	Calling operator. More...
Obj	operator() (const Obj &args)
	Calling operator, with positional arguments. More...
Obj	operator() (const Obj &args, const Obj &kw)
	Calling operator, with positional and keyword arguments. More...

Friends
class	Sequence_Base< Tuple >

Additional Inherited Members
Protected Member Functions inherited from mds_utils::python::Sequence_Base< Tuple >
size_t	idx (long i) const
	Converts a Python index (that can also be negative) into a C index. More...
Protected Member Functions inherited from mds_utils::python::Obj
void	check_callable ()
	Checks if the object is callable. More...
void	check_call_result (PyObject *result)
	Checks if the result of the object call was successful. More...
Protected Attributes inherited from mds_utils::python::Sequence_Base< Tuple >
size_t	m_len
	The length of the sequence.
Protected Attributes inherited from mds_utils::python::Obj
size_t	decref_on_destroy
PyObject *	m_po
	Underlying pointer to the wrapped Python object.

Detailed Description

Wraps a Python tuple.

Warning

• Be sure to have included proper overloads of the mds_utils::python::to_python function.
• Remember that the copy/move constructors and the assignment operators do not duplicate the underlying Python object. They only increment its reference count.

Author

Michele De Stefano

Date

05/08/2014

Definition at line 49 of file tuple.hpp.

Constructor & Destructor Documentation

mds_utils::python::Tuple::Tuple ( size_t  len )

inline

Builds a tuple of specified length but with uninitialized elements.

This constructor is useful for building empty tuples.

Parameters

len	The length of the Tuple. Passsing 0 will build an empty tuple.

Author

Michele De Stefano

Date

27/05/2014

Definition at line 84 of file tuple.hpp.

mds_utils::python::Tuple::Tuple ( PyObject *  po )

inline

Constructs a new Tuple from a Python sequence.

It throws an exception if the parameter is not a sequence.

Parameters

po	Pointer to a Pyton sequence object.

Remarks

This constructor does not incref the Python object.

Author

Michele De Stefano

Date

10/04/2014

Definition at line 99 of file tuple.hpp.

---

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

• include/mds_utils/python/tuple.hpp