网站开发比较厉害,合肥专业网站建设,asp网站报错信息,建筑企业网站模板许多年来不时使用Python的人并不是都知道Python的导入机制其实非常灵活。在本文中#xff0c;我们将探讨以下话题#xff1a;
常规导入#xff08;regular imports#xff09;使用from语句导入相对导入#xff08;relative imports#xff09;可选导入#xff08;option…许多年来不时使用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)打开终端cd至my_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.pyIn [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 wont work!main()现在从终端进入subpackage1文件夹执行以下命令
python module_x.py如果你使用的是Python 2你应该会看到下面的错误信息
Traceback (most recent call last):File module_x.py, line 1, in modulefrom . 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 modulefrom . 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 moduleimport mathFile /Users/michael/Desktop/math.py, line 6, in modulesquare_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 packagemodule_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_modulemodule 中的函数以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_modulemodule 中的函数以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 attributemodule中的函数直接使用被引用的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_a4. 函数顶部引入可以用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欢迎查看或forkReferenceThis Gist
总结
在本文中我们讲了很多有关导入的内容但是还有部分内容没有涉及。PEP 302中介绍了导入钩子import hooks支持实现一些非常酷的功能比如说直接从github导入。Python标准库中还有一个importlib模块值得查看学习。当然你还可以多看看别人写的代码不断挖掘更多好用的妙招。
