Python相互导入的问题解决

目录
  • 前言
  • 问题→解决
    • 问题描述
    • 问题复现
    • 解决问题
  • 总结

前言

Hi! 这是随笔专栏的第一篇文章。好的开始等于成功了一半。在之后的日子里，除了不定期分享实战中可总结出的小项目外，还会经常与大分享开发时遇到的问题。今天，是一个曾困扰了我许久的关于 Python 两个文件间互相 import 的问题。

问题→解决

问题描述

两个文件间相互导入时产生了一系列错误，比如 ImportError, NameError 等等。这次，我用简单的代码示例复现一下这些问题，并一步一步解决。

问题复现

这里，我创建两个同目录下的 Python 文件：mutualImportA 和 mutualImportB 并输入代码。

# mutualImportA.py  

from mutualImportB import b

a = 1  

def pA():
    print(b)  

pA()

# mutualImportB.py  

from mutualImportA import a  

b = 1  

def pB():
    print(a)  

pB()

创建完毕后，任意运行 A 或 B 都会报错：
ImportError: cannot import name 'b' from partially initialized module 'mutualImportB' (most likely due to a circular import)
当然有些人习惯于用 import 的导入而非 from import 的导入方式，这时候的报错就会变成：
AttributeError: partially initialized module 'mutualImportB' has no attribute 'b' (most likely due to a circular import)

好的，这两个报错还算友好。这种导入的方式都在程序出指明了导入的内容，所以解释器可以发现这里是循环导入（most likely due to a circular import）。但有时出现的 NameError 才真正让人头疼。

我们将代码改一下，保留 from import 语句，但将其 import 后面的变量名改为通配符 * 。这次的报错：
NameError: name 'b' is not defined

这就很奇怪了。我们在使用 IDE 时， IDE 不会检出相互导入时引发的循环导入问题。不过前两种在报错中即可看出，而这时，从报错中很难发现为何 b 没有声明。这种专为复现而出现的小文件中问题可以捋清思路、找到问题，在较大的项目中就往往无从下手了。

那么为什么会出现这样的情况呢？我们想一下整个程序的运行流程。

问题复现完毕，下面探讨如何解决问题。

解决问题

此前，我曾在许多平台看到过文章，但其中绝大部分都是完全重复的（尤其在 CSDN 上），明显互相“转载”来“转载”去。可惜，转载的文章并不能真正解决问题。在这篇原创的文章中，我将自己摸索的经验分享了出来。下面转入正题。

循环导入的根本原因是什么？为什么会循环导入？
其实由循环导入，我们可以想到递归而引发的栈溢出。

def a(b):
    return a(b)

这，是一个明显错误的函数。一旦我们调用了函数，函数内部就会不加判断地再次调用此函数。
而当我们加入了判断时：

def a(b):
	if b == 1:
		return 1
	else:
		return a(b - 1)

这样的话，该函数就转变为一个健康的函数了。

将同样的思路运用到相互导入的方式上。我们必须在整个文件初就要导入某个模块吗？一般来说不是的。我们应当将导入放在它真正被需要的函数里。比如，问题复现中的 a、b 改一下：

# mutualImportA.py  

a = 1  

def pA():
	from mutualImportB import b
    print(b)  

pA()

# mutualImportB.py  

b = 1  

def pB():
	from mutualImportA import a
    print(a)  

pB()

这样的话，就没有上面的循环导入的问题了。这次再划分下流程：

OK，那么问题到此为止就解决完毕了。

当然，据此问题也衍生出了一些代码的规范问题：
开发中，若文件较小，还是最好不要将需要相互使用的两个函数或类分到两个文件中。这样，可以避免不少的问题。

总结

说个事情，上一篇博客《利用深度优先搜索等算法实现围棋棋盘控制》有一处打错，应是 GitHub 而非 Github ，在此更正一下~

那么今天关于 Python 开发时遇到的问题的分享就到此为止了，再见！

到此这篇关于Python相互导入的问题解决的文章就介绍到这了,更多相关Python相互导入内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

赞 (0)

