Skip to main content

Python wrapper for running a display inside X virtual framebuffer (Xvfb)

Corey Goldberg - 2012, 2013


Install xvfbwrapper from PyPI

pip install xvfbwrapper

System Requirements

  • Xvfb (sudo apt-get install xvfb, or similar)

  • Python 2.7 or 3.2+ (tested on py27, py32, py33, pypy)

About Xvfb (X Virtual Framebuffer)

In the X Window System, Xvfb or X virtual framebuffer is an X11 server that performs all graphical operations in memory, not showing any screen output. This virtual server does not require the computer it is running on to even have a screen or any input device. Only a network layer is necessary.

Example: Basic Usage

from xvfbwrapper import Xvfb

vdisplay = Xvfb()
vdisplay.start()

# launch stuff inside virtual display here

vdisplay.stop()

Example: Headless Selenium WebDriver Tests

from selenium import webdriver
from xvfbwrapper import Xvfb

import unittest


class TestPages(unittest.TestCase):

    def setUp(self):
        self.xvfb = Xvfb(width=1280, height=720)
        self.addCleanup(self.xvfb.stop)
        self.xvfb.start()
        self.browser = webdriver.Firefox()
        self.addCleanup(self.browser.quit)

    def testUbuntuHomepage(self):
        self.browser.get('http://www.ubuntu.com')
        self.assertIn('Ubuntu', self.browser.title)

    def testGoogleHomepage(self):
        self.browser.get('http://www.google.com')
        self.assertIn('Google', self.browser.title)


if __name__ == '__main__':
    unittest.main(verbosity=2)

This code uses selenium and xvfbwrapper to run a test with Firefox inside a headless display.

  • install selenium bindings: pip install selenium

  • Firefox will launch inside virtual display (headless)

  • browser is not shown while tests are run

Metadata

Release files for xvfbwrapper 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for xvfbwrapper 0.2.1
File Size Uploaded
xvfbwrapper-0.2.1.tar.gz 3.2 kB Details

Release files / xvfbwrapper-0.2.1.tar.gz

Download URL xvfbwrapper-0.2.1.tar.gz
Size 3.2 kB
Tags Source
SHA-256 checksum
How to use checksums
ef99a07ac88966c4b3c973150cf58f6689e3f473e3ff6a074064db93d0796036
BLAKE2b-256 checksum
How to use checksums
6a318c980fb875c22877a7acca738edf6034c23922617cfa01e93bb5f580f62c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

0.2.34

2 release files

0.2.33

2 release files

0.2.32

2 release files

0.2.31

2 release files

0.2.30

2 release files

0.2.29

2 release files

0.2.28

2 release files

0.2.25

2 release files

0.2.24

2 release files

0.2.23

2 release files

0.2.21

2 release files

0.2.20

2 release files

0.2.19

2 release files

0.2.15

2 release files

0.2.14

2 release files

0.2.12

2 release files

0.2.11

2 release files

0.2.10

2 release files

0.2.9

1 release file

0.2.8

1 release file

0.2.7

1 release file

0.2.6

1 release file

0.2.5

1 release file

0.2.4

1 release file

0.2.3

1 release file

0.2.2

1 release file

This release

0.2.1 This release

1 release file

0.2.0

1 release file

0.1.3

1 release file

0.1.2

1 release file

0.1.1

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page