Nota

¡Ayúdanos a traducir la documentación oficial de Python al Español! Puedes encontrar más información en Como contribuir. Ayuda a acercar Python a más personas de habla hispana.

3. Modelo de datos

3.1. Objetos, valores y tipos

Objects son la abstracción de Python para los datos. Todos los datos en un programa Python están representados por objetos o por relaciones entre objetos. (En cierto sentido y de conformidad con el modelo de Von Neumann de una «programa almacenado de computadora», el código también está representado por objetos.)

Cada objeto tiene una identidad, un tipo y un valor. La identidad de un objeto nunca cambia una vez que ha sido creado; puede pensar en ello como la dirección del objeto en la memoria. El operador “is” compara la identidad de dos objetos; la función id() retorna un número entero que representa su identidad.

CPython implementation detail: Para CPython, id(x) es la dirección de memoria donde se almacena x.

El tipo de un objeto determina las operaciones que admite el objeto (por ejemplo, «¿tiene una longitud?») y también define los posibles valores para los objetos de ese tipo. La función type() retorna el tipo de un objeto (que es un objeto en sí mismo). Al igual que su identidad, también el type de un objeto es inmutable. 1

El valor de algunos objetos puede cambiar. Se dice que los objetos cuyo valor puede cambiar son mutables; Los objetos cuyo valor no se puede modificar una vez que se crean se denominan inmutables. (El valor de un objeto contenedor inmutable que contiene una referencia a un objeto mutable puede cambiar cuando se cambia el valor de este último; sin embargo, el contenedor todavía se considera inmutable, porque la colección de objetos que contiene no se puede cambiar. Por lo tanto, la inmutabilidad no es estrictamente lo mismo que tener un valor inmutable, es más sutil). La mutabilidad de un objeto está determinada por su tipo; por ejemplo, los números, las cadenas de caracteres y las tuplas son inmutables, mientras que los diccionarios y las listas son mutables.

Los objetos nunca se destruyen explícitamente; sin embargo, cuando se vuelven inalcanzables, se pueden recolectar basura. Se permite a una implementación posponer la recolección de basura u omitirla por completo; es una cuestión de calidad de la implementación cómo se implementa la recolección de basura, siempre que no se recolecten objetos que todavía sean accesibles.

CPython implementation detail: CPython actualmente utiliza un esquema de conteo de referencias con detección retardada (opcional) de basura enlazada cíclicamente, que recolecta la mayoría de los objetos tan pronto como se vuelven inalcanzables, pero no se garantiza que recolecte basura que contenga referencias circulares. Vea la documentación del módulo gc para información sobre el control de la recolección de basura cíclica. Otras implementaciones actúan de manera diferente y CPython puede cambiar. No dependa de la finalización inmediata de los objetos cuando se vuelvan inalcanzables (por lo que siempre debe cerrar los archivos explícitamente).

Tenga en cuenta que el uso de las funciones de rastreo o depuración de la implementación puede mantener activos los objetos que normalmente serían coleccionables. También tenga en cuenta que la captura de una excepción con una sentencia “try…except” puede mantener objetos activos.

Algunos objetos contienen referencias a recursos «externos» como archivos abiertos o ventanas. Se entiende que estos recursos se liberan cuando el objeto es eliminado por el recolector de basura, pero como no se garantiza que la recolección de basura suceda, dichos objetos también proporcionan una forma explícita de liberar el recurso externo, generalmente un método close(). Se recomienda encarecidamente a los programas cerrar explícitamente dichos objetos. La declaración “try…finally” y la declaración “with” proporcionan formas convenientes de hacer esto.

Algunos objetos contienen referencias a otros objetos; estos se llaman contenedores. Ejemplos de contenedores son tuplas, listas y diccionarios. Las referencias son parte del valor de un contenedor. En la mayoría de los casos, cuando hablamos del valor de un contenedor, implicamos los valores, no las identidades de los objetos contenidos; sin embargo, cuando hablamos de la mutabilidad de un contenedor, solo se implican las identidades de los objetos contenidos inmediatamente. Entonces, si un contenedor inmutable (como una tupla) contiene una referencia a un objeto mutable, su valor cambia si se cambia ese objeto mutable.

Los tipos afectan a casi todos los aspectos del comportamiento del objeto. Incluso la importancia de la identidad del objeto se ve afectada en cierto sentido: para los tipos inmutables, las operaciones que calculan nuevos valores en realidad pueden retornar una referencia a cualquier objeto existente con el mismo tipo y valor, mientras que para los objetos mutables esto no está permitido. Por ejemplo, al hacer a = 1; b = 1, a y b puede o no referirse al mismo objeto con el valor 1, dependiendo de la implementación, pero al hacer c = []; d = [], c y d se garantiza que se refieren a dos listas vacías diferentes, únicas y recién creadas. (Tenga en cuenta que c = d = [] asigna el mismo objeto a ambos c y d.)

3.2. Jerarquía de tipos estándar

A continuación se muestra una lista de los tipos integrados en Python. Los módulos de extensión (escritos en C, Java u otros lenguajes, dependiendo de la implementación) pueden definir tipos adicionales. Las versiones futuras de Python pueden agregar tipos a la jerarquía de tipos (por ejemplo, números racionales, matrices de enteros almacenados de manera eficiente, etc.), aunque tales adiciones a menudo se proporcionarán a través de la biblioteca estándar.

Algunas de las descripciones de tipos a continuación contienen un párrafo que enumera “atributos especiales”. Estos son atributos que proporcionan acceso a la implementación y no están destinados para uso general. Su definición puede cambiar en el futuro.

None

Este tipo tiene un solo valor. Hay un solo objeto con este valor. Se accede a este objeto a través del nombre incorporado None. Se utiliza para indicar la ausencia de un valor en muchas situaciones, por ejemplo, se retorna desde funciones que no retornan nada explícitamente. Su valor de verdad es falso.

NotImplemented

Este tipo tiene un solo valor. Hay un solo objeto con este valor. Se accede a este objeto a través del nombre integrado NotImplemented. Los métodos numéricos y los métodos de comparación enriquecidos deben devolver este valor si no implementan la operación para los operandos proporcionados. (El intérprete intentará entonces la operación reflejada, o alguna otra alternativa, dependiendo del operador). No debe evaluarse en un contexto booleano.

Vea Implementar operaciones aritméticas para más detalles.

Distinto en la versión 3.9: La evaluación de NotImplemented en un contexto booleano está en desuso. Si bien actualmente se evalúa como verdadero, lanzará un DeprecationWarning. Lanzará un TypeError en una versión futura de Python.

Elipsis

Este tipo tiene un solo valor. Hay un solo objeto con este valor. Se accede a este objeto a través del literal ... o el nombre incorporado Ellipsis. Su valor de verdad es verdadero.

numbers.Number

Estos son creados por literales numéricos y retornados como resultados por operadores aritméticos y funciones aritméticas integradas. Los objetos numéricos son inmutables; una vez creado su valor nunca cambia. Los números de Python están, por supuesto, fuertemente relacionados con los números matemáticos, pero están sujetos a las limitaciones de la representación numérica en las computadoras.

Las representaciones de cadena de las clases numéricas, calculadas por __repr__() y __str__(), tienen las siguientes propiedades:

• Son literales numéricos válidos que, cuando se pasan a su constructor de clase, producen un objeto que tiene el valor del numérico original.

• La representación está en base 10, cuando sea posible.

• Los ceros iniciales, posiblemente excepto un solo cero antes de un punto decimal, no se muestran.

• Los ceros finales, posiblemente excepto un solo cero después de un punto decimal, no se muestran.

• Solo se muestra un signo cuando el número es negativo.

Python distingue entre números enteros, números de coma flotante y números complejos:

numbers.Integral

Estos representan elementos del conjunto matemático de números enteros (positivo y negativo).

Hay dos tipos de números enteros:

Enteros (int)

Estos representan números en un rango ilimitado, sujetos solo a la memoria (virtual) disponible. Para las operaciones de desplazamiento y máscara, se asume una representación binaria, y los números negativos se representan en una variante del complemento de 2 que da la ilusión de una cadena de caracteres infinita de bits con signo que se extiende hacia la izquierda.

Booleanos (bool)

Estos representan los valores de verdad Falso y Verdadero. Los dos objetos que representan los valores False y True son los únicos objetos booleanos. El tipo booleano es un subtipo del tipo entero y los valores booleanos se comportan como los valores 0 y 1 respectivamente, en casi todos los contextos, con la excepción de que cuando se convierten en una cadena de caracteres, las cadenas de caracteres "False" o "True" son retornadas respectivamente.

Las reglas para la representación de enteros están destinadas a dar la interpretación más significativa de las operaciones de cambio y máscara que involucran enteros negativos.

numbers.Real (float)

Estos representan números de punto flotante de precisión doble a nivel de máquina. Está a merced de la arquitectura de la máquina subyacente (y la implementación de C o Java) para el rango aceptado y el manejo del desbordamiento. Python no admite números de coma flotante de precisión simple; el ahorro en el uso del procesador y la memoria, que generalmente son la razón para usarlos, se ven reducidos por la sobrecarga del uso de objetos en Python, por lo que no hay razón para complicar el lenguaje con dos tipos de números de coma flotante.

numbers.Complex (complex)

Estos representan números complejos como un par de números de coma flotante de precisión doble a nivel de máquina. Se aplican las mismas advertencias que para los números de coma flotante. Las partes reales e imaginarias de un número complejo z se pueden obtener a través de los atributos de solo lectura z.real y z.imag.

Secuencias

Estos representan conjuntos ordenados finitos indexados por números no negativos. La función incorporada len() retorna el número de elementos de una secuencia. Cuando la longitud de una secuencia es n, el conjunto de índices contiene los números 0, 1, …, n-1. El elemento i de la secuencia a se selecciona mediante a[i].

Las secuencias también admiten segmentación: a[i:j] selecciona todos los elementos con índice k de modo que i <= k < j. Cuando se usa como una expresión, un segmento es una secuencia del mismo tipo. Esto implica que el conjunto de índices se vuelve a enumerar para que comience en 0.

Algunas secuencias también admiten «segmentación extendida» con un tercer parámetro «paso» : a[i:j:k] selecciona todos los elementos de a con índice x donde x = i + n*k, n >= 0 y i <= x < j.

Las secuencias se distinguen según su mutabilidad:

Secuencias inmutables

Un objeto de un tipo de secuencia inmutable no puede cambiar una vez que se crea. (Si el objeto contiene referencias a otros objetos, estos otros objetos pueden ser mutables y pueden cambiarse; sin embargo, la colección de objetos a los que hace referencia directamente un objeto inmutable no puede cambiar).

Los siguientes tipos son secuencias inmutables:

Cadenas de caracteres

Una cadena de caracteres es una secuencia de valores que representan puntos de código Unicode. Todos los puntos de código en el rango U+0000 - U+10FFFF se puede representar en una cadena de caracteres. Python no tiene un tipo char; en cambio, cada punto de código en la cadena de caracteres se representa como un objeto de cadena de caracteres con longitud 1. La función incorporada ord() convierte un punto de código de su forma de cadena de caracteres a un entero en el rango 0 - 10FFFF; la función chr() convierte un entero en el rango 0 - 10FFFF a la cadena de caracteres correspondiente de longitud 1. str.encode() se puede usar para convertir un objeto de tipo str a bytes usando la codificación de texto dada, y bytes.decode() se puede usar para lograr el caso inverso.

Tuplas

Los elementos de una tupla son objetos arbitrarios de Python. Las tuplas de dos o más elementos están formadas por listas de expresiones separadas por comas. Se puede formar una tupla de un elemento (un “singleton”) al colocar una coma en una expresión (una expresión en sí misma no crea una tupla, ya que los paréntesis deben ser utilizables para agrupar expresiones). Una tupla vacía puede estar formada por un par de paréntesis vacío.

Bytes

Un objeto de bytes es una colección inmutable. Los elementos son bytes de 8 bits, representados por enteros en el rango 0 <= x <256. Literales de bytes (como b'abc') y el constructor incorporado bytes() se puede utilizar para crear objetos de bytes. Además, los objetos de bytes se pueden decodificar en cadenas de caracteres a través del método decode().

Secuencias mutables

Las secuencias mutables se pueden cambiar después de su creación. Las anotaciones de suscripción y segmentación se pueden utilizar como el objetivo de asignaciones y declaraciones del (eliminar).

