Cannot iter over messages with an explicit decode parameter

[bfontaine]

Hello (again),

The FAQ says that to avoid closing the connection after one message, one should use async for message in websocket instead of message = websocket.recv(), but then how do you pass an explicit decode parameter?
We obviously can’t pass a parameter to __aiter__, but we could add an explicit method like iter_messages that would take this argument.

Something like:

async def iter_messages(self, decode: bool | None = None) -> AsyncIterator[Data]:
    # code from the current __aiter__ implementation, with decode=decode
    try:
        while True:
            yield await self.recv(decode=decode)
    except ConnectionClosedOK:
        return

def __aiter__(self) -> AsyncIterator[Data]:
    return self.iter_messages(decode=decode)

Then if one wanted to explicitely pass a decode argument, they would use:

for message in websocket.iter_messages(decode=...):
    ...

What do you think? If this sounds good to you I can make a PR.

[aaugustin]

You can write an old-style loop, like we did back before we had async iterators:

while True:
    msg = await websocket.recv(decode=...)
    ...

Adding the API you're suggesting would add some API surface and docs complexity for a requirement that is quite an edge case so I'm not immediately sold on the idea of adding it. Consider that a -0.

[bfontaine]

Ok thank you, that’s what I ended up doing:

while True:
    try:
        payload = await ws.recv(decode=False)
    except ConnectionClosedOK:
        return

    ...