Skip to content

GH-117727: Speed up pathlib.Path.iterdir() by using os.scandir() #117728

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 4 commits into from
Apr 12, 2024
Merged

GH-117727: Speed up pathlib.Path.iterdir() by using os.scandir() #117728

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
84534f9
GH-117727: Speed up `pathlib.Path.iterdir()` by using `os.scandir()`
barneygale Apr 10, 2024
fbe636c
Merge branch 'main' into iterdir-scandir
barneygale Apr 11, 2024
81cd7c6
Merge branch 'main' into iterdir-scandir
barneygale Apr 12, 2024
8bec7c8
Remove errant newline
barneygale Apr 12, 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
Next Next commit
GH-117727: Speed up pathlib.Path.iterdir() by using os.scandir() 
Replace use of `os.listdir()` with `os.scandir()`. Forgo setting `_drv`,
`_root` and `_tail_cached`, as these usually aren't needed. Use
`os.DirEntry.path` to set `_str`.
  • Loading branch information
@barneygale
barneygale committed Apr 10, 2024
commit 84534f9df17f8134b0329e43a8cb5d16f9551835
25 changes: 6 additions & 19 deletions Lib/pathlib/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -584,7 +584,12 @@ def iterdir(self):
The children are yielded in arbitrary order, and the
special entries '.' and '..' are not included.
"""
return (self._make_child_relpath(name) for name in os.listdir(self))
root_dir = str(self)
with os.scandir(root_dir) as scandir_it:
paths = [entry.path for entry in scandir_it]
Comment thread
barneygale marked this conversation as resolved.
if root_dir == '.':
paths = map(self._remove_leading_dot, paths)
return map(self._from_parsed_string, paths)

def _scandir(self):
return os.scandir(self)
Expand All @@ -599,24 +604,6 @@ def _make_child_direntry(self, entry):
path._tail_cached = self._tail + [entry.name]
return path

def _make_child_relpath(self, name):
if not name:
return self
path_str = str(self)
tail = self._tail
if tail:
path_str = f'{path_str}{self.parser.sep}{name}'
elif path_str != '.':
path_str = f'{path_str}{name}'
else:
path_str = name
path = self.with_segments(path_str)
path._str = path_str
path._drv = self.drive
path._root = self.root
path._tail_cached = tail + [name]
return path

def glob(self, pattern, *, case_sensitive=None, recurse_symlinks=False):
"""Iterate over this subtree and yield all existing files (of any
kind, including directories) matching the given relative pattern.
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2024-04-10-21-30-37.gh-issue-117727.uAYNVS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Speed up :meth:`pathlib.Path.iterdir` by using :func:`os.scandir`
internally.