python包的导入,__init__相关问题-优快云博客

本文链接：https://blog.youkuaiyun.com/python_136/article/details/149721054

在 Python 中，当你尝试导入一个模块（比如import gun_pb2）时，Python 会按照特定的顺序在预定义的路径列表中查找该模块文件（如gun_pb2.py）。如果文件存在，但所在目录不在这个搜索路径列表目录下，Python 就会抛出ModuleNotFoundError

解决方案

你可以通过以下几种方式将目录添加到搜索路径：

1. 修改当前脚本（推荐临时使用）

在main.py中动态添加路径：

import sys
sys.path.append('./protobuf_files')  # 添加目录到搜索路径

import gun_pb2  # 现在可以找到了

2. 设置环境变量（推荐永久使用）

在终端中设置PYTHONPATH环境变量：

# Linux/macOS
export PYTHONPATH="${PYTHONPATH}:/path/to/my_project/protobuf_files"

# Windows (PowerShell)
$env:PYTHONPATH += ";C:\path\to\my_project\protobuf_files"

3. 创建包结构（推荐项目级组织）

将protobuf_files转为 Python 包（添加__init__.py文件）：

my_project/
├── main.py
└── protobuf/  # 转为包
    ├── __init__.py  # 空文件，声明此目录为包
    └── gun_pb2.py

# main.py
from protobuf import gun_pb2  # 包路径在默认搜索路径中

原理总结

Python 的模块搜索路径由以下部分组成（按顺序查找）：

当前执行脚本所在的目录
PYTHONPATH环境变量中指定的目录
Python 安装的默认库目录（如site-packages）

如果你的模块不在这些路径中，Python 就无法找到它，即使文件物理上存在。

搜索路径的组成（按查找顺序）

当前执行脚本所在的目录
如果你运行 python /path/to/your/script.py，Python 会首先在 /path/to/your/ 目录下查找模块。
PYTHONPATH 环境变量中指定的目录
PYTHONPATH 是一个操作系统级的环境变量，你可以在其中添加自定义的模块搜索路径。多个路径用分隔符（Linux/macOS 用 :，Windows 用 ;）分隔。
Python 安装的默认库目录
包括标准库和第三方库安装的位置（如 site-packages），这是 Python 自带的搜索路径。

如何查看模块搜索路径？

你可以通过以下两种方式查看当前 Python 解释器的搜索路径：

方法 1：在 Python 代码中查看 `sys.path`

import sys

# 打印模块搜索路径列表
for path in sys.path:
    print(path)

/Users/you/projects/my_project  # 当前脚本目录
/Users/you/custom_modules       # PYTHONPATH 中添加的路径
/Library/Frameworks/Python.framework/Versions/3.9/lib/python39.zip
/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9
/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/lib-dynload
/Users/you/Library/Python/3.9/lib/python/site-packages
/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages

当前脚本所在目录（优先级最高）
PYTHONPATH 环境变量中的目录（用户自定义路径）
Python 标准库和第三方库目录（如 site-packages）

`init.py` 文件的作用

告诉 Python：这是一个包。没有它，Python 不会把目录当作包处理（Python 3.3+ 中不强制，但仍建议保留）。
可以初始化包（导入默认内容）：

比如在 my_package/__init__.py 中写

print("包被导入了！")

from .module_a import func_a
# main.py
from my_package import func_a # 直接从包中导入函数

相对导入 vs 绝对导入包内的行为

from my_package.module_a import func

# 在 module_b.py 中
from .module_a import func # 同级目录
from ..sub_package import module_c # 上一级目录

在 Python 里，只要发生了包导入的行为，不管采用何种导入方式，都会先执行包的 __init__.py 文件。下面为你详细说明：

1. 包导入机制

当你导入一个包时，比如使用 import my_package、from my_package import * 或者 from my_package import module_a 等方式，Python 会先执行该包的 __init__.py 文件。
__init__.py 文件的作用是对包进行初始化，并且定义包的命名空间。
要是 __init__.py 文件中有可执行代码，像打印语句、变量赋值或者函数调用等，这些代码都会在导入包的时候被执行。

# 方式 1: 导入整个包
import my_package  # 执行 __init__.py

# 方式 2: 从包中导入特定模块
from my_package import module_a  # 执行 __init__.py，再导入 module_a

# 方式 3: 从包中导入特定对象
from my_package import func1  # 执行 __init__.py，再导入 func1

# 方式 4: 通配符导入（受 __all__ 限制）
from my_package import *  # 执行 __init__.py，再导入 __all__ 中列出的对象

3. 避免副作用的最佳做法

不在 __init__.py 中放置可执行代码：__init__.py 主要用于定义包的公共接口，要避免编写会产生副作用的代码，例如打印信息、进行文件操作等。
使用显式导入：推荐采用 from my_package.module_a import func1 这样的显式导入方式，这样可以提高代码的可读性。
延迟导入：如果某些导入操作会带来较大开销，或者会引发循环导入的问题，可以在函数或方法内部进行延迟导入。