相关推荐

  • Python中常见的导入方式总结

    一.直接导入模块 import 模块名 优点:干净直接 import sys print(sys.path) import os # os是一个模块 import os.path # 注意这里的os.path是一个模块 二.直接导入包 import 包名 如果只导入包,在调用时不可使用.来找到模块,但可以访问到__init__.py下的类和函数. import bs4 # 注意这里bs4是一个包! soup = bs4.BeautifulSoup(...) # 可以访问到包中__init__.p

  • python 模块导入问题汇总

    python 模块导入问题汇总

    问题描述 此时start.py是启动程序,引入了core包中的user_control,transfer,withdraw三个模块文件 但执行start.py的时候,出现了以下错误: 上图中显示的问题是:在transfer.py导入user_control模块的时候,无法找到该模块. 问题查找 当时我就纳闷了,user_control和transfer在同一个包中,按理来说不用做任何处理就能导入.而且在导入user_control的时候也没有报错. 然后我单独执行了transfer.py文件,没

  • python中添加模块导入路径的方法

    python中自定义模块导入路径的方式主要有以下3种: (1)使用sys.path.append()随着程序执行,会动态地添加模块导入的路径,但是程序执行结束后就会立即失效(临时性的) import sys sys.path.append('自定义路径') (2)加入到环境变量PYTHONPATH用于当前用户 在用户主目录下有一个 .bashrc 隐藏文件,打开文件 sudo vim ~/.bashrc 添加单个路径的方法 export PYTHONPATH=<自定义路径>:$PYTHONPA

  • Python相互导入的问题解决

    Python相互导入的问题解决

    目录 前言 问题→解决 问题描述 问题复现 解决问题 总结 前言 Hi! 这是随笔专栏的第一篇文章.好的开始等于成功了一半.在之后的日子里,除了不定期分享实战中可总结出的小项目外,还会经常与大分享开发时遇到的问题.今天,是一个曾困扰了我许久的关于 Python 两个文件间互相 import 的问题. 问题→解决 问题描述 两个文件间相互导入时产生了一系列错误,比如 ImportError, NameError 等等.这次,我用简单的代码示例复现一下这些问题,并一步一步解决. 问题复现 这里,我创

  • python模块导入的细节详解

    python模块导入细节 本文主要介绍了关于python模块导入的相关内容,分享出来供大家参考学习,下面话不多说了,来一起看看详细的介绍吧 官方手册:https://docs.python.org/3/tutorial/modules.html 可执行文件和模块 python源代码文件按照功能可以分为两种类型: 用于执行的可执行程序文件 不用与执行,仅用于被其它python源码文件导入的模块文件 例如文件a.py和b.py在同一目录下,它们的内容分别是: # b.py x="var x in m

  • python引入导入自定义模块和外部文件的实例

    项目中想使用以前的代码,或者什么样的需求致使你需要导入外部的包 如果是web 下,比如说django ,那么你新建一个app,把你需要导入的说用东东,都写到这个app中,然后在setting中的app也配上基本就ok了 如果是本地代码,可以有几种方式, 1.这种最简单,也可能最不实用,将你的外部文件放到跟需要调用外部文件的文件同一个包下,同一目录 folder ------toinvoke.py ------tobeinvoded.py 这样在toinvoke.py 中引入 import tov

  • 快速了解Python相对导入

    1.绝对导入和相对导入 绝对导入:按照sys.path顺序搜索,先主目录(sys.path中第一项''),然后PYTHONPATH环境变量.标准库路径.pth指定路径等. 相对导入:在模块所在同一个包内搜索,注意该包目录与主目录的区别. 例1:有以下目录 app/ __init__.py mod.py string.py mod.py内容:import string 当在app/目录下执行Python mod.py时为绝对导入,当在app上层目录执行python -m app.mod时为相对导入

  • Python动态导入模块的方法实例分析

    本文实例讲述了Python动态导入模块的方法.分享给大家供大家参考,具体如下: 一.正常导入模块 正常模块导入方式: import module(模块路径) 同时导入多个模块: import os,sys,socket 二.动态导入模块 动态导入模块允许我们通过字符串形式来导入模块 2.1 __import__函数,接受一个字符串参数 import os, sys my_sys = __import__('sys') my_os = __import__('os') print(sys.vers

  • 对Python模块导入时全局变量__all__的作用详解

    Python中一个py文件就是一个模块,"__all__"变量是一个特殊的变量,可以在py文件中,也可以在包的__init__.py中出现. 1.在普通模块中使用时,表示一个模块中允许哪些属性可以被导入到别的模块中, 如:全局变量,函数,类.如下,test1.py和main.py test1.py __all__=["test"] def test(): print('----test-----') def test1(): print('----test1----

  • 解决python中导入win32com.client出错的问题

    准备写一个操作Excel脚本却在导入包的时候出现了一个小问题 导入包 from Tkinter import Tk from time import sleep, ctime from tkMessageBox import showwarning from urllib import urlopen import win32com.client as win32 报错提示 Traceback (most recent call last): File "estock.pyw", li

  • Python 动态导入对象,importlib.import_module()的使用方法

    背景 一个函数运行需要根据不同项目的配置,动态导入对应的配置文件运行. 解决 文件结构 a #文件夹 │a.py │__init__.py b #文件夹 │b.py │__init__.py ├─c#文件夹 │c.py │__init__.py # c.py 中内容 args = {'a':1} class C: def c(self): pass 目的 向a模块中导入c.py 中的对象 解决方案 a.py import importlib params = importlib.import_m

  • python批量导入数据进Elasticsearch的实例

    ES在之前的博客已有介绍,提供很多接口,本文介绍如何使用python批量导入.ES官网上有较多说明文档,仔细研究并结合搜索引擎应该不难使用. 先给代码 #coding=utf-8 from datetime import datetime from elasticsearch import Elasticsearch from elasticsearch import helpers es = Elasticsearch() actions = [] f=open('index.txt') i=

  • Python 中导入csv数据的三种方法

    Python 中导入csv数据的三种方法,具体内容如下所示: 1.通过标准的Python库导入CSV文件: Python提供了一个标准的类库CSV文件.这个类库中的reader()函数用来导入CSV文件.当CSV文件被读入后,可以利用这些数据生成一个NumPy数组,用来训练算法模型.: from csv importreader import numpy as np filename=input("请输入文件名: ") withopen(filename,'rt',encoding='

随机推荐