Sign inDemoInstall


Package Overview
File Explorer

Install Socket

Detect and block malicious and high-risk dependencies



unittest-based test runner with Ant/JUnit like XML reporting.



License Latest Version Development Status Documentation Status Coverage Status Coveralls Coverage Status Requirements Status

unittest-xml-reporting (aka xmlrunner)

A unittest test runner that can save test results to XML files in xUnit format. The files can be consumed by a wide range of tools, such as build systems, IDEs and continuous integration servers.


  • Python 3.7+
  • Please note Python 3.6 end-of-life was in Dec 2021, last version supporting 3.6 was 3.1.0
  • Please note Python 3.5 end-of-life was in Sep 2020, last version supporting 3.5 was 3.1.0
  • Please note Python 2.7 end-of-life was in Jan 2020, last version supporting 2.7 was 2.5.2
  • Please note Python 3.4 end-of-life was in Mar 2019, last version supporting 3.4 was 2.5.2
  • Please note Python 2.6 end-of-life was in Oct 2013, last version supporting 2.6 was 1.14.0

Limited support for unittest.TestCase.subTest

unittest has the concept of sub-tests for a unittest.TestCase; this doesn't map well to an existing xUnit concept, so you won't find it in the schema. What that means, is that you lose some granularity in the reports for sub-tests.

unittest also does not report successful sub-tests, so the accounting won't be exact.

Jenkins plugins

Jenkins JUnit plugin

This plugin does not perform XSD validation (at time of writing) and should parse the XML file without issues.

Jenkins xUnit plugin version 1.100

This plugin does perfom XSD validation and uses the more lax XSD. This should parse the XML file without issues.

Jenkins xUnit plugin version 1.104+

This plugin does perfom XSD validation and uses the more strict XSD.


import io
import unittest
import xmlrunner

# run the tests storing results in memory
out = io.BytesIO()
    failfast=False, buffer=False, catchbreak=False, exit=False)

Transform the results removing extra attributes.

from xmlrunner.extra.xunit_plugin import transform

with open('TEST-report.xml', 'wb') as report:

JUnit Schema ?

There are many tools claiming to write JUnit reports, so you will find many schemas with minor differences.

We used the XSD that was available in the Jenkins xUnit plugin version 1.100; a copy is available under tests/vendor/jenkins/xunit-plugin/.../junit-10.xsd (see attached license).

You may also find these resources useful:


The easiest way to install unittest-xml-reporting is via Pip:

$ pip install unittest-xml-reporting

If you use Git and want to get the latest development version:

$ git clone
$ cd unittest-xml-reporting
$ sudo python install

Or get the latest development version as a tarball:

$ wget
$ unzip
$ cd unittest-xml-reporting
$ sudo python install

Or you can manually download the latest released version from PyPI.


python -m xmlrunner [options]
python -m xmlrunner discover [options]

# help
python -m xmlrunner -h


python -m xmlrunner discover -t ~/mycode/tests -o /tmp/build/junit-reports


The script below, adapted from the unittest, shows how to use XMLTestRunner in a very simple way. In fact, the only difference between this script and the original one is the last line:

import random
import unittest
import xmlrunner

class TestSequenceFunctions(unittest.TestCase):

    def setUp(self):
        self.seq = list(range(10))

    @unittest.skip("demonstrating skipping")
    def test_skipped(self):"shouldn't happen")

    def test_shuffle(self):
        # make sure the shuffled sequence does not lose any elements
        self.assertEqual(self.seq, list(range(10)))

        # should raise an exception for an immutable sequence
        self.assertRaises(TypeError, random.shuffle, (1,2,3))

    def test_choice(self):
        element = random.choice(self.seq)
        self.assertTrue(element in self.seq)

    def test_sample(self):
        with self.assertRaises(ValueError):
            random.sample(self.seq, 20)
        for element in random.sample(self.seq, 5):
            self.assertTrue(element in self.seq)

if __name__ == '__main__':
        # these make sure that some options that are not applicable
        # remain hidden from the help menu.
        failfast=False, buffer=False, catchbreak=False)

Reporting to a single file

if __name__ == '__main__':
    with open('/path/to/results.xml', 'wb') as output:
            failfast=False, buffer=False, catchbreak=False)

Doctest support

The XMLTestRunner can also be used to report on docstrings style tests.

import doctest
import xmlrunner

def twice(n):
    >>> twice(5)
    return 2 * n

class Multiplicator(object):
    def threetimes(self, n):
        >>> Multiplicator().threetimes(5)
        return 3 * n

if __name__ == "__main__":
    suite = doctest.DocTestSuite()

Django support

In order to plug XMLTestRunner to a Django project, add the following to your

TEST_RUNNER = 'xmlrunner.extra.djangotestrunner.XMLTestRunner'

Also, the following settings are provided so you can fine tune the reports:

TEST_OUTPUT_VERBOSE10|1|2Besides the XML reports generated by the test runner, a bunch of useful information is printed to the sys.stderr stream, just like the TextTestRunner does. Use this setting to choose between a verbose and a non-verbose output.
TEST_OUTPUT_DESCRIPTIONSFalseTrue|FalseIf your test methods contains docstrings, you can display such docstrings instead of display the test name (ex: module.TestCase.test_method).
In order to use this feature, you have to enable verbose output by setting TEST_OUTPUT_VERBOSE = 2.
Only effects stdout and not XML output.
TEST_OUTPUT_DIR"."<str>Tells the test runner where to put the XML reports. If the directory couldn't be found, the test runner will try to create it before generate the XML files.
TEST_OUTPUT_FILE_NAMENone<str>Tells the test runner to output a single XML report with this filename under os.path.join(TEST_OUTPUT_DIR, TEST_OUTPUT_FILE_NAME).
Please note that for long running tests, this will keep the results in memory for a longer time than multiple reports, and may use up more resources.


We are always looking for good contributions, so please just fork the repository and send pull requests (with tests!).

If you would like write access to the repository, or become a maintainer, feel free to get in touch.

Testing changes with tox

Please use tox to test your changes before sending a pull request. You can find more information about tox at

$ pip install tox

# basic sanity test, friendly output
$ tox -e pytest

# all combinations
$ tox



Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.


Related posts

SocketSocket SOC 2 Logo


  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc