Skip to content

Fixes Register Endpoint for Router of Instance of APIWebSocketRoute #358

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

Closed
HideyoshiNakazone wants to merge 4 commits into from
Closed

Fixes Register Endpoint for Router of Instance of APIWebSocketRoute #358

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bed8cfb
Fixes WebSocket Implementation for Router of Instance of APIWebSocket…
HideyoshiNakazone Feb 3, 2025
a525f9d
Adds TestCase for FastAPIUtils CBV and Websockets
HideyoshiNakazone Feb 24, 2025
a224089
Alters Router Instance Check for Better Readability
HideyoshiNakazone Feb 24, 2025
5e2b161
Adds Simple Receive Test
HideyoshiNakazone Mar 8, 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
16 changes: 10 additions & 6 deletions fastapi_utils/cbv.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

import pydantic
from fastapi import APIRouter, Depends
from fastapi.routing import APIRoute
from fastapi.routing import APIRoute, APIWebSocketRoute
from starlette.routing import Route, WebSocketRoute

PYDANTIC_VERSION = pydantic.VERSION
Expand Down Expand Up @@ -108,12 +108,16 @@ def _register_endpoints(router: APIRouter, cls: Type[Any], *urls: str) -> None:
_allocate_routes_by_method_name(router, url, function_members)
router_roles = []
for route in router.routes:
if not isinstance(route, APIRoute):
raise ValueError("The provided routes should be of type APIRoute")
if not isinstance(route, APIRoute) and not isinstance(route, APIWebSocketRoute):
Copy link
Collaborator

@yuval9313 yuval9313 Feb 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Author

@HideyoshiNakazone HideyoshiNakazone Feb 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

raise ValueError("The provided routes should be of type APIRoute or APIWebSocketRoute")

route_methods: Any = route.methods
cast(Tuple[Any], route_methods)
router_roles.append((route.path, tuple(route_methods)))
if isinstance(route, APIRoute):
route_methods: Any = route.methods
cast(Tuple[Any], route_methods)
router_roles.append((route.path, tuple(route_methods)))

if isinstance(route, APIWebSocketRoute):
router_roles.append((route.path, tuple(["WS"])))

if len(set(router_roles)) != len(router_roles):
raise Exception("An identical route role has been implemented more then once")
Expand Down