Estructuras de objetos comunes

Hay un gran número de estructuras que se utilizan en la definición de los tipos de objetos de Python. Esta sección describe estas estructuras y la forma en que se utilizan.

Tipos objeto base y macros

En última instancia, todos los objetos de Python comparten un pequeño número de campos en el comienzo de la representación del objeto en la memoria. Estos están representados por la PyObject y PyVarObject,que se definen, a su vez, por las expansiones de algunos macros también se utilizan, ya sea directa o indirectamente, en la definición de todos otros objetos de Python.

type PyObject
Part of the Stable ABI.

Todos los tipos de objetos son extensiones de este tipo. Este es un tipo que contiene la información que Python necesita para tratar un puntero a un objeto como un objeto. En una construcción «release» normal, que contiene solo contador de referencia del objeto y un puntero al objeto de tipo correspondiente. En realidad nada es declarado como un PyObject, pero cada puntero a un objeto de Python se puede convertir en una PyObject*. El acceso a los miembros debe hacerse mediante el uso de las macros Py_REFCNT y Py_TYPE.

type PyVarObject
Part of the Stable ABI.

Esta es una extensión de PyObject que se suma el campo ob_size. Esto sólo se utiliza para objetos que tienen cierta noción de longitud (length). Este tipo no suele aparecer en la API Python/C. El acceso a los miembros debe hacerse mediante el uso de las macros Py_REFCNT, Py_TYPE, y Py_SIZE.

PyObject_HEAD

Esta es una macro utilizado cuando se declara nuevos tipos que representan objetos sin una longitud variable. La macro PyObject_HEAD se expande a:

PyObject ob_base;

Consulte la documentación de PyObject en secciones anteriores.

PyObject_VAR_HEAD

Esta es una macro utilizado cuando se declara nuevos tipos que representan objetos con una longitud que varía de una instancia a otra instancia. La macro PyObject_VAR_HEAD se expande a:

PyVarObject ob_base;

Consulte la documentación de PyVarObject anteriormente.

int Py_Is(const PyObject *x, const PyObject *y)
Part of the Stable ABI since version 3.10.

Test if the x object is the y object, the same as x is y in Python.

Nuevo en la versión 3.10.

int Py_IsNone(const PyObject *x)
Part of the Stable ABI since version 3.10.

Test if an object is the None singleton, the same as x is None in Python.

Nuevo en la versión 3.10.

int Py_IsTrue(const PyObject *x)
Part of the Stable ABI since version 3.10.

Test if an object is the True singleton, the same as x is True in Python.

Nuevo en la versión 3.10.

int Py_IsFalse(const PyObject *x)
Part of the Stable ABI since version 3.10.

Test if an object is the False singleton, the same as x is False in Python.

Nuevo en la versión 3.10.

PyTypeObject *Py_TYPE(const PyObject *o)

Get the type of the Python object o.

Return a borrowed reference.

The Py_SET_TYPE() function must be used to set an object type.

int Py_IS_TYPE(PyObject *o, PyTypeObject *type)

Retorna un valor distinto de cero si el objeto o tipo es type. Retorna cero en caso contrario. Equivalente a: Py_TYPE(o) == type.

Nuevo en la versión 3.9.

void Py_SET_TYPE(PyObject *o, PyTypeObject *type)

Establece el tipo del objeto o a type.

Nuevo en la versión 3.9.

Py_ssize_t Py_REFCNT(const PyObject *o)

Get the reference count of the Python object o.

Distinto en la versión 3.10: Py_REFCNT() is changed to the inline static function. Use Py_SET_REFCNT() to set an object reference count.

void Py_SET_REFCNT(PyObject *o, Py_ssize_t refcnt)

Establece el conteo de referencia del objeto o a refcnt.

Nuevo en la versión 3.9.

Py_ssize_t Py_SIZE(const PyVarObject *o)

Get the size of the Python object o.

The Py_SET_SIZE() function must be used to set an object size.

void Py_SET_SIZE(PyVarObject *o, Py_ssize_t size)

