root用户下pip install -e本地包显示成功但无法导入的排查方案

排查步骤 #

• 检查egg-link文件位置与内容
  执行以下命令获取root用户的site-packages路径：

  python -c "import site; print(site.getsitepackages())"
  

  进入该路径，查看是否存在my-pkg.egg-link文件，打开文件确认其内容是否指向my-pkg的正确绝对路径。如果文件不存在或路径错误，就是问题根源。
• 验证Python环境一致性
  root和普通用户分别执行以下命令，确认使用的是同一个Python解释器：

  which python && python --version
  

  Docker环境中可能存在PATH变量差异，导致root使用的Python和普通用户不一致。
• 检查文件权限
  查看my-pkg及其子目录的权限：

  ls -ld my-pkg my-pkg/my_pkg
  

  确保root用户对这些文件有读取权限（虽然root默认有权限，但如果目录权限是drwx------，可能会影响Python的导入逻辑）。
• 查看详细安装日志
  重新执行安装命令并开启verbose模式：

  pip install -e my-pkg -v
  

  重点关注日志中关于egg-link生成的步骤，是否有隐藏的错误或路径异常。

解决方法 #

• 使用--user参数安装
  即使是root用户，也可以强制安装到用户级site-packages：

  pip install -e my-pkg --user
  

  这会避免系统级路径的权限或环境冲突问题。
• 手动创建egg-link文件
  找到root用户的site-packages路径，手动创建my-pkg.egg-link文件，写入my-pkg的绝对路径。例如：

  echo "/absolute/path/to/your/project/my-pkg" > /usr/local/lib/python3.9/site-packages/my-pkg.egg-link
  

• 调整目录权限
  确保my-pkg目录及文件对所有用户可读：

  chmod -R a+r my-pkg
  

• 直接执行setup.py
  跳过pip，直接运行setup.py的develop模式：

  python /absolute/path/to/my-pkg/setup.py develop
  

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