Real Python · Philipp Acsany
How to Use Claude Code Skills for Better Python Docstrings
How to Use Claude Code Skills for Better Python Docstrings是Real Python的免费实践教程(en)。前置条件:需要会写 Python 函数、类与 docstring,熟悉终端基本命令和 Markdown 编辑;网页称若你是 Claude Code 新手,可先看 How to Use Claude Code to Write and Debug Python。
学习者能在项目中创建一个名为 docstring-doctor 的 Claude Code skill,让 Claude 按固定的 Google 风格规则为 Python 代码给出 docstring 建议。
- 难度
- 见前置条件
- 类型
- 博客与教程 · 实践教程
- 语言
- en
- 规模
- 1 个课节
- 内容费用
- 免费
- 动手
- 需要动手环境
选择学习环境
按你的电脑系统准备;提示词在你自己的电脑上使用。
本机动手
先在临时项目 skills-demo 里观察 Claude 的默认输出,再创建 .claude/skills/docstring-doctor/SKILL.md,重开会话后对比同一提示的结果。
已安装并登录 Claude Code(示例在 Claude Code 2.1.273 下核对);Python 3.12 或更高版本(示例在 Python 3.14.6 下核对);Linux/WSL 的 Bash 或 macOS 的 zsh/Bash;若 python3 不是启动 Python 的命令,用你自己的命令替代。
准备工具和账号
标“选用”的可以跳过。
- Claude Code 运行 skill、生成 docstring 建议
- Python 3.12+ 运行教程中的示例模块与后续辅助脚本
- 终端(Bash/zsh)创建目录、启动 claude 会话
让 AI Agent 一次搭好课程
复制开课提示词发给你常用的 AI Agent。它会下载允许保存的官方材料、建立课节目录并自检;需要账号、权限或费用时会先问你。
开课提示词 · 只需用一次此提示词尚未实测验证请帮我把「How to Use Claude Code Skills for Better Python Docstrings」的学习环境一次准备好,让我之后只需要按顺序学习和做练习。 开始前先问我:课程放在哪个目录(等我给出完整路径),确认我的操作系统和已有工具。确认前不要创建文件或安装软件。 课程入口:https://realpython.com/claude-code-skills/ 我的系统:macOS。如果实际不符,先调整方案。 本次路线:macOS:本机动手。只准备这条路线需要的工具;只读路线不安装运行环境、不配置模型密钥。 练习:按教程正文继续练习:重开会话后反复用同一提示对比输出,并阅读 Step 2、Step 3 的正文做后续扩展。 课节(官方顺序): 1. How to Use Claude Code Skills for Better Python Docstrings:https://realpython.com/claude-code-skills/ 1. 环境 - Claude Code 已安装并登录 - Python 3.12 或更高版本 - Bash(Linux/WSL)或 zsh/Bash(macOS) - 安装前先列出要装的软件和命令,等我同意;已装好的直接复用。 2. 材料 - 官方课程页面:只记录链接 https://realpython.com/claude-code-skills/ 3. 目录(最外层放在我确认的位置) claude-code-skills-docstrings/ ├── README.md # 课程入口、课节清单、每次怎么开始 ├── progress.md # 每课:读讲义 / 做练习 / 记笔记 ├── questions.md # 待解决的问题 ├── check-env.sh # 环境自检,按 README 操作 ├── data/ # 练习用到的样例数据 └── lessons/ # 每课一个文件夹:notes.md + exercises/ └── 01-01-how-to-use-claude-code/ - 每课文件夹里建 notes.md(顶部写本课官方链接)和 exercises/;课节文件夹名称与上面一致。 - 已有课程目录先检查并复用;不覆盖笔记、作业或 progress.md,不重置已有进度。尚未发布的课节保留入口并注明未发布,不能代写讲义或虚构练习。 4. 自检 - 创建 check-env.sh,逐项检查并记录“通过/未通过”: - 在课程根目录运行;每项检查独立执行,进入子目录不能影响下一项。使用当前系统的终端运行。 - ls .claude/skills/docstring-doctor/SKILL.md → 列出 SKILL.md 路径,说明 skill 文件已建立 - python3 --version → 输出 3.12 或更高版本号 - 在 claude 会话中重复“Suggest docstrings for inventory.py without editing the file.” → 回答包含 Args/Returns/Raises 小节,且提到 restock() 抛出的 ValueError - 标注为人工检查、浏览器操作或 notebook 单元的项目,按相应方式操作,不直接粘贴进 shell;脚本只包含当前系统可执行的命令。 - 仅在当前路线需要、对应材料已获准保存、工具已安装时运行该项;需要登录、付费或尚未开放的材料记为“需要我操作/未验证”,不能伪报通过。不执行会调用付费 API、提交作业或修改云服务的检查。 - 运行一次,把结果给我看;未通过的项目说明原因和修复办法。 5. 学习计划 - README.md:课程入口、课节清单(带链接)、每次学习怎么开始(使用“每课提示词”)。 - progress.md:每课三项勾选——读讲义、做练习、记笔记。 6. 最后分三部分汇报:已完成、需要我自己操作的、尚未验证的。 边界: - 需要管理员权限、会产生费用或需要填写密钥的操作,先告诉我原因,等我同意。密钥由我在本机配置,不发到聊天,不写进笔记或版本库;原项目需要 .env 时确认已被 Git 忽略。 - 不替我写练习或作业答案,也不替我提交。我卡住时只给提示;我明确要求时才给解答。 - 只下载许可允许个人保存的材料;其余只放链接。不把未运行的命令说成成功。 如果你不能直接操作我的文件系统,请在确认目录后给出适用于我的系统、可直接执行的命令和需要保存的文件内容。搭好后的课程目录
claude-code-skills-docstrings/ ├── README.md # 课程入口、课节清单、每次怎么开始 ├── progress.md # 每课:读讲义 / 做练习 / 记笔记 ├── questions.md # 待解决的问题 ├── check-env.sh # 环境自检,按 README 操作 ├── data/ # 练习用到的样例数据 └── lessons/ # 每课一个文件夹:notes.md + exercises/ └── 01-01-how-to-use-claude-code/
常见问题
免费吗?
免费:节选可直接读到前置条件、示例模块与第 1 步正文、代码和文件内容,未见正文付费墙;导航栏 “Unlock All Content” 属站点会员入口,不计入本资源费用。实践无额外费用:网页写明辅助脚本只使用标准库,无需安装任何东西;练习使用免费的 Python 3.12+ 即可。
需要什么基础?
需要会写 Python 函数、类与 docstring,熟悉终端基本命令和 Markdown 编辑;网页称若你是 Claude Code 新手,可先看 How to Use Claude Code to Write and Debug Python。软件、账号与硬件:已安装并登录 Claude Code(示例在 Claude Code 2.1.273 下核对);Python 3.12 或更高版本(示例在 Python 3.14.6 下核对);Linux/WSL 的 Bash 或 macOS 的 zsh/Bash;若 python3 不是启动 Python 的命令,用你自己的命令替代。
有中文吗?
本站记录的语言是en;是否有中文字幕或译本本站未核实,请以原站为准。
怎么开始?
从原始资源入口开始:https://realpython.com/claude-code-skills/。本页“学前准备”列出环境与工具,“学习指南”给出开课提示词,可以在自己的电脑上按步骤开始。
来源与使用须知
- 原始资源
- Real Python
- 收录时间
- 本站首次收录 2026-10-22
- 指南参考
- 课程主页
版权与转载
- 课程材料未标明许可:仅供个人学习,转载、修改或商用前请先联系原作者。
- 本站只提供原始链接和学习指南,不转载、不镜像课程材料;引用时请注明原作者与出处。