【python】通过修改 sys.path 来解决相对导入问题

project/
├── utils/
│   ├── logger_manager.py  # 包含 LogRecord 类
│   └── redis_manager.py   # 当前报错的文件
└── main.py

在 redis_manager.py 中添加以下代码：

# redis_manager.py
import sys
from pathlib import Path

# 获取当前脚本的父目录（即 utils 目录的父目录，也就是 project/）
parent_dir = str(Path(__file__).resolve().parent.parent)
# 将父目录添加到 sys.path
sys.path.append(parent_dir)

# 现在可以使用绝对导入，从项目根目录开始查找模块
from utils.logger_manager import LogRecord

# 后续代码保持不变...

代码解释

• sys：用于访问 Python 解释器的系统参数，包括 sys.path。
• Path：来自 pathlib 模块，用于处理文件路径，比传统的字符串路径更安全、更简洁。

• Path(__file__)：获取当前脚本（redis_manager.py）的路径对象。
• .resolve()：将路径解析为绝对路径。
• .parent.parent：获取父目录的父目录（即 project/）。
• str(...)：将路径对象转换为字符串。

• sys.path.append(parent_dir)：将父目录添加到模块搜索路径的末尾。

• from utils.logger_manager import LogRecord：直接从 utils 包导入模块，Python 会在 sys.path 中找到 project/ 目录。

• 无需修改项目结构（不需要 __init__.py）。
• 不依赖运行方式（可以直接运行脚本）。
• 适用于临时调试或快速修复。

• 每个脚本都需要添加路径代码，冗余较多。
• 如果项目结构复杂，可能需要更复杂的路径计算。
• 修改 sys.path 是临时的，仅对当前脚本有效。

常见问题

• 如果项目结构嵌套较深，可能需要调整 .parent 的数量。例如：

• # 如果脚本在更深的目录中，可能需要更多 .parent
  parent_dir = str(Path(__file__).resolve().parent.parent.parent)

• 为避免重复添加相同路径，可以先检查：

• if parent_dir not in sys.path:
      sys.path.append(parent_dir)

• pathlib 模块自动处理不同操作系统的路径分隔符（如 / 和 \），确保代码在 Windows、Linux、macOS 上都能正常工作。

适用场景

• 独立脚本或工具，不需要作为包的一部分。
• 快速调试或临时修改。
• 无法修改项目结构（如第三方代码）的情况。