用途:统一 Python 代码风格与文档规范,提升代码库可维护性与协作效率。适用于新项目搭建 lint/格式化、编写或审查 docstring、制定团队编码标准、配置 ruff/mypy/pyright、风格一致性审查以及编写项目文档。
主要能力:主张用工具自动格式化,避免风格争论;遵循 PEP 8 命名,强调名称清晰可读;把文档当作代码维护;公开 API 都应带类型注解。推荐用 ruff 作为一体化 linter 和 formatter,取代 flake8、isort 和 black;用 mypy 或 pyright 做严格类型检查。
快速开始:pip install ruff mypy,并在 pyproject.toml 中配置。ruff 可设置 line-length = 120、target-version,select 分组(E、W、F、I、B、C4、UP、SIM)等。命令:ruff check --fix . 与 ruff format .。mypy 可开 strict,并单独放宽 tests.*。
命名与导入:文件模块用描述性 snake_case,类用 PascalCase,函数变量用 snake_case,常量用 SCREAMING_SNAKE_CASE。导入按标准库、第三方、本地分组,只用绝对导入。
文档与格式:公共类、方法与函数写 Google 风格 docstring,包含 Args、Returns、Raises、Example;行长 120 字符,长调用与长字符串合理换行。建议 README 包含安装、快速开始、配置、开发章节,CHANGELOG 采用 Keep a Changelog 格式。
限制:资料主要给出规范与配置示例,未提供具体运行效果、收费或平台信息;示例代码中的版本号与选择规则需按项目实际情况调整。