Actualmente hay dos tipos intrínsecos de secuencias mutable:

Listas

Los elementos de una lista son objetos de Python arbitrarios. Las listas se forman colocando una lista de expresiones separadas por comas entre corchetes. (Tome en cuenta que no hay casos especiales necesarios para formar listas de longitud 0 o 1.)

Colecciones de bytes

Un objeto bytearray es una colección mutable. Son creados por el constructor incorporado bytearray(). Además de ser mutables (y, por lo tanto, inquebrantable), las colecciones de bytes proporcionan la misma interfaz y funcionalidad que los objetos inmutables bytes.

El módulo de extensión array proporciona un ejemplo adicional de un tipo de secuencia mutable, al igual que el módulo collections.

Tipos de conjuntos

Estos representan conjuntos finitos no ordenados de objetos únicos e inmutables. Como tal, no pueden ser indexados por ningún subscript. Sin embargo, pueden repetirse y la función incorporada len() retorna el número de elementos en un conjunto. Los usos comunes de los conjuntos son pruebas rápidas de membresía, eliminación de duplicados de una secuencia y cálculo de operaciones matemáticas como intersección, unión, diferencia y diferencia simétrica.

Para elementos del conjunto, se aplican las mismas reglas de inmutabilidad que para las claves de diccionario. Tenga en cuenta que los tipos numéricos obedecen las reglas normales para la comparación numérica: si dos números se comparan igual (por ejemplo, 1 y 1.0), solo uno de ellos puede estar contenido en un conjunto.

Actualmente hay dos tipos de conjuntos intrínsecos:

Conjuntos

Estos representan un conjunto mutable. Son creados por el constructor incorporado set() y puede ser modificado posteriormente por varios métodos, como add().

Conjuntos congelados

Estos representan un conjunto inmutable. Son creados por el constructor incorporado frozenset(). Como un conjunto congelado es inmutable y hashable, se puede usar nuevamente como un elemento de otro conjunto o como una clave de un diccionario.

Mapeos

Estos representan conjuntos finitos de objetos indexados por conjuntos de índices arbitrarios. La notación de subíndice a[k] selecciona el elemento indexado por k del mapeo a; esto se puede usar en expresiones y como el objetivo de asignaciones o declaraciones del. La función incorporada len() retorna el número de elementos en un mapeo.

Actualmente hay un único tipo de mapeo intrínseco:

Diccionarios

Estos representan conjuntos finitos de objetos indexados por valores casi arbitrarios. Los únicos tipos de valores no aceptables como claves son valores que contienen listas o diccionarios u otros tipos mutables que se comparan por valor en lugar de por identidad de objeto, la razón es que la implementación eficiente de los diccionarios requiere que el valor hash de una clave permanezca constante. Los tipos numéricos utilizados para las claves obedecen las reglas normales para la comparación numérica: si dos números se comparan igual (por ejemplo, 1 y 1.0) entonces se pueden usar indistintamente para indexar la misma entrada del diccionario.

Los diccionarios conservan el orden de inserción, lo que significa que las claves se mantendrán en el mismo orden en que se agregaron secuencialmente sobre el diccionario. Reemplazar una clave existente no cambia el orden, sin embargo, eliminar una clave y volver a insertarla la agregará al final en lugar de mantener su lugar anterior.

Los diccionarios son mutables; pueden ser creados por la notación {...} (vea la sección Despliegues de diccionario).

Los módulos de extensión dbm.ndbm y dbm.gnu proporcionan ejemplos adicionales de tipos de mapeo, al igual que el módulo collections.

Distinto en la versión 3.7: Los diccionarios no conservaban el orden de inserción en las versiones de Python anteriores a 3.6. En CPython 3.6, el orden de inserción se conserva, pero se consideró un detalle de implementación en ese momento en lugar de una garantía de idioma.

Tipos invocables

Estos son los tipos a los que la operación de llamada de función (vea la sección Invocaciones) puede ser aplicado:

Funciones definidas por el usuario

Un objeto función definido por el usuario, es creado por un definición de función (vea la sección Definiciones de funciones). Debe llamarse con una lista de argumentos que contenga el mismo número de elementos que la lista de parámetros formales de la función.

Atributos especiales:

Atributo	Significado
__doc__	El texto de documentación de la función, o None si no está disponible; no heredado por subclases.	Escribible
__name__	El nombre de la función.	Escribible
__qualname__	Las funciones qualified name. Nuevo en la versión 3.3.	Escribible
__module__	El nombre del módulo en el que se definió la función, o None si no está disponible.	Escribible
__defaults__	Una tupla que contiene valores de argumento predeterminados para aquellos argumentos que tienen valores predeterminados, o None si ningún argumento tiene un valor predeterminado.	Escribible
__code__	El objeto de código que representa el cuerpo de la función compilada.	Escribible
__globals__	Una referencia al diccionario que contiene las variables globales de la función — el espacio de nombres global del módulo en el que se definió la función.	Solo lectura
__dict__	El espacio de nombres que admite atributos de funciones arbitrarias.	Escribible
__closure__	None o una tupla de celdas que contienen enlaces para las variables libres de la función. Vea a continuación para obtener información sobre el atributo cell_contents.	Solo lectura
__annotations__	Un diccionario que contiene anotaciones de parámetros. Las claves del dict son los nombres de los parámetros, y 'return' para la anotación de retorno, si se proporciona. Para más información sobre trabajar con este atributo, ve Prácticas recomendadas para las anotaciones.	Escribible
__kwdefaults__	Un diccionario que contiene valores predeterminados para parámetros de solo palabras clave.	Escribible

La mayoría de los atributos etiquetados «Escribible» verifican el tipo del valor asignado.

Los objetos de función también admiten la obtención y configuración de atributos arbitrarios, que se pueden usar, por ejemplo, para adjuntar metadatos a funciones. La notación de puntos de atributo regular se utiliza para obtener y establecer dichos atributos. Tenga en cuenta que la implementación actual solo admite atributos de función en funciones definidas por el usuario. Los atributos de función en funciones integradas pueden ser compatibles en el futuro.

Un objeto de celda tiene el atributo cell_contents. Esto se puede usar para obtener el valor de la celda, así como para establecer el valor.

Se puede recuperar información adicional sobre la definición de una función desde su objeto de código; Vea la descripción de los tipos internos a continuación. El tipo cell puede ser accedido en el módulo types.

Métodos de instancia

Un objeto de método de instancia combina una clase, una instancia de clase y cualquier objeto invocable (normalmente una función definida por el usuario).

Atributos especiales de solo lectura: __self__ es el objeto de instancia de clase, __func__ es el objeto de función; __doc__ es la documentación del método (al igual que __func__.__doc__); __name__ es el nombre del método (al igual que __func__.__name__); __module__ es el nombre del módulo en el que el método fue definido, o None si no se encuentra disponible.

Los métodos también admiten obtener (más no establecer) los atributos arbitrarios de la función en el objeto de función subyacente.

Los objetos de métodos definidos por usuarios pueden ser creados al obtener el atributo de una clase (probablemente a través de la instancia de dicha clase), si tal atributo es el objeto de una función definida por el usuario o el objeto del método de una clase.

Cuando un objeto de instancia de método es creado al obtener un objeto de función definida por el usuario desde una clase a través de una de sus instancias, su atributo __self__ es la instancia, y el objeto de método se dice que está enlazado. El nuevo atributo de método __func__ es el objeto de función original.

Cuando un objeto de instancia de método es creado al obtener un objeto de método de clase a partir de una clase o instancia, su atributo __self__ es la clase misma, y su atributo __func__ es el objeto de función subyacente al método de la clase.

Cuando el objeto de la instancia de método es invocado, la función subyacente (__func__) es llamada, insertando la instancia de clase (__self__) delante de la lista de argumentos. Por ejemplo, cuando C es una clase que contiene la definición de una función f(), y x es una instancia de C, invocar x.f(1) es equivalente a invocar C.f(x, 1).

Cuando el objeto de instancia de método es derivado del objeto del método de clase, la “instancia de clase” almacenada en __self__ en realidad será la clase misma, de manera que invocar ya sea x.f(1)``o ``C.f(1) es equivalente a invocar f(C,1) donde f es la función subyacente.

Tome en cuenta que la transformación de objeto de función a objeto de método de instancia ocurre cada vez que el atributo es obtenido de la instancia. En algunos casos, una optimización fructífera es asignar el atributo a una variable local e invocarla. Note también que esta transformación únicamente ocurre con funciones definidas por usuario; otros objetos invocables (y todos los objetos no invocables) son obtenidos sin transformación. También es importante mencionar que las funciones definidas por el usuario, que son atributos de la instancia de una clase no son convertidos a métodos enlazados; esto ocurre únicamente cuando la función es un atributo de la clase.

Funciones generadoras

Una función o método que utiliza la declaración yield (ver sección La declaración yield) se llama generator function. Dicha función, cuando es invocada, siempre retorna un objeto iterador que puede ser utilizado para ejecutar el cuerpo de la función: invocando el método iterador iterator.__next__() hará que la función se ejecute hasta proporcionar un valor utilizando la declaración yield. Cuando la función ejecuta una declaración return o llega hasta el final, una excepción StopIteration es lanzada y el iterador habrá llegado al final del conjunto de valores a ser retornados.

Funciones de corrutina

Una función o método que es definido utilizando async def se llama coroutine function. Dicha función, cuando es invocada, retorna un objeto coroutine. Éste puede contener expresiones await, así como declaraciones async with y async for. Ver también la sección Objetos de Corrutina.

Funciones generadoras asincrónicas

Una función o método que es definido usando async def y que utiliza la declaración yield se llama asynchronous generator function. Dicha función, al ser invocada, retorna un objeto iterador asincrónico que puede ser utilizado en una declaración async for para ejecutar el cuerpo de la función.

Invocando el método del iterador asincrónico aiterator.__anext__() retornará un awaitable que al ser esperado se ejecutará hasta proporcionar un valor utilizando la expresión yield. Cuando la función ejecuta una declaración return vacía o llega a su final, una excepción StopAsyncIteration es lanzada y el iterador asincrónico habrá llegado al final del conjunto de valores a ser producidos.

Funciones incorporadas

Un objeto de función incorporada es un envoltorio (wrapper) alrededor de una función C. Ejemplos de funciones incorporadas son len() y math.sin() (math es un módulo estándar incorporado). El número y tipo de argumentos son determinados por la función C. Atributos especiales de solo lectura: __doc__ es la cadena de documentación de la función, o None si no se encuentra disponible; __name__ es el nombre de la función; __init__ es establecido como None (sin embargo ver el siguiente elemento); __module__ es el nombre del módulo en el que la función fue definida o None si no se encuentra disponible.

Métodos incorporados

Éste es realmente un disfraz distinto de una función incorporada, esta vez teniendo un objeto que se pasa a la función C como un argumento extra implícito. Un ejemplo de un método incorporado es alist.append(), asumiendo que alist es un objeto de lista. En este caso, el atributo especial de solo lectura __self__ es establecido al objeto indicado por alist.

Clases

Las clases son invocables. Estos objetos normalmente actúan como fábricas de nuevas instancias de ellos mismos, pero las variaciones son posibles para los tipos de clases que anulan __new__(). Los argumentos de la invocación son pasados a __new__() y, en el caso típico, a __init__() para iniciar la nueva instancia.

Instancias de clases

Las instancias de clases arbitrarias se pueden hacer invocables definiendo el método __call__() en su clase.

Módulos

Los módulos son una unidad básica organizacional en código Python, y son creados por el import system al ser invocados ya sea por la declaración import, o invocando funciones como importlib.import_module() y la incorporada __import__(). Un objeto de módulo tiene un espacio de nombres implementado por un objeto de diccionario (éste es el diccionario al que hace referencia el atributo de funciones __globals__ definido en el módulo). Las referencias de atributos son traducidas a búsquedas en este diccionario, p. ej., m.x es equivalente a m.__dict__[“x”]. Un objeto de módulo no contiene el objeto de código utilizado para iniciar el módulo (ya que no es necesario una vez que la inicialización es realizada).

La asignación de atributos actualiza el diccionario de espacio de nombres del módulo, p. ej., m.x = 1 es equivalente a m.__dict__[“x”] = 1.

