关于ImportError: attempted relative import with no known parent package解决

问题

我的项目结构如下：

my_project/
├── utils/
│   ├── __init__.py
│   └── config.py
└── scripts/
    ├── __init__.py
    └── train.py

当我在train.py中 尝试导入config中的模块时，即 from ..utils.config import *，报错：
ImportError: attempted relative import with no known parent package

解决

只需要两步：

1. 将my_project目录加到环境中

import os
import sys

SCRIPT_DIR = os.path.dirname(__file__)         # 获取当前脚本所在的目录
sys.path.append(os.path.dirname(SCRIPT_DIR))   # 将当前脚本所在目录的父目录添加到 sys.path                  #然后再导入所需模块

2. 然后再导入(一定要放在前面代码的后面)：
   from utils.config import *

第一步的作用是动态地修改 Python 的模块搜索路径，以便能够进行导入操作。具体来说，它通过在运行时添加目录到 sys.path，确保 Python 能够找到并导入相关的模块。

分步解释

1. SCRIPT_DIR = os.path.dirname(__file__)

   • __file__ 是一个特殊变量，包含当前脚本的文件路径。
   • os.path.dirname(__file__) 返回当前脚本文件的目录路径。例如，如果脚本路径是 /path/to/my_project/scripts/train.py，那么 SCRIPT_DIR 将是 /path/to/my_project/scripts。

2. sys.path.append(os.path.dirname(SCRIPT_DIR))

   • os.path.dirname(SCRIPT_DIR) 获取 SCRIPT_DIR 的父目录路径。如果 SCRIPT_DIR 是 /path/to/my_project/scripts，那么 os.path.dirname(SCRIPT_DIR) 将是 /path/to/my_project。
   • sys.path.append(...) 将这个路径添加到 sys.path 列表中。sys.path 是一个包含所有 Python 模块搜索路径的列表，Python 解释器会按照这个列表中的路径顺序查找模块。

为什么要这么做？

项目结构如下：

my_project/
├── utils/
│   ├── __init__.py
│   └── config.py
└── scripts/
    ├── __init__.py
    └── train.py

如果你在 train.py 中需要导入 utils.config 模块：

# train.py
from utils.config import *

直接运行 train.py 可能会失败，因为 utils 目录不在 sys.path 中。通过将 my_project 目录添加到 sys.path，你可以确保 train.py 能够成功导入 utils.config 模块。

例子

# train.py
import os
import sys

# 获取当前脚本的目录
SCRIPT_DIR = os.path.dirname(__file__)
# 将当前脚本目录的父目录添加到 sys.path
sys.path.append(os.path.dirname(SCRIPT_DIR))

# 现在可以成功导入 utils.config 模块
from utils.config import *

# 其他代码

运行脚本

确保在项目的根目录下运行脚本：

cd /path/to/my_project
python scripts/train.py

通过这种方式，train.py 可以正确地导入 utils.config 模块，因为 my_project 目录被添加到了 sys.path，Python 解释器能够在这个目录中查找模块。

总结

这段代码的主要目的是动态地修改模块搜索路径，以确保在特定项目结构下，脚本能够正确导入需要的模块。这样做可以避免直接修改环境变量或依赖硬编码的路径，从而提高代码的可移植性和灵活性。