Python导入全局、局部模块以及如何让避免循环导入

许多年来不时使用Python的人并不是都知道Python的导入机制其实非常灵活。在本文中,我们将探讨以下话题:

  • 常规导入(regular imports)
  • 使用from语句导入
  • 相对导入(relative imports)
  • 可选导入(optional imports)
  • 本地导入(local imports)
  • 导入注意事项
  • 如何避免循环导入

常规导入

常规导入应该是最常使用的导入方式,大概是这样的:

import sys

你只需要使用import一词,然后指定你希望导入的模块或包即可。通过这种方式导入的好处是可以一次性导入多个包或模块:

import os, sys, time

虽然这节省了空间,但是却违背了Python风格指南。Python风格指南建议将每个导入语句单独成行。

有时在导入模块时,你想要重命名这个模块。这个功能很容易实现:

import sys as systemprint(system.platform)

上面的代码将我们导入的sys模块重命名为system。我们可以按照和以前一样的方式调用模块的方法,但是可以用一个新的模块名。也有某些子模块必须要使用点标记法才能导入。

import urllib.error

这个情况不常见,但是对此有所了解总是没有坏处的。

使用from语句导入

很多时候你只想要导入一个模块或库中的某个部分。我们来看看在Python中如何实现这点:

from functools import lru_cache

上面这行代码可以让你直接调用lru_cache。如果你按常规方式导入functools,那么你就必须像这样调用lru_cache

functools.lru_cache(*args)

根据你实际的使用场景,上面的做法可能是更好的。在复杂的代码库中,能够看出某个函数是从哪里导入的这点很有用的。不过,如果你的代码维护的很好,模块化程度高,那么只从某个模块中导入一部分内容也是非常方便和简洁的。

当然,你还可以使用from方法导入模块的全部内容,就像这样:

from os import *

这种做法在少数情况下是挺方便的,但是这样也会打乱你的命名空间。问题在于,你可能定义了一个与导入模块中名称相同的变量或函数,这时如果你试图使用os模块中的同名变量或函数,实际使用的将是你自己定义的内容。因此,你最后可能会碰到一个相当让人困惑的逻辑错误。标准库中我唯一推荐全盘导入的模块只有Tkinter。

如果你正好要写自己的模块或包,有人会建议你在__init__.py文件中导入所有内容,让模块或者包使用起来更方便。我个人更喜欢显示地导入,而非隐式地导入。

你也可以采取折中方案,从一个包中导入多个项:

from os import path, walk, unlink
from os import uname, remove

在上述代码中,我们从os模块中导入了5个函数。你可能注意到了,我们是通过多次从同一个模块中导入实现的。当然,如果你愿意的话,你也可以使用圆括号一次性导入多个项:

from os import (path, walk, unlink, uname, remove, rename)

这是一个有用的技巧,不过你也可以换一种方式:

from os import path, walk, unlink, uname, \remove, rename

上面的反斜杠是Python中的续行符,告诉解释器这行代码延续至下一行。

相对导入

PEP 328介绍了引入相对导入的原因,以及选择了哪种语法。具体来说,是使用句点来决定如何相对导入其他包或模块。这么做的原因是为了避免偶然情况下导入标准库中的模块产生冲突。这里我们以PEP 328中给出的文件夹结构为例,看看相对导入是如何工作的:

my_package/__init__.pysubpackage1/__init__.pymodule_x.pymodule_y.pysubpackage2/__init__.pymodule_z.pymodule_a.py

在本地磁盘上找个地方创建上述文件和文件夹。在顶层的__init__.py文件中,输入以下代码:

from . import subpackage1
from . import subpackage2

接下来进入subpackage1文件夹,编辑其中的__init__.py文件,输入以下代码:

from . import module_x
from . import module_y

现在编辑module_x.py文件,输入以下代码:

from .module_y import spam as hamdef main():ham()

最后编辑module_y.py文件,输入以下代码:

def spam():print('spam ' * 3)

