tiangolo.fastapi/tests/test_routing_facade_contract.py

from enum import IntEnum

import fastapi.routing as routing
from fastapi.routing_handlers import RouteHandlerConfig
from fastapi.routing_router import APIRouter
from fastapi.routing_routes import APIRoute, APIWebSocketRoute
from fastapi.routing_utils import request_response, websocket_session
from starlette.responses import Response


def test_routing_facade_exports_expected_symbols() -> None:
    expected = {
        "APIRouter",
        "APIRoute",
        "APIWebSocketRoute",
        "RouteHandlerConfig",
        "get_request_handler",
        "get_websocket_app",
        "request_response",
        "websocket_session",
        "_PING_INTERVAL",
    }
    assert expected.issubset(set(routing.__all__))


def test_routing_facade_re_exports_router_classes() -> None:
    assert routing.APIRouter is APIRouter
    assert routing.APIRoute is APIRoute
    assert routing.APIWebSocketRoute is APIWebSocketRoute


def test_routing_facade_re_exports_handler_contracts() -> None:
    assert routing.RouteHandlerConfig is RouteHandlerConfig
    assert routing.request_response is request_response
    assert routing.websocket_session is websocket_session


def test_routing_ping_constant_compatibility() -> None:
    assert isinstance(routing._PING_INTERVAL, (float, int))


class _CreatedStatus(IntEnum):
    CREATED = 201


def _raw_response_endpoint() -> Response:
    return Response(content="ok")


def test_api_route_defaults_and_intenum_status_paths() -> None:
    route = routing.APIRoute(
        "/raw-response",
        _raw_response_endpoint,
        status_code=_CreatedStatus.CREATED,
    )
    assert route.response_model is None
    assert route.status_code == 201
    assert route.methods == {"GET"}