0

0

Python 包结构设计的最佳实践

冷炫風刃

冷炫風刃

发布时间:2026-01-30 20:53:02

|

404人浏览过

|

来源于php中文网

原创

Python包名须全小写、用短横线分隔(PyPI发布时),导入模块名则须为合法标识符(字母/数字/下划线);__init__.py应精简,避免隐式依赖;推荐src布局确保开发与运行路径一致;弃用setup.py,统一用pyproject.toml管理。

python 包结构设计的最佳实践

包名必须全小写且不带下划线

Python 包名在 import 语句中是标识符,受 PEP 8 明确约束:应全部小写,多个单词用短横线(-)分隔——但注意,**这仅适用于 PyPI 发布时的包名**;实际导入时用的模块名仍须是合法 Python 标识符,即只能含字母、数字和下划线,且不能以数字开头。

常见错误是把包名设为 my_utilsMyPackage,导致下游用户写 import my_utils 看似可行,但一旦发布到 PyPI,pip install my_utils 会被 PyPI 视为独立包,与 import my_utils 的命名空间脱节,引发版本混乱或安装覆盖。

实操建议:

绿色大气办公家具类企业织梦模板1.0
绿色大气办公家具类企业织梦模板1.0

绿色大气办公家具类企业织梦模板是以织梦最新内核来进行开发的模板,该模板属于家具行业,装修企业,家装类,属于企业通用,装修设计、家具生产等企业均可以使用该模板,页面简洁简单,容易管理,DEDE5.5内核以上都可以使用;附带测试数据!模板特点:简洁美观大方小清新的设计风格,图片展示效果绝佳。页面结构简单,利于SEO的优化,模板后台易于管理。使用程序:织梦DEDECMS5.5以上版本都可以使用。温馨提示