Atributos predefinidos (escribibles):

__name__

El nombre del módulo.

__doc__

El texto de documentación del módulo, o None si no está disponible.

__file__

El nombre de ruta del archivo desde el que se cargó el módulo, si se cargó desde un archivo. El atributo __file__ puede faltar para ciertos tipos de módulos, como los módulos C que están vinculados estáticamente al intérprete. Para los módulos de extensión cargados dinámicamente desde una biblioteca compartida, es el nombre de ruta del archivo de la biblioteca compartida.

__annotations__

Un diccionario que contiene el variable annotations recopilados durante la ejecución del cuerpo del módulo. Para buenas prácticas sobre trabajar con __annotations__, por favor ve Prácticas recomendadas para las anotaciones.

El atributo especial de solo lectura __dict__ es el espacio de nombres del módulo como un objeto de diccionario.

CPython implementation detail: Debido a la manera en la que CPython limpia los diccionarios de módulo, el diccionario de módulo será limpiado cuando el módulo se encuentra fuera de alcance, incluso si el diccionario aún tiene referencias existentes. Para evitar esto, copie el diccionario o mantenga el módulo cerca mientras usa el diccionario directamente.

Clases personalizadas

Los tipos de clases personalizadas son normalmente creadas por definiciones de clases (ver sección Definiciones de clase). Una clase tiene implementado un espacio de nombres por un objeto de diccionario. Las referencias de atributos de clase son traducidas a búsquedas en este diccionario, p. ej., C.x es traducido a C.__dict__[“x”] (aunque hay una serie de enlaces que permiten la ubicación de atributos por otros medios). Cuando el nombre de atributo no es encontrado ahí, la búsqueda de atributo continúa en las clases base. Esta búsqueda de las clases base utiliza la orden de resolución de métodos C3 que se comporta correctamente aún en la presencia de estructuras de herencia ‘diamante’ donde existen múltiples rutas de herencia que llevan a un ancestro común. Detalles adicionales en el MRO C3 utilizados por Python pueden ser encontrados en la documentación correspondiente a la versión 2.3 en https://www.python.org/download/releases/2.3/mro/.

Cuando la referencia de un atributo de clase (digamos, para la clase C) produce un objeto de método de clase, éste es transformado a un objeto de método de instancia cuyo atributo __self__ es C. Cuando produce un objeto de un método estático, éste es transformado al objeto envuelto por el objeto de método estático. Ver sección Implementando Descriptores para otra manera en la que los atributos obtenidos de una clase pueden diferir de los que en realidad están contenidos en su __dict__.

Las asignaciones de atributos de clase actualizan el diccionario de la clase, nunca el diccionario de la clase base.

Un objeto de clase puede ser invocado (ver arriba) para producir una instancia de clase (ver a continuación).

Atributos especiales:

__name__

El nombre de la clase.

__module__

El nombre del módulo en el que se definió la clase.

__dict__

El diccionario conteniendo el espacio de nombres de la clase.

__bases__

Una tupla conteniendo las clases de base, en orden de ocurrencia en la lista de clase base.

__doc__

El texto de documentación de la clase, o None si no está disponible.

__annotations__

Un diccionario conteniendo el variable annotations recopilados durante la ejecución del cuerpo de la clase. Para buenas prácticas sobre trabajar con __annotations__, por favor ve Prácticas recomendadas para las anotaciones.

Instancias de clase

Una instancia de clase es creado al invocar un objeto de clase (ver arriba). Una instancia de clase tiene implementado un espacio de nombres como diccionario que es el primer lugar en el que se buscan referencias de atributos. Cuando un atributo no es encontrado ahí, y la clase de instancia tiene un atributo con ese nombre, la búsqueda continúa con los atributos de clase. Si se encuentra que un atributo de clase es un objeto de función definido por el usuario, es transformado en un objeto de método de instancia cuyo atributo __self__ es la instancia. Los objetos de método y método de clase estáticos también son transformados; ver más adelante debajo de “Clases”. Ver sección Implementando Descriptores para otra forma en la que los atributos de una clase obtenida a través de sus instancias puede diferir de los objetos realmente almacenados en el __dict__ de la clase. Si no se encuentra ningún atributo de clase, y la clase del objeto tiene un método __getattr__(), éste es llamado para satisfacer la búsqueda.

Asignación y eliminación de atributos actualizan el diccionario de la instancia, nunca el diccionario de la clase. Si la clase tiene un método __setattr__() o __delattr__(), éste es invocado en lugar de actualizar el diccionario de la instancia directamente.

Instancias de clases pueden pretender ser números, secuencias o mapeos si tienen métodos con ciertos nombres especiales. Ver sección Nombres especiales de método.

Atributos especiales: __dict__ es el diccionario de atributos; __class__ es la clase de la instancia.

Objetos E/S (también conocidos como objetos de archivo)

Un file object representa un archivo abierto. Diversos accesos directos se encuentran disponibles para crear objetos de archivo: la función incorporada open(), así como os.popen(), os.fdopen(), y el método de objetos socket makefile() (y quizás por otras funciones y métodos proporcionados por módulos de extensión).

Los objetos sys.stdin, sys.stdout y sys.stderr son iniciados a objetos de archivos correspondientes a la entrada y salida estándar del intérprete, así como flujos de error; todos ellos están abiertos en el modo de texto y por lo tanto siguen la interface definida por la clase abstracta io.TextIOBase.

Tipos internos

Algunos tipos utilizados internamente por el intérprete son expuestos al usuario. Sus definiciones pueden cambiar en futuras versiones del intérprete, pero son mencionadas aquí para complementar.

Objetos de código

Los objetos de código representan código de Python ejecutable compilado por bytes, o bytecode. La diferencia entre un objeto de código y un objeto de función es que el objeto de función contiene una referencia explícita a los globales de la función (el módulo en el que fue definido), mientras el objeto de código no contiene contexto; de igual manera los valores por defecto de los argumentos son almacenados en el objeto de función, no en el objeto de código (porque representan valores calculados en tiempo de ejecución). A diferencia de objetos de función, los objetos de código son inmutables y no contienen referencias (directas o indirectas) a objetos mutables.

Atributos especiales de solo lectura: co_name da el nombre de la función; co_argcount es el número total de argumentos posicionales (incluyendo argumentos únicamente posicionales y argumentos con valores por default); co_posonlyargcount es el número de argumentos únicamente posicionales (incluyendo argumentos con valores por default); co_kwonlyargcountp es el número de argumentos solo de palabra clave (incluyendo argumentos con valores por default); co_nlocals es el número de variables usadas por la función (incluyendo argumentos); co_varnames es una tupla que contiene los nombres con las variables locales (empezando con los nombres de argumento); co_cellvars es una tupla que contiene los nombres de variables locales que son referenciadas por funciones anidadas; co_freevars es una tupla que contiene los nombres de variables libres; co_code es una cadena que representa la secuencia de instrucciones de bytecode; co_consts es una tupla que contiene las literales usadas por el bytecode; co_names es una tupla que contiene los nombres usados por el bytecode; co_filename es el nombre de archivo de donde el código fue compilado; co_firstlineno es el primer número de línea de la función; co_lnotab es una cadena codificando el mapeo desde el desplazamiento de bytecode al número de líneas (ver el código fuente del intérprete para más detalles); co_stacksize es el tamaño de pila requerido; co_flags es un entero codificando el número de banderas para el intérprete.

Los siguientes bits de bandera son definidos por co_flags : bit 0x04 es establecido si la función utiliza la sintaxis *arguments para aceptar un número arbitrario de argumentos posicionales; bit 0x08 es establecido si la función utiliza la sintaxis **keywords para aceptar argumentos de palabras clave arbitrarios; bit 0x20 es establecido si la función es un generador.

Declaraciones de características futuras (from __future__ import division) también utiliza bits en co_flags para indicar si el objeto de código fue compilado con alguna característica particular habilitada: el bit 0x2000 es establecido si la función fue compilada con división futura habilitada; los bits 0x10 y 0x1000 fueron utilizados en versiones previas de Python.

Otros bits en co_flags son reservados para uso interno.

Si un objeto de código representa una función, el primer elemento en co_consts es la cadena de documentación de la función, o None si no está definido.

Objetos de marco

Los objetos de marco representan marcos de ejecución. Pueden ocurrir en objetos de rastreo (ver a continuación), y son también pasados hacia funciones de rastreo registradas.

Atributos especiales de solo lectura: f_back es para el marco de pila anterior (hacia quien produce el llamado), o None si éste es el marco de pila inferior; f_code es el objeto de código ejecutado en este marco; f_locals es el diccionario utilizado para buscar variables locales; f_globals es usado por las variables globales; f_builtins es utilizado por nombres incorporados (intrínsecos); f_lasti da la instrucción precisa (éste es un índice dentro de la cadena de bytecode del objeto de código).

Acceder a f_code lanza un objeto evento de auditoría .__getattr__ con argumentos obj y "f_code" .

Atributos especiales escribibles: f_trace, de lo contrario None, es una función llamada por distintos eventos durante la ejecución del código (éste es utilizado por el depurador). Normalmente un evento es desencadenado por cada una de las líneas fuente - esto puede ser deshabilitado estableciendo f_trace_lines a False.

Las implementaciones pueden permitir que eventos por código de operación sean solicitados estableciendo f_trace_opcodes a True. Tenga en cuenta que esto puede llevar a un comportamiento indefinido del intérprete si se levantan excepciones por la función de rastreo escape hacia la función que está siendo rastreada.

f_lineno es el número de línea actual del marco — escribiendo a esta forma dentro de una función de rastreo salta a la línea dada (solo para el último marco). Un depurador puede implementar un comando de salto (Jump) (también conocido como Set Next Statement) al escribir en f_lineno.

Objetos de marco soportan un método:

frame.clear()

Este método limpia todas las referencias a variables locales mantenidas por el marco. También, si el marco pertenecía a un generador, éste es finalizado. Esto ayuda a interrumpir los ciclos de referencia que involucran objetos de marco (por ejemplo al detectar una excepción y almacenando su rastro para uso posterior).

RuntimeError es lanzado si el marco se encuentra en ejecución.

Nuevo en la versión 3.4.

Objetos de seguimiento de pila (traceback)

Los objetos de seguimiento de pila representan el trazo de pila (stack trace) de una excepción. Un objeto de rastreo es creado de manera implícita cuando se da una excepción, y puede ser creada de manera explícita al llamar types.TracebackType.

Para seguimientos de pila (tracebacks) creados de manera implícita, cuando la búsqueda por un manejo de excepciones desenvuelve la pila de ejecución, en cada nivel de desenvolvimiento se inserta un objeto de rastreo al frente del rastreo actual. Cuando se entra a un manejo de excepción, la pila de rastreo se vuelve disponible para el programa. (Ver sección La sentencia try.) Es accesible como el tercer elemento de la tupla retornada por sys.exc_info(), y como el atributo __traceback__ de la excepción capturada.

Cuando el programa no contiene un gestor apropiado, el trazo de pila es escrito (muy bien formateado) a la secuencia de error estándar; si el intérprete es interactivo, también se vuelve disponible al usuario como sys.last_traceback.

Para seguimientos de pila creados de forma explícita, depende de su creador determinar cómo los atributos tb_next deberían ser ligados para formar un trazo de pila completo (full stack trace).

Atributos especiales de solo lectura: tb_frame apunta al marco de ejecución del nivel actual; tb_lineno da el número de línea donde ocurrió la excepción; tb_lasti indica la instrucción precisa. El número de línea y la última instrucción en el seguimiento de pila puede diferir del número de línea de su objeto de marco si la excepción ocurrió en una declaración try sin una cláusula de excepción (except) correspondiente o con una cláusula finally.

Acceder a tb_frame lanza un objeto evento de auditoría .__getattr__ con argumentos obj y tb_frame.

Atributo especial escribible: tb_next es el siguiente nivel en el trazo de pila (hacia el marco en donde ocurrió la excepción), o None si no existe un siguiente nivel.

Distinto en la versión 3.7: Los objetos de seguimiento de pila ya pueden ser instanciados de manera explícita desde código de Python, y el atributo tb_next de instancias existentes puede ser actualizado.

Objetos de segmento (Slice objects)

Los objetos de segmento son utilizados para representar segmentos para métodos __getitem__(). También son creados por la función incorporada slice().

Atributos especiales de solo lectura: start es el límite inferior; stop es el límite superior; step es el valor de paso; cada uno es None si es omitido. Estos atributos pueden ser de cualquier tipo.

Los objetos de segmento soportan un método:

slice.indices(self, length)

Este método toma un argumento length de entero simple y calcula información relacionada con el segmento que el mismo describiría si fuera aplicado a una secuencia de elementos length. Retorna una tupla de tres enteros; respectivamente estos son los índices start y stop y el step o longitud del paso del segmento. Índices faltantes o fuera de los límites son manipulados de manera consistente con segmentos regulares.

Objetos de método estático

Los objetos de método estático proveen una forma de anular la transformación de objetos de función a objetos de método descritos anteriormente. Un objeto de método estático es una envoltura (wrapper) alrededor de cualquier otro objeto, usualmente un objeto de método definido por usuario. Cuando un objeto de método estático es obtenido desde una clase o una instancia de clase, usualmente el objeto retornado es el objeto envuelto, el cual no está objeto a ninguna transformación adicional. Los objetos de método estático también pueden ser llamados. Los objetos de método estático son creados por el constructor incorporado staticmethod().

Objetos de método de clase

Un objeto de método de clase, igual que un objeto de método estático, es un envoltorio (wrapper) alrededor de otro objeto que altera la forma en la que el objeto es obtenido desde las clases y las instancias de clase. El comportamiento de los objetos de método de clase sobre tal obtención es descrita más arriba, debajo de “Métodos definidos por usuario”. Objetos de clase de método son creados por el constructor incorporado classmethod().

3.3. Nombres especiales de método

Una clase puede implementar ciertas operaciones que son invocadas por sintaxis especiales (como operaciones aritméticas o de sub-índice y segmentación) definiendo métodos con nombres especiales. Este es el enfoque de Python hacia operator overloading, permitiendo a las clases definir su propio comportamiento con respecto a los operadores del lenguaje. Por ejemplo, si una clase define un método llamado __getitem__(), y x es una instancia de esta clase, entonces x[i] es aproximadamente equivalente a type(x).__getitem__(x, i). A excepción de donde se menciona, los intentos por ejecutar una operación lanzan una excepción cuando no es definido un método apropiado (normalmente AttributeError o TypeError).

Estableciendo un método especial a None indica que la operación correspondiente no se encuentra disponible. Por ejemplo, si una clase establece __iter__() a None, la clase no es iterable, así que llamando iter() en sus instancias lanzará un TypeError (sin volver a __getitem__()). 2

Cuando se implementa una clase que emula cualquier tipo incorporado, es importante que la emulación solo sea implementado al grado que hace sentido para el objeto que está siendo modelado. Por ejemplo, algunas secuencias pueden trabajar bien con la obtención de elementos individuales, pero extraer un segmento puede no tener mucho sentido. (Un ejemplo de esto es la interfaz NodeList, en el Modelo de Objetos del Documento del W3C.)

3.3.1. Personalización básica

object.__new__(cls[, ...])

Es llamado para crear una nueva instancia de clase cls. __new__() es un método estático (como un caso especial, así que no se necesita declarar como tal) que toma la clase de donde fue solicitada una instancia como su primer argumento. Los argumentos restantes son aquellos que se pasan a la expresión del constructor de objetos (para llamar a la clase). El valor retornado de __new__() deberá ser la nueva instancia de objeto (normalmente una instancia de cls).

Implementaciones típicas crean una nueva instancia de la clase invocando el método __new__() de la súper clase utilizando super().__new__(cls[, …]) con argumentos apropiados y después modificando la recién creada instancia como necesaria antes de retornarla.

Si __new__() es invocado durante la construcción del objeto y éste retorna una instancia de cls, entonces el nuevo método __init__() de la instancia será invocado como __init__(self[, …]), donde self es la nueva instancia y los argumentos restantes son iguales a como fueron pasados hacia el constructor de objetos.

Si __new__() no retorna una instancia de cls, entonces el nuevo método __init__() de la instancia no será invocado.

__new__() es destinado principalmente para permitir a subclases de tipos inmutables (como int, str, o tuple) personalizar la creación de instancias. También es comúnmente anulado en metaclases personalizadas con el fin de personalizar la creación de clase.

object.__init__(self[, ...])

Llamado después de que la instancia ha sido creada (por __new__()), pero antes es retornada a quien produce la llamada. Los argumentos son aquellos pasados a la expresión del constructor de la clase. Si una clase base tiene un método __init__(), el método __init__() de clase derivada, de existir, debe llamarlo explícitamente para asegurar la inicialización apropiada de la clase base que es parte de la instancia; por ejemplo: super().__init__([args…]).

Debido a que __new__() y __init__() trabajan juntos construyendo objetos (__new__() para crearlo y __init__() para personalizarlo), ningún valor distinto a None puede ser retornado por __init__(); hacer esto puede causar que se lance una excepción TypeError en tiempo de ejecución.

object.__del__(self)

Llamado cuando la instancia es a punto de ser destruida. Esto también es llamado finalizador o (indebidamente) destructor. Si una clase base tiene un método __del__() el método __del__() de la clase derivada, de existir, debe llamarlo explícitamente para asegurar la eliminación adecuada de la parte de la clase base de la instancia.

Es posible (¡aunque no recomendable!) para el método __del__() posponer la destrucción de la instancia al crear una nueva referencia hacia ésta. Esto es llamado resurrección de objeto. Es dependiente de la implementación si __del__() es llamado una segunda vez cuando un objeto resucitado está por ser destruido; la implementación CPython actual únicamente lo llama una vez.

No está garantizado que los métodos __del__() sean llamados para objetos que aún existen cuando el intérprete se cierra.

Nota

del x no llama directamente x.__del__() — el primero disminuye el conteo de referencia para x uno por uno, y el segundo es llamado únicamente cuando el conteo de referencias de x llega a cero.

CPython implementation detail: It is possible for a reference cycle to prevent the reference count of an object from going to zero. In this case, the cycle will be later detected and deleted by the cyclic garbage collector. A common cause of reference cycles is when an exception has been caught in a local variable. The frame’s locals then reference the exception, which references its own traceback, which references the locals of all frames caught in the traceback.

Ver también

Documentación para el módulo gc.

Advertencia

Debido a las circunstancias inciertas bajo las que los métodos __del__() son invocados, las excepciones que ocurren durante su ejecución son ignoradas, y una advertencia es mostrada hacia sys.stderr. En particular:

• __del__() puede ser invocado cuando código arbitrario es ejecutado, incluyendo el de cualquier hilo arbitrario. Si __del__() necesita realizar un cierre de exclusión mutua (lock) o invocar cualquier otro recurso que lo esté bloqueando, podría provocar un bloqueo muto (deadlock) ya que el recurso podría estar siendo utilizado por el código que se interrumpe al ejecutar __del__().

• __del__() puede ser ejecutado durante el cierre del intérprete. Como consecuencia, las variables globales que necesita para acceder (incluyendo otros módulos) podrían haber sido borradas o establecidas a None. Python garantiza que los globales cuyo nombre comienza con un guión bajo simple sean borrados de su módulo antes que los globales sean borrados; si no existen otras referencias a dichas globales, esto puede ayudar asegurando que los módulos importados aún se encuentren disponibles al momento de llamar al método __del__().

object.__repr__(self)

Llamado por la función incorporada repr() para calcular la cadena “oficial” de representación de un objeto. Si es posible, esto debería verse como una expresión de Python válida que puede ser utilizada para recrear un objeto con el mismo valor (bajo el ambiente adecuado). Si no es posible, una cadena con la forma <…some useful description…> debe ser retornada. El valor de retorno debe ser un objeto de cadena (string). Si una clase define __repr__() pero no __str__(), entonces __repr__() también es utilizado cuando una cadena “informal” de representación de instancias de esas clases son requeridas.

Esto es típicamente utilizado para depurar, así que es importante que la representación sea rica en información e inequívoca.

object.__str__(self)

Llamado por str(object) y las funciones incorporadas format() y print() para calcular la “informal” o bien mostrada cadena de representación de un objeto. El valor de retorno debe ser un objeto string.

Este método difiere de object.__repr__() en que no hay expectativas de que __str__() retorne una expresión de Python válida: una representación más conveniente o concisa pueda ser utilizada.

La implementación por defecto definida por el tipo incorporado object llama a object.__repr__().

object.__bytes__(self)

Llamado por bytes para calcular la representación de la cadena de byte de un objeto. Este deberá retornar un objeto bytes.

object.__format__(self, format_spec)

Llamado por la función incorporada format(), y por extensión, la evaluación de formatted string literals y el método str.format(), para producir la representación “formateada” de un objeto. El argumento format_spec es una cadena que contiene una descripción de las opciones de formato deseadas. La interpretación del argumento format_spec depende del tipo que implementa __format__(), sin embargo, ya sea que la mayoría de las clases deleguen el formato a uno de los tipos incorporados, o utilicen una sintaxis de opción de formato similar.

Ver Especificación de formato Mini-Lenguaje para una descripción de la sintaxis de formato estándar.

El valor de retorno debe ser un objeto de cadena.

Distinto en la versión 3.4: El método __format__ del mismo object lanza un TypeError si se la pasa una cadena no vacía.

Distinto en la versión 3.7: object.__format__(x, ‘’) es ahora equivalente a str(x) en lugar de format(str(self), ‘’).

object.__lt__(self, other)

object.__le__(self, other)

object.__eq__(self, other)

object.__ne__(self, other)

object.__gt__(self, other)

object.__ge__(self, other)

Estos son los llamados métodos de comparación rich. La correspondencia entre símbolos de operador y los nombres de método es de la siguiente manera: x<y llama x.__lt__(y), x<=y llama x.__le__(y), x==y llama x.__eq__(y), x!=y llama x.__ne__(y), x>y llama x.__gt__(y), y x>=y llama x.__ge__(y).

Un método de comparación rich puede retornar el único NotImplemented si no implementa la operación para un par de argumentos dados. Por convención, False y True son retornados para una comparación exitosa. Sin embargo, estos métodos pueden retornar cualquier valor, así que si el operador de comparación es utilizado en un contexto Booleano (p. ej. en la condición de una sentencia if), Python llamará bool() en dicho valor para determinar si el resultado es verdadero (true) o falso (false).

Por defecto, object implementa __eq__() usando is, retornando NotImplemented en el caso de una comparación falsa: True if x is y else NotImplemented. Para __ne__(), por defecto delega a __eq__() e invierte el resultado a menos que sea NotImplemented. No hay otras relaciones implícitas entre los operadores de comparación o implementaciones predeterminadas; por ejemplo, la verdad de (x <y o x == y) no implica x <= y. Para generar automáticamente operaciones de pedido a partir de una sola operación raíz, consulte functools.total_ordering().

Ver el párrafo sobre __hash__() para más notas importantes sobre la creación de objetos hashable que soportan operaciones de comparación personalizadas y son utilizables como llaves de diccionario.

No existen versiones con argumento intercambiado de estos métodos (a ser utilizados cuando el argumento de la izquierda no soporta la operación pero el de la derecha sí); más bien, __lt__() y __gt__() son el reflejo del otro, __le__() y __ge__() son un reflejo del otro, y __eq__() y __ne__() son su propio reflejo. Si los operandos son de tipos distintos, y el tipo de operando de la derecha es una clase directa o indirecta del tipo de operando de la izquierda, el método reflejado del operando de la derecha tiene prioridad, de otro modo el método del operando de la izquierda tiene prioridad. Subclases virtuales no son consideradas.

object.__hash__(self)

Llamado por la función incorporada hash() y por operaciones en miembros de colecciones hash incluyendo set, frozenset, and dict. __hash__() debe retornar un entero. La única propiedad requerida es que los objetos que se comparen igual tienen el mismo valor hash; se recomienda mezclar los valores hash de los componentes de los objetos que juegan un papel en la comparación de objetos al colocarlos en una tupla y calcular el hash de la tupla. Por ejemplo:

def __hash__(self):
    return hash((self.name, self.nick, self.color))

Nota

hash() trunca el valor retornado del método personalizado __hash__() del objeto al tamaño de Py_ssize_t. Esto normalmente son 8 bytes en estructuras de 64-bits y 4 bytes en estructuras de 32 bits. Si el __hash__() de un objeto debe interoperar en estructuras de tamaños de bits diferentes, asegúrese de revisar la amplitud en todas las estructuras soportadas. Una forma fácil de hacer esto es con python -c “import sys; print(sys.hash_info.width)”.

