typePyTupleObject
This subtype of
represents a Python tuple object.
PyTuple_Type
Part of the
.This instance of
represents the Python tuple type; it is the same object as
in the Python layer.
intPyTuple_Check(
*p)
Return true if p is a tuple object or an instance of a subtype of the tuple type. This function always succeeds.
intPyTuple_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. Part of the
. Thread safety:
.Return a new tuple object of size len, or NULL with an exception set on failure.
*PyTuple_FromArray(
*const*array,
size)
Thread safety:
.Create a tuple of size items and copy references from array to the new tuple.
array can be NULL if size is 0.
On success, return a new reference. On error, set an exception and return NULL.
Added in version 3.15.
*PyTuple_Pack(
n, ...)
Return value: New reference. Part of the
. Thread safety:
.Return a new tuple object of size n, or NULL with an exception set 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)
Part of the
. Thread safety:
.Take a pointer to a tuple object, and return the size of that tuple. On error, return -1 with an exception set.
PyTuple_GET_SIZE(
*p)
Thread safety:
.Like
, but without error checking.
*PyTuple_GetItem(
*p,
pos)
Return value: Borrowed reference. Part of the
. Thread safety:
Safe to call from multiple threads with external synchronization only
.Return the object at position pos in the tuple pointed to by p. If pos is negative or out of bounds, return NULL and set an
exception.
The returned reference is borrowed from the tuple p (that is: it is only valid as long as you hold a reference to p). To get a
, use
Py_NewRef(PyTuple_GetItem(...))
or
.
*PyTuple_GET_ITEM(
*p,
pos)
Return value: Borrowed reference. Thread safety:
Safe to call from multiple threads with external synchronization only
.Like
, but does no checking of its arguments.
*PyTuple_GetSlice(
*p,
low,
high)
Return value: New reference. Part of the
. Thread safety:
.Return the slice of the tuple pointed to by p between low and high, or NULL with an exception set on failure.
This is the equivalent of the Python expression p[low:high]. Indexing from the end of the tuple is not supported.
intPyTuple_SetItem(
*p,
pos,
*o)
Part of the
. Thread safety:
Safe to call from multiple threads with external synchronization only
.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. This function should only be used to fill in brand new tuples; using it on an existing tuple is thread-unsafe.
Note
This function “
” a reference to o and discards a reference to an item already in the tuple at the affected position (unless it was NULL).
voidPyTuple_SET_ITEM(
*p,
pos,
*o)
Thread safety:
Safe to call from multiple threads with external synchronization only
.Like
, but does no error checking, and should only be used to fill in brand new tuples, using it on an existing tuple is thread-unsafe.
Bounds checking is performed as an assertion if Python is built in
or
.
Note
This function “
” 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.
Warning
This macro should only be used on tuples that are newly created. Using this macro on a tuple that is already in use (or in other words, has a refcount > 1) could lead to undefined behavior.
int_PyTuple_Resize(
**p,
newsize)
Thread safety:
Safe to call from multiple threads with external synchronization only
.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
A struct sequence object is a
, that is, a sequence whose items can also be accessed through attributes. It is similar to
, but provides a slightly different interface.
To create a struct sequence, you first have to create a specific struct sequence type.
*PyStructSequence_NewType(
*desc)
Return value: New reference. Part of the
. Thread safety:
.Create a new struct sequence type from the data in desc, described below. Instances of the resulting type can be created with
.
Return NULL with an exception set on failure.
voidPyStructSequence_InitType(
*type,
*desc)
Thread safety:
Safe to call without external synchronization on distinct objects
.Initializes a struct sequence type type from desc in place.
intPyStructSequence_InitType2(
*type,
*desc)
Thread safety:
Safe to call without external synchronization on distinct objects
.Like
, but returns 0 on success and -1 with an exception set on failure.
Added in version 3.4.
typePyStructSequence_Desc
Part of the
(including all members).Contains the meta information of a struct sequence type to create.
constchar*name
Fully qualified name of the type; null-terminated UTF-8 encoded. The name must contain the module name.
constchar*doc
Pointer to docstring for the type or NULL to omit.
*fields
Pointer to NULL-terminated array with field names of the new type.
intn_in_sequence
Number of fields visible to the Python side (if used as tuple).
typePyStructSequence_Field
Part of the
(including all members).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
array of the
determines which field of the struct sequence is described.
constchar*name
Name for the field or NULL to end the list of named fields, set to
to leave unnamed.
constchar*doc
Field docstring or NULL to omit.
constchar*constPyStructSequence_UnnamedField
Part of the
since version 3.11.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. Part of the
. Thread safety:
.Creates an instance of type, which must have been created with
.
Return NULL with an exception set on failure.
*PyStructSequence_GetItem(
*p,
pos)
Return value: Borrowed reference. Part of the
. Thread safety:
Safe to call from multiple threads with external synchronization only
.Return the object at position pos in the struct sequence pointed to by p. The returned reference is borrowed from the struct sequence p (that is: it is only valid as long as you hold a reference to p).
Bounds checking is performed as an assertion if Python is built in
or
.
*PyStructSequence_GET_ITEM(
*p,
pos)
Return value: Borrowed reference. Thread safety:
Safe to call from multiple threads with external synchronization only
.Alias to
.
Changed in version 3.13: Now implemented as an alias to
.
voidPyStructSequence_SetItem(
*p,
pos,
*o)
Part of the
. Thread safety:
Safe to call from multiple threads with external synchronization only
.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.
Bounds checking is performed as an assertion if Python is built in
or
.
Note
This function “
” a reference to o.
voidPyStructSequence_SET_ITEM(
*p,
*pos,
*o)
Thread safety:
Safe to call from multiple threads with external synchronization only
.Alias to
.
Changed in version 3.13: Now implemented as an alias to
.