Python 模块与包系统

Python 的模块就是一个 .py 文件，它包含了 Python 代码的函数、类、变量等。

my_modules.py    ├── 变量    ├── 函数    ├── 类    └── 可执行代码

作用：

• 代码组织：将功能相关放在一起。
• 代码复用：一个模块可以被多个程序使用。
• 命名空间隔离：避免变量名冲突。
• 可维护性：模块化设计更容易维护。

模块基本使用：

my_math.py：

"""my_math.py - 数学工具模块"""PI = 3.14159defadd(a, b):return a + bdefmultiply(a, b):return a * bclassCalculator:defpower(self, x, n):return x ** n

在另一个文件中导入并使用：

import my_mathprint(my_math.PI)print(my_math.add(3, 5))calc = my_math.Calculator()print(calc.power(2, 10))

import 机制

四种导入方式：

# 方式1：导入整个模块（最常用）import mathprint(math.sqrt(16))  # 4.0# 方式2：导入特定对象（推荐）from math import sqrt, piprint(sqrt(16))       # 4.0print(pi)             # 3.14159# 方式3：导入所有对象（不推荐！）from math import *print(sin(0))         # 0.0print(cos(0))         # 1.0# 方式4：给模块起别名import numpy as nparray = np.array([1, 2, 3])

Python 模块路径

sys.path 是 Python 运行时的一个列表，维护了模块导入的路径：

# 查看模块路径import sysprint(sys.path)for path in sys.path print(path)

通常情况下模块搜索路径的顺序为：

1. 当前脚本所在目录
2. PYTHONPATH 环境变量指定的目录
3. Python 安装目录，标准库路径
4. site-packages 第三方库

通过修改 sys.path 列表是可以改变 path 模块导入路径顺序的，不过这在实际开发中并不常用，维护起来会比较困难。

# 自定义模块搜索路径import sys# 末尾添加自定义模块路径sys.path.append('/path/to/my/modules')import my_custom_modules# 插入到开头，优先级最高sys.path.insert(0, '/path/to/my/modules')

sys.path 的修改只在当前Python进程（当前项目运行期间）有效，不是永久性的。

__name__ 与 __main__

一个 .py 文件中所有的顶级代码 top-level code 在被其他模块导入时，都会立即执行。

所以 import 的顺序与时机会影响一个程序的行为。

每个模块 .py 文件都有一个 __name__ 属性：

• 当该 .py 文件被 Python 解释器直接执行的时候，__name__ 的值为 __main__；
• 当他被其他模块导入的时候，__name__ 的值为该 .py 文件的模块名，也就是它的文件名。

my_module.py：

# my_module.pyprint(__name__)

命令行直接使用 Python 解释器执行，会打印 __main__：

jackey@jackey-HBB-WX9:$ python3 my_module.py__main__

其他模块导入，test.py：

# test.pyimport my_module # 在导入时，my_module 中的顶层代码会立即值执行，__name__ 的值变为 my_module

jackey@jackey-HBB-WX9:$ python3 test.pymy_module

这点非常重要，也非常实用，很多 Python 开发者会忽略这一点。

当我们不想让一个模块中所有的代码都被其他模块使用的时候，可以这样写：

... ...if __name__ == "__main__":    ... ...  # 其他模块导入时不会执行的代码

这样 if __name__ == "__main__":  后的代码，就可以使用 python 解释器单独跑该 .py 脚本，来测试整个模块的代码在指定的情况下能否运行正常。

而该 .py 模块被导入和整个项目整体跑的时候，if __name__ == "__main__": 后的代码并不会执行影响项目的行为。

这个用法在实际开发中非常实用，通常情况下我们会把一个系统拆分成很多功能模块，每个模块设计好接口后，可以使用假数据测试功能模块，确保万无一失后，再将所有的模块组合在一起。

实际开发中的典型流程：

1. 拆分系统：将一个大型系统拆分成多个功能模块
2. 独立开发：每个模块设计好输入/输出接口
3. 独立测试：在每个模块中通过 if __name__ == "__main__": 编写测试代码，使用模拟数据验证模块功能
4. 组合集成：各模块万无一失后，通过 import 组合到一起
5. 持续迭代：修改某个模块后，依然可以独立测试验证

这样做的好处：

• 提升开发效率：无需启动整个项目即可测试单个模块
• 降低 BUG 率：模块级测试更精准，问题定位更快速
• 减少维护成本：每个模块都有独立的"说明书"（测试代码）
• 促进代码复用：模块设计得更独立、更通用

在命令行调用 .py 脚本的时候可以传入参数，影响程序的行为：

# test.py... ...if __name__ == "__main__":import sys# sys.argv[0] 是脚本名称# sys.argv[1:] 是命令行参数for arg in sys.argv:        print(f"参数：{arg}")

jackey@jackey-HBB-WX9:$ python3 test.py argv1 argv2 argv3参数：test.py参数：argv1参数：argv2参数：argv3

Python 包 - Package

包是一个包含多个模块的目录，必须包含 __init__.py 文件（Python 3.3+ 可以没有，但是强烈推荐包含）。

my_package/              ← 包目录    __init__.py          ← 包的初始化文件    module1.py           ← 模块1    module2.py           ← 模块2    subpackage/          ← 子包        __init__.py        submodule1.py        submodule2.py

__init__.py 在包被导入时执行，用于：

1. 初始化包状态
2. 导入子模块（方便外部使用）
3. 定义 __all__（控制 from package import * 的行为）

包的导入方式：

# 假设项目结构如下："""project/├── my_package/│   ├── __init__.py│   ├── math_utils.py│   └── web/│       ├── __init__.py│       └── requests.py└── main.py"""# 方式1：导入整个包import my_packagemy_package.math_utils.add(3, 5)# 方式2：从包中导入模块from my_package import math_utilsmath_utils.add(3, 5)# 方式3：导入包中的特定函数from my_package.math_utils import addadd(3, 5)# 方式4：导入子包中的模块from my_package.web import requestsrequests.get('http://example.com')# 方式5：导入子包import my_package.web.requestsmy_package.web.requests.get('http://example.com')

__init__.py 高级用法

# my_package/__init__.py"""包的入口文件，控制包的对外接口"""# 1. 控制导入行为__all__ = ['math_utils', 'string_utils']  # 限制 from package import *# 2. 暴露内部模块的接口from .math_utils import add, subtractfrom .string_utils import to_upper, to_lower# 3. 包级别的初始化print("my_package 正在初始化...")# 4. 定义包级别的变量__version__ = '1.0.0'__author__ = 'Python Trainer'# 5. 条件导入（根据平台）import sysif sys.platform == 'win32':from . import windows_utilselse:from . import unix_utils# 使用后：# from my_package import add, subtract  # 可以直接导入# print(my_package.__version__)          # 1.0.0

实际开发中，要避免循环导入的问题：

# module_a.pyfrom module_b import function_bdeffunction_a():return function_b()# module_b.pyfrom module_a import function_a  # 循环导入！！！deffunction_b():return function_a()

END.