Si una clase no define un método __eq__(), tampoco debe definir una operación __hash__(); si define a __eq__() pero no a __hash__(), sus instancias no serán utilizables como elementos en colecciones hash. Si la clase define objetos mutables e implementa un método __eq__(), éste no deberá implementar __hash__(), ya que la implementación de colecciones hash requiere que la llave de un valor hash no sea mutable (si el valor del objeto hash cambia, estará en el cubo de hash equivocado).

Clases definidas por usuario tienen los métodos __eq__() y __hash__() por defecto; con ellos, todos los objetos se comparan de manera desigual (excepto con ellos mismos) y x.__hash__() retorna un valor apropiado tal que x == y implique que x es y y hash(x) == hash(y).

Una clase que anula __eq__() y no define __hash__() tendrá implícito su __hash__() establecido a None. Cuando el método __hash__() de una clase es None, instancias de la clase lanzarán un TypeError cuando el programa intente obtener el valor del hash, y también será correctamente identificado como de hash no calculable cuando se verifique isinstance(obj, collections.abc.Hashable).

Si una clase que anula __eq__() necesita conservar la implementación de __hash__() de una clase padre, al intérprete se le debe informar explícitamente estableciendo __hash__ = <ParentClass>.__hash__.

Si una clase que no anula __eq__() desea eliminar el soporte de hash, debe incluir __hash__ = None en la definición de clase. Una clase que define su propio __hash__() y que explícitamente lanza un TypeError será identificado de manera incorrecta como de hash calculable por una llamada isinstance(obj, collections.abc.Hashable).

Nota

Por defecto los valores de objetos str y bytes de __hash__() son “salados” con un valor aleatorio impredecible. Aunque se mantienen constantes dentro de un proceso Python particular, no son predecibles entre invocaciones repetidas de Python.

Esto tiene la intención de proveer protección contra una negación de servicio causada por entradas cautelosamente elegidas y que explotan el peor caso de rendimiento en la inserción de un diccionario, complejidad O(n²). Ver http://www.ocert.org/advisories/ocert-2011-003.html para más detalles.

Cambiar los valores hash afectan el orden de la iteración de los sets. Python nunca ha dado garantías en relación a este orden (y típicamente varía entre estructuras de 32-bits y 64-bits).

Ver también PYTHONHASHSEED.

Distinto en la versión 3.3: La aleatorización de hash es habilitada por defecto.

object.__bool__(self)

Es llamado para implementar pruebas de valores de verdad y la operación incorporada bool(); debe retornar False o True. Cuando este método no es definido, __len__() es llamado, si es definido, y el objeto es considerado verdadero (true) si el resultado es diferente de zero. Si la clase no define __len__() ni __bool__(), todas sus instancias son consideradas verdaderas (true).

3.3.2. Personalizando acceso a atributos

Los siguientes métodos pueden ser definidos para personalizar el significado de acceso a atributos (uso de, asignación a, o borrado de x.name) para instancias de clase.

object.__getattr__(self, name)

Es llamado cuando el acceso a atributos por defecto falla con un AttributeError (ya sea que __getattribute__() lanza una excepción AttributeError porque name no es un atributo de instancia o un atributo en el árbol de clase para self; o el __get__() de la propiedad de name lanza una excepción AttributeError). Este método debe retornar el valor de atributo (calculado) o lanzar una excepción AttributeError.

Tome en cuenta que si el atributo es encontrado a través del mecanismo normal, __getattr__() no es llamado. (Esto es una desigualdad intencional entre __getattr__() y __setattr__().) Esto es realizado tanto por motivos de eficiencia y porque de otra manera __getattr__() no tendría manera de acceder a otros atributos de la instancia. Tome en cuenta que al menos para variables de instancia, se puede fingir control total al no insertar ningún valor en el diccionario de atributo de instancia (sino insertándolos en otro objeto). Ver el método __getattribute__() a continuación para una forma de tener control total sobre el acceso de atributo.

object.__getattribute__(self, name)

Es llamado incondicionalmente para implementar acceso de atributo por instancias de clase. Si la clase también define __getattr__(), éste no será llamado a menos que __getattribute__() lo llame de manera explícita o lance una excepción AttributeError. Este método deberá retornar el valor de atributo (calculado) o lanzar una excepción AttributeError. Para evitar la recursividad infinita en este método, su implementación deberá siempre llamar al método de la clase base con el mismo nombre para acceder cualquier atributo que necesite, por ejemplo, object.__getattribute__(self, name).

Nota

Este método aún puede ser sobrepasado cuando se buscan métodos especiales como resultado de una invocación implícita a través de sintaxis de lenguaje o funciones implícitas. Ver Búsqueda de método especial.

Lanza un evento de auditoría object.__getattr__ con argumentos obj, name.

object.__setattr__(self, name, value)

Es llamado cuando se intenta la asignación de atributos. Éste es llamado en lugar del mecanismo normal (p. ej. guardar el valor en el diccionario de instancias). name es el nombre de atributo, value es el valor que se le asigna.

Si __setattr__() quiere asignar a un atributo de instancia, debe llamar al método de la clase base con el mismo nombre, por ejemplo, object.__setattr__(self, name, value).

Lanza un evento de auditoría object.__setattr__ con argumentos obj, name, value.

object.__delattr__(self, name)

Al igual que __setattr__() pero para borrado de atributos en lugar de establecerlos. Esto solo de ser implementado si del obj.name es significativo para el objeto.

Lanza un evento de auditoría object.__delattr__ con argumentos obj, name.

object.__dir__(self)

Es llamado cuando dir() es llamado en el objeto. Una secuencia debe ser retornada. dir() convierte la secuencia retornada a una lista y la ordena.

3.3.2.1. Personalizando acceso a atributos de módulo

Nombres especiales __getattr__ y __dir__ también pueden ser utilizados para personalizar acceso a atributos de módulo. La función __getattr__ a nivel del módulo debe aceptar un argumento que es el nombre del atributo y retornar el valor calculado o lanzar una excepción AttributeError. Si un atributo no es encontrado en el objeto de módulo a través de una búsqueda normal, p. ej. object.__getattribute__(), entonces __getattr__ es buscado en el módulo __dict__ antes de lanzar una excepción AttributeError. Si es encontrado, es llamado con el nombre de atributo y el resultado es retornado.

La función __dir__ debe no aceptar argumentos y retornar una secuencia de cadena de caracteres que representan los nombres accesibles en el módulo. De existir, esta función anula la búsqueda estándar dir() en un módulo.

Para una personalización más precisa sobre el comportamiento del módulo (estableciendo atributos, propiedades, etc.), se puede establecer el atributo __class__ de un objeto de módulo a una subclase de types.ModuleType. Por ejemplo:

import sys
from types import ModuleType

class VerboseModule(ModuleType):
    def __repr__(self):
        return f'Verbose {self.__name__}'

    def __setattr__(self, attr, value):
        print(f'Setting {attr}...')
        super().__setattr__(attr, value)

sys.modules[__name__].__class__ = VerboseModule

Nota

Definiendo un módulo __getattr__ y estableciendo un módulo __class__ solo afecta búsquedas que utilizan la sintaxis de acceso a atributo – acceder directamente a las globales del módulo (ya sea por código dentro del módulo, o a través de una referencia al diccionario de globales del módulo) no se ve afectado.

Distinto en la versión 3.5: El atributo de módulo __class__ es ahora escribible.

Nuevo en la versión 3.7: Atributos de módulo __getattr__ y __dir__.

Ver también

PEP 562 - Módulos __getattr__ y __dir__

Describe las funciones __getattr__ y __dir__ en módulos.

3.3.2.2. Implementando Descriptores

Los siguientes métodos solo aplican cuando una instancia de clase que contiene el método (llamado clase descriptora) aparece en una clase propietaria (el descriptor debe estar en el diccionario de clase del propietario o en el diccionario de clase de alguno de sus padres). En los ejemplos a continuación, “el atributo” se refiere al atributo cuyo nombre es la llave de la propiedad en la clase propietaria __dict__.

object.__get__(self, instance, owner=None)

Es llamado para obtener el atributo de la clase propietaria (acceso a atributos de clase) o de una instancia de dicha clase (acceso a atributos de instancia). El argumento opcional owner es la clase propietaria, mientras que instance es la instancia a través de la cual el atributo fue accedido, o None cuando el atributo es accedido a través de owner.

Este método debe retornar el valor de atributo calculado o lanzar una excepción AttributeError.

PEP 252 especifica que __get__() puede ser llamado con uno o dos argumentos. Los propios descriptores incorporados de Python soportan esta especificación; sin embargo, es probable que algunas herramientas de terceros tengan descriptores que requieran ambos argumentos. La propia implementación de __getattribute__() en Python siempre pasa ambos argumentos si son requeridos o no.

object.__set__(self, instance, value)

Es llamado para establecer el atributo en una instancia instance de la clase propietaria a un nuevo valor value.

Nota, agregar __set__() o __delete__() cambia el tipo de descriptor a un “descriptor de datos”. Ver Invocando Descriptores para más detalles.

object.__delete__(self, instance)

Es llamado para borrar el atributo en una instancia instance de la clase propietaria.

El atributo __objclass__ es interpretado por el módulo inspect como la especificación de la clase donde el objeto fue definido (establecer esto adecuadamente puede ayudar en introspección de atributos dinámicos de clases en tiempo de ejecución). Para invocables, puede indicar que una instancia de un tipo (o subclase) dado es esperado o requerido como el primero argumento posicional (por ejemplo, CPython establece este atributo para métodos independientes que son implementados en C).

3.3.2.3. Invocando Descriptores

De manera general, un descriptor es un atributo de objeto con “comportamiento enlazado”, cuyo atributo de acceso ha sido anulado por métodos en el protocolo del descriptor: __get__(), __set__(), y __delete__(). Si cualquiera de esos métodos son definidos por un objeto, se dice que es un descriptor.

El comportamiento por defecto para atributos de acceso es obtener (get), establecer (set) o borrar (delete) el atributo del diccionario del objeto. Por ejemplo, a.x tiene una cadena de búsqueda que comienza con a.__dict__[‘x’], luego type(a).__dict__[‘x’], y continúa por las clases base de type(a) excluyendo metaclases.

Sin embargo, si el valor buscado es un objeto definiendo uno de los métodos del descriptor, entonces Python puede anular el comportamiento por defecto e invocar al método del descriptor en su lugar. Dónde ocurre esto en la cadena de precedencia depende de qué métodos de descriptor fueron definidos y cómo son llamados.

El punto de inicio por invocación de descriptor es un enlace a.x. Cómo los argumentos son ensamblados dependen de a:

Llamado Directo

El llamado más simple y menos común es cuando el código de usuario invoca directamente un método descriptor: x.__get__(a).

Enlace de Instancia

Al enlazar a una instancia de objeto, a es transformado en un llamado: type(a).__dict__[‘x’].__get__(a, type(a)).

Enlace de Clase

Al enlazar a una clase, A.x es transformado en un llamado: A.__dict__[‘x’].__get__(None, A).

Súper Enlace

Si a es una instancia de super, entonces el enlace super(B, obj).m() busca obj.__class__.__mro__ la clase base A que precede inmediatamente B y luego invoca al descriptor con el llamado: A.__dict__[‘m’].__get__(obj, obj.__class__).

Para enlace de instancias, la precedencia de la invocación de descriptor depende de qué métodos de descriptor son definidos. Un descriptor puede definir cualquier combinación de __get__(), __set__() y __delete__(). Si no define __get__(), entonces el acceso al atributo retornará el objeto de descriptor a menos que exista un valor en el diccionario de instancias del objeto. Si el descriptor define __set__() y/o __delete__(), es un descriptor de datos; si no define ninguno, es un descriptor sin datos. Normalmente los descriptores de datos definen ambos __get__() y __set__(), mientras que los descriptores sin datos solo tienen el método __get__(). Descriptores de datos con __set__() y __get__() (y/o __delete__()) definidos siempre anulan una re-definición en el diccionario de instancias. Por el contrario, los descriptores sin datos pueden ser anulados por instancias.

