Skip to content

Commit

Permalink
Add a pytest-unittest translator to the conversion guide (#6213)
Browse files Browse the repository at this point in the history
* added conversion translation section, and fixed mocker reference

* mocker is a fixture

* which can, not which and

* clarified mocker is the fixture, not .patch
  • Loading branch information
ESadek-MO authored Nov 4, 2024
1 parent 5714ed6 commit d1125eb
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion docs/src/developers_guide/contributing_pytest_conversions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Conversion Checklist
#. Check for references to ``@tests``. These should be changed to ``@_shared_utils``.
#. Check for references to ``with mock.patch("...")``. These should be replaced with
``mocker.patch("...")``. Note, ``mocker.patch("...")`` is NOT a context manager.
``mocker.patch("...")``. ``mocker`` is a fixture, and can be passed into functions.
#. Check for ``np.testing.assert...``. This can usually be swapped for
``_shared_utils.assert...``.
#. Check for references to ``super()``. Most test classes used to inherit from
Expand All @@ -54,3 +54,23 @@ Conversion Checklist
#. Check the file against https://github.com/astral-sh/ruff , using ``pip install ruff`` ->
``ruff check --select PT <file>``.

Common Translations
-------------------

.. list-table::
:widths: 50 50
:header-rows: 1

* - ``unittest`` method
- ``pytest`` equivalent
* - ``assertTrue(x)``
- ``assert x``
* - ``assertFalse(x)``
- ``assert not x``
* - ``assertRegex(x, y)``
- ``assert re.match(y, x)``
* - ``assertRaisesRegex(cls, msg_re)``
- ``with pytest.raises(cls, match=msg_re):``
* - ``mock.patch(...)``
- ``mocker.patch(...)``

0 comments on commit d1125eb

Please sign in to comment.