Python 库参考构建器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/python-library-reference-builder 技能到当前 AI 助手。
技能介绍
要解决的具体问题
Python 项目常依赖数十甚至上百个第三方库,开发者面临三个典型痛点:文档分散在源码、PyPI 页面与外部博客之间;内置的 help 函数只能查看已导入对象的摘要,无法批量获取全量信息;类型注解和用法示例要么缺失,要么需要人工翻找。这些问题在排查某个函数到底支持哪些参数,或者确认该库有没有现成的递归示例时尤为耗时。
核心能力与关键步骤
该技能使用标准库中的 ast 模块解析包源码结构,通过 importlib 直接读取已安装环境中的元数据,并集成 Sphinx autodoc 的文档生成能力。具体流程包括:
- 扫描目标包的初始化文件与子模块,定位公开接口。
- 提取每个函数或类的文档字符串、参数类型注解和返回值类型。
- 从模块级注释或文档字符串中抓取用法示例片段。
- 生成结构化的 Markdown 或 HTML 参考文档,支持全文搜索。
适用边界与注意点
该工具仅处理已通过标准包管理流程正确安装的包,未安装或仅存在于源码树中的库会被跳过。它依赖包内的文档字符串和类型注解规范,若原始代码未提供,则输出会缺失对应信息。此外,不处理动态生成的接口,例如通过特殊钩子动态创建的属性,这类对象无法被静态解析模块识别。
使用场景
- 维护内部Python工具库时,需要为新增函数批量生成包含参数类型和示例的接口文档
- 接手未完整文档化的第三方库,需快速提取核心模块的函数签名和用法片段
- 编写Python技术博客时,想引用依赖库的真实类型注解和实际使用示例而非凭记忆描述
- 团队搭建内部知识库,需要将多个Python包的关键接口和示例结构化存入可搜索系统
适合人员
- Python库维护者:需要为新增功能生成规范的接口文档和类型说明
- 后端开发者:在集成第三方库时快速确认函数参数类型和返回值结构
- 技术作家:撰写Python库教程时需要准确的用法示例和参数说明
- AI团队知识库管理员:搭建技术文档系统时需要批量结构化入库