如何在GitHub Codespaces中设置DISPLAY变量运行Python GUI程序

错误原因 #

GitHub Codespaces默认是无图形界面的服务器环境，Tkinter依赖X11显示服务器渲染GUI，但当前环境既没有设置$DISPLAY环境变量，也没有可用的显示设备，因此抛出_tkinter.TclError: no display name and no $DISPLAY environment variable错误。

你遇到的错误日志如下：

Traceback (most recent call last):
  File "/workspaces/CODSOFT/calculator.py", line 24, in <module>
    window = tk.Tk()
  File "/home/codespace/.python/current/lib/python3.10/tkinter/__init__.py", line 2299, in __init__
    self.tk = _tkinter.create(screenName, baseName, className, interactive, wantobjects, useTk, sync, use)
_tkinter.TclError: no display name and no $DISPLAY environment variable

解决方法 #

方法1：本地X服务器转发（实现在本地显示GUI） #

• 本地安装X服务器：
  • Windows：安装VcXsrv
  • macOS：安装XQuartz
  • Linux：系统自带X11，无需额外安装
• 启动本地X服务器，开启允许网络连接的选项：
  • VcXsrv启动时勾选"Disable access control"
  • XQuartz在「偏好设置→安全性」中勾选"允许网络客户端"
• 在Codespaces终端中设置DISPLAY变量：

  export DISPLAY=$(echo $SSH_CLIENT | awk '{print $1}'):0.0
  

• 重新运行你的Tkinter程序即可在本地看到GUI界面。

方法2：虚拟显示（无需本地X服务器，仅验证程序逻辑） #

如果不需要实际显示GUI，只是验证程序逻辑，可以用xvfb创建虚拟显示：

• 在Codespaces中安装xvfb：

  sudo apt update && sudo apt install -y xvfb
  

• 通过xvfb运行程序：

  xvfb-run python3 /workspaces/CODSOFT/calculator.py
  

• 程序会在虚拟显示中运行，控制台可以输出日志，用于逻辑验证。

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