直接赋值__doc__失败,因类__doc__是只读描述符;修改__new__或__init__无效;推荐用types.new_class动态创建带文档的类,或对已存在类封装新类而非硬改。

直接赋值 __doc__ 失败?因为类对象是不可变的
给 Python 类动态设置文档字符串,不能像函数那样直接写 MyClass.__doc__ = "new doc"——这行代码看似没报错,但实际不会生效。原因在于:CPython 中类对象的 __doc__ 是只读描述符,底层绑定到类型对象的 tp_doc 字段,直接赋值会被忽略(尤其在 3.10+ 更严格)。
用 types.FunctionType 替换类的 __new__ 或 __init__ 不可行
有人尝试通过重写特殊方法来“触发”文档更新,但这是误解。文档字符串不属于运行时行为,它不参与实例化逻辑;修改 __new__ 或 __init__ 对 __doc__ 完全无影响。真正起作用的只有两类方式:
- 在类定义后、首次被引用前,用
setattr配合绕过描述符检查(仅对用户自定义类有效,且有版本差异) - 用
types.new_class+exec重新构建类(推荐,可控性强)
types.new_class 是最稳妥的动态生成方案
它允许你在运行时构造类,并显式传入 doc 参数。关键点是:必须提供 exec_body 来执行类体,否则类体为空。
import types
<p>def make_class_with_doc(name, bases=(), namespace=None, doc=""):
if namespace is None:
namespace = {}
namespace["<strong>doc</strong>"] = doc
return types.new_class(name, bases, exec_body=lambda ns: ns.update(namespace))</p><h1>使用</h1><p>MyDynamicClass = make_class_with_doc("MyDynamicClass", doc="这是一个动态生成的类")
print(MyDynamicClass.<strong>doc</strong>) # 输出:这是一个动态生成的类
注意:exec_body 必须是可调用对象,且接收一个 dict 并就地修改它;直接传 namespace 不行,因为 new_class 内部会新建一个空字典传入。
立即学习“Python免费学习笔记(深入)”;
已存在的类想改 __doc__?只能 hack __dict__ 或用 ctypes(不推荐)
对于已导入、已使用的类(比如第三方库里的类),常规手段基本无效。少数情况下可尝试:
- 若该类尚未被任何模块缓存(如刚定义完还没被 import),可试
MyClass.__dict__['__doc__'] = "new"—— 但这依赖 CPython 实现细节,3.12 已更难成功 - 用
ctypes强制写内存(PyObject_SetAttrString)—— 极度危险,极易 segfault,调试困难,生产环境绝对禁用
真实项目中,如果真需要“替换已有类的文档”,应优先考虑封装一层新类、或用 sphinx.ext.autodoc 的 :noindex: + 自定义 __doc__ 属性模拟,而不是硬改原类。


















