get_client() — fastapi Function Reference

Architecture documentation for the get_client() function in test_filter_pydantic_sub_model_pv2.py from the fastapi codebase.

Function python FastAPI Applications calls 1

Entity Profile

FastAPI→ Applications→ get_client() — fastapi Function Reference

Dependency Diagram

graph TD
  96ec4141_049c_4580_ecb1_6ec52ce2506a["get_client()"]
  2927101d_fb92_c1c6_6e38_9ecdc5507a94["test_filter_pydantic_sub_model_pv2.py"]
  96ec4141_049c_4580_ecb1_6ec52ce2506a -->|defined in| 2927101d_fb92_c1c6_6e38_9ecdc5507a94
  112c401f_f2a5_ed4e_8921_869f01d2baf8["lower_username()"]
  96ec4141_049c_4580_ecb1_6ec52ce2506a -->|calls| 112c401f_f2a5_ed4e_8921_869f01d2baf8
  style 96ec4141_049c_4580_ecb1_6ec52ce2506a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

tests/test_filter_pydantic_sub_model_pv2.py lines 12–48

def get_client():
    from pydantic import BaseModel, ValidationInfo, field_validator

    app = FastAPI()

    class ModelB(BaseModel):
        username: str

    class ModelC(ModelB):
        password: str

    class ModelA(BaseModel):
        name: str
        description: Optional[str] = None
        foo: ModelB
        tags: dict[str, str] = {}

        @field_validator("name")
        def lower_username(cls, name: str, info: ValidationInfo):
            if not name.endswith("A"):
                raise ValueError("name must end in A")
            return name

    async def get_model_c() -> ModelC:
        return ModelC(username="test-user", password="test-password")

    @app.get("/model/{name}", response_model=ModelA)
    async def get_model_a(name: str, model_c=Depends(get_model_c)):
        return {
            "name": name,
            "description": "model-a-desc",
            "foo": model_c,
            "tags": {"key1": "value1", "key2": "value2"},
        }

    client = TestClient(app)
    return client