SuperAPI AI 工具集

python-code-style

编程与开发

查看项目

更新于 10-15 23:48

技能介绍

用途:为 Python 项目建立统一的代码风格与文档规范,适用于新项目配置 linter/formatter、编写或审查 docstring、制定团队编码标准、配置 ruff/mypy/pyright、审查代码风格一致性以及编写项目文档。

主要能力:

  1. 自动化格式化:推荐用 ruff 作为一体化 linter 与 formatter,替代 flake8、isort、black。安装命令:pip install ruff mypy。配置示例(pyproject.toml):[tool.ruff] line-length = 120,target-version = "py312";[tool.ruff.lint] select 包含 E、W、F、I、B、C4、UP、SIM,ignore = ["E501"];[tool.ruff.format] quote-style = "double",indent-style = "space"。运行:ruff check --fix . 与 ruff format .。
  2. 类型检查:mypy 严格模式配置(strict = true、warn_return_any、warn_unused_ignores、disallow_untyped_defs、disallow_incomplete_defs),可对 tests.* 放宽;也可用 pyright(typeCheckingMode = "strict")。
  3. 命名约定:文件与模块用描述性 snake_case,类用 PascalCase(缩写保持大写),函数与变量用 snake_case,模块级常量用 SCREAMING_SNAKE_CASE。
  4. 导入组织:按标准库、第三方、本地分组,仅使用绝对导入。
  5. 文档:为所有公开类、方法、函数编写 Google 风格 docstring,包含 Args、Returns、Raises、Example 等段落;README 与 CHANGELOG(Keep a Changelog)结构示例。
  6. 行宽与格式:建议 120 字符行宽,给出函数参数换行、链式调用、长字符串拼接的写法示例。

使用方式:在 pyproject.toml 中完成 ruff 与 mypy/pyright 配置后,通过命令行运行检查与格式化,并在 CI 中对每次提交执行 linter。

适用场景:Python 项目初始化、代码评审、团队规范落地、文档维护。

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