Python（2.2）模块与包

2017-10-13

对于初学者来说，通常只需要一个 .py 源码文件，就可以应付各种范例程序，然而实际的应用程序需要的代码数量远比范例程序要来的多，只使用一个 .py 文件来编写，势必造成程序管理上的混乱，你必须学会根据功能将文件划分在不同的模块（Module）中编写，而功能相近或彼此辅助的模块，也要知道如何使用包（Package）来加以管理。

2.2.1 模块简介

有件事实也许令人惊讶，其实你已经编写过模块了，每个 .py 文件本身就是一个模块，当你编写完一个 .py 文件，而别人打算直接引用你的成果的话，只需要在他编写的 .py 文件中导入（import）就可以了。举个例子来说，若想在 Hello3.py 中，直接引用先前写好的 Hello2.py，可以按以下方式来编写：

此处输入图片的描述

每个 .py 文件的文件名就是模块名称，想要引入模块时必须使用 import 关键字指定模块名称，若想取用模块中定义的名称，必须在名称前加上模块名称与一个「.」，例如 Hello2.name。接着来直接执行 Hello3.py，看看会有什么结果：

此处输入图片的描述

执行结果中的前两行显示，就是 Hello2.py 中的内容，被 import 到模块中的程序会被执行，接着执行 Hello3.py 中 import 之后的程序。

提示：此时若查看 .py 文件所在的文件夹，会发现多了个 pycache 文件夹，当中会有 .pyc 文件，这是 CPython 将 .py 文件转译后的位元码文件，之前再次引入同一模块，若源码文件检测到没有变更，就不会对源码重新进行语法分析等动作，而可以从位元码开始直译，以加快直译速度。

类似地，Python 本身提供有标准程序库，若需要这些程序库中的某个模块功能，可以将模块引入，例如，若想要获得命令列引数（Command-line-argument），可以通过 sys 模块中的 argv 清单（list）。例如：

此处输入图片的描述

由于 argv 定义在 sys 模块中，在 import sys 后，就必须使用 sys.argv 来取用，sys.argv 清单中的资源取用时必须指定索引（Index）号码，这个号码实际上从 0 开始，然而 sys.argv[0] 会存储原始文件名，就上面的例子来说，就是存储 Hello4.py，若有提供命令列引数，就依次从 sys.argv[1] 开始储存。一个执行结果如下：

此处输入图片的描述

如果又多个模块需要 import，除了逐行 import 之外，也可以在但一行中使用逗号「,」来区分模块。例如：

1	import sys, email

使用模块来管理代码，有利于代码的重用且可避免混乱，然而有些函数，类别等经常使用，每次都要 import 就显得麻烦了，因此这类常用的函数、类别等，也经常被整理在一个 builtins 模块中，在 builtins 模块中的函数、类别等名称，都可以不用 import 直接取用，而且不用加上模块名称作为前置，像是之前使用过的 print()、input()函数。

提示：想知道还有那些函数或类别吗？可以在 REPL 中使用 dir() 函数查询 __builtins__ 模块，dir() 函数会将可用的名称列出，例如 dir(__builtins__)：

2.2.2 设定 PYTHONPATH

你已经学会使用模块了，现在有个小问题，若想取用他人编写好的模块，一定要将 .py 文件放到当前的文件夹中吗？举个例子来说，目前的 .py 文件都放在 E:\Pyhton\workspace，如果执行 python 指令时也在 E:\Pyhton\workspace，基本上不会有问题，然而若是在其他文件夹就会出错了：

此处输入图片的描述

python -c 可以指定一段小程序来执行，因此，python -c “import Hello”，就相当于在某个 .py 档案中执行了 import Hello，因此这可以用来测试是否可找到指定模块。可以看到，在找不到指定模块时，会发生 ModuleNotFoundError 错误。

如果想将他人提供的 .py 文件，放到其他的文件夹（例如 lib 文件夹）中加以管理，可以设定 PYTHONPATH 环境变量来解决这个问题。Python 编译器会在环境变量设定的文件夹中，寻找是否有指定模块名称对应的 .py 文件。例如：

此处输入图片的描述

在 Windows 中，可以使用 SET PYTHONPATH=路径1;路径2 的方式来设定 PYTHONPATH 环境变量，多个路径时中间使用「;」来分隔。实际上，Pyhton 编译器会根据 sys.path 清单中的路径来寻找模块，以目前的设定来看，sys.path 会包含以下内容：

此处输入图片的描述

提示：如果 Windows 中安装了多个版本的 Python 环境，也可以按照类似方式设定 PATH 环境变量，例如 SET PATH=Python环境路径，这样就可以切换执行的 python 编译器版本。

因此，如果想要动态地管理模块的寻找路径，也可以通过程序变更 sys.path 的内容来达到。例如在没有对 PYTHONPATH 设定任何信息的情况下，在进入 REPL 后，可以如下进行设定：

此处输入图片的描述

在上面的图片中可以看到，sys.path.append('E:\Python\workspace') 对 sys.path 新增了一条路径信息，因此之后 import Hello 时，就可以在 E:\Python\workspace 找到对应的 Hello.py 了。

2.2.3 使用套件管理模块

现在你所编写的程序，可以分别放在各个模块之中，就源码管理上比较好一些了，但还不是很好，就如同你会分不同文件夹来放置不同作用的文档，模块也应该分门别类加以放置。

