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)


Install xvfbwrapper from PyPI

pip install xvfbwrapper

System Requirements

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

  • Python 2

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

#!/usr/bin/env python

from selenium import webdriver
from xvfbwrapper import Xvfb

import unittest


class TestHomepages(unittest.TestCase):

    def setUp(self):
        self.vdisplay = Xvfb(width=1280, height=720)
        self.vdisplay.start()
        self.browser = webdriver.Firefox()

    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)

    def tearDown(self):
        self.browser.quit()
        self.vdisplay.stop()


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.1.0.tar.gz (2.6 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: xvfbwrapper-0.1.0.tar.gz
  • Upload date:
  • Size: 2.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for xvfbwrapper-0.1.0.tar.gz
Algorithm Hash digest
SHA256 26cc3db8f0abab6b16c683a8583f2a26aded60875eedb0101c52ebf0ccf4767d
MD5 5e9dee939f53563466088421327d3a85
BLAKE2b-256 0c698b7f31d96a1e870f98f50881e0e59f7056f47d33ae315aadd3ff091514cf

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