讲师中心 微信公众号

工具推荐

视频效率加速
updream

一键生成高质量推广成片

AniShort
AniShort

AI短剧协同制作平台

Seko
Seko

AI短剧一键生成成片

Laper
Laper

剧本策划到成片协作

Python 项目规模扩大后的组织方式

大静君_6998

大静君_6998

发布时间:2026-02-23 18:33:09

|

509人浏览过

|

来源于php中文网

原创

根本原因是 Python 的 sys.path 未包含预期父目录;应统一用绝对导入、以项目根目录为基准,配合 __init__.py 和 python -m 启动,避免手动修改 sys.path。

python 项目规模扩大后的组织方式

模块拆分时 import 路径总报 ModuleNotFoundError

根本原因是 Python 的 sys.path 没包含你认为“理所当然”的父目录,不是路径写错了,而是解释器根本没去那里找。项目一深,from src.utils import helper 这种写法在不同执行位置(比如从根目录 run、从 tests 目录 run、用 pytest 执行)行为不一致。

实操建议:

  • 统一用绝对导入:所有 import 都基于项目根目录,根目录下必须有 __init__.py(哪怕空文件),并确保运行时当前工作目录是根目录(或通过 -m 方式启动)
  • 避免在代码里手动改 sys.path.append(...) —— 这会让模块位置变得隐式且难调试
  • 用 python -m src.main 启动,而不是 python src/main.py;前者把 src 当作包,后者把它当脚本,加载机制完全不同
  • 如果必须支持多入口,用 setuptools 配 pyproject.toml 中的 [project.entry-points."console_scripts"],让 pip install -e . 后能直接调命令

什么时候该建子包而不是平铺一堆 .py 文件

不是看文件数量,而是看职责是否形成可复用、可隔离的语义单元。比如 auth 里混着数据库模型、HTTP 路由、密码策略,后期想抽出来给另一个项目用?不可能。但如果你把 auth/models.py、auth/providers.py、auth/exceptions.py 放一起,并对外只暴露 auth.get_user() 和 auth.InvalidTokenError,那它就具备了子包价值。

判断信号:

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

Python 环境工具专业版
Python 环境工具专业版

Python 环境工具专业版功能概述Python 环境工具专业版是一项面向实际任务的技能。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。核心要点使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。执行完成后建议检查结果是否符合预期,并保留必要记录。使用与执行同时注意输入完整性、执行条件和输出可用性。从功能定位来看,该技能

下载
  • 多个模块频繁互相 from . import xxx,且外部几乎不直接引用内部模块 → 适合收进子包
  • __init__.py 开始承担“门面”职责:聚合导出接口、设置默认配置、触发初始化逻辑
  • 测试目录结构开始镜像源码结构(tests/auth/test_providers.py 对应 auth/providers.py)→ 结构已自然分层
  • CI 中想单独运行某块测试(如 pytest tests/auth),但当前平铺导致无法精准切分

setup.py 已淘汰,pyproject.toml 怎么配才算“生产可用”

很多团队配完 pyproject.toml 就以为万事大吉,结果别人 clone 下来 pip install -e . 报错,或者 CI 里依赖版本冲突。问题常出在三个字段没对齐:包发现方式、依赖声明粒度、Python 版本约束。

关键配置项和避坑点:

  • [build-system] 必须用 build-backend = "setuptools.build_meta"(别用 hatch 或 pdm 的 backend,除非全团队统一工具链)
  • [project] 下的 requires-python = ">=3.9" 要和 CI 环境、部署环境严格一致;dependencies 别写 requests>=2.25,而要写 requests>=2.25,,防止意外升级破坏兼容性
  • [project.optional-dependencies] 是解耦的好地方:比如 dev = ["pytest", "black"]、aws = ["boto3"],用户按需装,不会让基础包变重
  • 别漏掉 [project.urls],尤其是 "Repository" = "https://..." —— 这是 pip show 时唯一能追溯来源的地方

大型项目里 __init__.py 不再只是“让目录变包”的占位符

它实际是模块 API 的第一道门禁。很多人留空或只写几行 from .xxx import yyy,结果用户 import mypkg 后得自己翻子模块,而 from mypkg import get_client 这种简洁用法根本不存在。

应该做的事:

  • 在顶层 __init__.py 中显式 re-export 核心类/函数,控制公共接口范围;内部模块名(如 _utils、internal)加下划线前缀,不在 __all__ 里列,就是明确告诉使用者:“别依赖这个”
  • 利用 __getattr__ 延迟加载(Python 3.7+):对重型子模块(如含 C 扩展的 fastmath),首次访问才导入,避免 import mypkg 就触发全部初始化
  • 在 __init__.py 末尾做轻量级检查:比如确认 os.getenv("ENV") 存在,或 warn 用户当前 Python 版本接近 EOL —— 错误提示比散落在各处更早、更集中

越大的项目,__init__.py 越不能“省事”。它不是语法要求,是 API 设计的一部分。

热门AI工具

更多
Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

讯飞智文

一款面向学习和办公场景的AI文档创作工具,可辅助生成PPT与Word文档,提高资料整理和内容制作效率。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

豆包大模型

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

WorkBuddy

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

DeepSeek

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

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

相关专题

更多
pip安装使用方法
pip安装使用方法

安装步骤:1、确保Python已经正确安装在您的计算机上;2、下载“get-pip.py”脚本;3、按下Win + R键,然后输入cmd并按下Enter键来打开命令行窗口;4、在命令行窗口中,使用cd命令切换到“get-pip.py”所在的目录;5、执行安装命令;6、验证安装结果即可。大家可以访问本专题下的文章,了解pip安装使用方法的更多内容。

3650

2023.10.09

更新pip版本
更新pip版本

更新pip版本方法有使用pip自身更新、使用操作系统自带的包管理工具、使用python包管理工具、手动安装最新版本。想了解更多相关的内容,请阅读专题下面的文章。

8303

2024.12.20

pip设置清华源
pip设置清华源

设置方法:1、打开终端或命令提示符窗口;2、运行“touch ~/.pip/pip.conf”命令创建一个名为pip的配置文件;3、打开pip.conf文件,然后添加“[global];index-url = https://pypi.tuna.tsinghua.edu.cn/simple”内容,这将把pip的镜像源设置为清华大学的镜像源;4、保存并关闭文件即可。

10022

2024.12.23

python升级pip
python升级pip

本专题整合了python升级pip相关教程,阅读下面的文章了解更多详细内容。

5307

2025.07.23

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

3248

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

5529

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

3909

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

506

2026.01.19

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

120

2026.11.12

热门下载

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

精品课程

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

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