test_router_sync_generator_lifespan() — fastapi Function Reference

Architecture documentation for the test_router_sync_generator_lifespan() function in test_router_events.py from the fastapi codebase.

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ test_router_sync_generator_lifespan() — fastapi Function Reference

Dependency Diagram

graph TD
  ad15a6ce_7b73_2f23_9dbd_1d769f6a2b0e["test_router_sync_generator_lifespan()"]
  05561238_1d26_3221_b177_440da9d6e710["test_router_events.py"]
  ad15a6ce_7b73_2f23_9dbd_1d769f6a2b0e -->|defined in| 05561238_1d26_3221_b177_440da9d6e710
  style ad15a6ce_7b73_2f23_9dbd_1d769f6a2b0e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

tests/test_router_events.py lines 269–293

def test_router_sync_generator_lifespan(state: State) -> None:
    """Test that a sync generator lifespan works via _wrap_gen_lifespan_context."""
    from collections.abc import Generator

    def lifespan(app: FastAPI) -> Generator[None, None, None]:
        state.app_startup = True
        yield
        state.app_shutdown = True

    app = FastAPI(lifespan=lifespan)  # type: ignore[arg-type]

    @app.get("/")
    def main() -> dict[str, str]:
        return {"message": "Hello World"}

    assert state.app_startup is False
    assert state.app_shutdown is False
    with TestClient(app) as client:
        assert state.app_startup is True
        assert state.app_shutdown is False
        response = client.get("/")
        assert response.status_code == 200, response.text
        assert response.json() == {"message": "Hello World"}
    assert state.app_startup is True
    assert state.app_shutdown is True