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

test_required_str.py — fastapi Source File

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

File python FastAPI Applications 5 imports 6 functions

Entity Profile

Dependency Diagram

graph LR
  8e7c5262_e142_553a_cad6_86527ccd4889["test_required_str.py"]
  0dda2280_3359_8460_301c_e98c77e78185["typing"]
  8e7c5262_e142_553a_cad6_86527ccd4889 --> 0dda2280_3359_8460_301c_e98c77e78185
  5befe8bf_65d1_d058_6b78_4a597a8488e9["pytest"]
  8e7c5262_e142_553a_cad6_86527ccd4889 --> 5befe8bf_65d1_d058_6b78_4a597a8488e9
  534f6e44_61b8_3c38_8b89_6934a6df9802["__init__.py"]
  8e7c5262_e142_553a_cad6_86527ccd4889 --> 534f6e44_61b8_3c38_8b89_6934a6df9802
  a7c04dee_ee23_5891_b185_47ff6bed036d["testclient.py"]
  8e7c5262_e142_553a_cad6_86527ccd4889 --> a7c04dee_ee23_5891_b185_47ff6bed036d
  a7f4e7b0_9725_db90_5cbc_7ca8211b323a["inline_snapshot"]
  8e7c5262_e142_553a_cad6_86527ccd4889 --> a7f4e7b0_9725_db90_5cbc_7ca8211b323a
  style 8e7c5262_e142_553a_cad6_86527ccd4889 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

from typing import Annotated

import pytest
from fastapi import FastAPI, Path
from fastapi.testclient import TestClient
from inline_snapshot import Is, snapshot

app = FastAPI()


@app.get("/required-str/{p}")
async def read_required_str(p: Annotated[str, Path()]):
    return {"p": p}


@app.get("/required-alias/{p_alias}")
async def read_required_alias(p: Annotated[str, Path(alias="p_alias")]):
    return {"p": p}


@app.get("/required-validation-alias/{p_val_alias}")
def read_required_validation_alias(
    p: Annotated[str, Path(validation_alias="p_val_alias")],
):
    return {"p": p}


@app.get("/required-alias-and-validation-alias/{p_val_alias}")
def read_required_alias_and_validation_alias(
    p: Annotated[str, Path(alias="p_alias", validation_alias="p_val_alias")],
):
    return {"p": p}


@pytest.mark.parametrize(
    ("path", "expected_name", "expected_title"),
    [
        pytest.param("/required-str/{p}", "p", "P", id="required-str"),
        pytest.param(
            "/required-alias/{p_alias}", "p_alias", "P Alias", id="required-alias"
        ),
        pytest.param(
            "/required-validation-alias/{p_val_alias}",
            "p_val_alias",
            "P Val Alias",
            id="required-validation-alias",
        ),
        pytest.param(
            "/required-alias-and-validation-alias/{p_val_alias}",
            "p_val_alias",
            "P Val Alias",
            id="required-alias-and-validation-alias",
        ),
    ],
)
def test_schema(path: str, expected_name: str, expected_title: str):
    assert app.openapi()["paths"][path]["get"]["parameters"] == snapshot(
        [
            {
                "required": True,
                "schema": {"title": Is(expected_title), "type": "string"},
                "name": Is(expected_name),
                "in": "path",
            }
        ]
    )


@pytest.mark.parametrize(
    "path",
    [
        pytest.param("/required-str", id="required-str"),
        pytest.param("/required-alias", id="required-alias"),
        pytest.param(
            "/required-validation-alias",
            id="required-validation-alias",
        ),
        pytest.param(
            "/required-alias-and-validation-alias",
            id="required-alias-and-validation-alias",
        ),
    ],
)
def test_success(path: str):
    client = TestClient(app)
    response = client.get(f"{path}/hello")
    assert response.status_code == 200, response.text
    assert response.json() == {"p": "hello"}

Domain

Subdomains

Functions

Dependencies

Source

Frequently Asked Questions

What does test_required_str.py do?
test_required_str.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_required_str.py?
test_required_str.py defines 6 function(s): read_required_alias, read_required_alias_and_validation_alias, read_required_str, read_required_validation_alias, test_schema, test_success.
What does test_required_str.py depend on?
test_required_str.py imports 5 module(s): __init__.py, inline_snapshot, pytest, testclient.py, typing.
Where is test_required_str.py in the architecture?
test_required_str.py is located at tests/test_request_params/test_path/test_required_str.py (domain: FastAPI, subdomain: Applications, directory: tests/test_request_params/test_path).

Analyze Your Own Codebase

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

Try Supermodel Free