Python 面向对象 --- 模块

目标

• 模块
• 包
• 模块的制作

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 的解释器在 导入模块 时，会：
1，搜索 当前目录 指定模块名的文件，如果有就直接导入
2，如果没有，再搜索 系统目录

注：在开发中，给文件起名，不要和 系统模块文件 重名

python 中每一个模块都是一个内置属性 __file__ 可以 查看模块 的 完整路径

示例

import random

# 生成一个 0 ~ 10 的数字
rand = random.randint(0, 10)

print(rand)

注意： 如果当前目录下，存在一个 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）

概念

• 包 是一个 包含多个模块 的 特殊目录
• 目录下有一个 特殊的文件 __init__.py
• 包名的 命名方式 和 变量名 一致，小写字母 + _

好处

• 使用 import 包名 可以一次性导入 包 中 所有的模块

案例演练

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

init.py

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

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

def receive():
    return "这是来自 110 的短信"

def send(text):
    print("正在发送 %s" % text)

03，发布模块

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

3.1 制作发布压缩包步骤

目录结构

[root@test python_code]# tree
.
├── hm_message
│   ├── __init__.py
│   ├── receive_message.py
│   └── send_message.py
└── setup.py

1，创建 setup.py

• setup.py 的文件

[root@test python_code]# more setup.py
from distutils.core import setup

setup(name="String.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，构建模块

[root@test python_code]# python3 setup.py build
running build
running build_py
creating build
creating build/lib
creating build/lib/hm_message
copying hm_message/__init__.py -> build/lib/hm_message
copying hm_message/send_message.py -> build/lib/hm_message
copying hm_message/receive_message.py -> build/lib/hm_message

[root@test python_code]# tree
.
├── build
│   └── lib
│       └── hm_message
│           ├── __init__.py
│           ├── receive_message.py
│           └── send_message.py
├── hm_message
│   ├── __init__.py
│   ├── receive_message.py
│   └── send_message.py
└── setup.py

4 directories, 7 files

3，生成发布压缩包

[root@test python_code]# python3 setup.py sdist
running sdist
running check
warning: sdist: manifest template 'MANIFEST.in' does not exist (using default file list)

warning: sdist: standard file not found: should have one of README, README.txt, README.rst

writing manifest file 'MANIFEST'
creating String.hm_message-1.0
creating String.hm_message-1.0/hm_message
making hard links in String.hm_message-1.0...
hard linking setup.py -> String.hm_message-1.0
hard linking hm_message/__init__.py -> String.hm_message-1.0/hm_message
hard linking hm_message/receive_message.py -> String.hm_message-1.0/hm_message
hard linking hm_message/send_message.py -> String.hm_message-1.0/hm_message
creating dist
Creating tar archive
removing 'String.hm_message-1.0' (and everything under it)

[root@test python_code]# tree
.
├── build
│   └── lib
│       └── hm_message
│           ├── __init__.py
│           ├── receive_message.py
│           └── send_message.py
├── dist
│   └── String.hm_message-1.0.tar.gz
├── hm_message
│   ├── __init__.py
│   ├── receive_message.py
│   └── send_message.py
├── MANIFEST
└── setup.py

5 directories, 9 files

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

3.2 安装模块

[root@test dist]# tar zxvf String.hm_message-1.0.tar.gz
String.hm_message-1.0/
String.hm_message-1.0/PKG-INFO
String.hm_message-1.0/hm_message/
String.hm_message-1.0/hm_message/__init__.py
String.hm_message-1.0/hm_message/receive_message.py
String.hm_message-1.0/hm_message/send_message.py
String.hm_message-1.0/setup.py
[root@test-docker dist]# tree
.
├── String.hm_message-1.0
│   ├── hm_message
│   │   ├── __init__.py
│   │   ├── receive_message.py
│   │   └── send_message.py
│   ├── PKG-INFO
│   └── setup.py
└── String.hm_message-1.0.tar.gz

2 directories, 6 files

[root@test dist]# cd String.hm_message-1.0
[root@test-docker String.hm_message-1.0]# python3 setup.py install
running install
running build
running build_py
creating build
creating build/lib
creating build/lib/hm_message
copying hm_message/__init__.py -> build/lib/hm_message
copying hm_message/send_message.py -> build/lib/hm_message
copying hm_message/receive_message.py -> build/lib/hm_message
running install_lib
creating /usr/local/python3/lib/python3.7/site-packages/hm_message
copying build/lib/hm_message/__init__.py -> /usr/local/python3/lib/python3.7/site-packages/hm_message
copying build/lib/hm_message/send_message.py -> /usr/local/python3/lib/python3.7/site-packages/hm_message
copying build/lib/hm_message/receive_message.py -> /usr/local/python3/lib/python3.7/site-packages/hm_message
byte-compiling /usr/local/python3/lib/python3.7/site-packages/hm_message/__init__.py to __init__.cpython-37.pyc
byte-compiling /usr/local/python3/lib/python3.7/site-packages/hm_message/send_message.py to send_message.cpython-37.pyc
byte-compiling /usr/local/python3/lib/python3.7/site-packages/hm_message/receive_message.py to receive_message.cpython-37.pyc
running install_egg_info
Writing /usr/local/python3/lib/python3.7/site-packages/String.hm_message-1.0-py3.7.egg-info

[root@test String.hm_message-1.0]# cd /usr/local/python3/lib/python3.7/site-packages/

[root@test site-packages]# tree hm_message/
hm_message/
├── __init__.py
├── __pycache__
│   ├── __init__.cpython-37.pyc
│   ├── receive_message.cpython-37.pyc
│   └── send_message.cpython-37.pyc
├── receive_message.py
└── send_message.py

1 directory, 6 files

[root@test site-packages]# ipython3
Python 3.7.0 (default, Jul 18 2018, 16:50:30)
Type 'copyright', 'credits' or 'license' for more information
IPython 6.4.0 -- An enhanced Interactive Python. Type '?' for help.

In [1]: import hm_message

In [2]: hm_message.send_message.send("hello")
正在发送 hello

In [3]: hm_message.receive_message.receive()
Out[3]: '这是来自 110 的短信'

卸载模块

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

[root@test String.hm_message-1.0]# cd /usr/local/python3/lib/python3.7/site-packages/

[root@test site-packages]# rm -f 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