GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GH-142407: Doc: Clarify shutil.copyfile() does not use CopyFile2 on Windows by CodeSeeed · Pull Request #144354 · python/cpython

Conversation

@CodeSeeed

@CodeSeeed CodeSeeed commented Jan 31, 2026 •
edited by github-actions Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

The current documentation for shutil implies that all copy functions benefit from fast kernel-space copying on Windows via the CopyFile2 API. However, shutil.copyfile() is an exception — it still uses a userspace read/write loop.

This PR clarifies that:

  • shutil.copy(), copy2(), copytree(), and move() use CopyFile2 (when available)
  • shutil.copyfile() does not, and remains a buffered userspace copy
  • Provides practical guidance: prefer copy2() over copyfile() for better performance on Windows when metadata preservation is acceptable

The change has been verified by:

  • Building the docs locally with make html (0 warnings)
  • Confirming the rendered HTML displays the updated text correctly

Related to GH-142407.


📚 Documentation preview 📚: https://cpython-previews--144354.org.readthedocs.build/

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@CodeSeeed
Doc: Clarify that shutil.copyfile() does not use CopyFile2 on Windows
67ef1c2
@CodeSeeed
CodeSeeed requested a review from giampaolo as a code owner January 31, 2026 03:03
@python-cla-bot

python-cla-bot Bot commented Jan 31, 2026 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

CLA signed

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels Jan 31, 2026
@github-project-automation github-project-automation Bot added this to Docs PRs Jan 31, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Jan 31, 2026
@CodeSeeed CodeSeeed changed the title Doc: Clarify that shutil.copyfile() does not use CopyFile2 on Windows GH-142407: Doc: Clarify shutil.copyfile() does not use CopyFile2 on Windows Jan 31, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Jan 31, 2026
Update shutil.rst to clarify copy performance on Windows #142407
Closed
@picnixz

picnixz commented Feb 1, 2026

Copy link
Copy Markdown
Member

There is already #142408. Please do not open PRs if there are already ones that exist for the issue.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@picnixz picnixz closed this Feb 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@giampaolo giampaolo Awaiting requested review from giampaolo giampaolo is a code owner

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Todo

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@CodeSeeed @picnixz
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.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.