Establece el tamaño del objeto o a size.

Nuevo en la versión 3.9.

PyObject_HEAD_INIT(type)

Esta es una macro que se expande para valores de inicialización para un nuevo tipo PyObject. Esta macro expande:

_PyObject_EXTRA_INIT
1, type,
PyVarObject_HEAD_INIT(type, size)

Esta es una macro que se expande para valores de inicialización para un nuevo tipo PyVarObject, incluyendo el campo ob_size. Esta macro se expande a:

_PyObject_EXTRA_INIT
1, type, size,

Implementando funciones y métodos

type PyCFunction
Part of the Stable ABI.

Tipo de las funciones usadas para implementar la mayoría de invocables Python en C. Funciones de este tipo toman dos parámetros PyObject* y retorna un valor de ese tipo. Si el valor de retorno es NULL, una excepción fue establecida. Si no es NULL, el valor retornado se interpreta como el valor de retorno de la función que se expone en Python. La función debe retornar una nueva referencia.

La firma de la función es:

PyObject *PyCFunction(PyObject *self,
                      PyObject *args);
type PyCFunctionWithKeywords
Part of the Stable ABI.

Tipo de las funciones que se utilizan para implementar invocables Python en C con la firma METH_VARARGS | METH_KEYWORDS. La firma de la función es:

PyObject *PyCFunctionWithKeywords(PyObject *self,
                                  PyObject *args,
                                  PyObject *kwargs);
type _PyCFunctionFast

Tipo de las funciones que se utilizan para implementar invocables Python en C con la firma METH_FASTCALL. La firma de la función es:

PyObject *_PyCFunctionFast(PyObject *self,
                           PyObject *const *args,
                           Py_ssize_t nargs);
type _PyCFunctionFastWithKeywords

Tipo de las funciones que se utilizan para implementar invocables Python en C con la firma METH_FASTCALL | METH_KEYWORDS. La firma de la función es:

PyObject *_PyCFunctionFastWithKeywords(PyObject *self,
                                       PyObject *const *args,
                                       Py_ssize_t nargs,
                                       PyObject *kwnames);
type PyCMethod

Tipo de las funciones que se utilizan para implementar invocables Python en C con la firma METH_METHOD | METH_FASTCALL | METH_KEYWORDS. La firma de la función es:

PyObject *PyCMethod(PyObject *self,
                    PyTypeObject *defining_class,
                    PyObject *const *args,
                    Py_ssize_t nargs,
                    PyObject *kwnames)

Nuevo en la versión 3.9.

type PyMethodDef
Part of the Stable ABI.

Estructura utiliza para describir un método de un tipo de extensión. Esta estructura tiene cuatro campos:

Campo

Tipo C

Significado

ml_name

const char *

nombre del método

ml_meth

PyCFunction

puntero a la implementación en C

ml_flags

int

flag bits que indican cómo debe ser construida la llamada

ml_doc

const char *

puntos a los contenidos del docstring

El ml_meth es un puntero de función C. Las funciones pueden ser de diferentes tipos, pero siempre retornan PyObject*. Si la función no es la de PyCFunction, el compilador requiere una conversión de tipo en la tabla de métodos. A pesar de que PyCFunction define el primer parámetro como PyObject*, es común que la implementación del método utiliza el tipo específico C del objecto self.

El campo ml_flags es un campo de bits que puede incluir las siguientes flags. Las flags individuales indican o bien una convención de llamada o una convención vinculante.

Existen estas convenciones de llamada:

METH_VARARGS

Esta es la convención de llamada típica, donde los métodos tienen el tipo PyCFunction. La función espera dos valores PyObject*. El primero es objeto self para los métodos; para las funciones del módulo, que es el objeto módulo. El segundo parámetro (a menudo llamado args) es un objeto tupla que representa todos los argumentos. Este parámetro se procesa típicamente usando PyArg_ParseTuple() o PyArg_UnpackTuple().

METH_VARARGS | METH_KEYWORDS