打开终端,cdmy_package包所在的文件夹,但不要进入my_package。在这个文件夹下运行Python解释器。我使用的是IPython,因为它的自动补全功能非常方便:

In [1]: import my_packageIn [2]: my_package.subpackage1.module_x
Out[2]: <module 'my_package.subpackage1.module_x' from 'my_package/subpackage1/module_x.py'>In [3]: my_package.subpackage1.module_x.main()
spam spam spam

相对导入适用于你最终要放入包中的代码。如果你编写了很多相关性强的代码,那么应该采用这种导入方式。你会发现PyPI上有很多流行的包也是采用了相对导入。还要注意一点,如果你想要跨越多个文件层级进行导入,只需要使用多个句点即可。不过,PEP 328建议相对导入的层级不要超过两层。

还要注意一点,如果你往module_x.py文件中添加了if __name__ == ‘__main__’,然后试图运行这个文件,你会碰到一个很难理解的错误。编辑一下文件,试试看吧!

from . module_y import spam as hamdef main():ham()if __name__ == '__main__':# This won't work!main()

现在从终端进入subpackage1文件夹,执行以下命令:

python module_x.py

如果你使用的是Python 2,你应该会看到下面的错误信息:

Traceback (most recent call last):File "module_x.py", line 1, in <module>from . module_y import spam as ham
ValueError: Attempted relative import in non-package

如果你使用的是Python 3,错误信息大概是这样的:

Traceback (most recent call last):File "module_x.py", line 1, in <module>from . module_y import spam as ham
SystemError: Parent module '' not loaded, cannot perform relative import

这指的是,module_x.py是某个包中的一个模块,而你试图以脚本模式执行,但是这种模式不支持相对导入。

如果你想在自己的代码中使用这个模块,那么你必须将其添加至Python的导入检索路径(import search path)。最简单的做法如下:

import sys
sys.path.append('/path/to/folder/containing/my_package')
import my_package

注意,你需要添加的是my_package的上一层文件夹路径,而不是my_package本身。原因是my_package就是我们想要使用的包,所以如果你添加它的路径,那么将无法使用这个包。

我们接下来谈谈可选导入。

可选导入(Optional imports)

如果你希望优先使用某个模块或包,但是同时也想在没有这个模块或包的情况下有备选,你就可以使用可选导入这种方式。这样做可以导入支持某个软件的多种版本或者实现性能提升。以github2包中的代码为例:

try:# For Python 3from http.client import responses
except ImportError:  # For Python 2.5-2.7try:from httplib import responses  # NOQAexcept ImportError:  # For Python 2.4from BaseHTTPServer import BaseHTTPRequestHandler as _BHRHresponses = dict([(k, v[0]) for k, v in _BHRH.responses.items()])

lxml包也有使用可选导入方式:

try:from urlparse import urljoinfrom urllib2 import urlopen
except ImportError:# Python 3from urllib.parse import urljoinfrom urllib.request import urlopen

正如以上示例所示,可选导入的使用很常见,是一个值得掌握的技巧。

局部导入

当你在局部作用域中导入模块时,你执行的就是局部导入。如果你在Python脚本文件的顶部导入一个模块,那么你就是在将该模块导入至全局作用域,这意味着之后的任何函数或方法都可能访问该模块。例如:

import sys  # global scopedef square_root(a):# This import is into the square_root functions local scopeimport mathreturn math.sqrt(a)def my_pow(base_num, power):return math.pow(base_num, power)if __name__ == '__main__':print(square_root(49))print(my_pow(2, 3))

这里,我们将sys模块导入至全局作用域,但我们并没有使用这个模块。然后,在square_root函数中,我们将math模块导入至该函数的局部作用域,这意味着math模块只能在square_root函数内部使用。如果我们试图在my_pow函数中使用math,会引发NameError。试着执行这个脚本,看看会发生什么。

