SuperAPI AI 工具集

python-code-style

编程与开发

查看项目

更新于 10-15 21:48

技能介绍

用途:为 Python 项目提供代码风格、静态检查、格式化、命名约定与文档标准指导,适合新建项目配置工具、审查代码风格一致性、撰写 docstring 或制定团队规范。

主要能力:推荐用 ruff 作为一体化 linter 与格式化工具(替代 flake8、isort、black),并给出 pyproject.toml 配置示例,如 line-length=120、target-version="py312",lint 选择 E、W、F、I、B、C4、UP、SIM 等规则,忽略 E501。类型检查可用 mypy 严格模式(strict=true、disallow_untyped_defs 等),或改用 pyright 的 strict 模式。命名遵循 PEP 8:模块与函数用 snake_case,类用 PascalCase,常量用 SCREAMING_SNAKE_CASE,强调描述性而非缩写。导入按标准库、第三方、本地分组,推荐绝对导入。文档采用 Google 风格 docstring,覆盖 Args、Returns、Raises、Example,公共 API 均需 docstring。还涉及 README 结构与 Keep a Changelog 格式。

使用方式:安装 pip install ruff mypy;运行 ruff check --fix . 与 ruff format .;在 pyproject.toml 中配置各工具。建议在 CI 中自动运行 linter,新项目目标 Python 3.10+,推荐 3.12+。

适用场景:全栈开发最佳实践、代码架构与性能优化建议、代码审查。

限制:需要具体项目上下文与技术栈信息;不处理非技术业务决策,仅提供指导而非具体实现。内容源自 wshobson/agents(MIT License, Copyright (c) 2024 Seth Hobson),使用与再分发须遵守该许可并保留版权声明。