Made some changes in relation to the first PyTest conversion sprint (#6548)

* Made some changes in relation to the first PyTest conversion sprint

* review comments and corrections

Author: ESadek-MO

docs/src/developers_guide/contributing_pytest_conversions.rst

@@ -40,8 +40,9 @@ 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("...")``. ``mocker`` is a fixture, and can be passed into functions.
+#. Check for references to ``with mock.patch("...")``. These should be replaced with either
+   ``with mocker.patch("...")`` or ``mocker.patch("..."). Note that ``mocker`` is a fixture,
+   and should be passed into relevant functions as a parameter.
 #. 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
@@ -73,4 +74,6 @@ Common Translations
      - ``with pytest.raises(cls, match=msg_re):``
    * - ``mock.patch(...)``
      - ``mocker.patch(...)``
+   * - ``with mock.patch.object(...) as x:``
+     - ``x = mocker.patch.object(...)``
 

lib/iris/tests/__init__.py

@@ -7,6 +7,9 @@
 .. note:: This module needs to control the matplotlib backend, so it
           **must** be imported before ``matplotlib.pyplot``.
 
+.. note:: Iris is currently undergoing conversion to PyTest. Once that
+          conversion is complete, this module will eventually be removed.
+
 The primary class for this module is :class:`IrisTest`.
 
 """

lib/iris/tests/_shared_utils.py

@@ -2,7 +2,10 @@
 #
 # This file is part of Iris and is released under the BSD license.
 # See LICENSE in the root of the repository for full licensing details.
-"""Provides testing capabilities and customisations specific to Iris."""
+"""Provides testing capabilities and customisations specific to Iris.
+
+.. note:: This module is private, and is subject to change on short notice.
+"""
 
 import collections
 from collections.abc import Mapping