使用局部作用域的好处之一,是你使用的模块可能需要很长时间才能导入,如果是这样的话,将其放在某个不经常调用的函数中或许更加合理,而不是直接在全局作用域中导入。老实说,我几乎从没有使用过局部导入,主要是因为如果模块内部到处都有导入语句,会很难分辨出这样做的原因和用途。根据约定,所有的导入语句都应该位于模块的顶部。

导入注意事项

在导入模块方面,有几个程序员常犯的错误。这里我们介绍两个。

  • 循环导入(circular imports)
  • 覆盖导入(Shadowed imports,暂时翻译为覆盖导入)

先来看看循环导入。

循环导入

如果你创建两个模块,二者相互导入对方,那么就会出现循环导入。例如:

# a.py
import bdef a_test():print("in a_test")b.b_test()a_test()

然后在同个文件夹中创建另一个模块,将其命名为b.py

import adef b_test():print('In test_b"')a.a_test()b_test()

如果你运行任意一个模块,都会引发AttributeError。这是因为这两个模块都在试图导入对方。简单来说,模块a想要导入模块b,但是因为模块b也在试图导入模块a(这时正在执行),模块a将无法完成模块b的导入。我看过一些解决这个问题的破解方法(hack),但是一般来说,你应该做的是重构代码,避免发生这种情况。

覆盖导入

当你创建的模块与标准库中的模块同名时,如果你导入这个模块,就会出现覆盖导入。举个例子,创建一个名叫math.py的文件,在其中写入如下代码:

import mathdef square_root(number):return math.sqrt(number)square_root(72)

现在打开终端,试着运行这个文件,你会得到以下回溯信息(traceback):

Traceback (most recent call last):File "math.py", line 1, in <module>import mathFile "/Users/michael/Desktop/math.py", line 6, in <module>square_root(72)File "/Users/michael/Desktop/math.py", line 4, in square_rootreturn math.sqrt(number)
AttributeError: module 'math' has no attribute 'sqrt'

这到底是怎么回事?其实,你运行这个文件的时候,Python解释器首先在当前运行脚本所处的的文件夹中查找名叫math的模块。在这个例子中,解释器找到了我们正在执行的模块,试图导入它。但是我们的模块中并没有叫sqrt的函数或属性,所以就抛出了AttributeError

如何避免循环导入

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这种语法在Python 3 中已经不支持了,所以不要在代码中用这种方法来避免循环引入。

如:

# pkg/module_a.py 
from __future__ import print_function
import module_bdef action_a():print(module_b.action_b.__name__)# pkg/module_b.py
from __future__ import print_function
import module_adef 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_bdef action_a():print(pkg2.module_b.action_b.__name__)# pkg/module_b.py
from __future__ import print_function
import pkg2.module_adef 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_functiondef action_a():print(action_b.__name__)from .module_b import action_b# pkg/module_b.py
from __future__ import print_functiondef 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_functiondef action_a():from . import module_bprint(module_b.action_b.__name__)# pkg/module_b.py
from __future__ import print_functiondef action_b():from . import module_aprint(module_a.action_a.__name__)

# pkg/module_a.py
from __future__ import print_functiondef action_a():from .module_b import action_bprint(action_b.__name__)# pkg/module_b.py
from __future__ import print_function
def action_b():from .module_a import action_aprint(action_a.__name__)

这种方式虽然Python 2和3都支持,但编码不够优雅,影响代码可读性,不建议使用

  • 本文讨论的问题,是Python中调用package时,应如何避免循环引入
  • 当直接在命令行执行一个Python module时,适用情况不完全相同
  • 本文内容我在GitHub上提供了一个Demo,欢迎查看或fork
  • Reference:This Gist

总结

在本文中,我们讲了很多有关导入的内容,但是还有部分内容没有涉及。PEP 302中介绍了导入钩子(import hooks),支持实现一些非常酷的功能,比如说直接从github导入。Python标准库中还有一个importlib模块,值得查看学习。当然,你还可以多看看别人写的代码,不断挖掘更多好用的妙招。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/473416.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

