Objetos tupla¶
-
PyTypeObject PyTuple_Type¶
- Part of the Stable ABI.
Esta instancia de
PyTypeObject
representa el tipo tupla de Python; es el mismo objeto quetuple
en la capa de Python.
-
int PyTuple_Check(PyObject *p)¶
Retorna verdadero si p es un objeto tupla o una instancia de un subtipo del tipo tupla. Esta función siempre finaliza con éxito.
-
int PyTuple_CheckExact(PyObject *p)¶
Retorna verdadero si p es un objeto tupla pero no una instancia de un subtipo del tipo tupla. Esta función siempre finaliza con éxito.
-
PyObject *PyTuple_New(Py_ssize_t len)¶
- Return value: New reference. Part of the Stable ABI.
Return a new tuple object of size len, or
NULL
with an exception set on failure.
-
PyObject *PyTuple_Pack(Py_ssize_t n, ...)¶
- Return value: New reference. Part of the Stable ABI.
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 toPy_BuildValue("(OO)", a, b)
.
-
Py_ssize_t PyTuple_Size(PyObject *p)¶
- Part of the Stable 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_t PyTuple_GET_SIZE(PyObject *p)¶
Like
PyTuple_Size()
, but without error checking.
-
PyObject *PyTuple_GetItem(PyObject *p, Py_ssize_t pos)¶
- Return value: Borrowed reference. Part of the Stable ABI.
Retorna el objeto en la posición pos en la tupla señalada por p. Si pos es negativo o está fuera de los límites, retorna
NULL
y establece una excepciónIndexError
.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 strong reference, use
Py_NewRef(PyTuple_GetItem(...))
orPySequence_GetItem()
.
-
PyObject *PyTuple_GET_ITEM(PyObject *p, Py_ssize_t pos)¶
- Return value: Borrowed reference.
Como
PyTuple_GetItem()
, pero no verifica sus argumentos.
-
PyObject *PyTuple_GetSlice(PyObject *p, Py_ssize_t low, Py_ssize_t high)¶
- Return value: New reference. Part of the Stable ABI.
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.
-
int PyTuple_SetItem(PyObject *p, Py_ssize_t pos, PyObject *o)¶
- Part of the Stable ABI.
Inserta una referencia al objeto o en la posición pos de la tupla señalada por p. Retorna
0
en caso de éxito. Si pos está fuera de límites, retorna-1
y establece una excepciónIndexError
.Nota
Esta función «roba» una referencia a o y descarta una referencia a un elemento que ya está en la tupla en la posición afectada.
-
void PyTuple_SET_ITEM(PyObject *p, Py_ssize_t pos, PyObject *o)¶
Al igual que
PyTuple_SetItem()
, pero no realiza ninguna comprobación de errores, y debe solo usarse para completar tuplas nuevas.Bounds checking is performed as an assertion if Python is built in debug mode or
with assertions
.Nota
Esta función «roba» una referencia a o y, a diferencia de
PyTuple_SetItem()
, no descarta una referencia a ningún elemento que se está reemplazando; cualquier referencia en la tupla en la posición pos se filtrará.
-
int _PyTuple_Resize(PyObject **p, Py_ssize_t newsize)¶
Se puede usar para cambiar el tamaño de una tupla. newsize será el nuevo tamaño de la tupla. Debido a que se supone que las tuplas son inmutables, esto solo debe usarse si solo hay una referencia al objeto. No use esto si la tupla ya puede ser conocida por alguna otra parte del código. La tupla siempre crecerá o disminuirá al final. Piense en esto como destruir la antigua tupla y crear una nueva, solo que de manera más eficiente. Retorna
0
en caso de éxito. El código del cliente nunca debe suponer que el valor resultante de*p
será el mismo que antes de llamar a esta función. Si se reemplaza el objeto referenciado por*p
, se destruye el original*p
. En caso de fallo, retorna-1
y establece*p
enNULL
, y lanzaMemoryError
oSystemError
.
Objetos de secuencia de estructura¶
Los objetos de secuencia de estructura son el equivalente en C de los objetos namedtuple()
, es decir, una secuencia a cuyos elementos también se puede acceder a través de atributos. Para crear una secuencia de estructura, primero debe crear un tipo de secuencia de estructura específico.
-
PyTypeObject *PyStructSequence_NewType(PyStructSequence_Desc *desc)¶
- Return value: New reference. Part of the Stable ABI.
Crea un nuevo tipo de secuencia de estructura a partir de los datos en desc, que se describen a continuación. Las instancias del tipo resultante se pueden crear con
PyStructSequence_New()
.Return
NULL
with an exception set on failure.
-
void PyStructSequence_InitType(PyTypeObject *type, PyStructSequence_Desc *desc)¶
Inicializa una secuencia de estructura tipo type desde desc en su lugar.
-
int PyStructSequence_InitType2(PyTypeObject *type, PyStructSequence_Desc *desc)¶
Like
PyStructSequence_InitType()
, but returns0
on success and-1
with an exception set on failure.Added in version 3.4.
-
type PyStructSequence_Desc¶
- Part of the Stable ABI (including all members).
Contiene la meta información de un tipo de secuencia de estructura para crear.
-
const char *name¶
Fully qualified name of the type; null-terminated UTF-8 encoded. The name must contain the module name.
-
const char *doc¶
Pointer to docstring for the type or
NULL
to omit.
-
PyStructSequence_Field *fields¶
Pointer to
NULL
-terminated array with field names of the new type.
-
int n_in_sequence¶
Number of fields visible to the Python side (if used as tuple).
-
const char *name¶
-
type PyStructSequence_Field¶
- Part of the Stable ABI (including all members).
Describes a field of a struct sequence. As a struct sequence is modeled as a tuple, all fields are typed as PyObject*. The index in the
fields
array of thePyStructSequence_Desc
determines which field of the struct sequence is described.-
const char *name¶
Name for the field or
NULL
to end the list of named fields, set toPyStructSequence_UnnamedField
to leave unnamed.
-
const char *doc¶
Field docstring or
NULL
to omit.
-
const char *name¶
-
const char *const PyStructSequence_UnnamedField¶
- Part of the Stable ABI since version 3.11.
Valor especial para un nombre de campo para dejarlo sin nombre.
Distinto en la versión 3.9: El tipo se cambió de
char *
.
-
PyObject *PyStructSequence_New(PyTypeObject *type)¶
- Return value: New reference. Part of the Stable ABI.
Crea una instancia de type, que debe haberse creado con
PyStructSequence_NewType()
.Return
NULL
with an exception set on failure.
-
PyObject *PyStructSequence_GetItem(PyObject *p, Py_ssize_t pos)¶
- Return value: Borrowed reference. Part of the Stable ABI.
Return the object at position pos in the struct sequence pointed to by p.
Bounds checking is performed as an assertion if Python is built in debug mode or
with assertions
.
-
PyObject *PyStructSequence_GET_ITEM(PyObject *p, Py_ssize_t pos)¶
- Return value: Borrowed reference.
Alias to
PyStructSequence_GetItem()
.Distinto en la versión 3.13: Now implemented as an alias to
PyStructSequence_GetItem()
.
-
void PyStructSequence_SetItem(PyObject *p, Py_ssize_t pos, PyObject *o)¶
- Part of the Stable ABI.
Establece el campo en el índice pos de la secuencia de estructura p en el valor o. Como
PyTuple_SET_ITEM()
, esto solo debe usarse para completar instancias nuevas.Bounds checking is performed as an assertion if Python is built in debug mode or
with assertions
.Nota
Esta función «roba» una referencia a o.
-
void PyStructSequence_SET_ITEM(PyObject *p, Py_ssize_t *pos, PyObject *o)¶
Alias to
PyStructSequence_SetItem()
.Distinto en la versión 3.13: Now implemented as an alias to
PyStructSequence_SetItem()
.