Skip to content

Document that WebSocketResponse.receive() raises asyncio.TimeoutError #3962

Open
@antonagestam

Description

@antonagestam

To be able to do anything useful with the timeout feature of WebSocketResponse.receive() you will probably want to catch the exceptions that occur. It's currently quite hard to find what exceptions will be raised on timeouts without digging through source code. I suggest documenting the fact.

Related issue: #2906
receive() in the documentation/reference: https://aiohttp.readthedocs.io/en/stable/web_reference.html#aiohttp.web.WebSocketResponse.receive

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    No status

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions