Python之模块详细梳理(四),关于相对导入报错最优雅解决方法

2024-08-27 17:08

本文主要是介绍Python之模块详细梳理(四),关于相对导入报错最优雅解决方法,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

相对导入

相对导入是指在同一个项目下不同模块之间相互导入,称为相对导入。

相对导入的案例

项目结构图如下:

项目名称project,该目录下有xx子项目和test.py模块。其中xx子目录下有y和z两个子目录,y子目录下有abc.py模块和yy.py模块,z子目录下有zz.py模块。yy.py是xx子项目的入口。test.py是整个项目的入口。

test.py模块的内容

"""
此模块是整个project项目的入口
"""from xx.y import yyyy.f2()
print(yy.num1, yy.num2, yy.num3)out:
123
10
hello
10 123 888

yy.py模块的内容

"""
此模块是xx子项目对外引用的入口
"""from .abc import *
from ..z.zz import *num3 = 888def f2():print(num2)print(num1)

zz.py模块的内容

"""
子项目,被导入的子模块
"""num1 = 10def f():print('hello')

abc.py模块的内容

"""
子项目,被导入的子模块
"""num2 = 123

以上就是模拟大型项目的框架结构,测试运行test.py模块可以看到输出正常,完全没有问题。

请仔细看yy.py模块的内容:

from .abc import *语句:. 表示当前目录,abc表示abc.py模块。

from ..z.zz import *语句,.. 表示父目录,z表示z文件夹,zz表示zz.py模块。

另外... 表示祖父目录,请熟悉from 路径标识结构。

相对导入:以from . 开头的语句,例如from .abc import *。

绝对导入:以文件夹或包或模块名开头的语句,例如from xx.y import yy。

以上暂未遇到报错,可如果你尝试调试yy.py模块,直接运行yy.py模块时会报错。

相对导入报错情况分析

是不是非常奇怪!为什么运行test.py模块调用yy.py模块时不报错,而直接脚本方式运行yy.py模块时会报错。我在网上找了很多资料没理出个头绪。后来找到有建议在yy.py模块中对sys.path添加路径,方法虽然可行但不优雅,也没有解释为什么yy.py模块被调用时不会报错,而直接运行yy.py会报错。

我针对被调用时不报错主动执行时报错的情况特地查了很多资料,做了仔细分析,关于上述这个特点我首先想到的是__name__,这个变量在被调用时和主动执行时内容是不一样的。后来针对模块调用查资料找到了__package__,这个变量在被调用时和主动执行时内容也是不一样的。

下面我们尝试打印__name__和__package__这两个变量,看看在被调用和主动执行时分别有什么不同。

修改yy.py模块文件内容

"""
此模块是xx子项目对外引用的入口
"""from .abc import *
from ..z.zz import *print(__name__)
print(__package__)
num3 = 888def f2():print(num2)print(num1)

执行test.py模块的结果:

xx.y.yy
xx.y
123
10
hello
10 123 888

直接执行yy.py的结果(暂时注释那2行相对导入的代码,要不然报错会导致看不到print打印内容):

相对导入报错的pythonic解决方法

认真观察yy.py模块被导入时打印的内容和主动执行时打印的内容不同之处。我想到了最pythonic的解决方案。

"""
此模块是xx子项目对外引用的入口
"""
__package__ = 'xx.y'from .abc import *
from ..z.zz import *num3 = 888def f2():print(num2)print(num1)

直接修改__package__变量的值为被调用时的值,这样主动运行yy.py模块时不再报错,被调用时也不报错。

以上是相对导入的知识点梳理,我在yy.py模块直接调试运行会报错这一问题上花费很多时间和精力,最终想到了最优雅的解决方式,希望对各位深入学python的朋友有所帮助,如果要转载请注明出处和作者是“皛心”。

这篇关于Python之模块详细梳理(四),关于相对导入报错最优雅解决方法的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1112264

相关文章

Python中你不知道的gzip高级用法分享

《Python中你不知道的gzip高级用法分享》在当今大数据时代,数据存储和传输成本已成为每个开发者必须考虑的问题,Python内置的gzip模块提供了一种简单高效的解决方案,下面小编就来和大家详细讲... 目录前言:为什么数据压缩如此重要1. gzip 模块基础介绍2. 基本压缩与解压缩操作2.1 压缩文

golang中reflect包的常用方法

《golang中reflect包的常用方法》Go反射reflect包提供类型和值方法,用于获取类型信息、访问字段、调用方法等,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值... 目录reflect包方法总结类型 (Type) 方法值 (Value) 方法reflect包方法总结

Python设置Cookie永不超时的详细指南

《Python设置Cookie永不超时的详细指南》Cookie是一种存储在用户浏览器中的小型数据片段,用于记录用户的登录状态、偏好设置等信息,下面小编就来和大家详细讲讲Python如何设置Cookie... 目录一、Cookie的作用与重要性二、Cookie过期的原因三、实现Cookie永不超时的方法(一)

Python内置函数之classmethod函数使用详解

《Python内置函数之classmethod函数使用详解》:本文主要介绍Python内置函数之classmethod函数使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地... 目录1. 类方法定义与基本语法2. 类方法 vs 实例方法 vs 静态方法3. 核心特性与用法(1编程客

C# 比较两个list 之间元素差异的常用方法

《C#比较两个list之间元素差异的常用方法》:本文主要介绍C#比较两个list之间元素差异,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录1. 使用Except方法2. 使用Except的逆操作3. 使用LINQ的Join,GroupJoin

Python函数作用域示例详解

《Python函数作用域示例详解》本文介绍了Python中的LEGB作用域规则,详细解析了变量查找的四个层级,通过具体代码示例,展示了各层级的变量访问规则和特性,对python函数作用域相关知识感兴趣... 目录一、LEGB 规则二、作用域实例2.1 局部作用域(Local)2.2 闭包作用域(Enclos

Python实现对阿里云OSS对象存储的操作详解

《Python实现对阿里云OSS对象存储的操作详解》这篇文章主要为大家详细介绍了Python实现对阿里云OSS对象存储的操作相关知识,包括连接,上传,下载,列举等功能,感兴趣的小伙伴可以了解下... 目录一、直接使用代码二、详细使用1. 环境准备2. 初始化配置3. bucket配置创建4. 文件上传到os

MySQL查询JSON数组字段包含特定字符串的方法

《MySQL查询JSON数组字段包含特定字符串的方法》在MySQL数据库中,当某个字段存储的是JSON数组,需要查询数组中包含特定字符串的记录时传统的LIKE语句无法直接使用,下面小编就为大家介绍两种... 目录问题背景解决方案对比1. 精确匹配方案(推荐)2. 模糊匹配方案参数化查询示例使用场景建议性能优

关于集合与数组转换实现方法

《关于集合与数组转换实现方法》:本文主要介绍关于集合与数组转换实现方法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1、Arrays.asList()1.1、方法作用1.2、内部实现1.3、修改元素的影响1.4、注意事项2、list.toArray()2.1、方

使用Python实现可恢复式多线程下载器

《使用Python实现可恢复式多线程下载器》在数字时代,大文件下载已成为日常操作,本文将手把手教你用Python打造专业级下载器,实现断点续传,多线程加速,速度限制等功能,感兴趣的小伙伴可以了解下... 目录一、智能续传:从崩溃边缘抢救进度二、多线程加速:榨干网络带宽三、速度控制:做网络的好邻居四、终端交互