Fixes Register Endpoint for Router of Instance of APIWebSocketRoute

[HideyoshiNakazone]

Versions

Python Version: 3.13

Package Versions:

• fastapi: 0.115.8
• fastapi-utils: 0.8.0

Bug

When creating a Route of type APIWebSocketRoute the following error is thrown:

Traceback (mostrecentcalllast):
File"/home/user/Downloads/teste/main.py", line7, in<module>
@cbv(router)
^^^^^^^^^^^File"/home/user/.cache/pypoetry/virtualenvs/teste-4HLGbWUH-py3.12/lib/python3.12/site-packages/fastapi_utils/cbv.py", line46, indecoratorreturn_cbv(router, cls, *urls)
^^^^^^^^^^^^^^^^^^^^^^^^File"/home/user/.cache/pypoetry/virtualenvs/teste-4HLGbWUH-py3.12/lib/python3.12/site-packages/fastapi_utils/cbv.py", line57, in_cbv_register_endpoints(router, cls, *urls)
File"/home/user/.cache/pypoetry/virtualenvs/teste-4HLGbWUH-py3.12/lib/python3.12/site-packages/fastapi_utils/cbv.py", line112, in_register_endpointsraiseValueError("The provided routes should be of type APIRoute")
ValueError: Theprovidedroutesshouldbeof type APIRoute

This error can be replicated using the following example:

fromfastapiimportFastAPI, WebSocket, WebSocketDisconnect, APIRouterfromfastapi_utils.cbvimportcbvapp=FastAPI()
router=APIRouter()
@cbv(router)classWebSocketCBV:
@router.websocket("/ws")asyncdefwebsocket_endpoint(self, websocket: WebSocket):
awaitwebsocket.accept()
try:
whileTrue:
data=awaitwebsocket.receive_text()
awaitwebsocket.send_text(f"Message text was: {data}")
exceptWebSocketDisconnect:
print("Client disconnected")
app.include_router(router)
if__name__=="__main__":
importuvicornuvicorn.run(app, host="0.0.0.0", port=8000)

Solution

The solution i recommend is to just add the class to instance check of the _register_endpoints function and then add it with a fixed route_method of "WS" since the APIWebSocketRoute does not have a methods atribute.

Thank you very much,
Vitor Hideyoshi.

[HideyoshiNakazone]

Hey @yuval9313, could you or another maintainer take a look in this merge request please?

Thanks a lot,
Vitor Hideyoshi.

[yuval9313]

You are also missing test case

[yuval9313]

I'm sorry, this is really nit pick but I prefer not (condition a or condition b)

[HideyoshiNakazone]

Not a problem at all, i'll happily make the change :)

[HideyoshiNakazone]

You are also missing test case

Hello, I've added a test case in the unittests for the websocket example, it tests the three basic operations on the websocket connection (can accept connection, can send_text, receive_text and can close). I hope this test is okay :)

[kaziiriad]

#367

[HideyoshiNakazone]

Hello @yuval9313 , can we resume this MR? I'd love to have this merged