Python基础-包与模块

Python基础-包与模块

写在前面

如非特别说明，下文均基于Python3

摘要

为重用以及更好的维护代码，

Python

使用了模块与包；一个

Python

文件就是一个模块，包是组织模块的特殊目录(包含

__init__.py

文件)。

模块搜索路径，

Python

解释器在特定的目录中搜索模块，运行时

sys.path

即搜索路径。

使用

import

关键字导入模块，注意

import *

与

__all__

的关系。

1. 模块与导入

A module is a file containing Python definitions and statements

Python

模块就是包含定义以及语句的文件，文件名是模块的名字加上

.py

后缀。

1.1 为重用而生

假设有一个完成特定功能，很好用的函数或者类。为了使用这个功能，不得不把这段代码复制到需要使用的每一个文件中。重复代码是编程的大忌，如果功能实现需要修改，会不得不修改每一个出现的地方，这是反人类的。

重用能够很好的解决这一问题，实际上，函数，类等结构在一定程度上也为重用提供了便利。

Python

中，将一系列相关的函数，类等组织在一个文件中，每一个文件都是一个

Python

模块。

1.2 导入模块

使用

import

关键字导入模块(模块需在搜索路径中)：

import sys；基础导入语句。

import sys as system；为导入的名字起别名。

from sys import path；导入模块特定元素。

from sys import *；从sys中导入全部可导入名字

import-only-once

模块只导入一次这种行为在大多数情况下是一种实质性的优化，在同一个解释器生命周期内，多次使用

import

语句导入同一个模块，导入只发生一次。

这一点可以在模块中加入输出语句证明。

import *

与

__all__

使用

import *

可能会污染当前模块的名字空间，导入了一些不需要引用的名字。因此不推荐使用。

事实上，规范的第三方模块会提供一个模块公共接口，暴露该模块可用的接口。公共接口由模块名为

__all__

的列表定义。

如定义名为

mtest1

的模块：

__all__ = ['test1', 'test12']

def test1():
print('test1')

def test11():
print('test11')

def test12():
print('test12')

使用全部导入的方式：

>>> form mtest1 import *
>>> dir()
>>> ['__annotations__', '__builtins__', '__doc__', '__loader__','__name__', '__package__', '__spec__', 'test1', 'test12']

可以看到函数

test11()

并没有被导入，这就是

__all__

的作用了。

2. 包与其构建

为了更好组织模块，将模块分组为包(package)。

2.1 包是特殊模块

从文件系统上看，包就是模块所在目录。为使

Python

解释器将其区别普通目录作为包看待，包中必须直接包含一个名为

__init__.py

的文件(模块)。

包基本上就是另外一类模块，不同的地方在于包能包含其他模块与包。包作为一个模块，其内容其实就是文件

__init__.py

(模块)的内容。

如名为

constants

的包，文件

constants/__init__.py

如下：

PI = 3.14

那么可以将包

constants

作为普通模块对待：

import constants
print(constants.PI)

2.2 构建包

如果要构建一个名为

drawing

的包，其中包含

shapes

和

colors

模块，需要创建一下目录和文件：

文件/目录	描述
~/python	加入到搜索路径中的目录
~/python/drawing	包目录(drawing包)
~/python/drawing/__init__.py	包代码(drawing模块)
~/python/drawing/colors.py	color模块
~/python/drawing/shapes.py	shapes模块

假设已经将

~/python

作为搜索目录。依照这个设置，下列导入语句都是合法的：

import drawing

# 导入drawing包(即

__init__.py

模块)

import drawing.colors

# 导入colors模块，使用drawing.colors.attr的方式引用

from drawing import shapes

# 导入shapes模块

__all__

变量

与模块的

__all__

变量相似，包的

__all__

变量决定了使用

from package import *

导入的子模块。

如以上

drawing

包的

__init__.py

文件内容如下：

__all__ = ['colors']

那么使用

from drawing import *

只会导入

colors

模块。

3. 搜索路径

现在已经编写完了一个很好用的模块，并且通过了测试。那么如何让这个模块可用呢？即如何让这个模块具备可导入到其他模块的能力。

3.1 搜索模块

当使用

import

语句导入模块时，

Python

解释器通过以下方式搜索模块：

首先搜索

built-in

模块

最后搜索变量

sys.path

提供的路径列表

sys.path

在解释器启动时从以下位置初始化：

当前脚本路径

环境变量

PYTHONPATH

指定的路径集合

安装默认路径

sys.path

初始化完成后，可以在运行时修改。

3.2 让模块可用

那么现在若要使模块可用，一是将其放置到已有的搜索路径下，二是指定模块所在路径为搜索路径。

一般情况下，若选择第一种方式，我们将模块放置到

Python

安装路径的

\lib\site-packages

下，这个目录是专门用来安装第三方模块的。正如该目录下的

README

文件展示的那样：

This directory exists so that 3rd party packages can be installed here. Read the source for site.py for more details.

若选择第二种方式，直接将模块所在目录加入到环境变量

PYTHONPATH

中即可。

值得注意的是，可以在

\lib\site-packages

路径下新建一个名为

user_lib.pth

的文件，内容是需要搜索的路径，一行一个，也可以将指定路径加入到搜索目录中：