From a28d595b4686b074101ba5d9b5cf7498361f75c6 Mon Sep 17 00:00:00 2001 From: Samuel Gaist Date: Sat, 1 Oct 2022 11:44:06 +0200 Subject: [PATCH] doc: add note to help modernize code bases to use pathlib Fixes #10199 --- doc/en/how-to/tmp_path.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/en/how-to/tmp_path.rst b/doc/en/how-to/tmp_path.rst index 99e9e5536..a2f936d33 100644 --- a/doc/en/how-to/tmp_path.rst +++ b/doc/en/how-to/tmp_path.rst @@ -109,6 +109,17 @@ rather than standard :class:`pathlib.Path` objects. .. note:: These days, it is preferred to use ``tmp_path`` and ``tmp_path_factory``. + In order to help modernize old code bases, one can run pytest with the legacypath + plugin disabled: + + .. code-block:: bash + + pytest -p no:legacypath + + This will trigger errors on tests using the legacy paths. + It can also be permanently set as part of the :confval:`addopts` parameter in the + config file. + See :fixture:`tmpdir ` :fixture:`tmpdir_factory ` API for details.