GH-142407: Doc: Clarify shutil.copyfile() does not use CopyFile2 on Windows #144354
+11
−3
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.
The current documentation for
shutilimplies that all copy functions benefit from fast kernel-space copying on Windows via theCopyFile2API. However,shutil.copyfile()is an exception — it still uses a userspace read/write loop.This PR clarifies that:
shutil.copy(),copy2(),copytree(), andmove()useCopyFile2(when available)shutil.copyfile()does not, and remains a buffered userspace copycopy2()overcopyfile()for better performance on Windows when metadata preservation is acceptableThe change has been verified by:
make html(0 warnings)Related to GH-142407.
📚 Documentation preview 📚: https://cpython-previews--144354.org.readthedocs.build/