如何通过Singularity容器从远程目录运行自定义Python模块

问题场景 #

平时运行自定义Python模块的命令为：

singularity run ./Image/myimage.sif -m mymodule.start

该命令仅在与mymodule同目录时生效。将模块所在本地目录~/Projects/MyModule/绑定到容器内/mnt后，执行以下命令：

singularity run --bind ~/Projects/MyModule/:/mnt ./Image/myimage.sif -m mymodule.start

出现报错：

/usr/bin/python3: No module named mymodule.start

解决方法 #

• 通过环境变量临时添加模块路径
  启动容器时设置PYTHONPATH环境变量，将绑定目录/mnt（若mymodule在/mnt的子目录，需指定到对应父目录）加入Python的模块搜索路径：

singularity run --bind ~/Projects/MyModule/:/mnt --env PYTHONPATH=/mnt ./Image/myimage.sif -m mymodule.start

• 切换到绑定目录后执行模块
  使用singularity exec配合bash命令，先切换到绑定目录再运行模块，Python会自动把当前目录纳入搜索路径：

singularity exec --bind ~/Projects/MyModule/:/mnt ./Image/myimage.sif bash -c "cd /mnt && python3 -m mymodule.start"

• 创建.pth文件实现持久化识别
  如果需要长期使用该模块，可在容器内的Python site-packages目录下创建.pth文件，写入绑定目录路径：

# 进入容器交互模式
singularity shell --bind ~/Projects/MyModule/:/mnt ./Image/myimage.sif
# 在容器内执行（替换python3.x为实际Python版本，如python3.8）
echo "/mnt" > /usr/lib/python3.x/site-packages/mymodule.pth

之后每次启动容器，Python都会自动加载该路径下的模块。

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