### `__init__.py` 文件的作用 `__init__.py` 文件用于标识一个目录为 Python 包，并在导入该包时自动执行其中的代码。该文件可以为空，也可以包含初始化逻辑、包级变量、函数定义以及模块的导入语句，从而为整个包提供统一的接口[^1]。 ### 定义包级变量 在 `__init__.py` 中定义的变量会成为包级变量，可以通过包名直接访问。例如，若在 `my_package/__init__.py` 中定义： ```python # my_package/__init__.py PACKAGE_NAME = "My Package" VERSION = "1.0.0" ``` 在外部使用时： ```python import my_package print(my_package.PACKAGE_NAME) # 输出: My Package print(my_package.VERSION) # 输出: 1.0.0 ``` 这种方式适用于定义常量、配置参数或全局状态等信息[^1]。 ### 定义包级函数 同样地，可以在 `__init__.py` 中定义函数，使其成为包级别的工具函数。例如： ```python # my_package/__init__.py def greet(): print("Hello from My Package!") ``` 外部调用方式如下： ```python import my_package my_package.greet() # 输出: Hello from My Package! ``` 此类函数通常用于提供包级别的辅助功能，例如初始化、日志配置或环境检查等[^1]。 ### 导入子模块或子包 `__init__.py` 也常用于导入子模块或子包，以便用户可以直接通过包名访问其中的内容。例如： ```python # my_package/__init__.py from .module1 import func1 from .module2 import func2 ``` 这样，用户可以简化导入语句： ```python from my_package import func1, func2 ``` 而不是： ```python from my_package.module1 import func1 from my_package.module2 import func2 ``` 这种方式提高了代码的可读性和使用便捷性，同时有助于维护包的公共 API 接口。 ### 控制导入行为（`__all__` 变量） `__init__.py` 中可以定义 `__all__` 变量来控制 `from package import *` 时导入的内容。例如： ```python # my_package/__init__.py __all__ = ['func1', 'func2', 'greet'] ``` 此时，执行： ```python from my_package import * ``` 将只导入 `func1`, `func2`, 和 `greet`，从而避免意外导入不希望暴露的符号[^1]。 --- ### 示例：完整 `__init__.py` 文件 以下是一个综合示例，展示如何在一个 `__init__.py` 文件中定义变量、函数、导入子模块并控制 `__all__`： ```python # my_package/__init__.py PACKAGE_NAME = "My Package" VERSION = "1.0.0" def greet(): print(f"Welcome to {PACKAGE_NAME} version {VERSION}") from .module1 import func1 from .module2 import func2 __all__ = ['PACKAGE_NAME', 'VERSION', 'greet', 'func1', 'func2'] ``` --- ### 使用场景建议 - **常量定义**：适合将配置参数、版本号等信息放在 `__init__.py` 中，便于统一管理和访问。 - **工具函数**：包级函数如初始化逻辑、日志配置等可在此定义。 - **模块导入**：为了简化用户导入路径，可以在 `__init__.py` 中导入常用模块。 - **API 暴露控制**：通过 `__all__` 明确声明包的公共接口，增强代码可维护性。 --- ###