首页
/ PyVirtualDisplay 技术文档

PyVirtualDisplay 技术文档

2024-12-25 10:05:45作者:宣聪麟

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 项目。

登录后查看全文

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
568
412
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
125
208
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
75
145
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
431
38
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
98
253
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
693
91
folibfolib
FOLib 是一个为Ai研发而生的、全语言制品库和供应链服务平台
Java
42
2
CS-BooksCS-Books
🔥🔥超过1000本的计算机经典书籍、个人笔记资料以及本人在各平台发表文章中所涉及的资源等。书籍资源包括C/C++、Java、Python、Go语言、数据结构与算法、操作系统、后端架构、计算机系统知识、数据库、计算机网络、设计模式、前端、汇编以及校招社招各种面经~
100
13
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
298
1.03 K