run headless display inside X virtual framebuffer (Xvfb)
Project description
Python wrapper for running a display inside X virtual framebuffer (Xvfb).
Info:
Dev Home (GitHub): https://github.com/cgoldberg/xvfbwrapper
Releases (PyPI): https://pypi-hypernode.com/pypi/xvfbwrapper
Author: Corey Goldberg - 2012, 2013, 2015, 2016
License: MIT
About Xvfb:
You may want to run a program that uses a graphical display, requiring X11 and a physical display attached. However, With Xvfb you can run headless inside a virtual dislpay. 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.
Xvfb is often used for running browser-based acceptance tests on a headless server.
About xvfbwrapper:
xvfbwrapper is a small python wrapper for controlling Xvfb. It works nicely when Integrating wiith python test suites or other Python code.
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, py34, 3.5, pypy)
Examples
Basic Usage:
from xvfbwrapper import Xvfb vdisplay = Xvfb() vdisplay.start() # launch stuff inside # virtual display here. vdisplay.stop()
Basic Usage, specifying display geometry and color depth:
from xvfbwrapper import Xvfb vdisplay = Xvfb(width=1280, height=740, colordepth=16) vdisplay.start() # launch stuff inside # virtual display here. vdisplay.stop()
Usage as a Context Manager:
from xvfbwrapper import Xvfb with Xvfb() as xvfb: # launch stuff inside virtual display here. # It starts/stops around this code block.
Testing Example: Headless Selenium WebDriver Tests:
import unittest from selenium import webdriver from xvfbwrapper import Xvfb 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 above code uses selenium and xvfbwrapper to run a test with Firefox inside a headless display.
It will:
install selenium bindings: pip install selenium
Firefox will launch inside virtual display (headless)
browser is not shown while tests are run
Look Ma’, no browser!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file xvfbwrapper-0.2.8.tar.gz
.
File metadata
- Download URL: xvfbwrapper-0.2.8.tar.gz
- Upload date:
- Size: 4.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f99d741f145ca1d4c42d3085bc2857e54571db80099b6eb49ac2efcf4e971666 |
|
MD5 | c8ce7c35fc555a6af272e7e17cf0b5c0 |
|
BLAKE2b-256 | f0068462744fbdb980cd6ffaee23d98ef6edc15a13428a85ac7ba10dd6b5989d |