Skip to content

GH-73991: Add pathlib.Path.copy() #119058

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
barneygale merged 19 commits into from
Jun 14, 2024
Merged

GH-73991: Add pathlib.Path.copy() #119058

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
7128a7a
GH-73991: Add `pathlib.Path.copy()` method.
barneygale May 14, 2024
4cf63e6
Fix tests, add news
barneygale May 15, 2024
e83f53e
Comment on use of `shutil.copy2()`
barneygale May 15, 2024
092a0e0
Use fcopyfile() / sendfile() where available.
barneygale May 15, 2024
ac37fa5
Merge branch 'main' into gh-73991-copy
barneygale Jun 3, 2024
a9a216e
Drop usage of shutil
barneygale Jun 3, 2024
cbf6174
Fix tests, add FICLONE support
barneygale Jun 3, 2024
738f8ed
Move to `pathlib._os`.
barneygale Jun 4, 2024
83cb4dc
Move a bit more code into _os.
barneygale Jun 4, 2024
0aceea2
Handle classes that subclass PathBase and os.PathLike but not Path.
barneygale Jun 4, 2024
eec9e7f
Reword
barneygale Jun 4, 2024
fddcd73
Add test for directory symlinks
barneygale Jun 5, 2024
c683c2d
Fix handling of symlinks to directories on Windows.
barneygale Jun 5, 2024
0be714f
Expose _winapi.COPY_FILE_DIRECTORY
barneygale Jun 5, 2024
5169b9a
Test copying empty file.
barneygale Jun 5, 2024
7c9c893
Apply suggestions from code review
barneygale Jun 6, 2024
0e1e4f1
Drop `follow_symlinks` argument for now.
barneygale Jun 6, 2024
8434924
Merge branch 'main' into gh-73991-copy
barneygale Jun 12, 2024
d8cb6c6
Merge branch 'main' into gh-73991-copy
barneygale Jun 13, 2024
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
Fix handling of symlinks to directories on Windows.
  • Loading branch information
@barneygale
barneygale committed Jun 5, 2024
commit c683c2dfa72330801fa35de355020f1fa7807126
11 changes: 3 additions & 8 deletions Lib/pathlib/_local.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,9 @@
import grp
except ImportError:
grp = None
try:
import _winapi
except ImportError:
_winapi = None

from ._abc import UnsupportedOperation, PurePathBase, PathBase
from ._os import copyfile


__all__ = [
Expand Down Expand Up @@ -784,7 +781,7 @@ def mkdir(self, mode=0o777, parents=False, exist_ok=False):
if not exist_ok or not self.is_dir():
raise

if hasattr(_winapi, 'CopyFile2'):
if copyfile:
def copy(self, target, follow_symlinks=True):
"""
Copy the contents of this file to the given target. If this file is a
Expand All @@ -799,9 +796,7 @@ def copy(self, target, follow_symlinks=True):
# Use generic implementation from PathBase.
return PathBase.copy(self, target, follow_symlinks=follow_symlinks)
raise

flags = 0 if follow_symlinks else _winapi.COPY_FILE_COPY_SYMLINK
_winapi.CopyFile2(os.fspath(self), target, flags)
copyfile(os.fspath(self), target, follow_symlinks)

def chmod(self, mode, *, follow_symlinks=True):
"""
Expand Down
34 changes: 34 additions & 0 deletions Lib/pathlib/_os.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

from errno import EBADF, EOPNOTSUPP, ETXTBSY, EXDEV
import os
import stat
import sys
try:
import fcntl
Expand All @@ -13,6 +14,10 @@
import posix
except ImportError:
posix = None
try:
import _winapi
except ImportError:
_winapi = None


def get_copy_blocksize(infd):
Expand Down Expand Up @@ -87,6 +92,35 @@ def copyfd(source_fd, target_fd):
copyfd = None


if _winapi and hasattr(_winapi, 'CopyFile2'):
def is_dirlink(path):
try:
st = os.lstat(path)
except OSError:
Comment thread
barneygale marked this conversation as resolved.
Outdated
return False
return (st.st_file_attributes & stat.FILE_ATTRIBUTE_DIRECTORY and
st.st_reparse_tag == stat.IO_REPARSE_TAG_SYMLINK)

def copyfile(source, target, follow_symlinks):
"""
Copy from one file to another using CopyFile2 (Windows only).
"""
if follow_symlinks:
flags = 0
else:
flags = _winapi.COPY_FILE_COPY_SYMLINK
try:
_winapi.CopyFile2(source, target, flags)
Comment thread
barneygale marked this conversation as resolved.
Outdated
except OSError as err:
# Check for ERROR_ACCESS_DENIED
if err.winerror != 5 or not is_dirlink(source):
raise err
Comment thread
barneygale marked this conversation as resolved.
Outdated
flags |= _winapi.COPY_FILE_DIRECTORY
_winapi.CopyFile2(source, target, flags)
else:
copyfile = None


def copyfileobj(source_f, target_f):
"""
Copy data from file-like object source_f to file-like object target_f.
Expand Down