# Python Code Quality: Best Practices and Tools
- 发布方：Real Python；作者：Leodanis Pozo Ramos
- 形式：文章 · en
- 原始资源：[https://realpython.com/python-code-quality/]()
- 本站页面：[https://oplearnx.com/resources/res\_cmrcj2rs2a7q]()
- 学习主题：计算机科学 / 编程与软件工程 / Python；计算机科学 / 编程与软件工程；计算机科学 / 编程与软件工程 / 软件测试
- 内容状态：状态待核验
- 原始发布时间：2026-10-25 22:00
- 本站首次收录：2026-10-27 00:12
## 能学到什么
读完能说清高质量 Python 代码的判定标准，并用风格指南、评审、linter、类型检查、格式化、测试、性能剖析、漏洞检查等工具维护代码质量。
- 列举高质量代码的关键特征（功能性、可读性、文档、合规、可复用、可维护、健壮、可测试、高效、可扩展、安全）
- 区分低质量与高质量代码，并说明代码质量对项目的意义
- 用 PEP 8 等风格指南和格式化工具（如 black、isort）统一代码风格
- 用 pylint、flake8、ruff 等 linter 和 mypy 等静态类型检查器发现代码问题
- 用 pytest、unittest、doctest、tox/nox 组织与运行测试
- 用 cProfile、timeit 等剖析工具评估并改进代码效率
- 权衡可读性、效率、安全等质量特性之间的取舍，并判断何时做质量检查
## 适合我吗
- 适合：适合已能写 Python 脚本、想把项目代码写得更规范可维护的中级学习者，文中给出大量工具与最佳实践。
- 需要留意：不适合零基础学 Python 语法的人，也不覆盖具体框架或项目的完整开发流程。
## 前置条件与费用
- 知识前置：需要会写基本 Python 函数、类与模块，并了解异常处理、测试等基础概念。
- 软件、账号与硬件：需自备可运行 Python 的本地环境；文中提到的示例代码需从站点下载，练习涉及安装 linter、格式化与测试工具。
- 内容费用：免费：节选里可直接读到文章正文主体内容，导航中的“Unlock All Content”会员入口不改变本资源费用。
- 实践费用：实践无额外费用：网页未提及练习需要付费云服务或 API。
- 转载与修改：按材料分别核对，见本页“来源核验与开课实跑”；仓库许可不自动适用于教材或视频。
## 准备工具
- Python 3：运行文中示例与练习代码
- 浏览器：阅读文章正文与目录
- ruff / black / isort：练习代码风格检查与格式化
- mypy：练习静态类型检查
- pytest：练习编写与运行测试
## 学习指南
开课检查：提示词由本站整理，尚未按提示词实际完成开课检查。
### 开课提示词（Windows）
```text
请帮我把「Python Code Quality: Best Practices and Tools」的学习环境一次准备好，让我之后只需要按顺序学习和做练习。
开始前先问我：课程放在哪个目录（等我给出完整路径），确认我的操作系统和已有工具。确认前不要创建文件或安装软件。
课程入口：https://realpython.com/python-code-quality/
我的系统：Windows。如果实际不符，先调整方案。
本次路线：Windows：本机动手。只准备这条路线需要的工具；只读路线不安装运行环境、不配置模型密钥。
练习：在自己的小项目或示例脚本上依次运行 linter、格式化、类型检查与测试，并按剖析结果做一次小优化。
课节（官方顺序）：
1. Python Code Quality: Best Practices and Tools（主页）：https://realpython.com/python-code-quality/
1. 环境
- 本地 Python 3 虚拟环境
- 可选：ruff、black、isort、mypy、pytest 等工具链
- 安装前先列出要装的软件和命令，等我同意；已装好的直接复用。
2. 材料
- 官方课程页面：只记录链接 https://realpython.com/python-code-quality/
3. 目录（最外层放在我确认的位置）
python-code-quality-real-python/
├── README.md # 课程入口、课节清单、每次怎么开始
├── progress.md # 每课：读讲义 / 做练习 / 记笔记
├── questions.md # 待解决的问题
├── check-env.ps1 # 环境自检，按 README 操作
├── data/ # 练习用到的样例数据
└── lessons/ # 每课一个文件夹：notes.md + exercises/
└── 01-01-python-code-quality-best-practices/
- 每课文件夹里建 notes.md（顶部写本课官方链接）和 exercises/；课节文件夹名称与上面一致。
- 已有课程目录先检查并复用；不覆盖笔记、作业或 progress.md，不重置已有进度。尚未发布的课节保留入口并注明未发布，不能代写讲义或虚构练习。
4. 自检
- 创建 check-env.ps1，逐项检查并记录“通过/未通过”：
- 在课程根目录运行；每项检查独立执行，进入子目录不能影响下一项。将下面检查转换为 PowerShell 命令，不使用 Bash 语法。
- python -c "import sys; print(sys.version)" → 输出可用的 Python 3 版本号
- 打开 https://realpython.com/python-code-quality/ 确认正文与目录可见 → 页面显示文章标题、目录和正文段落
- 标注为人工检查、浏览器操作或 notebook 单元的项目，按相应方式操作，不直接粘贴进 shell；脚本只包含当前系统可执行的命令。
- 仅在当前路线需要、对应材料已获准保存、工具已安装时运行该项；需要登录、付费或尚未开放的材料记为“需要我操作/未验证”，不能伪报通过。不执行会调用付费 API、提交作业或修改云服务的检查。
- 运行一次，把结果给我看；未通过的项目说明原因和修复办法。
5. 学习计划
- README.md：课程入口、课节清单（带链接）、每次学习怎么开始（使用“每课提示词”）。
- progress.md：每课三项勾选——读讲义、做练习、记笔记。
6. 最后分三部分汇报：已完成、需要我自己操作的、尚未验证的。
边界：
- 需要管理员权限、会产生费用或需要填写密钥的操作，先告诉我原因，等我同意。密钥由我在本机配置，不发到聊天，不写进笔记或版本库；原项目需要 .env 时确认已被 Git 忽略。
- 不替我写练习或作业答案，也不替我提交。我卡住时只给提示；我明确要求时才给解答。
- 只下载许可允许个人保存的材料；其余只放链接。不把未运行的命令说成成功。
如果你不能直接操作我的文件系统，请在确认目录后给出适用于我的系统、可直接执行的命令和需要保存的文件内容。
```
### 开课提示词（macOS）
```text
请帮我把「Python Code Quality: Best Practices and Tools」的学习环境一次准备好，让我之后只需要按顺序学习和做练习。
开始前先问我：课程放在哪个目录（等我给出完整路径），确认我的操作系统和已有工具。确认前不要创建文件或安装软件。
课程入口：https://realpython.com/python-code-quality/
我的系统：macOS。如果实际不符，先调整方案。
本次路线：macOS：本机动手。只准备这条路线需要的工具；只读路线不安装运行环境、不配置模型密钥。
练习：在自己的小项目或示例脚本上依次运行 linter、格式化、类型检查与测试，并按剖析结果做一次小优化。
课节（官方顺序）：
1. Python Code Quality: Best Practices and Tools（主页）：https://realpython.com/python-code-quality/
1. 环境
- 本地 Python 3 虚拟环境
- 可选：ruff、black、isort、mypy、pytest 等工具链
- 安装前先列出要装的软件和命令，等我同意；已装好的直接复用。
2. 材料
- 官方课程页面：只记录链接 https://realpython.com/python-code-quality/
3. 目录（最外层放在我确认的位置）
python-code-quality-real-python/
├── README.md # 课程入口、课节清单、每次怎么开始
├── progress.md # 每课：读讲义 / 做练习 / 记笔记
├── questions.md # 待解决的问题
├── check-env.sh # 环境自检，按 README 操作
├── data/ # 练习用到的样例数据
└── lessons/ # 每课一个文件夹：notes.md + exercises/
└── 01-01-python-code-quality-best-practices/
- 每课文件夹里建 notes.md（顶部写本课官方链接）和 exercises/；课节文件夹名称与上面一致。
- 已有课程目录先检查并复用；不覆盖笔记、作业或 progress.md，不重置已有进度。尚未发布的课节保留入口并注明未发布，不能代写讲义或虚构练习。
4. 自检
- 创建 check-env.sh，逐项检查并记录“通过/未通过”：
- 在课程根目录运行；每项检查独立执行，进入子目录不能影响下一项。使用当前系统的终端运行。
- python -c "import sys; print(sys.version)" → 输出可用的 Python 3 版本号
- 打开 https://realpython.com/python-code-quality/ 确认正文与目录可见 → 页面显示文章标题、目录和正文段落
- 标注为人工检查、浏览器操作或 notebook 单元的项目，按相应方式操作，不直接粘贴进 shell；脚本只包含当前系统可执行的命令。
- 仅在当前路线需要、对应材料已获准保存、工具已安装时运行该项；需要登录、付费或尚未开放的材料记为“需要我操作/未验证”，不能伪报通过。不执行会调用付费 API、提交作业或修改云服务的检查。
- 运行一次，把结果给我看；未通过的项目说明原因和修复办法。
5. 学习计划
- README.md：课程入口、课节清单（带链接）、每次学习怎么开始（使用“每课提示词”）。
- progress.md：每课三项勾选——读讲义、做练习、记笔记。
6. 最后分三部分汇报：已完成、需要我自己操作的、尚未验证的。
边界：
- 需要管理员权限、会产生费用或需要填写密钥的操作，先告诉我原因，等我同意。密钥由我在本机配置，不发到聊天，不写进笔记或版本库；原项目需要 .env 时确认已被 Git 忽略。
- 不替我写练习或作业答案，也不替我提交。我卡住时只给提示；我明确要求时才给解答。
- 只下载许可允许个人保存的材料；其余只放链接。不把未运行的命令说成成功。
如果你不能直接操作我的文件系统，请在确认目录后给出适用于我的系统、可直接执行的命令和需要保存的文件内容。
```
### 开课提示词（Linux）
```text
请帮我把「Python Code Quality: Best Practices and Tools」的学习环境一次准备好，让我之后只需要按顺序学习和做练习。
开始前先问我：课程放在哪个目录（等我给出完整路径），确认我的操作系统和已有工具。确认前不要创建文件或安装软件。
课程入口：https://realpython.com/python-code-quality/
我的系统：Linux。如果实际不符，先调整方案。
本次路线：Linux：本机动手。只准备这条路线需要的工具；只读路线不安装运行环境、不配置模型密钥。
练习：在自己的小项目或示例脚本上依次运行 linter、格式化、类型检查与测试，并按剖析结果做一次小优化。
课节（官方顺序）：
1. Python Code Quality: Best Practices and Tools（主页）：https://realpython.com/python-code-quality/
1. 环境
- 本地 Python 3 虚拟环境
- 可选：ruff、black、isort、mypy、pytest 等工具链
- 安装前先列出要装的软件和命令，等我同意；已装好的直接复用。
2. 材料
- 官方课程页面：只记录链接 https://realpython.com/python-code-quality/
3. 目录（最外层放在我确认的位置）
python-code-quality-real-python/
├── README.md # 课程入口、课节清单、每次怎么开始
├── progress.md # 每课：读讲义 / 做练习 / 记笔记
├── questions.md # 待解决的问题
├── check-env.sh # 环境自检，按 README 操作
├── data/ # 练习用到的样例数据
└── lessons/ # 每课一个文件夹：notes.md + exercises/
└── 01-01-python-code-quality-best-practices/
- 每课文件夹里建 notes.md（顶部写本课官方链接）和 exercises/；课节文件夹名称与上面一致。
- 已有课程目录先检查并复用；不覆盖笔记、作业或 progress.md，不重置已有进度。尚未发布的课节保留入口并注明未发布，不能代写讲义或虚构练习。
4. 自检
- 创建 check-env.sh，逐项检查并记录“通过/未通过”：
- 在课程根目录运行；每项检查独立执行，进入子目录不能影响下一项。使用当前系统的终端运行。
- python -c "import sys; print(sys.version)" → 输出可用的 Python 3 版本号
- 打开 https://realpython.com/python-code-quality/ 确认正文与目录可见 → 页面显示文章标题、目录和正文段落
- 标注为人工检查、浏览器操作或 notebook 单元的项目，按相应方式操作，不直接粘贴进 shell；脚本只包含当前系统可执行的命令。
- 仅在当前路线需要、对应材料已获准保存、工具已安装时运行该项；需要登录、付费或尚未开放的材料记为“需要我操作/未验证”，不能伪报通过。不执行会调用付费 API、提交作业或修改云服务的检查。
- 运行一次，把结果给我看；未通过的项目说明原因和修复办法。
5. 学习计划
- README.md：课程入口、课节清单（带链接）、每次学习怎么开始（使用“每课提示词”）。
- progress.md：每课三项勾选——读讲义、做练习、记笔记。
6. 最后分三部分汇报：已完成、需要我自己操作的、尚未验证的。
边界：
- 需要管理员权限、会产生费用或需要填写密钥的操作，先告诉我原因，等我同意。密钥由我在本机配置，不发到聊天，不写进笔记或版本库；原项目需要 .env 时确认已被 Git 忽略。
- 不替我写练习或作业答案，也不替我提交。我卡住时只给提示；我明确要求时才给解答。
- 只下载许可允许个人保存的材料；其余只放链接。不把未运行的命令说成成功。
如果你不能直接操作我的文件系统，请在确认目录后给出适用于我的系统、可直接执行的命令和需要保存的文件内容。
```
### 每课提示词
```text
继续学习「Python Code Quality: Best Practices and Tools」。课程目录是 python-code-quality-real-python/（不知道完整路径就先问我）。
1. 读 progress.md，找到下一课；如果我指定了第几课，就准备那一课。
2. 打开这一课的官方页面和本地讲义，列出本课练习要用的工具、文件和样例数据。缺少的先告诉我，等我同意再安装或下载。
3. 在 lessons/ 对应的课节文件夹里准备好练习：exercises/ 里给每道题建一个文件，写上题号和题目原文链接，不写答案；已有文件保留，样例数据放到 data/。拿不到官方题目或起始代码时记录限制，不编造替代品。
4. 按 README 运行开课时生成的自检脚本或在线检查清单，并检查本课新增工具能否正常使用。
5. 告诉我：本课先读哪几节、从哪道练习开始、大约需要多久。我学完后，帮我在 progress.md 勾选并把问题整理到 questions.md。
边界：
- 需要管理员权限、会产生费用或需要填写密钥的操作，先告诉我原因，等我同意。密钥由我在本机配置，不发到聊天，不写进笔记或版本库；原项目需要 .env 时确认已被 Git 忽略。
- 不替我写练习或作业答案，也不替我提交。我卡住时只给提示；我明确要求时才给解答。
- 只下载许可允许个人保存的材料；其余只放链接。不把未运行的命令说成成功。
```
### 课节（官方顺序）
1. [Python Code Quality: Best Practices and Tools（主页）]()
## 指南参考
- [课程主页]()
## 来源、许可与验证记录
- **开课提示词未完整验证，需要自备账号或资源**：Real Python 会员或直播课报名（Intermediate Python Deep Dive）
- **内容提示**：原站推广：正文是完整的代码质量教程，同时推广 Real Python 自己的直播课 Intermediate Python Deep Dive 与“Unlock All Content”会员订阅。；付费内容：网页写明本资源自己的配套课程“Managing and Measuring Python Code Quality”（50m · 14 lessons）与会员订阅、直播课需付费加入，文章正文本身可免费阅读。
- 转载与修改 · 课程页面与材料：未找到明确许可。节选未写出本文章的许可名称，仅见站点会员与课程等商业入口 [依据]()
- 链接检查：1/1 个可以访问
## 来源与推荐
- 编辑整理收录
---
来源：LearnMap · 学径（https://oplearnx.com）