FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

GH-73991: Support preserving metadata in `pathlib.Path.copytree()` by barneygale · Pull Request #121438 · python/cpython · GitHub

/ cpython Public

GH-73991: Support preserving metadata in pathlib.Path.copytree() #121438

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 5 commits into from
Jul 20, 2024
+45 −3
Conversation 3 Commits 5 Checks 0 Files changed 3
Merged

GH-73991: Support preserving metadata in pathlib.Path.copytree() #121438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cad8709
GH-73991: Support preserving metadata in `pathlib.Path.copytree()`
barneygale Jul 6, 2024
2470fec
Tweaks
barneygale Jul 6, 2024
1500af7
Fix up xattrs test
barneygale Jul 6, 2024
6cc6cc1
Merge branch 'main' into copytree-preserve-metadata
barneygale Jul 20, 2024
b65a5f3
Merge branch 'main' into copytree-preserve-metadata
AA-Turner Jul 20, 2024
File filter

Filter by extension

Filter by extension .py  (2) .rst  (1) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
10 changes: 9 additions & 1 deletion Doc/library/pathlib.rst
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -1557,7 +1557,8 @@ Copying, renaming and deleting
.. versionadded:: 3.14


.. method:: Path.copytree(target, *, follow_symlinks=True, dirs_exist_ok=False, \
.. method:: Path.copytree(target, *, follow_symlinks=True, \
preserve_metadata=False, dirs_exist_ok=False, \
ignore=None, on_error=None)

Recursively copy this directory tree to the given destination.
Expand All @@ -1566,6 +1567,13 @@ Copying, renaming and deleting
true (the default), the symlink's target is copied. Otherwise, the symlink
is recreated in the destination tree.

If *preserve_metadata* is false (the default), only the directory structure
and file data are guaranteed to be copied. Set *preserve_metadata* to true
to ensure that file and directory permissions, flags, last access and
modification times, and extended attributes are copied where supported.
This argument has no effect on Windows, where metadata is always preserved
when copying.

If the destination is an existing directory and *dirs_exist_ok* is false
(the default), a :exc:`FileExistsError` is raised. Otherwise, the copying
operation will continue if it encounters existing directories, and files
Expand Down
8 changes: 6 additions & 2 deletions Lib/pathlib/_abc.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -835,7 +835,8 @@ def copy(self, target, *, follow_symlinks=True, preserve_metadata=False):
if preserve_metadata:
self._copy_metadata(target)

def copytree(self, target, *, follow_symlinks=True, dirs_exist_ok=False,
def copytree(self, target, *, follow_symlinks=True,
preserve_metadata=False, dirs_exist_ok=False,
ignore=None, on_error=None):
"""
Recursively copy this directory tree to the given destination.
Expand All @@ -851,6 +852,8 @@ def on_error(err):
try:
sources = source_dir.iterdir()
target_dir.mkdir(exist_ok=dirs_exist_ok)
if preserve_metadata:
source_dir._copy_metadata(target_dir)
for source in sources:
if ignore and ignore(source):
continue
Expand All @@ -859,7 +862,8 @@ def on_error(err):
stack.append((source, target_dir.joinpath(source.name)))
else:
source.copy(target_dir.joinpath(source.name),
follow_symlinks=follow_symlinks)
follow_symlinks=follow_symlinks,
preserve_metadata=preserve_metadata)
except OSError as err:
on_error(err)
except OSError as err:
Expand Down
30 changes: 30 additions & 0 deletions Lib/test/test_pathlib/test_pathlib.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -716,6 +716,36 @@ def test_copytree_no_read_permission(self):
self.assertIsInstance(errors[0], PermissionError)
self.assertFalse(target.exists())

def test_copytree_preserve_metadata(self):
base = self.cls(self.base)
source = base / 'dirC'
if hasattr(os, 'chmod'):
os.chmod(source / 'dirD', stat.S_IRWXU | stat.S_IRWXO)
if hasattr(os, 'chflags') and hasattr(stat, 'UF_NODUMP'):
os.chflags(source / 'fileC', stat.UF_NODUMP)
target = base / 'copyA'
source.copytree(target, preserve_metadata=True)

for subpath in ['.', 'fileC', 'dirD', 'dirD/fileD']:
source_st = source.joinpath(subpath).stat()
target_st = target.joinpath(subpath).stat()
self.assertLessEqual(source_st.st_atime, target_st.st_atime)
self.assertLessEqual(source_st.st_mtime, target_st.st_mtime)
self.assertEqual(source_st.st_mode, target_st.st_mode)
if hasattr(source_st, 'st_flags'):
self.assertEqual(source_st.st_flags, target_st.st_flags)

@os_helper.skip_unless_xattr
def test_copytree_preserve_metadata_xattrs(self):
base = self.cls(self.base)
source = base / 'dirC'
source_file = source.joinpath('dirD', 'fileD')
os.setxattr(source_file, b'user.foo', b'42')
target = base / 'copyA'
source.copytree(target, preserve_metadata=True)
target_file = target.joinpath('dirD', 'fileD')
self.assertEqual(os.getxattr(target_file, b'user.foo'), b'42')

def test_resolve_nonexist_relative_issue38671(self):
p = self.cls('non', 'exist')

Expand Down
Back | FazBrowse Home | New Git URL