Skip to content

Do not process FileNotFoundError in FileResponse, resolves #979 #2856

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
toxadx wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Do not process FileNotFoundError in FileResponse, resolves #979 #2856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6110ddd
Do not process FileNotFoundError in FileResponse, resolves #979
toxadx Jan 29, 2025
cbdb410
Remove not-used exc_info from tests/test_responses.py
toxadx Jan 29, 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
2 changes: 1 addition & 1 deletion starlette/responses.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
stat_result = await anyio.to_thread.run_sync(os.stat, self.path)
self.set_stat_headers(stat_result)
except FileNotFoundError:
raise RuntimeError(f"File at path {self.path} does not exist.")
pass
else:
mode = stat_result.st_mode
Copy link
Owner

@Kludex Kludex Feb 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 lines below, we have another RuntimeError.

Also, this is a breaking change.

Copy link
Contributor

@alex-oleshkevich alex-oleshkevich Mar 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can raise a new exception derived from both RuntimeError and FileNotFoundError. This way we can keep backward compatibility.

class NotFoundError(FileNotFoundError, RuntimeError): ...

if not stat.S_ISREG(mode):
Expand Down
3 changes: 1 addition & 2 deletions tests/test_responses.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,9 +299,8 @@ def test_file_response_with_missing_file_raises_error(tmp_path: Path, test_clien
path = tmp_path / "404.txt"
app = FileResponse(path=path, filename="404.txt")
client = test_client_factory(app)
with pytest.raises(RuntimeError) as exc_info:
with pytest.raises(FileNotFoundError):
client.get("/")
assert "does not exist" in str(exc_info.value)


def test_file_response_with_chinese_filename(tmp_path: Path, test_client_factory: TestClientFactory) -> None:
Expand Down