Skip to content

Add missing prepared method for WebSocketResponse to docs #10988

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
merged 4 commits into from
May 23, 2025
Merged

Add missing prepared method for WebSocketResponse to docs #10988

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
61d8cdd
Adjust changelog message for #6009
bdraco May 23, 2025
5121a58
fix
bdraco May 23, 2025
204ee03
changelog
bdraco May 23, 2025
a9b612d
Update CHANGES/6009.bugfix.rst
bdraco May 23, 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
1 change: 1 addition & 0 deletions CHANGES/10988.bugfix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
6009.bugfix.rst
2 changes: 1 addition & 1 deletion CHANGES/6009.bugfix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Fixed ``WebSocketResponse.prepared`` property to correctly reflect the prepared state, especially during timeout scenarios -- by :user:`bdraco`
Fixed :py:meth:`~aiohttp.web.WebSocketResponse.prepared` property to correctly reflect the prepared state, especially during timeout scenarios -- by :user:`bdraco`
5 changes: 5 additions & 0 deletions docs/web_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1045,6 +1045,11 @@ and :ref:`aiohttp-web-signals` handlers::
of closing.
:const:`~aiohttp.WSMsgType.CLOSE` message has been received from peer.

.. attribute:: prepared

Read-only :class:`bool` property, ``True`` if :meth:`prepare` has
been called, ``False`` otherwise.

.. attribute:: close_code

Read-only property, close code from peer. It is set to ``None`` on
Expand Down
Loading