Python 模块和包-CFANZ编程社区

仅用学习参考

目标

模块
包
发布模块

01. 模块

1.1 模块的概念

模块是 Python 程序架构的一个核心概念

每一个以扩展名py 结尾的Python 源代码文件都是一个模块
模块名同样也是一个标识符，需要符合标识符的命名规则
在模块中定义的全局变量、函数、类都是提供给外界直接使用的工具
模块就好比是工具包，要想使用这个工具包中的工具，就需要先导入这个模块

1.2 模块的两种导入方式

1）import 导入

import 模块名1, 模块名2

提示：在导入模块时，每个导入应该独占一行

import 模块名1
import 模块名2

导入之后

通过模块名. 使用模块提供的工具——全局变量、函数、类

使用 `as` 指定模块的别名

如果模块的名字太长，可以使用 as 指定模块的名称，以方便在代码中的使用

import 模块名1 as 模块别名

注意：模块别名 应该符合 大驼峰命名法

2）from...import 导入

如果希望从某一个模块 中，导入部分工具，就可以使用 from ... import 的方式
import 模块名 是 一次性 把模块中 所有工具全部导入，并且通过 模块名/别名 访问

# 从 模块 导入 某一个工具
from 模块名1 import 工具名

导入之后

不需要通过模块名.

可以直接使用模块提供的工具——全局变量、函数、类

注意

如果 两个模块，存在 同名的函数，那么 后导入模块的函数，会 覆盖掉先导入的函数

开发时import 代码应该统一写在代码的顶部，更容易及时发现冲突
一旦发现冲突，可以使用as 关键字给其中一个工具起一个别名

from...import *

# 从 模块 导入 所有工具
from 模块名1 import *

注意

这种方式不推荐使用，因为函数重名并没有任何的提示，出现问题不好排查

1.3 模块的搜索顺序[扩展]

Python 的解释器在 导入模块 时，会有以下操作：

搜索当前目录指定模块名的文件，如果有就直接导入
如果没有，再搜索系统目录

在开发时，给文件起名，不要和 系统的模块文件 重名

Python 中每一个模块都有一个内置属性__file__ 可以查看模块的完整路径
示例 - 随机生成 0~10 的整数

In [5]: import random

In [6]: rand = random.randint(0,10)

In [7]: print(rand)
10

In [18]: rand = random.randint(0,10)

In [19]: print(rand)
6

In [20]: rand = random.randint(0,10)

In [21]: print(rand)
2

In [22]:

注意：如果当前目录下，存在一个 random.py 的文件，程序就无法正常执行了！
因为这个时候，Python 的解释器会 加载当前目录 下的 random.py 而不会加载 系统的 random 模块

1.4 原则 —— 每一个文件都应该是可以被导入的

一个独立的 Python 文件就是一个模块
在导入文件时，文件中所有没有任何缩进的代码都会被执行一遍！
实际开发场景
在实际开发中，每一个模块都是独立开发的，大多都有专人负责
开发人员通常会在模块下方增加一些测试代码

仅在模块内使用，而被导入到其他文件中不需要执行

`name` 属性

__name__ 属性可以做到，测试模块的代码只在测试情况下被运行，而在被导入时不会被执行！
__name__ 是Python 的一个内置属性，记录着一个字符串
如果是被其他文件导入的，__name__ 就是模块名
如果是当前执行的程序__name__ 是__main__
在很多 Python 文件中都会看到以下格式的代码：

# 导入模块
# 定义全局变量
# 定义类
# 定义函数

# 在代码的最下方
def main():
    # ...
    pass

# 根据 __name__ 判断是否执行下方代码
if __name__ == "__main__":
    main()

02. 包（Package）

Python 模块和包_python

python的包不是这种包

概念

包是一个包含多个模块的特殊目录
目录下有一个特殊的文件__init__.py
包名的命名方式和变量名一致，小写字母+_好处
使用import 包名 可以一次性导入包中所有的模块

案例演练

新建一个hm_message 的包
在目录下，新建两个文件send_message 和receive_message
在send_message 文件中定义一个send 函数
在receive_message 文件中定义一个receive 函数
在外部直接导入hm_message 的包

`init.py`

要在外界使用包中的模块，需要在__init__.py 中指定对外界提供的模块列表

# 从 当前目录 导入 模块列表
from . import send_message
from . import receive_message

Python 模块和包_当前目录_02

03. 发布模块

如果希望自己开发的模块，分享给其他人，可以按照以下步骤操作

3.1 制作发布压缩包步骤

1) 创建 setup.py

setup.py 的文件

from distutils.core import setup

setup(name="hm_message",  # 包名
      version="1.0",  # 版本
      description="itheima's 发送和接收消息模块",  # 描述信息
      long_description="完整的发送和接收消息模块",  # 完整描述信息
      author="itheima",  # 作者
      author_email="itheima@itheima.com",  # 作者邮箱
      url="www.itheima.com",  # 主页
      py_modules=["hm_message.send_message",
                  "hm_message.receive_message"])

有关字典参数的详细信息，可以参阅官方网站

2) 构建模块

$ python setup.py build

Python 模块和包_python_03

3) 生成发布压缩包

$ python setup.py sdist

注意：要制作哪个版本的模块，就使用哪个版本的解释器执行！

Python 模块和包_python_04

执行完毕之后，就会生成数据文件如下：

Python 模块和包_python_05

3.2 安装模块

$ tar -zxvf hm_message-1.0.tar.gz 或者 unzip hm_message-1.0.zip

 $ python setup.py install

卸载模块

直接从安装目录下，把安装模块的目录删除就可以。

$ cd /usr/local/lib/python3.5/dist-packages/
$ sudo rm -r hm_message*

3.3 `pip` 安装第三方模块

第三方模块 通常是指由 知名的第三方团队 开发的 并且被 程序员广泛使用 的 Python 包 / 模块

例如pygame 就是一套非常成熟的游戏开发模块
pip 是一个现代的，通用的Python 包管理工具
提供了对Python 包的查找、下载、安装、卸载等功能
安装和卸载命令如下：

# 将模块安装到 Python 2.x 环境
$ sudo pip install pygame
$ sudo pip uninstall pygame

# 将模块安装到 Python 3.x 环境
$ sudo pip3 install pygame
$ sudo pip3 uninstall pygame

Python 模块和包_python_06