Skip to content

gh-81340: Use copy_file_range in shutil.copyfile copy functions #93152

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.

Sign up for GitHub

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
zooba merged 9 commits into from
Feb 3, 2025
Merged

gh-81340: Use copy_file_range in shutil.copyfile copy functions #93152

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
985159a
Move determining a block size for copying to a separate function
illia-v May 23, 2022
e4fa33b
Add copy-on-write support to shutil
illia-v May 23, 2022
47b0834
Update comments in `_determine_linux_fastcopy_blocksize`
illia-v May 24, 2022
474859c
Update docs to link to `copy_file_range` as a Python function
illia-v May 24, 2022
1846895
Merge branch 'main' into fix-issue-81340
illia-v Jun 5, 2024
41d48d9
Drop the `allow_reflink` argument
illia-v Jun 5, 2024
e8feaca
Remove duplicate change entries from docs
illia-v Jun 5, 2024
dc07a54
Merge branch 'main' into fix-issue-81340
illia-v Dec 28, 2024
cb1dae8
Merge branch 'main' into fix-issue-81340
zooba Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update docs to link to copy_file_range as a Python function
  • Loading branch information
@illia-v
illia-v committed May 24, 2022
commit 474859cbe12ded1bee2b96b1e81d4dd5696fdf5f
12 changes: 6 additions & 6 deletions Doc/library/shutil.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ Directory and files operations
a new symbolic link will be created instead of copying the
file *src* points to.

*allow_reflink* enables copy-on-write on supported Linux filesystems.
The :c:func:`copy_file_range` system call is used internally when
*allow_reflink* enables copy-on-write on supported Linux filesystems (e.g.,
btrfs and XFS). :func:`os.copy_file_range` is used internally when
*allow_reflink* is true.

.. audit-event:: shutil.copyfile src,dst shutil.copyfile
Expand Down Expand Up @@ -176,8 +176,8 @@ Directory and files operations
is true and *src* is a symbolic link, *dst* will be a copy of
the file *src* refers to.

*allow_reflink* enables copy-on-write on supported Linux filesystems.
The :c:func:`copy_file_range` system call is used internally when
*allow_reflink* enables copy-on-write on supported Linux filesystems (e.g.,
btrfs and XFS). :func:`os.copy_file_range` is used internally when
*allow_reflink* is true.

:func:`~shutil.copy` copies the file data and the file's permission
Expand Down Expand Up @@ -217,8 +217,8 @@ Directory and files operations
it can; :func:`copy2` never raises an exception because it
cannot preserve file metadata.

*allow_reflink* enables copy-on-write on supported Linux filesystems.
The :c:func:`copy_file_range` system call is used internally when
*allow_reflink* enables copy-on-write on supported Linux filesystems (e.g.,
btrfs and XFS). :func:`os.copy_file_range` is used internally when
*allow_reflink* is true.

:func:`copy2` uses :func:`copystat` to copy the file metadata.
Expand Down
11 changes: 6 additions & 5 deletions Misc/NEWS.d/next/Library/2022-05-23-21-23-29.gh-issue-81340.D11RkZ.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Use the :c:func:`copy_file_range` Linux system call in :func:`shutil.copy`,
:func:`shutil.copy2`, and :func:`shutil.copyfile` functions by default. The
system call gives filesystems an opportunity to implement the use of
copy-on-write or server-side copy. The functions have a new *allow_reflink*
argument to control the functionality. Patch by Illia Volochii.
Use :func:`os.copy_file_range` in :func:`shutil.copy`, :func:`shutil.copy2`,
and :func:`shutil.copyfile` functions by default. An underlying Linux system
call gives filesystems an opportunity to implement the use of copy-on-write
(in case of btrfs and XFS) or server-side copy (in the case of NFS.) The
functions have a new *allow_reflink* argument to control the functionality.
Patch by Illia Volochii.