Clarification on how to clean up `tempfile.mkstemp`

[jugmac00]

Documentation

On tempfile.mkstemp's documentation you can read:

Unlike TemporaryFile(), the user of mkstemp() is responsible for deleting the temporary file when done with it.

mkstemp() returns a tuple containing an OS-level handle to an open file (as would be returned by os.open()) and the absolute pathname of that file, in that order.

After seeing the os.open I thought it would be enough to use os.close on the file handle - which is obviously not the case.

I would suggest to update the first paragraph to something like this:

Unlike TemporaryFile(), the user of mkstemp() is responsible for deleting the temporary file with e.g. os.remove when done with it.

In my perfect world, this paragraph would even briefly mention whether a os.close is necessary before a os.remove, but I am aware the documentation should be kept succint.

Linked PRs

• gh-94543: Clarify the mkstemp documentation #107033
• gh-94543: Improve tempfile.mkstemp documentation about cleanup #154748