LeetCode 995. K 连续位的最小翻转次数(差分思想)

文章目录1. 题目2. 解题1. 题目 在仅包含 0 和 1 的数组 A 中&#xff0c;一次 K 位翻转包括选择一个长度为 K 的&#xff08;连续&#xff09;子数组&#xff0c;同时将子数组中的每个 0 更改为 1&#xff0c;而每个 1 更改为 0。 返回所需的 K 位翻转的次数&#xff0c;以便…

如何自学人工智能?

不少同学跃跃欲试&#xff0c;想投入 AI 的怀抱&#xff0c;但苦于不知如何下手。其中&#xff0c;人工智能的核心就是机器学习&#xff08;Machine Learning&#xff09;&#xff0c;它是使计算机具有智能的根本途径&#xff0c;其应用遍及人工智能的各个领域。 我们今天就来分…

2014/4/16

2014-04-16 crystal 14:10:53 股东大会开了没今天 crystal 14:11:08 今天296创新高了 crystal 2014/4/16 14:08:33 32.9 米多爸爸 2014/4/16 14:08:42 296不错&#xff0c;不是今天开股东大会吗 米多爸爸 2014/4/16 14:08:51 延期了&…

AI 人工智能学习经典书单

人工智能相关岗位中&#xff0c;涉及到的内容包含&#xff1a;算法、深度学习、机器学习、自然语言处理、数据结构、Tensorflow、Python 、数据挖掘、搜索开发、神经网络、视觉度量、图像识别、语音识别、推荐系统、系统算法、图像算法、数据分析、概率编程、计算机数学、数据仓…

牛客 牛牛爱喝酒(模拟)

文章目录1. 题目2. 解题1. 题目 链接&#xff1a;https://ac.nowcoder.com/acm/contest/9752/A 来源&#xff1a;牛客网 牛牛是一个酒鬼&#xff0c;非常爱喝酒&#xff0c; 一瓶酒m元钱&#xff0c; 两个酒瓶可以换一瓶酒&#xff0c; 四个瓶盖可以换一瓶酒&#xff0c; 现在…

零基础30分钟开启你的快速开发之旅

零基础30分钟开启你快速开发之旅 1. 前言 接触AgileEAS.NET SOA 中间件平台&#xff08;以下简称EAS.NET平台&#xff09;有4个多月时间&#xff0c;经过试用认为可以把它作为一个开发的基础平台&#xff0c;开发团队可以把开发的重点放在需求的把控和项目的交付上&#xff0c;…

Python语法糖——遍历列表时删除元素

Python的for可以遍历一个List&#xff0c;但是在遍历的过程中删除元素常常会得到意想不到的结果甚至程序出现异常&#xff0c;例如&#xff1a; lst [1, 1, 0, 2, 0, 0, 8, 3, 0, 2, 5, 0, 2, 6]for item in lst:if item 0:lst.remove(item) print lst输出&#xff1a; [1, 1…

牛客 牛牛的独特子序列(双指针/二分查找)

文章目录1. 题目2. 解题2.1 双指针2.2 二分查找1. 题目 链接&#xff1a;https://ac.nowcoder.com/acm/contest/9752/B 来源&#xff1a;牛客网 牛牛现在有一个长度为len只包含小写字母‘a’-z’的字符串x&#xff0c;他现在想要一个特殊的子序列&#xff0c; 这个子序列的长…

TCPIP通信

最近在开发TCPIP通信&#xff0c;封装了3个类&#xff0c;望各位大神指点指点。1 using System;2 using System.Collections.Generic;3 using System.Text;4 using System.Net.Sockets;5 using System.Threading;6 using System.Net;7 using System.Linq;8 using System.Net.Ne…

Python 20 秒画完小猪佩奇“社会人”!

每天写代码的程序员&#xff0c;你们知道今年社交平台上最火的带货女王是谁吗&#xff1f;范冰冰&#xff1f;杨幂&#xff1f;Angelababy&#xff1f;不&#xff0c;是猪猪女孩小猪佩奇。 如果你经常用抖音、快手、B 站、知乎、微博……或者类似的任何一个内容或社交平台&…

