首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >关于Python导入模块,你可能没学透?!

关于Python导入模块,你可能没学透?!

作者头像
马哥linux运维
修改2019-05-27 17:47:11
8370
修改2019-05-27 17:47:11
举报
文章被收录于专栏:linux、Python学习linux、Python学习

来源:恋习Python

ID:sldata2017

作为一名新手Python程序员,你首先需要学习的内容之一就是如何导入模块或包。但是我注意到,那些许多年来不时使用Python的人并不是都知道Python的导入机制其实非常灵活。在本文中,我们将探讨以下话题:

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

常规导入

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

import
 sys

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

import
 os, sys, time

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

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

import
 sys 
as
 system
print
(system.platform)

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

import
 urllib.error

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

使用from语句导入

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

from
 functools 
import
 lru_cache

上面这行代码可以让你直接调用 lru_cache。如果你按常规方式导入 functools,那么你就必须像这样调用 lru_cache:获取更多技术知识点+v156 5219 9186,欢豆在线解答哦~

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__.py
 subpackage1/
 __init__.py
 module_x.py
 module_y.py
 subpackage2/
 __init__.py
 module_z.py
 module_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
 ham
def
 main():
 ham()

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

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

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

In
 [
1
]: 
import
 my_package
In
 [
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
 ham
def
 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 3
 
from
 http.client 
import
 responses
except
 
ImportError
: 
# For Python 2.5-2.7
 
try
:
 
from
 httplib 
import
 responses 
# NOQA
 
except
 
ImportError
: 
# For Python 2.4
 
from
 
BaseHTTPServer
 
import
 
BaseHTTPRequestHandler
 
as
 _BHRH
 responses = dict([(k, v[
0
]) 
for
 k, v 
in
 _BHRH.responses.items()])

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

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

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

局部导入

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

import
 sys 
# global scope
def
 square_root(a):
 
# This import is into the square_root functions local scope
 
import
 math
 
return
 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
 b
def
 a_test():
 
print
(
"in a_test"
)
 b.b_test()
a_test()

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

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

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

覆盖导入

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

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

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

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

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

总结

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

原文:[Python 101 - All about imports](http://www.blog.pythonlibrary.org/2016/03/01/python-101-all-about-imports/)

本文系转载,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文系转载前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档