Python library to integrate axe and selenium for web accessibility testing.
axe-selenium-python integrates aXe and selenium to enable automated web accessibility testing.
You will need the following prerequisites in order to use axe-selenium-python:
- Python 2.7 or 3.6
- pytest-selenium >= 3.0.0
- geckodriver downloaded and added to your PATH
To install axe-selenium-python:
$ pip install axe-selenium-python
To install pytest-axe:
$ pip install pytest-axe
import pytest from axe_selenium_python.test_accessibility import rules, report @pytest.mark.nondestructive def test_header_run_axe(selenium, axe, pytestconfig): pytestconfig.violations = axe.run('header', None, 'critical') assert pytestconfig.violations is not None @pytest.mark.nondestructive @pytest.mark.parametrize('rule', rules) def test_header_accessibility(rule, pytestconfig): violations = pytestconfig.violations assert rule not in violations, report(violations[rule])
The above example is currently the recommended approach. The first test runs axe against the selenium instance, with the context set to <header> and stores the results in pytestconfig.
The second test uses pytest parametrize to generate tests for each rule in the provided list rules.
The method axe.run() accepts three parameters: context, options, and impact. For more information on context and options, view the aXe documentation here.
The third parameter, impact, allows you to filter violations by their impact level. The options are critical, severe, moderate, and minor, with the default value set to None.
This will filter violations for the impact level specified, and all violations with a higher impact level.
Command Line Argument
$ pytest --base-url http://www.mozilla.com --driver Firefox test_accessibility.py
- Added run method to Axe class to simplify the usage in existing test suites
- run method includes the ability to set what impact level to test for: ‘minor’, ‘moderate’, ‘severe’, ‘critical’
- Added pytest-axe usage example to README
- Added usage example to README
- Added selenium instance as a class attribute
- Changed file paths to OS independent structure
- Fixed file read operations to use with keyword
- Fixed include of aXe API file and references to it
- Updated README
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash SHA256 hash help||File type||Python version||Upload date|
|axe_selenium_python-0.0.43-py2.py3-none-any.whl (68.4 kB) Copy SHA256 hash SHA256||Wheel||py2.py3|
|axe-selenium-python-0.0.43.tar.gz (64.3 kB) Copy SHA256 hash SHA256||Source||None|