SuperAPI AI 工具集

python-docstrings

编程与开发

查看项目

更新于 10-15 21:52

技能介绍

用途:为 Python 代码添加、修正、审计或审查文档字符串与解释性注释,重点记录名称、类型注解和代码结构无法体现的调用方可见契约与维护关键理由,并保持运行时与工具行为不变,遵循仓库既有文档约定。

主要能力:提供编辑与审查两种模式。编辑模式在指定范围内添加或修正文档;审查模式只报告误导、缺失、冗余或过时的文档而不修改,除非用户同时要求修复。会读取仓库说明、目标文件、公共导入面、邻近已文档化 API、测试及 pyproject.toml、Ruff、pydocstyle、Sphinx 等配置,确定本地格式与公共范围,只映射有证据的非显然契约字段:输入、返回或产出、失败、副作用、生命周期、并发与不变量。

使用方式:先确定格式与公共面,再添加最小可用的文档字符串或块级理由注释,不重写可执行代码。随后解析改动文件、运行配置的检查、按比例用聚焦测试验证声明,并确认纯文档改动未改变可执行 AST 或工具指令。文档工作不授权修改签名、注解、装饰器、控制流、依赖或 API。

适用场景:公共 API、异步与生成器语义、上下文管理器、协议与回调、重载、属性与描述符等契约的文档化;审查调用方影响较大的错误或过时契约。

限制:不得为 sleep、重试、缓存、顺序、锁或回退编造理由;无直接证据不得声称线程安全、幂等或保证清理;示例可能成为 doctest,需保持确定性;注释可能影响工具行为。验证可用 python3 scripts/verify_doc_only_diff.py --base HEAD -- path/to/file.py。其余细节暂未提供。