PyTupleObject
This subtype of
represents a Python tuple object.
PyTuple_Type
This instance of
represents the Python tuple type; it is the same object as
in the Python layer.
int PyTuple_Check(
*p)
Return true if p is a tuple object or an instance of a subtype of the tuple type. This function always succeeds.
int PyTuple_CheckExact(
*p)
Return true if p is a tuple object, but not an instance of a subtype of the tuple type. This function always succeeds.
* PyTuple_New(
len)
Return value: New reference.Return a new tuple object of size len, or NULL on failure.
* PyTuple_Pack(
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).
PyTuple_Size(
*p)
Take a pointer to a tuple object, and return the size of that tuple.
PyTuple_GET_SIZE(
*p)
Return the size of the tuple p, which must be non-NULL and point to a tuple; no error checking is performed.
* PyTuple_GetItem(
*p,
pos)
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 set an
exception.
* PyTuple_GET_ITEM(
*p,
pos)
Return value: Borrowed reference.Like
, but does no checking of its arguments.
* PyTuple_GetSlice(
*p,
low,
high)
Return value: New reference.Return the slice of the tuple pointed to by p between low and high, or NULL on failure. This is the equivalent of the Python expression p[low:high]. Indexing from the end of the list is not supported.
int PyTuple_SetItem(
*p,
pos,
*o)
Insert a reference to object o at position pos of the tuple pointed to by p. Return 0 on success. If pos is out of bounds, return -1 and set an
exception.
Note
This function “steals” a reference to o and discards a reference to an item already in the tuple at the affected position.
void PyTuple_SET_ITEM(
*p,
pos,
*o)
Like
, but does no error checking, and should only be used to fill in brand new tuples.
Note
This macro “steals” a reference to o, and, unlike
, does not discard a reference to any item that is being replaced; any reference in the tuple at position pos will be leaked.
int _PyTuple_Resize(
**p,
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
or
.
Struct Sequence Objects
Struct sequence objects are the C equivalent of
objects, i.e. a sequence whose items can also be accessed through attributes. To create a struct sequence, you first have to create a specific struct sequence type.
* PyStructSequence_NewType(
*desc)
Return value: New reference.Create a new struct sequence type from the data in desc, described below. Instances of the resulting type can be created with
.
void PyStructSequence_InitType(
*type,
*desc)
Initializes a struct sequence type type from desc in place.
int PyStructSequence_InitType2(
*type,
*desc)
The same as PyStructSequence_InitType, but returns 0 on success and -1 on failure.
New in version 3.4.
PyStructSequence_Desc
Contains the meta information of a struct sequence type to create.
Field
C Type
Meaning
name
constchar*
name of the struct sequence type
doc
constchar*
pointer to docstring for the type or NULL to omit
fields
PyStructSequence_Field*
pointer to NULL-terminated array with field names of the new type
n_in_sequence
int
number of fields visible to the Python side (if used as tuple)
PyStructSequence_Field
Describes a field of a struct sequence. As a struct sequence is modeled as a tuple, all fields are typed as
. The index in the fields array of the
determines which field of the struct sequence is described.
Field
C Type
Meaning
name
constchar*
name for the field or NULL to end the list of named fields, set to
to leave unnamed
doc
constchar*
field docstring or NULL to omit
const char * const PyStructSequence_UnnamedField
Special value for a field name to leave it unnamed.
Changed in version 3.9: The type was changed from char*.
* PyStructSequence_New(
*type)
Return value: New reference.Creates an instance of type, which must have been created with
.
* PyStructSequence_GetItem(
*p,
pos)
Return value: Borrowed reference.Return the object at position pos in the struct sequence pointed to by p. No bounds checking is performed.
* PyStructSequence_GET_ITEM(
*p,
pos)
Return value: Borrowed reference.Macro equivalent of
.
void PyStructSequence_SetItem(
*p,
pos,
*o)
Sets the field at index pos of the struct sequence p to value o. Like
, this should only be used to fill in brand new instances.
Note
This function “steals” a reference to o.
void PyStructSequence_SET_ITEM(
*p,
*pos,
*o)
Macro equivalent of
.
Note
This function “steals” a reference to o.