当前位置:

首页 > 编程开发 > 如何在 pdoc 中为私有函数生成文档

如何在 pdoc 中为私有函数生成文档

pdoc默认屏蔽以下划线开头的私有函数,不生成文档。可通过定义模块级__pdoc__字典,将私有成员映射为True,从而显式启用文档化;另一种方式是通过__all__列表配合--force参数实现。推荐使用__pdoc__方案,该方案稳定且符合设计哲学。

本文目录
    pdoc 默认会屏蔽所有以下划线开头的私有方法(比如 `_example_method`),因为它的设计原则是“只暴露公共 API”。但如果你确实需要让某些私有函数在文档中现身,可以通过自定义模板或修改模块的 `__all__` 和 `__pdoc__` 魔法变量来显式控制可见性。

    pdoc 有个默认行为:它会忽略所有以下划线开头的私有方法。这背后的逻辑其实很清晰——pdoc 信奉“文档即接口”,只记录那些符合 Python 公共约定的成员(即没有下划线前缀、且未被 __all__ 显式排除的可导出对象)。所以,哪怕你用了 --all-modules 或者设置了 PODOC_ALL_SUBMODULES=true,这些开关影响的也只是子模块的加载范围,并不改变类或模块内部成员的可见性判定规则。

    那么,如果确实需要让私有函数(比如 _helper() 或 __internal_process())出现在最终生成的 HTML 文档中,该怎么办?推荐下面两种轻量且好维护的方案。

    ✅ 方法一:使用 __pdoc__ 显式启用(推荐)

    在模块的顶层(比如 mymodule.py)添加一个 __pdoc__ 字典,把你想文档化的私有成员映射为 True:

    # mymodule.py
    def public_func():
        """这是一个公开函数,会自动被文档化。"""
        pass
    
    def _private_helper():
        """这是一个私有辅助函数。"""
        return 42
    
    # 显式声明需文档化的私有成员
    __pdoc__ = {
        '_private_helper': True,
        # 也可禁用某个公有成员:'public_func': False,
    }
    

    然后运行命令即可生效:

    pdoc --html --output-dir docs mymodule

    ⚠️ 注意:__pdoc__ 必须定义在待文档化模块的全局作用域,并且要放在目标函数定义之后,否则可能因为导入顺序问题导致识别失败。

    ✅ 方法二:通过 __all__ + --force 组合(适用于模块级私有函数)

    如果你的私有函数本质上是“模块内可用但并非严格私有”,可以考虑把它加入 __all__,再配合 --force 强制包含。注意这里的逻辑有点巧妙:--force 本身会绕过 __all__ 的白名单限制,而你把私有名写进 __all__ 后,再结合 --force,就能确保 pdoc 在扫描时将其纳入候选集——当然,最终是否显示还是受 __pdoc__ 的裁决。

    # mymodule.py
    __all__ = ['public_func', '_private_helper']  # 将私有名列入 __all__
    
    def public_func(): ...
    def _private_helper(): ...
    

    然后执行:

    pdoc --force --html --output-dir docs mymodule

    ? 原理说明:--force 不直接启用私有成员,但它会绕过 __all__ 的限制;而 __all__ 里写上私有名,相当于给 pdoc 一个“候选名单”。最终谁上场,还是 __pdoc__ 说了算。

    ❌ 不推荐的做法

    • 修改 pdoc 源码或依赖未公开的内部标志(比如 _pdoc_hidden);
    • 试图用 --all-submodules 之类的开关“暴力覆盖”——它们控制的是包结构遍历,跟成员可见性不沾边;
    • 把私有函数改名为公有(比如 private_helper → helper),这既违背封装语义,也不符合 PEP 8 规范。

    总结

    pdoc 的设计哲学很明确:API 的意图要清晰表达。是否文档化私有函数,本质上是一个接口设计问题——如果这个函数确实需要被下游用户理解或调试,那就通过 __pdoc__ 显式授权;如果它纯属实现细节,保持隐藏反而更有利于长期维护。灵活运用 __pdoc__ 是最符合 pdoc 初衷、也最稳定可控的解决方案。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    悟空浏览器怎么彻底清理浏览器配置文件
    悟空浏览器怎么彻底清理浏览器配置文件

    彻底清理悟空浏览器的数据,通常有三个路径:通过手机系统设置能一次性清除所有配置和用户信息;利用浏览器内置功能,可以只清理缓存而保留个性化设置;最彻底的则是卸载重装,让应用回到初始状态。 悟空浏览器用久了,是不是偶尔会感觉变慢,或者出现一些难以解释的小毛病?有时候,与其一个个排查问题,不如来一次彻底的

    漫蛙漫画官网首页登录入口
    漫蛙漫画官网首页登录入口

    漫蛙漫画首页登录入口https://www.manwamh.top/:一触即达的漫画世界核心枢纽 对于漫画迷而言,找到那个可靠的资源门户至关重要。漫蛙漫画的首页登录入口,正是这样一个核心渠道。通过它,你可以直接跳转到漫蛙2漫画APP的下载页面,轻松几步完成安装,马上就能投入到精彩纷呈的漫画之旅中。 漫蛙漫画首页登录入口: 官方入口地址已经为你备好

    漫蛙漫画官方入口
    漫蛙漫画官方入口

    漫蛙漫画官方入口与核心功能解析 寻找一个稳定、资源丰富的漫画在线阅读平台,是许多漫画爱好者的共同需求。其中,漫蛙漫画官方入口及其免费全集服务,受到了不少关注。那么,这个平台究竟如何?下面,我们就来深入了解一下它的具体信息与特色功能。 平台的官方访问地址是:https://www.manwa123.c

    漫蛙动漫APP最新版本下载
    漫蛙动漫APP最新版本下载

    对于动漫爱好者而言,找到一个资源全、体验佳的追番平台,常常是件头疼事。漫蛙动漫APP的定位很明确:就是要打造一个聚合全球正版动漫资源的专属乐园。无论是当季火爆的日漫新番、值得回味的经典国创,还是那些小众却精彩的优质动画,在这里基本都能一网打尽。平台底层采用了智能缓冲技术,最大程度保证了播放的流畅度,

    漫蛙官网入口免费下载最新版
    漫蛙官网入口免费下载最新版

    想要获取正版manwa漫蛙APP?官方指定下载渠道就是漫蛙官网入口。 对于漫画迷而言,找到一款心仪的阅读神器至关重要。漫蛙APP正是这样一款专为全球漫画爱好者打造的平台,它汇聚了从日韩人气连载到本土原创精品的海量资源。说它“应有尽有”毫不为过。更重要的是,其界面设计清爽直观,搭配智能检索功能,能让用

    漫蛙漫画在线观看入口
    漫蛙漫画在线观看入口

    想要畅享海量正版漫画资源?漫蛙漫画平台不容错过 对于漫画迷来说,找到一个资源丰富、体验流畅的正版平台实属幸事。漫蛙漫画凭借其优质的在线阅读服务,已经成为了许多资深读者的心头好。今天,我们就来详细拆解一下平台的访问方法与实用技巧,助你轻松开启漫画之旅。 漫蛙漫画网页入口页面指南 想立刻体验?官方在线观

    漫蛙如何下载最新版本
    漫蛙如何下载最新版本

    漫蛙漫画网APP官方下载方法全解析 对于资深漫画迷来说,找到一个资源全、更新快、体验佳的阅读平台,就像淘到了宝藏。漫蛙漫画网APP,正是这样一个专为爱好者打造的精品集散地。它汇聚了全球优质的正版漫画,从火爆的日漫连载到崛起的国创佳作,平台都能做到实时同步更新。当然,第一步得先把它装到设备上。接下来,

    漫蛙漫画APP最新版本下载
    漫蛙漫画APP最新版本下载

    漫蛙漫画APP:专业漫画阅读工具的全面革新 作为一款专业的漫画阅读工具,漫蛙漫画APP整合了全球优质漫画资源,其升级版漫蛙2在功能与体验上可谓全面革新。这款应用不仅囊括日漫经典与国漫新作,更通过简洁直观的界面设计和流畅操作,为用户打造沉浸式阅读环境,充分满足各类漫画爱好者的多样化需求。 漫蛙漫画特色

    卖茶叶妈妈3d漫蛙安卓版下载
    卖茶叶妈妈3d漫蛙安卓版下载

    当下动漫圈热议的卖茶叶妈妈3d漫蛙下载,凭借其突破性的3D视觉技术成为焦点 最近动漫爱好者们都在讨论一个现象级产品——卖茶叶妈妈3d漫蛙下载。这款由漫蛙漫画平台倾力打造的3D作品专区,用立体建模与动态分镜彻底颠覆了传统二维漫画的阅读模式。你猜怎么着?现在只需通过专区提供的便捷下载通道,无论是热血冒险

    漫蛙下载最新版本
    漫蛙下载最新版本

    漫蛙APP:资深漫画迷的移动图书馆与阅读利器 对于漫画爱好者来说,找到一个资源全、体验好的阅读平台,从来都不是件容易的事。而漫蛙APP,恰恰就是为这个需求而生的。它凭借海量的正版漫画库和极其便捷的离线下载功能,在圈内积累了相当不错的口碑。更重要的是,从经典的日本热血漫到新兴的国产原创作品,它几乎一网

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。