Docs: Note lifetime of temporary directories #8038
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I wasn't sure if the comment was best placed directly in the reference or in the pydocs. |
bluetech
reviewed
Nov 21, 2020
src/_pytest/tmpdir.py
Outdated
| @@ -172,7 +172,9 @@ def _mk_tmp(request: FixtureRequest, factory: TempPathFactory) -> Path: | |||
| def tmpdir(tmp_path: Path) -> py.path.local: | |||
| """Return a temporary directory path object which is unique to each test | |||
| function invocation, created as a sub directory of the base temporary | |||
| directory. | |||
| directory. After 3 sessions the directory will be removed by default, | |||
There was a problem hiding this comment.
I think it would be good to describe the situation in a bit more detail. I suggest writing this in a separate paragraph:
The temporary directory is created under a base directory. By default, a
new base 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`.
WDYT?
There was a problem hiding this comment.
Thanks, that sounds good, particularly the extra link! I updated with 6a25660. I left out your first sentence since I thought it was sufficiently covered in the existing docs, but I can be persuaded otherwise.
Explanation: The default handling of these lifetimes is done in `tmpdir.TempPathFactory.getbasetemp`, which passes `keep=3` to `pathlib.make_numbered_dir_with_cleanup`. GH Issue: pytest-dev#8036
matthewhughes934
force-pushed
the
note-tmpdir-lifetime
branch
from
352d93e
to
6a25660
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation: The default handling of these lifetimes is done in
tmpdir.TempPathFactory.getbasetemp, which passeskeep=3topathlib.make_numbered_dir_with_cleanup.GH Issue: #8036