讲师中心 微信公众号
AI工具推荐 视频效率加速

Python如何快速创建一个符合标准的包结构_使用Cookiecutter模板

梦晨姑娘_9815

梦晨姑娘_9815

发布时间:2026-05-23 08:53:47

|

813人浏览过

|

来源于php中文网

原创

手动建包目录易出错,Cookiecutter可一键生成符合PEP 517/518、src/布局、pyproject.toml、测试目录及type stubs等现代规范的可发布结构,避免import失败、pip install -e .报错等问题。

python如何快速创建一个符合标准的包结构_使用cookiecutter模板

为什么不用手动建包目录,而要用 Cookiecutter

手动创建符合 pyproject.toml、src/ 布局、测试目录、type stubs 等标准的 Python 包结构,容易漏掉 __init__.py 位置、搞错 packages 发布配置、或把测试文件混进源码里。Cookiecutter 本质是模板填充工具,它不运行代码,只按变量替换生成静态文件树——这意味着你拿到的是“已验证过可发布的结构”,不是靠文档脑补出来的。

常见错误现象:pip install -e . 失败、import mypkg 报 ModuleNotFoundError、CI 上 pytest 找不到测试——八成源于初始结构没对齐现代打包规范(PEP 517/518 + setuptools 或 hatch)。

选哪个 Cookiecutter 模板最稳妥

推荐用 audreyr/cookiecutter-pypackage(维护活跃、支持 src/ 布局和 pyproject.toml),避免用已归档的旧模板(如 cookiecutter-pypackage-minimal)。注意它默认生成的是 setup.py + setup.cfg 混合结构,你需要主动选 use_pyproject 为 y,否则会退回旧式打包流程。

执行命令时关键参数:

立即学习“Python免费学习笔记(深入)”;

  • cookiecutter https://github.com/audreyr/cookiecutter-pypackage
  • 遇到 use_pyproject [n]: → 输 y
  • 遇到 use_src_layout [y]: → 输 y(强制 src/mypkg/,避免 import 冲突)
  • 遇到 command_line_interface [no]: → 按需输 click 或留空

生成后立刻检查根目录是否存在 pyproject.toml,且里面包含 [build-system] 和 [project] 段——没有就说明模板没走对路径。

python-script-generator
python-script-generator

快速生成专业的 Python 脚本和应用代码。一键创建完整项目结构,支持CLI、API、爬虫、Bot、Django等多种项目类型,包含完整的项目结构、配置文件、依赖管理、测试、README和文档。

下载

生成后必须改的三处配置

Cookiecutter 只填骨架,不替你写业务逻辑,但以下三处不改,包根本跑不起来:

  • pyproject.toml 中的 project.name 必须和 src/ 下实际包名一致(比如 project.name = "mycoolpkg" → 目录必须是 src/mycoolpkg/)
  • src/mycoolpkg/__init__.py 至少要有一行 __version__ = "0.1.0",否则 importlib.metadata.version("mycoolpkg") 会炸
  • tests/ 下的 conftest.py 如果存在,确认它没硬编码 sys.path.insert(0, "..") —— src/ 布局下 pytest 默认能发现包,加这个反而导致导入重复

验证方式:在项目根目录运行 python -m build,成功输出 dist/mypkg-0.1.0-py3-none-any.whl;再用 pip install dist/*.whl,然后 python -c "import mycoolpkg; print(mycoolpkg.__version__)" 能打印版本即通过。

为什么 src/ 布局比平铺更安全

新手常把模块直接放项目根目录(mycoolpkg.py),结果 pytest 在根目录跑时会把当前路径加入 sys.path,导致 import 的是本地文件而非已安装包,掩盖了 import 路径 bug。而 src/ 布局强制所有代码在 src/ 下,配合 pyproject.toml 中 packages = [{include = "mycoolpkg", from = "src"}],让构建工具和 IDE 都明确知道“源码在哪、发布什么”。

性能影响几乎为零,但兼容性上要注意:某些老 CI 脚本(比如硬写 python setup.py test)会失效,必须改用 pytest --pyargs mycoolpkg 或 python -m pytest tests/。

真正容易被忽略的是:PyCharm 默认不把 src/ 标为 Sources Root,得右键目录 → Mark Directory as → Sources Root,否则类型提示和跳转会断。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1651

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

4104

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1649

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

23757

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2907

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2947

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1143

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

596

2023.08.10

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn