Tuple Objects¶

typePyTupleObject¶

This subtype ofPyObject represents a Python tuple object.

PyTypeObjectPyTuple_Type¶

Μέρος τουΣταθερό ABI.

This instance ofPyTypeObject represents the Python tuple type; itis the same object astuple in the Python layer.

intPyTuple_Check(PyObject*p)¶

Return true ifp is a tuple object or an instance of a subtype of thetuple type. This function always succeeds.

intPyTuple_CheckExact(PyObject*p)¶

Return true ifp is a tuple object, but not an instance of a subtype of thetuple type. This function always succeeds.

PyObject*PyTuple_New(Py_ssize_tlen)¶

Επιστρεφόμενη τιμή: New reference. Μέρος τουΣταθερό ABI.

Return a new tuple object of sizelen,orNULL with an exception set on failure.

PyObject*PyTuple_Pack(Py_ssize_tn,...)¶

Επιστρεφόμενη τιμή: New reference. Μέρος τουΣταθερό ABI.

Return a new tuple object of sizen,orNULL with an exception set on failure. The tuple valuesare initialized to the subsequentn C arguments pointing to Python objects.PyTuple_Pack(2,a,b) is equivalent toPy_BuildValue("(OO)",a,b).

Py_ssize_tPyTuple_Size(PyObject*p)¶

Μέρος τουΣταθερό ABI.

Take a pointer to a tuple object, and return the size of that tuple.On error, return-1 and with an exception set.

Py_ssize_tPyTuple_GET_SIZE(PyObject*p)¶

LikePyTuple_Size(), but without error checking.

PyObject*PyTuple_GetItem(PyObject*p,Py_ssize_tpos)¶

Επιστρεφόμενη τιμή: Borrowed reference. Μέρος τουΣταθερό ABI.

Return the object at positionpos in the tuple pointed to byp. Ifpos isnegative or out of bounds, returnNULL and set anIndexError exception.

The returned reference is borrowed from the tuplep(that is: it is only valid as long as you hold a reference top).To get astrong reference, usePy_NewRef(PyTuple_GetItem(...))orPySequence_GetItem().

PyObject*PyTuple_GET_ITEM(PyObject*p,Py_ssize_tpos)¶

Επιστρεφόμενη τιμή: Borrowed reference.

LikePyTuple_GetItem(), but does no checking of its arguments.

PyObject*PyTuple_GetSlice(PyObject*p,Py_ssize_tlow,Py_ssize_thigh)¶

Επιστρεφόμενη τιμή: New reference. Μέρος τουΣταθερό ABI.

Return the slice of the tuple pointed to byp betweenlow andhigh,orNULL with an exception set on failure.

This is the equivalent of the Python expressionp[low:high].Indexing from the end of the tuple is not supported.

intPyTuple_SetItem(PyObject*p,Py_ssize_tpos,PyObject*o)¶

Μέρος τουΣταθερό ABI.

Insert a reference to objecto at positionpos of the tuple pointed to byp. Return0 on success. Ifpos is out of bounds, return-1and set anIndexError exception.

Σημείωση

This function «steals» a reference too and discards a reference toan item already in the tuple at the affected position.

voidPyTuple_SET_ITEM(PyObject*p,Py_ssize_tpos,PyObject*o)¶

LikePyTuple_SetItem(), but does no error checking, and shouldonly beused to fill in brand new tuples.

Bounds checking is performed as an assertion if Python is built indebug mode orwithassertions.

Σημείωση

This function «steals» a reference too, and, unlikePyTuple_SetItem(), doesnot discard a reference to any item thatis being replaced; any reference in the tuple at positionpos will beleaked.

Προειδοποίηση

This macro shouldonly be used on tuples that are newly created.Using this macro on a tuple that is already in use (or in other words, hasa refcount > 1) could lead to undefined behavior.

int_PyTuple_Resize(PyObject**p,Py_ssize_tnewsize)¶

