mirror of
https://github.com/python/cpython.git
synced 2025-09-26 18:29:57 +00:00
GH-125413: Move pathlib.Path.copy() implementation alongside Path.info (#129856)
Move pathlib's private `CopyReader`, `LocalCopyReader`, `CopyWriter` and `LocalCopyWriter` classes into `pathlib._os`, where they can live alongside the low-level copying functions (`copyfileobj()` etc) and high-level path querying interface (`PathInfo`). This sets the stage for merging `LocalCopyReader` into `PathInfo`. No change of behaviour; just moving some code around.
This commit is contained in:
Barney Gale
GitHub
parent
d5796e64e0
commit
c88dacb391
3 changed files with 297 additions and 300 deletions
|
|
@ -7,7 +7,7 @@ import sys
|
|||
from errno import *
|
||||
from glob import _StringGlobber, _no_recurse_symlinks
|
||||
from itertools import chain
|
||||
from stat import S_IMODE, S_ISDIR, S_ISREG, S_ISSOCK, S_ISBLK, S_ISCHR, S_ISFIFO
|
||||
from stat import S_ISDIR, S_ISREG, S_ISSOCK, S_ISBLK, S_ISCHR, S_ISFIFO
|
||||
from _collections_abc import Sequence
|
||||
|
||||
try:
|
||||
|
|
@ -19,8 +19,8 @@ try:
|
|||
except ImportError:
|
||||
grp = None
|
||||
|
||||
from pathlib._os import copyfile, PathInfo, DirEntryInfo
|
||||
from pathlib._abc import CopyReader, CopyWriter, JoinablePath, ReadablePath, WritablePath
|
||||
from pathlib._os import LocalCopyReader, LocalCopyWriter, PathInfo, DirEntryInfo
|
||||
from pathlib._abc import JoinablePath, ReadablePath, WritablePath
|
||||
|
||||
|
||||
__all__ = [
|
||||
|
|
@ -65,141 +65,6 @@ class _PathParents(Sequence):
|
|||
return "<{}.parents>".format(type(self._path).__name__)
|
||||
|
||||
|
||||
class _LocalCopyReader(CopyReader):
|
||||
"""This object implements the "read" part of copying local paths. Don't
|
||||
try to construct it yourself.
|
||||
"""
|
||||
__slots__ = ()
|
||||
|
||||
_readable_metakeys = {'mode', 'times_ns'}
|
||||
if hasattr(os.stat_result, 'st_flags'):
|
||||
_readable_metakeys.add('flags')
|
||||
if hasattr(os, 'listxattr'):
|
||||
_readable_metakeys.add('xattrs')
|
||||
_readable_metakeys = frozenset(_readable_metakeys)
|
||||
|
||||
def _read_metadata(self, metakeys, *, follow_symlinks=True):
|
||||
metadata = {}
|
||||
if 'mode' in metakeys or 'times_ns' in metakeys or 'flags' in metakeys:
|
||||
st = self._path.stat(follow_symlinks=follow_symlinks)
|
||||
if 'mode' in metakeys:
|
||||
metadata['mode'] = S_IMODE(st.st_mode)
|
||||
if 'times_ns' in metakeys:
|
||||
metadata['times_ns'] = st.st_atime_ns, st.st_mtime_ns
|
||||
if 'flags' in metakeys:
|
||||
metadata['flags'] = st.st_flags
|
||||
if 'xattrs' in metakeys:
|
||||
try:
|
||||
metadata['xattrs'] = [
|
||||
(attr, os.getxattr(self._path, attr, follow_symlinks=follow_symlinks))
|
||||
for attr in os.listxattr(self._path, follow_symlinks=follow_symlinks)]
|
||||
except OSError as err:
|
||||
if err.errno not in (EPERM, ENOTSUP, ENODATA, EINVAL, EACCES):
|
||||
raise
|
||||
return metadata
|
||||
|
||||
|
||||
class _LocalCopyWriter(CopyWriter):
|
||||
"""This object implements the "write" part of copying local paths. Don't
|
||||
try to construct it yourself.
|
||||
"""
|
||||
__slots__ = ()
|
||||
|
||||
_writable_metakeys = _LocalCopyReader._readable_metakeys
|
||||
|
||||
def _write_metadata(self, metadata, *, follow_symlinks=True):
|
||||
def _nop(*args, ns=None, follow_symlinks=None):
|
||||
pass
|
||||
|
||||
if follow_symlinks:
|
||||
# use the real function if it exists
|
||||
def lookup(name):
|
||||
return getattr(os, name, _nop)
|
||||
else:
|
||||
# use the real function only if it exists
|
||||
# *and* it supports follow_symlinks
|
||||
def lookup(name):
|
||||
fn = getattr(os, name, _nop)
|
||||
if fn in os.supports_follow_symlinks:
|
||||
return fn
|
||||
return _nop
|
||||
|
||||
times_ns = metadata.get('times_ns')
|
||||
if times_ns is not None:
|
||||
lookup("utime")(self._path, ns=times_ns, follow_symlinks=follow_symlinks)
|
||||
# We must copy extended attributes before the file is (potentially)
|
||||
# chmod()'ed read-only, otherwise setxattr() will error with -EACCES.
|
||||
xattrs = metadata.get('xattrs')
|
||||
if xattrs is not None:
|
||||
for attr, value in xattrs:
|
||||
try:
|
||||
os.setxattr(self._path, attr, value, follow_symlinks=follow_symlinks)
|
||||
except OSError as e:
|
||||
if e.errno not in (EPERM, ENOTSUP, ENODATA, EINVAL, EACCES):
|
||||
raise
|
||||
mode = metadata.get('mode')
|
||||
if mode is not None:
|
||||
try:
|
||||
lookup("chmod")(self._path, mode, follow_symlinks=follow_symlinks)
|
||||
except NotImplementedError:
|
||||
# if we got a NotImplementedError, it's because
|
||||
# * follow_symlinks=False,
|
||||
# * lchown() is unavailable, and
|
||||
# * either
|
||||
# * fchownat() is unavailable or
|
||||
# * fchownat() doesn't implement AT_SYMLINK_NOFOLLOW.
|
||||
# (it returned ENOSUP.)
|
||||
# therefore we're out of options--we simply cannot chown the
|
||||
# symlink. give up, suppress the error.
|
||||
# (which is what shutil always did in this circumstance.)
|
||||
pass
|
||||
flags = metadata.get('flags')
|
||||
if flags is not None:
|
||||
try:
|
||||
lookup("chflags")(self._path, flags, follow_symlinks=follow_symlinks)
|
||||
except OSError as why:
|
||||
if why.errno not in (EOPNOTSUPP, ENOTSUP):
|
||||
raise
|
||||
|
||||
if copyfile:
|
||||
# Use fast OS routine for local file copying where available.
|
||||
def _create_file(self, source, metakeys):
|
||||
"""Copy the given file to the given target."""
|
||||
try:
|
||||
source = os.fspath(source)
|
||||
except TypeError:
|
||||
if not isinstance(source, WritablePath):
|
||||
raise
|
||||
super()._create_file(source, metakeys)
|
||||
else:
|
||||
copyfile(source, os.fspath(self._path))
|
||||
|
||||
if os.name == 'nt':
|
||||
# Windows: symlink target might not exist yet if we're copying several
|
||||
# files, so ensure we pass is_dir to os.symlink().
|
||||
def _create_symlink(self, source, metakeys):
|
||||
"""Copy the given symlink to the given target."""
|
||||
self._path.symlink_to(source.readlink(), source.is_dir())
|
||||
if metakeys:
|
||||
metadata = source._copy_reader._read_metadata(metakeys, follow_symlinks=False)
|
||||
if metadata:
|
||||
self._write_metadata(metadata, follow_symlinks=False)
|
||||
|
||||
def _ensure_different_file(self, source):
|
||||
"""
|
||||
Raise OSError(EINVAL) if both paths refer to the same file.
|
||||
"""
|
||||
try:
|
||||
if not self._path.samefile(source):
|
||||
return
|
||||
except (OSError, ValueError):
|
||||
return
|
||||
err = OSError(EINVAL, "Source and target are the same file")
|
||||
err.filename = str(source)
|
||||
err.filename2 = str(self._path)
|
||||
raise err
|
||||
|
||||
|
||||
class PurePath(JoinablePath):
|
||||
"""Base class for manipulating paths without I/O.
|
||||
|
||||
|
|
@ -1190,8 +1055,8 @@ class Path(WritablePath, ReadablePath, PurePath):
|
|||
os.replace(self, target)
|
||||
return self.with_segments(target)
|
||||
|
||||
_copy_reader = property(_LocalCopyReader)
|
||||
_copy_writer = property(_LocalCopyWriter)
|
||||
_copy_reader = property(LocalCopyReader)
|
||||
_copy_writer = property(LocalCopyWriter)
|
||||
|
||||
def move(self, target):
|
||||
"""
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue