详解Python模块化--模块(Modules)和包(Packages)

引言

在刚入门python时，模块化编程、模块、类库等术语常常并不容易理清。尤其是Modules（模块）和Packages（包），在import引用时很容易混淆出错。

实际上，Python中的函数(Function)、类(Class)、模块(Module)、包库(Package)，都是为了实现模块化引用，让程序的组织更清晰有条理。

• 通常，函数、变量、类存储在被称为模块(Module)的.py文件中，一组模块文件又组成了包(Package)。
• 将函数、变量、类存储在存储在独立的.py文件中，可隐藏代码实现的细节，将不同代码块重新组织，与主程序分离，简化主程序的逻辑，提高主程序的可读性。
• 有了包和模块文件，可以在其他不同程序中进行复用，还可以使用其他人开发的第三方依赖库。

Python Modules模块

Modules2模块是包含 Python 定义和语句的文件。以.py为后缀的文件名就是模块名称。

在模块内，模块的名称可以用全局变量 __name__表示（字符串）。

举个例子，我们创建了一个fibo.py文件，文件内容为：

# Fibonacci numbers module
def fib(n):    # write Fibonacci series up to n
    a, b = 0, 1
    while a < n:
        print(a, end=' ')
        a, b = b, a+b
    print()
def fib2(n):   # return Fibonacci series up to n
    result = []
    a, b = 0, 1
    while a < n:
        result.append(a)
        a, b = b, a+b
    return result

这里fibo.py就是一个模块，fib、fib2是fibo模块中的函数。

导入模块

如果我们想要在其他程序中使用fibo模块，可以有以下三种方式导入：

①导入整个模块

#import module_name
import fibo

可使用下面的语法来使用其中任何一个函数：

#module_name.func()
fibo.fib(10)

⭕ 注意：这里模块名+句点不可省略。

②导入模块中的特定函数

#from module_name import function_name
from fibo import fib, fib2
fib(10)

若使用这种语法，调用函数时就无需使用模块名+句点。

因为在import语句中已经显式地导入了函数fib和fib2，因此调用它时只需指定其名称。

③导入模块中的所有函数

#from module_name import *
from fibo import *
fib(20)

这种方式会导入除可下划线 (__)开头的名称以外的所有函数。

⭕ 注意：在大多数情况下，通常不推荐*这种用法，因为它可能会在解释器中引入了一组未知的名称，而且通常会导致代码可读性变差。

给导入的模块一个别名

# import module as m
import numpy as np
a = np.arange(100)

利用as给导入模块一个别名，简化代码中的调用写法。

单独运行模块

如果我们想单独测试下模块，可以在模块中添加以下代码，就可以既用作脚本，也可用作可导入模块：

if __name__ == "__main__":
    import sys
    fib(int(sys.argv[1]))

单独运行模块：

python fibo.py 100

这段解析命令行的代码仅在模块作为“主”文件执行时才运行。

加速模块加载

为了加快模块的加载速度，Python 会将每个模块的编译版本（如*.pyc）会缓存在__pycache__下的目录中。生成编译文件pyc的详细过程，可以参考文档PEP 3147。

Python 会根据编译版本检查源代码的修改日期，以查看它是否已过期并需要重新编译。

Python Packages包

Packages包可以理解为一组模块的容器，并用Package.Module的方式来构建命名空间3。

以文件系统来类比的话，可以将包视为文件系统上的目录，而将模块视为目录中的文件。4

例如，A.B指定的是在命名为B的包中命名为A的子模块。

利用这样的方法，可以避免一些多模块的包之间命名发生冲突的问题，有点类似于C++中的std::string、cv::imread等命名空间的引用。

例如，这是一个官方的package例子，提供了关于声音处理的sound包：

sound/                          Top-level package
      __init__.py               Initialize the sound package
      formats/                  Subpackage for file format conversions
              __init__.py
              wavread.py
              wavwrite.py
              ...
      effects/                  Subpackage for sound effects
              __init__.py
              echo.py
              ...
      filters/                  Subpackage for filters
              __init__.py
              equalizer.py
              ...

• __init__.py 必须有这个文件，才能使 Python 将包含该文件的目录视为包（Package）。__init__.py可以是一个空文件，也可以执行包的初始化代码或设置__all__变量。
• formats/ 、effects/ 、filters/ 是次一级的子包（Subpackage），每个子包中也有__init__.py 文件。
• echo.py等文件是子包中的模块（Module），模块中可能包含函数、类或变量。

引用包（Package）中的模块

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

这种方式，可以直接引用函数，而不用加上前面包的前缀。

引用包（Package）中子模块的函数或变量

from sound.effects.echo import echofilter
echofilter(input, output, delay=0.7, atten=4)

这种方式会加载子模块echo，同时使子模块中的 echofilter() 函数直接可用。

from package import item语句会先测试item是否在包中定义；如果包中没有找到定义，会假定item是一个模块并尝试加载它。如果依旧找不到item， 就会引发我们常见的ImportError异常。

利用相对路径引用包和模块

from . import echo
from .. import formats
from ..filters import equalizer

这里的.可以访问同级目录下的包（Package）或者模块（Module）。
这里的..可以访问上一级目录下的包（Package）或者模块（Module）。

利用__all__提供包的显式索引

当我们直接采用from sound.effects import *时，可能会引用一些不需要的内容，或者导致加载速度过慢。

这时我们可以通过在__init__.py中定义一个_all__列表，来指定用 * 时应导入的模块名称列表：

__all__ = ["echo", "surround", "reverse"]

这样我们就可以维护在import * 时需要导入的模块列表，在发布不同版本的包时很有用。

打包自己的Package并分发

通过setuptool工具打包自己的Package，可以参考这两篇文档：

https://packaging.python.org/tutorials/packaging-projects/
如何添加必要的文件和结构来创建包、如何构建包以及如何将其上传到Python Package Index。

https://packaging.python.org/guides/distributing-packages-using-setuptools/
介绍如何配置、打包和分发自己的 Python 项目的基础知识。

安装python社区中的Package

注意，在python社区中的Package，通常是指发行版的软件包，而不是源代码中一组模块的容器（a container of modules）。

常见的包可以查看PyPI：https://pypi.org/，通过使用pip install来安装社区提供的Packages。

总结

模块化就是将相关代码组织到不同层级的文件里，便于复用，提高代码的可读性。

函数、变量、类存储在被称为模块(Module)的.py文件中，一组模块文件又组成了包(Package)。

引入Package包或Module模块，可以用import …或from … import …，还可以通过相对路径引用上一级的包和模块。