Skip to content

web: Update docstrings for prepare and on_finish #3490

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.

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
merged 1 commit into from
Apr 28, 2025
Merged
Changes from all commits
Commits
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
15 changes: 10 additions & 5 deletions tornado/web.py
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,8 @@ def prepare(self) -> Optional[Awaitable[None]]:
"""Called at the beginning of a request before `get`/`post`/etc.

Override this method to perform common initialization regardless
of the request method.
of the request method. There is no guarantee that ``prepare`` will
be called if an error occurs that is handled by the framework.

Asynchronous support: Use ``async def`` or decorate this method with
`.gen.coroutine` to make it asynchronous.
Expand All @@ -299,10 +300,14 @@ def prepare(self) -> Optional[Awaitable[None]]:
def on_finish(self) -> None:
"""Called after the end of a request.

Override this method to perform cleanup, logging, etc.
This method is a counterpart to `prepare`. ``on_finish`` may
not produce any output, as it is called after the response
has been sent to the client.
Override this method to perform cleanup, logging, etc. This method is primarily intended as
a counterpart to `prepare`. However, there are a few error cases where ``on_finish`` may be
called when ``prepare`` has not. (These are considered bugs and may be fixed in the future,
but for now you may need to check to see if the initialization work done in ``prepare`` has
occurred)

``on_finish`` may not produce any output, as it is called after the response has been sent
to the client.
"""
pass

Expand Down