Home / File/ test_schema_compat_pydantic_v2.py — fastapi Source File

test_schema_compat_pydantic_v2.py — fastapi Source File

Architecture documentation for test_schema_compat_pydantic_v2.py, a python file in the fastapi codebase. 7 imports, 0 dependents.

File python FastAPI Routing 7 imports 3 functions 3 classes

Entity Profile

Dependency Diagram

graph LR
  fcd29191_bbfc_1eb6_fe6b_ff9e3a695a04["test_schema_compat_pydantic_v2.py"]
  5befe8bf_65d1_d058_6b78_4a597a8488e9["pytest"]
  fcd29191_bbfc_1eb6_fe6b_ff9e3a695a04 --> 5befe8bf_65d1_d058_6b78_4a597a8488e9
  534f6e44_61b8_3c38_8b89_6934a6df9802["__init__.py"]
  fcd29191_bbfc_1eb6_fe6b_ff9e3a695a04 --> 534f6e44_61b8_3c38_8b89_6934a6df9802
  a7c04dee_ee23_5891_b185_47ff6bed036d["testclient.py"]
  fcd29191_bbfc_1eb6_fe6b_ff9e3a695a04 --> a7c04dee_ee23_5891_b185_47ff6bed036d
  a7f4e7b0_9725_db90_5cbc_7ca8211b323a["inline_snapshot"]
  fcd29191_bbfc_1eb6_fe6b_ff9e3a695a04 --> a7f4e7b0_9725_db90_5cbc_7ca8211b323a
  6913fbd4_39df_d14b_44bb_522e99b65b90["pydantic"]
  fcd29191_bbfc_1eb6_fe6b_ff9e3a695a04 --> 6913fbd4_39df_d14b_44bb_522e99b65b90
  8fd7072e_05b0_6622_0f14_e1e357032855["utils.py"]
  fcd29191_bbfc_1eb6_fe6b_ff9e3a695a04 --> 8fd7072e_05b0_6622_0f14_e1e357032855
  712b7268_fde0_3ca8_dc06_7aa9a47c77d9["enum"]
  fcd29191_bbfc_1eb6_fe6b_ff9e3a695a04 --> 712b7268_fde0_3ca8_dc06_7aa9a47c77d9
  style fcd29191_bbfc_1eb6_fe6b_ff9e3a695a04 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import pytest
from fastapi import FastAPI
from fastapi.testclient import TestClient
from inline_snapshot import snapshot
from pydantic import BaseModel

from tests.utils import needs_py310


@pytest.fixture(name="client")
def get_client():
    from enum import Enum

    app = FastAPI()

    class PlatformRole(str, Enum):
        admin = "admin"
        user = "user"

    class OtherRole(str, Enum): ...

    class User(BaseModel):
        username: str
        role: PlatformRole | OtherRole

    @app.get("/users")
    async def get_user() -> User:
        return {"username": "alice", "role": "admin"}

    client = TestClient(app)
    return client


@needs_py310
def test_get(client: TestClient):
    response = client.get("/users")
    assert response.json() == {"username": "alice", "role": "admin"}


@needs_py310
def test_openapi_schema(client: TestClient):
    response = client.get("openapi.json")
    assert response.json() == snapshot(
        {
            "openapi": "3.1.0",
            "info": {"title": "FastAPI", "version": "0.1.0"},
            "paths": {
                "/users": {
                    "get": {
                        "summary": "Get User",
                        "operationId": "get_user_users_get",
                        "responses": {
                            "200": {
                                "description": "Successful Response",
                                "content": {
                                    "application/json": {
                                        "schema": {"$ref": "#/components/schemas/User"}
                                    }
                                },
                            }
                        },
                    }
                }
            },
            "components": {
                "schemas": {
                    "PlatformRole": {
                        "type": "string",
                        "enum": ["admin", "user"],
                        "title": "PlatformRole",
                    },
                    "User": {
                        "properties": {
                            "username": {"type": "string", "title": "Username"},
                            "role": {
                                "anyOf": [
                                    {"$ref": "#/components/schemas/PlatformRole"},
                                    {"enum": [], "title": "OtherRole"},
                                ],
                                "title": "Role",
                            },
                        },
                        "type": "object",
                        "required": ["username", "role"],
                        "title": "User",
                    },
                }
            },
        }
    )

Domain

Subdomains

Dependencies

Frequently Asked Questions

What does test_schema_compat_pydantic_v2.py do?
test_schema_compat_pydantic_v2.py is a source file in the fastapi codebase, written in python. It belongs to the FastAPI domain, Routing subdomain.
What functions are defined in test_schema_compat_pydantic_v2.py?
test_schema_compat_pydantic_v2.py defines 3 function(s): get_client, test_get, test_openapi_schema.
What does test_schema_compat_pydantic_v2.py depend on?
test_schema_compat_pydantic_v2.py imports 7 module(s): __init__.py, enum, inline_snapshot, pydantic, pytest, testclient.py, utils.py.
Where is test_schema_compat_pydantic_v2.py in the architecture?
test_schema_compat_pydantic_v2.py is located at tests/test_schema_compat_pydantic_v2.py (domain: FastAPI, subdomain: Routing, directory: tests).

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free