SuperAPI AI 工具集

python-code-style

编程与开发

查看项目

更新于 10-15 23:42

技能介绍

用途:为 Python 项目建立一致的代码风格与文档标准,覆盖 lint、格式化、命名、类型注解与文档编写,适合新项目配置、代码评审和团队规范落地。

主要能力:

  1. 自动化格式化与 lint:推荐 ruff 作为一体化工具,替代 flake8、isort、black;在 pyproject.toml 中配置 line-length、target-version 及 select/ignore 规则集(E、W、F、I、B、C4、UP、SIM)。
  2. 类型检查:配置 mypy strict 模式(warn_return_any、disallow_untyped_defs 等),或使用 pyright 的 strict 模式。
  3. 命名规范:模块与函数用 snake_case,类用 PascalCase,常量用 SCREAMING_SNAKE_CASE,强调描述性命名而非缩写。
  4. 导入组织:按标准库、第三方、本地分组,推荐绝对导入。
  5. 文档:为所有公开类、方法和函数编写 Google 风格 docstring,包含 Args、Returns、Raises、Example 等段落;README 与 CHANGELOG 遵循 Keep a Changelog 格式。

必要用法: 安装:pip install ruff mypy 运行:ruff check --fix . 与 ruff format . 配置示例(pyproject.toml):[tool.ruff] line-length = 120;target-version = "py312";[tool.mypy] strict = true。

适用场景:新项目工具链搭建、团队编码规范制定、代码评审中的风格一致性检查、公开 API 文档编写。

限制:资料未提供具体版本兼容性、CI 集成细节、性能数据或收费信息;行宽 120、目标 Python 3.12 等为推荐值,需按项目实际调整。