规划仓库结构
你在前面的综合项目里做出了真东西:一个客服副驾驶、一个文档提取器、一个评测关卡。现在它多半还是一堆单元格或一个长长的脚本。打开它的招聘经理只能猜东西在哪里,而克隆下来却看不到明显运行方式的招聘人员会直接关掉标签页。对一个作品集项目来说,你能做的最有杠杆的一件事,就是给它一个平淡、合乎惯例的结构,让任何人都能在 30 秒内找到方向。
先说实话:这个模块讲的是仓库,而不是实际部署到云上。我们没法在你的浏览器里启动服务器或推送到主机上,也不打算假装可以。你在这里能学到并证明的,是结构、测试和一条命令就能运行,有了这些,以后部署就轻而易举。最后的部署说明就只是说明,并标明不评分。
几乎每个 Python 项目最终都会收敛到的结构:
my_project/
README.md # what it is + how to run it
pyproject.toml # name, version, dependencies
.env.example # the shape of the secrets (NEVER the real ones)
src/
my_project/ # the importable package
__init__.py
__main__.py # runs on `python -m my_project`
core.py # your actual code
tests/
test_my_project.py # pytest finds these by the test_ prefix
注意两点。第一,包放在 src/ 下一个以项目命名的文件夹里,这就是"src 布局",它能防止你的测试意外导入本地文件夹,而不是已安装的包。第二,包目录的名字跟着项目名走:一个叫 triage 的项目得到 src/triage/,一个叫 copilot 的项目得到 src/copilot/。没有一个固定的答案:这棵目录树是名字的函数。
你的任务就是写出这个函数。build_manifest(name) 接收一个项目名,以已排序的路径字符串列表的形式,返回仓库应该包含的文件列表。它必须包含 README.md、pyproject.toml、src/<name>/ 下一个装着 __init__.py 和一个模块文件的包目录,以及一个 tests/test_*.py 文件。把名字规范化成一个有效的包目录(小写,并把空格和连字符变成下划线,因为 doc-extractor 不是可导入的模块名,而 doc_extractor 是)。
这就是一个脚手架脚本会在磁盘上创建的清单。我们不在评分器里写文件:我们检查的是你能否为任何项目名描述出正确的目录树。按 Run 打印一个叫 triage 的项目的结构。
写 build_manifest(name),以已排序的路径字符串列表返回一个项目的仓库文件树。它必须包含 README.md、pyproject.toml、src/<pkg>/ 下的包目录,其中有一个 __init__.py、一个 __main__.py(正是这个文件让第 3 课的运行命令 python -m <pkg> 能够工作),以及至少一个其他的模块 .py 文件,还有一个名为 tests/test_<pkg>.py 的测试文件。把 name 规范化成包目录(小写,空格和连字符变成下划线),这样不同的项目名会产生不同的目录树。
这个练习即将开放
完成它前面的那一课,这一课就会解锁。整门课程免费,无需账号,而且你现在就可以阅读这节课。
这个浏览器屏蔽了 learn.floati.life 的 Cookie,所以你在这里完成的课程无法按顺序打开。请允许这个网站使用 Cookie,然后重新加载。