PyVirtualDisplay 技术文档

1. 安装指南

1.1 安装 PyVirtualDisplay

首先，使用 pip 安装 pyvirtualdisplay：

$ python3 -m pip install pyvirtualdisplay

1.2 可选依赖

• Pillow：用于 smartdisplay 子模块，安装命令如下：

  $ python3 -m pip install pillow
  

• EasyProcess：用于某些示例，安装命令如下：

  $ python3 -m pip install EasyProcess
  

• xmessage 和 gnumeric：用于某些示例，在 Ubuntu 22.04 上安装命令如下：

  $ sudo apt install x11-utils gnumeric
  

1.3 安装所有依赖和后端

在 Ubuntu 22.04 上，可以一次性安装所有依赖和后端：

$ sudo apt-get install xvfb xserver-xephyr tigervnc-standalone-server x11-utils gnumeric
$ python3 -m pip install pyvirtualdisplay pillow EasyProcess

2. 项目的使用说明

2.1 使用上下文管理器控制显示

使用上下文管理器可以方便地启动和停止虚拟显示：

from pyvirtualdisplay import Display

with Display() as disp:
    # 显示已激活
    print(disp.is_alive())  # True
# 显示已停止
print(disp.is_alive())  # False

2.2 使用 start() 和 stop() 方法控制显示

不推荐使用 start() 和 stop() 方法，但也可以实现类似功能：

from pyvirtualdisplay import Display

disp = Display()
disp.start()
# 显示已激活
disp.stop()
# 显示已停止

2.3 选择不同的后端

• Xvfb 后端：

  disp = Display()
  # 或者
  disp = Display(visible=False)
  # 或者
  disp = Display(backend="xvfb")
  

• Xephyr 后端：

  disp = Display(visible=True)
  # 或者
  disp = Display(backend="xephyr")
  

• Xvnc 后端：

  disp = Display(backend="xvnc")
  

2.4 设置显示尺寸和颜色深度

• 设置显示尺寸：

  disp = Display(size=(100, 60))
  

• 设置颜色深度：

  disp = Display(color_depth=24)
  

3. 项目API使用文档

3.1 Display 类

Display 类是 pyvirtualdisplay 的核心类，用于创建和管理虚拟显示。

3.1.1 构造函数

Display(visible=False, size=(1024, 768), color_depth=24, backend="xvfb", rfbport=5900, extra_args=None, use_xauth=False, manage_global_env=True)

• visible：是否可见，默认为 False。
• size：显示尺寸，默认为 (1024, 768)。
• color_depth：颜色深度，默认为 24。
• backend：后端类型，默认为 "xvfb"。
• rfbport：VNC 端口，默认为 5900。
• extra_args：传递给后端的额外参数。
• use_xauth：是否使用 Xauthority 文件，默认为 False。
• manage_global_env：是否管理全局环境变量，默认为 True。

3.1.2 方法

• start()：启动虚拟显示。
• stop()：停止虚拟显示。
• is_alive()：检查虚拟显示是否处于活动状态。

3.2 SmartDisplay 类

SmartDisplay 类继承自 Display，提供了额外的截图功能。

3.2.1 方法

• waitgrab()：等待并抓取虚拟显示的截图。

4. 项目安装方式

4.1 使用 pip 安装

$ python3 -m pip install pyvirtualdisplay

4.2 安装可选依赖

• Pillow：

  $ python3 -m pip install pillow
  

• EasyProcess：

  $ python3 -m pip install EasyProcess
  

4.3 安装所有依赖和后端

在 Ubuntu 22.04 上，可以一次性安装所有依赖和后端：

$ sudo apt-get install xvfb xserver-xephyr tigervnc-standalone-server x11-utils gnumeric
$ python3 -m pip install pyvirtualdisplay pillow EasyProcess

通过以上步骤，您可以顺利安装并使用 pyvirtualdisplay 项目。