Python 的模块管理_python模块管理-CSDN博客

本文链接：https://blog.csdn.net/snail915/article/details/147674203

Python 的模块管理

引言

当我们的项目还很小时，完全可以将所有的 py 文件放在同一个目录下。但是，随着项目的逐步深入，代码文件越来越多，就需要对其分类管理，于是就需要用到 Python 的模块管理了。本文主要包含以下内容

1.什么是包以及包的作用

2.如何使用包

3.什么是 __init.py 文件，以及它的具体作用

什么是包 (package)

包的本质其实就是目录，是一种组织代码的方式，用于将相关联的代码进行分组存放。它主要包含四个作用：

1.代码模块化：将功能相似的代码分类存放，避免单个文件太大。

2.避免命名冲突：当项目组人数较多时，遵照代码规范，不同组员有可能会命名相同的名称。通过包名区分，可有效避免命名冲突。

3.方便代码复用：包可以被其他项目直接引用，避免重复造轮子。

4.提高可维护性：清晰的目录结构更易维护和协作开发。

如何使用包（Package）

1.创建包

新建一个目录（包名），例如 packageA
在目录中创建一个 __init__.py 文件（可以是空文件，标识这是一个包）
添加模块（ .py 文件）

# 在项目目录下，创建了一个 packageA 的包
# 在 packageA 包下创建了一个 mathe.py 的模块，用于定义常见的数学方法
# 在 mathe.py 模块中定义了一个 Mathe 类，如下
class Mathe:
    def __init__(self):
        Pai = 3.1415926

    # 定义了一个静态加法方法
    @staticmethod
    def add(*arg):
        sum = 0
        for i in arg:
            sum += i
        return sum

if __name__ == "__main__":
    print(Mathe.add(1,2,3,4,5))

2.导入包中的模块并使用

# 导入包有三种方式：
# 方式1：导入整个模块，调用时需加上包名
import packageA.mathe 
print(packageA.mathe.Mathe.add(1,2,3))

# 方式2：从模块导入特定函数
from packageA import Mathe
print(Mathe.add(12,3))

# 方式3：使用别名（避免冲突）
import packageA.mathe as mathe1
print(mathe1.Mathe.add(1,2,3))

什么是 `init.py` 文件

__init__.py 是 Python 包（Package）的核心文件，用于标识一个目录是 Python 包，并控制包的初始化行为。它包含有三个关键性的作用：

1.标识一个包

在 Python 3.2 及更早的版本中，没有定义 __init__.py 的目录完全不能作为包导入，会导致 ImportError

# 示例结构：
mypackage/
    ├── __init__.py    # 必须存在（Python 3.3 前强制要求）
    ├── module1.py
    └── subpackage/
        ├── __init__.py
        └── module2.py

2.包的初始化

当包被导入时，__init__.py 中的代码会自动执行。这就催生了两个重要用途

定义包集的变量、函数或类（如 __version__ 定义包的版本）
执行包初始化逻辑（如加载配置、建立数据库连接、配置环境变量等）

3.控制导入行为

通过 __all__ 变量指定 from package import * 时导出的模块

# mypackage/__init__.py
__all__ = ["module1", "subpackage"]  # 允许导出的模块

以下是一个完整的 __init__.py 文件示例

"""
mypackage 主包的初始化文件

这个文件定义了包的公共接口和初始化逻辑。
"""

# 1. 版本信息
__version__ = "1.0.0"
__author__ = "John Doe"
__license__ = "MIT"

# 2. 控制 from mypackage import * 的行为
__all__ = [
    'CONST_PI',
    'helper_function',
    'CoreClass',
    'calculate'
]

# 3. 包级别导入（公开接口）
from .constants import CONST_PI, CONST_G
from .utils import helper_function, calculate
from .subpackage.core import CoreClass

# 4. 初始化代码
print(f"初始化 mypackage 版本 {__version__}")

# 5. 延迟导入（可选）
def lazy_import():
    """延迟导入重型模块的示例"""
    import heavy_module  # 实际使用时再导入
    return heavy_module

# 6. 包级别函数
def package_info():
    """返回包信息"""
    return {
        "version": __version__,
        "author": __author__,
        "license": __license__
    }

# 7. 子包快捷访问（可选）
subpackage = None  # 占位符

def __getattr__(name):
    """Python 3.7+ 的延迟子包导入"""
    if name == 'subpackage':
        global subpackage
        from . import subpackage as sp
        subpackage = sp
        return subpackage
    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")