Skip to content

Commit

Permalink
Merge pull request #8038 from matthewhughes934/note-tmpdir-lifetime
Browse files Browse the repository at this point in the history
Docs: Note lifetime of temporary directories
  • Loading branch information
bluetech committed Dec 5, 2020
2 parents e398c93 + 6a25660 commit 1a1bb61
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/_pytest/tmpdir.py
Expand Up @@ -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
Expand All @@ -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.
"""

Expand Down

0 comments on commit 1a1bb61

Please sign in to comment.