SuperAPI AI 工具集

python-coding-standards

编程与开发

查看项目

更新于 10-16 08:47

技能介绍

用途:在编写、重构或评审 Python 应用与库代码、定义数据模型、拆分大型模块或搭建 Python 项目时使用。目标是直白、有组织、易读易维护的代码,而非炫技式架构;评审或诊断时只返回问题及其后果,不直接实施改动。

主要能力与规则:以仓库为先,先读项目说明、Python 支持范围、依赖约束、邻近实现与测试、已配置检查,再选语法或工具;除非请求含迁移,保持公开导入、输入、序列化值与持久化数据兼容。新项目使用 Python 3.12 或更高,并在 pyproject.toml 记录支持范围。项目用 uv 工作流管理:pyproject.toml、uv.lock、uv add、uv sync、uv run;不以 pip install 或 uv pip install 作为常规安装手段。函数、方法、返回值、模型字段、属性、模块级值与局部变量声明都要求类型注解,使用 dict[str, int]、list[Item]、Item | None 等 3.12 兼容写法,不用 Any 或 cast 仅为凑注解。应用自有结构化数据默认用 Pydantic BaseModel,闭合字符串词表用标准库 enum.StrEnum 并显式赋值。拆分模块需基于职责、依赖或生命周期,500 行手写一方代码提示做拆分评审,1000 行需在合理边界拆分或说明理由。无法由代码表达之处用文档字符串与注释解释意图、约束与权衡。验证时通过 uv run 运行相关检查,关注公开导入、入参接受与拒绝、序列化字段与枚举值、错误行为与清理路径的兼容测试。

限制:以上规则来自该技能说明,具体收费、平台支持与效果暂未提供。