Skip to content

GH-73991: Support preserving metadata in pathlib.Path.copy() #120806

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 15 commits into from
Jul 6, 2024
Merged

GH-73991: Support preserving metadata in pathlib.Path.copy() #120806

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
ff025ff
GH-73991: Support preserving metadata in `pathlib.Path.copy()`
barneygale Jun 20, 2024
720a0e0
Test timestamps
barneygale Jun 20, 2024
c14d16f
Typos
barneygale Jun 21, 2024
f54925c
Use code from shutil.
barneygale Jun 21, 2024
b05256b
Tighten conditions.
barneygale Jun 21, 2024
ee2cd35
Merge branch 'main' into copy-metadata
barneygale Jun 23, 2024
da6cd5b
Merge branch 'main' into copy-metadata
barneygale Jun 24, 2024
211b861
Undo shutil changes.
barneygale Jun 24, 2024
8129c46
Remove some code that's now unused.
barneygale Jun 24, 2024
15cc3db
docstrings, re-order methods.
barneygale Jun 27, 2024
89dfad5
Skip retrieving metadata if we're unable to set it on the target.
barneygale Jun 27, 2024
d312469
Merge branch 'main' into copy-metadata
barneygale Jul 3, 2024
547a3c3
Fix double lookup.
barneygale Jul 3, 2024
f584643
Rename methods.
barneygale Jul 3, 2024
3206a89
Tweaks
barneygale Jul 3, 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
Tweaks
  • Loading branch information
@barneygale
barneygale committed Jul 3, 2024
commit 3206a89bdd42b517568731708c3c306eb9ea3adb
19 changes: 10 additions & 9 deletions Lib/pathlib/_abc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -784,26 +784,27 @@ def mkdir(self, mode=0o777, parents=False, exist_ok=False):
# Metadata keys supported by this path type.
_readable_metadata = _writable_metadata = frozenset()

def _read_metadata(self, keys, follow_symlinks):
def _read_metadata(self, keys=None, *, follow_symlinks=True):
"""
Returns path metadata as a dict with string keys.
"""
raise UnsupportedOperation(self._unsupported_msg('_read_metadata()'))

def _write_metadata(self, metadata, follow_symlinks):
def _write_metadata(self, metadata, *, follow_symlinks=True):
"""
Sets path metadata from the given dict with string keys.
"""
raise UnsupportedOperation(self._unsupported_msg('_write_metadata()'))

def _copy_metadata(self, target, follow_symlinks):
def _copy_metadata(self, target, *, follow_symlinks=True):
"""
Copies metadata (permissions, timestamps, etc) from this path to target.
"""
metadata_keys = self._readable_metadata & target._writable_metadata
if metadata_keys:
metadata = self._read_metadata(metadata_keys, follow_symlinks)
target._write_metadata(metadata, follow_symlinks)
# Metadata types supported by both source and target.
keys = self._readable_metadata & target._writable_metadata
if keys:
metadata = self._read_metadata(keys, follow_symlinks=follow_symlinks)
target._write_metadata(metadata, follow_symlinks=follow_symlinks)

def copy(self, target, *, follow_symlinks=True, preserve_metadata=False):
"""
Expand All @@ -818,7 +819,7 @@ def copy(self, target, *, follow_symlinks=True, preserve_metadata=False):
if not follow_symlinks and self.is_symlink():
target.symlink_to(self.readlink())
if preserve_metadata:
self._copy_metadata(target, False)
self._copy_metadata(target, follow_symlinks=False)
return
with self.open('rb') as source_f:
try:
Expand All @@ -832,7 +833,7 @@ def copy(self, target, *, follow_symlinks=True, preserve_metadata=False):
else:
raise
if preserve_metadata:
self._copy_metadata(target, True)
self._copy_metadata(target)

def copytree(self, target, *, follow_symlinks=True, dirs_exist_ok=False,
ignore=None, on_error=None):
Expand Down
6 changes: 4 additions & 2 deletions Lib/pathlib/_os.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,10 +189,12 @@ def copyfileobj(source_f, target_f):
file_metadata_keys = frozenset(file_metadata_keys)


def read_file_metadata(path, keys, follow_symlinks):
def read_file_metadata(path, keys=None, *, follow_symlinks=True):
"""
Returns local path metadata as a dict with string keys.
"""
if keys is None:
keys = file_metadata_keys
assert keys.issubset(file_metadata_keys)
result = {}
for key in keys:
Expand All @@ -215,7 +217,7 @@ def read_file_metadata(path, keys, follow_symlinks):
return result


def write_file_metadata(path, metadata, follow_symlinks):
def write_file_metadata(path, metadata, *, follow_symlinks=True):
"""
Sets local path metadata from the given dict with string keys.
"""
Expand Down