Prácticas recomendadas para las anotaciones#

autor: Larry Hastings

Resumen#

Este documento se designó para encapsular las prácticas recomendadas para trabajar con diccionarios de anotaciones. Si escribe código Python que examina "annotations" en objetos Python, recomendamos seguir las pautas que se describen a continuación.

El documento se organizó en 4 secciones: prácticas recomendadas para acceder a las anotaciones de un objeto en las versiones de Python 3.10 y posteriores, prácticas recomendadas para acceder a las anotaciones de un objeto en las versiones de Python 3.9 y anteriores, otras prácticas recomendadas para "annotations" que aplican a cualquier versión de Python y peculiaridades de "annotations".

Tome en cuenta que este documento trabaja específicamente con "annotations", no usarlo para anotaciones. Si está buscando información sobre cómo usar "anotaciones de tipado" en su código, consulte el módulo "typing".

Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3.10 y posteriores#

Python 3.10 adds a new function to the standard library: "inspect.get_annotations()". In Python versions 3.10 through 3.13, calling this function is the best practice for accessing the annotations dict of any object that supports annotations. This function can also "un-stringize" stringized annotations for you.

In Python 3.14, there is a new "annotationlib" module with functionality for working with annotations. This includes a "annotationlib.get_annotations()" function, which supersedes "inspect.get_annotations()".

Si por alguna razón "inspect.get_annotations()" no es viable para su caso de uso, puede acceder manualmente al miembro de datos "annotations". La práctica recomendada para esto también cambió en Python 3.10: a partir de Python 3.10, se garantiza que "o.annotations" siempre opere en funciones, clases y módulos de Python. Si está seguro de que el objeto que está examinando es uno de los tres objetos específicos, puede usar simplemente "o.annotations" para obtener el diccionario de anotaciones del objeto.

Sin embargo, otros tipos de llamadas -- por ejemplo, invocables creados por "functools.partial()" -- pueden no tener definido un atributo "annotations". Al acceder a "annotations" de un objeto posiblemente desconocido, la práctica recomendada de las versiones de Python 3.10 y posteriores es llamar "getattr()" con tres argumentos, por ejemplo "getattr(o, 'annotations', None)".

Antes de Python 3.10, acceder a "annotations" en una clase que no define anotaciones pero que tiene una clase padre con anotaciones devolvería las anotaciones de la clase padre. En Python 3.10 y versiones posteriores, las anotaciones de la clase hija serán un diccionario vacío en su lugar.

Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3.9 y anteriores#

En versiones de Python 3.9 y anteriores, acceder al diccionario de anotaciones de un objeto es mucho más complicado que en versiones más recientes. El problema es un defecto de diseño en estas versiones anteriores de Python, específicamente relacionado con las anotaciones de clase.

La práctica recomendada para acceder al diccionario de anotaciones de otros objetos -- funciones, otros invocables y módulos -- es la misma que la de la 3.10, asumiendo que no está llamando "inspect.get_annotations()": debe usar tres argumentos de "getattr()" para acceder al atributo "annotations" del objeto.

Desafortunadamente, esta no es la mejor práctica para las clases. El problema es que, dado que "annotations" es opcional en las clases, y debido a que las clases pueden heredar atributos desde sus clases base, acceder al atributo "annotations" de una clase puede retornar por inadvertencia el diccionario de anotaciones de una clase base. Como ejemplo:

class Base: a: int = 3 b: str = 'abc'

class Derived(Base): pass

print(Derived.annotations)

Esto imprimirá el diccionario de anotaciones de "Base", no de "Derived".

Su código deberá tener una ruta de código separada si el objeto que está examinando es una clase ("isinstance(o, type)"). En este caso, la práctica recomendada se basa en un detalle de implementación de las versiones de Python 3.9 y anteriores: si una clase tiene anotaciones definidas, se almacenan en el diccionario "dict" de la clase. Dado que la clase puede o no tener anotaciones definidas, la mejor práctica es llamar al método "get()" en el diccionario de la clase.

Para ponerlo todo junto, aquí hay un código de muestra que accede de forma segura al atributo "annotations" en un objeto arbitrario en las versiones de Python 3.9 y anteriores:

if isinstance(o, type): ann = o.dict.get('annotations', None) else: ann = getattr(o, 'annotations', None)

Después de ejecutar este código, "ann" debería ser un diccionario o "None". Recomendamos que vuelva a verificar el tipo de "ann" usando "isinstance()" antes de un examen más detenido.

Tome en cuenta que algunos objetos de tipo exótico o con formato incorrecto pueden no tener un atributo "dict" , así que para mayor seguridad, también puede usar "getattr()" para acceder a "dict".

Desencadenamiento manual de anotaciones en cadena#

En situaciones donde algunas anotaciones pueden estar "encadenadas", y desea evaluar esas cadenas de caracteres para producir los valores de Python que representan, lo mejor es llamar a "inspect.get_annotations()" para que haga este trabajo por usted.