Los métodos con estas flags deben ser del tipo PyCFunctionWithKeywords. La función espera tres parámetros: self, args, kwargs donde kwargs es un diccionario de todos los argumentos de palabras clave o, posiblemente, NULL si no hay argumentos de palabra clave. Los parámetros se procesan típicamente usando PyArg_ParseTupleAndKeywords().

METH_FASTCALL

Convención de llamando rápido que soporta sólo argumentos posicionales. Los métodos tienen el tipo _PyCFunctionFast. El primer parámetro es self, el segundo parámetro es un arreglo C de valores PyObject* que indican los argumentos y el tercer parámetro es el número de argumentos (la longitud del arreglo).

Nuevo en la versión 3.7.

Distinto en la versión 3.10: METH_FASTCALL is now part of the stable ABI.

METH_FASTCALL | METH_KEYWORDS

Extensión de METH_FASTCALL que admite también argumentos de palabra clave, con los métodos de tipo _PyCFunctionFastWithKeywords. argumentos de palabra clave se transmiten de la misma manera como en el vectorcall protocol: hay un cuarto parámetro PyObject* adicional que es una tupla que representa los nombres de los argumentos de palabra clave o posiblemente NULL si no hay palabras clave. Los valores de los argumentos de palabras clave se almacenan en el arreglo args, después de los argumentos posicionales.

Esto no es parte de la API limitada.

Nuevo en la versión 3.7.

METH_METHOD | METH_FASTCALL | METH_KEYWORDS

Extensión de METH_FASTCALL | METH_KEYWORDS que admite la clase definitoria, es decir, la clase que contiene el método en cuestión. La clase definitoria podría ser una superclase de Py_TYPE(self).

El método debe ser de tipo PyCMethod, lo mismo que para METH_FASTCALL | METH_KEYWORDS con el argumento defining_clase añadido después de self.

Nuevo en la versión 3.9.

METH_NOARGS

Métodos sin parámetros no tienen que comprobar si los argumentos se dan si están registrados con el flag METH_NOARGS. Tienen que ser de tipo PyCFunction. El primer parámetro normalmente se denomina self y llevará a cabo una referencia a la instancia módulo u objeto. En todos los casos el segundo parámetro será NULL.

METH_O

Los métodos con un solo argumento objeto pueden ser listados con el flag METH_O, en lugar de invocar PyArg_ParseTuple() con un argumento "O". Tienen el tipo PyCFunction, con el parámetro self, y un parámetro PyObject* que representa el único argumento.

Estas dos constantes no se utilizan para indicar la convención de llamada si no la vinculación cuando su usan con métodos de las clases. Estos no se pueden usar para funciones definidas para módulos. A lo sumo uno de estos flags puede establecerse en un método dado.

METH_CLASS

Al método se le pasará el objeto tipo como primer parámetro, en lugar de una instancia del tipo. Esto se utiliza para crear métodos de clase (class methods), similar a lo que se crea cuando se utiliza la función classmethod() incorporada.

METH_STATIC

El método pasará NULL como el primer parámetro en lugar de una instancia del tipo. Esto se utiliza para crear métodos estáticos (static methods), similar a lo que se crea cuando se utiliza la función staticmethod() incorporada.

En otros controles constantes dependiendo si se carga un método en su lugar (in place) de otra definición con el mismo nombre del método.

METH_COEXIST

El método se cargará en lugar de las definiciones existentes. Sin METH_COEXIST, el comportamiento predeterminado es saltarse las definiciones repetidas. Desde envolturas de ranura se cargan antes de la tabla de métodos, la existencia de una ranura sq_contains, por ejemplo, generaría un método envuelto llamado __contains__() e impediría la carga de una PyCFunction correspondiente con el mismo nombre. Con el flag definido, la PyCFunction se cargará en lugar del objeto envoltorio y coexistirá con la ranura. Esto es útil porque las llamadas a PyCFunctions se optimizan más que las llamadas a objetos envolvente.

Acceder a atributos de tipos de extensión

type PyMemberDef
Part of the Stable ABI.

Estructura que describe un atributo de un tipo que corresponde a un miembro de la estructura de C. Sus campos son:

Campo

Tipo C

Significado

name

const char *

nombre del miembro

type

int

el tipo de miembro en la estructura de C

offset

Py_ssize_t

el desplazamiento en bytes que el miembro se encuentra en la estructura de objetos tipo

flags

int

flags bits que indican si el campo debe ser de sólo lectura o de escritura

doc

const char *

puntos a los contenidos del docstring

type puede ser uno de muchos macros T_ correspondientes a diversos tipos C. Cuando se accede al miembro en Python, será convertida al tipo Python equivalente.

Nombre de la macro

Tipo C

T_SHORT

short

T_INT

int

T_LONG

long

T_FLOAT

float

T_DOUBLE

double

T_STRING

const char *

T_OBJECT

PyObject *

T_OBJECT_EX

PyObject *

T_CHAR

char

T_BYTE

char

T_UBYTE

unsigned char

T_UINT

unsigned int

T_USHORT

unsigned short

T_ULONG

unsigned long

T_BOOL

char

T_LONGLONG

long long

T_ULONGLONG

unsigned long long

T_PYSSIZET

Py_ssize_t

T_OBJECT y T_OBJECT_EX se diferencian en que T_OBJECT retorna None si el miembro es NULL y T_OBJECT_EX lanza un AttributeError. Trate de usar T_OBJECT_EX sobre T_OBJECT porque T_OBJECT_EX maneja el uso de la declaración del en ese atributo más correctamente que T_OBJECT.

flags puede ser 0 para el acceso de escritura y lectura o READONLY para el acceso de sólo lectura. El uso de T_STRING para type implica READONLY. Los datos T_STRING se interpretan como UTF-8. Sólo se pueden eliminar T_OBJECT y miembros T_OBJECT_EX. (Se establecen a NULL).

Los tipos asignados al heap (creados usando PyType_FromSpec() o similar), PyMemberDef pueden contener definiciones para los miembros especiales __dictoffset__, __weaklistoffset__ y __vectorcalloffset__, correspondientes a tp_dictoffset, tp_weaklistoffset y tp_vectorcall_offset en objetos de tipo. Estos deben definirse con T_PYSSIZET y READONLY, por ejemplo:

static PyMemberDef spam_type_members[] = {
    {"__dictoffset__", T_PYSSIZET, offsetof(Spam_object, dict), READONLY},
    {NULL}  /* Sentinel */
};
PyObject *PyMember_GetOne(const char *obj_addr, struct PyMemberDef *m)

Get an attribute belonging to the object at address obj_addr. The attribute is described by PyMemberDef m. Returns NULL on error.

int PyMember_SetOne(char *obj_addr, struct PyMemberDef *m, PyObject *o)

Set an attribute belonging to the object at address obj_addr to object o. The attribute to set is described by PyMemberDef m. Returns 0 if successful and a negative value on failure.

type PyGetSetDef
Part of the Stable ABI.

Estructura para definir el acceso para un tipo como el de una propiedad. Véase también la descripción de la ranura PyTypeObject.tp_getset.

Campo

Tipo C

Significado

nombre

const char *

Nombre del atributo

get

getter

Función C para obtener el atributo

set

setter

función opcional C para establecer o eliminar el atributo, si se omite el atributo es de sólo lectura

doc

const char *

docstring opcional

clausura (closure)

void *

puntero de función opcional, proporcionar datos adicionales para getter y setter

La función get toma un parámetro PyObject* (la instancia) y un puntero de función (el closure asociado):

typedef PyObject *(*getter)(PyObject *, void *);

Debe retornar una nueva referencia en caso de éxito o NULL con una excepción establecida en caso de error.

Las funciones set toman dos parámetros PyObject* (la instancia y el valor a ser establecido) y un puntero de función (el closure asociado):

typedef int (*setter)(PyObject *, PyObject *, void *);

En caso de que el atributo deba suprimirse el segundo parámetro es NULL. Debe retornar 0 en caso de éxito o -1 con una excepción explícita en caso de fallo.