Метод __prepare__ был введен в Python 3.0 через PEP 3115 для решения основных ограничений в протоколе создания классов. До этого изменения пространство имен, используемое во время выполнения тела класса, всегда было стандартным словарем, не предоставляя способа сохранить порядок объявления атрибутов или перехватить присвоения в момент их появления. Это стало особенно проблематичным для разработчиков, создающих ORM и библиотеки сериализации, которым нужно было отслеживать последовательность объявлений полей, не прибегая к ненадежному парсингу исходного кода.
Когда Python выполняет тело класса, оно заполняет отображение пространства имен, которое в конечном итоге станет классом __dict__. Стандартный тип dict не гарантирует порядок вставки в старых версиях Python и не имеет хуков для проверки или преобразования имен в момент их определения. Разработчикам, которым требовались ограничения времени объявления, такие как запрет определенных шаблонов именования или отслеживание порядка полей для бинарных протоколов, не было чистого механизма, чтобы вмешаться в эту специфическую фазу создания класса до того, как объект класса был финализирован.
Путем реализации __prepare__ как статического метода в метаклассе вы можете вернуть настраиваемое изменяемое отображение (например, collections.OrderedDict или пользовательский проверяющий словарь), которое будет служить в качестве пространства имен. Это отображение захватывает все присвоения на уровне класса во время выполнения тела, позволяя предварительную обработку перед тем, как метод метакласса __new__ финализирует класс. Пользовательское пространство имен затем передается в __new__, где оно может быть преобразовано в стандартный dict или сохранено для упорядоченного доступа.
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']
Финансовая торговая платформа нуждалась в генерации бинарных форматов сообщений, где порядок полей в заголовке протокола строго соответствовал порядку объявления в классе сообщений Python. Переупорядочивание полей нарушило бы совместимость с устаревшими парсерами C++ со стороны обмена, что вызвало бы отклонение сделок или сбои системы.
Решение A: Ручная индексация. Разработчики аннотировали каждое поле с помощью номера последовательности, например, field_order = 1. Этот подход явный и легко понимаем для начинающих. Однако он нарушает принцип DRY и становится обременительным для обслуживания во время рефакторинга, так как вставка поля посередине требует перенумерации всех последующих полей.
Решение B: Парсинг исходного кода. Фреймворк мог бы использовать модуль AST для парсинга исходного определения класса и извлечения порядка присвоений. Это работает без сложности с метаклассом. К сожалению, это полностью проваливается, когда исходные файлы недоступны во время выполнения, например, в замороженных бинарных дистрибутивах или оптимизированных развертываниях CPython, которые удаляют исходный код.
Решение C: Метакласс с __prepare__. Возвращая OrderedDict из __prepare__, метакласс автоматически захватывает естественный порядок объявления. Это надежно во всех сценариях развертывания и прозрачно для конечных пользователей. Единственным недостатком является дополнительная сложность понимания протокола метаклассов Python, который требует знаний на уровне старшего разработчика.
Выбор решения: Команда выбрала Решение C, потому что это дает гарантии времени определения без накладных расходов во время выполнения для каждого экземпляра сообщения. Оно надежно работает во всех средах развертывания, включая те, где нет исходного кода, и поддерживает естественный синтаксис классов, который ожидают разработчики, при этом обеспечивая ограничения на как можно более раннем этапе.
Результат: Библиотека сообщений автоматически поддерживала совместимость с форматами передачи. Разработчики писали естественные определения классов, и система генерировала правильные бинарные макеты. Иерархии наследования правильно сохраняли порядок полей родителя перед полями потомков, решая сложную проблему в спецификации торгового протокола без ручного вмешательства.
Вопрос 1: Почему __prepare__ должен быть определен как @staticmethod (или @classmethod), а не как обычный метод экземпляра, и какая ошибка возникает, если вы пропустите этот декоратор?
Ответ: __prepare__ вызывается до создания экземпляра метакласса, что означает, что cls или self еще недоступны для связывания. Python вызывает __prepare__ для генерации пространства имен, которое будет передано в __new__. Если оно определено как обычный метод экземпляра, ожидающий self, Python вызовет TypeError, указывая, что функция принимает позиционные аргументы, но они не были переданы, поскольку механизм пытается вызвать его только с именем, базами и ключевыми аргументами. Это должен быть статический метод, чтобы его можно было вызывать без неявного связывания первого аргумента, хотя classmethod работает, если вам нужен доступ к самому метаклассу.
Вопрос 2: Может ли __prepare__ вернуть отображение, которое не является подклассом dict, и какой конкретный протокол оно должно удовлетворять, чтобы функционировать правильно во время выполнения тела класса?
Ответ: Да, он может вернуть любое изменяемое отображение, реализующее протокол абстрактного базового класса MutableMapping, конкретно требуя __setitem__, __getitem__, __contains__, а идеальной также __iter__ или keys() для преобразования. Однако не обязательно, чтобы это отображение унаследовало от dict. Критическим требованием является то, что оно должно принимать строковые ключи и произвольные значения, ведя себя как словарь во время присвоений атрибутов в теле класса. После выполнения класса метакласс __new__ получает это отображение; если это не подкласс dict, необходимо явно конвертировать его (например, dict(namespace)) перед вызовом super().__new__, так как __dict__ создаваемого объекта класса должен быть словарем.
Вопрос 3: Как __prepare__ обрабатывает ключевые аргументы, передаваемые в заголовке определения класса (например, class MyClass(metaclass=Meta, strict=True)), и что происходит, если они не перенаправлены должным образом?
Ответ: Ключевые аргументы в заголовке класса (кроме metaclass) передаются в __prepare__ как **kwds. Если __prepare__ не принимает **kwargs (или конкретные именованные аргументы), Python вызовет TypeError, утверждая, что __prepare__ получил неожидаемый ключевой аргумент. Это распространенная ошибка при добавлении параметров конфигурации к метаклассам. Подпись метода должна быть __prepare__(name, bases, **kwargs), чтобы быть совместимой с будущими версиями. Эти ключевые слова также затем передаются в __new__ и __init__, позволяя метаклассу получать конфигурацию на этапе подготовки для настройки поведения пространства имен (например, выбора между строгим и ленивым режимами проверки).