SuperAPI AI 工具集

python-code-style

编程与开发

查看项目

更新于 10-16 00:30

技能介绍

用途:为 Python 项目建立统一的代码风格、静态检查与文档规范,适用于新项目初始化、代码评审、团队编码标准制定以及 ruff、mypy、pyright 的配置。

主要能力:

  1. 自动化格式化与检查:推荐用 ruff 作为一体化 linter 与 formatter,替代 flake8、isort、black。安装命令为 pip install ruff mypy。常用命令:ruff check --fix . 与 ruff format .。
  2. 类型检查:提供 mypy 严格模式配置(strict、warn_return_any、disallow_untyped_defs 等),并给出 pyright 的 typeCheckingMode = "strict" 替代方案。
  3. 命名约定:模块与函数用 snake_case,类用 PascalCase,模块级常量用 SCREAMING_SNAKE_CASE,强调描述性命名而非缩写。
  4. 导入组织:按标准库、第三方、本地分组,推荐使用绝对导入。
  5. 文档规范:采用 Google 风格 docstring,包含 Args、Returns、Raises、Example 等段落,公共 API 均需文档。
  6. 项目文档:给出 README 结构与 Keep a Changelog 格式的 CHANGELOG 示例。

使用方式:在 pyproject.toml 中配置 [tool.ruff]、[tool.mypy] 或 [tool.pyright],设置 line-length、target-version、lint select 规则等,然后在 CI 中自动运行检查。

适用场景:团队编码标准落地、代码评审、新项目工具链搭建、文档编写。

限制:资料未提供具体版本兼容性、性能数据、收费信息或与其他工具的对比结论;示例中的 Python 版本与行宽等参数需按项目实际情况调整。