gh-142302: Fix mkstemp() documentation: clarify file descriptor inheritance behavior #142338
+13
−7
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.
Description
Fixes the misleading documentation for
tempfile.mkstemp()regarding file descriptor inheritance.The current documentation states "The file descriptor is not inherited by child processes," which is incomplete and misleading.
What was wrong
The file descriptor created by
mkstemp()is inherited by child processes created viafork(). The close-on-exec flag (O_CLOEXEC), when available, only prevents inheritance acrossexec()calls, notfork()calls.Changes made
Updated the documentation to accurately describe the inheritance behavior:
O_CLOEXEConly affectsexec()callsTesting
Verified the documentation builds correctly:
cd Doc make htmlRelated Issue
Fixes #142302
📚 Documentation preview 📚: https://cpython-previews--142338.org.readthedocs.build/