Skip to main content

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

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xvfbwrapper-0.2.0.tar.gz (3.0 kB view details)

Uploaded Source

File details

Details for the file xvfbwrapper-0.2.0.tar.gz.

File metadata

File hashes

Hashes for xvfbwrapper-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9bdeaa9bec0a8e40e2c1e21e52fb5c39868d44d188fec5bf3512945c7917fb07
MD5 8b94886c7a99514cb8318479f62d8298
BLAKE2b-256 907130b724dcc9a194211dd59e3f6228815bbacbe80e695570ebe72ea116bf0a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page