SuperAPI AI 工具集

python-coding-standards

编程与开发

查看项目

更新于 10-15 17:31

技能介绍

用途:在编写或编辑任何 Python 代码前使用,包括脚本、函数、缺陷修复、定时任务、一次性数据处理,或向已有 .py 文件追加内容,使项目内每个文件风格一致。所有可运行的 Python 代码(演示脚本、一次性脚本、保存到文件的示例、留在对话中供复制运行的代码)都适用;仅用于说明概念、没有可运行入口的片段除外,无法判断时按有入口处理。

主要能力与规则:用户将运行的函数需完整类型注解(每个参数与返回类型);禁止全局变量,改用实例属性、闭包或依赖注入,但从未被重新赋值或修改的常量(如 MAX_RETRIES = 3)和模块级 logger 可以;诊断信息用 logging 而非 print(),print() 仅用于 CLI 面向用户的输出,独立脚本在入口调用 logging.basicConfig(level=logging.INFO, format=...),被导入的模块把 basicConfig 留给导入方;对 HTTP、数据库、子进程、文件读写等可能因外部原因失败的 I/O 用 try/except 包裹并记录足够诊断信息;注释解释 WHY 而非 WHAT。

工具与依赖:使用 .venv 与 requirements.txt,遵循 PEP 8 与 Black。依赖用 PEP 440 兼容发布操作符 ~=major.minor 锁定(如 numpy~=2.4),不用 == 精确版本或裸 >=,^= 不是 pip 合法语法。若平台无 wheel,pip 会静默回退源码构建,可用 .venv/bin/python -m pip install --only-binary :all: -r requirements.txt 快速失败。编码统一 UTF-8,非 UTF-8 文件才声明编码行。

测试:新逻辑、新功能或缺陷修复都需测试业务逻辑;禁止硬编码返回值或同义反复断言。已有 pytest 则先写测试;无测试设施但在项目中则搭建 pytest;真正独立的一次性代码至少写可运行探针。测试通过不代表能捕获问题,需破坏被测代码确认测试变红。隔离测试需同时 mock 或重定向所有副作用边界。

限制:设计文档应放在项目既有文档约定位置,不要另建目录。资料未提供具体收费、平台支持范围等信息。