Python 文档字符串提取器

它解决什么问题

阅读一个 Python 包时，真正的接口说明往往散落在源码的 docstring 里。手动翻找 .py 文件、复制参数表、确认某个 Args 段到底描述的是哪个函数，既慢又容易看漏。更麻烦的是，docstring 有 Google、NumPy、Sphinx 等多种写法，没有统一解析就没法程序化索引。

技能如何工作

Python 文档字符串提取器 用 ast.parse 定位模块、类和函数上的文档字符串，再交给 docstring_parser 做结构化解析：

• 多格式解析：支持 ReST、Google、NumPy 风格，覆盖多数主流项目
• 类型提示交叉引用：通过 typing_inspect 把类型注解与 docstring 字段对齐
• 构建可检索索引：将参数说明、返回值、异常等段落提取为结构化条目

典型流程是：定位目标模块 → 用 AST 抽取 docstring → 按格式分派解析器 → 输出带类型信息的索引结果，便于后续检索或文档生成。

适用边界

• 它是解析器，不是 docstring 生成器；缺 docstring 的代码不会有凭空补全
• 仅覆盖上述三类格式，非标准自由文本的解析结果可能不完整
• 对类型推断较弱的老代码，交叉引用命中率会下降