使用nbdev创建的本地Python库安装后无法识别的问题求助

核心原因 #

1. 路径识别差异：仓库顶层执行pip install -e .后，Python仅将顶层目录加入系统路径（sys.path），但nbs文件夹内的Notebook默认不会自动向上识别顶层目录，导致找不到pyseatrials模块。
2. 包名配置不一致：你在终端用from seatrials import *成功，但代码中尝试导入pyseatrials，说明库文件夹名称或setup.py/settings.ini中的包名配置存在不一致。
3. pip版本兼容性：pip 22.x对可编辑安装的识别逻辑有调整，若setup.py或settings.ini配置不规范，会导致包无法出现在pip list中。

解决步骤 #

1. 修正包名配置一致性 #

• 打开仓库根目录的settings.ini，确保package_name字段值为pyseatrials，与你要导入的包名一致。
• 打开setup.py，确认setup()函数中的name参数同样设置为pyseatrials。
• 若库文件夹名称是seatrials，建议重命名为pyseatrials，保持包名、文件夹名、配置完全一致。

2. 修复Notebook的路径问题 #

在nbs文件夹内的Notebook开头添加以下代码，手动将仓库顶层目录加入系统路径：

import sys, os
sys.path.insert(0, os.path.abspath('..'))

添加后再执行from pyseatrials.trig import *即可正常导入。

3. 重新执行规范的可编辑安装 #

• 先卸载现有可能存在的错误安装：

  pip uninstall -y seatrials pyseatrials
  

• 回到仓库顶层目录，重新执行：

  pip install -e .
  

• 执行pip list | grep pyseatrials，此时应该能看到包名，且标注为editable状态。

4. 用nbdev工具同步配置 #

执行nbdev的钩子和同步命令，确保Notebook与库代码的关联正常：

nbdev_install_hooks
nbdev_build_lib
nbdev_clean_nbs

5. 验证Python环境一致性 #

在Notebook中执行以下代码，查看当前内核的Python路径：

import sys
print(sys.executable)

对比终端中执行which python3的输出，确保两者路径一致，避免因多环境隔离导致的导入问题。

内容的提问来源于stack exchange，提问作者Jonno Bourne