使用RNN预测文档归属作者

文章目录1. 文本处理2. 文本序列化3. 数据集拆分4. 建立RNN模型5. 训练6. 测试参考 基于深度学习的自然语言处理 1. 文本处理 数据预览 # 有两个作者的文章&#xff08;A, B&#xff09;&#xff0c;定义为0&#xff0c; 1 A 0 # hamilton B 1 # madison UNKNOWN -1# 把…

Python进阶-函数默认参数,特别是参数传递为空列表

这两天遇到函数默认参数的bug&#xff0c;在互联网上好好总结了一下&#xff1a;如非特别说明&#xff0c;下文均基于Python3一、默认参数 python为了简化函数的调用&#xff0c;提供了默认参数机制&#xff1a;def pow(x, n 2):r 1while n > 0:r * xn - 1return r这样在调…

java中的Switch case语句

java中的Switch case 语句 在Switch语句中有4个关键字:switch,case break,default. 在switch(变量)&#xff0c;变量只能是整型或者字符型&#xff0c;程序先读出这个变量的值&#xff0c;然后在各个"case"里查找哪个值和这个变量相等,如果相等,则条件成立,程序执行相…

LeetCode 1674. 使数组互补的最少操作次数(差分思想)

文章目录1. 题目2. 解题1. 题目 给你一个长度为 偶数 n 的整数数组 nums 和一个整数 limit 。 每一次操作&#xff0c;你可以将 nums 中的任何整数替换为 1 到 limit 之间的另一个整数。 如果对于所有下标 i&#xff08;下标从 0 开始&#xff09;&#xff0c;nums[i] nums[…

python 数据分析-读写数据csv、xlsx文件

1、读写csv文件可以使用基础python实现&#xff0c;或者使用csv模块、pandas模块实现。 基础python读写csv文件 读写单个CSV 以下为通过基础python读取CSV文件的代码&#xff0c;请注意&#xff0c;若字段中的值包含有","且该值没有被引号括起来&#xff0c;则无法…

c#将list集合转换为datatable的简单办法

public static class ExtensionMethods { /// <summary> /// 将List转换成DataTable /// </summary> /// <typeparam name"T"></typeparam> /// <param name"data"></param&g…

Kaggle 房价预测竞赛优胜方案:用 Python 进行全面数据探索

&#xff3b;导读&#xff3d;Kaggle 的房价预测竞赛从 2016 年 8 月开始&#xff0c;到 2017 年 2 月结束。这段时间内&#xff0c;超过 2000 多人参与比赛&#xff0c;选手采用高级回归技术&#xff0c;基于我们给出的 79 个特征&#xff0c;对房屋的售价进行了准确的预测。今…

使用GRU单元的RNN模型生成唐诗

文章目录1. 读取数据2. 字符索引3. 创建文本序列4. 创建文本编码序列5. 使用GRU单元建立RNN模型6. 文本生成参考 基于深度学习的自然语言处理 本文使用 GRU 单元建立 RNN 网络&#xff0c;使用唐诗三百首进行训练&#xff0c;使用模型生成唐诗。 GRU RNN 网络能够克服简单RNN…

循环与分支

1. 循环 for循环for arg in [list] 这是一个基本的循环结构. 它与C语言中的for循环结构有很大的不同.for arg in [list]docommand(s)...done for arg in "$var1" "$var2" "$var3" ... "$varN" 在[list]中的参数加上双引号是为了阻止单…

Python数据结构常见的八大排序算法(详细整理)

前言 八大排序&#xff0c;三大查找是《数据结构》当中非常基础的知识点&#xff0c;在这里为了复习顺带总结了一下常见的八种排序算法。 常见的八大排序算法&#xff0c;他们之间关系如下&#xff1a; 排序算法.png 他们的性能比较&#xff1a; 下面&#xff0c;利用Python分别…