gh-142407: Update shutil.rst to clarify copy performance on Windows #142408
+3
−1
Conversation
This file contains hidden or 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
Clarify the behavior of shutil.copyfile and shutil.copy2 on Windows, including buffer size and efficiency.
| On Windows :func:`shutil.copyfile` uses a bigger default buffer size (1 MiB | ||
| instead of 64 KiB) and a :func:`memoryview`-based variant of | ||
| :func:`shutil.copyfileobj` is used. | ||
| :func:`shutil.copyfileobj` is used, which is still read and write in a loop. |
Member
There was a problem hiding this comment.
Suggested change
| :func:`shutil.copyfileobj` is used, which is still read and write in a loop. | |
| :func:`shutil.copyfileobj` is used, which is still reads and writes in a loop. |
Grammar.
Comment on lines
+544
to
+545
| :func:`shutil.copy2` uses native call ``CopyFile2`` on windows and it is the most | ||
| efficient and support copy-on-write, but preserve the metadata. |
Member
There was a problem hiding this comment.
Suggested change
| :func:`shutil.copy2` uses native call ``CopyFile2`` on windows and it is the most | |
| efficient and support copy-on-write, but preserve the metadata. | |
| :func:`shutil.copy2` uses the native ``CopyFile2`` call on Windows, which is the most | |
| efficient method, supports copy-on-write, and preserves metadata. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Clarify the behavior of efficiency of shutil.copyfile and shutil.copy2 on Windows.
Fixs: #142407
📚 Documentation preview 📚: https://cpython-previews--142408.org.readthedocs.build/