FM / c-api

/usr/share/doc/python3-docs/html/_sources/c-api/

/usr/share/doc/python3-docs/html/_sources/c-api

Name	Size	Mode	Actions
abstract.rst.txt	715	0644	edit dl rm
allocation.rst.txt	2653	0644	edit dl rm
apiabiversion.rst.txt	2242	0644	edit dl rm
arg.rst.txt	30651	0644	edit dl rm
bool.rst.txt	1200	0644	edit dl rm
buffer.rst.txt	22267	0644	edit dl rm
bytearray.rst.txt	2250	0644	edit dl rm
bytes.rst.txt	9211	0644	edit dl rm
capsule.rst.txt	5741	0644	edit dl rm
cell.rst.txt	1940	0644	edit dl rm
code.rst.txt	1666	0644	edit dl rm
codec.rst.txt	4799	0644	edit dl rm
complex.rst.txt	3946	0644	edit dl rm
concrete.rst.txt	2046	0644	edit dl rm
conversion.rst.txt	5516	0644	edit dl rm
coro.rst.txt	820	0644	edit dl rm
datetime.rst.txt	6415	0644	edit dl rm
descriptor.rst.txt	1111	0644	edit dl rm
dict.rst.txt	7952	0644	edit dl rm
exceptions.rst.txt	47814	0644	edit dl rm
file.rst.txt	3248	0644	edit dl rm
float.rst.txt	2243	0644	edit dl rm
function.rst.txt	3348	0644	edit dl rm
gcsupport.rst.txt	6057	0644	edit dl rm
gen.rst.txt	1301	0644	edit dl rm
import.rst.txt	12825	0644	edit dl rm
index.rst.txt	613	0644	edit dl rm
init.rst.txt	52383	0644	edit dl rm
intro.rst.txt	28751	0644	edit dl rm
iter.rst.txt	1129	0644	edit dl rm
iterator.rst.txt	1640	0644	edit dl rm
list.rst.txt	4735	0644	edit dl rm
long.rst.txt	10436	0644	edit dl rm
mapping.rst.txt	2871	0644	edit dl rm
marshal.rst.txt	3561	0644	edit dl rm
memory.rst.txt	21369	0644	edit dl rm
memoryview.rst.txt	2348	0644	edit dl rm
method.rst.txt	2818	0644	edit dl rm
module.rst.txt	18266	0644	edit dl rm
none.rst.txt	740	0644	edit dl rm
number.rst.txt	10583	0644	edit dl rm
objbuffer.rst.txt	2198	0644	edit dl rm
object.rst.txt	17420	0644	edit dl rm
objimpl.rst.txt	304	0644	edit dl rm
refcounting.rst.txt	2909	0644	edit dl rm
reflection.rst.txt	1417	0644	edit dl rm
sequence.rst.txt	6547	0644	edit dl rm
set.rst.txt	6144	0644	edit dl rm
slice.rst.txt	2404	0644	edit dl rm
stable.rst.txt	1969	0644	edit dl rm
structures.rst.txt	13787	0644	edit dl rm
sys.rst.txt	9944	0644	edit dl rm
tuple.rst.txt	8031	0644	edit dl rm
type.rst.txt	3963	0644	edit dl rm
typeobj.rst.txt	60184	0644	edit dl rm
unicode.rst.txt	68074	0644	edit dl rm
utilities.rst.txt	414	0644	edit dl rm
veryhigh.rst.txt	16655	0644	edit dl rm
weakref.rst.txt	2635	0644	edit dl rm

Edit: /usr/share/doc/python3-docs/html/_sources/c-api/tuple.rst.txt (8031B)

.. highlightlang:: c

.. _tupleobjects:

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

.. index:: object: tuple

.. c:type:: PyTupleObject

This subtype of :c:type:`PyObject` represents a Python tuple object.

.. c:var:: PyTypeObject PyTuple_Type

This instance of :c:type:`PyTypeObject` represents the Python tuple type; it
   is the same object as :class:`tuple` in the Python layer.

.. c:function:: int PyTuple_Check(PyObject *p)

Return true if *p* is a tuple object or an instance of a subtype of the tuple
   type.

.. c:function:: int PyTuple_CheckExact(PyObject *p)

Return true if *p* is a tuple object, but not an instance of a subtype of the
   tuple type.

.. c:function:: PyObject* PyTuple_New(Py_ssize_t len)

Return a new tuple object of size *len*, or *NULL* on failure.

.. c:function:: PyObject* PyTuple_Pack(Py_ssize_t n, ...)

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)``.

.. c:function:: Py_ssize_t PyTuple_Size(PyObject *p)

