如何让IDE识别C编写的Python扩展模块的文档与函数？

C编译的Python扩展是二进制文件，IDE无法直接解析其中的函数签名和文档，以下是几种可行的解决方法：

1. 添加类型提示存根文件（.pyi） #

这是最简便且通用的方案，无需修改C代码。在模块所在的目录下创建名为eccLib.pyi的文件，写入以下内容：

def parseFASTA(rawData: str) -> list[dict]:
    """Returns a list of dicts containing FASTA data."""
    ...

def parseGTF(rawData: str) -> list[dict]:
    """Returns a list of dicts containing GTF line data."""
    ...

IDE会自动读取这个存根文件，提供函数补全、参数提示和文档预览。

2. 自动生成存根文件 #

借助stubgen工具（mypy工具链的一部分）可以自动生成存根文件，再手动调整细节：

• 安装mypy：pip install mypy
• 生成存根：stubgen -o . eccLib
• 打开生成的eccLib.pyi，补充或修正函数文档和类型注解即可。

3. 嵌入PEP 484类型注解（修改C代码） #

如果希望直接在C代码中提供类型信息，可以保持当前文档字符串的PEP 484规范格式（你已实现），部分现代IDE会尝试解析这些字符串。也可以通过Python的Py_Annotation API为函数添加类型注解，但实现相对繁琐，不如存根文件高效。

内容的提问来源于stack exchange，提问作者TCA 166