代码质量
本章讲解 Python 代码规范、测试和文档编写的最佳实践。
章节导航
| 章节 | 文件 | 主题 |
|---|---|---|
| 01 | 01-代码规范.md | PEP 8、类型提示、格式化工具 |
| 02 | 02-单元测试.md | pytest、Fixtures、Mock |
| 03 | 03-文档编写.md | 文档字符串、Sphinx、MkDocs |
核心知识点
代码规范
- PEP 8 风格指南
- 类型提示（typing）
- Black / Ruff 格式化工具
- pre-commit 钩子
单元测试
- pytest 测试框架
- Fixtures 共享测试数据
- Mock 模拟外部依赖
- 测试覆盖率
文档编写
- Google 风格文档字符串
- Sphinx API 文档
- MkDocs 用户文档
- README 最佳实践