下载
  • 本地开发包名用纯小写+下划线(如 myproject),对应目录名 myproject/
  • PyPI 上注册的发行包名用短横线(如 myproject-cli),但其内部 setup.pypyproject.toml 中的 name 字段必须与安装命令一致,而 packages 列表仍指向实际 Python 包名(["myproject"]
  • 避免包名与标准库冲突(如 jsonhttp),导入时会静默覆盖,调试极难定位

__init__.py 不该是功能堆积区

很多人习惯在 __init__.py 里集中导入所有子模块内容(from .core import func_a; from .utils import helper),再统一暴露给上层。这看似方便用户写 import myproject; myproject.func_a(),但会带来隐式依赖、启动变慢、循环导入风险。

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

典型现象是:改动一个深层工具函数,触发整个包重加载;或测试时只导入 myproject.utils,却因 __init__.py 拉入了数据库模块而意外连接 MySQL。

实操建议:

  • __init__.py 只做三件事:声明包属性(如 __version__)、设置 __all__(若需显式控制 from myproject import *)、轻量级别名(如 from .core import CoreClass as Client
  • 子模块功能按需导入,用户应明确写 from myproject.core import process_data,而非依赖顶层通配
  • 若真需简化常用路径,可用 __getattr__ 延迟加载(Python 3.7+),避免启动时硬导入

src 目录布局比扁平结构更可靠

直接把 myproject/ 放在项目根目录下(即 setup.py 同级),会导致测试时 python test/test_main.py 可能意外导入本地未安装的 myproject,也可能因当前路径优先被 sys.path 加载而跳过已安装版本,造成行为不一致。

根本问题是:开发态(源码)和运行态(安装后)的模块解析路径不统一。

实操建议:

  • 强制采用 src/ 布局:项目结构为 src/myproject/__init__.pypyproject.toml 中配置 packages = [{include = "myproject", from = "src"}]
  • 这样 pip install -e . 安装的是可复现的包路径,单元测试也必须通过 python -m pytest tests/ 运行(而非 python test_*.py),确保走的是已安装包路径
  • CI 中加一条检查:python -c "import myproject; print(myproject.__file__)",确认输出路径含 site-packages 而非项目内 src/

避免 setup.py 与 pyproject.toml 功能重叠

很多项目同时存在 setup.pypyproject.toml,且两者都定义依赖、入口点或元数据。这会造成构建行为分裂:用 pip wheel .pyproject.toml,但 python setup.py bdist_wheelsetup.py,结果生成不同轮子。

更隐蔽的问题是:某些 CI 工具(如旧版 tox)默认调用 setup.py,而本地开发用 pip install -e . 实际走的是 pyproject.toml,导致环境不一致。

实操建议:

  • 彻底弃用 setup.py,除非你必须支持 Python setuptools 插件(如 build_ext
  • pyproject.toml 中用 [build-system] 明确指定构建后端(推荐 setuptools>=61.0),用 [project] 定义元数据,用 [project.optional-dependencies] 管理 dev/test 分组
  • 入口点(如 CLI 命令)统一写在 [project.entry-points."console_scripts"],不要在 setup.py 里重复写 entry_points
包结构不是静态模板,而是随团队规模、部署方式、测试策略动态调整的契约。最常被忽略的其实是「导入路径」和「安装路径」的分离时机——等 CI 报出 ModuleNotFoundError 再改,往往已污染多个环境。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
mysql修改数据表名
mysql修改数据表名

MySQL修改数据表:1、首先查看数据库中所有的表,代码为:‘SHOW TABLES;’;2、修改表名,代码为:‘ALTER TABLE 旧表名 RENAME [TO] 新表名;’。php中文网还提供MySQL的相关下载、相关课程等内容,供大家免费下载使用。

668

2023.06.20

MySQL创建存储过程
MySQL创建存储过程

存储程序可以分为存储过程和函数,MySQL中创建存储过程和函数使用的语句分别为CREATE PROCEDURE和CREATE FUNCTION。使用CALL语句调用存储过程智能用输出变量返回值。函数可以从语句外调用(通过引用函数名),也能返回标量值。存储过程也可以调用其他存储过程。php中文网还提供MySQL创建存储过程的相关下载、相关课程等内容,供大家免费下载使用。

247

2023.06.21

mongodb和mysql的区别
mongodb和mysql的区别

mongodb和mysql的区别:1、数据模型;2、查询语言;3、扩展性和性能;4、可靠性。本专题为大家提供mongodb和mysql的区别的相关的文章、下载、课程内容,供大家免费下载体验。

281

2023.07.18

mysql密码忘了怎么查看
mysql密码忘了怎么查看

MySQL是一个关系型数据库管理系统,由瑞典MySQL AB 公司开发,属于 Oracle 旗下产品。MySQL 是最流行的关系型数据库管理系统之一,在 WEB 应用方面,MySQL是最好的 RDBMS 应用软件之一。那么mysql密码忘了怎么办呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

516

2023.07.19

mysql创建数据库
mysql创建数据库

MySQL是一个关系型数据库管理系统,由瑞典MySQL AB 公司开发,属于 Oracle 旗下产品。MySQL 是最流行的关系型数据库管理系统之一,在 WEB 应用方面,MySQL是最好的 RDBMS 应用软件之一。那么mysql怎么创建数据库呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

256

2023.07.25

mysql默认事务隔离级别
mysql默认事务隔离级别

MySQL是一种广泛使用的关系型数据库管理系统,它支持事务处理。事务是一组数据库操作,它们作为一个逻辑单元被一起执行。为了保证事务的一致性和隔离性,MySQL提供了不同的事务隔离级别。php中文网给大家带来了相关的教程以及文章欢迎大家前来学习阅读。

387

2023.08.08

sqlserver和mysql区别
sqlserver和mysql区别

SQL Server和MySQL是两种广泛使用的关系型数据库管理系统。它们具有相似的功能和用途,但在某些方面存在一些显著的区别。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

533

2023.08.11

mysql忘记密码
mysql忘记密码

MySQL是一种关系型数据库管理系统,关系数据库将数据保存在不同的表中,而不是将所有数据放在一个大仓库内,这样就增加了速度并提高了灵活性。那么忘记mysql密码我们该怎么解决呢?php中文网给大家带来了相关的教程以及其他关于mysql的文章,欢迎大家前来学习阅读。

605

2023.08.14

C++ 设计模式与软件架构
C++ 设计模式与软件架构

本专题深入讲解 C++ 中的常见设计模式与架构优化,包括单例模式、工厂模式、观察者模式、策略模式、命令模式等,结合实际案例展示如何在 C++ 项目中应用这些模式提升代码可维护性与扩展性。通过案例分析,帮助开发者掌握 如何运用设计模式构建高质量的软件架构,提升系统的灵活性与可扩展性。

14

2026.01.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
MySQL 教程
MySQL 教程

共48课时 | 2万人学习

MySQL 初学入门(mosh老师)
MySQL 初学入门(mosh老师)

共3课时 | 0.3万人学习

简单聊聊mysql8与网络通信
简单聊聊mysql8与网络通信

共1课时 | 815人学习

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

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