Skip to content

doc: note about mutation of parametrized values #7516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 20, 2020
Merged

doc: note about mutation of parametrized values #7516

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c3c3a9c
doc: note about mutation of parametrized values
ankostis Jul 19, 2020
a2b0838
doc: minor typo; pep8 2nd original note
ankostis Jul 19, 2020
625aa5c
doc: drop explaination why parametrized no copy
ankostis Jul 20, 2020
c049831
doc: split in separate notes mutation & unicode
ankostis Jul 20, 2020
b676882
doc: @bluetech's example in mutations note
ankostis Jul 20, 2020
07ac0ab
doc: split example § in mutation note
ankostis Jul 20, 2020
f556031
Update doc/en/parametrize.rst
bluetech Jul 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions doc/en/parametrize.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,19 +79,30 @@ them in turn:
FAILED test_expectation.py::test_eval[6*9-42] - AssertionError: assert 54...
======================= 1 failed, 2 passed in 0.12s ========================

.. note::

Parameter values are passed as-is to tests (no copy whatsoever).

For example, if you pass a list or a dict as a parameter value, and
the test case code mutates it, the mutations will be reflected in subsequent
test case calls.

.. note::

pytest by default escapes any non-ascii characters used in unicode strings
for the parametrization because it has several downsides.
If however you would like to use unicode strings in parametrization and see them in the terminal as is (non-escaped), use this option in your ``pytest.ini``:
If however you would like to use unicode strings in parametrization
and see them in the terminal as is (non-escaped), use this option
in your ``pytest.ini``:

.. code-block:: ini

[pytest]
disable_test_id_escaping_and_forfeit_all_rights_to_community_support = True

Keep in mind however that this might cause unwanted side effects and
even bugs depending on the OS used and plugins currently installed, so use it at your own risk.
even bugs depending on the OS used and plugins currently installed,
so use it at your own risk.


As designed in this example, only one pair of input/output values fails
Expand Down