GNU Info

(python2.1-api.info)Tuple Objects

---

Next: List Objects Prev: Buffer Objects Up: Sequence Objects

---

Enter node , (file) or (file)node

Tuple Objects
-------------

`PyTupleObject'
     This subtype of `PyObject' represents a Python tuple object.

`PyTypeObject PyTuple_Type'
     This instance of `PyTypeObject' represents the Python tuple type;
     it is the same object as `types.TupleType' in the Python layer.  .

`int PyTuple_Check(PyObject *p)'
     Return true if the argument is a tuple object.

`PyObject* PyTuple_New(int len)'
     Return a new tuple object of size LEN, or `NULL' on failure.

`int PyTuple_Size(PyObject *p)'
     Takes a pointer to a tuple object, and returns the size of that
     tuple.

`PyObject* PyTuple_GetItem(PyObject *p, int pos)'
     Returns the object at position POS in the tuple pointed to by P.
     If POS is out of bounds, returns `NULL' and sets an `IndexError'
     exception.

`PyObject* PyTuple_GET_ITEM(PyObject *p, int pos)'
     Does the same, but does no checking of its arguments.

`PyObject* PyTuple_GetSlice(PyObject *p, int low, int high)'
     Takes a slice of the tuple pointed to by P from LOW to HIGH and
     returns it as a new tuple.

`int PyTuple_SetItem(PyObject *p, int pos, PyObject *o)'
     Inserts a reference to object O at position POS of the tuple
     pointed to by P. It returns `0' on success.  *Note:*  This
     function "steals" a reference to O.

`void PyTuple_SET_ITEM(PyObject *p, int pos, PyObject *o)'
     Does the same, but does no error checking, and should _only_ be
     used to fill in brand new tuples.  *Note:*  This function "steals"
     a reference to O.

`int _PyTuple_Resize(PyObject **p, int newsize, int last_is_sticky)'
     Can be used to resize a tuple.  NEWSIZE will be the new length of
     the tuple.  Because tuples are _supposed_ to be immutable, this
     should only be used if there is only one reference to the object.
     Do _not_ use this if the tuple may already be known to some other
     part of the code.  The tuple will always grow or shrink at the
     end.  The LAST_IS_STICKY flag is not used and should always be
     false.  Think of this as destroying the old tuple and creating a
     new one, only more efficiently.  Returns `0' on success and `-1'
     on failure (in which case a `MemoryError' or `SystemError' will be
     raised).