Can be used to resize a tuple.newsize will be the new length of the tuple.Because tuples aresupposed to be immutable, this should only be used if thereis only one reference to the object. Donot use this if the tuple may alreadybe known to some other part of the code. The tuple will always grow or shrinkat the end. Think of this as destroying the old tuple and creating a new one,only more efficiently. Returns0 on success. Client code should neverassume that the resulting value of*p will be the same as before callingthis function. If the object referenced by*p is replaced, the original*p is destroyed. On failure, returns-1 and sets*p toNULL, andraisesMemoryError orSystemError.

Struct Sequence Objects¶

Struct sequence objects are the C equivalent ofnamedtuple()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 sequencetype.

PyTypeObject*PyStructSequence_NewType(PyStructSequence_Desc*desc)¶

Επιστρεφόμενη τιμή: New reference. Μέρος τουΣταθερό ABI.

Create a new struct sequence type from the data indesc, described below. Instancesof the resulting type can be created withPyStructSequence_New().

ReturnNULL with an exception set on failure.

voidPyStructSequence_InitType(PyTypeObject*type,PyStructSequence_Desc*desc)¶

Initializes a struct sequence typetype fromdesc in place.

intPyStructSequence_InitType2(PyTypeObject*type,PyStructSequence_Desc*desc)¶

LikePyStructSequence_InitType(), but returns0 on successand-1 with an exception set on failure.

Added in version 3.4.

typePyStructSequence_Desc¶

Μέρος τουΣταθερό ABI (συμπεριλαμβανομένων όλων των μελών).

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 orNULL to omit.

PyStructSequence_Field*fields¶

Pointer toNULL-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¶

Μέρος τουΣταθερό ABI (συμπεριλαμβανομένων όλων των μελών).

Describes a field of a struct sequence. As a struct sequence is modeled as atuple, all fields are typed asPyObject*. The index in thefields array ofthePyStructSequence_Desc determines whichfield of the struct sequence is described.

constchar*name¶

Name for the field orNULL to end the list of named fields,set toPyStructSequence_UnnamedField to leave unnamed.

constchar*doc¶

Field docstring orNULL to omit.

constchar*constPyStructSequence_UnnamedField¶

Μέρος τουΣταθερό ABI από την έκδοση 3.11.

Special value for a field name to leave it unnamed.

Άλλαξε στην έκδοση 3.9:The type was changed fromchar*.

PyObject*PyStructSequence_New(PyTypeObject*type)¶

Επιστρεφόμενη τιμή: New reference. Μέρος τουΣταθερό ABI.

Creates an instance oftype, which must have been created withPyStructSequence_NewType().

ReturnNULL with an exception set on failure.

PyObject*PyStructSequence_GetItem(PyObject*p,Py_ssize_tpos)¶

Επιστρεφόμενη τιμή: Borrowed reference. Μέρος τουΣταθερό ABI.

Return the object at positionpos in the struct sequence pointed to byp.

Bounds checking is performed as an assertion if Python is built indebug mode orwithassertions.

PyObject*PyStructSequence_GET_ITEM(PyObject*p,Py_ssize_tpos)¶

Επιστρεφόμενη τιμή: Borrowed reference.

Alias toPyStructSequence_GetItem().

Άλλαξε στην έκδοση 3.13:Now implemented as an alias toPyStructSequence_GetItem().

voidPyStructSequence_SetItem(PyObject*p,Py_ssize_tpos,PyObject*o)¶

Μέρος τουΣταθερό ABI.

Sets the field at indexpos of the struct sequencep to valueo. LikePyTuple_SET_ITEM(), this should only be used to fill in brand newinstances.

Bounds checking is performed as an assertion if Python is built indebug mode orwithassertions.

Σημείωση

This function «steals» a reference too.

voidPyStructSequence_SET_ITEM(PyObject*p,Py_ssize_t*pos,PyObject*o)¶

Alias toPyStructSequence_SetItem().

Άλλαξε στην έκδοση 3.13:Now implemented as an alias toPyStructSequence_SetItem().