Merge pull request #9111 from ziebam/iss4320-better-docs-for-testdir-copy-example

This commit is contained in:
Bruno Oliveira 2021-09-22 07:51:42 -03:00 committed by GitHub
commit f50652a5d2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 8 additions and 1 deletions

View File

@ -224,6 +224,7 @@ Michael Goerz
Michael Krebs
Michael Seifert
Michal Wajszczuk
Michał Zięba
Mihai Capotă
Mike Hoyle (hoylemd)
Mike Lundy

1
changelog/4320.doc.rst Normal file
View File

@ -0,0 +1 @@
Improved docs for `pytester.copy_example`.

View File

@ -416,7 +416,12 @@ return a result object, with which we can assert the tests' outcomes.
result.assert_outcomes(passed=4)
Additionally it is possible to copy examples for an example folder before running pytest on it.
Additionally it is possible to copy examples to the ``pytester``'s isolated environment
before running pytest on it. This way we can abstract the tested logic to separate files,
which is especially useful for longer tests and/or longer ``conftest.py`` files.
Note that for ``pytester.copy_example`` to work we need to set `pytester_example_dir`
in our ``pytest.ini`` to tell pytest where to look for example files.
.. code-block:: ini