Skip to content

gh-151788: Speed up http.server directory listing by using os.scandir() #151789

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

Open
mjbommar wants to merge 7 commits into
base: main
Choose a base branch
from
+20 −7
Open

gh-151788: Speed up http.server directory listing by using os.scandir() #151789

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0606d02
gh-151788: Speed up http.server directory listing by using os.scandir
mjbommar Jun 20, 2026
9ba9f68
gh-151788: Address review — OSError fallback and tone down NEWS
mjbommar Jun 20, 2026
57bc982
gh-151788: Address review — drop perf comment, tame NEWS wording
mjbommar Jun 20, 2026
1138200
gh-151788: Fix NEWS entry doc reference
mjbommar Jun 21, 2026
d47f9fb
gh-151788: Apply review suggestions
mjbommar Jun 21, 2026
b1e3fd4
Apply suggested rewrite for name
mjbommar Jun 23, 2026
09f2b44
gh-151788: Normalize line endings to LF in list_directory
mjbommar Jun 23, 2026
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
23 changes: 16 additions & 7 deletions Lib/http/server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -872,13 +872,13 @@ def list_directory(self, path):

"""
try:
list = os.listdir(path)
with os.scandir(path) as it:
entries = sorted(it, key=lambda e: e.name.lower())
except OSError:
self.send_error(
HTTPStatus.NOT_FOUND,
"No permission to list directory")
return None
list.sort(key=lambda a: a.lower())
r = []
displaypath = self.path
displaypath = displaypath.split('#', 1)[0]
Expand All @@ -899,14 +899,23 @@ def list_directory(self, path):
r.append(f'<title>{title}</title>\n</head>')
r.append(f'<body>\n<h1>{title}</h1>')
r.append('<hr>\n<ul>')
for name in list:
fullname = os.path.join(path, name)
displayname = linkname = name
for entry in entries:
displayname = linkname = name = entry.name
# Ignore any OSError raised by the os.DirEntry methods
# to match the behavior of their os.path.* counterpart.
try:
is_dir = entry.is_dir()
except OSError:
is_dir = False
try:
is_symlink = entry.is_symlink()
except OSError:
is_symlink = False
# Append / for directories or @ for symbolic links
if os.path.isdir(fullname):
if is_dir:
Comment thread
picnixz marked this conversation as resolved.
displayname = name + "/"
linkname = name + "/"
if os.path.islink(fullname):
if is_symlink:
displayname = name + "@"
# Note: a link to a directory displays with @ and links with /
r.append('<li><a href="%s">%s</a></li>'
Expand Down
4 changes: 4 additions & 0 deletions Misc/NEWS.d/next/Library/2026-06-20-09-00-26.gh-issue-151788.Gr8IxK.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
:class:`http.server.SimpleHTTPRequestHandler` now relies on :func:`os.scandir`
instead of :func:`os.listdir` to build directory listings, thereby reducing
the total number of :func:`os.stat` calls per entry. This typically improves
directory listing performance on filesystems where such calls are slow.
Loading