Si está usando la versión de Python 3.9 o anterior, o si por alguna razón no puede usar "inspect.get_annotations()", necesitará duplicar su lógica. Recomendamos que examine la implementación de "inspect.get_annotations()" en la versión actual de Python y siga un enfoque similar.

En pocas palabras, si desea evaluar una anotación en cadena en un objeto arbitrario "o":

• Si "o" es un módulo, use "o.dict" como "globals" cuando llame a "eval()".

• Si "o" es una clase, use "sys.modules[o.module].dict" como "globals" y "dict(vars(o))" como "locals" cuando llame a "eval()".

• If "o" is a wrapped callable using "functools.update_wrapper()", "@functools.wraps", or "functools.partial()", iteratively unwrap it by accessing either "o.wrapped" or "o.func" as appropriate, until you have found the root unwrapped function.

• Si "o" es un invocable (pero no una clase), use "o.globals" como globales cuando llame a "eval()".

Sin embargo, no todos los valores de cadena de caracteres usados como anotaciones se pueden convertir correctamente en valores de Python mediante "eval()". Los valores de cadena de caracteres pueden contener, teóricamente, cualquier cadena de caracteres válida, y en la práctica, hay varios casos de uso válidos para anotaciones de tipo que requieren anotaciones con valores de cadena de caracteres que no pueden evaluarse específicamente. Por ejemplo:

• PEP 604 introduce tipos de unión usando "|", antes de que se agregara soporte para esto en Python 3.10.

• Las definiciones que no son necesarias en tiempo de ejecución, sólo se importan cuando "typing.TYPE_CHECKING" es verdadero.

Si "eval()" intenta evaluar tales valores, fallará y lanzará una excepción. Por lo tanto, al diseñar una API de biblioteca que funcione con anotaciones, se recomienda sólo intentar evaluar valores de cadena de caracteres cuando la llamada lo solicite explícitamente.

Prácticas recomendadas para "annotations" en cualquier versión de Python#

• Debe evitar asignar directamente al miembro "annotations" de objetos. Deje que Python administre la configuración "annotations".

• Si asigna directamente al miembro "annotations" de un objeto, siempre debe establecerlo en un objeto "dict".

• You should avoid accessing "annotations" directly on any object. Instead, use "annotationlib.get_annotations()" (Python 3.14+) or "inspect.get_annotations()" (Python 3.10+).

• If you do directly access the "annotations" member of an object, you should ensure that it's a dictionary before attempting to examine its contents.

• Debe evitar modificar los diccionarios "annotations".

• Debe evitar eliminar el atributo "annotations" de un objeto.

Peculiaridades de "annotations"#

En todas las versiones de Python 3, los objetos de función crean de forma diferida un diccionario de anotaciones si no hay anotaciones definidas en ese objeto. Puede eliminar el atributo "annotations" usando "del fn.annotations", pero si luego accede a "fn.annotations", el objeto creará un diccionario nuevo vacío que almacenará y retornará como sus anotaciones. Eliminar las anotaciones en una función antes de que haya creado su diccionario de anotaciones de forma diferida arrojará un "AttributeError"; el uso de dos veces seguidas de "del fn.annotations" garantiza que siempre arroje un "AttributeError".

Todo en el párrafo anterior también se aplica a los objetos de clase y módulo en las versiones de Python 3.10 y posteriores.

En todas las versiones de Python 3, puede establecer "annotations" en un objeto de función en "None". Sin embargo, al acceder después a las anotaciones en ese objeto usando "fn.annotations" se creará un diccionario vacío de forma diferida según el primer párrafo de esta sección. Esto no es cierto para módulos y clases, en cualquier versión de Python; esos objetos permiten establecer "annotations" en cualquier valor de Python, y conservarán cualquier valor que se establezca.

Si Python encadena sus anotaciones por usted (usando "from future import annotations"), y especifica una cadena de caracteres como una anotación, la cadena de caracteres en sí se citará. En efecto, la anotación se cita dos veces. Por ejemplo:

from future import annotations def foo(a: "str"): pass

print(foo.annotations)

Esto imprime "{'a': "'str'"}". En realidad, esto no debería considerarse una "peculiaridad"; aquí se menciona simplemente porque podría sorprenderle.

If you use a class with a custom metaclass and access "annotations" on the class, you may observe unexpected behavior; see 749 for some examples. You can avoid these quirks by using "annotationlib.get_annotations()" on Python 3.14+ or "inspect.get_annotations()" on Python 3.10+. On earlier versions of Python, you can avoid these bugs by accessing the annotations from the class's "dict" (for example, "cls.dict.get('annotations', None)").

In some versions of Python, instances of classes may have an "annotations" attribute. However, this is not supported functionality. If you need the annotations of an instance, you can use "type()" to access its class (for example, "annotationlib.get_annotations(type(myinstance))" on Python 3.14+).