Métodos de Python (que incluyen staticmethod() y classmethod()) son implementados como descriptores sin datos. Por consiguiente, las instancias pueden redefinir y anular métodos. Esto permite que instancias individuales adquieran comportamientos que pueden diferir de otras instancias de la misma clase.

La función property() es implementada como un descriptor de datos. Por lo tanto, las instancias no pueden anular el comportamiento de una propiedad.

3.3.2.4. __slots__

__slots__ nos permiten declarar de manera explícita miembros de datos (como propiedades) y negar la creación de __dict__ y __weakref__ (a menos que se declare explícitamente en __slots__ o se encuentre disponible en un elemento padre.)

El espacio ganado al usar __dict__ puede ser importante. La velocidad de búsqueda de atributos también puede mejorar significativamente.

object.__slots__

Esta variable de clase se le puede asignar una cadena de caracteres, un elemento iterable o una secuencia de cadena de caracteres con nombres de variables utilizados por instancias. __slots__ reserva espacio para las variables declaradas y previene la creación automática de __dict__ y __weakref__ para cada instancia.

3.3.2.4.1. Notas sobre el uso de __slots__

• Cuando se hereda de una clase sin __slots__, los atributos __dict__ y __weakref__ de las instancias siempre serán accesibles.

• Sin una variable __dict__, no se puede asignar a instancias nuevas variables que no se encuentren listadas en la definición de __slots__. Intentos de asignación a una variable no listada lanza una excepción AttributeError. Si se desea hacer una asignación dinámica a variables nuevas, se debe agregar ’__dict__’ a la secuencia de cadena de caracteres en la declaración de __slots__.

• Sin una variable __weakref__ por cada instancia, las clases que definen __slots__ no soportan “referencias débiles” (weak references) a sus instancias. Si se desea el soporte de dichas referencias, se debe agregar ’__weakref__’ a la secuencia de cadena de caracteres en la declaración de __slots__.

• __slots__ son implementados a nivel de clase al crear descriptores (Implementando Descriptores) para cada nombre de variable. Como resultado, los atributos de clase no pueden ser utilizados para establecer valores por defecto a variables de instancia definidos por __slots__; de lo contrario, el atributo de clase sobrescribirá la asignación del descriptor.

• La acción de una declaración __slots__ no está limitada a la clase donde fue definida. __slots__ declarado en padres, se vuelven disponibles en clases hijas. Sin embargo, subclases hijas tendrán un __dict__ y __weakref__ a menos que también se defina __slots__ (el cual solo debe contener nombres de espacios o slots adicionales).

• Si una clase define un espacio (slot) también definido en una clase base, la variable de instancia definida por el espacio de la clase base es inaccesible (excepto al obtener su descriptor directamente de la clase base). Esto hace que el significado del programa sea indefinido. En el futuro se podría agregar una verificación para prevenir esto.

• __slots__ no vacíos no funcionan para clases derivadas de tipos incorporados de “longitud variable” como int, bytes y tuple.

• Cualquier iterable sin cadena de caracteres puede ser asignado a __slots__. Mapeos también pueden ser utilizados; sin embargo, en el futuro, un significado especial puede ser asignado a los valores correspondientes para cada llave.

• La asignación __class__ funciona solo si ambas clases tienen el mismo __slots__.

• Herencia múltiple con múltiples clases de padres con espacios (slots) puede ser utilizada, pero solo un padre es permitido que tenga atributos creados por espacios (las otras bases deben tener diseños de espacios vacíos) - violaciones lanzan una excepción TypeError.

• Si un iterados es utilizado por __slots__, entonces un descriptor es creado para cada uno de los valores del iterador. Sin embargo, el atributo __slots__ será un iterador vacío.

3.3.3. Personalización de creación de clases

Siempre que una clase hereda de otra clase, __init_subclass__ es llamado en esa clase. De esta manera, es posible escribir clases que cambian el comportamiento de las subclases. Esto está estrechamente relacionado con los decoradores de clase, pero solo donde los decoradores de clase afectan a la clase específica a la que son aplicados, __init_subclass__ solo aplica a futuras subclases de la clase que define el método.

classmethod object.__init_subclass__(cls)

Este método es llamado siempre que la clase que lo contiene sea heredada. cls es entonces, la nueva subclase. Si se define como un método de instancia normal, éste es convertido de manera implícita a un método de clase.

Los argumentos de palabra clave que fueron dados a una nueva clase, son pasados a la clase __init_subclass__ del padre. Por temas de compatibilidad con otras clases que usan __init_subclass__, uno debería quitar los argumentos de palabra clave y pasar los otros a la clase base, como en:

class Philosopher:
    def __init_subclass__(cls, /, default_name, **kwargs):
        super().__init_subclass__(**kwargs)
        cls.default_name = default_name

class AustralianPhilosopher(Philosopher, default_name="Bruce"):
    pass

La implementación por defecto object.__init_subclass__ no hace nada, pero lanza un error si es llamado con cualquier argumento.

Nota

La sugerencia de metaclase metaclass es consumido por el resto de la maquinaria de tipos, y nunca se pasa a las implementaciones __init_subclass__. La clase meta actual (más que la sugerencia explícita) puede ser accedida como type(cls).

Nuevo en la versión 3.6.

Cuando se crea una clase, type.__new__() escanea las variables de clase y realiza retornos de llamada a aquellas con un gancho __set_name__().

object.__set_name__(self, owner, name)

Llamado automáticamente al momento en el que se crea la clase propietaria owner. El objeto es asignado a name en esa clase:

class A:
    x = C()  # Automatically calls: x.__set_name__(A, 'x')

Si la variable de clase se asigna después de crear la clase, __set_name__() no se llamará automáticamente. Si es necesario, __set_name__() se puede llamar directamente:

class A:
   pass

c = C()
A.x = c                  # The hook is not called
c.__set_name__(A, 'x')   # Manually invoke the hook

Ver Creando el objeto de clase para más detalles.

Nuevo en la versión 3.6.

3.3.3.1. Metaclases

Por defecto, las clases son construidas usando type(). El cuerpo de la clase es ejecutado en un nuevo espacio de nombres y el nombre de la clase es ligado de forma local al resultado de type(name, bases, namespace).

El proceso de creación de clase puede ser personalizado pasando el argumento de palabra clave metaclass en la línea de definición de la clase, o al heredar de una clase existente que incluya dicho argumento. En el siguiente ejemplo, ambos MyClass y MySubclass son instancias de Meta:

class Meta(type):
    pass

class MyClass(metaclass=Meta):
    pass

class MySubclass(MyClass):
    pass

Cualquier otro argumento de palabra clave que sea especificado en la definición de clase es pasado mediante todas las operaciones de metaclase descritas a continuación.

Cuando una definición de clase es ejecutada, los siguientes pasos ocurren:

• Entradas de la Orden de Resolución de Método (MRU) son resueltas;

• se determina la metaclase adecuada;

• se prepara el espacio de nombres de clase;

• se ejecuta el cuerpo de la clase;

• se crea el objeto de clase.

3.3.3.2. Resolviendo entradas de la Orden de Resolución de Métodos (MRU)

Si una base que aparece en la definición de una clase no es una instancia de type, entonces el método __mro_entries__ se busca en ella. Si es encontrado, se llama con la tupla de bases originales. Este método debe retornar una tupla de clases que será utilizado en lugar de esta base. La tupla puede estar vacía, en cuyo caso la base original es ignorada.

Ver también

PEP 560 - Soporte central para módulos de clasificación y tipos genéricos

3.3.3.3. Determinando la metaclase adecuada

La metaclase adecuada para la definición de una clase es determinada de la siguiente manera:

• si no se dan bases ni metaclases explícitas, entonces se utiliza type();

• si se da una metaclase explícita y no es una instancia de type(), entonces se utiliza directamente como la metaclase;

• si se da una instancia de type() como la metaclase explícita, o se definen bases, entonces se utiliza la metaclase más derivada.

La metaclase más derivada es elegida de la metaclase especificada explícitamente (si existe) y de la metaclase (p. ej. type(cls)) de todas las clases base especificadas.

3.3.3.4. Preparando el espacio de nombres de la clase

Una vez que se ha identificado la metaclase apropiada, entonces se prepara el espacio de nombres de la clase. Si la metaclase tiene un atributo __prepare__, es llamado como namespace = metaclass.__prepare__(name, bases, **kwds) (donde los argumentos de palabra clave adicionales, de existir, provienen de la definición de la clase). El método __prepare__ debe ser implementado como classmethod(). El espacio de nombres retornado por __prepare__ es pasado a __new__, pero cuando el objeto de clase final es creado, el espacio de nombres es copiado en un dict.

Si la metaclase no tiene atributo __prepare__, entonces el espacio de nombres de clase es iniciado como un mapeo vacío ordenado.

Ver también

PEP 3115 - Metaclases en Python 3000

Introduce el enlace de espacio de nombres __prepare__

3.3.3.5. Ejecutando el cuerpo de la clase

El cuerpo de la clase es ejecutado como exec(body, globals(), namespace) (aproximadamente). La diferencia clave con un llamado normal a exec() es que el alcance léxico permite que el cuerpo de la clase (incluyendo cualquier método) haga referencia a nombres de los alcances actuales y externos cuando la definición de clase sucede dentro de la función.

Sin embargo, aún cuando la definición de clase sucede dentro de la función, los métodos definidos dentro de la clase aún no pueden ver nombres definidos dentro del alcance de la clase. Variables de clase deben ser accedidas a través del primer parámetro de instancia o métodos de clase, o a través de la referencia al léxico implícito __class__ descrita en la siguiente sección.

3.3.3.6. Creando el objeto de clase

Una vez que el espacio de nombres de la clase ha sido poblado al ejecutar el cuerpo de la clase, el objeto de clase es creado al llamar metaclass(name, bases, namespace, **kwds) (las palabras clave adicionales que se pasan aquí, son las mismas que aquellas pasadas en __prepare__).

Este objeto de clase es el que será referenciado por la forma sin argumentos de super(). __class__ es una referencia de cierre implícita creada por el compilador si cualquier método en el cuerpo de una clase se refiere tanto a __class__ o super. Esto permite que la forma sin argumentos de super() identifique correctamente la clase definida en base al alcance léxico, mientras la clase o instancia que fue utilizada para hacer el llamado actual es identificado en base al primer argumento que se pasa al método.

CPython implementation detail: En CPython 3.6 y posterior, la celda __class__ se pasa a la metaclase como una entrada __classcell__ en el espacio de nombres de la clase. En caso de existir, esto debe ser propagado hacia el llamado type.__new__ para que la clase se inicie correctamente. No hacerlo resultará en un error RuntimeError en Python 3.8.

Cuando se utiliza la metaclase por defecto type, o cualquier metaclase que finalmente llama a type.__new__, los siguientes pasos de personalización adicional son invocados después de crear el objeto de clase:

1. El método type.__new__ recolecta todos los atributos en el espacio de nombres de la clase que definen un método __set_name__();

2. Esos métodos __set_name__ son llamados con la clase siendo definida y el nombre de ese atributo particular asignado;

3. El gancho __init_subclass__() llama al padre inmediato de la nueva clase en su orden de resolución del método.

Después de que el objeto de clase es creado, se pasa al decorador de clase incluido en su definición (si existe) y el objeto resultante es enlazado en el espacio de nombres local como la clase definida.

Cuando una nueva clase es creada por type.__new__, el objeto proporcionado como el parámetro de espacio de nombres es copiado a un trazado ordenado y el objeto original es descartado. La nueva copia es envuelta en un proxy de solo lectura, que se convierte en el atributo __dict__ del objeto de clase.

Ver también

PEP 3135 - Nuevo súper

Describe la referencia de cierre implícita __class__

3.3.3.7. Usos para metaclases

Los usos potenciales para metaclases son ilimitados. Algunas ideas que ya han sido exploradas incluyen enumeración, registros, revisión de interface, delegación automática, creación de propiedades automática, proxy, infraestructuras, y bloqueo/sincronización automática de recursos.

3.3.4. Personalizando revisiones de instancia y subclase

Los siguientes métodos son utilizados para anular el comportamiento por defecto de las funciones incorporadas isinstance() y issubclass().

En particular, la metaclase abc.ABCMeta implementa estos métodos para permitir la adición de Clases Base Abstractas (ABCs, por su nombre en inglés Abstract Base Clases) como “clases base virtuales” a cualquier clase o tipo (incluyendo tipos incorporados), incluyendo otros ABCs.

