在Google Colab中执行pyautogui报错KeyError: 'DISPLAY'求助

问题描述 #

在Windows和Chromebook系统上使用Google Colab运行pyautogui代码时触发KeyError: 'DISPLAY'错误，但相同代码在Anaconda（Jupyter）本地环境中可正常运行。

运行代码：

!pip install pyautogui

import pyautogui

# 延迟2秒后移动鼠标指针到(500,500)位置
pyautogui.moveTo(500, 500, duration=2)

错误信息：

---------------------------------------------------------------------------
KeyError                                  Traceback (most recent call last)
<ipython-input-6-db2179c13aca> in <cell line: 1>()
----> 1 import pyautogui
      2 
      3 #Move mouse pointer with 2 sec delay
      4 pyautogui.moveTo(500, 500, duration=2)

2 frames
/usr/lib/python3.10/os.py in __getitem__(self, key)
    678         except KeyError:
    679             # raise KeyError with the original key value
--> 680             raise KeyError(key) from None
    681         return self.decodevalue(value)
    682 

KeyError: 'DISPLAY'

代码及错误截图：

问题原因 #

Google Colab的代码运行在云端无图形界面的服务器环境中，而pyautogui依赖本地桌面环境的DISPLAY环境变量来控制鼠标、键盘等外设，云端环境不存在该变量，因此导入库时直接报错。而Anaconda的Jupyter环境运行在本地桌面系统中，自带图形界面支持，所以代码能正常执行。

解决方案 #

如果需要在Colab中测试pyautogui的GUI操作逻辑，可以通过创建虚拟显示界面来模拟桌面环境，步骤如下：

1. 安装虚拟显示工具xvfb和相关依赖：

!apt-get install -y xvfb
!pip install pyautogui pyvirtualdisplay

2. 初始化虚拟显示并运行代码：

from pyvirtualdisplay import Display
import pyautogui

# 创建虚拟显示
display = Display(visible=0, size=(1920, 1080))
display.start()

# 执行pyautogui操作
pyautogui.moveTo(500, 500, duration=2)
print("鼠标移动操作已在虚拟界面中完成")

# 关闭虚拟显示
display.stop()

注意：这种方式仅能在云端虚拟界面中模拟操作，无法控制你本地Windows或Chromebook的鼠标指针。如果需要控制本地设备，建议直接在本地Jupyter或Python环境中运行代码。

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