mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-09 19:38:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

GH-125413: Revert addition of pathlib.Path.scandir() method (#127377)

Browse source 
Remove documentation for `pathlib.Path.scandir()`, and rename the method to
`_scandir()`. In the private pathlib ABCs, make `iterdir()` abstract and
call it from `_scandir()`.

It's not worthwhile to add this method at the moment - see discussion:
https://discuss.python.org/t/ergonomics-of-new-pathlib-path-scandir/71721

Co-authored-by: Steve Dower <steve.dower@microsoft.com>
This commit is contained in:
Barney Gale 2024-12-05 21:39:43 +00:00 • committed by GitHub
parent f4f530804b
commit 8b3cccf3f9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 22 additions and 85 deletions
Download patch file Download diff file Expand all files Collapse all files

15
Lib/pathlib/_abc.py
View file

@ -94,7 +94,7 @@ class PathGlobber(_GlobberBase):
lexists = operator.methodcaller('exists', follow_symlinks=False)
add_slash = operator.methodcaller('joinpath', '')
scandir = operator.methodcaller('scandir')
scandir = operator.methodcaller('_scandir')
@staticmethod
def concat_path(path, text):
@ -632,13 +632,14 @@ class PathBase(PurePathBase):
with self.open(mode='w', encoding=encoding, errors=errors, newline=newline) as f:
return f.write(data)
def scandir(self):
"""Yield os.DirEntry objects of the directory contents.
def _scandir(self):
"""Yield os.DirEntry-like objects of the directory contents.
The children are yielded in arbitrary order, and the
special entries '.' and '..' are not included.
"""
raise UnsupportedOperation(self._unsupported_msg('scandir()'))
import contextlib
return contextlib.nullcontext(self.iterdir())
def iterdir(self):
"""Yield path objects of the directory contents.
@ -646,9 +647,7 @@ class PathBase(PurePathBase):
The children are yielded in arbitrary order, and the
special entries '.' and '..' are not included.
"""
with self.scandir() as entries:
names = [entry.name for entry in entries]
return map(self.joinpath, names)
raise UnsupportedOperation(self._unsupported_msg('iterdir()'))
def _glob_selector(self, parts, case_sensitive, recurse_symlinks):
if case_sensitive is None:
@ -698,7 +697,7 @@ class PathBase(PurePathBase):
if not top_down:
paths.append((path, dirnames, filenames))
try:
with path.scandir() as entries:
with path._scandir() as entries:
for entry in entries:
name = entry.name
try: