python-code-style

概览

什么是 python-code-style？

python-code-style 是一项技能，旨在帮助开发者和团队强制执行统一的 Python 代码风格，包括代码检查、格式化、命名规范和文档标准。通过整合现代 Python 工具和最佳实践，该技能使代码库更易维护且便于协作。

谁适合使用此技能？

此技能适合希望做到以下几点的 Python 开发者、代码审查者和团队：

• 为新项目设置代码检查和格式化
• 审查代码风格一致性
• 配置如 ruff、mypy 或 pyright 等工具
• 制定团队编码标准
• 编写和维护清晰的文档字符串
• 创建并执行项目文档规范

解决的问题

python-code-style 解决了 Python 开发中的常见挑战：

• 通过自动化风格强制减少手动格式争议
• 确保代码遵循 PEP 8 命名规范
• 维护代码与文档同步
• 鼓励公共 API 使用类型注解

使用方法

安装步骤

1. 使用以下命令安装技能：
   npx skills add https://github.com/wshobson/agents --skill python-code-style
2. 查看 SKILL.md 文件，快速了解推荐的实践和工具。
3. 浏览 README.md、AGENTS.md 和 metadata.json 等支持文件，获取更多背景信息。

配置 Python 工具链

• 安装现代 Python 工具：

  pip install ruff mypy
  

• 在 pyproject.toml 中配置项目：

  [tool.ruff]
  line-length = 120
  target-version = "py312"
  
  [tool.mypy]
  strict = true
  

• 使用 ruff 作为主要的代码检查和格式化工具。它可以替代 flake8、isort 和 black，满足大多数工作流需求。

适应您的工作流程

• 首先预览 SKILL.md 文件，了解核心概念和模式。
• 根据项目需求和最低 Python 版本调整配置。
• 将类型提示和文档字符串维护纳入代码审查流程。

常见问题

python-code-style 涵盖哪些内容？

python-code-style 涵盖 Python 代码风格、代码检查、格式化、命名规范和文档标准。它提供维护高质量 Python 代码的指导和工具推荐。

推荐使用哪些工具？

该技能推荐使用 ruff 进行代码检查和格式化，使用 mypy 进行类型检查。配置示例见 SKILL.md。

如何预览技能的指导内容？

打开文件标签页，从 SKILL.md 开始查看编辑总结。其他参考资料和脚本可能位于子文件夹中。

python-code-style 适合所有 Python 项目吗？

此技能最适合注重代码质量、一致性和可维护性的项目。对于快速原型或对风格要求不高的脚本，可能不必强制使用。