class.__instancecheck__(self, instance)

Retorna true si la instancia instance debe ser considerada una instancia (directa o indirecta) de clase class. De ser definida, es llamado para implementar isinstance(instance, class).

class.__subclasscheck__(self, subclass)

Retorna true si la subclase subclass debe ser considerada una subclase (directa o indirecta) de clase class. De ser definida, es llamado para implementar issubclass(subclass, class).

Tome en cuenta que estos métodos son buscados en el tipo (metaclase) de una clase. No pueden ser definidos como métodos de clase en la clase actual. Esto es consistente con la búsqueda de métodos especiales que son llamados en instancias, solo en este caso la instancia es por sí misma una clase.

Ver también

PEP 3119 - Introducción a Clases Base Abstractas (Abstract Base Classes)

Incluye la especificación para personalizar el comportamiento de isinstance() y issubclass() a través de __instancecheck__() y __subclasscheck__(), con motivación para esta funcionalidad en el contexto de agregar Clases Base Abstractas (ver el módulo abc) al lenguaje.

3.3.5. Emulando tipos genéricos

Uno puede implementar la sintaxis de clase genérica como lo especifica PEP 484 (por ejemplo List[int]) definiendo un método especial:

classmethod object.__class_getitem__(cls, key)

Retornar un objeto representando la especialización de una clase genérica por argumentos de tipo encontrados en key.

Este método es buscado en el objeto de clase mismo, y cuando es definido en el cuerpo de la clase, este método es un método de clase implícito. Tome en cuenta que este mecanismo es ante todo reservado para su uso con sugerencias de tipo (type hints), no se aconseja otro uso.

Ver también

PEP 560 - Soporte central para módulos de clasificación y tipos genéricos

3.3.6. Emulando objetos que se pueden llamar

object.__call__(self[, args...])

Es llamado cuando la instancia es “llamada” como una función; si este método es definido, x(arg1, arg2, …) es una clave corta para x.__call__(arg1, arg2, …).

3.3.7. Emulando tipos de contenedores

Los siguientes métodos pueden ser definidos para implementar objetos contenedores. Los contenedores son generalmente secuencias (como listas o tuplas) o mapeos (como diccionarios), pero también pueden representar otros contenedores. La primera colección de métodos es utilizada ya sea para emular una secuencia o para emular un mapeo; la diferencia es que para una secuencia, las llaves permitidas deben ser los enteros k por lo que 0 <= k < N donde N es la longitud de la secuencia, o secciones de objetos, los cuales definen un rango de elementos. También es recomendado que los mapeos proporcionen los métodos keys(), values(), items(), get(), clear(), setdefault(), pop(), popitem(), copy(), y update() comportándose de manera similar a aquellos para los objetos de diccionario estándar de Python. El módulo collections.abc proporciona una clase base abstracta MutableMapping que ayuda a crear aquellos métodos desde un conjunto base de __getitem__(), __setitem__(), __delitem__(), y keys(). Secuencias mutables deben proporcionar métodos append(), count(), index(), extend(), insert(), pop(), remove(), reverse() y sort(), como objetos de lista estándar de Python. Por último, tipos de secuencia deben implementar adición (concatenación) y multiplicación (repetición) al definir los métodos __add__(), __radd__(), __iadd__(), __mul__(), __rmul__() y __imul__() descritos a continuación; no deben definir otros operadores numéricos. Es recomendado que ambos mapeos y secuencias implementen el método __contains__() para permitir el uso eficiente del operador in; para mapeos, in debe buscar las llaves de los mapeos; para secuencias, debe buscar a través de los valores. Además es recomendado que tanto mapeos como secuencias implementen el método __iter__() para permitir una iteración eficiente por el contenedor; para mapeos, __iter__() debe iterar a través de las llaves del objeto; para secuencias, debe iterar a través de los valores.

object.__len__(self)

Es llamado para implementar la función incorporada len(). Debe retornar la longitud del objeto, un entero >= 0. También, un objeto que no define un método __bool__() y cuyo método __len__() retorna cero, es considerado como falso en un contexto booleano.

CPython implementation detail: En CPython, se requiere que la longitud sea como mucho sys.maxsize. Si la longitud es más grande que sys.maxsize algunas características (como len()) pueden lanzar una excepción OverflowError. Para prevenir lanzar una excepción OverflowError al validar la verdad de un valor, un objeto debe definir un método __bool__().

object.__length_hint__(self)

Es llamado para implementar operator.length_hint(). Debe retornar una longitud estimada para el objeto (que puede ser mayor o menor que la longitud actual). La longitud debe ser un entero >= 0. El valor de retorno también debe ser NotImplemented el cual es tratado de igual forma a que si el método __length_hint__ no existiera en absoluto. Este método es puramente una optimización y nunca es requerido para precisión.

Nuevo en la versión 3.4.

Nota

La segmentación se hace exclusivamente con los siguientes tres métodos. Un llamado como

a[1:2] = b

es traducido a

a[slice(1, 2, None)] = b

etcétera. Elementos faltantes de segmentos siempre son llenados con None.

object.__getitem__(self, key)

Es llamado para implementar la evaluación de self[key]. Para tipos de secuencia, las llaves aceptadas deben ser enteros y objetos de segmento. Se debe tomar en cuenta que la interpretación especial de índices negativos (si la clase desea emular un tipo de secuencia) depende del método __getitem__(). Si key es de un tipo apropiado, se puede lanzar una excepción TypeError; si es de un valor afuera de la colección de índices para la secuencia (después de alguna interpretación especial de valores negativos), se debe lanzar una excepción IndexError. Para tipos de mapeos, si falta key (no en el contenedor), la excepción KeyError debe ser lanzada.

Nota

ciclos for esperan que una excepción IndexError sea lanzada para que índices ilegales permitan la detección adecuada del fin de una secuencia.

object.__setitem__(self, key, value)

Es llamado para implementar la asignación a self[key]. Lo mismo con respecto a __getitem__(). Esto solo debe ser implementado para mapeos si los objetos permiten cambios a los valores de las llaves, o si nuevas llaves pueden ser añadidas, o para secuencias si los elementos pueden ser reemplazados. Las mismas excepciones deben ser lanzadas para valores de key inadecuados con respecto al método __getitem__().

object.__delitem__(self, key)

Es llamado para implementar el borrado de self[key]. Lo mismo con respecto a __getitem__(). Esto solo debe ser implementado para mapeos si los objetos permiten el borrado de llaves, o para secuencias si los elementos pueden ser eliminados de la secuencia. Las mismas excepciones deben ser lanzadas por valores de key inapropiados con respecto al método __getitem__().

object.__missing__(self, key)

Es llamado por dict.__getitem__() para implementar self[key] para subclases de diccionarios cuando la llave no se encuentra en el diccionario.

object.__iter__(self)

Este método es llamado cuando se requiere un iterador para un contenedor. Este método debe retornar un nuevo objeto iterador que pueda iterar todos los objetos del contenedor. Para mapeos, debe iterar sobre las llaves del contenedor.

Objetos iteradores también necesitan implementar este método; son requeridos para retornarse a sí mismos. Para mayor información sobre objetos iteradores, ver Tipos de iteradores.

object.__reversed__(self)

Es llamado (si existe) por la función incorporada reversed() para implementar una interacción invertida. Debe retornar un nuevo objeto iterador que itere sobre todos los objetos en el contenedor en orden inverso.

Si el método __reversed__() no es proporcionado, la función incorporada reversed() recurrirá a utilizar el protocolo de secuencia (__len__() y __getitem__()). Objetos que permiten el protocolo de secuencia deben únicamente proporcionar __reversed__() si no pueden proporcionar una implementación que sea más eficiente que la proporcionada por reversed().

Los operadores de prueba de pertenencia (in and not in) son normalmente implementados como una iteración sobre un contenedor. Sin embargo, los objetos de contenedor pueden proveer el siguiente método especial con una implementación más eficiente, que tampoco requiere que el objeto sea iterable.

object.__contains__(self, item)

Es llamado para implementar operadores de prueba de pertenencia. Deben retornar true si item se encuentra en self, de lo contrario false. Para objetos de mapeo, estos debe considerar las llaves del mapeo en lugar de los valores o los pares de llave-valor.

Para objetos que no definen __contains__(), la prueba de pertenencia primero intenta la iteración a través de __iter__(), y luego el antiguo protocolo de iteración de secuencia a través de __getitem__(), ver esta sección en la referencia del lenguaje.

3.3.8. Emulando tipos numéricos

Los siguientes métodos pueden ser definidos para emular objetos numéricos. Métodos que corresponden a operaciones que no son permitidas por el número particular implementado (por ejemplo, operaciones bit a bit para números no enteros) se deben dejar sin definir.

object.__add__(self, other)

object.__sub__(self, other)

object.__mul__(self, other)

object.__matmul__(self, other)

object.__truediv__(self, other)

object.__floordiv__(self, other)

object.__mod__(self, other)

object.__divmod__(self, other)

object.__pow__(self, other[, modulo])

object.__lshift__(self, other)

object.__rshift__(self, other)

object.__and__(self, other)

object.__xor__(self, other)

object.__or__(self, other)

Estos métodos son llamados para implementar las operaciones aritméticas binarias (+, -, *, @, /, //, %, divmod(), pow(), **, <<, >>, &, ^, |). Por ejemplo, para evaluar la expresión x + y, donde x es instancia de una clase que tiene un método __add__(), x.__add__(y) es llamado. El método __divmod__() debe ser el equivalente a usar __floordiv__() y __mod__(); no debe ser relacionado a __truediv__(). Se debe tomar en cuenta que __pow__() debe ser definido para aceptar un tercer argumento opcional si la versión ternaria de la función incorporada pow() es soportada.

Si alguno de esos métodos no permiten la operación con los argumentos suministrados, debe retornar NotImplemented.

object.__radd__(self, other)

object.__rsub__(self, other)

object.__rmul__(self, other)

object.__rmatmul__(self, other)

object.__rtruediv__(self, other)

object.__rfloordiv__(self, other)

object.__rmod__(self, other)

object.__rdivmod__(self, other)

object.__rpow__(self, other[, modulo])

object.__rlshift__(self, other)

object.__rrshift__(self, other)

object.__rand__(self, other)

object.__rxor__(self, other)

object.__ror__(self, other)

Estos métodos son llamados para implementar las operaciones aritméticas binarias (+, -, *, @, /, //, %, divmod(), pow(), **, <<, >>, &, ^, |) con operandos reflejados (intercambiados). Estas funciones son llamadas únicamente si el operando izquierdo no soporta la operación correspondiente 3 y los operandos son de tipos diferentes. 4 Por ejemplo, para evaluar la expresión x - y, donde y es instancia de una clase que tiene un método __rsub__(), y.__rsub__(x) es llamado si x.__sub__(y) retorna NotImplemented.

Se debe tomar en cuenta que la función ternaria pow() no intentará llamar a __rpow__() (las reglas de coerción se volverían demasiado complicadas).

Nota

Si el tipo del operando de la derecha es una subclase del tipo del operando de la izquierda y esa subclase proporciona el método reflejado para la operación, este método será llamado antes del método no reflejado del operando izquierdo. Este comportamiento permite que las subclases anulen las operaciones de sus predecesores.

object.__iadd__(self, other)

object.__isub__(self, other)

object.__imul__(self, other)

object.__imatmul__(self, other)

object.__itruediv__(self, other)

object.__ifloordiv__(self, other)

object.__imod__(self, other)

object.__ipow__(self, other[, modulo])

object.__ilshift__(self, other)

object.__irshift__(self, other)

object.__iand__(self, other)

object.__ixor__(self, other)

object.__ior__(self, other)

Estos métodos son llamados para implementar las asignaciones aritméticas aumentadas (+=, -=, *=, @=, /=, //=, %=, **=, <<=, >>=, &=, ^=, |=). Estos métodos deben intentar realizar la operación in-place (modificando self) y retornar el resultado (que puede, pero no tiene que ser self). Si un método específico no es definido, la asignación aumentada regresa a los métodos normales. Por ejemplo, si x es la instancia de una clase con el método __iadd__(), x += y es equivalente a x = x.__iadd__(y). De lo contrario x.__add__(y) y y.__radd__(x) se consideran al igual que con la evaluación de x + y. En ciertas situaciones, asignaciones aumentadas pueden resultar en errores no esperados (ver ¿Por qué hacer lo siguiente, a_tuple[i] += ['item'], lanza una excepción cuando la suma funciona?), pero este comportamiento es en realidad parte del modelo de datos.

object.__neg__(self)

object.__pos__(self)

object.__abs__(self)

object.__invert__(self)

Es llamado para implementar las operaciones aritméticas unarias (-, +, abs() and ~).

object.__complex__(self)

object.__int__(self)

object.__float__(self)

Es llamado para implementar las funciones incorporadas complex(), int() y float(). Debe retornar un valor del tipo apropiado.

object.__index__(self)

Es llamado para implementar operator.index(), y cuando sea que Python necesite convertir sin pérdidas el objeto numérico a un objeto entero (tal como en la segmentación o slicing, o las funciones incorporadas bin(), hex() y oct()). La presencia de este método indica que el objeto numérico es un tipo entero. Debe retornar un entero.

Si __int__(), __float__() y __complex__() no son definidos, entonces todas las funciones incorporadas correspondientes int(), float() y complex() vuelven a __index__().

object.__round__(self[, ndigits])

object.__trunc__(self)

object.__floor__(self)

object.__ceil__(self)

Es llamado para implementar la función incorporada round() y las funciones math trunc(), floor() y ceil(). A menos que ndigits sea pasado a __round__() todos estos métodos deben retornar el valor del objeto truncado a Integral (normalmente int).

Si __int__() no es definido, entonces la función incorporada int() regresa a __trunc__().

3.3.9. Gestores de Contexto en la Declaración with

Un context manager es un objeto que define el contexto en tiempo de ejecución a ser establecido cuando se ejecuta una declaración with. El gestor de contexto maneja la entrada y la salida del contexto en tiempo de ejecución deseado para la ejecución del bloque de código. Los gestores de contexto son normalmente invocados utilizando la declaración with (descritos en la sección La sentencia with), pero también pueden ser utilizados al invocar directamente sus métodos.

Usos típicos de los gestores de contexto incluyen guardar y restablecer diversos tipos de declaraciones globales, bloquear y desbloquear recursos, cerrar archivos abiertos, etc.

Para más información sobre gestores de contexto, ver Tipos Gestores de Contexto.

object.__enter__(self)

Ingresa al contexto en tiempo de ejecución relacionado con este objeto. La declaración with ligará el valor de retorno de este método al objetivo especificado en cláusula as de la declaración, en caso de existir.

object.__exit__(self, exc_type, exc_value, traceback)

Sale del contexto en tiempo de ejecución relacionado a este objeto. Los parámetros describen la excepción que causa la salida del contexto. Si éste se termina sin excepción, los tres argumentos serán None.

Si se proporciona una excepción, y el método desea eliminarla (por ejemplo, prevenir que sea propagada), debe retornar un valor verdadero. De lo contrario, la excepción será procesada de forma normal al salir de este método.

Se debe tomar en cuenta que los métodos __exit__() no deben lanzar de nuevo la excepción que se pasa; esto es la responsabilidad de quien hace el llamado.

Ver también

PEP 343 - La declaración “with”

La especificación, el antecedente, y los ejemplos para la declaración de Python with.

3.3.10. Personalización de argumentos posicionales en la coincidencia de patrones de clase

Cuando se usa un nombre de clase en un patrón, los argumentos posicionales en el patrón no están permitidos de forma predeterminada, es decir, case MyClass(x, y) generalmente no es válido sin soporte especial en MyClass. Para poder usar ese tipo de patrones, la clase necesita definir un atributo __match_args__.

object.__match_args__

A esta variable de clase se le puede asignar una tupla de cadenas. Cuando esta clase se utiliza en un patrón de clase con argumentos posicionales, cada argumento posicional se convertirá en un argumento de palabra clave, utilizando el valor correspondiente en __match_args__ como palabra clave. La ausencia de este atributo es equivalente a establecerlo en ().

Por ejemplo, si MyClass.__match_args__ es ("left", "center", "right") eso significa que case MyClass(x, y) es equivalente a case MyClass(left=x, center=y). Ten en cuenta que el número de argumentos en el patrón debe ser menor o igual que el número de elementos en __match_args__; si es más grande, el intento de coincidencia de patrón producirá un TypeError.

Nuevo en la versión 3.10.

Ver también

PEP 634 - Coincidencia de patrones estructurales

La especificación para la declaración match de Python.

3.3.11. Búsqueda de método especial

Para clases personalizadas, invocaciones implícitas de métodos especiales solo están garantizados para trabajar correctamente si son definidos en un tipo de objeto, no en el diccionario de instancia del objeto. Ese comportamiento es la razón por la que el siguiente código lanza una excepción:

>>> class C:
...     pass
...
>>> c = C()
>>> c.__len__ = lambda: 5
>>> len(c)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: object of type 'C' has no len()

La razón fundamental detrás de este comportamiento yace en una serie de métodos especiales como __hash__() y __repr__() que son implementados por todos los objetos, incluyendo objetos de tipo. Si la búsqueda implícita de estos métodos usaran el proceso de búsqueda convencional, fallarían al ser invocados en el objeto de tipo mismo:

>>> 1 .__hash__() == hash(1)
True
>>> int.__hash__() == hash(int)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: descriptor '__hash__' of 'int' object needs an argument

Intentar invocar de manera incorrecta el método no ligado de una clase de esta forma a veces es denominado como ‘confusión de metaclase’, y se evita sobrepasando la instancia al buscar métodos especiales:

>>> type(1).__hash__(1) == hash(1)
True
>>> type(int).__hash__(int) == hash(int)
True

Además de sobrepasar cualquier atributo de instancia en aras de lo apropiado, la búsqueda implícita del método especial generalmente también sobrepasa al método __getattribute__() incluso de la metaclase del objeto:

>>> class Meta(type):
...     def __getattribute__(*args):
...         print("Metaclass getattribute invoked")
...         return type.__getattribute__(*args)
...
>>> class C(object, metaclass=Meta):
...     def __len__(self):
...         return 10
...     def __getattribute__(*args):
...         print("Class getattribute invoked")
...         return object.__getattribute__(*args)
...
>>> c = C()
>>> c.__len__()                 # Explicit lookup via instance
Class getattribute invoked
10
>>> type(c).__len__(c)          # Explicit lookup via type
Metaclass getattribute invoked
10
>>> len(c)                      # Implicit lookup
10

Sobrepasar el mecanismo de __getattribute__() de esta forma proporciona un alcance importante para optimizaciones de velocidad dentro del intérprete, a costa de cierta flexibilidad en el manejo de métodos especiales (el método especial debe ser establecido en el objeto de clase mismo para ser invocado consistentemente por el intérprete).

3.4. Corrutinas

3.4.1. Objetos Esperables

Un objeto awaitable generalmente implementa a un método __await__(). Objetos Coroutine retornados a partir de funciones async def son esperables.

Nota

Los objetos generator iterator retornados a partir de generadores decorados con types.coroutine() o asyncio.coroutine() también son esperables, pero no implementan __await__().

object.__await__(self)

Debe retornar un iterator. Debe ser utilizado para implementar objetos awaitable. Por ejemplo, asyncio.Future implementa este método para ser compatible con la expresión await.

Nuevo en la versión 3.5.

Ver también

PEP 492 para información adicional sobre objetos esperables.

3.4.2. Objetos de Corrutina

Objetos Coroutine son objetos awaitable. La ejecución de una corrutina puede ser controlada llamando __await__() e iterando sobre el resultado. Cuando la corrutina ha terminado de ejecutar y retorna, el iterados lanza una excepción StopIteration, y el atributo value de dicha excepción mantiene el valor de retorno. Si la corrutina lanza una excepción, ésta es propagada por el iterador. Las corrutinas no deben lanzar directamente excepciones StopIteration no manejadas.

Las corrutinas también tienen los métodos mencionados a continuación, los cuales son análogos a los de los generadores. (ver Métodos generador-iterador). Sin embargo, a diferencia de los generadores, las corrutinas no soportan directamente iteración.

Distinto en la versión 3.5.2: Es un error RuntimeError esperar a una corrutina más de una vez.

coroutine.send(value)

Inicia o continua la ejecución de una corrutina. Si value es None, esto es equivalente a avanzar al iterador retornado por __await__(). Si value no es None, este método delega al método send() del iterador que causó la suspensión de la corrutina. El resultado (el valor de retorno, StopIteration, u otra excepción) es el mismo que cuando se itera sobre el valor de retorno de __await__(), descrito anteriormente.

coroutine.throw(type[, value[, traceback]])

Lanza la excepción especificada en la corrutina. Este método delega a throw() del iterador que causó la suspensión de la corrutina, si dicho método existe. De lo contrario, la excepción es lanzada al punto de la suspensión. El resultado (valor de retorno, StopIteration, u otra excepción) es el mismo que cuando se itera sobre el valor de retorno de __await__() descrito anteriormente. Si la excepción no es obtenida en la corrutina, ésta se propaga de regreso a quien realizó el llamado.

coroutine.close()

Causa que la corrutina misma se borre a sí misma y termine su ejecución. Si la corrutina es suspendida, este método primero delega a close(), si existe, del iterador que causó la suspensión de la corrutina. Luego lanza una excepción GeneratorExit en el punto de suspensión, causando que la corrutina se borre a sí misma. Finalmente, la corrutina es marcada como completada, aún si nunca inició.

Objetos de corrutina son cerrados automáticamente utilizando el proceso anterior cuando están a punto de ser destruidos.

3.4.3. Iteradores asíncronos

Un iterador asíncrono puede llamar código asíncrono en su método __anext__.

Iteradores asíncronos pueden ser utilizados en la declaración async for.

object.__aiter__(self)

Debe retornar un objeto de iterador asíncrono.

object.__anext__(self)

Debe retornar un esperable (awaitable) resultante en el siguiente valor del iterador. Debe levantar una excepción StopAsyncIteration cuando la iteración termina.

Un ejemplo de objeto iterable asíncrono:

class Reader:
    async def readline(self):
        ...

    def __aiter__(self):
        return self

    async def __anext__(self):
        val = await self.readline()
        if val == b'':
            raise StopAsyncIteration
        return val

Nuevo en la versión 3.5.

Distinto en la versión 3.7: Antes de Python 3.7, __aiter__ podía retornar un esperable que se resolvería en un asynchronous iterator.

A partir de Python 3.7, __aiter__ debe retornar un objeto iterador asíncrono. Retornar cualquier otra cosa resultará en un error TypeError.

3.4.4. Gestores de Contexto Asíncronos

Un gestor de contexto asíncrono es un gestor de contexto que puede suspender la ejecución en sus métodos __aenter__ y __aexit__.

Los gestores de contexto asíncronos pueden ser utilizados en una declaración async with.

object.__aenter__(self)

Semánticamente similar a __enter__(), siendo la única diferencia que debe retorna un esperable.

object.__aexit__(self, exc_type, exc_value, traceback)

Semánticamente similar a __exit__(), siendo la única diferencia que debe retornar un esperable.

Un ejemplo de una clase de gestor de contexto asíncrono:

class AsyncContextManager:
    async def __aenter__(self):
        await log('entering context')

    async def __aexit__(self, exc_type, exc, tb):
        await log('exiting context')

Nuevo en la versión 3.5.

Notas a pie de página

1

Es posible cambiar en algunos casos un tipo de objeto bajo ciertas circunstancias controladas. Generalmente no es buena idea, ya que esto puede llevar a un comportamiento bastante extraño de no ser tratado correctamente.

2

Los métodos __hash__(), __iter__(), __reversed__(), y __contains__() tienen manejo especial para esto; otros lanzarán un error TypeError, pero lo harán dependiendo del comportamiento de que None no se puede llamar.

3

“No soporta” aquí significa que la clase no tiene tal método, o el método retorna NotImplemented. No establecer el método a None si se quiere forzar el retroceso al método reflejado del operando correcto—eso, por el contrario, tendrá un efecto opuesto de bloquear explícitamente dicho retroceso.

4

Para operandos del mismo tipo, se asume que si el método no reflejado (como __add__()) falla, la operación no es soportada, por lo cual el método reflejado no es llamado.