From c21ef7ba22c87c709c89cbb7cefa25a5133bdeef Mon Sep 17 00:00:00 2001 From: Ronny Pfannschmidt Date: Mon, 4 Oct 2021 08:56:26 +0200 Subject: [PATCH] fix #8818 - run regendoc without tox cachedir #4270 introduced per tox env pytest cachedirs and never protected regendoc against it --- changelog/8818.trivial.rst | 1 + doc/en/Makefile | 6 +- doc/en/builtin.rst | 50 +++++----- doc/en/example/markers.rst | 60 ++++++------ doc/en/example/nonpython.rst | 12 +-- doc/en/example/parametrize.rst | 40 ++++---- doc/en/example/pythoncollection.rst | 12 +-- doc/en/example/reportingdemo.rst | 116 ++++++++++++------------ doc/en/example/simple.rst | 63 ++++++------- doc/en/getting-started.rst | 18 ++-- doc/en/how-to/assert.rst | 10 +- doc/en/how-to/cache.rst | 82 +++-------------- doc/en/how-to/capture-stdout-stderr.rst | 6 +- doc/en/how-to/capture-warnings.rst | 8 +- doc/en/how-to/doctest.rst | 8 +- doc/en/how-to/fixtures.rst | 40 ++++---- doc/en/how-to/output.rst | 55 ++++++----- doc/en/how-to/parametrize.rst | 14 +-- doc/en/how-to/tmp_path.rst | 4 +- doc/en/how-to/unittest.rst | 8 +- doc/en/how-to/usage.rst | 22 +---- doc/en/how-to/writing_plugins.rst | 4 +- doc/en/index.rst | 4 +- doc/en/reference/reference.rst | 17 ++-- tox.ini | 7 +- 25 files changed, 298 insertions(+), 369 deletions(-) create mode 100644 changelog/8818.trivial.rst diff --git a/changelog/8818.trivial.rst b/changelog/8818.trivial.rst new file mode 100644 index 00000000000..e8c7a24c61b --- /dev/null +++ b/changelog/8818.trivial.rst @@ -0,0 +1 @@ +Ensure ``regendoc`` opts out of ``TOX_ENV`` cachedir selection to ensure independent example test runs. diff --git a/doc/en/Makefile b/doc/en/Makefile index 1cffbd463d8..f2db6891211 100644 --- a/doc/en/Makefile +++ b/doc/en/Makefile @@ -34,6 +34,10 @@ REGENDOC_ARGS := \ regen: REGENDOC_FILES:=*.rst */*.rst regen: - PYTHONDONTWRITEBYTECODE=1 PYTEST_ADDOPTS="-pno:hypothesis -Wignore::pytest.PytestUnknownMarkWarning" COLUMNS=76 regendoc --update ${REGENDOC_FILES} ${REGENDOC_ARGS} +# need to reset cachedir to the non-tox default + PYTHONDONTWRITEBYTECODE=1 \ + PYTEST_ADDOPTS="-pno:hypothesis -p no:hypothesispytest -Wignore::pytest.PytestUnknownMarkWarning -o cache_dir=.pytest_cache" \ + COLUMNS=76 \ + regendoc --update ${REGENDOC_FILES} ${REGENDOC_ARGS} .PHONY: regen diff --git a/doc/en/builtin.rst b/doc/en/builtin.rst index 28c6cd5c6ef..e22a874b4d5 100644 --- a/doc/en/builtin.rst +++ b/doc/en/builtin.rst @@ -16,8 +16,13 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a .. code-block:: pytest - $ pytest -q --fixtures - cache + $ pytest --fixtures -v + =========================== test session starts ============================ + platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python + cachedir: .pytest_cache + rootdir: /home/sweet/project + collected 0 items + cache -- ../../../..$PYTHON_SITE/_pytest/cacheprovider.py:520 Return a cache object that can persist state between testing sessions. cache.get(key, default) @@ -28,40 +33,41 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a Values can be any object handled by the json stdlib module. - capsys + capsys -- ../../../..$PYTHON_SITE/_pytest/capture.py:903 Enable text capturing of writes to ``sys.stdout`` and ``sys.stderr``. The captured output is made available via ``capsys.readouterr()`` method calls, which return a ``(out, err)`` namedtuple. ``out`` and ``err`` will be ``text`` objects. - capsysbinary + capsysbinary -- ../../../..$PYTHON_SITE/_pytest/capture.py:920 Enable bytes capturing of writes to ``sys.stdout`` and ``sys.stderr``. The captured output is made available via ``capsysbinary.readouterr()`` method calls, which return a ``(out, err)`` namedtuple. ``out`` and ``err`` will be ``bytes`` objects. - capfd + capfd -- ../../../..$PYTHON_SITE/_pytest/capture.py:937 Enable text capturing of writes to file descriptors ``1`` and ``2``. The captured output is made available via ``capfd.readouterr()`` method calls, which return a ``(out, err)`` namedtuple. ``out`` and ``err`` will be ``text`` objects. - capfdbinary + capfdbinary -- ../../../..$PYTHON_SITE/_pytest/capture.py:954 Enable bytes capturing of writes to file descriptors ``1`` and ``2``. The captured output is made available via ``capfd.readouterr()`` method calls, which return a ``(out, err)`` namedtuple. ``out`` and ``err`` will be ``byte`` objects. - doctest_namespace [session scope] + doctest_namespace [session scope] -- ../../../..$PYTHON_SITE/_pytest/doctest.py:728 Fixture that returns a :py:class:`dict` that will be injected into the namespace of doctests. - pytestconfig [session scope] - Session-scoped fixture that returns the :class:`pytest.Config` object. + pytestconfig [session scope] -- ../../../..$PYTHON_SITE/_pytest/fixtures.py:1372 + Session-scoped fixture that returns the session's :class:`pytest.Config` + object. Example:: @@ -69,7 +75,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a if pytestconfig.getoption("verbose") > 0: ... - record_property + record_property -- ../../../..$PYTHON_SITE/_pytest/junitxml.py:282 Add extra properties to the calling test. User properties become part of the test report and are available to the @@ -83,13 +89,13 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a def test_function(record_property): record_property("example_key", 1) - record_xml_attribute + record_xml_attribute -- ../../../..$PYTHON_SITE/_pytest/junitxml.py:305 Add extra xml attributes to the tag for the calling test. The fixture is callable with ``name, value``. The value is automatically XML-encoded. - record_testsuite_property [session scope] + record_testsuite_property [session scope] -- ../../../..$PYTHON_SITE/_pytest/junitxml.py:343 Record a new ```` tag as child of the root ````. This is suitable to writing global information regarding the entire test @@ -111,7 +117,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a `pytest-xdist `__ plugin. See issue `#7767 `__ for details. - caplog + caplog -- ../../../..$PYTHON_SITE/_pytest/logging.py:491 Access and control log capturing. Captured logs are available through the following properties/methods:: @@ -122,7 +128,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a * caplog.record_tuples -> list of (logger_name, level, message) tuples * caplog.clear() -> clear captured records and formatted log output string - monkeypatch + monkeypatch -- ../../../..$PYTHON_SITE/_pytest/monkeypatch.py:29 A convenient fixture for monkey-patching. The fixture provides these methods to modify objects, dictionaries or @@ -141,19 +147,19 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a fixture has finished. The ``raising`` parameter determines if a KeyError or AttributeError will be raised if the set/deletion operation has no target. - recwarn + recwarn -- ../../../..$PYTHON_SITE/_pytest/recwarn.py:29 Return a :class:`WarningsRecorder` instance that records all warnings emitted by test functions. See https://docs.python.org/library/how-to/capture-warnings.html for information on warning categories. - tmpdir_factory [session scope] + tmpdir_factory [session scope] -- ../../../..$PYTHON_SITE/_pytest/tmpdir.py:210 Return a :class:`pytest.TempdirFactory` instance for the test session. - tmp_path_factory [session scope] + tmp_path_factory [session scope] -- ../../../..$PYTHON_SITE/_pytest/tmpdir.py:217 Return a :class:`pytest.TempPathFactory` instance for the test session. - tmpdir + tmpdir -- ../../../..$PYTHON_SITE/_pytest/tmpdir.py:232 Return a temporary directory path object which is unique to each test function invocation, created as a sub directory of the base temporary directory. @@ -163,11 +169,11 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a ``--basetemp`` is used then it is cleared each session. See :ref:`base temporary directory`. - The returned object is a `py.path.local`_ path object. + The returned object is a `legacy_path`_ object. - .. _`py.path.local`: https://py.readthedocs.io/en/latest/path.html + .. _legacy_path: https://py.readthedocs.io/en/latest/path.html - tmp_path + tmp_path -- ../../../..$PYTHON_SITE/_pytest/tmpdir.py:250 Return a temporary directory path object which is unique to each test function invocation, created as a sub directory of the base temporary directory. @@ -180,7 +186,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a The returned object is a :class:`pathlib.Path` object. - no tests ran in 0.12s + ========================== no tests ran in 0.12s =========================== You can also interactively ask for help, e.g. by typing on the Python interactive prompt something like: diff --git a/doc/en/example/markers.rst b/doc/en/example/markers.rst index 6f76001dca2..402b8e34626 100644 --- a/doc/en/example/markers.rst +++ b/doc/en/example/markers.rst @@ -46,8 +46,8 @@ You can then restrict a test run to only run tests marked with ``webtest``: $ pytest -v -m webtest =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collecting ... collected 4 items / 3 deselected / 1 selected test_server.py::test_send_http PASSED [100%] @@ -61,8 +61,8 @@ Or the inverse, running all tests except the webtest ones: $ pytest -v -m "not webtest" =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collecting ... collected 4 items / 1 deselected / 3 selected test_server.py::test_something_quick PASSED [ 33%] @@ -83,8 +83,8 @@ tests based on their module, class, method, or function name: $ pytest -v test_server.py::TestClass::test_method =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collecting ... collected 1 item test_server.py::TestClass::test_method PASSED [100%] @@ -98,8 +98,8 @@ You can also select on the class: $ pytest -v test_server.py::TestClass =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collecting ... collected 1 item test_server.py::TestClass::test_method PASSED [100%] @@ -113,8 +113,8 @@ Or select multiple nodes: $ pytest -v test_server.py::TestClass test_server.py::test_send_http =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collecting ... collected 2 items test_server.py::TestClass::test_method PASSED [ 50%] @@ -157,8 +157,8 @@ The expression matching is now case-insensitive. $ pytest -v -k http # running with the above defined example module =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collecting ... collected 4 items / 3 deselected / 1 selected test_server.py::test_send_http PASSED [100%] @@ -172,8 +172,8 @@ And you can also run all tests except the ones that match the keyword: $ pytest -k "not send_http" -v =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collecting ... collected 4 items / 1 deselected / 3 selected test_server.py::test_something_quick PASSED [ 33%] @@ -189,8 +189,8 @@ Or to select "http" and "quick" tests: $ pytest -k "http or quick" -v =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collecting ... collected 4 items / 2 deselected / 2 selected test_server.py::test_send_http PASSED [ 50%] @@ -244,7 +244,7 @@ You can ask which markers exist for your test suite - the list includes our just @pytest.mark.parametrize(argnames, argvalues): call a test function multiple times passing in different arguments in turn. argvalues generally needs to be a list of values if argnames specifies only one name or a list of tuples of values if argnames specifies multiple names. Example: @parametrize('arg1', [1,2]) would lead to two calls of the decorated test function, one with arg1=1 and another with arg1=2.see https://docs.pytest.org/en/stable/how-to/parametrize.html for more info and examples. - @pytest.mark.usefixtures(fixturename1, fixturename2, ...): mark tests as needing all of the specified fixtures. see https://docs.pytest.org/en/stable/how-to/fixtures.html#usefixtures + @pytest.mark.usefixtures(fixturename1, fixturename2, ...): mark tests as needing all of the specified fixtures. see https://docs.pytest.org/en/stable/explanation/fixtures.html#usefixtures @pytest.mark.tryfirst: mark a hook implementation function such that the plugin machinery will try to call it first/as early as possible. @@ -398,8 +398,8 @@ the test needs: $ pytest -E stage2 =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 1 item test_someenv.py s [100%] @@ -413,8 +413,8 @@ and here is one that specifies exactly the environment needed: $ pytest -E stage1 =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 1 item test_someenv.py . [100%] @@ -488,7 +488,7 @@ The output is as follows: .. code-block:: pytest $ pytest -q -s - Mark(name='my_marker', args=(,), kwargs={}) + Mark(name='my_marker', args=(,), kwargs={}) . 1 passed in 0.12s @@ -606,8 +606,8 @@ then you will see two tests skipped and two executed tests as expected: $ pytest -rs # this option reports skip reasons =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 4 items test_plat.py s.s. [100%] @@ -623,8 +623,8 @@ Note that if you specify a platform via the marker-command line option like this $ pytest -m linux =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 4 items / 3 deselected / 1 selected test_plat.py . [100%] @@ -687,8 +687,8 @@ We can now use the ``-m option`` to select one set: $ pytest -m interface --tb=short =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 4 items / 2 deselected / 2 selected test_module.py FF [100%] @@ -714,8 +714,8 @@ or to select both "event" and "interface" tests: $ pytest -m "interface or event" --tb=short =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 4 items / 1 deselected / 3 selected test_module.py FFF [100%] diff --git a/doc/en/example/nonpython.rst b/doc/en/example/nonpython.rst index 4533642d442..d6d1218236e 100644 --- a/doc/en/example/nonpython.rst +++ b/doc/en/example/nonpython.rst @@ -30,8 +30,8 @@ now execute the test specification: nonpython $ pytest test_simple.yaml =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR/nonpython + cachedir: .pytest_cache + rootdir: /home/sweet/project/nonpython collected 2 items test_simple.yaml F. [100%] @@ -67,8 +67,8 @@ consulted when reporting in ``verbose`` mode: nonpython $ pytest -v =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR/nonpython + cachedir: .pytest_cache + rootdir: /home/sweet/project/nonpython collecting ... collected 2 items test_simple.yaml::hello FAILED [ 50%] @@ -93,8 +93,8 @@ interesting to just look at the collection tree: nonpython $ pytest --collect-only =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR/nonpython + cachedir: .pytest_cache + rootdir: /home/sweet/project/nonpython collected 2 items diff --git a/doc/en/example/parametrize.rst b/doc/en/example/parametrize.rst index a91162bcfb2..9d2c3d28063 100644 --- a/doc/en/example/parametrize.rst +++ b/doc/en/example/parametrize.rst @@ -161,8 +161,8 @@ objects, they are still using the default pytest representation: $ pytest test_time.py --collect-only =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 8 items @@ -226,8 +226,8 @@ this is a fully self-contained example which you can run with: $ pytest test_scenarios.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 4 items test_scenarios.py .... [100%] @@ -241,8 +241,8 @@ If you just collect tests you'll also nicely see 'advanced' and 'basic' as varia $ pytest --collect-only test_scenarios.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 4 items @@ -320,8 +320,8 @@ Let's first see how it looks like at collection time: $ pytest test_backends.py --collect-only =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 2 items @@ -339,7 +339,7 @@ And then when we run the test: ================================= FAILURES ================================= _________________________ test_db_initialized[d2] __________________________ - db = + db = def test_db_initialized(db): # a dummy test @@ -419,8 +419,8 @@ The result of this test will be successful: $ pytest -v test_indirect_list.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collecting ... collected 1 item test_indirect_list.py::test_indirect[a-b] PASSED [100%] @@ -478,7 +478,7 @@ argument sets to use for each test function. Let's run it: ================================= FAILURES ================================= ________________________ TestClass.test_equals[1-2] ________________________ - self = , a = 1, b = 2 + self = , a = 1, b = 2 def test_equals(self, a, b): > assert a == b @@ -508,12 +508,8 @@ Running it results in some skips if we don't have all the python interpreters in .. code-block:: pytest . $ pytest -rs -q multipython.py - sssssssssssssssssssssssssss [100%] - ========================= short test summary info ========================== - SKIPPED [9] multipython.py:29: 'python3.5' not found - SKIPPED [9] multipython.py:29: 'python3.6' not found - SKIPPED [9] multipython.py:29: 'python3.7' not found - 27 skipped in 0.12s + ........................... [100%] + 27 passed in 0.12s Indirect parametrization of optional implementations/imports -------------------------------------------------------------------- @@ -574,8 +570,8 @@ If you run this with reporting for skips enabled: $ pytest -rs test_module.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 2 items test_module.py .s [100%] @@ -636,8 +632,8 @@ Then run ``pytest`` with verbose mode and with only the ``basic`` marker: $ pytest -v -m basic =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collecting ... collected 24 items / 21 deselected / 3 selected test_pytest_param_example.py::test_eval[1+7-8] PASSED [ 33%] diff --git a/doc/en/example/pythoncollection.rst b/doc/en/example/pythoncollection.rst index 15889a37c1e..8b7f05bb76d 100644 --- a/doc/en/example/pythoncollection.rst +++ b/doc/en/example/pythoncollection.rst @@ -148,8 +148,8 @@ The test collection would look like this: $ pytest --collect-only =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR, configfile: pytest.ini + cachedir: .pytest_cache + rootdir: /home/sweet/project, configfile: pytest.ini collected 2 items @@ -210,8 +210,8 @@ You can always peek at the collection tree without running tests like this: . $ pytest --collect-only pythoncollection.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR, configfile: pytest.ini + cachedir: .pytest_cache + rootdir: /home/sweet/project, configfile: pytest.ini collected 3 items @@ -292,8 +292,8 @@ file will be left out: $ pytest --collect-only =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR, configfile: pytest.ini + cachedir: .pytest_cache + rootdir: /home/sweet/project, configfile: pytest.ini collected 0 items ======================= no tests collected in 0.12s ======================== diff --git a/doc/en/example/reportingdemo.rst b/doc/en/example/reportingdemo.rst index f7635e0acf1..ff814bd754a 100644 --- a/doc/en/example/reportingdemo.rst +++ b/doc/en/example/reportingdemo.rst @@ -10,8 +10,8 @@ Here is a nice run of several failures and how ``pytest`` presents things: assertion $ pytest failure_demo.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR/assertion + cachedir: .pytest_cache + rootdir: /home/sweet/project/assertion collected 44 items failure_demo.py FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF [100%] @@ -29,7 +29,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:19: AssertionError _________________________ TestFailing.test_simple __________________________ - self = + self = def test_simple(self): def f(): @@ -40,13 +40,13 @@ Here is a nice run of several failures and how ``pytest`` presents things: > assert f() == g() E assert 42 == 43 - E + where 42 = .f at 0xdeadbeef>() - E + and 43 = .g at 0xdeadbeef>() + E + where 42 = .f at 0xdeadbeef0002>() + E + and 43 = .g at 0xdeadbeef0003>() failure_demo.py:30: AssertionError ____________________ TestFailing.test_simple_multiline _____________________ - self = + self = def test_simple_multiline(self): > otherfunc_multi(42, 6 * 9) @@ -63,7 +63,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:14: AssertionError ___________________________ TestFailing.test_not ___________________________ - self = + self = def test_not(self): def f(): @@ -71,12 +71,12 @@ Here is a nice run of several failures and how ``pytest`` presents things: > assert not f() E assert not 42 - E + where 42 = .f at 0xdeadbeef>() + E + where 42 = .f at 0xdeadbeef0006>() failure_demo.py:39: AssertionError _________________ TestSpecialisedExplanations.test_eq_text _________________ - self = + self = def test_eq_text(self): > assert "spam" == "eggs" @@ -87,7 +87,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:44: AssertionError _____________ TestSpecialisedExplanations.test_eq_similar_text _____________ - self = + self = def test_eq_similar_text(self): > assert "foo 1 bar" == "foo 2 bar" @@ -100,7 +100,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:47: AssertionError ____________ TestSpecialisedExplanations.test_eq_multiline_text ____________ - self = + self = def test_eq_multiline_text(self): > assert "foo\nspam\nbar" == "foo\neggs\nbar" @@ -113,7 +113,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:50: AssertionError ______________ TestSpecialisedExplanations.test_eq_long_text _______________ - self = + self = def test_eq_long_text(self): a = "1" * 100 + "a" + "2" * 100 @@ -130,7 +130,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:55: AssertionError _________ TestSpecialisedExplanations.test_eq_long_text_multiline __________ - self = + self = def test_eq_long_text_multiline(self): a = "1\n" * 100 + "a" + "2\n" * 100 @@ -150,7 +150,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:60: AssertionError _________________ TestSpecialisedExplanations.test_eq_list _________________ - self = + self = def test_eq_list(self): > assert [0, 1, 2] == [0, 1, 3] @@ -161,7 +161,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:63: AssertionError ______________ TestSpecialisedExplanations.test_eq_list_long _______________ - self = + self = def test_eq_list_long(self): a = [0] * 100 + [1] + [3] * 100 @@ -174,7 +174,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:68: AssertionError _________________ TestSpecialisedExplanations.test_eq_dict _________________ - self = + self = def test_eq_dict(self): > assert {"a": 0, "b": 1, "c": 0} == {"a": 0, "b": 2, "d": 0} @@ -192,7 +192,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:71: AssertionError _________________ TestSpecialisedExplanations.test_eq_set __________________ - self = + self = def test_eq_set(self): > assert {0, 10, 11, 12} == {0, 20, 21} @@ -210,7 +210,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:74: AssertionError _____________ TestSpecialisedExplanations.test_eq_longer_list ______________ - self = + self = def test_eq_longer_list(self): > assert [1, 2] == [1, 2, 3] @@ -221,7 +221,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:77: AssertionError _________________ TestSpecialisedExplanations.test_in_list _________________ - self = + self = def test_in_list(self): > assert 1 in [0, 2, 3, 4, 5] @@ -230,7 +230,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:80: AssertionError __________ TestSpecialisedExplanations.test_not_in_text_multiline __________ - self = + self = def test_not_in_text_multiline(self): text = "some multiline\ntext\nwhich\nincludes foo\nand a\ntail" @@ -249,7 +249,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:84: AssertionError ___________ TestSpecialisedExplanations.test_not_in_text_single ____________ - self = + self = def test_not_in_text_single(self): text = "single foo line" @@ -262,7 +262,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:88: AssertionError _________ TestSpecialisedExplanations.test_not_in_text_single_long _________ - self = + self = def test_not_in_text_single_long(self): text = "head " * 50 + "foo " + "tail " * 20 @@ -275,7 +275,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:92: AssertionError ______ TestSpecialisedExplanations.test_not_in_text_single_long_term _______ - self = + self = def test_not_in_text_single_long_term(self): text = "head " * 50 + "f" * 70 + "tail " * 20 @@ -288,7 +288,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:96: AssertionError ______________ TestSpecialisedExplanations.test_eq_dataclass _______________ - self = + self = def test_eq_dataclass(self): from dataclasses import dataclass @@ -315,7 +315,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:108: AssertionError ________________ TestSpecialisedExplanations.test_eq_attrs _________________ - self = + self = def test_eq_attrs(self): import attr @@ -349,7 +349,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: i = Foo() > assert i.b == 2 E assert 1 == 2 - E + where 1 = .Foo object at 0xdeadbeef>.b + E + where 1 = .Foo object at 0xdeadbeef0018>.b failure_demo.py:128: AssertionError _________________________ test_attribute_instance __________________________ @@ -360,8 +360,8 @@ Here is a nice run of several failures and how ``pytest`` presents things: > assert Foo().b == 2 E AssertionError: assert 1 == 2 - E + where 1 = .Foo object at 0xdeadbeef>.b - E + where .Foo object at 0xdeadbeef> = .Foo'>() + E + where 1 = .Foo object at 0xdeadbeef0019>.b + E + where .Foo object at 0xdeadbeef0019> = .Foo'>() failure_demo.py:135: AssertionError __________________________ test_attribute_failure __________________________ @@ -379,7 +379,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:146: _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ - self = .Foo object at 0xdeadbeef> + self = .Foo object at 0xdeadbeef001a> def _get_b(self): > raise Exception("Failed to get attrib") @@ -397,15 +397,15 @@ Here is a nice run of several failures and how ``pytest`` presents things: > assert Foo().b == Bar().b E AssertionError: assert 1 == 2 - E + where 1 = .Foo object at 0xdeadbeef>.b - E + where .Foo object at 0xdeadbeef> = .Foo'>() - E + and 2 = .Bar object at 0xdeadbeef>.b - E + where .Bar object at 0xdeadbeef> = .Bar'>() + E + where 1 = .Foo object at 0xdeadbeef001b>.b + E + where .Foo object at 0xdeadbeef001b> = .Foo'>() + E + and 2 = .Bar object at 0xdeadbeef001c>.b + E + where .Bar object at 0xdeadbeef001c> = .Bar'>() failure_demo.py:156: AssertionError __________________________ TestRaises.test_raises __________________________ - self = + self = def test_raises(self): s = "qwe" @@ -415,7 +415,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:166: ValueError ______________________ TestRaises.test_raises_doesnt _______________________ - self = + self = def test_raises_doesnt(self): > raises(OSError, int, "3") @@ -424,7 +424,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:169: Failed __________________________ TestRaises.test_raise ___________________________ - self = + self = def test_raise(self): > raise ValueError("demo error") @@ -433,7 +433,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:172: ValueError ________________________ TestRaises.test_tupleerror ________________________ - self = + self = def test_tupleerror(self): > a, b = [1] # NOQA @@ -442,7 +442,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:175: ValueError ______ TestRaises.test_reinterpret_fails_with_print_for_the_fun_of_it ______ - self = + self = def test_reinterpret_fails_with_print_for_the_fun_of_it(self): items = [1, 2, 3] @@ -455,7 +455,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: items is [1, 2, 3] ________________________ TestRaises.test_some_error ________________________ - self = + self = def test_some_error(self): > if namenotexi: # NOQA @@ -486,7 +486,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: abc-123:2: AssertionError ____________________ TestMoreErrors.test_complex_error _____________________ - self = + self = def test_complex_error(self): def f(): @@ -512,7 +512,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:6: AssertionError ___________________ TestMoreErrors.test_z1_unpack_error ____________________ - self = + self = def test_z1_unpack_error(self): items = [] @@ -522,7 +522,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:217: ValueError ____________________ TestMoreErrors.test_z2_type_error _____________________ - self = + self = def test_z2_type_error(self): items = 3 @@ -532,20 +532,20 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:221: TypeError ______________________ TestMoreErrors.test_startswith ______________________ - self = + self = def test_startswith(self): s = "123" g = "456" > assert s.startswith(g) E AssertionError: assert False - E + where False = ('456') - E + where = '123'.startswith + E + where False = ('456') + E + where = '123'.startswith failure_demo.py:226: AssertionError __________________ TestMoreErrors.test_startswith_nested ___________________ - self = + self = def test_startswith_nested(self): def f(): @@ -556,15 +556,15 @@ Here is a nice run of several failures and how ``pytest`` presents things: > assert f().startswith(g()) E AssertionError: assert False - E + where False = ('456') - E + where = '123'.startswith - E + where '123' = .f at 0xdeadbeef>() - E + and '456' = .g at 0xdeadbeef>() + E + where False = ('456') + E + where = '123'.startswith + E + where '123' = .f at 0xdeadbeef0029>() + E + and '456' = .g at 0xdeadbeef002a>() failure_demo.py:235: AssertionError _____________________ TestMoreErrors.test_global_func ______________________ - self = + self = def test_global_func(self): > assert isinstance(globf(42), float) @@ -575,18 +575,18 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:238: AssertionError _______________________ TestMoreErrors.test_instance _______________________ - self = + self = def test_instance(self): self.x = 6 * 7 > assert self.x != 42 E assert 42 != 42 - E + where 42 = .x + E + where 42 = .x failure_demo.py:242: AssertionError _______________________ TestMoreErrors.test_compare ________________________ - self = + self = def test_compare(self): > assert globf(10) < 5 @@ -596,7 +596,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:245: AssertionError _____________________ TestMoreErrors.test_try_finally ______________________ - self = + self = def test_try_finally(self): x = 1 @@ -607,7 +607,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:250: AssertionError ___________________ TestCustomAssertMsg.test_single_line ___________________ - self = + self = def test_single_line(self): class A: @@ -622,7 +622,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:261: AssertionError ____________________ TestCustomAssertMsg.test_multiline ____________________ - self = + self = def test_multiline(self): class A: @@ -641,7 +641,7 @@ Here is a nice run of several failures and how ``pytest`` presents things: failure_demo.py:268: AssertionError ___________________ TestCustomAssertMsg.test_custom_repr ___________________ - self = + self = def test_custom_repr(self): class JSON: diff --git a/doc/en/example/simple.rst b/doc/en/example/simple.rst index 9bc51a88bbb..a872e34b102 100644 --- a/doc/en/example/simple.rst +++ b/doc/en/example/simple.rst @@ -166,6 +166,7 @@ Now we'll get feedback on a bad argument: ERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...] pytest: error: argument --cmdopt: invalid choice: 'type3' (choose from 'type1', 'type2') + If you need to provide more detailed error messages, you can use the ``type`` parameter and raise ``pytest.UsageError``: @@ -232,8 +233,8 @@ directory with the above conftest.py: $ pytest =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 0 items ========================== no tests ran in 0.12s =========================== @@ -297,8 +298,8 @@ and when running it will see a skipped "slow" test: $ pytest -rs # "-rs" means report details on the little 's' =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 2 items test_module.py .s [100%] @@ -314,8 +315,8 @@ Or run it including the ``slow`` marked test: $ pytest --runslow =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 2 items test_module.py .. [100%] @@ -458,9 +459,9 @@ which will add the string to the test header accordingly: $ pytest =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache + cachedir: .pytest_cache project deps: mylib-1.1 - rootdir: $REGENDOC_TMPDIR + rootdir: /home/sweet/project collected 0 items ========================== no tests ran in 0.12s =========================== @@ -487,10 +488,10 @@ which will add info only when run with "--v": $ pytest -v =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python - cachedir: $PYTHON_PREFIX/.pytest_cache + cachedir: .pytest_cache info1: did you know that ... did you? - rootdir: $REGENDOC_TMPDIR + rootdir: /home/sweet/project collecting ... collected 0 items ========================== no tests ran in 0.12s =========================== @@ -502,8 +503,8 @@ and nothing when run plainly: $ pytest =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 0 items ========================== no tests ran in 0.12s =========================== @@ -542,8 +543,8 @@ Now we can profile which test functions execute the slowest: $ pytest --durations=3 =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 3 items test_some_are_slow.py ... [100%] @@ -648,8 +649,8 @@ If we run this: $ pytest -rx =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 4 items test_step.py .Fx. [100%] @@ -657,7 +658,7 @@ If we run this: ================================= FAILURES ================================= ____________________ TestUserHandling.test_modification ____________________ - self = + self = def test_modification(self): > assert 0 @@ -732,8 +733,8 @@ We can run this: $ pytest =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 7 items test_step.py .Fx. [ 57%] @@ -743,17 +744,17 @@ We can run this: ================================== ERRORS ================================== _______________________ ERROR at setup of test_root ________________________ - file $REGENDOC_TMPDIR/b/test_error.py, line 1 + file /home/sweet/project/b/test_error.py, line 1 def test_root(db): # no db here, will error out E fixture 'db' not found > available fixtures: cache, capfd, capfdbinary, caplog, capsys, capsysbinary, doctest_namespace, monkeypatch, pytestconfig, record_property, record_testsuite_property, record_xml_attribute, recwarn, tmp_path, tmp_path_factory, tmpdir, tmpdir_factory > use 'pytest --fixtures [testpath]' for help on them. - $REGENDOC_TMPDIR/b/test_error.py:1 + /home/sweet/project/b/test_error.py:1 ================================= FAILURES ================================= ____________________ TestUserHandling.test_modification ____________________ - self = + self = def test_modification(self): > assert 0 @@ -762,21 +763,21 @@ We can run this: test_step.py:11: AssertionError _________________________________ test_a1 __________________________________ - db = + db = def test_a1(db): > assert 0, db # to show value - E AssertionError: + E AssertionError: E assert 0 a/test_db.py:2: AssertionError _________________________________ test_a2 __________________________________ - db = + db = def test_a2(db): > assert 0, db # to show value - E AssertionError: + E AssertionError: E assert 0 a/test_db2.py:2: AssertionError @@ -851,8 +852,8 @@ and run them: $ pytest test_module.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 2 items test_module.py FF [100%] @@ -860,7 +861,7 @@ and run them: ================================= FAILURES ================================= ________________________________ test_fail1 ________________________________ - tmp_path = Path('PYTEST_TMPDIR/test_fail10') + tmp_path = PosixPath('PYTEST_TMPDIR/test_fail10') def test_fail1(tmp_path): > assert 0 @@ -958,8 +959,8 @@ and run it: $ pytest -s test_module.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 3 items test_module.py Esetting up a test failed! test_module.py::test_setup_fails diff --git a/doc/en/getting-started.rst b/doc/en/getting-started.rst index bb41a2f1c02..c992b4262b9 100644 --- a/doc/en/getting-started.rst +++ b/doc/en/getting-started.rst @@ -22,7 +22,7 @@ Install ``pytest`` .. code-block:: bash $ pytest --version - pytest 6.2.5 + pytest 6.3.0.dev685+g581b021aa.d20210922 .. _`simpletest`: @@ -48,8 +48,8 @@ The test $ pytest =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 1 item test_sample.py F [100%] @@ -138,7 +138,7 @@ Once you develop multiple tests, you may want to group them into a class. pytest ================================= FAILURES ================================= ____________________________ TestClass.test_two ____________________________ - self = + self = def test_two(self): x = "hello" @@ -186,17 +186,17 @@ This is outlined below: ================================= FAILURES ================================= ______________________ TestClassDemoInstance.test_two ______________________ - self = + self = def test_two(self): > assert self.value == 1 E assert 0 == 1 - E + where 0 = .value + E + where 0 = .value test_class_demo.py:9: AssertionError ========================= short test summary info ========================== FAILED test_class_demo.py::TestClassDemoInstance::test_two - assert 0 == 1 - 1 failed, 1 passed in 0.04s + 1 failed, 1 passed in 0.12s Note that attributes added at class level are *class attributes*, so they will be shared between tests. @@ -221,14 +221,14 @@ List the name ``tmp_path`` in the test function signature and ``pytest`` will lo ================================= FAILURES ================================= _____________________________ test_needsfiles ______________________________ - tmp_path = Path('PYTEST_TMPDIR/test_needsfiles0') + tmp_path = PosixPath('PYTEST_TMPDIR/test_needsfiles0') def test_needsfiles(tmp_path): print(tmp_path) > assert 0 E assert 0 - test_tmpdir.py:3: AssertionError + test_tmp_path.py:3: AssertionError --------------------------- Captured stdout call --------------------------- PYTEST_TMPDIR/test_needsfiles0 ========================= short test summary info ========================== diff --git a/doc/en/how-to/assert.rst b/doc/en/how-to/assert.rst index 0aa4980f1a4..262f98771b8 100644 --- a/doc/en/how-to/assert.rst +++ b/doc/en/how-to/assert.rst @@ -30,8 +30,8 @@ you will see the return value of the function call: $ pytest test_assert1.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 1 item test_assert1.py F [100%] @@ -185,8 +185,8 @@ if you run this module: $ pytest test_assert2.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 1 item test_assert2.py F [100%] @@ -205,7 +205,7 @@ if you run this module: E '5' E Use -v to get the full diff - test_assert2.py:6: AssertionError + test_assert2.py:4: AssertionError ========================= short test summary info ========================== FAILED test_assert2.py::test_set_comparison - AssertionError: assert {'0'... ============================ 1 failed in 0.12s ============================= diff --git a/doc/en/how-to/cache.rst b/doc/en/how-to/cache.rst index 45dc81c2122..5438102f078 100644 --- a/doc/en/how-to/cache.rst +++ b/doc/en/how-to/cache.rst @@ -87,8 +87,8 @@ If you then run it with ``--lf``: $ pytest --lf =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 2 items run-last-failure: rerun previous 2 failures @@ -134,8 +134,8 @@ of ``FF`` and dots): $ pytest --ff =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 50 items run-last-failure: rerun previous 2 failures first @@ -278,72 +278,14 @@ You can always peek at the content of the cache using the $ pytest --cache-show =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR - cachedir: $PYTHON_PREFIX/.pytest_cache + cachedir: .pytest_cache + rootdir: /home/sweet/project + cachedir: /home/sweet/project/.pytest_cache --------------------------- cache values for '*' --------------------------- cache/lastfailed contains: - {'test_50.py::test_num[17]': True, - 'test_50.py::test_num[25]': True, - 'test_assert1.py::test_function': True, - 'test_assert2.py::test_set_comparison': True, - 'test_caching.py::test_function': True, - 'test_foocompare.py::test_compare': True} + {'test_caching.py::test_function': True} cache/nodeids contains: - ['test_50.py::test_num[0]', - 'test_50.py::test_num[10]', - 'test_50.py::test_num[11]', - 'test_50.py::test_num[12]', - 'test_50.py::test_num[13]', - 'test_50.py::test_num[14]', - 'test_50.py::test_num[15]', - 'test_50.py::test_num[16]', - 'test_50.py::test_num[17]', - 'test_50.py::test_num[18]', - 'test_50.py::test_num[19]', - 'test_50.py::test_num[1]', - 'test_50.py::test_num[20]', - 'test_50.py::test_num[21]', - 'test_50.py::test_num[22]', - 'test_50.py::test_num[23]', - 'test_50.py::test_num[24]', - 'test_50.py::test_num[25]', - 'test_50.py::test_num[26]', - 'test_50.py::test_num[27]', - 'test_50.py::test_num[28]', - 'test_50.py::test_num[29]', - 'test_50.py::test_num[2]', - 'test_50.py::test_num[30]', - 'test_50.py::test_num[31]', - 'test_50.py::test_num[32]', - 'test_50.py::test_num[33]', - 'test_50.py::test_num[34]', - 'test_50.py::test_num[35]', - 'test_50.py::test_num[36]', - 'test_50.py::test_num[37]', - 'test_50.py::test_num[38]', - 'test_50.py::test_num[39]', - 'test_50.py::test_num[3]', - 'test_50.py::test_num[40]', - 'test_50.py::test_num[41]', - 'test_50.py::test_num[42]', - 'test_50.py::test_num[43]', - 'test_50.py::test_num[44]', - 'test_50.py::test_num[45]', - 'test_50.py::test_num[46]', - 'test_50.py::test_num[47]', - 'test_50.py::test_num[48]', - 'test_50.py::test_num[49]', - 'test_50.py::test_num[4]', - 'test_50.py::test_num[5]', - 'test_50.py::test_num[6]', - 'test_50.py::test_num[7]', - 'test_50.py::test_num[8]', - 'test_50.py::test_num[9]', - 'test_assert1.py::test_function', - 'test_assert2.py::test_set_comparison', - 'test_caching.py::test_function', - 'test_foocompare.py::test_compare'] + ['test_caching.py::test_function'] cache/stepwise contains: [] example/value contains: @@ -359,9 +301,9 @@ filtering: $ pytest --cache-show example/* =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR - cachedir: $PYTHON_PREFIX/.pytest_cache + cachedir: .pytest_cache + rootdir: /home/sweet/project + cachedir: /home/sweet/project/.pytest_cache ----------------------- cache values for 'example/*' ----------------------- example/value contains: 42 diff --git a/doc/en/how-to/capture-stdout-stderr.rst b/doc/en/how-to/capture-stdout-stderr.rst index 5d405a166a8..14628df6164 100644 --- a/doc/en/how-to/capture-stdout-stderr.rst +++ b/doc/en/how-to/capture-stdout-stderr.rst @@ -84,8 +84,8 @@ of the failing function and hide the other one: $ pytest =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 2 items test_module.py .F [100%] @@ -99,7 +99,7 @@ of the failing function and hide the other one: test_module.py:12: AssertionError -------------------------- Captured stdout setup --------------------------- - setting up + setting up ========================= short test summary info ========================== FAILED test_module.py::test_func2 - assert False ======================= 1 failed, 1 passed in 0.12s ======================== diff --git a/doc/en/how-to/capture-warnings.rst b/doc/en/how-to/capture-warnings.rst index 9ac7c2a3302..f78698815c2 100644 --- a/doc/en/how-to/capture-warnings.rst +++ b/doc/en/how-to/capture-warnings.rst @@ -29,15 +29,15 @@ Running pytest now produces this output: $ pytest test_show_warnings.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 1 item test_show_warnings.py . [100%] ============================= warnings summary ============================= test_show_warnings.py::test_one - $REGENDOC_TMPDIR/test_show_warnings.py:5: UserWarning: api v1, should use functions from v2 + /home/sweet/project/test_show_warnings.py:5: UserWarning: api v1, should use functions from v2 warnings.warn(UserWarning("api v1, should use functions from v2")) -- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html @@ -393,7 +393,7 @@ defines an ``__init__`` constructor, as this prevents the class from being insta ============================= warnings summary ============================= test_pytest_warnings.py:1 - $REGENDOC_TMPDIR/test_pytest_warnings.py:1: PytestCollectionWarning: cannot collect test class 'Test' because it has a __init__ constructor (from: test_pytest_warnings.py) + /home/sweet/project/test_pytest_warnings.py:1: PytestCollectionWarning: cannot collect test class 'Test' because it has a __init__ constructor (from: test_pytest_warnings.py) class Test: -- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html diff --git a/doc/en/how-to/doctest.rst b/doc/en/how-to/doctest.rst index 80f1ee0d890..67a508c504c 100644 --- a/doc/en/how-to/doctest.rst +++ b/doc/en/how-to/doctest.rst @@ -31,8 +31,8 @@ then you can just invoke ``pytest`` directly: $ pytest =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 1 item test_example.txt . [100%] @@ -60,8 +60,8 @@ and functions, including from test modules: $ pytest --doctest-modules =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 2 items mymodule.py . [ 50%] diff --git a/doc/en/how-to/fixtures.rst b/doc/en/how-to/fixtures.rst index 1abeffee002..db21a52e3d5 100644 --- a/doc/en/how-to/fixtures.rst +++ b/doc/en/how-to/fixtures.rst @@ -433,8 +433,8 @@ marked ``smtp_connection`` fixture function. Running the test looks like this: $ pytest test_module.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 2 items test_module.py FF [100%] @@ -442,7 +442,7 @@ marked ``smtp_connection`` fixture function. Running the test looks like this: ================================= FAILURES ================================= ________________________________ test_ehlo _________________________________ - smtp_connection = + smtp_connection = def test_ehlo(smtp_connection): response, msg = smtp_connection.ehlo() @@ -454,7 +454,7 @@ marked ``smtp_connection`` fixture function. Running the test looks like this: test_module.py:7: AssertionError ________________________________ test_noop _________________________________ - smtp_connection = + smtp_connection = def test_noop(smtp_connection): response, msg = smtp_connection.noop() @@ -1050,7 +1050,7 @@ again, nothing much has changed: .. code-block:: pytest $ pytest -s -q --tb=no test_module.py - FFfinalizing (smtp.gmail.com) + FFfinalizing (smtp.gmail.com) ========================= short test summary info ========================== FAILED test_module.py::test_ehlo - assert 0 @@ -1083,7 +1083,7 @@ Running it: E AssertionError: (250, b'mail.python.org') E assert 0 ------------------------- Captured stdout teardown ------------------------- - finalizing (mail.python.org) + finalizing (mail.python.org) ========================= short test summary info ========================== FAILED test_anothersmtp.py::test_showhelo - AssertionError: (250, b'mail.... @@ -1218,7 +1218,7 @@ So let's just do another run: ================================= FAILURES ================================= ________________________ test_ehlo[smtp.gmail.com] _________________________ - smtp_connection = + smtp_connection = def test_ehlo(smtp_connection): response, msg = smtp_connection.ehlo() @@ -1230,7 +1230,7 @@ So let's just do another run: test_module.py:7: AssertionError ________________________ test_noop[smtp.gmail.com] _________________________ - smtp_connection = + smtp_connection = def test_noop(smtp_connection): response, msg = smtp_connection.noop() @@ -1241,7 +1241,7 @@ So let's just do another run: test_module.py:13: AssertionError ________________________ test_ehlo[mail.python.org] ________________________ - smtp_connection = + smtp_connection = def test_ehlo(smtp_connection): response, msg = smtp_connection.ehlo() @@ -1251,10 +1251,10 @@ So let's just do another run: test_module.py:6: AssertionError -------------------------- Captured stdout setup --------------------------- - finalizing + finalizing ________________________ test_noop[mail.python.org] ________________________ - smtp_connection = + smtp_connection = def test_noop(smtp_connection): response, msg = smtp_connection.noop() @@ -1264,7 +1264,7 @@ So let's just do another run: test_module.py:13: AssertionError ------------------------- Captured stdout teardown ------------------------- - finalizing + finalizing ========================= short test summary info ========================== FAILED test_module.py::test_ehlo[smtp.gmail.com] - assert 0 FAILED test_module.py::test_noop[smtp.gmail.com] - assert 0 @@ -1332,8 +1332,8 @@ Running the above tests results in the following test IDs being used: $ pytest --collect-only =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 11 items @@ -1385,8 +1385,8 @@ Running this test will *skip* the invocation of ``data_set`` with value ``2``: $ pytest test_fixture_marks.py -v =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collecting ... collected 3 items test_fixture_marks.py::test_data[0] PASSED [ 33%] @@ -1435,8 +1435,8 @@ Here we declare an ``app`` fixture which receives the previously defined $ pytest -v test_appsetup.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collecting ... collected 2 items test_appsetup.py::test_smtp_connection_exists[smtp.gmail.com] PASSED [ 50%] @@ -1515,8 +1515,8 @@ Let's run the tests in verbose mode and with looking at the print-output: $ pytest -v -s test_module.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collecting ... collected 8 items test_module.py::test_0[1] SETUP otherarg 1 diff --git a/doc/en/how-to/output.rst b/doc/en/how-to/output.rst index 91cfe2603f1..2297029d677 100644 --- a/doc/en/how-to/output.rst +++ b/doc/en/how-to/output.rst @@ -68,13 +68,13 @@ Executing pytest normally gives us this output (we are skipping the header to fo .. code-block:: pytest $ pytest --no-header - =========================== test session starts =========================== + =========================== test session starts ============================ collected 4 items test_verbosity_example.py .FFF [100%] - ================================ FAILURES ================================= - _____________________________ test_words_fail _____________________________ + ================================= FAILURES ================================= + _____________________________ test_words_fail ______________________________ def test_words_fail(): fruits1 = ["banana", "apple", "grapes", "melon", "kiwi"] @@ -85,7 +85,7 @@ Executing pytest normally gives us this output (we are skipping the header to fo E Use -v to get the full diff test_verbosity_example.py:8: AssertionError - ____________________________ test_numbers_fail ____________________________ + ____________________________ test_numbers_fail _____________________________ def test_numbers_fail(): number_to_text1 = {str(x): x for x in range(5)} @@ -100,7 +100,7 @@ Executing pytest normally gives us this output (we are skipping the header to fo E Use -v to get the full diff test_verbosity_example.py:14: AssertionError - ___________________________ test_long_text_fail ___________________________ + ___________________________ test_long_text_fail ____________________________ def test_long_text_fail(): long_text = "Lorem ipsum dolor sit amet " * 10 @@ -108,11 +108,11 @@ Executing pytest normally gives us this output (we are skipping the header to fo E AssertionError: assert 'hello world' in 'Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ips... sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet ' test_verbosity_example.py:19: AssertionError - ========================= short test summary info ========================= + ========================= short test summary info ========================== FAILED test_verbosity_example.py::test_words_fail - AssertionError: asser... FAILED test_verbosity_example.py::test_numbers_fail - AssertionError: ass... FAILED test_verbosity_example.py::test_long_text_fail - AssertionError: a... - ======================= 3 failed, 1 passed in 0.08s ======================= + ======================= 3 failed, 1 passed in 0.12s ======================== Notice that: @@ -127,7 +127,7 @@ Now we can increase pytest's verbosity: .. code-block:: pytest $ pytest --no-header -v - =========================== test session starts =========================== + =========================== test session starts ============================ collecting ... collected 4 items test_verbosity_example.py::test_ok PASSED [ 25%] @@ -135,8 +135,8 @@ Now we can increase pytest's verbosity: test_verbosity_example.py::test_numbers_fail FAILED [ 75%] test_verbosity_example.py::test_long_text_fail FAILED [100%] - ================================ FAILURES ================================= - _____________________________ test_words_fail _____________________________ + ================================= FAILURES ================================= + _____________________________ test_words_fail ______________________________ def test_words_fail(): fruits1 = ["banana", "apple", "grapes", "melon", "kiwi"] @@ -151,7 +151,7 @@ Now we can increase pytest's verbosity: E ? ^ ^ + test_verbosity_example.py:8: AssertionError - ____________________________ test_numbers_fail ____________________________ + ____________________________ test_numbers_fail _____________________________ def test_numbers_fail(): number_to_text1 = {str(x): x for x in range(5)} @@ -169,7 +169,7 @@ Now we can increase pytest's verbosity: E ...Full output truncated (3 lines hidden), use '-vv' to show test_verbosity_example.py:14: AssertionError - ___________________________ test_long_text_fail ___________________________ + ___________________________ test_long_text_fail ____________________________ def test_long_text_fail(): long_text = "Lorem ipsum dolor sit amet " * 10 @@ -177,11 +177,11 @@ Now we can increase pytest's verbosity: E AssertionError: assert 'hello world' in 'Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet ' test_verbosity_example.py:19: AssertionError - ========================= short test summary info ========================= + ========================= short test summary info ========================== FAILED test_verbosity_example.py::test_words_fail - AssertionError: asser... FAILED test_verbosity_example.py::test_numbers_fail - AssertionError: ass... FAILED test_verbosity_example.py::test_long_text_fail - AssertionError: a... - ======================= 3 failed, 1 passed in 0.07s ======================= + ======================= 3 failed, 1 passed in 0.12s ======================== Notice now that: @@ -196,7 +196,7 @@ Now if we increase verbosity even more: .. code-block:: pytest $ pytest --no-header -vv - =========================== test session starts =========================== + =========================== test session starts ============================ collecting ... collected 4 items test_verbosity_example.py::test_ok PASSED [ 25%] @@ -204,8 +204,8 @@ Now if we increase verbosity even more: test_verbosity_example.py::test_numbers_fail FAILED [ 75%] test_verbosity_example.py::test_long_text_fail FAILED [100%] - ================================ FAILURES ================================= - _____________________________ test_words_fail _____________________________ + ================================= FAILURES ================================= + _____________________________ test_words_fail ______________________________ def test_words_fail(): fruits1 = ["banana", "apple", "grapes", "melon", "kiwi"] @@ -220,7 +220,7 @@ Now if we increase verbosity even more: E ? ^ ^ + test_verbosity_example.py:8: AssertionError - ____________________________ test_numbers_fail ____________________________ + ____________________________ test_numbers_fail _____________________________ def test_numbers_fail(): number_to_text1 = {str(x): x for x in range(5)} @@ -239,7 +239,7 @@ Now if we increase verbosity even more: E + {'0': 0, '1': 1, '2': 2, '3': 3, '4': 4} test_verbosity_example.py:14: AssertionError - ___________________________ test_long_text_fail ___________________________ + ___________________________ test_long_text_fail ____________________________ def test_long_text_fail(): long_text = "Lorem ipsum dolor sit amet " * 10 @@ -247,11 +247,11 @@ Now if we increase verbosity even more: E AssertionError: assert 'hello world' in 'Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet ' test_verbosity_example.py:19: AssertionError - ========================= short test summary info ========================= + ========================= short test summary info ========================== FAILED test_verbosity_example.py::test_words_fail - AssertionError: asser... FAILED test_verbosity_example.py::test_numbers_fail - AssertionError: ass... FAILED test_verbosity_example.py::test_long_text_fail - AssertionError: a... - ======================= 3 failed, 1 passed in 0.07s ======================= + ======================= 3 failed, 1 passed in 0.12s ======================== Notice now that: @@ -322,8 +322,8 @@ Example: $ pytest -ra =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 6 items test_example.py .FEsxX [100%] @@ -380,8 +380,8 @@ More than one character can be used, so for example to only see failed and skipp $ pytest -rfs =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 6 items test_example.py .FEsxX [100%] @@ -416,8 +416,8 @@ captured output: $ pytest -rpP =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 6 items test_example.py .FEsxX [100%] @@ -447,7 +447,6 @@ captured output: PASSED test_example.py::test_ok == 1 failed, 1 passed, 1 skipped, 1 xfailed, 1 xpassed, 1 error in 0.12s === - Creating resultlog format files -------------------------------------------------- diff --git a/doc/en/how-to/parametrize.rst b/doc/en/how-to/parametrize.rst index 18163db6fa3..240016601be 100644 --- a/doc/en/how-to/parametrize.rst +++ b/doc/en/how-to/parametrize.rst @@ -57,8 +57,8 @@ them in turn: $ pytest =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 3 items test_expectation.py ..F [100%] @@ -169,8 +169,8 @@ Let's run this: $ pytest =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 3 items test_expectation.py ..x [100%] @@ -268,8 +268,8 @@ Let's also run with a stringinput that will lead to a failing test: def test_valid_string(stringinput): > assert stringinput.isalpha() E AssertionError: assert False - E + where False = () - E + where = '!'.isalpha + E + where False = () + E + where = '!'.isalpha test_strings.py:4: AssertionError ========================= short test summary info ========================== @@ -287,7 +287,7 @@ list: $ pytest -q -rs test_strings.py s [100%] ========================= short test summary info ========================== - SKIPPED [1] test_strings.py: got empty parameter set ['stringinput'], function test_valid_string at $REGENDOC_TMPDIR/test_strings.py:2 + SKIPPED [1] test_strings.py: got empty parameter set ['stringinput'], function test_valid_string at /home/sweet/project/test_strings.py:2 1 skipped in 0.12s Note that when calling ``metafunc.parametrize`` multiple times with different parameter sets, all parameter names across diff --git a/doc/en/how-to/tmp_path.rst b/doc/en/how-to/tmp_path.rst index d31f5956ae6..3e95116dca9 100644 --- a/doc/en/how-to/tmp_path.rst +++ b/doc/en/how-to/tmp_path.rst @@ -37,8 +37,8 @@ Running this would result in a passed test except for the last $ pytest test_tmp_path.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 1 item test_tmp_path.py F [100%] diff --git a/doc/en/how-to/unittest.rst b/doc/en/how-to/unittest.rst index eb2c72e77d3..122e25a8482 100644 --- a/doc/en/how-to/unittest.rst +++ b/doc/en/how-to/unittest.rst @@ -137,8 +137,8 @@ the ``self.db`` values in the traceback: $ pytest test_unittest_db.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 2 items test_unittest_db.py FF [100%] @@ -151,7 +151,7 @@ the ``self.db`` values in the traceback: def test_method1(self): assert hasattr(self, "db") > assert 0, self.db # fail for demo purposes - E AssertionError: .DummyDB object at 0xdeadbeef> + E AssertionError: .DummyDB object at 0xdeadbeef0001> E assert 0 test_unittest_db.py:10: AssertionError @@ -161,7 +161,7 @@ the ``self.db`` values in the traceback: def test_method2(self): > assert 0, self.db # fail for demo purposes - E AssertionError: .DummyDB object at 0xdeadbeef> + E AssertionError: .DummyDB object at 0xdeadbeef0001> E assert 0 test_unittest_db.py:13: AssertionError diff --git a/doc/en/how-to/usage.rst b/doc/en/how-to/usage.rst index f9b38b19ea6..ffbce91695f 100644 --- a/doc/en/how-to/usage.rst +++ b/doc/en/how-to/usage.rst @@ -201,28 +201,8 @@ hook was invoked: .. code-block:: pytest $ python myinvoke.py - .FEsxX. [100%]*** test run reporting finishing + *** test run reporting finishing - ================================== ERRORS ================================== - _______________________ ERROR at setup of test_error _______________________ - - @pytest.fixture - def error_fixture(): - > assert 0 - E assert 0 - - test_example.py:6: AssertionError - ================================= FAILURES ================================= - ________________________________ test_fail _________________________________ - - def test_fail(): - > assert 0 - E assert 0 - - test_example.py:14: AssertionError - ========================= short test summary info ========================== - FAILED test_example.py::test_fail - assert 0 - ERROR test_example.py::test_error - assert 0 .. note:: diff --git a/doc/en/how-to/writing_plugins.rst b/doc/en/how-to/writing_plugins.rst index 0157863e1a8..f46ba91dec1 100644 --- a/doc/en/how-to/writing_plugins.rst +++ b/doc/en/how-to/writing_plugins.rst @@ -448,8 +448,8 @@ in our ``pytest.ini`` to tell pytest where to look for example files. $ pytest =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR, configfile: pytest.ini + cachedir: .pytest_cache + rootdir: /home/sweet/project, configfile: pytest.ini collected 2 items test_example.py .. [100%] diff --git a/doc/en/index.rst b/doc/en/index.rst index 2548f7f8803..79eef7f44cc 100644 --- a/doc/en/index.rst +++ b/doc/en/index.rst @@ -45,8 +45,8 @@ To execute it: $ pytest =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y - cachedir: $PYTHON_PREFIX/.pytest_cache - rootdir: $REGENDOC_TMPDIR + cachedir: .pytest_cache + rootdir: /home/sweet/project collected 1 item test_sample.py F [100%] diff --git a/doc/en/reference/reference.rst b/doc/en/reference/reference.rst index 7ff0bd0430e..b5d0faf9055 100644 --- a/doc/en/reference/reference.rst +++ b/doc/en/reference/reference.rst @@ -1774,8 +1774,8 @@ All the command-line flags can be obtained by running ``pytest --help``:: --pdb start the interactive Python debugger on errors or KeyboardInterrupt. --pdbcls=modulename:classname - start a custom interactive Python debugger on - errors. For example: + specify a custom interactive Python debugger for use + with --pdb.For example: --pdbcls=IPython.terminal.debugger:TerminalPdb --trace Immediately break when running each test. --capture=method per-test capturing method: one of fd|sys|no|tee-sys. @@ -1800,7 +1800,8 @@ All the command-line flags can be obtained by running ``pytest --help``:: test next time --sw-skip, --stepwise-skip ignore the first failing test but stop on the next - failing test + failing test. + implicitly enables --stepwise. reporting: --durations=N show N slowest setup/test durations (N=0 for all). @@ -1887,7 +1888,7 @@ All the command-line flags can be obtained by running ``pytest --help``:: --basetemp=dir base temporary directory for this test run.(warning: this directory is removed if it exists) -V, --version display pytest version and information about - plugins.When given twice, also display information + plugins. When given twice, also display information about plugins. -h, --help show help message and configuration info -p name early-load given plugin module name or entry point @@ -1895,8 +1896,12 @@ All the command-line flags can be obtained by running ``pytest --help``:: To avoid loading of plugins, use the `no:` prefix, e.g. `no:doctest`. --trace-config trace considerations of conftest.py files. - --debug store internal tracing debug information in - 'pytestdebug.log'. + --debug=[DEBUG_FILE_NAME] + store internal tracing debug information in this log + file. + This file is opened with 'w' and truncated as a + result, care advised. + Defaults to 'pytestdebug.log'. -o OVERRIDE_INI, --override-ini=OVERRIDE_INI override ini option with "option=value" style, e.g. `-o xfail_strict=True -o cache_dir=cache`. diff --git a/tox.ini b/tox.ini index c6dd3f477ee..f9a3857f370 100644 --- a/tox.ini +++ b/tox.ini @@ -90,16 +90,11 @@ install_command=python -m pip --use-deprecated=legacy-resolver install {opts} {p deps = dataclasses PyYAML - regendoc>=0.6.1 + regendoc>=0.8.1 sphinx whitelist_externals = - rm make commands = - # don't show hypothesis plugin info in docs, see #4602 - pip uninstall hypothesis -y - rm -rf /tmp/doc-exec* - rm -rf {envdir}/.pytest_cache make regen [testenv:plugins]