Take a pointer to a tuple object, and return the size of that tuple.

.. c:function:: Py_ssize_t PyTuple_GET_SIZE(PyObject *p)

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

.. c:function:: PyObject* PyTuple_GetItem(PyObject *p, Py_ssize_t pos)

Return the object at position *pos* in the tuple pointed to by *p*.  If *pos* is
   out of bounds, return *NULL* and sets an :exc:`IndexError` exception.

.. c:function:: PyObject* PyTuple_GET_ITEM(PyObject *p, Py_ssize_t pos)

Like :c:func:`PyTuple_GetItem`, but does no checking of its arguments.

.. c:function:: PyObject* PyTuple_GetSlice(PyObject *p, Py_ssize_t low, Py_ssize_t high)

Take a slice of the tuple pointed to by *p* from *low* to *high* and return it
   as a new tuple.

.. c:function:: int PyTuple_SetItem(PyObject *p, Py_ssize_t pos, PyObject *o)

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*.

.. c:function:: void PyTuple_SET_ITEM(PyObject *p, Py_ssize_t pos, PyObject *o)

Like :c:func:`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*.

.. c:function:: 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 :exc:`MemoryError` or :exc:`SystemError`.

.. c:function:: int PyTuple_ClearFreeList()

Clear the free list. Return the total number of freed items.

Struct Sequence Objects
-----------------------

Struct sequence objects are the C equivalent of :func:`~collections.namedtuple`
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.

.. c:function:: PyTypeObject* PyStructSequence_NewType(PyStructSequence_Desc *desc)

Create a new struct sequence type from the data in *desc*, described below. Instances
   of the resulting type can be created with :c:func:`PyStructSequence_New`.

.. c:function:: void PyStructSequence_InitType(PyTypeObject *type, PyStructSequence_Desc *desc)

Initializes a struct sequence type *type* from *desc* in place.

.. c:function:: int PyStructSequence_InitType2(PyTypeObject *type, PyStructSequence_Desc *desc)

The same as ``PyStructSequence_InitType``, but returns ``0`` on success and ``-1`` on
   failure.

.. versionadded:: 3.4

.. c:type:: PyStructSequence_Desc

Contains the meta information of a struct sequence type to create.

.. c:type:: PyStructSequence_Field

Describes a field of a struct sequence. As a struct sequence is modeled as a
   tuple, all fields are typed as :c:type:`PyObject\*`.  The index in the
   :attr:`fields` array of the :c:type:`PyStructSequence_Desc` determines which
   field of the struct sequence is described.

.. c:var:: char* PyStructSequence_UnnamedField

Special value for a field name to leave it unnamed.

.. c:function:: PyObject* PyStructSequence_New(PyTypeObject *type)

Creates an instance of *type*, which must have been created with
   :c:func:`PyStructSequence_NewType`.

.. c:function:: PyObject* PyStructSequence_GetItem(PyObject *p, Py_ssize_t pos)

Return the object at position *pos* in the struct sequence pointed to by *p*.
   No bounds checking is performed.

.. c:function:: PyObject* PyStructSequence_GET_ITEM(PyObject *p, Py_ssize_t pos)

Macro equivalent of :c:func:`PyStructSequence_GetItem`.

.. c:function:: void PyStructSequence_SetItem(PyObject *p, Py_ssize_t pos, PyObject *o)

Sets the field at index *pos* of the struct sequence *p* to value *o*.  Like
   :c:func:`PyTuple_SET_ITEM`, this should only be used to fill in brand new
   instances.

.. note::

This function "steals" a reference to *o*.

.. c:function:: PyObject* PyStructSequence_SET_ITEM(PyObject *p, Py_ssize_t *pos, PyObject *o)

Macro equivalent of :c:func:`PyStructSequence_SetItem`.

.. note::

This function "steals" a reference to *o*.

.. highlightlang:: c .. _tupleobjects: Tuple Objects ------------- .. index:: object: tuple .. c:type:: PyTupleObject This subtype of :c:type:`PyObject` represents a Python tuple object. .. c:var:: PyTypeObject PyTuple_Type This instance of :c:type:`PyTypeObject` represents the Python tuple type; it is the same object as :class:`tuple` in the Python layer. .. c:function:: int PyTuple_Check(PyObject *p) Return true if *p* is a tuple object or an instance of a subtype of the tuple type. .. c:function:: int PyTuple_CheckExact(PyObject *p) Return true if *p* is a tuple object, but not an instance of a subtype of the tuple type. .. c:function:: PyObject* PyTuple_New(Py_ssize_t len) Return a new tuple object of size *len*, or *NULL* on failure. .. c:function:: PyObject* PyTuple_Pack(Py_ssize_t n, ...) 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)``. .. c:function:: Py_ssize_t PyTuple_Size(PyObject *p) Take a pointer to a tuple object, and return the size of that tuple. .. c:function:: Py_ssize_t PyTuple_GET_SIZE(PyObject *p) Return the size of the tuple *p*, which must be non-*NULL* and point to a tuple; no error checking is performed. .. c:function:: PyObject* PyTuple_GetItem(PyObject *p, Py_ssize_t pos) Return the object at position *pos* in the tuple pointed to by *p*. If *pos* is out of bounds, return *NULL* and sets an :exc:`IndexError` exception. .. c:function:: PyObject* PyTuple_GET_ITEM(PyObject *p, Py_ssize_t pos) Like :c:func:`PyTuple_GetItem`, but does no checking of its arguments. .. c:function:: PyObject* PyTuple_GetSlice(PyObject *p, Py_ssize_t low, Py_ssize_t high) Take a slice of the tuple pointed to by *p* from *low* to *high* and return it as a new tuple. .. c:function:: int PyTuple_SetItem(PyObject *p, Py_ssize_t pos, PyObject *o) 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*. .. c:function:: void PyTuple_SET_ITEM(PyObject *p, Py_ssize_t pos, PyObject *o) Like :c:func:`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*. .. c:function:: 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 :exc:`MemoryError` or :exc:`SystemError`. .. c:function:: int PyTuple_ClearFreeList() Clear the free list. Return the total number of freed items. Struct Sequence Objects ----------------------- Struct sequence objects are the C equivalent of :func:`~collections.namedtuple` 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. .. c:function:: PyTypeObject* PyStructSequence_NewType(PyStructSequence_Desc *desc) Create a new struct sequence type from the data in *desc*, described below. Instances of the resulting type can be created with :c:func:`PyStructSequence_New`. .. c:function:: void PyStructSequence_InitType(PyTypeObject *type, PyStructSequence_Desc *desc) Initializes a struct sequence type *type* from *desc* in place. .. c:function:: int PyStructSequence_InitType2(PyTypeObject *type, PyStructSequence_Desc *desc) The same as ``PyStructSequence_InitType``, but returns ``0`` on success and ``-1`` on failure. .. versionadded:: 3.4 .. c:type:: PyStructSequence_Desc Contains the meta information of a struct sequence type to create. +-------------------+------------------------------+------------------------------------+ | Field | C Type | Meaning | +===================+==============================+====================================+ | ``name`` | ``char *`` | name of the struct sequence type | +-------------------+------------------------------+------------------------------------+ | ``doc`` | ``char *`` | 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) | +-------------------+------------------------------+------------------------------------+ .. c:type:: PyStructSequence_Field Describes a field of a struct sequence. As a struct sequence is modeled as a tuple, all fields are typed as :c:type:`PyObject\*`. The index in the :attr:`fields` array of the :c:type:`PyStructSequence_Desc` determines which field of the struct sequence is described. +-----------+---------------+--------------------------------------+ | Field | C Type | Meaning | +===========+===============+======================================+ | ``name`` | ``char *`` | name for the field or *NULL* to end | | | | the list of named fields, set to | | | | PyStructSequence_UnnamedField to | | | | leave unnamed | +-----------+---------------+--------------------------------------+ | ``doc`` | ``char *`` | field docstring or *NULL* to omit | +-----------+---------------+--------------------------------------+ .. c:var:: char* PyStructSequence_UnnamedField Special value for a field name to leave it unnamed. .. c:function:: PyObject* PyStructSequence_New(PyTypeObject *type) Creates an instance of *type*, which must have been created with :c:func:`PyStructSequence_NewType`. .. c:function:: PyObject* PyStructSequence_GetItem(PyObject *p, Py_ssize_t pos) Return the object at position *pos* in the struct sequence pointed to by *p*. No bounds checking is performed. .. c:function:: PyObject* PyStructSequence_GET_ITEM(PyObject *p, Py_ssize_t pos) Macro equivalent of :c:func:`PyStructSequence_GetItem`. .. c:function:: void PyStructSequence_SetItem(PyObject *p, Py_ssize_t pos, PyObject *o) Sets the field at index *pos* of the struct sequence *p* to value *o*. Like :c:func:`PyTuple_SET_ITEM`, this should only be used to fill in brand new instances. .. note:: This function "steals" a reference to *o*. .. c:function:: PyObject* PyStructSequence_SET_ITEM(PyObject *p, Py_ssize_t *pos, PyObject *o) Macro equivalent of :c:func:`PyStructSequence_SetItem`. .. note:: This function "steals" a reference to *o*.