test_enforce_once_required_parameter.py — fastapi Source File
Architecture documentation for test_enforce_once_required_parameter.py, a python file in the fastapi codebase. 4 imports, 0 dependents.
Entity Profile
Dependency Diagram
graph LR 89b3e51d_0fbd_0087_6e90_4db54680fe7c["test_enforce_once_required_parameter.py"] 0dda2280_3359_8460_301c_e98c77e78185["typing"] 89b3e51d_0fbd_0087_6e90_4db54680fe7c --> 0dda2280_3359_8460_301c_e98c77e78185 534f6e44_61b8_3c38_8b89_6934a6df9802["__init__.py"] 89b3e51d_0fbd_0087_6e90_4db54680fe7c --> 534f6e44_61b8_3c38_8b89_6934a6df9802 a7c04dee_ee23_5891_b185_47ff6bed036d["testclient.py"] 89b3e51d_0fbd_0087_6e90_4db54680fe7c --> a7c04dee_ee23_5891_b185_47ff6bed036d a7f4e7b0_9725_db90_5cbc_7ca8211b323a["inline_snapshot"] 89b3e51d_0fbd_0087_6e90_4db54680fe7c --> a7f4e7b0_9725_db90_5cbc_7ca8211b323a style 89b3e51d_0fbd_0087_6e90_4db54680fe7c fill:#6366f1,stroke:#818cf8,color:#fff
Relationship Graph
Source Code
from typing import Optional
from fastapi import Depends, FastAPI, Query
from fastapi.testclient import TestClient
from inline_snapshot import snapshot
app = FastAPI()
def _get_client_key(client_id: str = Query(...)) -> str:
return f"{client_id}_key"
def _get_client_tag(client_id: Optional[str] = Query(None)) -> Optional[str]:
if client_id is None:
return None
return f"{client_id}_tag"
@app.get("/foo")
def foo_handler(
client_key: str = Depends(_get_client_key),
client_tag: Optional[str] = Depends(_get_client_tag),
):
return {"client_id": client_key, "client_tag": client_tag}
client = TestClient(app)
def test_get_invalid():
response = client.get("/foo")
assert response.status_code == 422
def test_get_valid():
response = client.get("/foo", params={"client_id": "bar"})
assert response.status_code == 200
assert response.json() == {"client_id": "bar_key", "client_tag": "bar_tag"}
def test_openapi_schema():
response = client.get("/openapi.json")
assert response.status_code == 200, response.text
assert response.json() == snapshot(
{
"components": {
"schemas": {
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array",
}
},
"title": "HTTPValidationError",
"type": "object",
},
"ValidationError": {
"properties": {
"ctx": {"title": "Context", "type": "object"},
"input": {"title": "Input"},
"loc": {
"items": {
"anyOf": [{"type": "string"}, {"type": "integer"}]
},
"title": "Location",
"type": "array",
},
"msg": {"title": "Message", "type": "string"},
"type": {"title": "Error Type", "type": "string"},
},
"required": ["loc", "msg", "type"],
"title": "ValidationError",
"type": "object",
},
}
},
"info": {"title": "FastAPI", "version": "0.1.0"},
"openapi": "3.1.0",
"paths": {
"/foo": {
"get": {
"operationId": "foo_handler_foo_get",
"parameters": [
{
"in": "query",
"name": "client_id",
"required": True,
"schema": {"title": "Client Id", "type": "string"},
},
],
"responses": {
"200": {
"content": {"application/json": {"schema": {}}},
"description": "Successful Response",
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error",
},
},
"summary": "Foo Handler",
}
}
},
}
)
Domain
Subdomains
Functions
Dependencies
- __init__.py
- inline_snapshot
- testclient.py
- typing
Source
Frequently Asked Questions
What does test_enforce_once_required_parameter.py do?
test_enforce_once_required_parameter.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_enforce_once_required_parameter.py?
test_enforce_once_required_parameter.py defines 6 function(s): _get_client_key, _get_client_tag, foo_handler, test_get_invalid, test_get_valid, test_openapi_schema.
What does test_enforce_once_required_parameter.py depend on?
test_enforce_once_required_parameter.py imports 4 module(s): __init__.py, inline_snapshot, testclient.py, typing.
Where is test_enforce_once_required_parameter.py in the architecture?
test_enforce_once_required_parameter.py is located at tests/test_enforce_once_required_parameter.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