关于Python如何避免循环导入问题详解
前言
Python 中使用package时,出现循环导入问题十分常见,我们创建如下package来说明这个问题:
pkg ├── __init__.py ├── module_a.py └── module_b.py
其中,
__init__.py 将pkg指定为一个Python package
module_a.py中定义了一个action_a()
函数,该函数引用了module_b.py中的一个attribute,如一个函数或变量
module_b.py中定义了一个action_b()
函数,该函数引用了module_a.py中的一个attribute,如一个函数或变量
这种情况下,执行该package时会抛出circular import error
错误,即循环引用,因为module_a试图去引入module_b时,而module_b首先要引入module_a,这会导致Python解释器无法执行下去。
然而,我们可以通过一些巧妙的方法,让上面的逻辑正常工作,同时避免循环引入的错误。
那么,什么时候它能正常工作,什么时候不能正常工作,而那些能够正常工作的情况又是什么原因呢?
何时它能正常工作?
1. 在module顶部引入,不要用from,相对引入,只在Python 2中有效
在module的顶部import,如import another_module
,module 中的函数以another_module.attribute
的方式引用another_module中的函数或变量等。这种方式之所以有效,是由于import another_module
是基于当前目录的相对引用,而且是一种隐式引用,如果从另一个package中引入module时,就可以失效了。另外,import another_module
这种语法在Python3 中已经不支持了,所以不要在代码中用这种方法来避免循环引入。
如:
# pkg/module_a.py from __future__ import print_function import module_b def action_a(): print(module_b.action_b.__name__) # pkg/module_b.py from __future__ import print_function import module_a def action_b(): print(module_a.action_a.__name__)
2. 在module的顶部引入,不要用from,绝对引入
在module的顶部import,使用从package开始的绝对路径,如import package.another_module
,module 中的函数以package.another_module.attribute
的方式引用another_module中的函数或变量等。之所以要挂上package name来引入,是由于import .another_module
这种形式的“相对引入”会报语法错误,而挂上package的绝对引入,Python 2和3都支持
案例:
# pkg/module_a.py from __future__ import print_function import pkg2.module_b def action_a(): print(pkg2.module_b.action_b.__name__) # pkg/module_b.py from __future__ import print_function import pkg2.module_a def action_b(): print(pkg2.module_a.action_a.__name__)
3. 在module底部引入another module的attribute,而非another module,用from
在module的底部import(至少要在被引用的attribute之后import),直接引入another module
的attribute,如from package.another_module import attribute
,相对引入也支持,如from .another_module import attribute
,module中的函数直接使用被引用的attribute即可。
如:
# pkg/module_a.py from __future__ import print_function def action_a(): print(action_b.__name__) from .module_b import action_b # pkg/module_b.py from __future__ import print_function def action_b(): print(action_a.__name__) from .module_a import action_a
4. 函数顶部引入,可以用from
在module的function顶部import,如from package import another_module
,也支持相对引入,引入module或attribute均可。
如:
# pkg/module_a.py from __future__ import print_function def action_a(): from . import module_b print(module_b.action_b.__name__) # pkg/module_b.py from __future__ import print_function def action_b(): from . import module_a print(module_a.action_a.__name__)
或
# pkg/module_a.py from __future__ import print_function def action_a(): from .module_b import action_b print(action_b.__name__) # pkg/module_b.py from __future__ import print_function def action_b(): from .module_a import action_a print(action_a.__name__)
这种方式虽然Python 2和3都支持,但编码不够优雅,影响代码可读性,不建议使用
注
本文讨论的问题,是Python中调用package时,应如何避免循环引入
当直接在命令行执行一个Python module时,适用情况不完全相同
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对脚本之家的支持。
- 能花钱的,就不要花时间
- Lombok介绍、使用方法和总结
- JDK1.7源码分析01-Collection
- Spring boot自定义启动字符画(banner)
- 产品解析:Github Atom
- Docker+Jenkins持续集成环境(5): android构建与apk发布
- Docker+Jenkins持续集成环境(4):使用etcd+confd实现容器服务注册与发现
- 易企秀前端压缩源码分析与还原
- 关于 JS 拖拽功能的冲突问题及解决方法
- 使用 SVG 和 JS 创建一个由星形变心形的动画
- 如何使用 Bootstrap 搭建更合理的 HTML 结构
- Java遍历Map对象的四种方式
- java 线程public void run()中值如何返回
- Jackson与spring框架整合的坑
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- 手牵手,使用uni-app从零开发一款视频小程序 (系列下 开发实战篇)
- POSTGRESQL 到底怎么访问同instance 的库--
- 简单工厂模式
- 这 9 种方法有效帮你提高国内访问 Github 的速度
- python实现sm2和sm4国密(国家商用密码)算法
- 面试常考算法之区间问题
- 爬虫 | JS逆向某验滑动加密分析
- LeetCode | 28.实现strStr()
- Redis | Redis 哈希相关命令
- 如何访问SAP Spartacus里的config数据
- 工具系列 | HTTP API 身份验证和授权
- Providers in SAP Spartacus
- 详解ELF可执行文件格式:读取头部信息和程序表头
- 我用 Python 写了个基金涨跌通知助手
- 模仿腾讯新闻做了款新闻阅读小程序