11--Python 导入模块与包

@Author : Roger TX ([email protected])

@Link : https://github.com/paotong999

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：

functools.lru_cache(*args)

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

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

from os import *

这种做法，需要注意的是 __all__ 这个变量。这个变量是内置变量，没有表示默认值，包含所有。但是如果有定义这个函数，则只导入该变量内的值。可以在 py文件中，也可以在包的 __init__.py 中出现。

在普通模块中使用时，表示一个模块中允许哪些属性可以被导入到别的模块中
在包下的 __init__.py 时，只是导入这个包 __all__ 变量内包含的模块，但是__init__.py中可以执行一些初始化内容，比如：from . import test1 导入当前目录下的其他模块

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

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

四、可选导入（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()])

五、局部导入

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

将模块导入至函数的局部作用域，这意味着模块只能在函数内部使用。使用局部作用域的好处之一，是你使用的模块可能需要很长时间才能导入，如果是这样的话，将其放在某个不经常调用的函数中或许更加合理，而不是直接在全局作用域中导入。

老实说，我几乎从没有使用过局部导入，主要是因为如果模块内部到处都有导入语句，会很难分辨出这样做的原因和用途。根据约定，所有的导入语句都应该位于模块的顶部。

导入注意事项

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

循环导入（circular imports）
覆盖导入（Shadowed imports，暂时翻译为覆盖导入）

循环导入
如果你创建两个模块，二者相互导入对方，那么就会出现循环导入。
如果你运行任意一个模块，都会引发 AttributeError。这是因为这两个模块都在试图导入对方。简单来说，模块 a想要导入模块 b，但是因为模块 b也在试图导入模块 a（这时正在执行），模块 a将无法完成模块 b的导入，一般需要避免发生这种情况。

覆盖导入
当你创建的模块与标准库中的模块同名时，如果你导入这个模块，就会出现覆盖导入。解释器首先在当前运行脚本所处的的文件夹中查找同名的模块。

总结

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

转载于:https://www.jianshu.com/p/0c626120779e