Frappe框架bench命令Python环境不一致致模块缺失求助

问题背景 #

使用Frappe框架时，bench start（通过Procfile启动服务）或直接执行bench watch时，系统调用了错误的Python环境，导致无法找到frappe模块。

Procfile内容 #

redis_queue: redis-server config/redis_queue.conf

web: bench serve --port 8000

socketio: /home/amol/.nvm/versions/node/v22.3.0/bin/node apps/frappe/socketio.js

watch: bench watch

schedule: bench schedule
worker:  bench worker 1>> logs/worker.log 2>> logs/worker.error.log 

已配置的虚拟环境状态 #

激活自定义虚拟环境.venv后，环境配置正常：

(.venv) amol@amol-IdeaPad-Gaming-3-15ARH05:~/WorkSpace/frappe/frappe-bench$ which python
/home/amol/WorkSpace/frappe/.venv/bin/python

(.venv) amol@amol-IdeaPad-Gaming-3-15ARH05:~/WorkSpace/frappe/frappe-bench$ which bench
/home/amol/WorkSpace/frappe/.venv/bin/bench

(.venv) amol@amol-IdeaPad-Gaming-3-15ARH05:~/WorkSpace/frappe/frappe-bench$ python
Python 3.12.3 (main, Sep 11 2024, 14:17:37) [GCC 13.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import frappe;
>>> frappe
<module 'frappe' from '/home/amol/WorkSpace/frappe/frappe-bench/apps/frappe/frappe/__init__.py'>
>>> 

错误现象 #

执行bench start或bench watch时，系统使用frappe-bench/env/bin/python而非虚拟环境的Python，报错：

16:26:56 watch.1       | /home/amol/WorkSpace/frappe/frappe-bench/env/bin/python: Error while finding module specification for 'frappe.utils.bench_helper' (ModuleNotFoundError: No module named 'frappe')

直接执行bench watch的错误输出：

(.venv) amol@amol-IdeaPad-Gaming-3-15ARH05:~/WorkSpace/frappe/frappe-bench$ bench  watch
/home/amol/WorkSpace/frappe/frappe-bench/env/bin/python: Error while finding module specification for 'frappe.utils.bench_helper' (ModuleNotFoundError: No module named 'frappe')

解决建议 #

1. 检查bench脚本的shebang行
   打开虚拟环境内的bench脚本（/home/amol/WorkSpace/frappe/.venv/bin/bench），确认第一行的shebang指向正确的Python路径：

   #!/home/amol/WorkSpace/frappe/.venv/bin/python
   

   若路径错误，修改后执行chmod +x /home/amol/WorkSpace/frappe/.venv/bin/bench确保脚本可执行。

2. 强制指定虚拟环境Python运行bench
   直接用虚拟环境的Python调用bench脚本，避免环境检测偏差：

   (.venv) amol@amol-IdeaPad-Gaming-3-15ARH05:~/WorkSpace/frappe/frappe-bench$ /home/amol/WorkSpace/frappe/.venv/bin/python /home/amol/WorkSpace/frappe/.venv/bin/bench watch
   

   也可以修改Procfile中的命令，明确指定虚拟环境路径：

   watch: /home/amol/WorkSpace/frappe/.venv/bin/python /home/amol/WorkSpace/frappe/.venv/bin/bench watch
   web: /home/amol/WorkSpace/frappe/.venv/bin/python /home/amol/WorkSpace/frappe/.venv/bin/bench serve --port 8000
   schedule: /home/amol/WorkSpace/frappe/.venv/bin/python /home/amol/WorkSpace/frappe/.venv/bin/bench schedule
   worker: /home/amol/WorkSpace/frappe/.venv/bin/python /home/amol/WorkSpace/frappe/.venv/bin/bench worker 1>> logs/worker.log 2>> logs/worker.error.log
   

3. 重新安装bench到虚拟环境
   先卸载当前bench：

   pip uninstall bench -y
   

   再用虚拟环境的pip重新安装：

   pip install frappe-bench
   

4. 验证环境变量优先级
   激活虚拟环境后，检查PATH变量是否将虚拟环境bin目录放在最前面：

   echo $PATH
   

   正常输出应以/home/amol/WorkSpace/frappe/.venv/bin开头，若不是，检查虚拟环境激活脚本的PATH配置。

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