Skip to content

[3.11] gh-51574: Document behaviour of mkdtemp on 3.11 and lower #103844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 27, 2023

Conversation

AlexWaygood
Copy link
Member

A bug has been fixed in 3.12 where mkdtemp does not return an absolute path if a relative path is supplied to the dir argument (#94612). However, the bugfix is not suitable to be backported, meaning the bug will not be fixed in the 3.11 branch and lower.

We should note the existing behaviour in the docs for the 3.11 branch, so that users are not misinformed about what will happen when the function is called.

Closes #51574

@kj7rrv
Copy link
Contributor

kj7rrv commented Apr 25, 2023

In the docs for 3.12, should we add "Changed in version 3.12: the return value is always an absolute path, even if dir is relative"? Would that be a separate PR?

@AlexWaygood
Copy link
Member Author

AlexWaygood commented Apr 25, 2023

In the docs for 3.12, should we add "Changed in version 3.12: the return value is always an absolute path, even if dir is relative"? Would that be a separate PR?

The note has already been added to the docs for 3.12 as part of #94612: see https://github.com/python/cpython/pull/94612/files#diff-cd9226095497c724772acabf76ce71e39ae2d6ae5cee2a27c9ba22ac541b2f1eR295-R297

The online docs have yet to be updated; they're built every few hours, I think.

@JelleZijlstra JelleZijlstra merged commit d20758c into python:3.11 Apr 27, 2023
@AlexWaygood AlexWaygood deleted the mkdtemp-docs-311 branch April 27, 2023 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.11 only security fixes docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants