You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何用pdoc生成Python私有方法的HTML文档?已尝试--all-modules无效

解决pdoc不生成私有方法文档的问题

你之前用的--all-modules参数和PODOC_ALL_SUBMODULES环境变量(注意是PDOC而非PODOC)是用来加载所有子模块的,和私有成员的显示无关,所以没效果。以下是可行的解决方法:

方法1:命令行添加--show-private参数

直接在pdoc命令后追加该参数,就能强制显示所有单下划线开头的私有方法、属性等成员,示例命令:

pdoc --show-private your_module.py -o output_dir

方法2:代码中用__pdoc__字典指定要包含的私有方法

如果只想展示特定的私有方法,不想全部暴露,可以在模块或类的代码里定义__pdoc__字典,将目标方法名设为True,示例:

class DemoClass:
    def _internal_method(self):
        """私有方法的文档说明"""
        pass

# 显式声明该私有方法需要被纳入文档
__pdoc__ = {"DemoClass._internal_method": True}

方法3:通过配置文件全局启用私有成员显示

创建名为.pdoc.toml的配置文件,添加以下内容:

show_private = true

后续运行pdoc时会自动读取该配置,默认显示所有私有成员,无需每次手动加命令行参数。

内容的提问来源于stack exchange,提问作者user19263504

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.06.27 19:22:03