举例来说，一个应用程序中会有多个模块彼此合作，也有可能由多个团队共同分工，完成应用程序的某些功能块，再组合在一起，如果你的应用程序是多个团队共同合作，若不分门别类放置模块，那么若 A 部门写了个 util 模块，B 部门也写了个 util 模块，当他们要将应用程序整合，若都将模块放在同一个 lib 目录中的话，就会发生同名的 util.py 文件覆盖问题。

两个部门各自建立文件夹放置自己的 util.py 文件，然后在 PYTHONPATH 中设定路径的方式行不通，因为执行 import util 时，只会使用 PYTHONPATH 第一个找到的 util.py，你真正需要的方式，必须是能够 import a.util 或 import b.util 来取用对应的模块。

为了便于进行套件管理的示范，我们来建立一个新的 hello_prj 文件夹，这就像是新建立应用程序时，必须有个专门的文件夹来管理相关资源。假设你在 hello_prj 中新增一个 openhome 套件，那么请在 hello_prj 中建立一个 openhome 文件夹，而 openhome 文件夹中，建立一个 __init__.py 文件。

此处输入图片的描述

注意！文件夹中一定要有一个 __init__.py 文件，该文件夹才会被视为一个套件。在套件的进阶管理中， __init__.py 中其实也可以编写程序，不过目前请保持 __init__.py 文件内容为空。

接着，将 Hello2.py 文件，复制到 openhome 套件中，然后将 Hello3.py 文件，复制到 hello_prj 文件夹，并修改 Hello3.py 如下：

此处输入图片的描述

主要的修改就是 import openhome.Hello2 与 openhome.Hello2.name，也就是模块名称前被加上了套件名称，这就说明了，套件名称会成为名称空间的一部分。

当 Python 编译器看到 import openhome.Hello2 时，会寻找 sys.path 中的路径里，是否有某个文件夹中含有 openhome 文件夹，若有找到，再进一步确认其中是否有个 __init__.py 文件，若有的话就确认有 openhome 套件了，接着看看其中是否有 Hello2.py，如果找到，就可以顺利完成模块的 import。

要执行 Hello3.py，请再主控台中切换至 E:\Pyhton\workspace\hello_prj 文件夹，一个执行范例如下所示：

此处输入图片的描述

由于套件名称会成为名称空间的一部分，就先前 A、B 两个部门的例子来说，可以分别建立 a 套件与 b 套件，当中放置各自的 util.py，当两个部分的 a、b 两个文件夹放到同一个 lib 文件夹时，并不会发生 util.py 文件彼此覆盖的问题，而再取用模块时，可以分别 import a.util 与 import b.util，若想取用各自模块中的名称，也可以使用 a.util.some、b.util.other 来区别。

如果模块数量很多，也可以建立多层次的套件，也就是套件中还会有套件，在这种情况下，每个担任套件的文件夹与子文件夹中，各要有一个 init.py 文件。举例来说，若想要建立 openhome.blog 套件，那么 openhome 文件夹中要有个 __init__.py 文件，而 openhome/blog 文件夹中，也要有个 __init__.py 文件。

提示：还记得在安装 Python 的 lib 文件夹中，包括了许多标准程序库的源码文件吗？lib 文件夹包含在 sys.path 之中，这个文件夹中也使用了一些套件来管理模块，而其中还有个 site-packages 文件夹，用来安装 Python 的第三方库，这个文件夹也包含在 sys.path 之中，通常第三方库也会使用套件来管理相关模块。

2.2.4 使用 import as 与 from import

使用套件管理，解决了实体文件与 import 模块时名称空间的问题，然而有时套件名称加上模块名称，会使得存取某个函数、类别等时，必须编写又臭又长的前置，若嫌麻烦，可以使用 import as 或者 from import 来解决这个问题。

import as 重新命名模块

如果想要改变被引入模块在当前模块中的变量名称，可以使用 import as。例如可修改先前 hello_prj 中的 Hello3.py 为以下：

1 2	import openhome.Hello2 as Hello print('今天要来点什么不同的吗？',Hello.name,'!')

在上面的范例中，import openhome.Hello2 as Hello 将 openhome.Hello2 模块，重新命名为 Hello，接下来就可以使用 Hello 这个名称来直接存取模块中定义的名称。

from import 直接引入名称

使用 import as 是将模块重新命名，然而，存取模块中定义的名称时，还是得加上名称前置，如果仍然嫌麻烦，可以使用 from import 直接将模块中指定的名称引入。例如：

1 2	from sys import argv print('Hello World', argv[0], '!')

在这个范例中，直接将 sys 模块中的 argv 名称引入至 Hello 模块中，也就是目前的 Hello.py 中，接下来你就可以直接使用 argv，而不是 sys.argv 来存取命令列索引。

如果有多个名称想要直接引入当前模块，除了逐行 from import 之外，也可以在单一行中使用逗号「,」来分隔，例如：

1	from sys import argv, path

你可以更偷懒一些，用以下的 from import 语句来引入 sys 模块中全部的名称：

1	from sys import *

不过这种方式有点危险，因为很容易造成名称冲突问题，若两个模块中正好都有相同的名称，那么比较后面 from import 的名称会覆盖先前的名称，导致一些意外的 BUG 发生，因此，除非你是在编写一些简单且内容不长的指令稿，否则并不建议使用 from xxx import * 的方式。

from import 除了从模块引入名称之外，也可以从套件引入模块，例如，若 openhome 套件下有个 hello 模块，就可以如下引入模块名称：

1	from openhome import hello