Python Coding Guidelines

Python Coding Guidelines 是什么

Python Coding Guidelines 是一份 Python 编码与审查规范，用于统一代码风格、版本选择、依赖管理、语法检查、测试和惯用写法。

适用场景

适用时先确认任务目标、对象、范围和成功标准，再判断该 Skill 是否比官方客户端、专用工具或人工流程更合适；涉及真实账号、外部写入、付费任务或敏感数据时，应把确认点放在实际操作之前。

核心能力与工作机制

它要求遵循 PEP 8 和清晰命名，优先仍受支持的现代 Python 版本，使用 py_compile 验证语法、运行项目测试，并在可用时使用 uv 管理依赖；重构应保持行为和接口。

执行流程

先读取项目版本、格式化与测试配置，确认兼容范围；以最小改动编写或重构，执行语法检查、格式化、静态检查和相关单元测试，再检查异常、类型、资源释放与兼容性。

输入与输出

开始前需要提供明确目标、必要素材或资源标识、允许访问的账号与范围、期望输出、时间口径，以及不能改变的事实和约束；缺少会影响权限、费用、隐私或执行路线的信息时，应先补齐。输出除最终文件、记录或分析结果外，还应保留输入范围、关键参数、资源或任务标识、执行状态与验证证据；计划、预览、排队或局部成功不能描述为最终完成。

依赖、账号与权限

需要目标仓库、Python 运行时、项目依赖和测试命令；uv、ruff、mypy 或 pytest 是否可用以项目配置为准。

副作用、限制与风险

机械套用规范可能破坏旧版本兼容、公共 API 或性能，测试通过也不能证明业务逻辑正确；升级依赖和解释器会扩大变更范围。实际执行可能读取本地或云端数据、写入文件、调用网络服务或改变外部系统。任何发送、发布、删除、覆盖、付费、部署或持久配置动作，都应在执行前说明对象、影响范围和恢复方式。

不适用边界

不以个人风格覆盖项目既有约定，不擅自升级运行时或依赖，也不在缺少测试时把重构描述为等价。

失败处理与验收

失败时先保存输入、资源或任务标识、日志和当前状态，查询是否已经产生结果或副作用，再决定有限重试、回滚或替代路线，避免重复写入、重复发送和重复计费。验收应检查真实文件、页面、记录、设备状态或任务终态，并抽查关键字段、数量、格式、权限与边界条件；无法实际验证的部分必须明确标注，不能根据命令返回或计划文本推断。

适合谁使用

适合 Python 开发、代码评审和团队规范落地。

来源、版本与许可

本条目依据 SkillHub 热门榜、发布者详情和版本 1.0.0 的完整 SKILL.md 整理，核验日期为 2026 年 9 月 29 日。完整 SKILL.md 未声明许可证，公开可下载不代表可以任意复制、修改或再分发。 SkillHub 当前两套安全扫描状态为 benign、benign；该状态只是平台信号，不能替代对脚本、凭据、网络请求、数据外送与后续版本的人工审查。

常见问题

1. Python Coding Guidelines 主要解决什么问题？

Python Coding Guidelines 是一份 Python 编码与审查规范，用于统一代码风格、版本选择、依赖管理、语法检查、测试和惯用写法。适用时先确认任务目标、对象、范围和成功标准，再判断该 Skill 是否比官方客户端、专用工具或人工流程更合适；涉及真实账号、外部写入、付费任务或敏感数据时，应把确认点放在实际操作之前。是否采用它，应以实际任务边界和可核验材料为准，不要因为榜单热度而跳过来源审查。

2. 开始前需要准备什么？

开始前需要提供明确目标、必要素材或资源标识、允许访问的账号与范围、期望输出、时间口径，以及不能改变的事实和约束；缺少会影响权限、费用、隐私或执行路线的信息时，应先补齐。准备阶段不要代替用户猜测关键事实；缺少会改变路线、费用或权限的输入时，应先补齐再执行。

3. 它怎样完成任务并交付结果？

先读取项目版本、格式化与测试配置，确认兼容范围；以最小改动编写或重构，执行语法检查、格式化、静态检查和相关单元测试，再检查异常、类型、资源释放与兼容性。每个阶段都要保留输入、决策、输出和检查点，不能把计划、预览或排队状态描述成最终交付。

4. 需要哪些工具、账号或权限？

需要目标仓库、Python 运行时、项目依赖和测试命令；uv、ruff、mypy 或 pytest 是否可用以项目配置为准。凭据应放在安全环境中，并按最小权限授权；账号、网络或本地依赖不满足时应明确停止条件。

5. 它会产生哪些外部操作或副作用？

实际执行可能读取本地或云端数据、写入文件、调用网络服务或改变外部系统。任何发送、发布、删除、覆盖、付费、部署或持久配置动作，都应在执行前说明对象、影响范围和恢复方式。涉及外部写入、上传、发送、付费或持久配置时，应在实际动作前说明影响范围并取得相应确认。

6. 哪些情况不适合使用？

不以个人风格覆盖项目既有约定，不擅自升级运行时或依赖，也不在缺少测试时把重构描述为等价。超出来源明确能力、专业资质或授权范围时，应切换到更合适的工具或交给专业人员处理。

7. 失败或结果异常时怎样恢复？

失败时先保存输入、资源或任务标识、日志和当前状态，查询是否已经产生结果或副作用，再决定有限重试、回滚或替代路线，避免重复写入、重复发送和重复计费。恢复时优先查询已有任务、日志或备份，避免无上限重试、重复扣费、重复发送或覆盖唯一原件。

8. 如何验收结果并控制风险？

验收应检查真实文件、页面、记录、设备状态或任务终态，并抽查关键字段、数量、格式、权限与边界条件；无法实际验证的部分必须明确标注，不能根据命令返回或计划文本推断。验收应基于真实文件、页面、任务终态或权威来源，并把未能实际检查的部分明确标记出来。