Skip to content

Support HEAD for static routes #2491

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
AbduazizZiyodov wants to merge 8 commits into
base: master
Choose a base branch
from
+23 −12
Open

Support HEAD for static routes #2491

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c0ffe93
feat: in static route disable methods other than GET & POST. Do not o…
AbduazizZiyodov Jul 19, 2025
3312731
Merge branch 'master' into static-route-head-sp
AbduazizZiyodov Jul 20, 2025
172ae78
Merge branch 'master' into static-route-head-sp
AbduazizZiyodov Jul 21, 2025
9346069
Merge branch 'master' into static-route-head-sp
AbduazizZiyodov Jul 24, 2025
17907d5
Merge branch 'master' into static-route-head-sp
AbduazizZiyodov Oct 5, 2025
f77c12c
Merge branch 'falconry:master' into static-route-head-sp
AbduazizZiyodov Nov 1, 2025
5012c16
Merge branch 'master' into static-route-head-sp
AbduazizZiyodov Dec 27, 2025
4b3551c
feat: adjust _open_file function to do only stat for HEAD requests
AbduazizZiyodov Dec 27, 2025
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
35 changes: 23 additions & 12 deletions falcon/routing/static.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,28 @@
from falcon import Response


def _open_file(file_path: str | Path) -> tuple[io.BufferedReader, os.stat_result]:
"""Open a file for a static file request and read file stat.
def _open_and_stat_file(
file_path: str | Path, only_stat: bool = False
) -> tuple[io.BufferedReader, os.stat_result]:
"""Open(optionally) a file for a static file request and read file stat.

Args:
file_path (Union[str, Path]): Path to the file to open.
Returns:
tuple: Tuple of (BufferedReader, stat_result).
"""
fh: io.BufferedReader | None = None
try:
fh = io.open(file_path, 'rb') # noqa: UP020
st = os.fstat(fh.fileno())
except OSError:
if fh is not None:
fh.close()
raise falcon.HTTPNotFound()

if only_stat:
st, fh = os.stat(file_path), io.BufferedReader(io.BytesIO())
else:
try:
fh = io.open(file_path, 'rb') # noqa: UP020
st = os.fstat(fh.fileno())
except OSError:
if fh is not None:
fh.close()
raise falcon.HTTPNotFound()
return fh, st


Expand Down Expand Up @@ -232,6 +238,9 @@ def __call__(self, req: Request, resp: Response, **kw: Any) -> None:
resp.set_header('Content-Length', '0')
return

if req.method not in ('GET', 'HEAD'):
raise falcon.HTTPMethodNotAllowed(('GET', 'HEAD'))

without_prefix = req.path[len(self._prefix) :]

# NOTE(kgriffs): Check surrounding whitespace and strip trailing
Expand Down Expand Up @@ -260,13 +269,15 @@ def __call__(self, req: Request, resp: Response, **kw: Any) -> None:
if '..' in file_path or not file_path.startswith(self._directory):
raise falcon.HTTPNotFound()

only_stat = req.method == 'HEAD'

if self._fallback_filename is None:
fh, st = _open_file(file_path)
fh, st = _open_and_stat_file(file_path, only_stat)
else:
try:
fh, st = _open_file(file_path)
fh, st = _open_and_stat_file(file_path, only_stat)
except falcon.HTTPNotFound:
fh, st = _open_file(self._fallback_filename)
fh, st = _open_and_stat_file(self._fallback_filename, only_stat)
file_path = self._fallback_filename

etag = f'{int(st.st_mtime):x}-{st.st_size:x}'
Expand Down
Loading