Pytest-API Reference

hogwarts · 2020 年11 月 30 日 08:47

This page contains the full reference to pytest's API.

::: {.contents depth=“3” local=“”}
:::

Functions

pytest.approx

::: {.autofunction}
pytest.approx
:::

pytest.fail

Tutorial: skipping{.interpreted-text role=“ref”}

::: {.autofunction}
pytest.fail
:::

pytest.skip

::: {.autofunction}
pytest.skip(msg, [allow_module_level=False])
:::

pytest.importorskip {#pytest.importorskip ref}

::: {.autofunction}
pytest.importorskip
:::

pytest.xfail

::: {.autofunction}
pytest.xfail
:::

pytest.exit

::: {.autofunction}
pytest.exit
:::

pytest.main

::: {.autofunction}
pytest.main
:::

pytest.param

::: {.autofunction}
pytest.param(*values, [id], [marks])
:::

pytest.raises

Tutorial: assertraises{.interpreted-text role=“ref”}.

::: {.autofunction with=“excinfo”}
pytest.raises(expected_exception: Exception [, *, match])
:::

pytest.deprecated_call

Tutorial: ensuring_function_triggers{.interpreted-text
role=“ref”}.

::: {.autofunction with=“”}
pytest.deprecated_call()
:::

pytest.register_assert_rewrite

Tutorial: assertion-rewriting{.interpreted-text role=“ref”}.

::: {.autofunction}
pytest.register_assert_rewrite
:::

pytest.warns

Tutorial: assertwarnings{.interpreted-text role=“ref”}

::: {.autofunction with=“”}
pytest.warns(expected_warning: Exception, [match])
:::

pytest.freeze_includes

Tutorial: freezing-pytest{.interpreted-text role=“ref”}.

::: {.autofunction}
pytest.freeze_includes
:::

Marks {#marks ref}

Marks can be used apply meta data to test functions (but not
fixtures), which can then be accessed by fixtures or plugins.

pytest.mark.filterwarnings {#pytest.mark.filterwarnings ref}

Tutorial: filterwarnings{.interpreted-text role=“ref”}.

Add warning filters to marked test items.

pytest.mark.parametrize {#pytest.mark.parametrize ref}

Tutorial: parametrize{.interpreted-text role=“doc”}.

This mark has the same signature as
:py_pytest.python.Metafunc.parametrize{.interpreted-text role=“meth”};
see there.

pytest.mark.skip {#pytest.mark.skip ref}

Tutorial: skip{.interpreted-text role=“ref”}.

Unconditionally skip a test function.

pytest.mark.skipif {#pytest.mark.skipif ref}

Tutorial: skipif{.interpreted-text role=“ref”}.

Skip a test function if a condition is True.

pytest.mark.usefixtures {#pytest.mark.usefixtures ref}

Tutorial: usefixtures{.interpreted-text role=“ref”}.

Mark a test function as using the given fixture names.

::: {.note}
::: {.title}
Note
:::

When using [usefixtures]{.title-ref} in hooks, it can only load fixtures
when applied to a test function before test setup (for example in the
[pytest_collection_modifyitems]{.title-ref} hook).

Also note that this mark has no effect when applied to fixtures.
:::

pytest.mark.xfail {#pytest.mark.xfail ref}

Tutorial: xfail{.interpreted-text role=“ref”}.

Marks a test function as expected to fail.

Custom marks

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
Mark <_pytest.mark.structures.Mark>{.interpreted-text role=“class”}
object to the collected Item <pytest.Item>{.interpreted-text
role=“class”}, which can then be accessed by fixtures or hooks with
Node.iter_markers <_pytest.nodes.Node.iter_markers>{.interpreted-text
role=“meth”}. The mark object will have the following attributes:

Fixtures {#fixtures-api}

Tutorial: fixture{.interpreted-text role=“ref”}.

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()

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
fixtures docs <fixture>{.interpreted-text role=“ref”}.

@pytest.fixture {#pytest.fixture-api}

::: {.autofunction decorator=“”}
pytest.fixture
:::

::: {.fixture}
cache
:::

config.cache

Tutorial: cache{.interpreted-text role=“ref”}.

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 :pyjson{.interpreted-text role=“mod”} stdlib module.

::: {.currentmodule}
_pytest.cacheprovider
:::

::: {.automethod}
Cache.get
:::

::: {.automethod}
Cache.set
:::

::: {.automethod}
Cache.makedir
:::

::: {.fixture}
capsys
:::

capsys

Tutorial: capture{.interpreted-text role=“doc”}.

::: {.currentmodule}
_pytest.capture
:::

::: {.autofunction no-auto-options=“”}
capsys()

Returns an instance of :pyCaptureFixture{.interpreted-text
role=“class”}.

Example:

def test_output(capsys):
    print("hello")
    captured = capsys.readouterr()

:::

::: {.autoclass members=“”}
CaptureFixture()
:::

::: {.fixture}
capsysbinary
:::

capsysbinary

Tutorial: capture{.interpreted-text role=“doc”}.

::: {.autofunction no-auto-options=“”}
capsysbinary()

Returns an instance of :pyCaptureFixture{.interpreted-text
role=“class”}.

Example:

def test_output(capsysbinary):
    print("hello")
    captured = capsysbinary.readouterr()

:::

::: {.fixture}
capfd
:::

capfd

Tutorial: capture{.interpreted-text role=“doc”}.

::: {.autofunction no-auto-options=“”}
capfd()

Returns an instance of :pyCaptureFixture{.interpreted-text
role=“class”}.

Example:

def test_system_echo(capfd):
    os.system('echo "hello"')
    captured = capfd.readouterr()

:::

::: {.fixture}
capfdbinary
:::

capfdbinary

Tutorial: capture{.interpreted-text role=“doc”}.

::: {.autofunction no-auto-options=“”}
capfdbinary()

Returns an instance of :pyCaptureFixture{.interpreted-text
role=“class”}.

Example:

def test_system_echo(capfdbinary):
    os.system('echo "hello"')
    captured = capfdbinary.readouterr()

:::

::: {.fixture}
doctest_namespace
:::

doctest_namespace

Tutorial: doctest{.interpreted-text role=“doc”}.

::: {.autofunction}
_pytest.doctest.doctest_namespace()

Usually this fixture is used in conjunction with another autouse
fixture:

@pytest.fixture(autouse=True)
def add_np(doctest_namespace):
    doctest_namespace["np"] = numpy

For more details: doctest_namespace{.interpreted-text role=“ref”}.
:::

::: {.fixture}
request
:::

request

Tutorial: request example{.interpreted-text role=“ref”}.

The request fixture is a special fixture providing information of the
requesting test function.

::: {.autoclass members=“”}
_pytest.fixtures.FixtureRequest()
:::

::: {.fixture}
pytestconfig
:::

pytestconfig

::: {.autofunction}
_pytest.fixtures.pytestconfig()
:::

::: {.fixture}
record_property
:::

record_property

Tutorial: record_property example{.interpreted-text role=“ref”}.

::: {.autofunction}
_pytest.junitxml.record_property()
:::

::: {.fixture}
record_testsuite_property
:::

record_testsuite_property

Tutorial: record_testsuite_property example{.interpreted-text
role=“ref”}.

::: {.autofunction}
_pytest.junitxml.record_testsuite_property()
:::

::: {.fixture}
caplog
:::

caplog

Tutorial: logging{.interpreted-text role=“doc”}.

::: {.autofunction no-auto-options=“”}
_pytest.logging.caplog()

Returns a _pytest.logging.LogCaptureFixture{.interpreted-text
role=“class”} instance.
:::

::: {.autoclass members=“”}
_pytest.logging.LogCaptureFixture
:::

::: {.fixture}
monkeypatch
:::

monkeypatch

Tutorial: monkeypatch{.interpreted-text role=“doc”}.

::: {.autofunction no-auto-options=“”}
_pytest.monkeypatch.monkeypatch()

Returns a ~pytest.MonkeyPatch{.interpreted-text role=“class”}
instance.
:::

::: {.autoclass members=“”}
pytest.MonkeyPatch
:::

::: {.fixture}
pytester
:::

pytester

::: {.versionadded}
6.2
:::

::: {.currentmodule}
_pytest.pytester
:::

Provides a Pytester{.interpreted-text role=“class”} instance that can
be used to run and test pytest itself.

It provides an empty directory where pytest can be executed in
isolation, and contains facilities to write tests, configuration files,
and match against expected output.

To use it, include in your topmost conftest.py file:

pytest_plugins = "pytester"

::: {.autoclass members=“”}
Pytester()
:::

::: {.autoclass members=“”}
RunResult()
:::

::: {.autoclass members=“” special-members=“str”}
LineMatcher()
:::

::: {.autoclass members=“”}
HookRecorder()
:::

::: {.fixture}
testdir
:::

testdir

Identical to pytester{.interpreted-text role=“fixture”}, but provides
an instance whose methods return legacy py.path.local objects instead
when applicable.

New code should avoid using testdir{.interpreted-text role=“fixture”}
in favor of pytester{.interpreted-text role=“fixture”}.

::: {.autoclass members=“”}
Testdir()
:::

::: {.fixture}
recwarn
:::

recwarn

Tutorial: assertwarnings{.interpreted-text role=“ref”}

::: {.currentmodule}
_pytest.recwarn
:::

::: {.autofunction no-auto-options=“”}
recwarn()
:::

::: {.autoclass members=“”}
WarningsRecorder()
:::

Each recorded warning is an instance of
warnings.WarningMessage{.interpreted-text role=“class”}.

::: {.note}
::: {.title}
Note
:::

DeprecationWarning and PendingDeprecationWarning are treated
differently; see ensuring_function_triggers{.interpreted-text
role=“ref”}.
:::

::: {.fixture}
tmp_path
:::

tmp_path

Tutorial: tmpdir{.interpreted-text role=“doc”}

::: {.currentmodule}
_pytest.tmpdir
:::

::: {.autofunction no-auto-options=“”}
tmp_path()
:::

::: {.fixture}
tmp_path_factory
:::

tmp_path_factory

Tutorial: tmp_path_factory example{.interpreted-text role=“ref”}

::: {#tmp_path_factory factory api}
tmp_path_factory instances have the following methods:
:::

::: {.currentmodule}
_pytest.tmpdir
:::

::: {.automethod}
TempPathFactory.mktemp
:::

::: {.automethod}
TempPathFactory.getbasetemp
:::

::: {.fixture}
tmpdir
:::

tmpdir

Tutorial: tmpdir{.interpreted-text role=“doc”}

::: {.currentmodule}
_pytest.tmpdir
:::

::: {.autofunction no-auto-options=“”}
tmpdir()
:::

::: {.fixture}
tmpdir_factory
:::

tmpdir_factory

Tutorial: tmpdir factory example{.interpreted-text role=“ref”}

::: {#tmpdir factory api}
tmpdir_factory instances have the following methods:
:::

::: {.currentmodule}
_pytest.tmpdir
:::

::: {.automethod}
TempdirFactory.mktemp
:::

::: {.automethod}
TempdirFactory.getbasetemp
:::

Hooks {#hook-reference}

Tutorial: writing_plugins{.interpreted-text role=“doc”}.

::: {.currentmodule}
_pytest.hookspec
:::

Reference to all hooks which can be implemented by
conftest.py files <localplugin>{.interpreted-text role=“ref”} and
plugins <plugins>{.interpreted-text role=“ref”}.

Bootstrapping hooks

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

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
:::

Collection hooks

pytest calls the following hooks for collecting files and directories:

::: {.autofunction}
pytest_collection
:::

::: {.autofunction}
pytest_ignore_collect
:::

::: {.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
:::

::: {.note}
::: {.title}
Note
:::

If this hook is implemented in conftest.py files, it always receives
all collected items, not only those under the conftest.py where it is
implemented.
:::

::: {.autofunction}
pytest_collection_finish
:::

Test running (runtest) hooks

All runtest related hooks receive a
:pypytest.Item <pytest.Item>{.interpreted-text role=“class”} 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 _pytest.runner and maybe also in _pytest.pdb which
interacts with _pytest.capture and its input/output capturing in order
to immediately drop into interactive debugging when a test failure
occurs.

::: {.autofunction}
pytest_pyfunc_call
:::

Reporting hooks

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
:::

Debugging/Interaction hooks

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
:::

Objects

Full reference to objects accessible from
fixtures <fixture>{.interpreted-text role=“ref”} or
hooks <hook-reference>{.interpreted-text role=“ref”}.

CallInfo

::: {.autoclass members=“”}
_pytest.runner.CallInfo()
:::

Class

::: {.autoclass members=“” show-inheritance=“”}
pytest.Class()
:::

Collector

::: {.autoclass members=“” show-inheritance=“”}
pytest.Collector()
:::

CollectReport

::: {.autoclass members=“” show-inheritance=“” inherited-members=“”}
_pytest.reports.CollectReport()
:::

Config

::: {.autoclass members=“”}
_pytest.config.Config()
:::

ExceptionInfo

::: {.autoclass members=“”}
_pytest._code.ExceptionInfo
:::

ExitCode

::: {.autoclass members=“”}
pytest.ExitCode
:::

File

::: {.autoclass members=“” show-inheritance=“”}
pytest.File()
:::

FixtureDef

::: {.autoclass members=“” show-inheritance=“”}
_pytest.fixtures.FixtureDef()
:::

FSCollector

::: {.autoclass members=“” show-inheritance=“”}
_pytest.nodes.FSCollector()
:::

Function

::: {.autoclass members=“” show-inheritance=“”}
pytest.Function()
:::

FunctionDefinition

::: {.autoclass members=“” show-inheritance=“”}
_pytest.python.FunctionDefinition()
:::

Item

::: {.autoclass members=“” show-inheritance=“”}
pytest.Item()
:::

MarkDecorator

::: {.autoclass members=“”}
_pytest.mark.MarkDecorator
:::

MarkGenerator

::: {.autoclass members=“”}
_pytest.mark.MarkGenerator
:::

Mark

::: {.autoclass members=“”}
_pytest.mark.structures.Mark
:::

Metafunc

::: {.autoclass members=“”}
_pytest.python.Metafunc
:::

Module

::: {.autoclass members=“” show-inheritance=“”}
pytest.Module()
:::

Node

::: {.autoclass members=“”}
_pytest.nodes.Node()
:::

Parser

::: {.autoclass members=“”}
_pytest.config.argparsing.Parser()
:::

PytestPluginManager

::: {.autoclass members=“” undoc-members=“” inherited-members=“” show-inheritance=“”}
_pytest.config.PytestPluginManager()
:::

Session

::: {.autoclass members=“” show-inheritance=“”}
pytest.Session()
:::

TestReport

::: {.autoclass members=“” show-inheritance=“” inherited-members=“”}
_pytest.reports.TestReport()
:::

_Result

Result used within hook wrappers <hookwrapper>{.interpreted-text
role=“ref”}.

::: {.autoclass}
pluggy.callers._Result
:::

::: {.automethod}
pluggy.callers._Result.get_result
:::

::: {.automethod}
pluggy.callers._Result.force_result
:::

Global Variables

pytest treats some global variables in a special manner when defined in
a test module or conftest.py files.

::: {.globalvar}
collect_ignore
:::

Tutorial: customizing-test-collection{.interpreted-text
role=“ref”}

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: customizing-test-collection{.interpreted-text
role=“ref”}

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: available installable plugins{.interpreted-text
role=“ref”}

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: scoped-marking{.interpreted-text role=“ref”}

Can be declared at the global level in test modules to apply one
or more marks <marks ref>{.interpreted-text role=“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.webtest

import pytest

pytestmark = [pytest.mark.integration, pytest.mark.slow]

Environment Variables

Environment variables that can be used to change pytest's behavior.

::: {.envvar}
PYTEST_ADDOPTS
:::

This contains a command-line (parsed by the pyshlex{.interpreted-text
role=“mod”} module) that will be prepended to the command line given
by the user, see adding default options{.interpreted-text role=“ref”}
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
pytest current test env{.interpreted-text role=“ref”} 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.

Exceptions

::: {.autoclass show-inheritance=“”}
pytest.UsageError()
:::

Warnings {#warnings ref}

Custom warnings generated in some situations such as improper usage or
deprecated features.

::: {.autoclass show-inheritance=“”}
pytest.PytestWarning
:::

::: {.autoclass show-inheritance=“”}
pytest.PytestAssertRewriteWarning
:::

::: {.autoclass show-inheritance=“”}
pytest.PytestCacheWarning
:::

::: {.autoclass show-inheritance=“”}
pytest.PytestCollectionWarning
:::

::: {.autoclass show-inheritance=“”}
pytest.PytestConfigWarning
:::

::: {.autoclass show-inheritance=“”}
pytest.PytestDeprecationWarning
:::

::: {.autoclass show-inheritance=“”}
pytest.PytestExperimentalApiWarning
:::

::: {.autoclass show-inheritance=“”}
pytest.PytestUnhandledCoroutineWarning
:::

::: {.autoclass show-inheritance=“”}
pytest.PytestUnknownMarkWarning
:::

Consult the internal-warnings{.interpreted-text role=“ref”} section in
the documentation for more information.

Configuration Options {#ini options ref}

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 config file formats{.interpreted-text role=“ref”}.

::: {.warning}
::: {.title}
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:

# content of pytest.ini
[pytest]
addopts = --maxfail=2 -rf  # exit after 2 failures, report fail info

issuing pytest test_hello.py actually means:

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
rootdir <rootdir>{.interpreted-text role=“ref”}. Directory may be
relative or absolute path. If setting relative path, then directory is
created relative to rootdir <rootdir>{.interpreted-text role=“ref”}.
Additionally path may contain environment variables, that will be
expanded. For more information about cache plugin please refer to
cache_provider{.interpreted-text role=“ref”}.
:::

::: {.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:

# content of pytest.ini
[pytest]
console_output_style = classic

:::

::: {.confval}
doctest_encoding

Default encoding to use to decode text files with docstrings.
See how pytest handles doctests <doctest>{.interpreted-text
role=“doc”}.
:::

::: {.confval}
doctest_optionflags

One or more doctest flag names from the standard doctest module.
See how pytest handles doctests <doctest>{.interpreted-text
role=“doc”}.
:::

::: {.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

# content of pytest.ini
[pytest]
empty_parameter_set_mark = xfail

::: {.note}
::: {.title}
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 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.

# content of pytest.ini
[pytest]
faulthandler_timeout=5

For more information please refer to faulthandler{.interpreted-text
role=“ref”}.
:::

::: {.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.

# 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
warnings{.interpreted-text role=“ref”}.
:::

::: {.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.

[pytest]
junit_duration_report = call

:::

::: {.confval}
junit_family

::: {.versionadded}
4.2
:::

::: {.versionchanged}
6.1 Default changed to xunit2.
:::

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.
xunit2: produces xunit 2.0 style
output,
which should be more compatible with latest Jenkins versions. This
is the default.

[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.

[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.

[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:

[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

[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
"live logging" <live_logs>{.interpreted-text role=“ref”}). The default
is False.

[pytest]
log_cli = True

:::

::: {.confval}
log_cli_date_format

Sets a :pytime.strftime{.interpreted-text role=“func”}-compatible
string that will be used when formatting dates for live logging.

[pytest]
log_cli_date_format = %Y-%m-%d %H:%M:%S

For more information, see live_logs{.interpreted-text role=“ref”}.
:::

::: {.confval}
log_cli_format

Sets a :pylogging{.interpreted-text role=“mod”}-compatible string used
to format live logging messages.

[pytest]
log_cli_format = %(asctime)s %(levelname)s %(message)s

For more information, see live_logs{.interpreted-text role=“ref”}.
:::

::: {.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.

[pytest]
log_cli_level = INFO

For more information, see live_logs{.interpreted-text role=“ref”}.
:::

::: {.confval}
log_date_format

Sets a :pytime.strftime{.interpreted-text role=“func”}-compatible
string that will be used when formatting dates for logging capture.

[pytest]
log_date_format = %Y-%m-%d %H:%M:%S