El método __prepare__ fue introducido en Python 3.0 a través de PEP 3115 para abordar limitaciones fundamentales en el protocolo de creación de clases. Antes de este cambio, el espacio de nombres utilizado durante la ejecución del cuerpo de la clase siempre era un diccionario estándar, sin forma de preservar el orden de declaración de atributos o interceptar asignaciones mientras ocurrían. Esto se volvió particularmente problemático para los desarrolladores que construían ORMs y bibliotecas de serialización que necesitaban rastrear la secuencia de declaraciones de campos sin recurrir a un análisis frágil del código fuente.
Cuando Python ejecuta un cuerpo de clase, llena un mapeo de espacio de nombres que eventualmente se convertirá en el __dict__ de la clase. El tipo dict por defecto no garantiza el orden de inserción en versiones anteriores de Python y carece de ganchos para validar o transformar nombres en el momento en que son definidos. Los desarrolladores que requieren restricciones en tiempo de declaración—como prohibir ciertos patrones de nombramiento o rastrear el orden de campos para protocolos binarios—no tenían un mecanismo limpio para engancharse en esta fase específica de construcción de clases antes de que el objeto de clase fuera finalizado.
Al implementar __prepare__ como un método estático en una metaclase, puedes devolver un mapeo mutable personalizado (como collections.OrderedDict o un diccionario validador personalizado) que sirva como espacio de nombres. Este mapeo captura todas las asignaciones a nivel de clase durante la ejecución del cuerpo, permitiendo el preprocesamiento antes de que el método __new__ de la metaclase finalice la clase. El espacio de nombres personalizado se pasa a __new__, donde puede ser convertido en un dict estándar o preservado para acceso ordenado.
from collections import OrderedDict class OrderPreservingMeta(type): @staticmethod def __prepare__(name, bases, **kwargs): return OrderedDict() def __new__(mcs, name, bases, namespace, **kwargs): ordered_attrs = list(namespace.keys()) cls = super().__new__(mcs, name, bases, dict(namespace)) cls._declaration_order = ordered_attrs return cls class Schema(metaclass=OrderPreservingMeta): id = 1 name = "test" value = 3.14 print(Schema._declaration_order) # ['id', 'name', 'value']
Una plataforma de negociación financiera necesitaba generar formatos de mensajes binarios donde el orden de los campos en el encabezado del protocolo coincidiera estrictamente con el orden de declaración en la definición de clase de mensaje de Python. Reordenar los campos rompería la compatibilidad con analizadores legados de C++ en el lado de la bolsa, provocando rechazos de operaciones o caídas del sistema.
Solución A: Indexación manual. Los desarrolladores anotarían cada campo con un número de secuencia como field_order = 1. Este enfoque es explícito y fácil de entender para principiantes. Sin embargo, viola el principio DRY y se convierte en una carga de mantenimiento durante el refactoring, ya que insertar un campo en medio requiere renumerar todos los campos subsiguientes.
Solución B: Análisis de código fuente. El marco podría usar el módulo AST para analizar el código fuente de la definición de la clase y extraer el orden de asignación. Esto funciona sin la complejidad de la metaclase. Desafortunadamente, falla por completo cuando los archivos fuente no están disponibles en tiempo de ejecución, como en distribuciones binarias congeladas o implementaciones optimizadas de CPython que eliminan el código fuente.
Solución C: Metaclase con __prepare__. Al devolver un OrderedDict de __prepare__, la metaclase captura automáticamente el orden natural de declaración. Esto es robusto en todos los escenarios de implementación y transparente para los usuarios finales. El único inconveniente es la complejidad adicional de comprender el protocolo de metaclase de Python, que requiere conocimientos de nivel senior.
Solución elegida: El equipo eligió la Solución C porque proporciona garantías en tiempo de definición sin sobrecarga en tiempo de ejecución por instancia de mensaje. Funciona de manera confiable en todos los entornos de implementación, incluidos aquellos sin código fuente, y mantiene la sintaxis natural de clase que los desarrolladores esperan mientras hace cumplir las restricciones en la etapa más temprana posible.
Resultado: La biblioteca de mensajes mantuvo automáticamente la compatibilidad con el formato de red. Los desarrolladores escribieron definiciones de clase naturales y el sistema generó diseños binarios correctos. Las jerarquías de herencia preservaron correctamente el orden de los campos padre antes de los campos hijo, resolviendo un problema complejo en la especificación del protocolo de negociación sin intervención manual.
Pregunta 1: ¿Por qué debe definirse __prepare__ como un @staticmethod (o @classmethod) en lugar de un método de instancia regular, y qué error ocurre si omites este decorador?
Respuesta: __prepare__ se invoca antes de que se cree la instancia de la metaclase, lo que significa que no hay cls o self disponible para enlazar aún. Python llama a __prepare__ para generar el espacio de nombres que se pasará a __new__. Si se define como un método de instancia regular que espera self, Python generará un TypeError indicando que la función toma argumentos posicionales pero no se dio ninguno, porque el mecanismo intenta llamarlo solo con el nombre, las bases y los argumentos clave. Debe ser un método estático para ser llamado sin enlace implícito del primer argumento, aunque classmethod funciona si necesitas acceso a la metaclase misma.
Pregunta 2: ¿Puede __prepare__ devolver un mapeo que no sea una subclase de dict, y qué protocolo específico debe cumplir para funcionar correctamente durante la ejecución del cuerpo de la clase?
Respuesta: Sí, puede devolver cualquier mapeo mutable que implemente el protocolo de la clase base abstracta MutableMapping, requiriendo específicamente __setitem__, __getitem__, __contains__, y idealmente __iter__ o keys() para la conversión. Sin embargo, el mapeo no necesita heredar de dict. El requisito crítico es que debe aceptar claves de cadena y valores arbitrarios, comportándose como un diccionario durante la asignación de atributos en el cuerpo de la clase. Después de la ejecución de la clase, la metaclase __new__ recibe este mapeo; si no es una subclase de dict, debes convertirlo explícitamente (por ejemplo, dict(namespace)) antes de llamar a super().__new__, ya que el __dict__ del objeto de clase resultante debe ser un diccionario.
Pregunta 3: ¿Cómo maneja __prepare__ los argumentos clave pasados en el encabezado de definición de clase (por ejemplo, class MyClass(metaclass=Meta, strict=True)), y qué sucede si no se avanzan adecuadamente?
Respuesta: Los argumentos clave en el encabezado de la clase (más allá de metaclass) se pasan a __prepare__ como **kwds. Si __prepare__ no acepta **kwargs (o argumentos nombrados específicos), Python generará un TypeError indicando que __prepare__ recibió un argumento clave inesperado. Este es un obstáculo común al agregar opciones de configuración a las metaclases. La firma del método debe ser __prepare__(name, bases, **kwargs) para ser compatible hacia adelante. Estos términos también se pasan posteriormente a __new__ y __init__, permitiendo que la metaclase reciba configuración en el momento de preparación para personalizar el comportamiento del espacio de nombres (por ejemplo, eligiendo entre modos de validación estrictos y flexibles).