fastapi Architecture Docs
Home / File/ test_skip_defaults.py — fastapi Source File

test_skip_defaults.py — fastapi Source File

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

File python FastAPI Applications 4 imports 10 functions 4 classes

Entity Profile

Dependency Diagram

graph LR
  561a8d75_9a7b_7a3e_8473_2d7c2acd5963["test_skip_defaults.py"]
  0dda2280_3359_8460_301c_e98c77e78185["typing"]
  561a8d75_9a7b_7a3e_8473_2d7c2acd5963 --> 0dda2280_3359_8460_301c_e98c77e78185
  534f6e44_61b8_3c38_8b89_6934a6df9802["__init__.py"]
  561a8d75_9a7b_7a3e_8473_2d7c2acd5963 --> 534f6e44_61b8_3c38_8b89_6934a6df9802
  a7c04dee_ee23_5891_b185_47ff6bed036d["testclient.py"]
  561a8d75_9a7b_7a3e_8473_2d7c2acd5963 --> a7c04dee_ee23_5891_b185_47ff6bed036d
  6913fbd4_39df_d14b_44bb_522e99b65b90["pydantic"]
  561a8d75_9a7b_7a3e_8473_2d7c2acd5963 --> 6913fbd4_39df_d14b_44bb_522e99b65b90
  style 561a8d75_9a7b_7a3e_8473_2d7c2acd5963 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

from typing import Optional

from fastapi import FastAPI
from fastapi.testclient import TestClient
from pydantic import BaseModel

app = FastAPI()


class SubModel(BaseModel):
    a: Optional[str] = "foo"


class Model(BaseModel):
    x: Optional[int] = None
    sub: SubModel


class ModelSubclass(Model):
    y: int
    z: int = 0
    w: Optional[int] = None


class ModelDefaults(BaseModel):
    w: Optional[str] = None
    x: Optional[str] = None
    y: str = "y"
    z: str = "z"


@app.get("/", response_model=Model, response_model_exclude_unset=True)
def get_root() -> ModelSubclass:
    return ModelSubclass(sub={}, y=1, z=0)


@app.get(
    "/exclude_unset", response_model=ModelDefaults, response_model_exclude_unset=True
)
def get_exclude_unset() -> ModelDefaults:
    return ModelDefaults(x=None, y="y")


@app.get(
    "/exclude_defaults",
    response_model=ModelDefaults,
    response_model_exclude_defaults=True,
)
def get_exclude_defaults() -> ModelDefaults:
    return ModelDefaults(x=None, y="y")


@app.get(
    "/exclude_none", response_model=ModelDefaults, response_model_exclude_none=True
)
def get_exclude_none() -> ModelDefaults:
    return ModelDefaults(x=None, y="y")


@app.get(
    "/exclude_unset_none",
    response_model=ModelDefaults,
    response_model_exclude_unset=True,
    response_model_exclude_none=True,
)
def get_exclude_unset_none() -> ModelDefaults:
    return ModelDefaults(x=None, y="y")


client = TestClient(app)


def test_return_defaults():
    response = client.get("/")
    assert response.json() == {"sub": {}}


def test_return_exclude_unset():
    response = client.get("/exclude_unset")
    assert response.json() == {"x": None, "y": "y"}


def test_return_exclude_defaults():
    response = client.get("/exclude_defaults")
    assert response.json() == {}


def test_return_exclude_none():
    response = client.get("/exclude_none")
    assert response.json() == {"y": "y", "z": "z"}


def test_return_exclude_unset_none():
    response = client.get("/exclude_unset_none")
    assert response.json() == {"y": "y"}

Domain

Subdomains

Functions

Classes

Dependencies

Source

Frequently Asked Questions

What does test_skip_defaults.py do?
test_skip_defaults.py is a source file in the fastapi codebase, written in python. It belongs to the FastAPI domain, Applications subdomain.
What functions are defined in test_skip_defaults.py?
test_skip_defaults.py defines 10 function(s): get_exclude_defaults, get_exclude_none, get_exclude_unset, get_exclude_unset_none, get_root, test_return_defaults, test_return_exclude_defaults, test_return_exclude_none, test_return_exclude_unset, test_return_exclude_unset_none.
What does test_skip_defaults.py depend on?
test_skip_defaults.py imports 4 module(s): __init__.py, pydantic, testclient.py, typing.
Where is test_skip_defaults.py in the architecture?
test_skip_defaults.py is located at tests/test_skip_defaults.py (domain: FastAPI, subdomain: Applications, directory: tests).

Analyze Your Own Codebase

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

Try Supermodel Free