SuperAPI AI 工具集

python-best-practices

编程与开发

查看项目

更新于 10-15 23:33

技能介绍

用途:该技能用于在编写或重构 Python 代码时提供符合行业最佳实践的专家指导,适用于新建函数、类或模块,重构旧代码,搭建项目结构,编写单元测试或采用 TDD,添加类型提示,配置 lint、格式化与类型检查工具,管理依赖与虚拟环境,以及提升可读性与可维护性。

主要能力:围绕 PEP 8 给出缩进、行长、空行、导入顺序、命名与空白等规范;强调自文档化代码与 docstring;按单一职责与 DRY 原则拆分函数和类;提供可测试代码、pytest 用例结构与 TDD 流程;建议使用具体异常、日志与上下文管理器;介绍 uv 虚拟环境与 pyproject.toml 项目配置;并说明 Ruff、Black、Mypy 的安装与常用命令,如 ruff check .、ruff format .、black myproject/、mypy myproject/。

使用方式:资料给出推荐工作流——先写类型提示与 docstring,再写测试,随后实现最小代码、重构、运行 linter、格式化、类型检查并执行测试;重构时先补测试、建立基线、小步修改并逐步提高类型覆盖。

适用场景与限制:适合日常 Python 工程实践与团队规范落地。资料未提供该技能的安装命令、调用方式、收费、价格、平台支持或效果数据,这些信息暂未提供。