如何给Python类添加动态文档字符串_修改__doc__属性实现

秋涛同学_6722

秋涛同学_6722

2026-05-22

309人浏览

原创

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

如何给python类添加动态文档字符串_修改__doc__属性实现

直接赋值 __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 来执行类体,否则类体为空。

Claw Code Suite (Python-Only Edition)
Claw Code Suite (Python-Only Edition)

仅使用 Python 将 Claw Code 虚拟化框架与 OpenClaw 集成,提供 184 种工具和 200 多条命令,用于安全分析和代码质量...

下载
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>)  # 输出:这是一个动态生成的类
</p>

注意:exec_body 必须是可调用对象,且接收一个 dict 并就地修改它;直接传 namespace 不行,因为 new_class 内部会新建一个空字典传入。

已存在的类想改 __doc__?只能 hack __dict__ 或用 ctypes(不推荐)

对于已导入、已使用的类(比如第三方库里的类),常规手段基本无效。少数情况下可尝试:

  • 若该类尚未被任何模块缓存(如刚定义完还没被 import),可试 MyClass.__dict__['__doc__'] = "new" —— 但这依赖 CPython 实现细节,3.12 已更难成功
  • 用 ctypes 强制写内存(PyObject_SetAttrString)—— 极度危险,极易 segfault,调试困难,生产环境绝对禁用

真实项目中,如果真需要“替换已有类的文档”,应优先考虑封装一层新类、或用 sphinx.ext.autodoc 的 :noindex: + 自定义 __doc__ 属性模拟,而不是硬改原类。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1771

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4644

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1749

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

27437

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3307

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3327

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1203

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2583

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习