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

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
Remove duplicate change entries from docs
  • Loading branch information
@illia-v
illia-v committed Jun 5, 2024
commit e8feaca42f23310cc1f01bcb20b67ab38f05f9ef
18 changes: 5 additions & 13 deletions Doc/library/shutil.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,6 @@ Directory and files operations
copy the file more efficiently. See
:ref:`shutil-platform-dependent-efficient-copy-operations` section.

.. versionchanged:: 3.14
Copy-on-write or server-side copy may be used internally on supported
filesystems via :func:`os.copy_file_range`.

.. exception:: SameFileError

This exception is raised if source and destination in :func:`copyfile`
Expand Down Expand Up @@ -191,10 +187,6 @@ Directory and files operations
copy the file more efficiently. See
:ref:`shutil-platform-dependent-efficient-copy-operations` section.

.. versionchanged:: 3.14
Copy-on-write or server-side copy may be used internally on supported
filesystems via :func:`os.copy_file_range`.

.. function:: copy2(src, dst, *, follow_symlinks=True)

Identical to :func:`~shutil.copy` except that :func:`copy2`
Expand Down Expand Up @@ -227,10 +219,6 @@ Directory and files operations
copy the file more efficiently. See
:ref:`shutil-platform-dependent-efficient-copy-operations` section.

.. versionchanged:: 3.14
Copy-on-write or server-side copy may be used internally on supported
filesystems via :func:`os.copy_file_range`.

.. function:: ignore_patterns(*patterns)

This factory function creates a function that can be used as a callable for
Expand Down Expand Up @@ -529,7 +517,7 @@ the use of userspace buffers in Python as in "``outfd.write(infd.read())``".

On macOS `fcopyfile`_ is used to copy the file content (not metadata).

On Linux :func:`os.sendfile` is used.
On Linux :func:`os.copy_file_range` or :func:`os.sendfile` is used.

On Windows :func:`shutil.copyfile` uses a bigger default buffer size (1 MiB
instead of 64 KiB) and a :func:`memoryview`-based variant of
Expand All @@ -541,6 +529,10 @@ file then shutil will silently fallback on using less efficient

.. versionchanged:: 3.8

.. versionchanged:: 3.14
Copy-on-write or server-side copy may be used internally via
:func:`os.copy_file_range` on supported Linux filesystems.

.. _shutil-copytree-example:

copytree example
Expand Down