Python中类的创建过程由元类控制,除了我们熟悉的__new__和__init__方法之外,__prepare__是元类中一个用于定制类命名空间的特殊方法,它在类定义开始执行前就会被调用,返回的命名空间对象会作为类体执行时的局部命名空间使用。

__prepare__方法的基本定义
__prepare__是元类的一个静态方法或者类方法,它的第一个参数通常是元类自身,第二个参数是要创建的类的名称,第三个参数是基类组成的元组,还可以接收额外的关键字参数。它必须返回一个映射类型的对象,这个对象就是类定义阶段使用的命名空间。
下面是一个最简单的自定义元类实现__prepare__的示例:
class MyMeta(type):
@classmethod
def __prepare__(metacls, name, bases, **kwargs):
# 返回一个空字典作为默认命名空间
return {}
def __new__(cls, name, bases, namespace, **kwargs):
# 打印命名空间内容
print(f"类 {name} 的命名空间: {namespace}")
return super().__new__(cls, name, bases, namespace)
class MyClass(metaclass=MyMeta):
x = 1
y = 2
运行上面的代码,会先执行__prepare__得到命名空间,然后执行类体中的赋值语句,最后将填充好的命名空间传给__new__方法,输出结果会显示命名空间中包含了x和y两个属性。
自定义命名空间实现属性顺序记录
默认的类命名空间是普通字典,不会记录属性的定义顺序,但是我们可以通过__prepare__返回一个有序字典,来记录类体中属性的定义顺序,这在很多需要按定义顺序处理类属性的场景中非常有用。
from collections import OrderedDict
class OrderedMeta(type):
@classmethod
def __prepare__(metacls, name, bases, **kwargs):
# 返回有序字典作为命名空间
return OrderedDict()
def __new__(cls, name, bases, namespace, **kwargs):
# 将命名空间中的属性按定义顺序保存到类的__ordered_attrs__属性中
namespace["__ordered_attrs__"] = list(namespace.keys())
return super().__new__(cls, name, bases, namespace)
class User(metaclass=OrderedMeta):
name = ""
age = 0
email = ""
print(User.__ordered_attrs__)
运行代码后,输出的结果会是['name', 'age', 'email', '__ordered_attrs__'],可以看到除了我们手动定义的三个属性,还有元类添加的__ordered_attrs__属性,前面的三个属性顺序和类体中的定义顺序完全一致。
过滤或转换类属性
我们还可以通过自定义命名空间的行为,实现类属性的过滤或者转换,比如在类定义时自动将所有的属性名转换为大写,或者过滤掉不符合规则的属性。
下面的示例实现了一个命名空间,会自动将赋值的属性名转为大写再存储:
class UpperDict(dict):
def __setitem__(self, key, value):
# 将属性名转为大写后存储
super().__setitem__(key.upper(), value)
class UpperMeta(type):
@classmethod
def __prepare__(metacls, name, bases, **kwargs):
return UpperDict()
def __new__(cls, name, bases, namespace, **kwargs):
# 打印最终的命名空间
print(f"转换后的命名空间: {dict(namespace)}")
return super().__new__(cls, name, bases, namespace)
class Config(metaclass=UpperMeta):
host = "127.0.0.1"
port = 8080
debug = True
运行代码后,输出的命名空间中属性名全部变成了大写,分别是HOST、PORT、DEBUG,这样在后续使用Config类的时候,就只能通过大写的属性名来访问对应的属性了。
__prepare__的调用时机说明
__prepare__的调用时机非常早,它在类体代码执行之前就会被元类调用,这也是为什么它能定制整个类定义阶段的命名空间。整个类创建的流程可以总结为以下几步:
- 解释器遇到类定义语句,获取类名、基类、元类(如果没有指定则使用type)
- 调用元类的__prepare__方法,得到类命名空间对象
- 执行类体中的代码,所有的赋值、函数定义等操作都会修改这个命名空间对象
- 调用元类的__new__方法,传入类名、基类、填充好的命名空间,创建类对象
- 调用元类的__init__方法,完成类对象的初始化
需要注意的是,__prepare__是Python 3中引入的方法,Python 2中不存在这个方法,所以如果需要在Python 2中实现类似的命名空间定制,需要通过其他方式,比如修改类创建后的属性,但效果不如__prepare__灵活。
实际应用场景
__prepare__的常见应用场景包括:
- 实现ORM模型类时,记录字段的定义顺序,方便后续生成建表语句
- 实现领域特定语言(DSL)时,定制类定义的行为,让类定义更符合领域逻辑
- 实现框架的配置类,自动转换或校验配置项的格式
- 实现需要按定义顺序处理类属性的装饰器或工具类
需要注意的是,__prepare__只在元类中有效,普通类中定义这个方法不会被调用,因为它属于元类的方法,用于控制类的创建过程,而不是类实例的行为。
Python__prepare__类命名空间元类修改时间:2026-06-30 01:24:36