python 导入模块问题

Python028

python 导入模块问题,第1张

Python是一种面向对象的编程语言,里面包含有丰富强大的库,想要学习Python开发,首先需要学习如何导入模块或包。下面就跟大家一起讨论下Python导入模块的几种方法:

常规导入

最常用的导入方式,大概是这样的:

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 :

functools.lru_cache(*args)

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

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

from os import *

这种做法在少数情况下是挺方便的,但是这样也会打乱你的命名空间。问题在于,你可能定义了一个与导入模块中名称相同的变量或函数,这时如果你试图使用

os 模块中的同名变量或函数,实际使用的将是你自己定义的内容。因此,你最后可能会碰到一个相当让人困惑的逻辑错误。

标准库中我唯一推荐全盘导入的模块只有Tkinter 。

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

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

from os import path, walk, unlinkfrom 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 subpackage1from . import subpackage2

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

from . import module_xfrom . 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_xOut[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

from . module_y import spam as hamValueError: Attempted relative import in non-package

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

Traceback (most recent call last):

File "module_x.py", line 1, in

from . module_y import spam as hamSystemError: Parent module '' not loaded, cannot perform relative import

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

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

import syssys.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 responsesexcept 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 urlopenexcept 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.pyimport 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

import math

File "/Users/michael/Desktop/math.py", line 6, in

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 。

当遇到无法导入某个python模块时,可能会是没有安装某个模块,也有可能是某模块在加载过程中失败,也有可能是陷入了循环导入的问题。本文详细解释了这个问题。

1. 模块未安装或者路径不对

ImportError: No mudule named myModule

有两种可能,一是该模块没有安装,一般可以用

pip install %module_name%

来解决。注意有时候模块安装包名并不等于要导入的模块名。这种情况下可以通过pip search | list命令来尝试找到正确的包。

另一种情况就是包虽然安装了,但当前运行的程序加载的路径有错。python运行时将从以下位置尝试加载python modules:

* 当前目录

* 环境变量$PYTHONPATH所指示的值,这是一个由“:”分隔的字符串,各个子字符串都是文件系统的一个路径。

* 标准库目录,如dist-site-packages下的模块。

* 在.pth文件中指定的路径,如果存在.pth文件的话。

可以使用以下方式来查看python运行时的包含路径:

?

12

import sysprint(sys.path)

在运行出错的脚本装头部加上这一段代码,然后在控制台中查看打印出来的python类库路径,检查安装包是否已包含在上述路径中。

***可以通过下面的方式将未包含在路径中的模块临时包含进来:***

sys.path.append("path/to/module")

另外,还可以在shell窗口中查看当前的python包含路径:

echo $PYTHONPATH

2. 无法导入已存在的模块

如果要导入的模块包含了native代码,并且native代码加载(初始化)失败时,就会导致这种错误。使用ssl,

gevent等涉及native的模块时,如果对应的native程序并未安装,则会出现这样的错误。

另一种错误情况是,使用相对路径导入时,父模块还未导入成功。见下面的代码:

?

12345

main.pymypackage/ __init__.pymymodule.pymyothermodule.py

mymodule.py如下所示:

?

123456789101112

#!/usr/bin/env python3 # Exported functiondef as_int(a): return int(a) # Test function for module def _test(): assert as_int('1') == 1 if __name__ == '__main__': _test()

以及myothermodule代码如下所示:

?

1234567891011121314

#!/usr/bin/env python3 from .mymodule import as_int # Exported functiondef add(a, b): return as_int(a) + as_int(b) # Test function for module def _test(): assert add('1', '1') == 2 if __name__ == '__main__': _test()

如果执行mypackage/myothermodule,则会报以下错误:

Traceback (most recent call last):

File "myothermodule.py", line 3, in

<module>

from .mymodule import as_int

SystemError: Parent module

'' not loaded, cannot perform relative import

[这篇文章](#Relative imports in

Python 3)给出了更详细的解答。

3. 循环导入

这种错误称之为"circular (or cyclic) imports"。是python独有的一种导入错误,在象java这样的语言中就不存在。

假设有如下两个文件,a.py和b.py:

?

1234567

#a.pyprint "a in"import sysprint "b imported: %s" % ("b" in sys.modules, )import bprint "a out"print b.x

以及:

?

12345

#b.pyprint "b in"import aprint "b out"x = 3

执行python a.py,将得到以下结果:

?

123456789101112131415

$ python a.pya in b imported: Falseb ina inb imported: Truea outTraceback (most recent call last): File "a.py", line 4, in <module> import b File "/home/shlomme/tmp/x/b.py", line 2, in <module> import aFile "/home/shlomme/tmp/x/a.py", line 7, in <module> print b.xAttributeError: 'module' object has no attribute 'x'

出现这种情况的原因是产生了循环导入。循环导入,以及在导入过程中python进行了加锁操作,最终导致在模块b未导入完成时就引用了其中的名字。

判断导入错误是否是因为循环导入引起的,主要看堆栈中是否出现两次重复的导入。比如上述堆栈中a.py出现两次,因此可以判断是这个文件引起的循环导入。

要解决这个问题,可以把模块看成一种资源,对所有要引入的模块进行编号,再按静态资源排序法顺次导入,就可以避免循环导入。