目标
- 模块
- 包
- 发布模块
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__
可以 查看模块 的 完整路径
示例
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 包名
可以一次性导入 包 中 所有的模块
案例演练
- 新建一个
hm_message
的 包 - 在目录下,新建两个文件
send_message
和receive_message
- 在
send_message
文件中定义一个send
函数 - 在
receive_message
文件中定义一个receive
函数 - 在外部直接导入
hm_message
的包
__init__.py
- 在 Python 模块中,
__init__.py
文件是一个特殊的文件,它位于包(Package)目录中,并且在导入包时会被自动执行。 - 要在外界使用 包 中的模块,需要在
__init__.py
中指定 对外界提供的模块列表
2.1 包的初始化
__init__.py
文件的主要作用是初始化包。当导入一个包时,Python 解释器会首先执行该包下的 __init__.py
文件。我们可以在 __init__.py
文件中执行一些初始化操作,例如设置包的全局变量、导入特定模块或子包等。
# __init__.py
print("Initializing my_package...")
# 设置包级别的变量
package_variable = 10
# 导入模块或子包
from . import module1
from .subpackage import module2
# 执行其他初始化操作,可以在 __init__.py 文件中执行其他的初始化操作,例如注册插件、加载配置文件、初始化数据库连接等。
# ...
# 注册插件
register_plugin()
# 加载配置文件
load_config()
# 初始化数据库连接
initialize_database()
在上述示例中,当导入 my_package
时,__init__.py
文件会被执行。它打印出初始化信息,设置了一个包级别的变量 package_variable
,并导入了 module1
模块和 module2
子包。
2.2 当前文件夹是包的标识
__init__.py
文件的另一个重要作用是标识一个目录为包。一个目录只有包含了 __init__.py
文件,才能被视为一个包。如果一个目录中没有 __init__.py
文件,Python 解释器会将其视为普通的目录,而不是包。
my_package/
__init__.py
module1.py
module2.py
2.3 控制包的导入行为
必须在`__init__.py`文件中添加`__all__ = []`,控制允许导入的模块列表
my_module1报红证明不可用
注意: __all__针对的是 ’ from ... import * ‘ 这种方式 对 ‘ import xxx ’ 这种方式无效
总结
综上所述,__init__.py
文件在 Python 包中具有初始化包、控制包的导入行为和提供包级别功能的作用。我们可以根据需要在 __init__.py
文件中编写代码来满足这些需求,并更好地组织和管理你的包。