This page contains the full reference to pytest's API.
.. autofunction:: pytest.approx
Tutorial: :ref:`skipping`
.. autofunction:: pytest.fail
.. autofunction:: pytest.skip(msg, [allow_module_level=False])
.. autofunction:: pytest.importorskip
.. autofunction:: pytest.xfail
.. autofunction:: pytest.exit
.. autofunction:: pytest.main
.. autofunction:: pytest.param(*values, [id], [marks])
Tutorial: :ref:`assertraises`.
.. autofunction:: pytest.raises(expected_exception: Exception [, *, match])
:with: excinfo
Tutorial: :ref:`ensuring_function_triggers`.
.. autofunction:: pytest.deprecated_call()
:with:
Tutorial: :ref:`assertion-rewriting`.
.. autofunction:: pytest.register_assert_rewrite
Tutorial: :ref:`assertwarnings`
.. autofunction:: pytest.warns(expected_warning: Exception, [match])
:with:
Tutorial: :ref:`freezing-pytest`.
.. autofunction:: pytest.freeze_includes
Marks can be used apply meta data to test functions (but not fixtures), which can then be accessed by fixtures or plugins.
Tutorial: :ref:`filterwarnings`.
Add warning filters to marked test items.
.. py:function:: pytest.mark.filterwarnings(filter)
:keyword str filter:
A *warning specification string*, which is composed of contents of the tuple ``(action, message, category, module, lineno)``
as specified in `The Warnings filter <https://docs.python.org/3/library/warnings.html#warning-filter>`_ section of
the Python documentation, separated by ``":"``. Optional fields can be omitted.
Module names passed for filtering are not regex-escaped.
For example:
.. code-block:: python
@pytest.mark.filterwarnings("ignore:.*usage will be deprecated.*:DeprecationWarning")
def test_foo():
...
Tutorial: :doc:`parametrize`.
This mark has the same signature as :py:meth:`_pytest.python.Metafunc.parametrize`; see there.
Tutorial: :ref:`skip`.
Unconditionally skip a test function.
.. py:function:: pytest.mark.skip(*, reason=None)
:keyword str reason: Reason why the test function is being skipped.
Tutorial: :ref:`skipif`.
Skip a test function if a condition is True.
.. py:function:: pytest.mark.skipif(condition, *, reason=None)
:type condition: bool or str
:param condition: ``True/False`` if the condition should be skipped or a :ref:`condition string <string conditions>`.
:keyword str reason: Reason why the test function is being skipped.
Tutorial: :ref:`usefixtures`.
Mark a test function as using the given fixture names.
.. py:function:: pytest.mark.usefixtures(*names)
:param args: the names of the fixture to use, as strings
Note
When using usefixtures in hooks, it can only load fixtures when applied to a test function before test setup (for example in the pytest_collection_modifyitems hook).
Also not that his mark has no effect when applied to fixtures.
Tutorial: :ref:`xfail`.
Marks a test function as expected to fail.
.. py:function:: pytest.mark.xfail(condition=None, *, reason=None, raises=None, run=True, strict=False)
:type condition: bool or str
:param condition:
Condition for marking the test function as xfail (``True/False`` or a
:ref:`condition string <string conditions>`). If a bool, you also have
to specify ``reason`` (see :ref:`condition string <string conditions>`).
:keyword str reason: Reason why the test function is marked as xfail.
:keyword Exception raises: Exception subclass expected to be raised by the test function; other exceptions will fail the test.
:keyword bool run:
If the test function should actually be executed. If ``False``, the function will always xfail and will
not be executed (useful if a function is segfaulting).
:keyword bool strict:
* If ``False`` (the default) the function will be shown in the terminal output as ``xfailed`` if it fails
and as ``xpass`` if it passes. In both cases this will not cause the test suite to fail as a whole. This
is particularly useful to mark *flaky* tests (tests that fail at random) to be tackled later.
* If ``True``, the function will be shown in the terminal output as ``xfailed`` if it fails, but if it
unexpectedly passes then it will **fail** the test suite. This is particularly useful to mark functions
that are always failing and there should be a clear indication if they unexpectedly start to pass (for example
a new release of a library fixes a known bug).
Marks are created dynamically using the factory object pytest.mark and applied as a decorator.
For example:
@pytest.mark.timeout(10, "slow", method="thread")
def test_function():
...Will create and attach a :class:`Mark <_pytest.mark.structures.Mark>` object to the collected
:class:`Item <_pytest.nodes.Item>`, which can then be accessed by fixtures or hooks with
:meth:`Node.iter_markers <_pytest.nodes.Node.iter_markers>`. The mark object will have the following attributes:
mark.args == (10, "slow")
mark.kwargs == {"method": "thread"}Tutorial: :ref:`fixture`.
Fixtures are requested by test functions or other fixtures by declaring them as argument names.
Example of a test requiring a fixture:
def test_output(capsys):
print("hello")
out, err = capsys.readouterr()
assert out == "hello\n"Example of a fixture requiring another fixture:
@pytest.fixture
def db_session(tmpdir):
fn = tmpdir / "db.file"
return connect(str(fn))For more details, consult the full :ref:`fixtures docs <fixture>`.
.. autofunction:: pytest.fixture
:decorator:
.. fixture:: cache
Tutorial: :ref:`cache`.
The config.cache object allows other plugins and fixtures
to store and retrieve values across test runs. To access it from fixtures
request pytestconfig into your fixture and get it with pytestconfig.cache.
Under the hood, the cache plugin uses the simple
dumps/loads API of the :py:mod:`json` stdlib module.
.. currentmodule:: _pytest.cacheprovider
.. automethod:: Cache.get
.. automethod:: Cache.set
.. automethod:: Cache.makedir
.. fixture:: capsys
Tutorial: :doc:`capture`.
.. currentmodule:: _pytest.capture
.. autofunction:: capsys()
:no-auto-options:
Returns an instance of :py:class:`CaptureFixture`.
Example:
.. code-block:: python
def test_output(capsys):
print("hello")
captured = capsys.readouterr()
assert captured.out == "hello\n"
.. autoclass:: CaptureFixture()
:members:
.. fixture:: capsysbinary
Tutorial: :doc:`capture`.
.. autofunction:: capsysbinary()
:no-auto-options:
Returns an instance of :py:class:`CaptureFixture`.
Example:
.. code-block:: python
def test_output(capsysbinary):
print("hello")
captured = capsysbinary.readouterr()
assert captured.out == b"hello\n"
.. fixture:: capfd
Tutorial: :doc:`capture`.
.. autofunction:: capfd()
:no-auto-options:
Returns an instance of :py:class:`CaptureFixture`.
Example:
.. code-block:: python
def test_system_echo(capfd):
os.system('echo "hello"')
captured = capfd.readouterr()
assert captured.out == "hello\n"
.. fixture:: capfdbinary
Tutorial: :doc:`capture`.
.. autofunction:: capfdbinary()
:no-auto-options:
Returns an instance of :py:class:`CaptureFixture`.
Example:
.. code-block:: python
def test_system_echo(capfdbinary):
os.system('echo "hello"')
captured = capfdbinary.readouterr()
assert captured.out == b"hello\n"
.. fixture:: doctest_namespace
Tutorial: :doc:`doctest`.
.. autofunction:: _pytest.doctest.doctest_namespace()
Usually this fixture is used in conjunction with another ``autouse`` fixture:
.. code-block:: python
@pytest.fixture(autouse=True)
def add_np(doctest_namespace):
doctest_namespace["np"] = numpy
For more details: :ref:`doctest_namespace`.
.. fixture:: request
Tutorial: :ref:`request example`.
The request fixture is a special fixture providing information of the requesting test function.
.. autoclass:: _pytest.fixtures.FixtureRequest()
:members:
.. fixture:: pytestconfig
.. autofunction:: _pytest.fixtures.pytestconfig()
.. fixture:: record_property
Tutorial: :ref:`record_property example`.
.. autofunction:: _pytest.junitxml.record_property()
.. fixture:: record_testsuite_property
Tutorial: :ref:`record_testsuite_property example`.
.. autofunction:: _pytest.junitxml.record_testsuite_property()
.. fixture:: caplog
Tutorial: :doc:`logging`.
.. autofunction:: _pytest.logging.caplog()
:no-auto-options:
This returns a :class:`_pytest.logging.LogCaptureFixture` instance.
.. autoclass:: _pytest.logging.LogCaptureFixture
:members:
.. fixture:: monkeypatch
.. currentmodule:: _pytest.monkeypatch
Tutorial: :doc:`monkeypatch`.
.. autofunction:: _pytest.monkeypatch.monkeypatch()
:no-auto-options:
This returns a :class:`MonkeyPatch` instance.
.. autoclass:: _pytest.monkeypatch.MonkeyPatch
:members:
.. fixture:: testdir
.. currentmodule:: _pytest.pytester
This fixture provides a :class:`Testdir` instance useful for black-box testing of test files, making it ideal to test plugins.
To use it, include in your top-most conftest.py file:
pytest_plugins = "pytester".. autoclass:: Testdir()
:members:
.. autoclass:: RunResult()
:members:
.. autoclass:: LineMatcher()
:members:
.. fixture:: recwarn
Tutorial: :ref:`assertwarnings`
.. currentmodule:: _pytest.recwarn
.. autofunction:: recwarn()
:no-auto-options:
.. autoclass:: _pytest.recwarn.WarningsRecorder()
:members:
Each recorded warning is an instance of :class:`warnings.WarningMessage`.
Note
:class:`RecordedWarning` was changed from a plain class to a namedtuple in pytest 3.1
Note
DeprecationWarning and PendingDeprecationWarning are treated
differently; see :ref:`ensuring_function_triggers`.
.. fixture:: tmp_path
Tutorial: :doc:`tmpdir`
.. currentmodule:: _pytest.tmpdir
.. autofunction:: tmp_path()
:no-auto-options:
.. fixture:: tmp_path_factory
Tutorial: :ref:`tmp_path_factory example`
tmp_path_factory instances have the following methods:
.. currentmodule:: _pytest.tmpdir
.. automethod:: TempPathFactory.mktemp
.. automethod:: TempPathFactory.getbasetemp
.. fixture:: tmpdir
Tutorial: :doc:`tmpdir`
.. currentmodule:: _pytest.tmpdir
.. autofunction:: tmpdir()
:no-auto-options:
.. fixture:: tmpdir_factory
Tutorial: :ref:`tmpdir factory example`
tmpdir_factory instances have the following methods:
.. currentmodule:: _pytest.tmpdir
.. automethod:: TempdirFactory.mktemp
.. automethod:: TempdirFactory.getbasetemp
Tutorial: :doc:`writing_plugins`.
.. currentmodule:: _pytest.hookspec
Reference to all hooks which can be implemented by :ref:`conftest.py files <localplugin>` and :ref:`plugins <plugins>`.
Bootstrapping hooks called for plugins registered early enough (internal and setuptools plugins).
.. autofunction:: pytest_load_initial_conftests
.. autofunction:: pytest_cmdline_preparse
.. autofunction:: pytest_cmdline_parse
.. autofunction:: pytest_cmdline_main
Initialization hooks called for plugins and conftest.py files.
.. autofunction:: pytest_addoption
.. autofunction:: pytest_addhooks
.. autofunction:: pytest_configure
.. autofunction:: pytest_unconfigure
.. autofunction:: pytest_sessionstart
.. autofunction:: pytest_sessionfinish
.. autofunction:: pytest_plugin_registered
pytest calls the following hooks for collecting files and directories:
.. autofunction:: pytest_collection
.. autofunction:: pytest_ignore_collect
.. autofunction:: pytest_collect_directory
.. autofunction:: pytest_collect_file
.. autofunction:: pytest_pycollect_makemodule
For influencing the collection of objects in Python modules you can use the following hook:
.. autofunction:: pytest_pycollect_makeitem
.. autofunction:: pytest_generate_tests
.. autofunction:: pytest_make_parametrize_id
After collection is complete, you can modify the order of items, delete or otherwise amend the test items:
.. autofunction:: pytest_collection_modifyitems
.. autofunction:: pytest_collection_finish
All runtest related hooks receive a :py:class:`pytest.Item <_pytest.main.Item>` object.
.. autofunction:: pytest_runtestloop
.. autofunction:: pytest_runtest_protocol
.. autofunction:: pytest_runtest_logstart
.. autofunction:: pytest_runtest_logfinish
.. autofunction:: pytest_runtest_setup
.. autofunction:: pytest_runtest_call
.. autofunction:: pytest_runtest_teardown
.. autofunction:: pytest_runtest_makereport
For deeper understanding you may look at the default implementation of these hooks in :py:mod:`_pytest.runner` and maybe also in :py:mod:`_pytest.pdb` which interacts with :py:mod:`_pytest.capture` and its input/output capturing in order to immediately drop into interactive debugging when a test failure occurs.
.. autofunction:: pytest_pyfunc_call
Session related reporting hooks:
.. autofunction:: pytest_collectstart
.. autofunction:: pytest_make_collect_report
.. autofunction:: pytest_itemcollected
.. autofunction:: pytest_collectreport
.. autofunction:: pytest_deselected
.. autofunction:: pytest_report_header
.. autofunction:: pytest_report_collectionfinish
.. autofunction:: pytest_report_teststatus
.. autofunction:: pytest_terminal_summary
.. autofunction:: pytest_fixture_setup
.. autofunction:: pytest_fixture_post_finalizer
.. autofunction:: pytest_warning_captured
.. autofunction:: pytest_warning_recorded
Central hook for reporting about test execution:
.. autofunction:: pytest_runtest_logreport
Assertion related hooks:
.. autofunction:: pytest_assertrepr_compare
.. autofunction:: pytest_assertion_pass
There are few hooks which can be used for special reporting or interaction with exceptions:
.. autofunction:: pytest_internalerror
.. autofunction:: pytest_keyboard_interrupt
.. autofunction:: pytest_exception_interact
.. autofunction:: pytest_enter_pdb
Full reference to objects accessible from :ref:`fixtures <fixture>` or :ref:`hooks <hook-reference>`.
.. autoclass:: _pytest.runner.CallInfo()
:members:
.. autoclass:: _pytest.python.Class()
:members:
:show-inheritance:
.. autoclass:: _pytest.nodes.Collector()
:members:
:show-inheritance:
.. autoclass:: _pytest.reports.CollectReport()
:members:
:show-inheritance:
:inherited-members:
.. autoclass:: _pytest.config.Config()
:members:
.. autoclass:: _pytest._code.ExceptionInfo
:members:
.. autoclass:: _pytest.config.ExitCode
:members:
.. autoclass:: _pytest.nodes.File()
:members:
:show-inheritance:
.. autoclass:: _pytest.fixtures.FixtureDef()
:members:
:show-inheritance:
.. autoclass:: _pytest.nodes.FSCollector()
:members:
:show-inheritance:
.. autoclass:: _pytest.python.Function()
:members:
:show-inheritance:
.. autoclass:: _pytest.nodes.Item()
:members:
:show-inheritance:
.. autoclass:: _pytest.mark.MarkDecorator
:members:
.. autoclass:: _pytest.mark.MarkGenerator
:members:
.. autoclass:: _pytest.mark.structures.Mark
:members:
.. autoclass:: _pytest.python.Metafunc
:members:
.. autoclass:: _pytest.python.Module()
:members:
:show-inheritance:
.. autoclass:: _pytest.nodes.Node()
:members:
.. autoclass:: _pytest.config.argparsing.Parser()
:members:
.. autoclass:: pluggy.PluginManager()
:members:
.. autoclass:: _pytest.config.PytestPluginManager()
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: _pytest.main.Session()
:members:
:show-inheritance:
.. autoclass:: _pytest.reports.TestReport()
:members:
:show-inheritance:
:inherited-members:
Result used within :ref:`hook wrappers <hookwrapper>`.
.. autoclass:: pluggy.callers._Result
.. automethod:: pluggy.callers._Result.get_result
.. automethod:: pluggy.callers._Result.force_result
pytest treats some global variables in a special manner when defined in a test module or
conftest.py files.
.. globalvar:: collect_ignore
Tutorial: :ref:`customizing-test-collection`
Can be declared in conftest.py files to exclude test directories or modules.
Needs to be list[str].
collect_ignore = ["setup.py"].. globalvar:: collect_ignore_glob
Tutorial: :ref:`customizing-test-collection`
Can be declared in conftest.py files to exclude test directories or modules
with Unix shell-style wildcards. Needs to be list[str] where str can
contain glob patterns.
collect_ignore_glob = ["*_ignore.py"].. globalvar:: pytest_plugins
Tutorial: :ref:`available installable plugins`
Can be declared at the global level in test modules and conftest.py files to register additional plugins.
Can be either a str or Sequence[str].
pytest_plugins = "myapp.testsupport.myplugin"pytest_plugins = ("myapp.testsupport.tools", "myapp.testsupport.regression").. globalvar:: pytestmark
Tutorial: :ref:`scoped-marking`
Can be declared at the global level in test modules to apply one or more :ref:`marks <marks ref>` to all test functions and methods. Can be either a single mark or a list of marks (applied in left-to-right order).
import pytest
pytestmark = pytest.mark.webtestimport pytest
pytestmark = [pytest.mark.integration, pytest.mark.slow]Environment variables that can be used to change pytest's behavior.
.. envvar:: PYTEST_ADDOPTS
This contains a command-line (parsed by the py:mod:shlex module) that will be prepended to the command line given by the user, see :ref:`adding default options` for more information.
.. envvar:: PYTEST_CURRENT_TEST
This is not meant to be set by users, but is set by pytest internally with the name of the current test so other processes can inspect it, see :ref:`pytest current test env` for more information.
.. envvar:: PYTEST_DEBUG
When set, pytest will print tracing and debug information.
.. envvar:: PYTEST_DISABLE_PLUGIN_AUTOLOAD
When set, disables plugin auto-loading through setuptools entrypoints. Only explicitly specified plugins will be loaded.
.. envvar:: PYTEST_PLUGINS
Contains comma-separated list of modules that should be loaded as plugins:
export PYTEST_PLUGINS=mymodule.plugin,xdist.. envvar:: PY_COLORS
When set to 1, pytest will use color in terminal output.
When set to 0, pytest will not use color.
PY_COLORS takes precedence over NO_COLOR and FORCE_COLOR.
.. envvar:: NO_COLOR
When set (regardless of value), pytest will not use color in terminal output.
PY_COLORS takes precedence over NO_COLOR, which takes precedence over FORCE_COLOR.
See no-color.org for other libraries supporting this community standard.
.. envvar:: FORCE_COLOR
When set (regardless of value), pytest will use color in terminal output.
PY_COLORS and NO_COLOR take precedence over FORCE_COLOR.
.. autoclass:: _pytest.config.UsageError()
:show-inheritance:
Custom warnings generated in some situations such as improper usage or deprecated features.
.. autoclass:: pytest.PytestWarning :show-inheritance:
.. autoclass:: pytest.PytestAssertRewriteWarning :show-inheritance:
.. autoclass:: pytest.PytestCacheWarning :show-inheritance:
.. autoclass:: pytest.PytestCollectionWarning :show-inheritance:
.. autoclass:: pytest.PytestConfigWarning :show-inheritance:
.. autoclass:: pytest.PytestDeprecationWarning :show-inheritance:
.. autoclass:: pytest.PytestExperimentalApiWarning :show-inheritance:
.. autoclass:: pytest.PytestUnhandledCoroutineWarning :show-inheritance:
.. autoclass:: pytest.PytestUnknownMarkWarning :show-inheritance:
Consult the :ref:`internal-warnings` section in the documentation for more information.
Here is a list of builtin configuration options that may be written in a pytest.ini, pyproject.toml, tox.ini or setup.cfg
file, usually located at the root of your repository. To see each file format in details, see
:ref:`config file formats`.
Warning
Usage of setup.cfg is not recommended except for very simple use cases. .cfg
files use a different parser than pytest.ini and tox.ini which might cause hard to track
down problems.
When possible, it is recommended to use the latter files, or pyproject.toml, to hold your pytest configuration.
Configuration options may be overwritten in the command-line by using -o/--override-ini, which can also be
passed multiple times. The expected format is name=value. For example:
pytest -o console_output_style=classic -o cache_dir=/tmp/mycache
.. confval:: addopts
Add the specified ``OPTS`` to the set of command line arguments as if they
had been specified by the user. Example: if you have this ini file content:
.. code-block:: ini
# content of pytest.ini
[pytest]
addopts = --maxfail=2 -rf # exit after 2 failures, report fail info
issuing ``pytest test_hello.py`` actually means:
.. code-block:: bash
pytest --maxfail=2 -rf test_hello.py
Default is to add no options.
.. confval:: cache_dir Sets a directory where stores content of cache plugin. Default directory is ``.pytest_cache`` which is created in :ref:`rootdir <rootdir>`. Directory may be relative or absolute path. If setting relative path, then directory is created relative to :ref:`rootdir <rootdir>`. Additionally path may contain environment variables, that will be expanded. For more information about cache plugin please refer to :ref:`cache_provider`.
.. confval:: confcutdir Sets a directory where search upwards for ``conftest.py`` files stops. By default, pytest will stop searching for ``conftest.py`` files upwards from ``pytest.ini``/``tox.ini``/``setup.cfg`` of the project if any, or up to the file-system root.
.. confval:: console_output_style
Sets the console output style while running tests:
* ``classic``: classic pytest output.
* ``progress``: like classic pytest output, but with a progress indicator.
* ``count``: like progress, but shows progress as the number of tests completed instead of a percent.
The default is ``progress``, but you can fallback to ``classic`` if you prefer or
the new mode is causing unexpected problems:
.. code-block:: ini
# content of pytest.ini
[pytest]
console_output_style = classic
.. confval:: doctest_encoding Default encoding to use to decode text files with docstrings. :doc:`See how pytest handles doctests <doctest>`.
.. confval:: doctest_optionflags One or more doctest flag names from the standard ``doctest`` module. :doc:`See how pytest handles doctests <doctest>`.
.. confval:: empty_parameter_set_mark
Allows to pick the action for empty parametersets in parameterization
* ``skip`` skips tests with an empty parameterset (default)
* ``xfail`` marks tests with an empty parameterset as xfail(run=False)
* ``fail_at_collect`` raises an exception if parametrize collects an empty parameter set
.. code-block:: ini
# content of pytest.ini
[pytest]
empty_parameter_set_mark = xfail
.. note::
The default value of this option is planned to change to ``xfail`` in future releases
as this is considered less error prone, see `#3155 <https://github.com/pytest-dev/pytest/issues/3155>`_
for more details.
.. confval:: faulthandler_timeout
Dumps the tracebacks of all threads if a test takes longer than ``X`` seconds to run (including
fixture setup and teardown). Implemented using the `faulthandler.dump_traceback_later`_ function,
so all caveats there apply.
.. code-block:: ini
# content of pytest.ini
[pytest]
faulthandler_timeout=5
For more information please refer to :ref:`faulthandler`.
.. confval:: filterwarnings
Sets a list of filters and actions that should be taken for matched
warnings. By default all warnings emitted during the test session
will be displayed in a summary at the end of the test session.
.. code-block:: ini
# content of pytest.ini
[pytest]
filterwarnings =
error
ignore::DeprecationWarning
This tells pytest to ignore deprecation warnings and turn all other warnings
into errors. For more information please refer to :ref:`warnings`.
.. confval:: junit_duration_report
.. versionadded:: 4.1
Configures how durations are recorded into the JUnit XML report:
* ``total`` (the default): duration times reported include setup, call, and teardown times.
* ``call``: duration times reported include only call times, excluding setup and teardown.
.. code-block:: ini
[pytest]
junit_duration_report = call
.. confval:: junit_family
.. versionadded:: 4.2
Configures the format of the generated JUnit XML file. The possible options are:
* ``xunit1`` (or ``legacy``): produces old style output, compatible with the xunit 1.0 format. **This is the default**.
* ``xunit2``: produces `xunit 2.0 style output <https://github.com/jenkinsci/xunit-plugin/blob/xunit-2.3.2/src/main/resources/org/jenkinsci/plugins/xunit/types/model/xsd/junit-10.xsd>`__,
which should be more compatible with latest Jenkins versions.
.. code-block:: ini
[pytest]
junit_family = xunit2
.. confval:: junit_logging
.. versionadded:: 3.5
.. versionchanged:: 5.4
``log``, ``all``, ``out-err`` options added.
Configures if captured output should be written to the JUnit XML file. Valid values are:
* ``log``: write only ``logging`` captured output.
* ``system-out``: write captured ``stdout`` contents.
* ``system-err``: write captured ``stderr`` contents.
* ``out-err``: write both captured ``stdout`` and ``stderr`` contents.
* ``all``: write captured ``logging``, ``stdout`` and ``stderr`` contents.
* ``no`` (the default): no captured output is written.
.. code-block:: ini
[pytest]
junit_logging = system-out
.. confval:: junit_log_passing_tests
.. versionadded:: 4.6
If ``junit_logging != "no"``, configures if the captured output should be written
to the JUnit XML file for **passing** tests. Default is ``True``.
.. code-block:: ini
[pytest]
junit_log_passing_tests = False
.. confval:: junit_suite_name
To set the name of the root test suite xml item, you can configure the ``junit_suite_name`` option in your config file:
.. code-block:: ini
[pytest]
junit_suite_name = my_suite
.. confval:: log_auto_indent
Allow selective auto-indentation of multiline log messages.
Supports command line option ``--log-auto-indent [value]``
and config option ``log_auto_indent = [value]`` to set the
auto-indentation behavior for all logging.
``[value]`` can be:
* True or "On" - Dynamically auto-indent multiline log messages
* False or "Off" or 0 - Do not auto-indent multiline log messages (the default behavior)
* [positive integer] - auto-indent multiline log messages by [value] spaces
.. code-block:: ini
[pytest]
log_auto_indent = False
Supports passing kwarg ``extra={"auto_indent": [value]}`` to
calls to ``logging.log()`` to specify auto-indentation behavior for
a specific entry in the log. ``extra`` kwarg overrides the value specified
on the command line or in the config.
.. confval:: log_cli
Enable log display during test run (also known as :ref:`"live logging" <live_logs>`).
The default is ``False``.
.. code-block:: ini
[pytest]
log_cli = True
.. confval:: log_cli_date_format
Sets a :py:func:`time.strftime`-compatible string that will be used when formatting dates for live logging.
.. code-block:: ini
[pytest]
log_cli_date_format = %Y-%m-%d %H:%M:%S
For more information, see :ref:`live_logs`.
.. confval:: log_cli_format
Sets a :py:mod:`logging`-compatible string used to format live logging messages.
.. code-block:: ini
[pytest]
log_cli_format = %(asctime)s %(levelname)s %(message)s
For more information, see :ref:`live_logs`.
.. confval:: log_cli_level
Sets the minimum log message level that should be captured for live logging. The integer value or
the names of the levels can be used.
.. code-block:: ini
[pytest]
log_cli_level = INFO
For more information, see :ref:`live_logs`.
.. confval:: log_date_format
Sets a :py:func:`time.strftime`-compatible string that will be used when formatting dates for logging capture.
.. code-block:: ini
[pytest]
log_date_format = %Y-%m-%d %H:%M:%S
For more information, see :ref:`logging`.
.. confval:: log_file
Sets a file name relative to the ``pytest.ini`` file where log messages should be written to, in addition
to the other logging facilities that are active.
.. code-block:: ini
[pytest]
log_file = logs/pytest-logs.txt
For more information, see :ref:`logging`.
.. confval:: log_file_date_format
Sets a :py:func:`time.strftime`-compatible string that will be used when formatting dates for the logging file.
.. code-block:: ini
[pytest]
log_file_date_format = %Y-%m-%d %H:%M:%S
For more information, see :ref:`logging`.
.. confval:: log_file_format
Sets a :py:mod:`logging`-compatible string used to format logging messages redirected to the logging file.
.. code-block:: ini
[pytest]
log_file_format = %(asctime)s %(levelname)s %(message)s
For more information, see :ref:`logging`.
.. confval:: log_file_level
Sets the minimum log message level that should be captured for the logging file. The integer value or
the names of the levels can be used.
.. code-block:: ini
[pytest]
log_file_level = INFO
For more information, see :ref:`logging`.
.. confval:: log_format
Sets a :py:mod:`logging`-compatible string used to format captured logging messages.
.. code-block:: ini
[pytest]
log_format = %(asctime)s %(levelname)s %(message)s
For more information, see :ref:`logging`.
.. confval:: log_level
Sets the minimum log message level that should be captured for logging capture. The integer value or
the names of the levels can be used.
.. code-block:: ini
[pytest]
log_level = INFO
For more information, see :ref:`logging`.
.. confval:: markers
When the ``--strict-markers`` or ``--strict`` command-line arguments are used,
only known markers - defined in code by core pytest or some plugin - are allowed.
You can list additional markers in this setting to add them to the whitelist,
in which case you probably want to add ``--strict-markers`` to ``addopts``
to avoid future regressions:
.. code-block:: ini
[pytest]
addopts = --strict-markers
markers =
slow
serial
.. note::
The use of ``--strict-markers`` is highly preferred. ``--strict`` was kept for
backward compatibility only and may be confusing for others as it only applies to
markers and not to other options.
.. confval:: minversion
Specifies a minimal pytest version required for running tests.
.. code-block:: ini
# content of pytest.ini
[pytest]
minversion = 3.0 # will fail if we run with pytest-2.8
.. confval:: norecursedirs
Set the directory basename patterns to avoid when recursing
for test discovery. The individual (fnmatch-style) patterns are
applied to the basename of a directory to decide if to recurse into it.
Pattern matching characters::
* matches everything
? matches any single character
[seq] matches any character in seq
[!seq] matches any char not in seq
Default patterns are ``'.*', 'build', 'dist', 'CVS', '_darcs', '{arch}', '*.egg', 'venv'``.
Setting a ``norecursedirs`` replaces the default. Here is an example of
how to avoid certain directories:
.. code-block:: ini
[pytest]
norecursedirs = .svn _build tmp*
This would tell ``pytest`` to not look into typical subversion or
sphinx-build directories or into any ``tmp`` prefixed directory.
Additionally, ``pytest`` will attempt to intelligently identify and ignore a
virtualenv by the presence of an activation script. Any directory deemed to
be the root of a virtual environment will not be considered during test
collection unless ``‑‑collect‑in‑virtualenv`` is given. Note also that
``norecursedirs`` takes precedence over ``‑‑collect‑in‑virtualenv``; e.g. if
you intend to run tests in a virtualenv with a base directory that matches
``'.*'`` you *must* override ``norecursedirs`` in addition to using the
``‑‑collect‑in‑virtualenv`` flag.
.. confval:: python_classes
One or more name prefixes or glob-style patterns determining which classes
are considered for test collection. Search for multiple glob patterns by
adding a space between patterns. By default, pytest will consider any
class prefixed with ``Test`` as a test collection. Here is an example of how
to collect tests from classes that end in ``Suite``:
.. code-block:: ini
[pytest]
python_classes = *Suite
Note that ``unittest.TestCase`` derived classes are always collected
regardless of this option, as ``unittest``'s own collection framework is used
to collect those tests.
.. confval:: python_files
One or more Glob-style file patterns determining which python files
are considered as test modules. Search for multiple glob patterns by
adding a space between patterns:
.. code-block:: ini
[pytest]
python_files = test_*.py check_*.py example_*.py
Or one per line:
.. code-block:: ini
[pytest]
python_files =
test_*.py
check_*.py
example_*.py
By default, files matching ``test_*.py`` and ``*_test.py`` will be considered
test modules.
.. confval:: python_functions
One or more name prefixes or glob-patterns determining which test functions
and methods are considered tests. Search for multiple glob patterns by
adding a space between patterns. By default, pytest will consider any
function prefixed with ``test`` as a test. Here is an example of how
to collect test functions and methods that end in ``_test``:
.. code-block:: ini
[pytest]
python_functions = *_test
Note that this has no effect on methods that live on a ``unittest
.TestCase`` derived class, as ``unittest``'s own collection framework is used
to collect those tests.
See :ref:`change naming conventions` for more detailed examples.
.. confval:: required_plugins
A space separated list of plugins that must be present for pytest to run.
Plugins can be listed with or without version specifiers directly following
their name. Whitespace between different version specifiers is not allowed.
If any one of the plugins is not found, emit an error.
.. code-block:: ini
[pytest]
required_plugins = pytest-django>=3.0.0,<4.0.0 pytest-html pytest-xdist>=1.0.0
.. confval:: testpaths
Sets list of directories that should be searched for tests when
no specific directories, files or test ids are given in the command line when
executing pytest from the :ref:`rootdir <rootdir>` directory.
Useful when all project tests are in a known location to speed up
test collection and to avoid picking up undesired tests by accident.
.. code-block:: ini
[pytest]
testpaths = testing doc
This tells pytest to only look for tests in ``testing`` and ``doc``
directories when executing from the root directory.
.. confval:: usefixtures
List of fixtures that will be applied to all test functions; this is semantically the same to apply
the ``@pytest.mark.usefixtures`` marker to all test functions.
.. code-block:: ini
[pytest]
usefixtures =
clean_db
.. confval:: xfail_strict
If set to ``True``, tests marked with ``@pytest.mark.xfail`` that actually succeed will by default fail the
test suite.
For more information, see :ref:`xfail strict tutorial`.
.. code-block:: ini
[pytest]
xfail_strict = True