Merge pull request #10140 from pytest-dev/backport-10138-to-7.1.x

[7.1.x] Explicit note that tmpdir fixture is discouraged in favour of tmp_path #9937

AUTHORS

@@ -84,6 +84,7 @@ Damian Skrzypczak
 Daniel Grana
 Daniel Hahler
 Daniel Nuri
+Daniel Sánchez Castelló
 Daniel Wandschneider
 Daniele Procida
 Danielle Jenkins
@@ -185,6 +186,7 @@ Katarzyna Król
 Katerina Koukiou
 Keri Volans
 Kevin Cox
+Kevin Hierro Carrasco
 Kevin J. Foley
 Kian Eliasi
 Kian-Meng Ang
@@ -322,6 +324,7 @@ Taneli Hukkinen
 Tanvi Mehta
 Tarcisio Fischer
 Tareq Alayan
+Tatiana Ovary
 Ted Xiao
 Terje Runde
 Thomas Grainger
@@ -339,6 +342,7 @@ Tyler Goodlet
 Tzu-ping Chung
 Vasily Kuznetsov
 Victor Maryama
+Victor Rodriguez
 Victor Uriarte
 Vidar T. Fauske
 Virgil Dupras

changelog/9937.doc.rst

@@ -0,0 +1 @@
+Explicit note that :fixture:`tmpdir` fixture is discouraged in favour of :fixture:`tmp_path`.

doc/en/how-to/tmp_path.rst

@@ -104,8 +104,10 @@ The ``tmpdir`` and ``tmpdir_factory`` fixtures
 
 The ``tmpdir`` and ``tmpdir_factory`` fixtures are similar to ``tmp_path``
 and ``tmp_path_factory``, but use/return legacy `py.path.local`_ objects
-rather than standard :class:`pathlib.Path` objects. These days, prefer to
-use ``tmp_path`` and ``tmp_path_factory``.
+rather than standard :class:`pathlib.Path` objects.
+
+.. note::
+    These days, it is preferred to use ``tmp_path`` and ``tmp_path_factory``.
 
 See :fixture:`tmpdir <tmpdir>` :fixture:`tmpdir_factory <tmpdir_factory>`
 API for details.

src/_pytest/legacypath.py

@@ -271,7 +271,14 @@ class LegacyTestdirPlugin:
 @attr.s(init=False, auto_attribs=True)
 class TempdirFactory:
     """Backward compatibility wrapper that implements :class:`py.path.local`
-    for :class:`TempPathFactory`."""
+    for :class:`TempPathFactory`.
+
+    .. note::
+        These days, it is preferred to use ``tmp_path_factory``.
+
+        :ref:`About the tmpdir and tmpdir_factory fixtures<tmpdir and tmpdir_factory>`.
+
+    """
 
     _tmppath_factory: TempPathFactory
 
@@ -312,6 +319,11 @@ class LegacyTmpdirPlugin:
 
         The returned object is a `legacy_path`_ object.
 
+        .. note::
+            These days, it is preferred to use ``tmp_path``.
+
+            :ref:`About the tmpdir and tmpdir_factory fixtures<tmpdir and tmpdir_factory>`.
+
         .. _legacy_path: https://py.readthedocs.io/en/latest/path.html
         """
         return legacy_path(tmp_path)

testing/test_doctest.py

@@ -223,7 +223,11 @@ class TestDoctests:
                 "Traceback (most recent call last):",
                 '  File "*/doctest.py", line *, in __run',
                 "    *",
-                *((" *^^^^*",) if sys.version_info >= (3, 11) else ()),
+                *(
+                    (" *^^^^*",)
+                    if (3, 11, 0, "beta", 4) > sys.version_info >= (3, 11)
+                    else ()
+                ),
                 '  File "<doctest test_doctest_unexpected_exception.txt[1]>", line 1, in <module>',
                 "ZeroDivisionError: division by zero",
                 "*/test_doctest_unexpected_exception.txt:2: UnexpectedException",

testing/test_main.py

@@ -47,7 +47,7 @@ def test_wrap_session_notify_exception(ret_exc, pytester: Pytester) -> None:
 
     end_lines = (
         result.stdout.lines[-4:]
-        if sys.version_info >= (3, 11)
+        if (3, 11, 0, "beta", 4) > sys.version_info >= (3, 11)
         else result.stdout.lines[-3:]
     )
 
@@ -57,7 +57,7 @@ def test_wrap_session_notify_exception(ret_exc, pytester: Pytester) -> None:
             'INTERNALERROR>     raise SystemExit("boom")',
             *(
                 ("INTERNALERROR>     ^^^^^^^^^^^^^^^^^^^^^^^^",)
-                if sys.version_info >= (3, 11)
+                if (3, 11, 0, "beta", 4) > sys.version_info >= (3, 11)
                 else ()
             ),
             "INTERNALERROR> SystemExit: boom",
@@ -68,7 +68,7 @@ def test_wrap_session_notify_exception(ret_exc, pytester: Pytester) -> None:
             'INTERNALERROR>     raise ValueError("boom")',
             *(
                 ("INTERNALERROR>     ^^^^^^^^^^^^^^^^^^^^^^^^",)
-                if sys.version_info >= (3, 11)
+                if (3, 11, 0, "beta", 4) > sys.version_info >= (3, 11)
                 else ()
             ),
             "INTERNALERROR> ValueError: boom",