floraachy
/
pytest2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

document toml use of filterwarnings (#7611) 

and include a demo of toml 'literal strings'

Update doc/en/warnings.rst
Apply suggestion by Ran
Fix linting

Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
This commit is contained in:
Thomas Grainger 2020-08-14 08:08:17 +01:00 committed by GitHub
parent 10f98e1d2f
commit 02c6e4455c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/en/warnings.rst
View File

@ -68,16 +68,30 @@ them into errors:
FAILED test_show_warnings.py::test_one - UserWarning: api v1, should use ... FAILED test_show_warnings.py::test_one - UserWarning: api v1, should use ...
1 failed in 0.12s 1 failed in 0.12s
The same option can be set in the ``pytest.ini`` file using the ``filterwarnings`` ini option. The same option can be set in the ``pytest.ini`` or ``pyproject.toml`` file using the
For example, the configuration below will ignore all user warnings, but will transform ``filterwarnings`` ini option. For example, the configuration below will ignore all
user warnings and specific deprecation warnings matching a regex, but will transform
all other warnings into errors. all other warnings into errors.
.. code-block:: ini .. code-block:: ini
# pytest.ini
[pytest] [pytest]
filterwarnings = filterwarnings =
error error
ignore::UserWarning ignore::UserWarning
ignore:function ham\(\) is deprecated:DeprecationWarning
.. code-block:: toml
# pyproject.toml
[tool.pytest.ini_options]
filterwarnings = [
"error",
"ignore::UserWarning",
# note the use of single quote below to denote "raw" strings in TOML
'ignore:function ham\(\) is deprecated:DeprecationWarning',
]
When a warning matches more than one option in the list, the action for the last matching option When a warning matches more than one option in the list, the action for the last matching option