summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/_pytest/tmpdir.py10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/_pytest/tmpdir.py b/src/_pytest/tmpdir.py
index e62d08db5..08c445e2b 100644
--- a/src/_pytest/tmpdir.py
+++ b/src/_pytest/tmpdir.py
@@ -199,6 +199,11 @@ def tmpdir(tmp_path: Path) -> py.path.local:
function invocation, created as a sub directory of the base temporary
directory.
+ By default, a new base temporary directory is created each test session,
+ and old bases are removed after 3 sessions, to aid in debugging. If
+ ``--basetemp`` is used then it is cleared each session. See :ref:`base
+ temporary directory`.
+
The returned object is a `py.path.local`_ path object.
.. _`py.path.local`: https://py.readthedocs.io/en/latest/path.html
@@ -212,6 +217,11 @@ def tmp_path(request: FixtureRequest, tmp_path_factory: TempPathFactory) -> Path
function invocation, created as a sub directory of the base temporary
directory.
+ By default, a new base temporary directory is created each test session,
+ and old bases are removed after 3 sessions, to aid in debugging. If
+ ``--basetemp`` is used then it is cleared each session. See :ref:`base
+ temporary directory`.
+
The returned object is a :class:`pathlib.Path` object.
"""