Skip to main content

pytest plugin for test session metadata

Project description

pytest-metadata is a plugin for pytest that provides access to test session metadata.

License PyPI Travis Issues Requirements


You will need the following in order to use pytest-metadata:

  • Python 3.7+ or PyPy3


To install pytest-metadata:

$ pip install pytest-metadata


We welcome contributions.

To learn more, see Development

Available metadata

The following metadata is gathered by this plugin:





Python version






pytest packages

{‘py’: ‘1.5.2’, ‘pytest’: ‘3.4.1’}


pytest plugins

{‘metadata’: ‘1.6.0’}

Additional metadata

You can provide your own metadata (key, value pair) by specifying --metadata on the commandline:

pytest --metadata foo bar

Note: You can provide multiple sets of --metadata:

pytest --metadata foo bar --metadata baz zoo

There’s also the possibility of passing in metadata as a JSON string:

pytest --metadata-from-json '{"cat_says": "bring the cat nip", "human_says": "yes kitty"}'

Alternatively a JSON can be read from a given file:

pytest --metadata-from-json-file path/to/valid/file.json

Continuous integration

When run in a continuous integration environment, additional metadata is added from environment variables. Below is a list of the supported continuous integration providers, along with links to the environment variables that are added to metadata if they’re present.

Note that if you’re using Tox to run your tests then you will need to pass down any additional environment variables for these to be picked up.

Viewing metadata

If you pass --verbose on the command line when running your tests, then the metadata will be displayed in the terminal report header:

pytest --verbose
============================ test session starts ============================
platform darwin -- Python 3.6.4, pytest-3.4.1, py-1.5.2, pluggy-0.6.0 -- /usr/bin/python
cachedir: .pytest_cache
metadata: {'Python': '3.6.4', 'Platform': 'Darwin-17.4.0-x86_64-i386-64bit', 'Packages': {'pytest': '3.4.1', 'py': '1.5.2', 'pluggy': '0.6.0'}, 'Plugins': {'metadata': '1.6.0'}}
plugins: metadata-1.6.0

Including metadata in Junit XML

Pytest-metadata provides the session scoped fixture include_metadata_in_junit_xml that you may use to include any metadata in Junit XML as property tags. For example the following test module

import pytest

pytestmark = pytest.mark.usefixtures('include_metadata_in_junit_xml')

def test():

when called with

pytest --metadata Daffy Duck --junit-xml=results.xml

would produce the following XML

<?xml version="1.0" encoding="utf-8"?>
  <testsuite name="pytest" errors="0" failures="0" skipped="0" tests="1" time="0.009" timestamp="2020-11-27T06:38:44.407674" hostname="sam">
      <property name="Daffy" value="Duck"/>

Accessing metadata

To add/modify/delete metadata at the end of metadata collection, you can use the pytest_metadata hook:

import pytest
def pytest_metadata(metadata):
    metadata.pop("password", None)

To access the metadata from a test or fixture, you can use the metadata fixture:

def test_metadata(metadata):
    assert 'metadata' in metadata['Plugins']

To access the metadata from a plugin, you can use the stash attribute of the config object. This can be used to read/add/modify the metadata:

def pytest_configure(config):
  metadata = config.pluginmanager.getplugin("metadata")
  if metadata:
      from pytest_metadata.plugin import metadata_key
      config.stash[metadata_key]['foo'] = 'bar'

Plugin integrations

Here’s a handy list of plugins that either read or contribute to the metadata:


Download files

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

Source Distribution

pytest_metadata-3.0.0.tar.gz (9.7 kB view hashes)

Uploaded source

Built Distribution

pytest_metadata-3.0.0-py3-none-any.whl (10.8 kB view hashes)

Uploaded py3

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