0

0

Python 包结构设计如何兼顾可维护性

舞夢輝影

舞夢輝影

发布时间:2026-02-13 21:46:02

|

353人浏览过

|

来源于php中文网

原创

__init__.py 是否写逻辑取决于是否暴露公共 api:纯组织用途应留空;需简化导入则仅放显式导入;严禁初始化操作。子包循环导入应通过抽取共享模块或接口解耦。tests 不应放入包内。拆包需满足独立演进、安装、维护等实际需求。

python 包结构设计如何兼顾可维护性

包结构里 __init__.py 到底要不要写逻辑

写了容易隐式耦合,不写又可能破坏导入体验——关键看是否暴露公共 API。

  • 纯组织用途(如仅用于分层):__init__.py 留空最安全,避免意外执行副作用
  • 需要简化上层导入(如 from mypkg import Client):只放 from .submod import Client 这类显式导入,别调用函数、读配置、初始化全局状态
  • 常见错误:在 __init__.py 里调用 logging.basicConfig() 或连接数据库——模块一导入就触发,测试难 mock,多进程易冲突

子包之间循环导入怎么破

不是靠“加 try/except”或“延迟 import”,而是从依赖方向上切断。

  • 典型症状:ImportError: cannot import name 'X' from partially initialized module 'mypkg.a'
  • 优先把共享数据/类型抽到独立的 types.pycore.py 包级模块,让 a 和 b 都单向依赖它
  • 若必须跨子包调用行为,用协议(typing.Protocol)或抽象基类定义接口,实现放在具体子包,调用方只依赖接口
  • 避免在 __init__.py 中跨子包导入——这会放大循环风险

tests 目录该不该放进包里

不该。测试代码不是生产依赖,放进包会导致安装时冗余、误导用户、污染命名空间。

Gaga
Gaga

曹越团队开发的AI视频生成工具

下载
  • 正确布局:mypkg/(包目录)和同级 tests/(测试目录),pyproject.toml 中用 packages = [{include = "mypkg"}] 明确限定
  • 常见错误:把 tests/ 放进 mypkg/ 下,并加 __init__.py ——用户 pip install 后会多出 mypkg.tests 可导入模块,且 pytest 可能误发现并运行已安装包里的测试
  • 测试中要导入被测模块?用 -m pytest 在项目根目录运行,或确保 python -c "import mypkg" 能通,pytest 自动识别源码路径

什么时候该拆新包,而不是加子包

当某个功能模块具备独立演进、可单独安装、有不同维护者或版本节奏时,才值得拆。

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

  • 信号包括:该模块已有外部用户直接依赖;它用不同 license;CI 流水线需独立触发;文档/README 独立成体系
  • 反例:为“看起来更清晰”把 utils/ 拆成 mypkg-utils ——只会增加发布负担、版本对齐成本、import 路径断裂
  • 拆包后,原包内保留兼容性 shim 是可行的(如 from mypkg_utils import helper),但得标注 Deprecated 并设弃用周期

真正的复杂点不在目录怎么排,而在于每次新增模块时,你有没有下意识问一句:“这个东西,未来半年会不会被另一个团队拿去改而不通知我?”——答案如果是“会”,那结构就该为它留出隔离边界。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

347

2023.10.09

更新pip版本
更新pip版本

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

423

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、保存并关闭文件即可。

784

2024.12.23

python升级pip
python升级pip

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

356

2025.07.23

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

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

1420

2023.10.19

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

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

339

2025.10.17

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

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

2209

2025.12.29

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

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

36

2026.01.19

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

23

2026.02.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 4.2万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.5万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号