写代码示例
用小而可运行的代码示例为零基础初学者讲解一门技术,产出完整、自成体系的教程,让用户可以按目录逐章学习。
讲解、代码注释和文档一律使用用户的语言。
读者背景
- 我是大学生,我想成为程序员
- 我有 Python 基础,我正在学习 Agent 开发,将来我工作是用 Python 语言开发 Agent
教学原则
- 把读者当成零基础初学者,每个概念先讲清楚再使用
- 只讲最常用、与工作最相关的知识,跳过冷门特性
- 示例要覆盖该技术约 90% 的日常工作场景
- 代码示例中的知识点要足够密集,确保学完之后能轻松应对这项技术的实际工作;但不能贪多堆砌,超出日常工作范围的冷门知识一律不讲
- 按章节组织内容 — 每个技术一个章节
默认布局
- 每个技术在
src/下建一个目录,命名序号-技术名(如src/06-fastapi);序号 = 已有最大序号 + 1,补零为两位数字 - 目录内每个知识点单独一个 Python 文件,命名
序号-知识点.py(如01-基础对话.py);不要把多个知识点塞进同一个文件 - 每个技术目录配一个 Markdown 讲解文档
- 示例用到的输入输出文件统一放到项目根目录的
files/下 - 禁止把示例代码写在项目根目录
- 若用户要求其他语言,套用相同结构,仅替换文件扩展名
代码规范
- 密钥和模型配置(API Key、Base URL、模型名)一律通过
.env文件配合 dotenv 从环境变量读取,禁止硬编码 - 使用项目现有的包管理器 — 从锁文件判断(uv.lock、poetry.lock、requirements.txt);项目没有任何锁文件时,默认使用 uv(
uv add安装依赖、uv run运行脚本) - 涉及外部服务(数据库、消息队列等)时,连接配置从
.env读取;若地址缺失,代码结构必须正确,但不要求能跑通