1. camlspotter
  2. opycaml


opycaml / tuple.idl.in

// ----------- tuple

// 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 tuple and types.TupleType in the Python layer..

boolean PyTuple_Check(PyObject *p);
// Return true if p is a tuple object or an instance of a subtype of the tuple type.

boolean PyTuple_CheckExact(PyObject *p);
// Return true if p is a tuple object, but not an instance of a subtype of the tuple type.

[new] PyTupleObject* PyTuple_New(Py_ssize_t len);
// Return value: New reference.
// Return a new tuple object of size len, or NULL on failure.

// PyObject* PyTuple_Pack(Py_ssize_t n, ...)
// Return value: New reference.
// Return a new tuple object of size n, or NULL on failure. The tuple values are initialized to the subsequent n C arguments pointing to Python objects. PyTuple_Pack(2, a, b) is equivalent to Py_BuildValue("(OO)", a, b).

size_or_fail PyTuple_Size(PyTupleObject *p);
// Take a pointer to a tuple object, and return the size of that tuple.

size_or_fail PyTuple_GET_SIZE(PyTupleObject *p);
// Return the size of the tuple p, which must be non-NULL and point to a tuple; no error checking is performed.

PyObject* PyTuple_GetItem(PyTupleObject *p, Py_ssize_t pos); [mlname getItemPos]
// Return value: Borrowed reference.
// Return the object at position pos in the tuple pointed to by p. If pos is out of bounds, return NULL and sets an IndexError exception.

PyObject* PyTuple_GET_ITEM(PyTupleObject *p, Py_ssize_t pos);
// Return value: Borrowed reference.
// Like PyTuple_GetItem(), but does no checking of its arguments.

[new] PySliceObject* PyTuple_GetSlice(PyTupleObject *p, Py_ssize_t low, Py_ssize_t high);
// Return value: New reference.
// Take a slice of the tuple pointed to by p from low to high and return it as a new tuple.

unit_or_fail PyTuple_SetItem(PyTupleObject *p, Py_ssize_t pos, [stolen] PyObject *o); [mlname setItemPos]
// Insert a reference to object o at position pos of the tuple pointed to by p. Return 0 on success.
// Note This function “steals” a reference to o.

void PyTuple_SET_ITEM(PyTupleObject *p, Py_ssize_t pos, [stolen] PyObject *o);
// Like PyTuple_SetItem(), 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, Py_ssize_t newsize);
// 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. Think of this as destroying the old tuple and creating a new one, only more efficiently. Returns 0 on success. Client code should never assume that the resulting value of *p will be the same as before calling this function. If the object referenced by *p is replaced, the original *p is destroyed. On failure, returns -1 and sets *p to NULL, and raises MemoryError or SystemError.

int PyTuple_ClearFreeList();
// Clear the free list. Return the total number of freed items.