Sync fastapi docs from b5ca1324 on 2025-12-07
Issue Manager / issue-manager (push) Has been cancelled
Build Docs / changes (push) Has been cancelled
Build Docs / langs (push) Has been cancelled
Build Docs / build-docs (push) Has been cancelled
Build Docs / docs-all-green (push) Has been cancelled
Conflict detector / main (push) Has been cancelled
Test Redistribute / test-redistribute (fastapi) (push) Has been cancelled
Test Redistribute / test-redistribute (fastapi-slim) (push) Has been cancelled
Test Redistribute / test-redistribute-alls-green (push) Has been cancelled
Test / lint (push) Has been cancelled
Test / test (pydantic-v1, 3.10) (push) Has been cancelled
Test / test (pydantic-v1, 3.11) (push) Has been cancelled
Test / test (pydantic-v1, 3.13) (push) Has been cancelled
Test / test (pydantic-v1, 3.8) (push) Has been cancelled
Test / test (pydantic-v1, 3.9) (push) Has been cancelled
Test / test (pydantic-v2, 3.10) (push) Has been cancelled
Test / test (pydantic-v2, 3.11) (push) Has been cancelled
Test / test (pydantic-v2, 3.12) (push) Has been cancelled
Test / test (pydantic-v2, 3.13) (push) Has been cancelled
Test / test (pydantic-v2, 3.14) (push) Has been cancelled
Test / test (pydantic-v2, 3.8) (push) Has been cancelled
Test / test (pydantic-v2, 3.9) (push) Has been cancelled
Test / coverage-combine (push) Has been cancelled
Test / check (push) Has been cancelled
Label Approved / label-approved (push) Has been cancelled
FastAPI People Contributors / job (push) Has been cancelled
FastAPI People Sponsors / job (push) Has been cancelled
Update Topic Repos / topic-repos (push) Has been cancelled
FastAPI People / job (push) Has been cancelled
Test / test (pydantic-v1, 3.12) (push) Has been cancelled
Issue Manager / issue-manager (push) Has been cancelled
Build Docs / changes (push) Has been cancelled
Build Docs / langs (push) Has been cancelled
Build Docs / build-docs (push) Has been cancelled
Build Docs / docs-all-green (push) Has been cancelled
Conflict detector / main (push) Has been cancelled
Test Redistribute / test-redistribute (fastapi) (push) Has been cancelled
Test Redistribute / test-redistribute (fastapi-slim) (push) Has been cancelled
Test Redistribute / test-redistribute-alls-green (push) Has been cancelled
Test / lint (push) Has been cancelled
Test / test (pydantic-v1, 3.10) (push) Has been cancelled
Test / test (pydantic-v1, 3.11) (push) Has been cancelled
Test / test (pydantic-v1, 3.13) (push) Has been cancelled
Test / test (pydantic-v1, 3.8) (push) Has been cancelled
Test / test (pydantic-v1, 3.9) (push) Has been cancelled
Test / test (pydantic-v2, 3.10) (push) Has been cancelled
Test / test (pydantic-v2, 3.11) (push) Has been cancelled
Test / test (pydantic-v2, 3.12) (push) Has been cancelled
Test / test (pydantic-v2, 3.13) (push) Has been cancelled
Test / test (pydantic-v2, 3.14) (push) Has been cancelled
Test / test (pydantic-v2, 3.8) (push) Has been cancelled
Test / test (pydantic-v2, 3.9) (push) Has been cancelled
Test / coverage-combine (push) Has been cancelled
Test / check (push) Has been cancelled
Label Approved / label-approved (push) Has been cancelled
FastAPI People Contributors / job (push) Has been cancelled
FastAPI People Sponsors / job (push) Has been cancelled
Update Topic Repos / topic-repos (push) Has been cancelled
FastAPI People / job (push) Has been cancelled
Test / test (pydantic-v1, 3.12) (push) Has been cancelled
This commit is contained in:
@@ -0,0 +1,9 @@
|
||||
from pydantic import BaseModel
|
||||
|
||||
|
||||
def forwardref_method(input: "ForwardRefModel") -> "ForwardRefModel":
|
||||
return ForwardRefModel(x=input.x + 1)
|
||||
|
||||
|
||||
class ForwardRefModel(BaseModel):
|
||||
x: int = 0
|
||||
+209
@@ -0,0 +1,209 @@
|
||||
import http
|
||||
from typing import FrozenSet, List, Optional
|
||||
|
||||
from fastapi import FastAPI, Path, Query
|
||||
|
||||
external_docs = {
|
||||
"description": "External API documentation.",
|
||||
"url": "https://docs.example.com/api-general",
|
||||
}
|
||||
|
||||
app = FastAPI(openapi_external_docs=external_docs)
|
||||
|
||||
|
||||
@app.api_route("/api_route")
|
||||
def non_operation():
|
||||
return {"message": "Hello World"}
|
||||
|
||||
|
||||
def non_decorated_route():
|
||||
return {"message": "Hello World"}
|
||||
|
||||
|
||||
app.add_api_route("/non_decorated_route", non_decorated_route)
|
||||
|
||||
|
||||
@app.get("/text")
|
||||
def get_text():
|
||||
return "Hello World"
|
||||
|
||||
|
||||
@app.get("/path/{item_id}")
|
||||
def get_id(item_id):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/str/{item_id}")
|
||||
def get_str_id(item_id: str):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/int/{item_id}")
|
||||
def get_int_id(item_id: int):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/float/{item_id}")
|
||||
def get_float_id(item_id: float):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/bool/{item_id}")
|
||||
def get_bool_id(item_id: bool):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param/{item_id}")
|
||||
def get_path_param_id(item_id: Optional[str] = Path()):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-minlength/{item_id}")
|
||||
def get_path_param_min_length(item_id: str = Path(min_length=3)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-maxlength/{item_id}")
|
||||
def get_path_param_max_length(item_id: str = Path(max_length=3)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-min_maxlength/{item_id}")
|
||||
def get_path_param_min_max_length(item_id: str = Path(max_length=3, min_length=2)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-gt/{item_id}")
|
||||
def get_path_param_gt(item_id: float = Path(gt=3)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-gt0/{item_id}")
|
||||
def get_path_param_gt0(item_id: float = Path(gt=0)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-ge/{item_id}")
|
||||
def get_path_param_ge(item_id: float = Path(ge=3)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-lt/{item_id}")
|
||||
def get_path_param_lt(item_id: float = Path(lt=3)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-lt0/{item_id}")
|
||||
def get_path_param_lt0(item_id: float = Path(lt=0)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-le/{item_id}")
|
||||
def get_path_param_le(item_id: float = Path(le=3)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-lt-gt/{item_id}")
|
||||
def get_path_param_lt_gt(item_id: float = Path(lt=3, gt=1)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-le-ge/{item_id}")
|
||||
def get_path_param_le_ge(item_id: float = Path(le=3, ge=1)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-lt-int/{item_id}")
|
||||
def get_path_param_lt_int(item_id: int = Path(lt=3)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-gt-int/{item_id}")
|
||||
def get_path_param_gt_int(item_id: int = Path(gt=3)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-le-int/{item_id}")
|
||||
def get_path_param_le_int(item_id: int = Path(le=3)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-ge-int/{item_id}")
|
||||
def get_path_param_ge_int(item_id: int = Path(ge=3)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-lt-gt-int/{item_id}")
|
||||
def get_path_param_lt_gt_int(item_id: int = Path(lt=3, gt=1)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/path/param-le-ge-int/{item_id}")
|
||||
def get_path_param_le_ge_int(item_id: int = Path(le=3, ge=1)):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/query")
|
||||
def get_query(query):
|
||||
return f"foo bar {query}"
|
||||
|
||||
|
||||
@app.get("/query/optional")
|
||||
def get_query_optional(query=None):
|
||||
if query is None:
|
||||
return "foo bar"
|
||||
return f"foo bar {query}"
|
||||
|
||||
|
||||
@app.get("/query/int")
|
||||
def get_query_type(query: int):
|
||||
return f"foo bar {query}"
|
||||
|
||||
|
||||
@app.get("/query/int/optional")
|
||||
def get_query_type_optional(query: Optional[int] = None):
|
||||
if query is None:
|
||||
return "foo bar"
|
||||
return f"foo bar {query}"
|
||||
|
||||
|
||||
@app.get("/query/int/default")
|
||||
def get_query_type_int_default(query: int = 10):
|
||||
return f"foo bar {query}"
|
||||
|
||||
|
||||
@app.get("/query/param")
|
||||
def get_query_param(query=Query(default=None)):
|
||||
if query is None:
|
||||
return "foo bar"
|
||||
return f"foo bar {query}"
|
||||
|
||||
|
||||
@app.get("/query/param-required")
|
||||
def get_query_param_required(query=Query()):
|
||||
return f"foo bar {query}"
|
||||
|
||||
|
||||
@app.get("/query/param-required/int")
|
||||
def get_query_param_required_type(query: int = Query()):
|
||||
return f"foo bar {query}"
|
||||
|
||||
|
||||
@app.get("/enum-status-code", status_code=http.HTTPStatus.CREATED)
|
||||
def get_enum_status_code():
|
||||
return "foo bar"
|
||||
|
||||
|
||||
@app.get("/query/frozenset")
|
||||
def get_query_type_frozenset(query: FrozenSet[int] = Query(...)):
|
||||
return ",".join(map(str, sorted(query)))
|
||||
|
||||
|
||||
@app.get("/query/list")
|
||||
def get_query_list(device_ids: List[int] = Query()) -> List[int]:
|
||||
return device_ids
|
||||
|
||||
|
||||
@app.get("/query/list-default")
|
||||
def get_query_list_default(device_ids: List[int] = Query(default=[])) -> List[int]:
|
||||
return device_ids
|
||||
@@ -0,0 +1,109 @@
|
||||
from typing import Dict
|
||||
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
class Items(BaseModel):
|
||||
items: Dict[str, int]
|
||||
|
||||
|
||||
@app.post("/foo")
|
||||
def foo(items: Items):
|
||||
return items.items
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_additional_properties_post():
|
||||
response = client.post("/foo", json={"items": {"foo": 1, "bar": 2}})
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"foo": 1, "bar": 2}
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/foo": {
|
||||
"post": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
"summary": "Foo",
|
||||
"operationId": "foo_foo_post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {"$ref": "#/components/schemas/Items"}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"Items": {
|
||||
"title": "Items",
|
||||
"required": ["items"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"items": {
|
||||
"title": "Items",
|
||||
"type": "object",
|
||||
"additionalProperties": {"type": "integer"},
|
||||
}
|
||||
},
|
||||
},
|
||||
"ValidationError": {
|
||||
"title": "ValidationError",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"loc": {
|
||||
"title": "Location",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
},
|
||||
"msg": {"title": "Message", "type": "string"},
|
||||
"type": {"title": "Error Type", "type": "string"},
|
||||
},
|
||||
},
|
||||
"HTTPValidationError": {
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,133 @@
|
||||
from typing import Union
|
||||
|
||||
from dirty_equals import IsDict
|
||||
from fastapi import FastAPI
|
||||
from fastapi._compat import PYDANTIC_V2
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel, ConfigDict
|
||||
|
||||
|
||||
class FooBaseModel(BaseModel):
|
||||
if PYDANTIC_V2:
|
||||
model_config = ConfigDict(extra="forbid")
|
||||
else:
|
||||
|
||||
class Config:
|
||||
extra = "forbid"
|
||||
|
||||
|
||||
class Foo(FooBaseModel):
|
||||
pass
|
||||
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.post("/")
|
||||
async def post(
|
||||
foo: Union[Foo, None] = None,
|
||||
):
|
||||
return foo
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_call_invalid():
|
||||
response = client.post("/", json={"foo": {"bar": "baz"}})
|
||||
assert response.status_code == 422
|
||||
|
||||
|
||||
def test_call_valid():
|
||||
response = client.post("/", json={})
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {}
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/": {
|
||||
"post": {
|
||||
"summary": "Post",
|
||||
"operationId": "post__post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": IsDict(
|
||||
{
|
||||
"anyOf": [
|
||||
{"$ref": "#/components/schemas/Foo"},
|
||||
{"type": "null"},
|
||||
],
|
||||
"title": "Foo",
|
||||
}
|
||||
)
|
||||
| IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{"$ref": "#/components/schemas/Foo"}
|
||||
)
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"Foo": {
|
||||
"properties": {},
|
||||
"additionalProperties": False,
|
||||
"type": "object",
|
||||
"title": "Foo",
|
||||
},
|
||||
"HTTPValidationError": {
|
||||
"properties": {
|
||||
"detail": {
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
"type": "array",
|
||||
"title": "Detail",
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"title": "HTTPValidationError",
|
||||
},
|
||||
"ValidationError": {
|
||||
"properties": {
|
||||
"loc": {
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
"type": "array",
|
||||
"title": "Location",
|
||||
},
|
||||
"msg": {"type": "string", "title": "Message"},
|
||||
"type": {"type": "string", "title": "Error Type"},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"title": "ValidationError",
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
from fastapi import APIRouter, FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
router = APIRouter()
|
||||
|
||||
sub_router = APIRouter()
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@sub_router.get("/")
|
||||
def read_item():
|
||||
return {"id": "foo"}
|
||||
|
||||
|
||||
router.include_router(sub_router, prefix="/items")
|
||||
|
||||
app.include_router(router)
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_path_operation():
|
||||
response = client.get("/items/")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"id": "foo"}
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/items/": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
}
|
||||
},
|
||||
"summary": "Read Item",
|
||||
"operationId": "read_item_items__get",
|
||||
}
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
import pytest
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.get("/a", responses={"hello": {"description": "Not a valid additional response"}})
|
||||
async def a():
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
openapi_schema = {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/a": {
|
||||
"get": {
|
||||
"responses": {
|
||||
# this is how one would imagine the openapi schema to be
|
||||
# but since the key is not valid, openapi.utils.get_openapi will raise ValueError
|
||||
"hello": {"description": "Not a valid additional response"},
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
},
|
||||
"summary": "A",
|
||||
"operationId": "a_a_get",
|
||||
}
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
with pytest.raises(ValueError):
|
||||
client.get("/openapi.json")
|
||||
@@ -0,0 +1,152 @@
|
||||
from dirty_equals import IsDict
|
||||
from fastapi import APIRouter, FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel, HttpUrl
|
||||
from starlette.responses import JSONResponse
|
||||
|
||||
|
||||
class CustomModel(BaseModel):
|
||||
a: int
|
||||
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
callback_router = APIRouter(default_response_class=JSONResponse)
|
||||
|
||||
|
||||
@callback_router.get(
|
||||
"{$callback_url}/callback/", responses={400: {"model": CustomModel}}
|
||||
)
|
||||
def callback_route():
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
@app.post("/", callbacks=callback_router.routes)
|
||||
def main_route(callback_url: HttpUrl):
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/": {
|
||||
"post": {
|
||||
"summary": "Main Route",
|
||||
"operationId": "main_route__post",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": IsDict(
|
||||
{
|
||||
"title": "Callback Url",
|
||||
"minLength": 1,
|
||||
"type": "string",
|
||||
"format": "uri",
|
||||
}
|
||||
)
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
| IsDict(
|
||||
{
|
||||
"title": "Callback Url",
|
||||
"maxLength": 2083,
|
||||
"minLength": 1,
|
||||
"type": "string",
|
||||
"format": "uri",
|
||||
}
|
||||
),
|
||||
"name": "callback_url",
|
||||
"in": "query",
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
"callbacks": {
|
||||
"callback_route": {
|
||||
"{$callback_url}/callback/": {
|
||||
"get": {
|
||||
"summary": "Callback Route",
|
||||
"operationId": "callback_route__callback_url__callback__get",
|
||||
"responses": {
|
||||
"400": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/CustomModel"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description": "Bad Request",
|
||||
},
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {"schema": {}}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"CustomModel": {
|
||||
"title": "CustomModel",
|
||||
"required": ["a"],
|
||||
"type": "object",
|
||||
"properties": {"a": {"title": "A", "type": "integer"}},
|
||||
},
|
||||
"HTTPValidationError": {
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
}
|
||||
},
|
||||
},
|
||||
"ValidationError": {
|
||||
"title": "ValidationError",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"loc": {
|
||||
"title": "Location",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
},
|
||||
"msg": {"title": "Message", "type": "string"},
|
||||
"type": {"title": "Error Type", "type": "string"},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
import typing
|
||||
|
||||
from fastapi import FastAPI
|
||||
from fastapi.responses import JSONResponse
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
class JsonApiResponse(JSONResponse):
|
||||
media_type = "application/vnd.api+json"
|
||||
|
||||
|
||||
class Error(BaseModel):
|
||||
status: str
|
||||
title: str
|
||||
|
||||
|
||||
class JsonApiError(BaseModel):
|
||||
errors: typing.List[Error]
|
||||
|
||||
|
||||
@app.get(
|
||||
"/a/{id}",
|
||||
response_class=JsonApiResponse,
|
||||
responses={422: {"description": "Error", "model": JsonApiError}},
|
||||
)
|
||||
async def a(id):
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/a/{id}": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"422": {
|
||||
"description": "Error",
|
||||
"content": {
|
||||
"application/vnd.api+json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/JsonApiError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/vnd.api+json": {"schema": {}}},
|
||||
},
|
||||
},
|
||||
"summary": "A",
|
||||
"operationId": "a_a__id__get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "Id"},
|
||||
"name": "id",
|
||||
"in": "path",
|
||||
}
|
||||
],
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"Error": {
|
||||
"title": "Error",
|
||||
"required": ["status", "title"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {"title": "Status", "type": "string"},
|
||||
"title": {"title": "Title", "type": "string"},
|
||||
},
|
||||
},
|
||||
"JsonApiError": {
|
||||
"title": "JsonApiError",
|
||||
"required": ["errors"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"errors": {
|
||||
"title": "Errors",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/Error"},
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,84 @@
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.get("/a/{id}")
|
||||
async def a(id):
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/a/{id}": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
},
|
||||
"summary": "A",
|
||||
"operationId": "a_a__id__get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "Id"},
|
||||
"name": "id",
|
||||
"in": "path",
|
||||
}
|
||||
],
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"ValidationError": {
|
||||
"title": "ValidationError",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"loc": {
|
||||
"title": "Location",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
},
|
||||
"msg": {"title": "Message", "type": "string"},
|
||||
"type": {"title": "Error Type", "type": "string"},
|
||||
},
|
||||
},
|
||||
"HTTPValidationError": {
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,116 @@
|
||||
import typing
|
||||
|
||||
from fastapi import FastAPI
|
||||
from fastapi.responses import JSONResponse
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
class JsonApiResponse(JSONResponse):
|
||||
media_type = "application/vnd.api+json"
|
||||
|
||||
|
||||
class Error(BaseModel):
|
||||
status: str
|
||||
title: str
|
||||
|
||||
|
||||
class JsonApiError(BaseModel):
|
||||
errors: typing.List[Error]
|
||||
|
||||
|
||||
@app.get(
|
||||
"/a",
|
||||
response_class=JsonApiResponse,
|
||||
responses={500: {"description": "Error", "model": JsonApiError}},
|
||||
)
|
||||
async def a():
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
@app.get("/b", responses={500: {"description": "Error", "model": Error}})
|
||||
async def b():
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/a": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"500": {
|
||||
"description": "Error",
|
||||
"content": {
|
||||
"application/vnd.api+json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/JsonApiError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/vnd.api+json": {"schema": {}}},
|
||||
},
|
||||
},
|
||||
"summary": "A",
|
||||
"operationId": "a_a_get",
|
||||
}
|
||||
},
|
||||
"/b": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"500": {
|
||||
"description": "Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {"$ref": "#/components/schemas/Error"}
|
||||
}
|
||||
},
|
||||
},
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
},
|
||||
"summary": "B",
|
||||
"operationId": "b_b_get",
|
||||
}
|
||||
},
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"Error": {
|
||||
"title": "Error",
|
||||
"required": ["status", "title"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {"title": "Status", "type": "string"},
|
||||
"title": {"title": "Title", "type": "string"},
|
||||
},
|
||||
},
|
||||
"JsonApiError": {
|
||||
"title": "JsonApiError",
|
||||
"required": ["errors"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"errors": {
|
||||
"title": "Errors",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/Error"},
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,177 @@
|
||||
from fastapi import APIRouter, FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel
|
||||
|
||||
|
||||
class ResponseModel(BaseModel):
|
||||
message: str
|
||||
|
||||
|
||||
app = FastAPI()
|
||||
router = APIRouter()
|
||||
|
||||
|
||||
@router.get("/a", responses={501: {"description": "Error 1"}})
|
||||
async def a():
|
||||
return "a"
|
||||
|
||||
|
||||
@router.get(
|
||||
"/b",
|
||||
responses={
|
||||
502: {"description": "Error 2"},
|
||||
"4XX": {"description": "Error with range, upper"},
|
||||
},
|
||||
)
|
||||
async def b():
|
||||
return "b"
|
||||
|
||||
|
||||
@router.get(
|
||||
"/c",
|
||||
responses={
|
||||
"400": {"description": "Error with str"},
|
||||
"5xx": {"description": "Error with range, lower"},
|
||||
"default": {"description": "A default response"},
|
||||
},
|
||||
)
|
||||
async def c():
|
||||
return "c"
|
||||
|
||||
|
||||
@router.get(
|
||||
"/d",
|
||||
responses={
|
||||
"400": {"description": "Error with str"},
|
||||
"5XX": {"model": ResponseModel},
|
||||
"default": {"model": ResponseModel},
|
||||
},
|
||||
)
|
||||
async def d():
|
||||
return "d"
|
||||
|
||||
|
||||
app.include_router(router)
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_a():
|
||||
response = client.get("/a")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == "a"
|
||||
|
||||
|
||||
def test_b():
|
||||
response = client.get("/b")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == "b"
|
||||
|
||||
|
||||
def test_c():
|
||||
response = client.get("/c")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == "c"
|
||||
|
||||
|
||||
def test_d():
|
||||
response = client.get("/d")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == "d"
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/a": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"501": {"description": "Error 1"},
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
},
|
||||
"summary": "A",
|
||||
"operationId": "a_a_get",
|
||||
}
|
||||
},
|
||||
"/b": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"502": {"description": "Error 2"},
|
||||
"4XX": {"description": "Error with range, upper"},
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
},
|
||||
"summary": "B",
|
||||
"operationId": "b_b_get",
|
||||
}
|
||||
},
|
||||
"/c": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"400": {"description": "Error with str"},
|
||||
"5XX": {"description": "Error with range, lower"},
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"default": {"description": "A default response"},
|
||||
},
|
||||
"summary": "C",
|
||||
"operationId": "c_c_get",
|
||||
}
|
||||
},
|
||||
"/d": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"400": {"description": "Error with str"},
|
||||
"5XX": {
|
||||
"description": "Server Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ResponseModel"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"default": {
|
||||
"description": "Default Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ResponseModel"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
"summary": "D",
|
||||
"operationId": "d_d_get",
|
||||
}
|
||||
},
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"ResponseModel": {
|
||||
"title": "ResponseModel",
|
||||
"required": ["message"],
|
||||
"type": "object",
|
||||
"properties": {"message": {"title": "Message", "type": "string"}},
|
||||
}
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,83 @@
|
||||
import pytest
|
||||
from fastapi import Body, FastAPI, Query
|
||||
from fastapi.testclient import TestClient
|
||||
from typing_extensions import Annotated
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.post("/")
|
||||
async def get(
|
||||
x: Annotated[float, Query(allow_inf_nan=True)] = 0,
|
||||
y: Annotated[float, Query(allow_inf_nan=False)] = 0,
|
||||
z: Annotated[float, Query()] = 0,
|
||||
b: Annotated[float, Body(allow_inf_nan=False)] = 0,
|
||||
) -> str:
|
||||
return "OK"
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"value,code",
|
||||
[
|
||||
("-1", 200),
|
||||
("inf", 200),
|
||||
("-inf", 200),
|
||||
("nan", 200),
|
||||
("0", 200),
|
||||
("342", 200),
|
||||
],
|
||||
)
|
||||
def test_allow_inf_nan_param_true(value: str, code: int):
|
||||
response = client.post(f"/?x={value}")
|
||||
assert response.status_code == code, response.text
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"value,code",
|
||||
[
|
||||
("-1", 200),
|
||||
("inf", 422),
|
||||
("-inf", 422),
|
||||
("nan", 422),
|
||||
("0", 200),
|
||||
("342", 200),
|
||||
],
|
||||
)
|
||||
def test_allow_inf_nan_param_false(value: str, code: int):
|
||||
response = client.post(f"/?y={value}")
|
||||
assert response.status_code == code, response.text
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"value,code",
|
||||
[
|
||||
("-1", 200),
|
||||
("inf", 200),
|
||||
("-inf", 200),
|
||||
("nan", 200),
|
||||
("0", 200),
|
||||
("342", 200),
|
||||
],
|
||||
)
|
||||
def test_allow_inf_nan_param_default(value: str, code: int):
|
||||
response = client.post(f"/?z={value}")
|
||||
assert response.status_code == code, response.text
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"value,code",
|
||||
[
|
||||
("-1", 200),
|
||||
("inf", 422),
|
||||
("-inf", 422),
|
||||
("nan", 422),
|
||||
("0", 200),
|
||||
("342", 200),
|
||||
],
|
||||
)
|
||||
def test_allow_inf_nan_body(value: str, code: int):
|
||||
response = client.post("/", json=value)
|
||||
assert response.status_code == code, response.text
|
||||
@@ -0,0 +1,75 @@
|
||||
import pytest
|
||||
from fastapi import Depends, FastAPI, Path
|
||||
from fastapi.param_functions import Query
|
||||
from fastapi.testclient import TestClient
|
||||
from fastapi.utils import PYDANTIC_V2
|
||||
from typing_extensions import Annotated
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
def test_no_annotated_defaults():
|
||||
with pytest.raises(
|
||||
AssertionError, match="Path parameters cannot have a default value"
|
||||
):
|
||||
|
||||
@app.get("/items/{item_id}/")
|
||||
async def get_item(item_id: Annotated[int, Path(default=1)]):
|
||||
pass # pragma: nocover
|
||||
|
||||
with pytest.raises(
|
||||
AssertionError,
|
||||
match=(
|
||||
"`Query` default value cannot be set in `Annotated` for 'item_id'. Set the"
|
||||
" default value with `=` instead."
|
||||
),
|
||||
):
|
||||
|
||||
@app.get("/")
|
||||
async def get(item_id: Annotated[int, Query(default=1)]):
|
||||
pass # pragma: nocover
|
||||
|
||||
|
||||
def test_multiple_annotations():
|
||||
async def dep():
|
||||
pass # pragma: nocover
|
||||
|
||||
@app.get("/multi-query")
|
||||
async def get(foo: Annotated[int, Query(gt=2), Query(lt=10)]):
|
||||
return foo
|
||||
|
||||
with pytest.raises(
|
||||
AssertionError,
|
||||
match=(
|
||||
"Cannot specify `Depends` in `Annotated` and default value"
|
||||
" together for 'foo'"
|
||||
),
|
||||
):
|
||||
|
||||
@app.get("/")
|
||||
async def get2(foo: Annotated[int, Depends(dep)] = Depends(dep)):
|
||||
pass # pragma: nocover
|
||||
|
||||
with pytest.raises(
|
||||
AssertionError,
|
||||
match=(
|
||||
"Cannot specify a FastAPI annotation in `Annotated` and `Depends` as a"
|
||||
" default value together for 'foo'"
|
||||
),
|
||||
):
|
||||
|
||||
@app.get("/")
|
||||
async def get3(foo: Annotated[int, Query(min_length=1)] = Depends(dep)):
|
||||
pass # pragma: nocover
|
||||
|
||||
client = TestClient(app)
|
||||
response = client.get("/multi-query", params={"foo": "5"})
|
||||
assert response.status_code == 200
|
||||
assert response.json() == 5
|
||||
|
||||
response = client.get("/multi-query", params={"foo": "123"})
|
||||
assert response.status_code == 422
|
||||
|
||||
if PYDANTIC_V2:
|
||||
response = client.get("/multi-query", params={"foo": "1"})
|
||||
assert response.status_code == 422
|
||||
@@ -0,0 +1,312 @@
|
||||
import pytest
|
||||
from dirty_equals import IsDict
|
||||
from fastapi import APIRouter, FastAPI, Query
|
||||
from fastapi.testclient import TestClient
|
||||
from typing_extensions import Annotated
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.get("/default")
|
||||
async def default(foo: Annotated[str, Query()] = "foo"):
|
||||
return {"foo": foo}
|
||||
|
||||
|
||||
@app.get("/required")
|
||||
async def required(foo: Annotated[str, Query(min_length=1)]):
|
||||
return {"foo": foo}
|
||||
|
||||
|
||||
@app.get("/multiple")
|
||||
async def multiple(foo: Annotated[str, object(), Query(min_length=1)]):
|
||||
return {"foo": foo}
|
||||
|
||||
|
||||
@app.get("/unrelated")
|
||||
async def unrelated(foo: Annotated[str, object()]):
|
||||
return {"foo": foo}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
foo_is_missing = {
|
||||
"detail": [
|
||||
IsDict(
|
||||
{
|
||||
"loc": ["query", "foo"],
|
||||
"msg": "Field required",
|
||||
"type": "missing",
|
||||
"input": None,
|
||||
}
|
||||
)
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
| IsDict(
|
||||
{
|
||||
"loc": ["query", "foo"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
}
|
||||
)
|
||||
]
|
||||
}
|
||||
foo_is_short = {
|
||||
"detail": [
|
||||
IsDict(
|
||||
{
|
||||
"ctx": {"min_length": 1},
|
||||
"loc": ["query", "foo"],
|
||||
"msg": "String should have at least 1 character",
|
||||
"type": "string_too_short",
|
||||
"input": "",
|
||||
}
|
||||
)
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
| IsDict(
|
||||
{
|
||||
"ctx": {"limit_value": 1},
|
||||
"loc": ["query", "foo"],
|
||||
"msg": "ensure this value has at least 1 characters",
|
||||
"type": "value_error.any_str.min_length",
|
||||
}
|
||||
)
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"path,expected_status,expected_response",
|
||||
[
|
||||
("/default", 200, {"foo": "foo"}),
|
||||
("/default?foo=bar", 200, {"foo": "bar"}),
|
||||
("/required?foo=bar", 200, {"foo": "bar"}),
|
||||
("/required", 422, foo_is_missing),
|
||||
("/required?foo=", 422, foo_is_short),
|
||||
("/multiple?foo=bar", 200, {"foo": "bar"}),
|
||||
("/multiple", 422, foo_is_missing),
|
||||
("/multiple?foo=", 422, foo_is_short),
|
||||
("/unrelated?foo=bar", 200, {"foo": "bar"}),
|
||||
("/unrelated", 422, foo_is_missing),
|
||||
],
|
||||
)
|
||||
def test_get(path, expected_status, expected_response):
|
||||
response = client.get(path)
|
||||
assert response.status_code == expected_status
|
||||
assert response.json() == expected_response
|
||||
|
||||
|
||||
def test_multiple_path():
|
||||
app = FastAPI()
|
||||
|
||||
@app.get("/test1")
|
||||
@app.get("/test2")
|
||||
async def test(var: Annotated[str, Query()] = "bar"):
|
||||
return {"foo": var}
|
||||
|
||||
client = TestClient(app)
|
||||
response = client.get("/test1")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"foo": "bar"}
|
||||
|
||||
response = client.get("/test1", params={"var": "baz"})
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"foo": "baz"}
|
||||
|
||||
response = client.get("/test2")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"foo": "bar"}
|
||||
|
||||
response = client.get("/test2", params={"var": "baz"})
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"foo": "baz"}
|
||||
|
||||
|
||||
def test_nested_router():
|
||||
app = FastAPI()
|
||||
|
||||
router = APIRouter(prefix="/nested")
|
||||
|
||||
@router.get("/test")
|
||||
async def test(var: Annotated[str, Query()] = "bar"):
|
||||
return {"foo": var}
|
||||
|
||||
app.include_router(router)
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
response = client.get("/nested/test")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"foo": "bar"}
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/default": {
|
||||
"get": {
|
||||
"summary": "Default",
|
||||
"operationId": "default_default_get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": False,
|
||||
"schema": {
|
||||
"title": "Foo",
|
||||
"type": "string",
|
||||
"default": "foo",
|
||||
},
|
||||
"name": "foo",
|
||||
"in": "query",
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/required": {
|
||||
"get": {
|
||||
"summary": "Required",
|
||||
"operationId": "required_required_get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {
|
||||
"title": "Foo",
|
||||
"minLength": 1,
|
||||
"type": "string",
|
||||
},
|
||||
"name": "foo",
|
||||
"in": "query",
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/multiple": {
|
||||
"get": {
|
||||
"summary": "Multiple",
|
||||
"operationId": "multiple_multiple_get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {
|
||||
"title": "Foo",
|
||||
"minLength": 1,
|
||||
"type": "string",
|
||||
},
|
||||
"name": "foo",
|
||||
"in": "query",
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/unrelated": {
|
||||
"get": {
|
||||
"summary": "Unrelated",
|
||||
"operationId": "unrelated_unrelated_get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "Foo", "type": "string"},
|
||||
"name": "foo",
|
||||
"in": "query",
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"HTTPValidationError": {
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
}
|
||||
},
|
||||
},
|
||||
"ValidationError": {
|
||||
"title": "ValidationError",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"loc": {
|
||||
"title": "Location",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
},
|
||||
"msg": {"title": "Message", "type": "string"},
|
||||
"type": {"title": "Error Type", "type": "string"},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,25 @@
|
||||
from functools import partial
|
||||
from typing import Optional
|
||||
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
|
||||
def main(some_arg, q: Optional[str] = None):
|
||||
return {"some_arg": some_arg, "q": q}
|
||||
|
||||
|
||||
endpoint = partial(main, "foo")
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
app.get("/")(endpoint)
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_partial():
|
||||
response = client.get("/?q=bar")
|
||||
data = response.json()
|
||||
assert data == {"some_arg": "foo", "q": "bar"}
|
||||
@@ -0,0 +1,203 @@
|
||||
from typing import Any, Dict, List, Union
|
||||
|
||||
from fastapi import FastAPI, UploadFile
|
||||
from fastapi._compat import (
|
||||
Undefined,
|
||||
_get_model_config,
|
||||
get_cached_model_fields,
|
||||
is_scalar_field,
|
||||
is_uploadfile_sequence_annotation,
|
||||
may_v1,
|
||||
)
|
||||
from fastapi._compat.shared import is_bytes_sequence_annotation
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel, ConfigDict
|
||||
from pydantic.fields import FieldInfo
|
||||
|
||||
from .utils import needs_py310, needs_py_lt_314, needs_pydanticv2
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_model_field_default_required():
|
||||
from fastapi._compat import v2
|
||||
|
||||
# For coverage
|
||||
field_info = FieldInfo(annotation=str)
|
||||
field = v2.ModelField(name="foo", field_info=field_info)
|
||||
assert field.default is Undefined
|
||||
|
||||
|
||||
@needs_py_lt_314
|
||||
def test_v1_plain_validator_function():
|
||||
from fastapi._compat import v1
|
||||
|
||||
# For coverage
|
||||
def func(v): # pragma: no cover
|
||||
return v
|
||||
|
||||
result = v1.with_info_plain_validator_function(func)
|
||||
assert result == {}
|
||||
|
||||
|
||||
def test_is_model_field():
|
||||
# For coverage
|
||||
from fastapi._compat import _is_model_field
|
||||
|
||||
assert not _is_model_field(str)
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_get_model_config():
|
||||
# For coverage in Pydantic v2
|
||||
class Foo(BaseModel):
|
||||
model_config = ConfigDict(from_attributes=True)
|
||||
|
||||
foo = Foo()
|
||||
config = _get_model_config(foo)
|
||||
assert config == {"from_attributes": True}
|
||||
|
||||
|
||||
def test_complex():
|
||||
app = FastAPI()
|
||||
|
||||
@app.post("/")
|
||||
def foo(foo: Union[str, List[int]]):
|
||||
return foo
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
response = client.post("/", json="bar")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == "bar"
|
||||
|
||||
response2 = client.post("/", json=[1, 2])
|
||||
assert response2.status_code == 200, response2.text
|
||||
assert response2.json() == [1, 2]
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_propagates_pydantic2_model_config():
|
||||
app = FastAPI()
|
||||
|
||||
class Missing:
|
||||
def __bool__(self):
|
||||
return False
|
||||
|
||||
class EmbeddedModel(BaseModel):
|
||||
model_config = ConfigDict(arbitrary_types_allowed=True)
|
||||
value: Union[str, Missing] = Missing()
|
||||
|
||||
class Model(BaseModel):
|
||||
model_config = ConfigDict(
|
||||
arbitrary_types_allowed=True,
|
||||
)
|
||||
value: Union[str, Missing] = Missing()
|
||||
embedded_model: EmbeddedModel = EmbeddedModel()
|
||||
|
||||
@app.post("/")
|
||||
def foo(req: Model) -> Dict[str, Union[str, None]]:
|
||||
return {
|
||||
"value": req.value or None,
|
||||
"embedded_value": req.embedded_model.value or None,
|
||||
}
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
response = client.post("/", json={})
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"value": None,
|
||||
"embedded_value": None,
|
||||
}
|
||||
|
||||
response2 = client.post(
|
||||
"/", json={"value": "foo", "embedded_model": {"value": "bar"}}
|
||||
)
|
||||
assert response2.status_code == 200, response2.text
|
||||
assert response2.json() == {
|
||||
"value": "foo",
|
||||
"embedded_value": "bar",
|
||||
}
|
||||
|
||||
|
||||
def test_is_bytes_sequence_annotation_union():
|
||||
# For coverage
|
||||
# TODO: in theory this would allow declaring types that could be lists of bytes
|
||||
# to be read from files and other types, but I'm not even sure it's a good idea
|
||||
# to support it as a first class "feature"
|
||||
assert is_bytes_sequence_annotation(Union[List[str], List[bytes]])
|
||||
|
||||
|
||||
def test_is_uploadfile_sequence_annotation():
|
||||
# For coverage
|
||||
# TODO: in theory this would allow declaring types that could be lists of UploadFile
|
||||
# and other types, but I'm not even sure it's a good idea to support it as a first
|
||||
# class "feature"
|
||||
assert is_uploadfile_sequence_annotation(Union[List[str], List[UploadFile]])
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_serialize_sequence_value_with_optional_list():
|
||||
"""Test that serialize_sequence_value handles optional lists correctly."""
|
||||
from fastapi._compat import v2
|
||||
|
||||
field_info = FieldInfo(annotation=Union[List[str], None])
|
||||
field = v2.ModelField(name="items", field_info=field_info)
|
||||
result = v2.serialize_sequence_value(field=field, value=["a", "b", "c"])
|
||||
assert result == ["a", "b", "c"]
|
||||
assert isinstance(result, list)
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
@needs_py310
|
||||
def test_serialize_sequence_value_with_optional_list_pipe_union():
|
||||
"""Test that serialize_sequence_value handles optional lists correctly (with new syntax)."""
|
||||
from fastapi._compat import v2
|
||||
|
||||
field_info = FieldInfo(annotation=list[str] | None)
|
||||
field = v2.ModelField(name="items", field_info=field_info)
|
||||
result = v2.serialize_sequence_value(field=field, value=["a", "b", "c"])
|
||||
assert result == ["a", "b", "c"]
|
||||
assert isinstance(result, list)
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_serialize_sequence_value_with_none_first_in_union():
|
||||
"""Test that serialize_sequence_value handles Union[None, List[...]] correctly."""
|
||||
from fastapi._compat import v2
|
||||
|
||||
field_info = FieldInfo(annotation=Union[None, List[str]])
|
||||
field = v2.ModelField(name="items", field_info=field_info)
|
||||
result = v2.serialize_sequence_value(field=field, value=["x", "y"])
|
||||
assert result == ["x", "y"]
|
||||
assert isinstance(result, list)
|
||||
|
||||
|
||||
@needs_py_lt_314
|
||||
def test_is_pv1_scalar_field():
|
||||
from fastapi._compat import v1
|
||||
|
||||
# For coverage
|
||||
class Model(v1.BaseModel):
|
||||
foo: Union[str, Dict[str, Any]]
|
||||
|
||||
fields = v1.get_model_fields(Model)
|
||||
assert not is_scalar_field(fields[0])
|
||||
|
||||
|
||||
@needs_py_lt_314
|
||||
def test_get_model_fields_cached():
|
||||
from fastapi._compat import v1
|
||||
|
||||
class Model(may_v1.BaseModel):
|
||||
foo: str
|
||||
|
||||
non_cached_fields = v1.get_model_fields(Model)
|
||||
non_cached_fields2 = v1.get_model_fields(Model)
|
||||
cached_fields = get_cached_model_fields(Model)
|
||||
cached_fields2 = get_cached_model_fields(Model)
|
||||
for f1, f2 in zip(cached_fields, cached_fields2):
|
||||
assert f1 is f2
|
||||
|
||||
assert non_cached_fields is not non_cached_fields2
|
||||
assert cached_fields is cached_fields2
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,101 @@
|
||||
import pytest
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
from .utils import needs_pydanticv2
|
||||
|
||||
|
||||
@pytest.fixture(name="client")
|
||||
def get_client(request):
|
||||
separate_input_output_schemas = request.param
|
||||
app = FastAPI(separate_input_output_schemas=separate_input_output_schemas)
|
||||
|
||||
from pydantic import BaseModel, computed_field
|
||||
|
||||
class Rectangle(BaseModel):
|
||||
width: int
|
||||
length: int
|
||||
|
||||
@computed_field
|
||||
@property
|
||||
def area(self) -> int:
|
||||
return self.width * self.length
|
||||
|
||||
@app.get("/")
|
||||
def read_root() -> Rectangle:
|
||||
return Rectangle(width=3, length=4)
|
||||
|
||||
@app.get("/responses", responses={200: {"model": Rectangle}})
|
||||
def read_responses() -> Rectangle:
|
||||
return Rectangle(width=3, length=4)
|
||||
|
||||
client = TestClient(app)
|
||||
return client
|
||||
|
||||
|
||||
@pytest.mark.parametrize("client", [True, False], indirect=True)
|
||||
@pytest.mark.parametrize("path", ["/", "/responses"])
|
||||
@needs_pydanticv2
|
||||
def test_get(client: TestClient, path: str):
|
||||
response = client.get(path)
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"width": 3, "length": 4, "area": 12}
|
||||
|
||||
|
||||
@pytest.mark.parametrize("client", [True, False], indirect=True)
|
||||
@needs_pydanticv2
|
||||
def test_openapi_schema(client: TestClient):
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/": {
|
||||
"get": {
|
||||
"summary": "Read Root",
|
||||
"operationId": "read_root__get",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {"$ref": "#/components/schemas/Rectangle"}
|
||||
}
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
},
|
||||
"/responses": {
|
||||
"get": {
|
||||
"summary": "Read Responses",
|
||||
"operationId": "read_responses_responses_get",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {"$ref": "#/components/schemas/Rectangle"}
|
||||
}
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
},
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"Rectangle": {
|
||||
"properties": {
|
||||
"width": {"type": "integer", "title": "Width"},
|
||||
"length": {"type": "integer", "title": "Length"},
|
||||
"area": {"type": "integer", "title": "Area", "readOnly": True},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["width", "length", "area"],
|
||||
"title": "Rectangle",
|
||||
}
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,95 @@
|
||||
from pathlib import Path
|
||||
from typing import Optional
|
||||
|
||||
from fastapi import APIRouter, FastAPI, File, UploadFile
|
||||
from fastapi.exceptions import HTTPException
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
router = APIRouter()
|
||||
|
||||
|
||||
class ContentSizeLimitMiddleware:
|
||||
"""Content size limiting middleware for ASGI applications
|
||||
Args:
|
||||
app (ASGI application): ASGI application
|
||||
max_content_size (optional): the maximum content size allowed in bytes, None for no limit
|
||||
"""
|
||||
|
||||
def __init__(self, app: APIRouter, max_content_size: Optional[int] = None):
|
||||
self.app = app
|
||||
self.max_content_size = max_content_size
|
||||
|
||||
def receive_wrapper(self, receive):
|
||||
received = 0
|
||||
|
||||
async def inner():
|
||||
nonlocal received
|
||||
message = await receive()
|
||||
if message["type"] != "http.request":
|
||||
return message # pragma: no cover
|
||||
|
||||
body_len = len(message.get("body", b""))
|
||||
received += body_len
|
||||
if received > self.max_content_size:
|
||||
raise HTTPException(
|
||||
422,
|
||||
detail={
|
||||
"name": "ContentSizeLimitExceeded",
|
||||
"code": 999,
|
||||
"message": "File limit exceeded",
|
||||
},
|
||||
)
|
||||
return message
|
||||
|
||||
return inner
|
||||
|
||||
async def __call__(self, scope, receive, send):
|
||||
if scope["type"] != "http" or self.max_content_size is None:
|
||||
await self.app(scope, receive, send)
|
||||
return
|
||||
|
||||
wrapper = self.receive_wrapper(receive)
|
||||
await self.app(scope, wrapper, send)
|
||||
|
||||
|
||||
@router.post("/middleware")
|
||||
def run_middleware(file: UploadFile = File(..., description="Big File")):
|
||||
return {"message": "OK"}
|
||||
|
||||
|
||||
app.include_router(router)
|
||||
app.add_middleware(ContentSizeLimitMiddleware, max_content_size=2**8)
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_custom_middleware_exception(tmp_path: Path):
|
||||
default_pydantic_max_size = 2**16
|
||||
path = tmp_path / "test.txt"
|
||||
path.write_bytes(b"x" * (default_pydantic_max_size + 1))
|
||||
|
||||
with client:
|
||||
with open(path, "rb") as file:
|
||||
response = client.post("/middleware", files={"file": file})
|
||||
assert response.status_code == 422, response.text
|
||||
assert response.json() == {
|
||||
"detail": {
|
||||
"name": "ContentSizeLimitExceeded",
|
||||
"code": 999,
|
||||
"message": "File limit exceeded",
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
def test_custom_middleware_exception_not_raised(tmp_path: Path):
|
||||
path = tmp_path / "test.txt"
|
||||
path.write_bytes(b"<file content>")
|
||||
|
||||
with client:
|
||||
with open(path, "rb") as file:
|
||||
response = client.post("/middleware", files={"file": file})
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"message": "OK"}
|
||||
@@ -0,0 +1,118 @@
|
||||
import pytest
|
||||
from fastapi import APIRouter, FastAPI
|
||||
from fastapi.routing import APIRoute
|
||||
from fastapi.testclient import TestClient
|
||||
from starlette.routing import Route
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
class APIRouteA(APIRoute):
|
||||
x_type = "A"
|
||||
|
||||
|
||||
class APIRouteB(APIRoute):
|
||||
x_type = "B"
|
||||
|
||||
|
||||
class APIRouteC(APIRoute):
|
||||
x_type = "C"
|
||||
|
||||
|
||||
router_a = APIRouter(route_class=APIRouteA)
|
||||
router_b = APIRouter(route_class=APIRouteB)
|
||||
router_c = APIRouter(route_class=APIRouteC)
|
||||
|
||||
|
||||
@router_a.get("/")
|
||||
def get_a():
|
||||
return {"msg": "A"}
|
||||
|
||||
|
||||
@router_b.get("/")
|
||||
def get_b():
|
||||
return {"msg": "B"}
|
||||
|
||||
|
||||
@router_c.get("/")
|
||||
def get_c():
|
||||
return {"msg": "C"}
|
||||
|
||||
|
||||
router_b.include_router(router=router_c, prefix="/c")
|
||||
router_a.include_router(router=router_b, prefix="/b")
|
||||
app.include_router(router=router_a, prefix="/a")
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"path,expected_status,expected_response",
|
||||
[
|
||||
("/a", 200, {"msg": "A"}),
|
||||
("/a/b", 200, {"msg": "B"}),
|
||||
("/a/b/c", 200, {"msg": "C"}),
|
||||
],
|
||||
)
|
||||
def test_get_path(path, expected_status, expected_response):
|
||||
response = client.get(path)
|
||||
assert response.status_code == expected_status
|
||||
assert response.json() == expected_response
|
||||
|
||||
|
||||
def test_route_classes():
|
||||
routes = {}
|
||||
for r in app.router.routes:
|
||||
assert isinstance(r, Route)
|
||||
routes[r.path] = r
|
||||
assert getattr(routes["/a/"], "x_type") == "A" # noqa: B009
|
||||
assert getattr(routes["/a/b/"], "x_type") == "B" # noqa: B009
|
||||
assert getattr(routes["/a/b/c/"], "x_type") == "C" # noqa: B009
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/a/": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
}
|
||||
},
|
||||
"summary": "Get A",
|
||||
"operationId": "get_a_a__get",
|
||||
}
|
||||
},
|
||||
"/a/b/": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
}
|
||||
},
|
||||
"summary": "Get B",
|
||||
"operationId": "get_b_a_b__get",
|
||||
}
|
||||
},
|
||||
"/a/b/c/": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
}
|
||||
},
|
||||
"summary": "Get C",
|
||||
"operationId": "get_c_a_b_c__get",
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,75 @@
|
||||
from typing import Optional
|
||||
|
||||
from fastapi import FastAPI
|
||||
from fastapi._compat import PYDANTIC_V2
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel
|
||||
from typing_extensions import Annotated
|
||||
|
||||
if PYDANTIC_V2:
|
||||
from pydantic import WithJsonSchema
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
class Item(BaseModel):
|
||||
name: str
|
||||
|
||||
if PYDANTIC_V2:
|
||||
description: Annotated[
|
||||
Optional[str], WithJsonSchema({"type": ["string", "null"]})
|
||||
] = None
|
||||
|
||||
model_config = {
|
||||
"json_schema_extra": {
|
||||
"x-something-internal": {"level": 4},
|
||||
}
|
||||
}
|
||||
else:
|
||||
description: Optional[str] = None # type: ignore[no-redef]
|
||||
|
||||
class Config:
|
||||
schema_extra = {
|
||||
"x-something-internal": {"level": 4},
|
||||
}
|
||||
|
||||
|
||||
@app.get("/foo", response_model=Item)
|
||||
def foo():
|
||||
return {"name": "Foo item"}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
item_schema = {
|
||||
"title": "Item",
|
||||
"required": ["name"],
|
||||
"type": "object",
|
||||
"x-something-internal": {
|
||||
"level": 4,
|
||||
},
|
||||
"properties": {
|
||||
"name": {
|
||||
"title": "Name",
|
||||
"type": "string",
|
||||
},
|
||||
"description": {
|
||||
"title": "Description",
|
||||
"type": ["string", "null"] if PYDANTIC_V2 else "string",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
def test_custom_response_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json()["components"]["schemas"]["Item"] == item_schema
|
||||
|
||||
|
||||
def test_response():
|
||||
# For coverage
|
||||
response = client.get("/foo")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"name": "Foo item", "description": None}
|
||||
@@ -0,0 +1,38 @@
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
swagger_ui_oauth2_redirect_url = "/docs/redirect"
|
||||
|
||||
app = FastAPI(swagger_ui_oauth2_redirect_url=swagger_ui_oauth2_redirect_url)
|
||||
|
||||
|
||||
@app.get("/items/")
|
||||
async def read_items():
|
||||
return {"id": "foo"}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_swagger_ui():
|
||||
response = client.get("/docs")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.headers["content-type"] == "text/html; charset=utf-8"
|
||||
assert "swagger-ui-dist" in response.text
|
||||
print(client.base_url)
|
||||
assert (
|
||||
f"oauth2RedirectUrl: window.location.origin + '{swagger_ui_oauth2_redirect_url}'"
|
||||
in response.text
|
||||
)
|
||||
|
||||
|
||||
def test_swagger_ui_oauth2_redirect():
|
||||
response = client.get(swagger_ui_oauth2_redirect_url)
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.headers["content-type"] == "text/html; charset=utf-8"
|
||||
assert "window.opener.swaggerUIRedirectOauth2" in response.text
|
||||
|
||||
|
||||
def test_response():
|
||||
response = client.get("/items/")
|
||||
assert response.json() == {"id": "foo"}
|
||||
@@ -0,0 +1,72 @@
|
||||
import io
|
||||
from pathlib import Path
|
||||
from typing import List
|
||||
|
||||
import pytest
|
||||
from fastapi import FastAPI, UploadFile
|
||||
from fastapi.datastructures import Default
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
def test_upload_file_invalid():
|
||||
with pytest.raises(ValueError):
|
||||
UploadFile.validate("not a Starlette UploadFile")
|
||||
|
||||
|
||||
def test_upload_file_invalid_pydantic_v2():
|
||||
with pytest.raises(ValueError):
|
||||
UploadFile._validate("not a Starlette UploadFile", {})
|
||||
|
||||
|
||||
def test_default_placeholder_equals():
|
||||
placeholder_1 = Default("a")
|
||||
placeholder_2 = Default("a")
|
||||
assert placeholder_1 == placeholder_2
|
||||
assert placeholder_1.value == placeholder_2.value
|
||||
|
||||
|
||||
def test_default_placeholder_bool():
|
||||
placeholder_a = Default("a")
|
||||
placeholder_b = Default("")
|
||||
assert placeholder_a
|
||||
assert not placeholder_b
|
||||
|
||||
|
||||
def test_upload_file_is_closed(tmp_path: Path):
|
||||
path = tmp_path / "test.txt"
|
||||
path.write_bytes(b"<file content>")
|
||||
app = FastAPI()
|
||||
|
||||
testing_file_store: List[UploadFile] = []
|
||||
|
||||
@app.post("/uploadfile/")
|
||||
def create_upload_file(file: UploadFile):
|
||||
testing_file_store.append(file)
|
||||
return {"filename": file.filename}
|
||||
|
||||
client = TestClient(app)
|
||||
with path.open("rb") as file:
|
||||
response = client.post("/uploadfile/", files={"file": file})
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"filename": "test.txt"}
|
||||
|
||||
assert testing_file_store
|
||||
assert testing_file_store[0].file.closed
|
||||
|
||||
|
||||
# For UploadFile coverage, segments copied from Starlette tests
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_upload_file():
|
||||
stream = io.BytesIO(b"data")
|
||||
file = UploadFile(filename="file", file=stream, size=4)
|
||||
assert await file.read() == b"data"
|
||||
assert file.size == 4
|
||||
await file.write(b" and more data!")
|
||||
assert await file.read() == b""
|
||||
assert file.size == 19
|
||||
await file.seek(0)
|
||||
assert await file.read() == b"data and more data!"
|
||||
await file.close()
|
||||
@@ -0,0 +1,57 @@
|
||||
from datetime import datetime, timezone
|
||||
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel
|
||||
|
||||
from .utils import needs_pydanticv1, needs_pydanticv2
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_pydanticv2():
|
||||
from pydantic import field_serializer
|
||||
|
||||
class ModelWithDatetimeField(BaseModel):
|
||||
dt_field: datetime
|
||||
|
||||
@field_serializer("dt_field")
|
||||
def serialize_datetime(self, dt_field: datetime):
|
||||
return dt_field.replace(microsecond=0, tzinfo=timezone.utc).isoformat()
|
||||
|
||||
app = FastAPI()
|
||||
model = ModelWithDatetimeField(dt_field=datetime(2019, 1, 1, 8))
|
||||
|
||||
@app.get("/model", response_model=ModelWithDatetimeField)
|
||||
def get_model():
|
||||
return model
|
||||
|
||||
client = TestClient(app)
|
||||
with client:
|
||||
response = client.get("/model")
|
||||
assert response.json() == {"dt_field": "2019-01-01T08:00:00+00:00"}
|
||||
|
||||
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
@needs_pydanticv1
|
||||
def test_pydanticv1():
|
||||
class ModelWithDatetimeField(BaseModel):
|
||||
dt_field: datetime
|
||||
|
||||
class Config:
|
||||
json_encoders = {
|
||||
datetime: lambda dt: dt.replace(
|
||||
microsecond=0, tzinfo=timezone.utc
|
||||
).isoformat()
|
||||
}
|
||||
|
||||
app = FastAPI()
|
||||
model = ModelWithDatetimeField(dt_field=datetime(2019, 1, 1, 8))
|
||||
|
||||
@app.get("/model", response_model=ModelWithDatetimeField)
|
||||
def get_model():
|
||||
return model
|
||||
|
||||
client = TestClient(app)
|
||||
with client:
|
||||
response = client.get("/model")
|
||||
assert response.json() == {"dt_field": "2019-01-01T08:00:00+00:00"}
|
||||
@@ -0,0 +1,216 @@
|
||||
from typing import Any
|
||||
|
||||
import orjson
|
||||
from fastapi import APIRouter, FastAPI
|
||||
from fastapi.responses import HTMLResponse, JSONResponse, PlainTextResponse
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
|
||||
class ORJSONResponse(JSONResponse):
|
||||
media_type = "application/x-orjson"
|
||||
|
||||
def render(self, content: Any) -> bytes:
|
||||
return orjson.dumps(content)
|
||||
|
||||
|
||||
class OverrideResponse(JSONResponse):
|
||||
media_type = "application/x-override"
|
||||
|
||||
|
||||
app = FastAPI(default_response_class=ORJSONResponse)
|
||||
router_a = APIRouter()
|
||||
router_a_a = APIRouter()
|
||||
router_a_b_override = APIRouter() # Overrides default class
|
||||
router_b_override = APIRouter() # Overrides default class
|
||||
router_b_a = APIRouter()
|
||||
router_b_a_c_override = APIRouter() # Overrides default class again
|
||||
|
||||
|
||||
@app.get("/")
|
||||
def get_root():
|
||||
return {"msg": "Hello World"}
|
||||
|
||||
|
||||
@app.get("/override", response_class=PlainTextResponse)
|
||||
def get_path_override():
|
||||
return "Hello World"
|
||||
|
||||
|
||||
@router_a.get("/")
|
||||
def get_a():
|
||||
return {"msg": "Hello A"}
|
||||
|
||||
|
||||
@router_a.get("/override", response_class=PlainTextResponse)
|
||||
def get_a_path_override():
|
||||
return "Hello A"
|
||||
|
||||
|
||||
@router_a_a.get("/")
|
||||
def get_a_a():
|
||||
return {"msg": "Hello A A"}
|
||||
|
||||
|
||||
@router_a_a.get("/override", response_class=PlainTextResponse)
|
||||
def get_a_a_path_override():
|
||||
return "Hello A A"
|
||||
|
||||
|
||||
@router_a_b_override.get("/")
|
||||
def get_a_b():
|
||||
return "Hello A B"
|
||||
|
||||
|
||||
@router_a_b_override.get("/override", response_class=HTMLResponse)
|
||||
def get_a_b_path_override():
|
||||
return "Hello A B"
|
||||
|
||||
|
||||
@router_b_override.get("/")
|
||||
def get_b():
|
||||
return "Hello B"
|
||||
|
||||
|
||||
@router_b_override.get("/override", response_class=HTMLResponse)
|
||||
def get_b_path_override():
|
||||
return "Hello B"
|
||||
|
||||
|
||||
@router_b_a.get("/")
|
||||
def get_b_a():
|
||||
return "Hello B A"
|
||||
|
||||
|
||||
@router_b_a.get("/override", response_class=HTMLResponse)
|
||||
def get_b_a_path_override():
|
||||
return "Hello B A"
|
||||
|
||||
|
||||
@router_b_a_c_override.get("/")
|
||||
def get_b_a_c():
|
||||
return "Hello B A C"
|
||||
|
||||
|
||||
@router_b_a_c_override.get("/override", response_class=OverrideResponse)
|
||||
def get_b_a_c_path_override():
|
||||
return {"msg": "Hello B A C"}
|
||||
|
||||
|
||||
router_b_a.include_router(
|
||||
router_b_a_c_override, prefix="/c", default_response_class=HTMLResponse
|
||||
)
|
||||
router_b_override.include_router(router_b_a, prefix="/a")
|
||||
router_a.include_router(router_a_a, prefix="/a")
|
||||
router_a.include_router(
|
||||
router_a_b_override, prefix="/b", default_response_class=PlainTextResponse
|
||||
)
|
||||
app.include_router(router_a, prefix="/a")
|
||||
app.include_router(
|
||||
router_b_override, prefix="/b", default_response_class=PlainTextResponse
|
||||
)
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
orjson_type = "application/x-orjson"
|
||||
text_type = "text/plain; charset=utf-8"
|
||||
html_type = "text/html; charset=utf-8"
|
||||
override_type = "application/x-override"
|
||||
|
||||
|
||||
def test_app():
|
||||
with client:
|
||||
response = client.get("/")
|
||||
assert response.json() == {"msg": "Hello World"}
|
||||
assert response.headers["content-type"] == orjson_type
|
||||
|
||||
|
||||
def test_app_override():
|
||||
with client:
|
||||
response = client.get("/override")
|
||||
assert response.content == b"Hello World"
|
||||
assert response.headers["content-type"] == text_type
|
||||
|
||||
|
||||
def test_router_a():
|
||||
with client:
|
||||
response = client.get("/a")
|
||||
assert response.json() == {"msg": "Hello A"}
|
||||
assert response.headers["content-type"] == orjson_type
|
||||
|
||||
|
||||
def test_router_a_override():
|
||||
with client:
|
||||
response = client.get("/a/override")
|
||||
assert response.content == b"Hello A"
|
||||
assert response.headers["content-type"] == text_type
|
||||
|
||||
|
||||
def test_router_a_a():
|
||||
with client:
|
||||
response = client.get("/a/a")
|
||||
assert response.json() == {"msg": "Hello A A"}
|
||||
assert response.headers["content-type"] == orjson_type
|
||||
|
||||
|
||||
def test_router_a_a_override():
|
||||
with client:
|
||||
response = client.get("/a/a/override")
|
||||
assert response.content == b"Hello A A"
|
||||
assert response.headers["content-type"] == text_type
|
||||
|
||||
|
||||
def test_router_a_b():
|
||||
with client:
|
||||
response = client.get("/a/b")
|
||||
assert response.content == b"Hello A B"
|
||||
assert response.headers["content-type"] == text_type
|
||||
|
||||
|
||||
def test_router_a_b_override():
|
||||
with client:
|
||||
response = client.get("/a/b/override")
|
||||
assert response.content == b"Hello A B"
|
||||
assert response.headers["content-type"] == html_type
|
||||
|
||||
|
||||
def test_router_b():
|
||||
with client:
|
||||
response = client.get("/b")
|
||||
assert response.content == b"Hello B"
|
||||
assert response.headers["content-type"] == text_type
|
||||
|
||||
|
||||
def test_router_b_override():
|
||||
with client:
|
||||
response = client.get("/b/override")
|
||||
assert response.content == b"Hello B"
|
||||
assert response.headers["content-type"] == html_type
|
||||
|
||||
|
||||
def test_router_b_a():
|
||||
with client:
|
||||
response = client.get("/b/a")
|
||||
assert response.content == b"Hello B A"
|
||||
assert response.headers["content-type"] == text_type
|
||||
|
||||
|
||||
def test_router_b_a_override():
|
||||
with client:
|
||||
response = client.get("/b/a/override")
|
||||
assert response.content == b"Hello B A"
|
||||
assert response.headers["content-type"] == html_type
|
||||
|
||||
|
||||
def test_router_b_a_c():
|
||||
with client:
|
||||
response = client.get("/b/a/c")
|
||||
assert response.content == b"Hello B A C"
|
||||
assert response.headers["content-type"] == html_type
|
||||
|
||||
|
||||
def test_router_b_a_c_override():
|
||||
with client:
|
||||
response = client.get("/b/a/c/override")
|
||||
assert response.json() == {"msg": "Hello B A C"}
|
||||
assert response.headers["content-type"] == override_type
|
||||
@@ -0,0 +1,206 @@
|
||||
from fastapi import APIRouter, FastAPI
|
||||
from fastapi.responses import HTMLResponse, JSONResponse, PlainTextResponse
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
|
||||
class OverrideResponse(JSONResponse):
|
||||
media_type = "application/x-override"
|
||||
|
||||
|
||||
app = FastAPI()
|
||||
router_a = APIRouter()
|
||||
router_a_a = APIRouter()
|
||||
router_a_b_override = APIRouter() # Overrides default class
|
||||
router_b_override = APIRouter() # Overrides default class
|
||||
router_b_a = APIRouter()
|
||||
router_b_a_c_override = APIRouter() # Overrides default class again
|
||||
|
||||
|
||||
@app.get("/")
|
||||
def get_root():
|
||||
return {"msg": "Hello World"}
|
||||
|
||||
|
||||
@app.get("/override", response_class=PlainTextResponse)
|
||||
def get_path_override():
|
||||
return "Hello World"
|
||||
|
||||
|
||||
@router_a.get("/")
|
||||
def get_a():
|
||||
return {"msg": "Hello A"}
|
||||
|
||||
|
||||
@router_a.get("/override", response_class=PlainTextResponse)
|
||||
def get_a_path_override():
|
||||
return "Hello A"
|
||||
|
||||
|
||||
@router_a_a.get("/")
|
||||
def get_a_a():
|
||||
return {"msg": "Hello A A"}
|
||||
|
||||
|
||||
@router_a_a.get("/override", response_class=PlainTextResponse)
|
||||
def get_a_a_path_override():
|
||||
return "Hello A A"
|
||||
|
||||
|
||||
@router_a_b_override.get("/")
|
||||
def get_a_b():
|
||||
return "Hello A B"
|
||||
|
||||
|
||||
@router_a_b_override.get("/override", response_class=HTMLResponse)
|
||||
def get_a_b_path_override():
|
||||
return "Hello A B"
|
||||
|
||||
|
||||
@router_b_override.get("/")
|
||||
def get_b():
|
||||
return "Hello B"
|
||||
|
||||
|
||||
@router_b_override.get("/override", response_class=HTMLResponse)
|
||||
def get_b_path_override():
|
||||
return "Hello B"
|
||||
|
||||
|
||||
@router_b_a.get("/")
|
||||
def get_b_a():
|
||||
return "Hello B A"
|
||||
|
||||
|
||||
@router_b_a.get("/override", response_class=HTMLResponse)
|
||||
def get_b_a_path_override():
|
||||
return "Hello B A"
|
||||
|
||||
|
||||
@router_b_a_c_override.get("/")
|
||||
def get_b_a_c():
|
||||
return "Hello B A C"
|
||||
|
||||
|
||||
@router_b_a_c_override.get("/override", response_class=OverrideResponse)
|
||||
def get_b_a_c_path_override():
|
||||
return {"msg": "Hello B A C"}
|
||||
|
||||
|
||||
router_b_a.include_router(
|
||||
router_b_a_c_override, prefix="/c", default_response_class=HTMLResponse
|
||||
)
|
||||
router_b_override.include_router(router_b_a, prefix="/a")
|
||||
router_a.include_router(router_a_a, prefix="/a")
|
||||
router_a.include_router(
|
||||
router_a_b_override, prefix="/b", default_response_class=PlainTextResponse
|
||||
)
|
||||
app.include_router(router_a, prefix="/a")
|
||||
app.include_router(
|
||||
router_b_override, prefix="/b", default_response_class=PlainTextResponse
|
||||
)
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
json_type = "application/json"
|
||||
text_type = "text/plain; charset=utf-8"
|
||||
html_type = "text/html; charset=utf-8"
|
||||
override_type = "application/x-override"
|
||||
|
||||
|
||||
def test_app():
|
||||
with client:
|
||||
response = client.get("/")
|
||||
assert response.json() == {"msg": "Hello World"}
|
||||
assert response.headers["content-type"] == json_type
|
||||
|
||||
|
||||
def test_app_override():
|
||||
with client:
|
||||
response = client.get("/override")
|
||||
assert response.content == b"Hello World"
|
||||
assert response.headers["content-type"] == text_type
|
||||
|
||||
|
||||
def test_router_a():
|
||||
with client:
|
||||
response = client.get("/a")
|
||||
assert response.json() == {"msg": "Hello A"}
|
||||
assert response.headers["content-type"] == json_type
|
||||
|
||||
|
||||
def test_router_a_override():
|
||||
with client:
|
||||
response = client.get("/a/override")
|
||||
assert response.content == b"Hello A"
|
||||
assert response.headers["content-type"] == text_type
|
||||
|
||||
|
||||
def test_router_a_a():
|
||||
with client:
|
||||
response = client.get("/a/a")
|
||||
assert response.json() == {"msg": "Hello A A"}
|
||||
assert response.headers["content-type"] == json_type
|
||||
|
||||
|
||||
def test_router_a_a_override():
|
||||
with client:
|
||||
response = client.get("/a/a/override")
|
||||
assert response.content == b"Hello A A"
|
||||
assert response.headers["content-type"] == text_type
|
||||
|
||||
|
||||
def test_router_a_b():
|
||||
with client:
|
||||
response = client.get("/a/b")
|
||||
assert response.content == b"Hello A B"
|
||||
assert response.headers["content-type"] == text_type
|
||||
|
||||
|
||||
def test_router_a_b_override():
|
||||
with client:
|
||||
response = client.get("/a/b/override")
|
||||
assert response.content == b"Hello A B"
|
||||
assert response.headers["content-type"] == html_type
|
||||
|
||||
|
||||
def test_router_b():
|
||||
with client:
|
||||
response = client.get("/b")
|
||||
assert response.content == b"Hello B"
|
||||
assert response.headers["content-type"] == text_type
|
||||
|
||||
|
||||
def test_router_b_override():
|
||||
with client:
|
||||
response = client.get("/b/override")
|
||||
assert response.content == b"Hello B"
|
||||
assert response.headers["content-type"] == html_type
|
||||
|
||||
|
||||
def test_router_b_a():
|
||||
with client:
|
||||
response = client.get("/b/a")
|
||||
assert response.content == b"Hello B A"
|
||||
assert response.headers["content-type"] == text_type
|
||||
|
||||
|
||||
def test_router_b_a_override():
|
||||
with client:
|
||||
response = client.get("/b/a/override")
|
||||
assert response.content == b"Hello B A"
|
||||
assert response.headers["content-type"] == html_type
|
||||
|
||||
|
||||
def test_router_b_a_c():
|
||||
with client:
|
||||
response = client.get("/b/a/c")
|
||||
assert response.content == b"Hello B A C"
|
||||
assert response.headers["content-type"] == html_type
|
||||
|
||||
|
||||
def test_router_b_a_c_override():
|
||||
with client:
|
||||
response = client.get("/b/a/c/override")
|
||||
assert response.json() == {"msg": "Hello B A C"}
|
||||
assert response.headers["content-type"] == override_type
|
||||
@@ -0,0 +1,69 @@
|
||||
from typing import Any
|
||||
|
||||
import pytest
|
||||
from fastapi import Depends, FastAPI, HTTPException
|
||||
from fastapi.testclient import TestClient
|
||||
from typing_extensions import Annotated
|
||||
|
||||
|
||||
class CustomError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
def catching_dep() -> Any:
|
||||
try:
|
||||
yield "s"
|
||||
except CustomError as err:
|
||||
raise HTTPException(status_code=418, detail="Session error") from err
|
||||
|
||||
|
||||
def broken_dep() -> Any:
|
||||
yield "s"
|
||||
raise ValueError("Broken after yield")
|
||||
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.get("/catching")
|
||||
def catching(d: Annotated[str, Depends(catching_dep)]) -> Any:
|
||||
raise CustomError("Simulated error during streaming")
|
||||
|
||||
|
||||
@app.get("/broken")
|
||||
def broken(d: Annotated[str, Depends(broken_dep)]) -> Any:
|
||||
return {"message": "all good?"}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_catching():
|
||||
response = client.get("/catching")
|
||||
assert response.status_code == 418
|
||||
assert response.json() == {"detail": "Session error"}
|
||||
|
||||
|
||||
def test_broken_raise():
|
||||
with pytest.raises(ValueError, match="Broken after yield"):
|
||||
client.get("/broken")
|
||||
|
||||
|
||||
def test_broken_no_raise():
|
||||
"""
|
||||
When a dependency with yield raises after the yield (not in an except), the
|
||||
response is already "successfully" sent back to the client, but there's still
|
||||
an error in the server afterwards, an exception is raised and captured or shown
|
||||
in the server logs.
|
||||
"""
|
||||
with TestClient(app, raise_server_exceptions=False) as client:
|
||||
response = client.get("/broken")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"message": "all good?"}
|
||||
|
||||
|
||||
def test_broken_return_finishes():
|
||||
client = TestClient(app, raise_server_exceptions=False)
|
||||
response = client.get("/broken")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"message": "all good?"}
|
||||
@@ -0,0 +1,130 @@
|
||||
from contextlib import contextmanager
|
||||
from typing import Any, Generator
|
||||
|
||||
import pytest
|
||||
from fastapi import Depends, FastAPI
|
||||
from fastapi.responses import StreamingResponse
|
||||
from fastapi.testclient import TestClient
|
||||
from typing_extensions import Annotated
|
||||
|
||||
|
||||
class Session:
|
||||
def __init__(self) -> None:
|
||||
self.data = ["foo", "bar", "baz"]
|
||||
self.open = True
|
||||
|
||||
def __iter__(self) -> Generator[str, None, None]:
|
||||
for item in self.data:
|
||||
if self.open:
|
||||
yield item
|
||||
else:
|
||||
raise ValueError("Session closed")
|
||||
|
||||
|
||||
@contextmanager
|
||||
def acquire_session() -> Generator[Session, None, None]:
|
||||
session = Session()
|
||||
try:
|
||||
yield session
|
||||
finally:
|
||||
session.open = False
|
||||
|
||||
|
||||
def dep_session() -> Any:
|
||||
with acquire_session() as s:
|
||||
yield s
|
||||
|
||||
|
||||
def broken_dep_session() -> Any:
|
||||
with acquire_session() as s:
|
||||
s.open = False
|
||||
yield s
|
||||
|
||||
|
||||
SessionDep = Annotated[Session, Depends(dep_session)]
|
||||
BrokenSessionDep = Annotated[Session, Depends(broken_dep_session)]
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.get("/data")
|
||||
def get_data(session: SessionDep) -> Any:
|
||||
data = list(session)
|
||||
return data
|
||||
|
||||
|
||||
@app.get("/stream-simple")
|
||||
def get_stream_simple(session: SessionDep) -> Any:
|
||||
def iter_data():
|
||||
yield from ["x", "y", "z"]
|
||||
|
||||
return StreamingResponse(iter_data())
|
||||
|
||||
|
||||
@app.get("/stream-session")
|
||||
def get_stream_session(session: SessionDep) -> Any:
|
||||
def iter_data():
|
||||
yield from session
|
||||
|
||||
return StreamingResponse(iter_data())
|
||||
|
||||
|
||||
@app.get("/broken-session-data")
|
||||
def get_broken_session_data(session: BrokenSessionDep) -> Any:
|
||||
return list(session)
|
||||
|
||||
|
||||
@app.get("/broken-session-stream")
|
||||
def get_broken_session_stream(session: BrokenSessionDep) -> Any:
|
||||
def iter_data():
|
||||
yield from session
|
||||
|
||||
return StreamingResponse(iter_data())
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_regular_no_stream():
|
||||
response = client.get("/data")
|
||||
assert response.json() == ["foo", "bar", "baz"]
|
||||
|
||||
|
||||
def test_stream_simple():
|
||||
response = client.get("/stream-simple")
|
||||
assert response.text == "xyz"
|
||||
|
||||
|
||||
def test_stream_session():
|
||||
response = client.get("/stream-session")
|
||||
assert response.text == "foobarbaz"
|
||||
|
||||
|
||||
def test_broken_session_data():
|
||||
with pytest.raises(ValueError, match="Session closed"):
|
||||
client.get("/broken-session-data")
|
||||
|
||||
|
||||
def test_broken_session_data_no_raise():
|
||||
client = TestClient(app, raise_server_exceptions=False)
|
||||
response = client.get("/broken-session-data")
|
||||
assert response.status_code == 500
|
||||
assert response.text == "Internal Server Error"
|
||||
|
||||
|
||||
def test_broken_session_stream_raise():
|
||||
# Can raise ValueError on Pydantic v2 and ExceptionGroup on Pydantic v1
|
||||
with pytest.raises((ValueError, Exception)):
|
||||
client.get("/broken-session-stream")
|
||||
|
||||
|
||||
def test_broken_session_stream_no_raise():
|
||||
"""
|
||||
When a dependency with yield raises after the streaming response already started
|
||||
the 200 status code is already sent, but there's still an error in the server
|
||||
afterwards, an exception is raised and captured or shown in the server logs.
|
||||
"""
|
||||
with TestClient(app, raise_server_exceptions=False) as client:
|
||||
response = client.get("/broken-session-stream")
|
||||
assert response.status_code == 200
|
||||
assert response.text == ""
|
||||
@@ -0,0 +1,79 @@
|
||||
from contextlib import contextmanager
|
||||
from typing import Any, Generator
|
||||
|
||||
import pytest
|
||||
from fastapi import Depends, FastAPI, WebSocket
|
||||
from fastapi.testclient import TestClient
|
||||
from typing_extensions import Annotated
|
||||
|
||||
|
||||
class Session:
|
||||
def __init__(self) -> None:
|
||||
self.data = ["foo", "bar", "baz"]
|
||||
self.open = True
|
||||
|
||||
def __iter__(self) -> Generator[str, None, None]:
|
||||
for item in self.data:
|
||||
if self.open:
|
||||
yield item
|
||||
else:
|
||||
raise ValueError("Session closed")
|
||||
|
||||
|
||||
@contextmanager
|
||||
def acquire_session() -> Generator[Session, None, None]:
|
||||
session = Session()
|
||||
try:
|
||||
yield session
|
||||
finally:
|
||||
session.open = False
|
||||
|
||||
|
||||
def dep_session() -> Any:
|
||||
with acquire_session() as s:
|
||||
yield s
|
||||
|
||||
|
||||
def broken_dep_session() -> Any:
|
||||
with acquire_session() as s:
|
||||
s.open = False
|
||||
yield s
|
||||
|
||||
|
||||
SessionDep = Annotated[Session, Depends(dep_session)]
|
||||
BrokenSessionDep = Annotated[Session, Depends(broken_dep_session)]
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.websocket("/ws")
|
||||
async def websocket_endpoint(websocket: WebSocket, session: SessionDep):
|
||||
await websocket.accept()
|
||||
for item in session:
|
||||
await websocket.send_text(f"{item}")
|
||||
|
||||
|
||||
@app.websocket("/ws-broken")
|
||||
async def websocket_endpoint_broken(websocket: WebSocket, session: BrokenSessionDep):
|
||||
await websocket.accept()
|
||||
for item in session:
|
||||
await websocket.send_text(f"{item}") # pragma no cover
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_websocket_dependency_after_yield():
|
||||
with client.websocket_connect("/ws") as websocket:
|
||||
data = websocket.receive_text()
|
||||
assert data == "foo"
|
||||
data = websocket.receive_text()
|
||||
assert data == "bar"
|
||||
data = websocket.receive_text()
|
||||
assert data == "baz"
|
||||
|
||||
|
||||
def test_websocket_dependency_after_yield_broken():
|
||||
with pytest.raises(ValueError, match="Session closed"):
|
||||
with client.websocket_connect("/ws-broken"):
|
||||
pass # pragma no cover
|
||||
@@ -0,0 +1,91 @@
|
||||
from fastapi import Depends, FastAPI, Security
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
counter_holder = {"counter": 0}
|
||||
|
||||
|
||||
async def dep_counter():
|
||||
counter_holder["counter"] += 1
|
||||
return counter_holder["counter"]
|
||||
|
||||
|
||||
async def super_dep(count: int = Depends(dep_counter)):
|
||||
return count
|
||||
|
||||
|
||||
@app.get("/counter/")
|
||||
async def get_counter(count: int = Depends(dep_counter)):
|
||||
return {"counter": count}
|
||||
|
||||
|
||||
@app.get("/sub-counter/")
|
||||
async def get_sub_counter(
|
||||
subcount: int = Depends(super_dep), count: int = Depends(dep_counter)
|
||||
):
|
||||
return {"counter": count, "subcounter": subcount}
|
||||
|
||||
|
||||
@app.get("/sub-counter-no-cache/")
|
||||
async def get_sub_counter_no_cache(
|
||||
subcount: int = Depends(super_dep),
|
||||
count: int = Depends(dep_counter, use_cache=False),
|
||||
):
|
||||
return {"counter": count, "subcounter": subcount}
|
||||
|
||||
|
||||
@app.get("/scope-counter")
|
||||
async def get_scope_counter(
|
||||
count: int = Security(dep_counter),
|
||||
scope_count_1: int = Security(dep_counter, scopes=["scope"]),
|
||||
scope_count_2: int = Security(dep_counter, scopes=["scope"]),
|
||||
):
|
||||
return {
|
||||
"counter": count,
|
||||
"scope_counter_1": scope_count_1,
|
||||
"scope_counter_2": scope_count_2,
|
||||
}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_normal_counter():
|
||||
counter_holder["counter"] = 0
|
||||
response = client.get("/counter/")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"counter": 1}
|
||||
response = client.get("/counter/")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"counter": 2}
|
||||
|
||||
|
||||
def test_sub_counter():
|
||||
counter_holder["counter"] = 0
|
||||
response = client.get("/sub-counter/")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"counter": 1, "subcounter": 1}
|
||||
response = client.get("/sub-counter/")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"counter": 2, "subcounter": 2}
|
||||
|
||||
|
||||
def test_sub_counter_no_cache():
|
||||
counter_holder["counter"] = 0
|
||||
response = client.get("/sub-counter-no-cache/")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"counter": 2, "subcounter": 1}
|
||||
response = client.get("/sub-counter-no-cache/")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"counter": 4, "subcounter": 3}
|
||||
|
||||
|
||||
def test_security_cache():
|
||||
counter_holder["counter"] = 0
|
||||
response = client.get("/scope-counter/")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"counter": 1, "scope_counter_1": 2, "scope_counter_2": 2}
|
||||
response = client.get("/scope-counter/")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"counter": 3, "scope_counter_1": 4, "scope_counter_2": 4}
|
||||
@@ -0,0 +1,154 @@
|
||||
from typing import AsyncGenerator, Generator
|
||||
|
||||
import pytest
|
||||
from fastapi import Depends, FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
class CallableDependency:
|
||||
def __call__(self, value: str) -> str:
|
||||
return value
|
||||
|
||||
|
||||
class CallableGenDependency:
|
||||
def __call__(self, value: str) -> Generator[str, None, None]:
|
||||
yield value
|
||||
|
||||
|
||||
class AsyncCallableDependency:
|
||||
async def __call__(self, value: str) -> str:
|
||||
return value
|
||||
|
||||
|
||||
class AsyncCallableGenDependency:
|
||||
async def __call__(self, value: str) -> AsyncGenerator[str, None]:
|
||||
yield value
|
||||
|
||||
|
||||
class MethodsDependency:
|
||||
def synchronous(self, value: str) -> str:
|
||||
return value
|
||||
|
||||
async def asynchronous(self, value: str) -> str:
|
||||
return value
|
||||
|
||||
def synchronous_gen(self, value: str) -> Generator[str, None, None]:
|
||||
yield value
|
||||
|
||||
async def asynchronous_gen(self, value: str) -> AsyncGenerator[str, None]:
|
||||
yield value
|
||||
|
||||
|
||||
callable_dependency = CallableDependency()
|
||||
callable_gen_dependency = CallableGenDependency()
|
||||
async_callable_dependency = AsyncCallableDependency()
|
||||
async_callable_gen_dependency = AsyncCallableGenDependency()
|
||||
methods_dependency = MethodsDependency()
|
||||
|
||||
|
||||
@app.get("/callable-dependency-class")
|
||||
async def get_callable_dependency_class(
|
||||
value: str, instance: CallableDependency = Depends()
|
||||
):
|
||||
return instance(value)
|
||||
|
||||
|
||||
@app.get("/callable-gen-dependency-class")
|
||||
async def get_callable_gen_dependency_class(
|
||||
value: str, instance: CallableGenDependency = Depends()
|
||||
):
|
||||
return next(instance(value))
|
||||
|
||||
|
||||
@app.get("/async-callable-dependency-class")
|
||||
async def get_async_callable_dependency_class(
|
||||
value: str, instance: AsyncCallableDependency = Depends()
|
||||
):
|
||||
return await instance(value)
|
||||
|
||||
|
||||
@app.get("/async-callable-gen-dependency-class")
|
||||
async def get_async_callable_gen_dependency_class(
|
||||
value: str, instance: AsyncCallableGenDependency = Depends()
|
||||
):
|
||||
return await instance(value).__anext__()
|
||||
|
||||
|
||||
@app.get("/callable-dependency")
|
||||
async def get_callable_dependency(value: str = Depends(callable_dependency)):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/callable-gen-dependency")
|
||||
async def get_callable_gen_dependency(value: str = Depends(callable_gen_dependency)):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/async-callable-dependency")
|
||||
async def get_async_callable_dependency(
|
||||
value: str = Depends(async_callable_dependency),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/async-callable-gen-dependency")
|
||||
async def get_async_callable_gen_dependency(
|
||||
value: str = Depends(async_callable_gen_dependency),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/synchronous-method-dependency")
|
||||
async def get_synchronous_method_dependency(
|
||||
value: str = Depends(methods_dependency.synchronous),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/synchronous-method-gen-dependency")
|
||||
async def get_synchronous_method_gen_dependency(
|
||||
value: str = Depends(methods_dependency.synchronous_gen),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/asynchronous-method-dependency")
|
||||
async def get_asynchronous_method_dependency(
|
||||
value: str = Depends(methods_dependency.asynchronous),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/asynchronous-method-gen-dependency")
|
||||
async def get_asynchronous_method_gen_dependency(
|
||||
value: str = Depends(methods_dependency.asynchronous_gen),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"route,value",
|
||||
[
|
||||
("/callable-dependency", "callable-dependency"),
|
||||
("/callable-gen-dependency", "callable-gen-dependency"),
|
||||
("/async-callable-dependency", "async-callable-dependency"),
|
||||
("/async-callable-gen-dependency", "async-callable-gen-dependency"),
|
||||
("/synchronous-method-dependency", "synchronous-method-dependency"),
|
||||
("/synchronous-method-gen-dependency", "synchronous-method-gen-dependency"),
|
||||
("/asynchronous-method-dependency", "asynchronous-method-dependency"),
|
||||
("/asynchronous-method-gen-dependency", "asynchronous-method-gen-dependency"),
|
||||
("/callable-dependency-class", "callable-dependency-class"),
|
||||
("/callable-gen-dependency-class", "callable-gen-dependency-class"),
|
||||
("/async-callable-dependency-class", "async-callable-dependency-class"),
|
||||
("/async-callable-gen-dependency-class", "async-callable-gen-dependency-class"),
|
||||
],
|
||||
)
|
||||
def test_class_dependency(route, value):
|
||||
response = client.get(route, params={"value": value})
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == value
|
||||
@@ -0,0 +1,400 @@
|
||||
import json
|
||||
from typing import Dict
|
||||
|
||||
import pytest
|
||||
from fastapi import BackgroundTasks, Depends, FastAPI
|
||||
from fastapi.responses import StreamingResponse
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
state = {
|
||||
"/async": "asyncgen not started",
|
||||
"/sync": "generator not started",
|
||||
"/async_raise": "asyncgen raise not started",
|
||||
"/sync_raise": "generator raise not started",
|
||||
"context_a": "not started a",
|
||||
"context_b": "not started b",
|
||||
"bg": "not set",
|
||||
"sync_bg": "not set",
|
||||
}
|
||||
|
||||
errors = []
|
||||
|
||||
|
||||
async def get_state():
|
||||
return state
|
||||
|
||||
|
||||
class AsyncDependencyError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class SyncDependencyError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class OtherDependencyError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
async def asyncgen_state(state: Dict[str, str] = Depends(get_state)):
|
||||
state["/async"] = "asyncgen started"
|
||||
yield state["/async"]
|
||||
state["/async"] = "asyncgen completed"
|
||||
|
||||
|
||||
def generator_state(state: Dict[str, str] = Depends(get_state)):
|
||||
state["/sync"] = "generator started"
|
||||
yield state["/sync"]
|
||||
state["/sync"] = "generator completed"
|
||||
|
||||
|
||||
async def asyncgen_state_try(state: Dict[str, str] = Depends(get_state)):
|
||||
state["/async_raise"] = "asyncgen raise started"
|
||||
try:
|
||||
yield state["/async_raise"]
|
||||
except AsyncDependencyError:
|
||||
errors.append("/async_raise")
|
||||
raise
|
||||
finally:
|
||||
state["/async_raise"] = "asyncgen raise finalized"
|
||||
|
||||
|
||||
def generator_state_try(state: Dict[str, str] = Depends(get_state)):
|
||||
state["/sync_raise"] = "generator raise started"
|
||||
try:
|
||||
yield state["/sync_raise"]
|
||||
except SyncDependencyError:
|
||||
errors.append("/sync_raise")
|
||||
raise
|
||||
finally:
|
||||
state["/sync_raise"] = "generator raise finalized"
|
||||
|
||||
|
||||
async def context_a(state: dict = Depends(get_state)):
|
||||
state["context_a"] = "started a"
|
||||
try:
|
||||
yield state
|
||||
finally:
|
||||
state["context_a"] = "finished a"
|
||||
|
||||
|
||||
async def context_b(state: dict = Depends(context_a)):
|
||||
state["context_b"] = "started b"
|
||||
try:
|
||||
yield state
|
||||
finally:
|
||||
state["context_b"] = f"finished b with a: {state['context_a']}"
|
||||
|
||||
|
||||
@app.get("/async")
|
||||
async def get_async(state: str = Depends(asyncgen_state)):
|
||||
return state
|
||||
|
||||
|
||||
@app.get("/sync")
|
||||
async def get_sync(state: str = Depends(generator_state)):
|
||||
return state
|
||||
|
||||
|
||||
@app.get("/async_raise")
|
||||
async def get_async_raise(state: str = Depends(asyncgen_state_try)):
|
||||
assert state == "asyncgen raise started"
|
||||
raise AsyncDependencyError()
|
||||
|
||||
|
||||
@app.get("/sync_raise")
|
||||
async def get_sync_raise(state: str = Depends(generator_state_try)):
|
||||
assert state == "generator raise started"
|
||||
raise SyncDependencyError()
|
||||
|
||||
|
||||
@app.get("/async_raise_other")
|
||||
async def get_async_raise_other(state: str = Depends(asyncgen_state_try)):
|
||||
assert state == "asyncgen raise started"
|
||||
raise OtherDependencyError()
|
||||
|
||||
|
||||
@app.get("/sync_raise_other")
|
||||
async def get_sync_raise_other(state: str = Depends(generator_state_try)):
|
||||
assert state == "generator raise started"
|
||||
raise OtherDependencyError()
|
||||
|
||||
|
||||
@app.get("/context_b")
|
||||
async def get_context_b(state: dict = Depends(context_b)):
|
||||
return state
|
||||
|
||||
|
||||
@app.get("/context_b_raise")
|
||||
async def get_context_b_raise(state: dict = Depends(context_b)):
|
||||
assert state["context_b"] == "started b"
|
||||
assert state["context_a"] == "started a"
|
||||
raise OtherDependencyError()
|
||||
|
||||
|
||||
@app.get("/context_b_bg")
|
||||
async def get_context_b_bg(tasks: BackgroundTasks, state: dict = Depends(context_b)):
|
||||
async def bg(state: dict):
|
||||
state["bg"] = f"bg set - b: {state['context_b']} - a: {state['context_a']}"
|
||||
|
||||
tasks.add_task(bg, state)
|
||||
return state
|
||||
|
||||
|
||||
# Sync versions
|
||||
|
||||
|
||||
@app.get("/sync_async")
|
||||
def get_sync_async(state: str = Depends(asyncgen_state)):
|
||||
return state
|
||||
|
||||
|
||||
@app.get("/sync_sync")
|
||||
def get_sync_sync(state: str = Depends(generator_state)):
|
||||
return state
|
||||
|
||||
|
||||
@app.get("/sync_async_raise")
|
||||
def get_sync_async_raise(state: str = Depends(asyncgen_state_try)):
|
||||
assert state == "asyncgen raise started"
|
||||
raise AsyncDependencyError()
|
||||
|
||||
|
||||
@app.get("/sync_sync_raise")
|
||||
def get_sync_sync_raise(state: str = Depends(generator_state_try)):
|
||||
assert state == "generator raise started"
|
||||
raise SyncDependencyError()
|
||||
|
||||
|
||||
@app.get("/sync_async_raise_other")
|
||||
def get_sync_async_raise_other(state: str = Depends(asyncgen_state_try)):
|
||||
assert state == "asyncgen raise started"
|
||||
raise OtherDependencyError()
|
||||
|
||||
|
||||
@app.get("/sync_sync_raise_other")
|
||||
def get_sync_sync_raise_other(state: str = Depends(generator_state_try)):
|
||||
assert state == "generator raise started"
|
||||
raise OtherDependencyError()
|
||||
|
||||
|
||||
@app.get("/sync_context_b")
|
||||
def get_sync_context_b(state: dict = Depends(context_b)):
|
||||
return state
|
||||
|
||||
|
||||
@app.get("/sync_context_b_raise")
|
||||
def get_sync_context_b_raise(state: dict = Depends(context_b)):
|
||||
assert state["context_b"] == "started b"
|
||||
assert state["context_a"] == "started a"
|
||||
raise OtherDependencyError()
|
||||
|
||||
|
||||
@app.get("/sync_context_b_bg")
|
||||
async def get_sync_context_b_bg(
|
||||
tasks: BackgroundTasks, state: dict = Depends(context_b)
|
||||
):
|
||||
async def bg(state: dict):
|
||||
state["sync_bg"] = (
|
||||
f"sync_bg set - b: {state['context_b']} - a: {state['context_a']}"
|
||||
)
|
||||
|
||||
tasks.add_task(bg, state)
|
||||
return state
|
||||
|
||||
|
||||
@app.middleware("http")
|
||||
async def middleware(request, call_next):
|
||||
response: StreamingResponse = await call_next(request)
|
||||
response.headers["x-state"] = json.dumps(state.copy())
|
||||
return response
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_async_state():
|
||||
assert state["/async"] == "asyncgen not started"
|
||||
response = client.get("/async")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == "asyncgen started"
|
||||
assert state["/async"] == "asyncgen completed"
|
||||
|
||||
|
||||
def test_sync_state():
|
||||
assert state["/sync"] == "generator not started"
|
||||
response = client.get("/sync")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == "generator started"
|
||||
assert state["/sync"] == "generator completed"
|
||||
|
||||
|
||||
def test_async_raise_other():
|
||||
assert state["/async_raise"] == "asyncgen raise not started"
|
||||
with pytest.raises(OtherDependencyError):
|
||||
client.get("/async_raise_other")
|
||||
assert state["/async_raise"] == "asyncgen raise finalized"
|
||||
assert "/async_raise" not in errors
|
||||
|
||||
|
||||
def test_sync_raise_other():
|
||||
assert state["/sync_raise"] == "generator raise not started"
|
||||
with pytest.raises(OtherDependencyError):
|
||||
client.get("/sync_raise_other")
|
||||
assert state["/sync_raise"] == "generator raise finalized"
|
||||
assert "/sync_raise" not in errors
|
||||
|
||||
|
||||
def test_async_raise_raises():
|
||||
with pytest.raises(AsyncDependencyError):
|
||||
client.get("/async_raise")
|
||||
assert state["/async_raise"] == "asyncgen raise finalized"
|
||||
assert "/async_raise" in errors
|
||||
errors.clear()
|
||||
|
||||
|
||||
def test_async_raise_server_error():
|
||||
client = TestClient(app, raise_server_exceptions=False)
|
||||
response = client.get("/async_raise")
|
||||
assert response.status_code == 500, response.text
|
||||
assert state["/async_raise"] == "asyncgen raise finalized"
|
||||
assert "/async_raise" in errors
|
||||
errors.clear()
|
||||
|
||||
|
||||
def test_context_b():
|
||||
response = client.get("/context_b")
|
||||
data = response.json()
|
||||
assert data["context_b"] == "started b"
|
||||
assert data["context_a"] == "started a"
|
||||
assert state["context_b"] == "finished b with a: started a"
|
||||
assert state["context_a"] == "finished a"
|
||||
|
||||
|
||||
def test_context_b_raise():
|
||||
with pytest.raises(OtherDependencyError):
|
||||
client.get("/context_b_raise")
|
||||
assert state["context_b"] == "finished b with a: started a"
|
||||
assert state["context_a"] == "finished a"
|
||||
|
||||
|
||||
def test_background_tasks():
|
||||
response = client.get("/context_b_bg")
|
||||
data = response.json()
|
||||
assert data["context_b"] == "started b"
|
||||
assert data["context_a"] == "started a"
|
||||
assert data["bg"] == "not set"
|
||||
middleware_state = json.loads(response.headers["x-state"])
|
||||
assert middleware_state["context_b"] == "started b"
|
||||
assert middleware_state["context_a"] == "started a"
|
||||
assert middleware_state["bg"] == "not set"
|
||||
assert state["context_b"] == "finished b with a: started a"
|
||||
assert state["context_a"] == "finished a"
|
||||
assert state["bg"] == "bg set - b: started b - a: started a"
|
||||
|
||||
|
||||
def test_sync_raise_raises():
|
||||
with pytest.raises(SyncDependencyError):
|
||||
client.get("/sync_raise")
|
||||
assert state["/sync_raise"] == "generator raise finalized"
|
||||
assert "/sync_raise" in errors
|
||||
errors.clear()
|
||||
|
||||
|
||||
def test_sync_raise_server_error():
|
||||
client = TestClient(app, raise_server_exceptions=False)
|
||||
response = client.get("/sync_raise")
|
||||
assert response.status_code == 500, response.text
|
||||
assert state["/sync_raise"] == "generator raise finalized"
|
||||
assert "/sync_raise" in errors
|
||||
errors.clear()
|
||||
|
||||
|
||||
def test_sync_async_state():
|
||||
response = client.get("/sync_async")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == "asyncgen started"
|
||||
assert state["/async"] == "asyncgen completed"
|
||||
|
||||
|
||||
def test_sync_sync_state():
|
||||
response = client.get("/sync_sync")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == "generator started"
|
||||
assert state["/sync"] == "generator completed"
|
||||
|
||||
|
||||
def test_sync_async_raise_other():
|
||||
with pytest.raises(OtherDependencyError):
|
||||
client.get("/sync_async_raise_other")
|
||||
assert state["/async_raise"] == "asyncgen raise finalized"
|
||||
assert "/async_raise" not in errors
|
||||
|
||||
|
||||
def test_sync_sync_raise_other():
|
||||
with pytest.raises(OtherDependencyError):
|
||||
client.get("/sync_sync_raise_other")
|
||||
assert state["/sync_raise"] == "generator raise finalized"
|
||||
assert "/sync_raise" not in errors
|
||||
|
||||
|
||||
def test_sync_async_raise_raises():
|
||||
with pytest.raises(AsyncDependencyError):
|
||||
client.get("/sync_async_raise")
|
||||
assert state["/async_raise"] == "asyncgen raise finalized"
|
||||
assert "/async_raise" in errors
|
||||
errors.clear()
|
||||
|
||||
|
||||
def test_sync_async_raise_server_error():
|
||||
client = TestClient(app, raise_server_exceptions=False)
|
||||
response = client.get("/sync_async_raise")
|
||||
assert response.status_code == 500, response.text
|
||||
assert state["/async_raise"] == "asyncgen raise finalized"
|
||||
assert "/async_raise" in errors
|
||||
errors.clear()
|
||||
|
||||
|
||||
def test_sync_sync_raise_raises():
|
||||
with pytest.raises(SyncDependencyError):
|
||||
client.get("/sync_sync_raise")
|
||||
assert state["/sync_raise"] == "generator raise finalized"
|
||||
assert "/sync_raise" in errors
|
||||
errors.clear()
|
||||
|
||||
|
||||
def test_sync_sync_raise_server_error():
|
||||
client = TestClient(app, raise_server_exceptions=False)
|
||||
response = client.get("/sync_sync_raise")
|
||||
assert response.status_code == 500, response.text
|
||||
assert state["/sync_raise"] == "generator raise finalized"
|
||||
assert "/sync_raise" in errors
|
||||
errors.clear()
|
||||
|
||||
|
||||
def test_sync_context_b():
|
||||
response = client.get("/sync_context_b")
|
||||
data = response.json()
|
||||
assert data["context_b"] == "started b"
|
||||
assert data["context_a"] == "started a"
|
||||
assert state["context_b"] == "finished b with a: started a"
|
||||
assert state["context_a"] == "finished a"
|
||||
|
||||
|
||||
def test_sync_context_b_raise():
|
||||
with pytest.raises(OtherDependencyError):
|
||||
client.get("/sync_context_b_raise")
|
||||
assert state["context_b"] == "finished b with a: started a"
|
||||
assert state["context_a"] == "finished a"
|
||||
|
||||
|
||||
def test_sync_background_tasks():
|
||||
response = client.get("/sync_context_b_bg")
|
||||
data = response.json()
|
||||
assert data["context_b"] == "started b"
|
||||
assert data["context_a"] == "started a"
|
||||
assert data["sync_bg"] == "not set"
|
||||
assert state["context_b"] == "finished b with a: started a"
|
||||
assert state["context_a"] == "finished a"
|
||||
assert state["sync_bg"] == "sync_bg set - b: started b - a: started a"
|
||||
@@ -0,0 +1,51 @@
|
||||
from contextvars import ContextVar
|
||||
from typing import Any, Awaitable, Callable, Dict, Optional
|
||||
|
||||
from fastapi import Depends, FastAPI, Request, Response
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
legacy_request_state_context_var: ContextVar[Optional[Dict[str, Any]]] = ContextVar(
|
||||
"legacy_request_state_context_var", default=None
|
||||
)
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
async def set_up_request_state_dependency():
|
||||
request_state = {"user": "deadpond"}
|
||||
contextvar_token = legacy_request_state_context_var.set(request_state)
|
||||
yield request_state
|
||||
legacy_request_state_context_var.reset(contextvar_token)
|
||||
|
||||
|
||||
@app.middleware("http")
|
||||
async def custom_middleware(
|
||||
request: Request, call_next: Callable[[Request], Awaitable[Response]]
|
||||
):
|
||||
response = await call_next(request)
|
||||
response.headers["custom"] = "foo"
|
||||
return response
|
||||
|
||||
|
||||
@app.get("/user", dependencies=[Depends(set_up_request_state_dependency)])
|
||||
def get_user():
|
||||
request_state = legacy_request_state_context_var.get()
|
||||
assert request_state
|
||||
return request_state["user"]
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_dependency_contextvars():
|
||||
"""
|
||||
Check that custom middlewares don't affect the contextvar context for dependencies.
|
||||
|
||||
The code before yield and the code after yield should be run in the same contextvar
|
||||
context, so that request_state_context_var.reset(contextvar_token).
|
||||
|
||||
If they are run in a different context, that raises an error.
|
||||
"""
|
||||
response = client.get("/user")
|
||||
assert response.json() == "deadpond"
|
||||
assert response.headers["custom"] == "foo"
|
||||
@@ -0,0 +1,246 @@
|
||||
from typing import List
|
||||
|
||||
from dirty_equals import IsDict
|
||||
from fastapi import Depends, FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
class Item(BaseModel):
|
||||
data: str
|
||||
|
||||
|
||||
def duplicate_dependency(item: Item):
|
||||
return item
|
||||
|
||||
|
||||
def dependency(item2: Item):
|
||||
return item2
|
||||
|
||||
|
||||
def sub_duplicate_dependency(
|
||||
item: Item, sub_item: Item = Depends(duplicate_dependency)
|
||||
):
|
||||
return [item, sub_item]
|
||||
|
||||
|
||||
@app.post("/with-duplicates")
|
||||
async def with_duplicates(item: Item, item2: Item = Depends(duplicate_dependency)):
|
||||
return [item, item2]
|
||||
|
||||
|
||||
@app.post("/no-duplicates")
|
||||
async def no_duplicates(item: Item, item2: Item = Depends(dependency)):
|
||||
return [item, item2]
|
||||
|
||||
|
||||
@app.post("/with-duplicates-sub")
|
||||
async def no_duplicates_sub(
|
||||
item: Item, sub_items: List[Item] = Depends(sub_duplicate_dependency)
|
||||
):
|
||||
return [item, sub_items]
|
||||
|
||||
|
||||
def test_no_duplicates_invalid():
|
||||
response = client.post("/no-duplicates", json={"item": {"data": "myitem"}})
|
||||
assert response.status_code == 422, response.text
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["body", "item2"],
|
||||
"msg": "Field required",
|
||||
"input": None,
|
||||
}
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["body", "item2"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
}
|
||||
]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def test_no_duplicates():
|
||||
response = client.post(
|
||||
"/no-duplicates",
|
||||
json={"item": {"data": "myitem"}, "item2": {"data": "myitem2"}},
|
||||
)
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == [{"data": "myitem"}, {"data": "myitem2"}]
|
||||
|
||||
|
||||
def test_duplicates():
|
||||
response = client.post("/with-duplicates", json={"data": "myitem"})
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == [{"data": "myitem"}, {"data": "myitem"}]
|
||||
|
||||
|
||||
def test_sub_duplicates():
|
||||
response = client.post("/with-duplicates-sub", json={"data": "myitem"})
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == [
|
||||
{"data": "myitem"},
|
||||
[{"data": "myitem"}, {"data": "myitem"}],
|
||||
]
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/with-duplicates": {
|
||||
"post": {
|
||||
"summary": "With Duplicates",
|
||||
"operationId": "with_duplicates_with_duplicates_post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {"$ref": "#/components/schemas/Item"}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/no-duplicates": {
|
||||
"post": {
|
||||
"summary": "No Duplicates",
|
||||
"operationId": "no_duplicates_no_duplicates_post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Body_no_duplicates_no_duplicates_post"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/with-duplicates-sub": {
|
||||
"post": {
|
||||
"summary": "No Duplicates Sub",
|
||||
"operationId": "no_duplicates_sub_with_duplicates_sub_post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {"$ref": "#/components/schemas/Item"}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"Body_no_duplicates_no_duplicates_post": {
|
||||
"title": "Body_no_duplicates_no_duplicates_post",
|
||||
"required": ["item", "item2"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"item": {"$ref": "#/components/schemas/Item"},
|
||||
"item2": {"$ref": "#/components/schemas/Item"},
|
||||
},
|
||||
},
|
||||
"HTTPValidationError": {
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
}
|
||||
},
|
||||
},
|
||||
"Item": {
|
||||
"title": "Item",
|
||||
"required": ["data"],
|
||||
"type": "object",
|
||||
"properties": {"data": {"title": "Data", "type": "string"}},
|
||||
},
|
||||
"ValidationError": {
|
||||
"title": "ValidationError",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"loc": {
|
||||
"title": "Location",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
},
|
||||
"msg": {"title": "Message", "type": "string"},
|
||||
"type": {"title": "Error Type", "type": "string"},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,540 @@
|
||||
from typing import Optional
|
||||
|
||||
import pytest
|
||||
from dirty_equals import IsDict
|
||||
from fastapi import APIRouter, Depends, FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
router = APIRouter()
|
||||
|
||||
|
||||
async def common_parameters(q: str, skip: int = 0, limit: int = 100):
|
||||
return {"q": q, "skip": skip, "limit": limit}
|
||||
|
||||
|
||||
@app.get("/main-depends/")
|
||||
async def main_depends(commons: dict = Depends(common_parameters)):
|
||||
return {"in": "main-depends", "params": commons}
|
||||
|
||||
|
||||
@app.get("/decorator-depends/", dependencies=[Depends(common_parameters)])
|
||||
async def decorator_depends():
|
||||
return {"in": "decorator-depends"}
|
||||
|
||||
|
||||
@router.get("/router-depends/")
|
||||
async def router_depends(commons: dict = Depends(common_parameters)):
|
||||
return {"in": "router-depends", "params": commons}
|
||||
|
||||
|
||||
@router.get("/router-decorator-depends/", dependencies=[Depends(common_parameters)])
|
||||
async def router_decorator_depends():
|
||||
return {"in": "router-decorator-depends"}
|
||||
|
||||
|
||||
app.include_router(router)
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
async def overrider_dependency_simple(q: Optional[str] = None):
|
||||
return {"q": q, "skip": 5, "limit": 10}
|
||||
|
||||
|
||||
async def overrider_sub_dependency(k: str):
|
||||
return {"k": k}
|
||||
|
||||
|
||||
async def overrider_dependency_with_sub(msg: dict = Depends(overrider_sub_dependency)):
|
||||
return msg
|
||||
|
||||
|
||||
def test_main_depends():
|
||||
response = client.get("/main-depends/")
|
||||
assert response.status_code == 422
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["query", "q"],
|
||||
"msg": "Field required",
|
||||
"input": None,
|
||||
}
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["query", "q"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
}
|
||||
]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def test_main_depends_q_foo():
|
||||
response = client.get("/main-depends/?q=foo")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {
|
||||
"in": "main-depends",
|
||||
"params": {"q": "foo", "skip": 0, "limit": 100},
|
||||
}
|
||||
|
||||
|
||||
def test_main_depends_q_foo_skip_100_limit_200():
|
||||
response = client.get("/main-depends/?q=foo&skip=100&limit=200")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {
|
||||
"in": "main-depends",
|
||||
"params": {"q": "foo", "skip": 100, "limit": 200},
|
||||
}
|
||||
|
||||
|
||||
def test_decorator_depends():
|
||||
response = client.get("/decorator-depends/")
|
||||
assert response.status_code == 422
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["query", "q"],
|
||||
"msg": "Field required",
|
||||
"input": None,
|
||||
}
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["query", "q"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
}
|
||||
]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def test_decorator_depends_q_foo():
|
||||
response = client.get("/decorator-depends/?q=foo")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"in": "decorator-depends"}
|
||||
|
||||
|
||||
def test_decorator_depends_q_foo_skip_100_limit_200():
|
||||
response = client.get("/decorator-depends/?q=foo&skip=100&limit=200")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"in": "decorator-depends"}
|
||||
|
||||
|
||||
def test_router_depends():
|
||||
response = client.get("/router-depends/")
|
||||
assert response.status_code == 422
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["query", "q"],
|
||||
"msg": "Field required",
|
||||
"input": None,
|
||||
}
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["query", "q"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
}
|
||||
]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def test_router_depends_q_foo():
|
||||
response = client.get("/router-depends/?q=foo")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {
|
||||
"in": "router-depends",
|
||||
"params": {"q": "foo", "skip": 0, "limit": 100},
|
||||
}
|
||||
|
||||
|
||||
def test_router_depends_q_foo_skip_100_limit_200():
|
||||
response = client.get("/router-depends/?q=foo&skip=100&limit=200")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {
|
||||
"in": "router-depends",
|
||||
"params": {"q": "foo", "skip": 100, "limit": 200},
|
||||
}
|
||||
|
||||
|
||||
def test_router_decorator_depends():
|
||||
response = client.get("/router-decorator-depends/")
|
||||
assert response.status_code == 422
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["query", "q"],
|
||||
"msg": "Field required",
|
||||
"input": None,
|
||||
}
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["query", "q"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
}
|
||||
]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def test_router_decorator_depends_q_foo():
|
||||
response = client.get("/router-decorator-depends/?q=foo")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"in": "router-decorator-depends"}
|
||||
|
||||
|
||||
def test_router_decorator_depends_q_foo_skip_100_limit_200():
|
||||
response = client.get("/router-decorator-depends/?q=foo&skip=100&limit=200")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"in": "router-decorator-depends"}
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"url,status_code,expected",
|
||||
[
|
||||
(
|
||||
"/main-depends/",
|
||||
200,
|
||||
{"in": "main-depends", "params": {"q": None, "skip": 5, "limit": 10}},
|
||||
),
|
||||
(
|
||||
"/main-depends/?q=foo",
|
||||
200,
|
||||
{"in": "main-depends", "params": {"q": "foo", "skip": 5, "limit": 10}},
|
||||
),
|
||||
(
|
||||
"/main-depends/?q=foo&skip=100&limit=200",
|
||||
200,
|
||||
{"in": "main-depends", "params": {"q": "foo", "skip": 5, "limit": 10}},
|
||||
),
|
||||
("/decorator-depends/", 200, {"in": "decorator-depends"}),
|
||||
(
|
||||
"/router-depends/",
|
||||
200,
|
||||
{"in": "router-depends", "params": {"q": None, "skip": 5, "limit": 10}},
|
||||
),
|
||||
(
|
||||
"/router-depends/?q=foo",
|
||||
200,
|
||||
{"in": "router-depends", "params": {"q": "foo", "skip": 5, "limit": 10}},
|
||||
),
|
||||
(
|
||||
"/router-depends/?q=foo&skip=100&limit=200",
|
||||
200,
|
||||
{"in": "router-depends", "params": {"q": "foo", "skip": 5, "limit": 10}},
|
||||
),
|
||||
("/router-decorator-depends/", 200, {"in": "router-decorator-depends"}),
|
||||
],
|
||||
)
|
||||
def test_override_simple(url, status_code, expected):
|
||||
app.dependency_overrides[common_parameters] = overrider_dependency_simple
|
||||
response = client.get(url)
|
||||
assert response.status_code == status_code
|
||||
assert response.json() == expected
|
||||
app.dependency_overrides = {}
|
||||
|
||||
|
||||
def test_override_with_sub_main_depends():
|
||||
app.dependency_overrides[common_parameters] = overrider_dependency_with_sub
|
||||
response = client.get("/main-depends/")
|
||||
assert response.status_code == 422
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["query", "k"],
|
||||
"msg": "Field required",
|
||||
"input": None,
|
||||
}
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["query", "k"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
}
|
||||
]
|
||||
}
|
||||
)
|
||||
app.dependency_overrides = {}
|
||||
|
||||
|
||||
def test_override_with_sub__main_depends_q_foo():
|
||||
app.dependency_overrides[common_parameters] = overrider_dependency_with_sub
|
||||
response = client.get("/main-depends/?q=foo")
|
||||
assert response.status_code == 422
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["query", "k"],
|
||||
"msg": "Field required",
|
||||
"input": None,
|
||||
}
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["query", "k"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
}
|
||||
]
|
||||
}
|
||||
)
|
||||
app.dependency_overrides = {}
|
||||
|
||||
|
||||
def test_override_with_sub_main_depends_k_bar():
|
||||
app.dependency_overrides[common_parameters] = overrider_dependency_with_sub
|
||||
response = client.get("/main-depends/?k=bar")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"in": "main-depends", "params": {"k": "bar"}}
|
||||
app.dependency_overrides = {}
|
||||
|
||||
|
||||
def test_override_with_sub_decorator_depends():
|
||||
app.dependency_overrides[common_parameters] = overrider_dependency_with_sub
|
||||
response = client.get("/decorator-depends/")
|
||||
assert response.status_code == 422
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["query", "k"],
|
||||
"msg": "Field required",
|
||||
"input": None,
|
||||
}
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["query", "k"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
}
|
||||
]
|
||||
}
|
||||
)
|
||||
app.dependency_overrides = {}
|
||||
|
||||
|
||||
def test_override_with_sub_decorator_depends_q_foo():
|
||||
app.dependency_overrides[common_parameters] = overrider_dependency_with_sub
|
||||
response = client.get("/decorator-depends/?q=foo")
|
||||
assert response.status_code == 422
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["query", "k"],
|
||||
"msg": "Field required",
|
||||
"input": None,
|
||||
}
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["query", "k"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
}
|
||||
]
|
||||
}
|
||||
)
|
||||
app.dependency_overrides = {}
|
||||
|
||||
|
||||
def test_override_with_sub_decorator_depends_k_bar():
|
||||
app.dependency_overrides[common_parameters] = overrider_dependency_with_sub
|
||||
response = client.get("/decorator-depends/?k=bar")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"in": "decorator-depends"}
|
||||
app.dependency_overrides = {}
|
||||
|
||||
|
||||
def test_override_with_sub_router_depends():
|
||||
app.dependency_overrides[common_parameters] = overrider_dependency_with_sub
|
||||
response = client.get("/router-depends/")
|
||||
assert response.status_code == 422
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["query", "k"],
|
||||
"msg": "Field required",
|
||||
"input": None,
|
||||
}
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["query", "k"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
}
|
||||
]
|
||||
}
|
||||
)
|
||||
app.dependency_overrides = {}
|
||||
|
||||
|
||||
def test_override_with_sub_router_depends_q_foo():
|
||||
app.dependency_overrides[common_parameters] = overrider_dependency_with_sub
|
||||
response = client.get("/router-depends/?q=foo")
|
||||
assert response.status_code == 422
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["query", "k"],
|
||||
"msg": "Field required",
|
||||
"input": None,
|
||||
}
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["query", "k"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
}
|
||||
]
|
||||
}
|
||||
)
|
||||
app.dependency_overrides = {}
|
||||
|
||||
|
||||
def test_override_with_sub_router_depends_k_bar():
|
||||
app.dependency_overrides[common_parameters] = overrider_dependency_with_sub
|
||||
response = client.get("/router-depends/?k=bar")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"in": "router-depends", "params": {"k": "bar"}}
|
||||
app.dependency_overrides = {}
|
||||
|
||||
|
||||
def test_override_with_sub_router_decorator_depends():
|
||||
app.dependency_overrides[common_parameters] = overrider_dependency_with_sub
|
||||
response = client.get("/router-decorator-depends/")
|
||||
assert response.status_code == 422
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["query", "k"],
|
||||
"msg": "Field required",
|
||||
"input": None,
|
||||
}
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["query", "k"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
}
|
||||
]
|
||||
}
|
||||
)
|
||||
app.dependency_overrides = {}
|
||||
|
||||
|
||||
def test_override_with_sub_router_decorator_depends_q_foo():
|
||||
app.dependency_overrides[common_parameters] = overrider_dependency_with_sub
|
||||
response = client.get("/router-decorator-depends/?q=foo")
|
||||
assert response.status_code == 422
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["query", "k"],
|
||||
"msg": "Field required",
|
||||
"input": None,
|
||||
}
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["query", "k"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
}
|
||||
]
|
||||
}
|
||||
)
|
||||
app.dependency_overrides = {}
|
||||
|
||||
|
||||
def test_override_with_sub_router_decorator_depends_k_bar():
|
||||
app.dependency_overrides[common_parameters] = overrider_dependency_with_sub
|
||||
response = client.get("/router-decorator-depends/?k=bar")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"in": "router-decorator-depends"}
|
||||
app.dependency_overrides = {}
|
||||
@@ -0,0 +1,78 @@
|
||||
from typing import Union
|
||||
|
||||
from fastapi import FastAPI, HTTPException, Security
|
||||
from fastapi.security import (
|
||||
OAuth2PasswordBearer,
|
||||
SecurityScopes,
|
||||
)
|
||||
from fastapi.testclient import TestClient
|
||||
from typing_extensions import Annotated
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
|
||||
|
||||
|
||||
def process_auth(
|
||||
credentials: Annotated[Union[str, None], Security(oauth2_scheme)],
|
||||
security_scopes: SecurityScopes,
|
||||
):
|
||||
# This is an incorrect way of using it, this is not checking if the scopes are
|
||||
# provided by the token, only if the endpoint is requesting them, but the test
|
||||
# here is just to check if FastAPI is indeed registering and passing the scopes
|
||||
# correctly when using Security with parameterless dependencies.
|
||||
if "a" not in security_scopes.scopes or "b" not in security_scopes.scopes:
|
||||
raise HTTPException(detail="a or b not in scopes", status_code=401)
|
||||
return {"token": credentials, "scopes": security_scopes.scopes}
|
||||
|
||||
|
||||
@app.get("/get-credentials")
|
||||
def get_credentials(
|
||||
credentials: Annotated[dict, Security(process_auth, scopes=["a", "b"])],
|
||||
):
|
||||
return credentials
|
||||
|
||||
|
||||
@app.get(
|
||||
"/parameterless-with-scopes",
|
||||
dependencies=[Security(process_auth, scopes=["a", "b"])],
|
||||
)
|
||||
def get_parameterless_with_scopes():
|
||||
return {"status": "ok"}
|
||||
|
||||
|
||||
@app.get(
|
||||
"/parameterless-without-scopes",
|
||||
dependencies=[Security(process_auth)],
|
||||
)
|
||||
def get_parameterless_without_scopes():
|
||||
return {"status": "ok"}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_get_credentials():
|
||||
response = client.get("/get-credentials", headers={"authorization": "Bearer token"})
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"token": "token", "scopes": ["a", "b"]}
|
||||
|
||||
|
||||
def test_parameterless_with_scopes():
|
||||
response = client.get(
|
||||
"/parameterless-with-scopes", headers={"authorization": "Bearer token"}
|
||||
)
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"status": "ok"}
|
||||
|
||||
|
||||
def test_parameterless_without_scopes():
|
||||
response = client.get(
|
||||
"/parameterless-without-scopes", headers={"authorization": "Bearer token"}
|
||||
)
|
||||
assert response.status_code == 401, response.text
|
||||
assert response.json() == {"detail": "a or b not in scopes"}
|
||||
|
||||
|
||||
def test_call_get_parameterless_without_scopes_for_coverage():
|
||||
assert get_parameterless_without_scopes() == {"status": "ok"}
|
||||
@@ -0,0 +1,251 @@
|
||||
from functools import partial
|
||||
from typing import AsyncGenerator, Generator
|
||||
|
||||
import pytest
|
||||
from fastapi import Depends, FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
from typing_extensions import Annotated
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
def function_dependency(value: str) -> str:
|
||||
return value
|
||||
|
||||
|
||||
async def async_function_dependency(value: str) -> str:
|
||||
return value
|
||||
|
||||
|
||||
def gen_dependency(value: str) -> Generator[str, None, None]:
|
||||
yield value
|
||||
|
||||
|
||||
async def async_gen_dependency(value: str) -> AsyncGenerator[str, None]:
|
||||
yield value
|
||||
|
||||
|
||||
class CallableDependency:
|
||||
def __call__(self, value: str) -> str:
|
||||
return value
|
||||
|
||||
|
||||
class CallableGenDependency:
|
||||
def __call__(self, value: str) -> Generator[str, None, None]:
|
||||
yield value
|
||||
|
||||
|
||||
class AsyncCallableDependency:
|
||||
async def __call__(self, value: str) -> str:
|
||||
return value
|
||||
|
||||
|
||||
class AsyncCallableGenDependency:
|
||||
async def __call__(self, value: str) -> AsyncGenerator[str, None]:
|
||||
yield value
|
||||
|
||||
|
||||
class MethodsDependency:
|
||||
def synchronous(self, value: str) -> str:
|
||||
return value
|
||||
|
||||
async def asynchronous(self, value: str) -> str:
|
||||
return value
|
||||
|
||||
def synchronous_gen(self, value: str) -> Generator[str, None, None]:
|
||||
yield value
|
||||
|
||||
async def asynchronous_gen(self, value: str) -> AsyncGenerator[str, None]:
|
||||
yield value
|
||||
|
||||
|
||||
callable_dependency = CallableDependency()
|
||||
callable_gen_dependency = CallableGenDependency()
|
||||
async_callable_dependency = AsyncCallableDependency()
|
||||
async_callable_gen_dependency = AsyncCallableGenDependency()
|
||||
methods_dependency = MethodsDependency()
|
||||
|
||||
|
||||
@app.get("/partial-function-dependency")
|
||||
async def get_partial_function_dependency(
|
||||
value: Annotated[
|
||||
str, Depends(partial(function_dependency, "partial-function-dependency"))
|
||||
],
|
||||
) -> str:
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/partial-async-function-dependency")
|
||||
async def get_partial_async_function_dependency(
|
||||
value: Annotated[
|
||||
str,
|
||||
Depends(
|
||||
partial(async_function_dependency, "partial-async-function-dependency")
|
||||
),
|
||||
],
|
||||
) -> str:
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/partial-gen-dependency")
|
||||
async def get_partial_gen_dependency(
|
||||
value: Annotated[str, Depends(partial(gen_dependency, "partial-gen-dependency"))],
|
||||
) -> str:
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/partial-async-gen-dependency")
|
||||
async def get_partial_async_gen_dependency(
|
||||
value: Annotated[
|
||||
str, Depends(partial(async_gen_dependency, "partial-async-gen-dependency"))
|
||||
],
|
||||
) -> str:
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/partial-callable-dependency")
|
||||
async def get_partial_callable_dependency(
|
||||
value: Annotated[
|
||||
str, Depends(partial(callable_dependency, "partial-callable-dependency"))
|
||||
],
|
||||
) -> str:
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/partial-callable-gen-dependency")
|
||||
async def get_partial_callable_gen_dependency(
|
||||
value: Annotated[
|
||||
str,
|
||||
Depends(partial(callable_gen_dependency, "partial-callable-gen-dependency")),
|
||||
],
|
||||
) -> str:
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/partial-async-callable-dependency")
|
||||
async def get_partial_async_callable_dependency(
|
||||
value: Annotated[
|
||||
str,
|
||||
Depends(
|
||||
partial(async_callable_dependency, "partial-async-callable-dependency")
|
||||
),
|
||||
],
|
||||
) -> str:
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/partial-async-callable-gen-dependency")
|
||||
async def get_partial_async_callable_gen_dependency(
|
||||
value: Annotated[
|
||||
str,
|
||||
Depends(
|
||||
partial(
|
||||
async_callable_gen_dependency, "partial-async-callable-gen-dependency"
|
||||
)
|
||||
),
|
||||
],
|
||||
) -> str:
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/partial-synchronous-method-dependency")
|
||||
async def get_partial_synchronous_method_dependency(
|
||||
value: Annotated[
|
||||
str,
|
||||
Depends(
|
||||
partial(
|
||||
methods_dependency.synchronous, "partial-synchronous-method-dependency"
|
||||
)
|
||||
),
|
||||
],
|
||||
) -> str:
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/partial-synchronous-method-gen-dependency")
|
||||
async def get_partial_synchronous_method_gen_dependency(
|
||||
value: Annotated[
|
||||
str,
|
||||
Depends(
|
||||
partial(
|
||||
methods_dependency.synchronous_gen,
|
||||
"partial-synchronous-method-gen-dependency",
|
||||
)
|
||||
),
|
||||
],
|
||||
) -> str:
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/partial-asynchronous-method-dependency")
|
||||
async def get_partial_asynchronous_method_dependency(
|
||||
value: Annotated[
|
||||
str,
|
||||
Depends(
|
||||
partial(
|
||||
methods_dependency.asynchronous,
|
||||
"partial-asynchronous-method-dependency",
|
||||
)
|
||||
),
|
||||
],
|
||||
) -> str:
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/partial-asynchronous-method-gen-dependency")
|
||||
async def get_partial_asynchronous_method_gen_dependency(
|
||||
value: Annotated[
|
||||
str,
|
||||
Depends(
|
||||
partial(
|
||||
methods_dependency.asynchronous_gen,
|
||||
"partial-asynchronous-method-gen-dependency",
|
||||
)
|
||||
),
|
||||
],
|
||||
) -> str:
|
||||
return value
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"route,value",
|
||||
[
|
||||
("/partial-function-dependency", "partial-function-dependency"),
|
||||
(
|
||||
"/partial-async-function-dependency",
|
||||
"partial-async-function-dependency",
|
||||
),
|
||||
("/partial-gen-dependency", "partial-gen-dependency"),
|
||||
("/partial-async-gen-dependency", "partial-async-gen-dependency"),
|
||||
("/partial-callable-dependency", "partial-callable-dependency"),
|
||||
("/partial-callable-gen-dependency", "partial-callable-gen-dependency"),
|
||||
("/partial-async-callable-dependency", "partial-async-callable-dependency"),
|
||||
(
|
||||
"/partial-async-callable-gen-dependency",
|
||||
"partial-async-callable-gen-dependency",
|
||||
),
|
||||
(
|
||||
"/partial-synchronous-method-dependency",
|
||||
"partial-synchronous-method-dependency",
|
||||
),
|
||||
(
|
||||
"/partial-synchronous-method-gen-dependency",
|
||||
"partial-synchronous-method-gen-dependency",
|
||||
),
|
||||
(
|
||||
"/partial-asynchronous-method-dependency",
|
||||
"partial-asynchronous-method-dependency",
|
||||
),
|
||||
(
|
||||
"/partial-asynchronous-method-gen-dependency",
|
||||
"partial-asynchronous-method-gen-dependency",
|
||||
),
|
||||
],
|
||||
)
|
||||
def test_dependency_types_with_partial(route: str, value: str) -> None:
|
||||
response = client.get(route)
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == value
|
||||
@@ -0,0 +1,65 @@
|
||||
from typing import List, Tuple
|
||||
|
||||
from fastapi import Depends, FastAPI, Security
|
||||
from fastapi.security import SecurityScopes
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
def get_user(required_scopes: SecurityScopes):
|
||||
return "john", required_scopes.scopes
|
||||
|
||||
|
||||
def get_user_override(required_scopes: SecurityScopes):
|
||||
return "alice", required_scopes.scopes
|
||||
|
||||
|
||||
def get_data():
|
||||
return [1, 2, 3]
|
||||
|
||||
|
||||
def get_data_override():
|
||||
return [3, 4, 5]
|
||||
|
||||
|
||||
@app.get("/user")
|
||||
def read_user(
|
||||
user_data: Tuple[str, List[str]] = Security(get_user, scopes=["foo", "bar"]),
|
||||
data: List[int] = Depends(get_data),
|
||||
):
|
||||
return {"user": user_data[0], "scopes": user_data[1], "data": data}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_normal():
|
||||
response = client.get("/user")
|
||||
assert response.json() == {
|
||||
"user": "john",
|
||||
"scopes": ["foo", "bar"],
|
||||
"data": [1, 2, 3],
|
||||
}
|
||||
|
||||
|
||||
def test_override_data():
|
||||
app.dependency_overrides[get_data] = get_data_override
|
||||
response = client.get("/user")
|
||||
assert response.json() == {
|
||||
"user": "john",
|
||||
"scopes": ["foo", "bar"],
|
||||
"data": [3, 4, 5],
|
||||
}
|
||||
app.dependency_overrides = {}
|
||||
|
||||
|
||||
def test_override_security():
|
||||
app.dependency_overrides[get_user] = get_user_override
|
||||
response = client.get("/user")
|
||||
assert response.json() == {
|
||||
"user": "alice",
|
||||
"scopes": ["foo", "bar"],
|
||||
"data": [1, 2, 3],
|
||||
}
|
||||
app.dependency_overrides = {}
|
||||
@@ -0,0 +1,449 @@
|
||||
import inspect
|
||||
import sys
|
||||
from functools import wraps
|
||||
from typing import AsyncGenerator, Generator
|
||||
|
||||
import pytest
|
||||
from fastapi import Depends, FastAPI
|
||||
from fastapi.concurrency import iterate_in_threadpool, run_in_threadpool
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
if sys.version_info >= (3, 13): # pragma: no cover
|
||||
from inspect import iscoroutinefunction
|
||||
else: # pragma: no cover
|
||||
from asyncio import iscoroutinefunction
|
||||
|
||||
|
||||
def noop_wrap(func):
|
||||
@wraps(func)
|
||||
def wrapper(*args, **kwargs):
|
||||
return func(*args, **kwargs)
|
||||
|
||||
return wrapper
|
||||
|
||||
|
||||
def noop_wrap_async(func):
|
||||
if inspect.isgeneratorfunction(func):
|
||||
|
||||
@wraps(func)
|
||||
async def gen_wrapper(*args, **kwargs):
|
||||
async for item in iterate_in_threadpool(func(*args, **kwargs)):
|
||||
yield item
|
||||
|
||||
return gen_wrapper
|
||||
|
||||
elif inspect.isasyncgenfunction(func):
|
||||
|
||||
@wraps(func)
|
||||
async def async_gen_wrapper(*args, **kwargs):
|
||||
async for item in func(*args, **kwargs):
|
||||
yield item
|
||||
|
||||
return async_gen_wrapper
|
||||
|
||||
@wraps(func)
|
||||
async def wrapper(*args, **kwargs):
|
||||
if inspect.isroutine(func) and iscoroutinefunction(func):
|
||||
return await func(*args, **kwargs)
|
||||
if inspect.isclass(func):
|
||||
return await run_in_threadpool(func, *args, **kwargs)
|
||||
dunder_call = getattr(func, "__call__", None) # noqa: B004
|
||||
if iscoroutinefunction(dunder_call):
|
||||
return await dunder_call(*args, **kwargs)
|
||||
return await run_in_threadpool(func, *args, **kwargs)
|
||||
|
||||
return wrapper
|
||||
|
||||
|
||||
class ClassInstanceDep:
|
||||
def __call__(self):
|
||||
return True
|
||||
|
||||
|
||||
class_instance_dep = ClassInstanceDep()
|
||||
wrapped_class_instance_dep = noop_wrap(class_instance_dep)
|
||||
wrapped_class_instance_dep_async_wrapper = noop_wrap_async(class_instance_dep)
|
||||
|
||||
|
||||
class ClassInstanceGenDep:
|
||||
def __call__(self):
|
||||
yield True
|
||||
|
||||
|
||||
class_instance_gen_dep = ClassInstanceGenDep()
|
||||
wrapped_class_instance_gen_dep = noop_wrap(class_instance_gen_dep)
|
||||
|
||||
|
||||
class ClassInstanceWrappedDep:
|
||||
@noop_wrap
|
||||
def __call__(self):
|
||||
return True
|
||||
|
||||
|
||||
class_instance_wrapped_dep = ClassInstanceWrappedDep()
|
||||
|
||||
|
||||
class ClassInstanceWrappedAsyncDep:
|
||||
@noop_wrap_async
|
||||
def __call__(self):
|
||||
return True
|
||||
|
||||
|
||||
class_instance_wrapped_async_dep = ClassInstanceWrappedAsyncDep()
|
||||
|
||||
|
||||
class ClassInstanceWrappedGenDep:
|
||||
@noop_wrap
|
||||
def __call__(self):
|
||||
yield True
|
||||
|
||||
|
||||
class_instance_wrapped_gen_dep = ClassInstanceWrappedGenDep()
|
||||
|
||||
|
||||
class ClassInstanceWrappedAsyncGenDep:
|
||||
@noop_wrap_async
|
||||
def __call__(self):
|
||||
yield True
|
||||
|
||||
|
||||
class_instance_wrapped_async_gen_dep = ClassInstanceWrappedAsyncGenDep()
|
||||
|
||||
|
||||
class ClassDep:
|
||||
def __init__(self):
|
||||
self.value = True
|
||||
|
||||
|
||||
wrapped_class_dep = noop_wrap(ClassDep)
|
||||
wrapped_class_dep_async_wrapper = noop_wrap_async(ClassDep)
|
||||
|
||||
|
||||
class ClassInstanceAsyncDep:
|
||||
async def __call__(self):
|
||||
return True
|
||||
|
||||
|
||||
class_instance_async_dep = ClassInstanceAsyncDep()
|
||||
wrapped_class_instance_async_dep = noop_wrap(class_instance_async_dep)
|
||||
wrapped_class_instance_async_dep_async_wrapper = noop_wrap_async(
|
||||
class_instance_async_dep
|
||||
)
|
||||
|
||||
|
||||
class ClassInstanceAsyncGenDep:
|
||||
async def __call__(self):
|
||||
yield True
|
||||
|
||||
|
||||
class_instance_async_gen_dep = ClassInstanceAsyncGenDep()
|
||||
wrapped_class_instance_async_gen_dep = noop_wrap(class_instance_async_gen_dep)
|
||||
|
||||
|
||||
class ClassInstanceAsyncWrappedDep:
|
||||
@noop_wrap
|
||||
async def __call__(self):
|
||||
return True
|
||||
|
||||
|
||||
class_instance_async_wrapped_dep = ClassInstanceAsyncWrappedDep()
|
||||
|
||||
|
||||
class ClassInstanceAsyncWrappedAsyncDep:
|
||||
@noop_wrap_async
|
||||
async def __call__(self):
|
||||
return True
|
||||
|
||||
|
||||
class_instance_async_wrapped_async_dep = ClassInstanceAsyncWrappedAsyncDep()
|
||||
|
||||
|
||||
class ClassInstanceAsyncWrappedGenDep:
|
||||
@noop_wrap
|
||||
async def __call__(self):
|
||||
yield True
|
||||
|
||||
|
||||
class_instance_async_wrapped_gen_dep = ClassInstanceAsyncWrappedGenDep()
|
||||
|
||||
|
||||
class ClassInstanceAsyncWrappedGenAsyncDep:
|
||||
@noop_wrap_async
|
||||
async def __call__(self):
|
||||
yield True
|
||||
|
||||
|
||||
class_instance_async_wrapped_gen_async_dep = ClassInstanceAsyncWrappedGenAsyncDep()
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
# Sync wrapper
|
||||
|
||||
|
||||
@noop_wrap
|
||||
def wrapped_dependency() -> bool:
|
||||
return True
|
||||
|
||||
|
||||
@noop_wrap
|
||||
def wrapped_gen_dependency() -> Generator[bool, None, None]:
|
||||
yield True
|
||||
|
||||
|
||||
@noop_wrap
|
||||
async def async_wrapped_dependency() -> bool:
|
||||
return True
|
||||
|
||||
|
||||
@noop_wrap
|
||||
async def async_wrapped_gen_dependency() -> AsyncGenerator[bool, None]:
|
||||
yield True
|
||||
|
||||
|
||||
@app.get("/wrapped-dependency/")
|
||||
async def get_wrapped_dependency(value: bool = Depends(wrapped_dependency)):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/wrapped-gen-dependency/")
|
||||
async def get_wrapped_gen_dependency(value: bool = Depends(wrapped_gen_dependency)):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/async-wrapped-dependency/")
|
||||
async def get_async_wrapped_dependency(value: bool = Depends(async_wrapped_dependency)):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/async-wrapped-gen-dependency/")
|
||||
async def get_async_wrapped_gen_dependency(
|
||||
value: bool = Depends(async_wrapped_gen_dependency),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/wrapped-class-instance-dependency/")
|
||||
async def get_wrapped_class_instance_dependency(
|
||||
value: bool = Depends(wrapped_class_instance_dep),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/wrapped-class-instance-async-dependency/")
|
||||
async def get_wrapped_class_instance_async_dependency(
|
||||
value: bool = Depends(wrapped_class_instance_async_dep),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/wrapped-class-instance-gen-dependency/")
|
||||
async def get_wrapped_class_instance_gen_dependency(
|
||||
value: bool = Depends(wrapped_class_instance_gen_dep),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/wrapped-class-instance-async-gen-dependency/")
|
||||
async def get_wrapped_class_instance_async_gen_dependency(
|
||||
value: bool = Depends(wrapped_class_instance_async_gen_dep),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/class-instance-wrapped-dependency/")
|
||||
async def get_class_instance_wrapped_dependency(
|
||||
value: bool = Depends(class_instance_wrapped_dep),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/class-instance-wrapped-async-dependency/")
|
||||
async def get_class_instance_wrapped_async_dependency(
|
||||
value: bool = Depends(class_instance_wrapped_async_dep),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/class-instance-async-wrapped-dependency/")
|
||||
async def get_class_instance_async_wrapped_dependency(
|
||||
value: bool = Depends(class_instance_async_wrapped_dep),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/class-instance-async-wrapped-async-dependency/")
|
||||
async def get_class_instance_async_wrapped_async_dependency(
|
||||
value: bool = Depends(class_instance_async_wrapped_async_dep),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/class-instance-wrapped-gen-dependency/")
|
||||
async def get_class_instance_wrapped_gen_dependency(
|
||||
value: bool = Depends(class_instance_wrapped_gen_dep),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/class-instance-wrapped-async-gen-dependency/")
|
||||
async def get_class_instance_wrapped_async_gen_dependency(
|
||||
value: bool = Depends(class_instance_wrapped_async_gen_dep),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/class-instance-async-wrapped-gen-dependency/")
|
||||
async def get_class_instance_async_wrapped_gen_dependency(
|
||||
value: bool = Depends(class_instance_async_wrapped_gen_dep),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/class-instance-async-wrapped-gen-async-dependency/")
|
||||
async def get_class_instance_async_wrapped_gen_async_dependency(
|
||||
value: bool = Depends(class_instance_async_wrapped_gen_async_dep),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/wrapped-class-dependency/")
|
||||
async def get_wrapped_class_dependency(value: ClassDep = Depends(wrapped_class_dep)):
|
||||
return value.value
|
||||
|
||||
|
||||
@app.get("/wrapped-endpoint/")
|
||||
@noop_wrap
|
||||
def get_wrapped_endpoint():
|
||||
return True
|
||||
|
||||
|
||||
@app.get("/async-wrapped-endpoint/")
|
||||
@noop_wrap
|
||||
async def get_async_wrapped_endpoint():
|
||||
return True
|
||||
|
||||
|
||||
# Async wrapper
|
||||
|
||||
|
||||
@noop_wrap_async
|
||||
def wrapped_dependency_async_wrapper() -> bool:
|
||||
return True
|
||||
|
||||
|
||||
@noop_wrap_async
|
||||
def wrapped_gen_dependency_async_wrapper() -> Generator[bool, None, None]:
|
||||
yield True
|
||||
|
||||
|
||||
@noop_wrap_async
|
||||
async def async_wrapped_dependency_async_wrapper() -> bool:
|
||||
return True
|
||||
|
||||
|
||||
@noop_wrap_async
|
||||
async def async_wrapped_gen_dependency_async_wrapper() -> AsyncGenerator[bool, None]:
|
||||
yield True
|
||||
|
||||
|
||||
@app.get("/wrapped-dependency-async-wrapper/")
|
||||
async def get_wrapped_dependency_async_wrapper(
|
||||
value: bool = Depends(wrapped_dependency_async_wrapper),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/wrapped-gen-dependency-async-wrapper/")
|
||||
async def get_wrapped_gen_dependency_async_wrapper(
|
||||
value: bool = Depends(wrapped_gen_dependency_async_wrapper),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/async-wrapped-dependency-async-wrapper/")
|
||||
async def get_async_wrapped_dependency_async_wrapper(
|
||||
value: bool = Depends(async_wrapped_dependency_async_wrapper),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/async-wrapped-gen-dependency-async-wrapper/")
|
||||
async def get_async_wrapped_gen_dependency_async_wrapper(
|
||||
value: bool = Depends(async_wrapped_gen_dependency_async_wrapper),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/wrapped-class-instance-dependency-async-wrapper/")
|
||||
async def get_wrapped_class_instance_dependency_async_wrapper(
|
||||
value: bool = Depends(wrapped_class_instance_dep_async_wrapper),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/wrapped-class-instance-async-dependency-async-wrapper/")
|
||||
async def get_wrapped_class_instance_async_dependency_async_wrapper(
|
||||
value: bool = Depends(wrapped_class_instance_async_dep_async_wrapper),
|
||||
):
|
||||
return value
|
||||
|
||||
|
||||
@app.get("/wrapped-class-dependency-async-wrapper/")
|
||||
async def get_wrapped_class_dependency_async_wrapper(
|
||||
value: ClassDep = Depends(wrapped_class_dep_async_wrapper),
|
||||
):
|
||||
return value.value
|
||||
|
||||
|
||||
@app.get("/wrapped-endpoint-async-wrapper/")
|
||||
@noop_wrap_async
|
||||
def get_wrapped_endpoint_async_wrapper():
|
||||
return True
|
||||
|
||||
|
||||
@app.get("/async-wrapped-endpoint-async-wrapper/")
|
||||
@noop_wrap_async
|
||||
async def get_async_wrapped_endpoint_async_wrapper():
|
||||
return True
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"route",
|
||||
[
|
||||
"/wrapped-dependency/",
|
||||
"/wrapped-gen-dependency/",
|
||||
"/async-wrapped-dependency/",
|
||||
"/async-wrapped-gen-dependency/",
|
||||
"/wrapped-class-instance-dependency/",
|
||||
"/wrapped-class-instance-async-dependency/",
|
||||
"/wrapped-class-instance-gen-dependency/",
|
||||
"/wrapped-class-instance-async-gen-dependency/",
|
||||
"/class-instance-wrapped-dependency/",
|
||||
"/class-instance-wrapped-async-dependency/",
|
||||
"/class-instance-async-wrapped-dependency/",
|
||||
"/class-instance-async-wrapped-async-dependency/",
|
||||
"/class-instance-wrapped-gen-dependency/",
|
||||
"/class-instance-wrapped-async-gen-dependency/",
|
||||
"/class-instance-async-wrapped-gen-dependency/",
|
||||
"/class-instance-async-wrapped-gen-async-dependency/",
|
||||
"/wrapped-class-dependency/",
|
||||
"/wrapped-endpoint/",
|
||||
"/async-wrapped-endpoint/",
|
||||
"/wrapped-dependency-async-wrapper/",
|
||||
"/wrapped-gen-dependency-async-wrapper/",
|
||||
"/async-wrapped-dependency-async-wrapper/",
|
||||
"/async-wrapped-gen-dependency-async-wrapper/",
|
||||
"/wrapped-class-instance-dependency-async-wrapper/",
|
||||
"/wrapped-class-instance-async-dependency-async-wrapper/",
|
||||
"/wrapped-class-dependency-async-wrapper/",
|
||||
"/wrapped-endpoint-async-wrapper/",
|
||||
"/async-wrapped-endpoint-async-wrapper/",
|
||||
],
|
||||
)
|
||||
def test_class_dependency(route):
|
||||
response = client.get(route)
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() is True
|
||||
@@ -0,0 +1,72 @@
|
||||
import pytest
|
||||
from fastapi import Body, Depends, FastAPI, HTTPException
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
initial_fake_database = {"rick": "Rick Sanchez"}
|
||||
|
||||
fake_database = initial_fake_database.copy()
|
||||
|
||||
initial_state = {"except": False, "finally": False}
|
||||
|
||||
state = initial_state.copy()
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
async def get_database():
|
||||
temp_database = fake_database.copy()
|
||||
try:
|
||||
yield temp_database
|
||||
fake_database.update(temp_database)
|
||||
except HTTPException:
|
||||
state["except"] = True
|
||||
raise
|
||||
finally:
|
||||
state["finally"] = True
|
||||
|
||||
|
||||
@app.put("/invalid-user/{user_id}")
|
||||
def put_invalid_user(
|
||||
user_id: str, name: str = Body(), db: dict = Depends(get_database)
|
||||
):
|
||||
db[user_id] = name
|
||||
raise HTTPException(status_code=400, detail="Invalid user")
|
||||
|
||||
|
||||
@app.put("/user/{user_id}")
|
||||
def put_user(user_id: str, name: str = Body(), db: dict = Depends(get_database)):
|
||||
db[user_id] = name
|
||||
return {"message": "OK"}
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True)
|
||||
def reset_state_and_db():
|
||||
global fake_database
|
||||
global state
|
||||
fake_database = initial_fake_database.copy()
|
||||
state = initial_state.copy()
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_dependency_gets_exception():
|
||||
assert state["except"] is False
|
||||
assert state["finally"] is False
|
||||
response = client.put("/invalid-user/rick", json="Morty")
|
||||
assert response.status_code == 400, response.text
|
||||
assert response.json() == {"detail": "Invalid user"}
|
||||
assert state["except"] is True
|
||||
assert state["finally"] is True
|
||||
assert fake_database["rick"] == "Rick Sanchez"
|
||||
|
||||
|
||||
def test_dependency_no_exception():
|
||||
assert state["except"] is False
|
||||
assert state["finally"] is False
|
||||
response = client.put("/user/rick", json="Morty")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"message": "OK"}
|
||||
assert state["except"] is False
|
||||
assert state["finally"] is True
|
||||
assert fake_database["rick"] == "Morty"
|
||||
@@ -0,0 +1,246 @@
|
||||
import json
|
||||
from typing import Any, Tuple
|
||||
|
||||
import pytest
|
||||
from fastapi import APIRouter, Depends, FastAPI, HTTPException
|
||||
from fastapi.exceptions import FastAPIError
|
||||
from fastapi.responses import StreamingResponse
|
||||
from fastapi.testclient import TestClient
|
||||
from typing_extensions import Annotated
|
||||
|
||||
|
||||
class Session:
|
||||
def __init__(self) -> None:
|
||||
self.open = True
|
||||
|
||||
|
||||
def dep_session() -> Any:
|
||||
s = Session()
|
||||
yield s
|
||||
s.open = False
|
||||
|
||||
|
||||
def raise_after_yield() -> Any:
|
||||
yield
|
||||
raise HTTPException(status_code=503, detail="Exception after yield")
|
||||
|
||||
|
||||
SessionFuncDep = Annotated[Session, Depends(dep_session, scope="function")]
|
||||
SessionRequestDep = Annotated[Session, Depends(dep_session, scope="request")]
|
||||
SessionDefaultDep = Annotated[Session, Depends(dep_session)]
|
||||
|
||||
|
||||
class NamedSession:
|
||||
def __init__(self, name: str = "default") -> None:
|
||||
self.name = name
|
||||
self.open = True
|
||||
|
||||
|
||||
def get_named_session(session: SessionRequestDep, session_b: SessionDefaultDep) -> Any:
|
||||
assert session is session_b
|
||||
named_session = NamedSession(name="named")
|
||||
yield named_session, session_b
|
||||
named_session.open = False
|
||||
|
||||
|
||||
NamedSessionsDep = Annotated[Tuple[NamedSession, Session], Depends(get_named_session)]
|
||||
|
||||
|
||||
def get_named_func_session(session: SessionFuncDep) -> Any:
|
||||
named_session = NamedSession(name="named")
|
||||
yield named_session, session
|
||||
named_session.open = False
|
||||
|
||||
|
||||
def get_named_regular_func_session(session: SessionFuncDep) -> Any:
|
||||
named_session = NamedSession(name="named")
|
||||
return named_session, session
|
||||
|
||||
|
||||
BrokenSessionsDep = Annotated[
|
||||
Tuple[NamedSession, Session], Depends(get_named_func_session)
|
||||
]
|
||||
NamedSessionsFuncDep = Annotated[
|
||||
Tuple[NamedSession, Session], Depends(get_named_func_session, scope="function")
|
||||
]
|
||||
|
||||
RegularSessionsDep = Annotated[
|
||||
Tuple[NamedSession, Session], Depends(get_named_regular_func_session)
|
||||
]
|
||||
|
||||
app = FastAPI()
|
||||
router = APIRouter()
|
||||
|
||||
|
||||
@router.get("/")
|
||||
def get_index():
|
||||
return {"status": "ok"}
|
||||
|
||||
|
||||
@app.get("/function-scope")
|
||||
def function_scope(session: SessionFuncDep) -> Any:
|
||||
def iter_data():
|
||||
yield json.dumps({"is_open": session.open})
|
||||
|
||||
return StreamingResponse(iter_data())
|
||||
|
||||
|
||||
@app.get("/request-scope")
|
||||
def request_scope(session: SessionRequestDep) -> Any:
|
||||
def iter_data():
|
||||
yield json.dumps({"is_open": session.open})
|
||||
|
||||
return StreamingResponse(iter_data())
|
||||
|
||||
|
||||
@app.get("/two-scopes")
|
||||
def get_stream_session(
|
||||
function_session: SessionFuncDep, request_session: SessionRequestDep
|
||||
) -> Any:
|
||||
def iter_data():
|
||||
yield json.dumps(
|
||||
{"func_is_open": function_session.open, "req_is_open": request_session.open}
|
||||
)
|
||||
|
||||
return StreamingResponse(iter_data())
|
||||
|
||||
|
||||
@app.get("/sub")
|
||||
def get_sub(sessions: NamedSessionsDep) -> Any:
|
||||
def iter_data():
|
||||
yield json.dumps(
|
||||
{"named_session_open": sessions[0].open, "session_open": sessions[1].open}
|
||||
)
|
||||
|
||||
return StreamingResponse(iter_data())
|
||||
|
||||
|
||||
@app.get("/named-function-scope")
|
||||
def get_named_function_scope(sessions: NamedSessionsFuncDep) -> Any:
|
||||
def iter_data():
|
||||
yield json.dumps(
|
||||
{"named_session_open": sessions[0].open, "session_open": sessions[1].open}
|
||||
)
|
||||
|
||||
return StreamingResponse(iter_data())
|
||||
|
||||
|
||||
@app.get("/regular-function-scope")
|
||||
def get_regular_function_scope(sessions: RegularSessionsDep) -> Any:
|
||||
def iter_data():
|
||||
yield json.dumps(
|
||||
{"named_session_open": sessions[0].open, "session_open": sessions[1].open}
|
||||
)
|
||||
|
||||
return StreamingResponse(iter_data())
|
||||
|
||||
|
||||
app.include_router(
|
||||
prefix="/router-scope-function",
|
||||
router=router,
|
||||
dependencies=[Depends(raise_after_yield, scope="function")],
|
||||
)
|
||||
|
||||
app.include_router(
|
||||
prefix="/router-scope-request",
|
||||
router=router,
|
||||
dependencies=[Depends(raise_after_yield, scope="request")],
|
||||
)
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_function_scope() -> None:
|
||||
response = client.get("/function-scope")
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert data["is_open"] is False
|
||||
|
||||
|
||||
def test_request_scope() -> None:
|
||||
response = client.get("/request-scope")
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert data["is_open"] is True
|
||||
|
||||
|
||||
def test_two_scopes() -> None:
|
||||
response = client.get("/two-scopes")
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert data["func_is_open"] is False
|
||||
assert data["req_is_open"] is True
|
||||
|
||||
|
||||
def test_sub() -> None:
|
||||
response = client.get("/sub")
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert data["named_session_open"] is True
|
||||
assert data["session_open"] is True
|
||||
|
||||
|
||||
def test_broken_scope() -> None:
|
||||
with pytest.raises(
|
||||
FastAPIError,
|
||||
match='The dependency "get_named_func_session" has a scope of "request", it cannot depend on dependencies with scope "function"',
|
||||
):
|
||||
|
||||
@app.get("/broken-scope")
|
||||
def get_broken(sessions: BrokenSessionsDep) -> Any: # pragma: no cover
|
||||
pass
|
||||
|
||||
|
||||
def test_named_function_scope() -> None:
|
||||
response = client.get("/named-function-scope")
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert data["named_session_open"] is False
|
||||
assert data["session_open"] is False
|
||||
|
||||
|
||||
def test_regular_function_scope() -> None:
|
||||
response = client.get("/regular-function-scope")
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert data["named_session_open"] is True
|
||||
assert data["session_open"] is False
|
||||
|
||||
|
||||
def test_router_level_dep_scope_function() -> None:
|
||||
response = client.get("/router-scope-function/")
|
||||
assert response.status_code == 503
|
||||
assert response.json() == {"detail": "Exception after yield"}
|
||||
|
||||
|
||||
def test_router_level_dep_scope_request() -> None:
|
||||
with TestClient(app, raise_server_exceptions=False) as client:
|
||||
response = client.get("/router-scope-request/")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"status": "ok"}
|
||||
|
||||
|
||||
def test_app_level_dep_scope_function() -> None:
|
||||
app = FastAPI(dependencies=[Depends(raise_after_yield, scope="function")])
|
||||
|
||||
@app.get("/app-scope-function")
|
||||
def get_app_scope_function():
|
||||
return {"status": "ok"}
|
||||
|
||||
with TestClient(app) as client:
|
||||
response = client.get("/app-scope-function")
|
||||
assert response.status_code == 503
|
||||
assert response.json() == {"detail": "Exception after yield"}
|
||||
|
||||
|
||||
def test_app_level_dep_scope_request() -> None:
|
||||
app = FastAPI(dependencies=[Depends(raise_after_yield, scope="request")])
|
||||
|
||||
@app.get("/app-scope-request")
|
||||
def get_app_scope_request():
|
||||
return {"status": "ok"}
|
||||
|
||||
with TestClient(app, raise_server_exceptions=False) as client:
|
||||
response = client.get("/app-scope-request")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"status": "ok"}
|
||||
@@ -0,0 +1,201 @@
|
||||
from contextvars import ContextVar
|
||||
from typing import Any, Dict, Tuple
|
||||
|
||||
import pytest
|
||||
from fastapi import Depends, FastAPI, WebSocket
|
||||
from fastapi.exceptions import FastAPIError
|
||||
from fastapi.testclient import TestClient
|
||||
from typing_extensions import Annotated
|
||||
|
||||
global_context: ContextVar[Dict[str, Any]] = ContextVar("global_context", default={}) # noqa: B039
|
||||
|
||||
|
||||
class Session:
|
||||
def __init__(self) -> None:
|
||||
self.open = True
|
||||
|
||||
|
||||
async def dep_session() -> Any:
|
||||
s = Session()
|
||||
yield s
|
||||
s.open = False
|
||||
global_state = global_context.get()
|
||||
global_state["session_closed"] = True
|
||||
|
||||
|
||||
SessionFuncDep = Annotated[Session, Depends(dep_session, scope="function")]
|
||||
SessionRequestDep = Annotated[Session, Depends(dep_session, scope="request")]
|
||||
SessionDefaultDep = Annotated[Session, Depends(dep_session)]
|
||||
|
||||
|
||||
class NamedSession:
|
||||
def __init__(self, name: str = "default") -> None:
|
||||
self.name = name
|
||||
self.open = True
|
||||
|
||||
|
||||
def get_named_session(session: SessionRequestDep, session_b: SessionDefaultDep) -> Any:
|
||||
assert session is session_b
|
||||
named_session = NamedSession(name="named")
|
||||
yield named_session, session_b
|
||||
named_session.open = False
|
||||
global_state = global_context.get()
|
||||
global_state["named_session_closed"] = True
|
||||
|
||||
|
||||
NamedSessionsDep = Annotated[Tuple[NamedSession, Session], Depends(get_named_session)]
|
||||
|
||||
|
||||
def get_named_func_session(session: SessionFuncDep) -> Any:
|
||||
named_session = NamedSession(name="named")
|
||||
yield named_session, session
|
||||
named_session.open = False
|
||||
global_state = global_context.get()
|
||||
global_state["named_func_session_closed"] = True
|
||||
|
||||
|
||||
def get_named_regular_func_session(session: SessionFuncDep) -> Any:
|
||||
named_session = NamedSession(name="named")
|
||||
return named_session, session
|
||||
|
||||
|
||||
BrokenSessionsDep = Annotated[
|
||||
Tuple[NamedSession, Session], Depends(get_named_func_session)
|
||||
]
|
||||
NamedSessionsFuncDep = Annotated[
|
||||
Tuple[NamedSession, Session], Depends(get_named_func_session, scope="function")
|
||||
]
|
||||
|
||||
RegularSessionsDep = Annotated[
|
||||
Tuple[NamedSession, Session], Depends(get_named_regular_func_session)
|
||||
]
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.websocket("/function-scope")
|
||||
async def function_scope(websocket: WebSocket, session: SessionFuncDep) -> Any:
|
||||
await websocket.accept()
|
||||
await websocket.send_json({"is_open": session.open})
|
||||
|
||||
|
||||
@app.websocket("/request-scope")
|
||||
async def request_scope(websocket: WebSocket, session: SessionRequestDep) -> Any:
|
||||
await websocket.accept()
|
||||
await websocket.send_json({"is_open": session.open})
|
||||
|
||||
|
||||
@app.websocket("/two-scopes")
|
||||
async def get_stream_session(
|
||||
websocket: WebSocket,
|
||||
function_session: SessionFuncDep,
|
||||
request_session: SessionRequestDep,
|
||||
) -> Any:
|
||||
await websocket.accept()
|
||||
await websocket.send_json(
|
||||
{"func_is_open": function_session.open, "req_is_open": request_session.open}
|
||||
)
|
||||
|
||||
|
||||
@app.websocket("/sub")
|
||||
async def get_sub(websocket: WebSocket, sessions: NamedSessionsDep) -> Any:
|
||||
await websocket.accept()
|
||||
await websocket.send_json(
|
||||
{"named_session_open": sessions[0].open, "session_open": sessions[1].open}
|
||||
)
|
||||
|
||||
|
||||
@app.websocket("/named-function-scope")
|
||||
async def get_named_function_scope(
|
||||
websocket: WebSocket, sessions: NamedSessionsFuncDep
|
||||
) -> Any:
|
||||
await websocket.accept()
|
||||
await websocket.send_json(
|
||||
{"named_session_open": sessions[0].open, "session_open": sessions[1].open}
|
||||
)
|
||||
|
||||
|
||||
@app.websocket("/regular-function-scope")
|
||||
async def get_regular_function_scope(
|
||||
websocket: WebSocket, sessions: RegularSessionsDep
|
||||
) -> Any:
|
||||
await websocket.accept()
|
||||
await websocket.send_json(
|
||||
{"named_session_open": sessions[0].open, "session_open": sessions[1].open}
|
||||
)
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_function_scope() -> None:
|
||||
global_context.set({})
|
||||
global_state = global_context.get()
|
||||
with client.websocket_connect("/function-scope") as websocket:
|
||||
data = websocket.receive_json()
|
||||
assert data["is_open"] is True
|
||||
assert global_state["session_closed"] is True
|
||||
|
||||
|
||||
def test_request_scope() -> None:
|
||||
global_context.set({})
|
||||
global_state = global_context.get()
|
||||
with client.websocket_connect("/request-scope") as websocket:
|
||||
data = websocket.receive_json()
|
||||
assert data["is_open"] is True
|
||||
assert global_state["session_closed"] is True
|
||||
|
||||
|
||||
def test_two_scopes() -> None:
|
||||
global_context.set({})
|
||||
global_state = global_context.get()
|
||||
with client.websocket_connect("/two-scopes") as websocket:
|
||||
data = websocket.receive_json()
|
||||
assert data["func_is_open"] is True
|
||||
assert data["req_is_open"] is True
|
||||
assert global_state["session_closed"] is True
|
||||
|
||||
|
||||
def test_sub() -> None:
|
||||
global_context.set({})
|
||||
global_state = global_context.get()
|
||||
with client.websocket_connect("/sub") as websocket:
|
||||
data = websocket.receive_json()
|
||||
assert data["named_session_open"] is True
|
||||
assert data["session_open"] is True
|
||||
assert global_state["session_closed"] is True
|
||||
assert global_state["named_session_closed"] is True
|
||||
|
||||
|
||||
def test_broken_scope() -> None:
|
||||
with pytest.raises(
|
||||
FastAPIError,
|
||||
match='The dependency "get_named_func_session" has a scope of "request", it cannot depend on dependencies with scope "function"',
|
||||
):
|
||||
|
||||
@app.websocket("/broken-scope")
|
||||
async def get_broken(
|
||||
websocket: WebSocket, sessions: BrokenSessionsDep
|
||||
) -> Any: # pragma: no cover
|
||||
pass
|
||||
|
||||
|
||||
def test_named_function_scope() -> None:
|
||||
global_context.set({})
|
||||
global_state = global_context.get()
|
||||
with client.websocket_connect("/named-function-scope") as websocket:
|
||||
data = websocket.receive_json()
|
||||
assert data["named_session_open"] is True
|
||||
assert data["session_open"] is True
|
||||
assert global_state["session_closed"] is True
|
||||
assert global_state["named_func_session_closed"] is True
|
||||
|
||||
|
||||
def test_regular_function_scope() -> None:
|
||||
global_context.set({})
|
||||
global_state = global_context.get()
|
||||
with client.websocket_connect("/regular-function-scope") as websocket:
|
||||
data = websocket.receive_json()
|
||||
assert data["named_session_open"] is True
|
||||
assert data["session_open"] is True
|
||||
assert global_state["session_closed"] is True
|
||||
@@ -0,0 +1,25 @@
|
||||
# This is more or less a workaround to make Depends and Security hashable
|
||||
# as other tools that use them depend on that
|
||||
# Ref: https://github.com/fastapi/fastapi/pull/14320
|
||||
|
||||
from fastapi import Depends, Security
|
||||
|
||||
|
||||
def dep():
|
||||
pass
|
||||
|
||||
|
||||
def test_depends_hashable():
|
||||
dep() # just for coverage
|
||||
d1 = Depends(dep)
|
||||
d2 = Depends(dep)
|
||||
d3 = Depends(dep, scope="function")
|
||||
d4 = Depends(dep, scope="function")
|
||||
|
||||
s1 = Security(dep)
|
||||
s2 = Security(dep)
|
||||
|
||||
assert hash(d1) == hash(d2)
|
||||
assert hash(s1) == hash(s2)
|
||||
assert hash(d1) != hash(d3)
|
||||
assert hash(d3) == hash(d4)
|
||||
@@ -0,0 +1,42 @@
|
||||
from fastapi import FastAPI, Request
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI(openapi_prefix="/api/v1")
|
||||
|
||||
|
||||
@app.get("/app")
|
||||
def read_main(request: Request):
|
||||
return {"message": "Hello World", "root_path": request.scope.get("root_path")}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_main():
|
||||
response = client.get("/app")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"message": "Hello World", "root_path": "/api/v1"}
|
||||
|
||||
|
||||
def test_openapi():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/app": {
|
||||
"get": {
|
||||
"summary": "Read Main",
|
||||
"operationId": "read_main_app_get",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
"servers": [{"url": "/api/v1"}],
|
||||
}
|
||||
@@ -0,0 +1,79 @@
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
class Model(BaseModel):
|
||||
pass
|
||||
|
||||
|
||||
class Model2(BaseModel):
|
||||
a: Model
|
||||
|
||||
|
||||
class Model3(BaseModel):
|
||||
c: Model
|
||||
d: Model2
|
||||
|
||||
|
||||
@app.get("/", response_model=Model3)
|
||||
def f():
|
||||
return {"c": {}, "d": {"a": {}}}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_get_api_route():
|
||||
response = client.get("/")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"c": {}, "d": {"a": {}}}
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/": {
|
||||
"get": {
|
||||
"summary": "F",
|
||||
"operationId": "f__get",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {"$ref": "#/components/schemas/Model3"}
|
||||
}
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"Model": {"title": "Model", "type": "object", "properties": {}},
|
||||
"Model2": {
|
||||
"title": "Model2",
|
||||
"required": ["a"],
|
||||
"type": "object",
|
||||
"properties": {"a": {"$ref": "#/components/schemas/Model"}},
|
||||
},
|
||||
"Model3": {
|
||||
"title": "Model3",
|
||||
"required": ["c", "d"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"c": {"$ref": "#/components/schemas/Model"},
|
||||
"d": {"$ref": "#/components/schemas/Model2"},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
import pytest
|
||||
from fastapi import APIRouter, FastAPI
|
||||
from fastapi.exceptions import FastAPIError
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
router = APIRouter()
|
||||
|
||||
|
||||
@router.get("")
|
||||
def get_empty():
|
||||
return ["OK"]
|
||||
|
||||
|
||||
app.include_router(router, prefix="/prefix")
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_use_empty():
|
||||
with client:
|
||||
response = client.get("/prefix")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == ["OK"]
|
||||
|
||||
response = client.get("/prefix/")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == ["OK"]
|
||||
|
||||
|
||||
def test_include_empty():
|
||||
# if both include and router.path are empty - it should raise exception
|
||||
with pytest.raises(FastAPIError):
|
||||
app.include_router(router)
|
||||
@@ -0,0 +1,111 @@
|
||||
from typing import Optional
|
||||
|
||||
from fastapi import Depends, FastAPI, Query, status
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
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)
|
||||
|
||||
expected_schema = {
|
||||
"components": {
|
||||
"schemas": {
|
||||
"HTTPValidationError": {
|
||||
"properties": {
|
||||
"detail": {
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
}
|
||||
},
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
},
|
||||
"ValidationError": {
|
||||
"properties": {
|
||||
"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",
|
||||
}
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
def test_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == status.HTTP_200_OK
|
||||
actual_schema = response.json()
|
||||
assert actual_schema == expected_schema
|
||||
|
||||
|
||||
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"}
|
||||
@@ -0,0 +1,88 @@
|
||||
import pytest
|
||||
from fastapi import Depends, FastAPI, HTTPException
|
||||
from fastapi.exceptions import RequestValidationError
|
||||
from fastapi.testclient import TestClient
|
||||
from starlette.responses import JSONResponse
|
||||
|
||||
|
||||
def http_exception_handler(request, exception):
|
||||
return JSONResponse({"exception": "http-exception"})
|
||||
|
||||
|
||||
def request_validation_exception_handler(request, exception):
|
||||
return JSONResponse({"exception": "request-validation"})
|
||||
|
||||
|
||||
def server_error_exception_handler(request, exception):
|
||||
return JSONResponse(status_code=500, content={"exception": "server-error"})
|
||||
|
||||
|
||||
app = FastAPI(
|
||||
exception_handlers={
|
||||
HTTPException: http_exception_handler,
|
||||
RequestValidationError: request_validation_exception_handler,
|
||||
Exception: server_error_exception_handler,
|
||||
}
|
||||
)
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def raise_value_error():
|
||||
raise ValueError()
|
||||
|
||||
|
||||
def dependency_with_yield():
|
||||
yield raise_value_error()
|
||||
|
||||
|
||||
@app.get("/dependency-with-yield", dependencies=[Depends(dependency_with_yield)])
|
||||
def with_yield(): ...
|
||||
|
||||
|
||||
@app.get("/http-exception")
|
||||
def route_with_http_exception():
|
||||
raise HTTPException(status_code=400)
|
||||
|
||||
|
||||
@app.get("/request-validation/{param}/")
|
||||
def route_with_request_validation_exception(param: int):
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
@app.get("/server-error")
|
||||
def route_with_server_error():
|
||||
raise RuntimeError("Oops!")
|
||||
|
||||
|
||||
def test_override_http_exception():
|
||||
response = client.get("/http-exception")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"exception": "http-exception"}
|
||||
|
||||
|
||||
def test_override_request_validation_exception():
|
||||
response = client.get("/request-validation/invalid")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"exception": "request-validation"}
|
||||
|
||||
|
||||
def test_override_server_error_exception_raises():
|
||||
with pytest.raises(RuntimeError):
|
||||
client.get("/server-error")
|
||||
|
||||
|
||||
def test_override_server_error_exception_response():
|
||||
client = TestClient(app, raise_server_exceptions=False)
|
||||
response = client.get("/server-error")
|
||||
assert response.status_code == 500
|
||||
assert response.json() == {"exception": "server-error"}
|
||||
|
||||
|
||||
def test_traceback_for_dependency_with_yield():
|
||||
client = TestClient(app, raise_server_exceptions=True)
|
||||
with pytest.raises(ValueError) as exc_info:
|
||||
client.get("/dependency-with-yield")
|
||||
last_frame = exc_info.traceback[-1]
|
||||
assert str(last_frame.path) == __file__
|
||||
assert last_frame.lineno == raise_value_error.__code__.co_firstlineno
|
||||
@@ -0,0 +1,370 @@
|
||||
from typing import Optional
|
||||
|
||||
from dirty_equals import IsDict
|
||||
from fastapi import FastAPI
|
||||
from fastapi.responses import JSONResponse
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
class Item(BaseModel):
|
||||
name: str
|
||||
price: Optional[float] = None
|
||||
|
||||
|
||||
@app.api_route("/items/{item_id}", methods=["GET"])
|
||||
def get_items(item_id: str):
|
||||
return {"item_id": item_id}
|
||||
|
||||
|
||||
def get_not_decorated(item_id: str):
|
||||
return {"item_id": item_id}
|
||||
|
||||
|
||||
app.add_api_route("/items-not-decorated/{item_id}", get_not_decorated)
|
||||
|
||||
|
||||
@app.delete("/items/{item_id}")
|
||||
def delete_item(item_id: str, item: Item):
|
||||
return {"item_id": item_id, "item": item}
|
||||
|
||||
|
||||
@app.head("/items/{item_id}")
|
||||
def head_item(item_id: str):
|
||||
return JSONResponse(None, headers={"x-fastapi-item-id": item_id})
|
||||
|
||||
|
||||
@app.options("/items/{item_id}")
|
||||
def options_item(item_id: str):
|
||||
return JSONResponse(None, headers={"x-fastapi-item-id": item_id})
|
||||
|
||||
|
||||
@app.patch("/items/{item_id}")
|
||||
def patch_item(item_id: str, item: Item):
|
||||
return {"item_id": item_id, "item": item}
|
||||
|
||||
|
||||
@app.trace("/items/{item_id}")
|
||||
def trace_item(item_id: str):
|
||||
return JSONResponse(None, media_type="message/http")
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_get_api_route():
|
||||
response = client.get("/items/foo")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"item_id": "foo"}
|
||||
|
||||
|
||||
def test_get_api_route_not_decorated():
|
||||
response = client.get("/items-not-decorated/foo")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"item_id": "foo"}
|
||||
|
||||
|
||||
def test_delete():
|
||||
response = client.request("DELETE", "/items/foo", json={"name": "Foo"})
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"item_id": "foo", "item": {"name": "Foo", "price": None}}
|
||||
|
||||
|
||||
def test_head():
|
||||
response = client.head("/items/foo")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.headers["x-fastapi-item-id"] == "foo"
|
||||
|
||||
|
||||
def test_options():
|
||||
response = client.options("/items/foo")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.headers["x-fastapi-item-id"] == "foo"
|
||||
|
||||
|
||||
def test_patch():
|
||||
response = client.patch("/items/foo", json={"name": "Foo"})
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"item_id": "foo", "item": {"name": "Foo", "price": None}}
|
||||
|
||||
|
||||
def test_trace():
|
||||
response = client.request("trace", "/items/foo")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.headers["content-type"] == "message/http"
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/items/{item_id}": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
"summary": "Get Items",
|
||||
"operationId": "get_items_items__item_id__get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "Item Id", "type": "string"},
|
||||
"name": "item_id",
|
||||
"in": "path",
|
||||
}
|
||||
],
|
||||
},
|
||||
"delete": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
"summary": "Delete Item",
|
||||
"operationId": "delete_item_items__item_id__delete",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "Item Id", "type": "string"},
|
||||
"name": "item_id",
|
||||
"in": "path",
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {"$ref": "#/components/schemas/Item"}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
},
|
||||
"options": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
"summary": "Options Item",
|
||||
"operationId": "options_item_items__item_id__options",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "Item Id", "type": "string"},
|
||||
"name": "item_id",
|
||||
"in": "path",
|
||||
}
|
||||
],
|
||||
},
|
||||
"head": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
"summary": "Head Item",
|
||||
"operationId": "head_item_items__item_id__head",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "Item Id", "type": "string"},
|
||||
"name": "item_id",
|
||||
"in": "path",
|
||||
}
|
||||
],
|
||||
},
|
||||
"patch": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
"summary": "Patch Item",
|
||||
"operationId": "patch_item_items__item_id__patch",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "Item Id", "type": "string"},
|
||||
"name": "item_id",
|
||||
"in": "path",
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {"$ref": "#/components/schemas/Item"}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
},
|
||||
"trace": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
"summary": "Trace Item",
|
||||
"operationId": "trace_item_items__item_id__trace",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "Item Id", "type": "string"},
|
||||
"name": "item_id",
|
||||
"in": "path",
|
||||
}
|
||||
],
|
||||
},
|
||||
},
|
||||
"/items-not-decorated/{item_id}": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
"summary": "Get Not Decorated",
|
||||
"operationId": "get_not_decorated_items_not_decorated__item_id__get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "Item Id", "type": "string"},
|
||||
"name": "item_id",
|
||||
"in": "path",
|
||||
}
|
||||
],
|
||||
}
|
||||
},
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"Item": {
|
||||
"title": "Item",
|
||||
"required": ["name"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {"title": "Name", "type": "string"},
|
||||
"price": IsDict(
|
||||
{
|
||||
"title": "Price",
|
||||
"anyOf": [{"type": "number"}, {"type": "null"}],
|
||||
}
|
||||
)
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
| IsDict({"title": "Price", "type": "number"}),
|
||||
},
|
||||
},
|
||||
"ValidationError": {
|
||||
"title": "ValidationError",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"loc": {
|
||||
"title": "Location",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
},
|
||||
"msg": {"title": "Message", "type": "string"},
|
||||
"type": {"title": "Error Type", "type": "string"},
|
||||
},
|
||||
},
|
||||
"HTTPValidationError": {
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
from unittest.mock import patch
|
||||
|
||||
import fastapi.cli
|
||||
import pytest
|
||||
|
||||
|
||||
def test_fastapi_cli():
|
||||
result = subprocess.run(
|
||||
[
|
||||
sys.executable,
|
||||
"-m",
|
||||
"coverage",
|
||||
"run",
|
||||
"-m",
|
||||
"fastapi",
|
||||
"dev",
|
||||
"non_existent_file.py",
|
||||
],
|
||||
capture_output=True,
|
||||
encoding="utf-8",
|
||||
env={**os.environ, "PYTHONIOENCODING": "utf-8"},
|
||||
)
|
||||
assert result.returncode == 1, result.stdout
|
||||
assert "Path does not exist non_existent_file.py" in result.stdout
|
||||
|
||||
|
||||
def test_fastapi_cli_not_installed():
|
||||
with patch.object(fastapi.cli, "cli_main", None):
|
||||
with pytest.raises(RuntimeError) as exc_info:
|
||||
fastapi.cli.main()
|
||||
assert "To use the fastapi command, please install" in str(exc_info.value)
|
||||
@@ -0,0 +1,90 @@
|
||||
"""
|
||||
Regression test, Error 422 if Form is declared before File
|
||||
See https://github.com/tiangolo/fastapi/discussions/9116
|
||||
"""
|
||||
|
||||
from pathlib import Path
|
||||
from typing import List
|
||||
|
||||
import pytest
|
||||
from fastapi import FastAPI, File, Form
|
||||
from fastapi.testclient import TestClient
|
||||
from typing_extensions import Annotated
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.post("/file_before_form")
|
||||
def file_before_form(
|
||||
file: bytes = File(),
|
||||
city: str = Form(),
|
||||
):
|
||||
return {"file_content": file, "city": city}
|
||||
|
||||
|
||||
@app.post("/file_after_form")
|
||||
def file_after_form(
|
||||
city: str = Form(),
|
||||
file: bytes = File(),
|
||||
):
|
||||
return {"file_content": file, "city": city}
|
||||
|
||||
|
||||
@app.post("/file_list_before_form")
|
||||
def file_list_before_form(
|
||||
files: Annotated[List[bytes], File()],
|
||||
city: Annotated[str, Form()],
|
||||
):
|
||||
return {"file_contents": files, "city": city}
|
||||
|
||||
|
||||
@app.post("/file_list_after_form")
|
||||
def file_list_after_form(
|
||||
city: Annotated[str, Form()],
|
||||
files: Annotated[List[bytes], File()],
|
||||
):
|
||||
return {"file_contents": files, "city": city}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def tmp_file_1(tmp_path: Path) -> Path:
|
||||
f = tmp_path / "example1.txt"
|
||||
f.write_text("foo")
|
||||
return f
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def tmp_file_2(tmp_path: Path) -> Path:
|
||||
f = tmp_path / "example2.txt"
|
||||
f.write_text("bar")
|
||||
return f
|
||||
|
||||
|
||||
@pytest.mark.parametrize("endpoint_path", ("/file_before_form", "/file_after_form"))
|
||||
def test_file_form_order(endpoint_path: str, tmp_file_1: Path):
|
||||
response = client.post(
|
||||
url=endpoint_path,
|
||||
data={"city": "Thimphou"},
|
||||
files={"file": (tmp_file_1.name, tmp_file_1.read_bytes())},
|
||||
)
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"file_content": "foo", "city": "Thimphou"}
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"endpoint_path", ("/file_list_before_form", "/file_list_after_form")
|
||||
)
|
||||
def test_file_list_form_order(endpoint_path: str, tmp_file_1: Path, tmp_file_2: Path):
|
||||
response = client.post(
|
||||
url=endpoint_path,
|
||||
data={"city": "Thimphou"},
|
||||
files=(
|
||||
("files", (tmp_file_1.name, tmp_file_1.read_bytes())),
|
||||
("files", (tmp_file_2.name, tmp_file_2.read_bytes())),
|
||||
),
|
||||
)
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"file_contents": ["foo", "bar"], "city": "Thimphou"}
|
||||
@@ -0,0 +1,35 @@
|
||||
from typing import Optional
|
||||
|
||||
from fastapi import Depends, FastAPI
|
||||
from pydantic import BaseModel, validator
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
class ModelB(BaseModel):
|
||||
username: str
|
||||
|
||||
|
||||
class ModelC(ModelB):
|
||||
password: str
|
||||
|
||||
|
||||
class ModelA(BaseModel):
|
||||
name: str
|
||||
description: Optional[str] = None
|
||||
model_b: ModelB
|
||||
|
||||
@validator("name")
|
||||
def lower_username(cls, name: str, values):
|
||||
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", "model_b": model_c}
|
||||
@@ -0,0 +1,130 @@
|
||||
import pytest
|
||||
from fastapi.exceptions import ResponseValidationError
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
from ..utils import needs_pydanticv1
|
||||
|
||||
|
||||
@pytest.fixture(name="client")
|
||||
def get_client():
|
||||
from .app_pv1 import app
|
||||
|
||||
client = TestClient(app)
|
||||
return client
|
||||
|
||||
|
||||
@needs_pydanticv1
|
||||
def test_filter_sub_model(client: TestClient):
|
||||
response = client.get("/model/modelA")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"name": "modelA",
|
||||
"description": "model-a-desc",
|
||||
"model_b": {"username": "test-user"},
|
||||
}
|
||||
|
||||
|
||||
@needs_pydanticv1
|
||||
def test_validator_is_cloned(client: TestClient):
|
||||
with pytest.raises(ResponseValidationError) as err:
|
||||
client.get("/model/modelX")
|
||||
assert err.value.errors() == [
|
||||
{
|
||||
"loc": ("response", "name"),
|
||||
"msg": "name must end in A",
|
||||
"type": "value_error",
|
||||
}
|
||||
]
|
||||
|
||||
|
||||
@needs_pydanticv1
|
||||
def test_openapi_schema(client: TestClient):
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/model/{name}": {
|
||||
"get": {
|
||||
"summary": "Get Model A",
|
||||
"operationId": "get_model_a_model__name__get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "Name", "type": "string"},
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {"$ref": "#/components/schemas/ModelA"}
|
||||
}
|
||||
},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"HTTPValidationError": {
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
}
|
||||
},
|
||||
},
|
||||
"ModelA": {
|
||||
"title": "ModelA",
|
||||
"required": ["name", "model_b"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {"title": "Name", "type": "string"},
|
||||
"description": {"title": "Description", "type": "string"},
|
||||
"model_b": {"$ref": "#/components/schemas/ModelB"},
|
||||
},
|
||||
},
|
||||
"ModelB": {
|
||||
"title": "ModelB",
|
||||
"required": ["username"],
|
||||
"type": "object",
|
||||
"properties": {"username": {"title": "Username", "type": "string"}},
|
||||
},
|
||||
"ValidationError": {
|
||||
"title": "ValidationError",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"loc": {
|
||||
"title": "Location",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
},
|
||||
"msg": {"title": "Message", "type": "string"},
|
||||
"type": {"title": "Error Type", "type": "string"},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,184 @@
|
||||
from typing import Optional
|
||||
|
||||
import pytest
|
||||
from dirty_equals import HasRepr, IsDict, IsOneOf
|
||||
from fastapi import Depends, FastAPI
|
||||
from fastapi.exceptions import ResponseValidationError
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
from .utils import needs_pydanticv2
|
||||
|
||||
|
||||
@pytest.fixture(name="client")
|
||||
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
|
||||
|
||||
@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}
|
||||
|
||||
client = TestClient(app)
|
||||
return client
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_filter_sub_model(client: TestClient):
|
||||
response = client.get("/model/modelA")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"name": "modelA",
|
||||
"description": "model-a-desc",
|
||||
"foo": {"username": "test-user"},
|
||||
}
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_validator_is_cloned(client: TestClient):
|
||||
with pytest.raises(ResponseValidationError) as err:
|
||||
client.get("/model/modelX")
|
||||
assert err.value.errors() == [
|
||||
IsDict(
|
||||
{
|
||||
"type": "value_error",
|
||||
"loc": ("response", "name"),
|
||||
"msg": "Value error, name must end in A",
|
||||
"input": "modelX",
|
||||
"ctx": {"error": HasRepr("ValueError('name must end in A')")},
|
||||
}
|
||||
)
|
||||
| IsDict(
|
||||
# TODO remove when deprecating Pydantic v1
|
||||
{
|
||||
"loc": ("response", "name"),
|
||||
"msg": "name must end in A",
|
||||
"type": "value_error",
|
||||
}
|
||||
)
|
||||
]
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_openapi_schema(client: TestClient):
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/model/{name}": {
|
||||
"get": {
|
||||
"summary": "Get Model A",
|
||||
"operationId": "get_model_a_model__name__get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "Name", "type": "string"},
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {"$ref": "#/components/schemas/ModelA"}
|
||||
}
|
||||
},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"HTTPValidationError": {
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
}
|
||||
},
|
||||
},
|
||||
"ModelA": {
|
||||
"title": "ModelA",
|
||||
"required": IsOneOf(
|
||||
["name", "description", "foo"],
|
||||
# TODO remove when deprecating Pydantic v1
|
||||
["name", "foo"],
|
||||
),
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {"title": "Name", "type": "string"},
|
||||
"description": IsDict(
|
||||
{
|
||||
"title": "Description",
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}],
|
||||
}
|
||||
)
|
||||
|
|
||||
# TODO remove when deprecating Pydantic v1
|
||||
IsDict({"title": "Description", "type": "string"}),
|
||||
"foo": {"$ref": "#/components/schemas/ModelB"},
|
||||
},
|
||||
},
|
||||
"ModelB": {
|
||||
"title": "ModelB",
|
||||
"required": ["username"],
|
||||
"type": "object",
|
||||
"properties": {"username": {"title": "Username", "type": "string"}},
|
||||
},
|
||||
"ValidationError": {
|
||||
"title": "ValidationError",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"loc": {
|
||||
"title": "Location",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
},
|
||||
"msg": {"title": "Message", "type": "string"},
|
||||
"type": {"title": "Error Type", "type": "string"},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
from typing import Optional
|
||||
|
||||
from fastapi import FastAPI, File, Form
|
||||
from starlette.testclient import TestClient
|
||||
from typing_extensions import Annotated
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.post("/urlencoded")
|
||||
async def post_url_encoded(age: Annotated[Optional[int], Form()] = None):
|
||||
return age
|
||||
|
||||
|
||||
@app.post("/multipart")
|
||||
async def post_multi_part(
|
||||
age: Annotated[Optional[int], Form()] = None,
|
||||
file: Annotated[Optional[bytes], File()] = None,
|
||||
):
|
||||
return {"file": file, "age": age}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_form_default_url_encoded():
|
||||
response = client.post("/urlencoded", data={"age": ""})
|
||||
assert response.status_code == 200
|
||||
assert response.text == "null"
|
||||
|
||||
|
||||
def test_form_default_multi_part():
|
||||
response = client.post("/multipart", data={"age": ""})
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"file": None, "age": None}
|
||||
@@ -0,0 +1,46 @@
|
||||
from fastapi import FastAPI, Form
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.post("/form/python-list")
|
||||
def post_form_param_list(items: list = Form()):
|
||||
return items
|
||||
|
||||
|
||||
@app.post("/form/python-set")
|
||||
def post_form_param_set(items: set = Form()):
|
||||
return items
|
||||
|
||||
|
||||
@app.post("/form/python-tuple")
|
||||
def post_form_param_tuple(items: tuple = Form()):
|
||||
return items
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_python_list_param_as_form():
|
||||
response = client.post(
|
||||
"/form/python-list", data={"items": ["first", "second", "third"]}
|
||||
)
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == ["first", "second", "third"]
|
||||
|
||||
|
||||
def test_python_set_param_as_form():
|
||||
response = client.post(
|
||||
"/form/python-set", data={"items": ["first", "second", "third"]}
|
||||
)
|
||||
assert response.status_code == 200, response.text
|
||||
assert set(response.json()) == {"first", "second", "third"}
|
||||
|
||||
|
||||
def test_python_tuple_param_as_form():
|
||||
response = client.post(
|
||||
"/form/python-tuple", data={"items": ["first", "second", "third"]}
|
||||
)
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == ["first", "second", "third"]
|
||||
@@ -0,0 +1,180 @@
|
||||
from typing import List, Optional
|
||||
|
||||
from dirty_equals import IsDict
|
||||
from fastapi import FastAPI, Form
|
||||
from fastapi._compat import PYDANTIC_V2
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel, Field
|
||||
from typing_extensions import Annotated
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
class FormModel(BaseModel):
|
||||
username: str
|
||||
lastname: str
|
||||
age: Optional[int] = None
|
||||
tags: List[str] = ["foo", "bar"]
|
||||
alias_with: str = Field(alias="with", default="nothing")
|
||||
|
||||
|
||||
class FormModelExtraAllow(BaseModel):
|
||||
param: str
|
||||
|
||||
if PYDANTIC_V2:
|
||||
model_config = {"extra": "allow"}
|
||||
else:
|
||||
|
||||
class Config:
|
||||
extra = "allow"
|
||||
|
||||
|
||||
@app.post("/form/")
|
||||
def post_form(user: Annotated[FormModel, Form()]):
|
||||
return user
|
||||
|
||||
|
||||
@app.post("/form-extra-allow/")
|
||||
def post_form_extra_allow(params: Annotated[FormModelExtraAllow, Form()]):
|
||||
return params
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_send_all_data():
|
||||
response = client.post(
|
||||
"/form/",
|
||||
data={
|
||||
"username": "Rick",
|
||||
"lastname": "Sanchez",
|
||||
"age": "70",
|
||||
"tags": ["plumbus", "citadel"],
|
||||
"with": "something",
|
||||
},
|
||||
)
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"username": "Rick",
|
||||
"lastname": "Sanchez",
|
||||
"age": 70,
|
||||
"tags": ["plumbus", "citadel"],
|
||||
"with": "something",
|
||||
}
|
||||
|
||||
|
||||
def test_defaults():
|
||||
response = client.post("/form/", data={"username": "Rick", "lastname": "Sanchez"})
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"username": "Rick",
|
||||
"lastname": "Sanchez",
|
||||
"age": None,
|
||||
"tags": ["foo", "bar"],
|
||||
"with": "nothing",
|
||||
}
|
||||
|
||||
|
||||
def test_invalid_data():
|
||||
response = client.post(
|
||||
"/form/",
|
||||
data={
|
||||
"username": "Rick",
|
||||
"lastname": "Sanchez",
|
||||
"age": "seventy",
|
||||
"tags": ["plumbus", "citadel"],
|
||||
},
|
||||
)
|
||||
assert response.status_code == 422, response.text
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "int_parsing",
|
||||
"loc": ["body", "age"],
|
||||
"msg": "Input should be a valid integer, unable to parse string as an integer",
|
||||
"input": "seventy",
|
||||
}
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["body", "age"],
|
||||
"msg": "value is not a valid integer",
|
||||
"type": "type_error.integer",
|
||||
}
|
||||
]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def test_no_data():
|
||||
response = client.post("/form/")
|
||||
assert response.status_code == 422, response.text
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["body", "username"],
|
||||
"msg": "Field required",
|
||||
"input": {"tags": ["foo", "bar"], "with": "nothing"},
|
||||
},
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["body", "lastname"],
|
||||
"msg": "Field required",
|
||||
"input": {"tags": ["foo", "bar"], "with": "nothing"},
|
||||
},
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["body", "username"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
},
|
||||
{
|
||||
"loc": ["body", "lastname"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
},
|
||||
]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def test_extra_param_single():
|
||||
response = client.post(
|
||||
"/form-extra-allow/",
|
||||
data={
|
||||
"param": "123",
|
||||
"extra_param": "456",
|
||||
},
|
||||
)
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"param": "123",
|
||||
"extra_param": "456",
|
||||
}
|
||||
|
||||
|
||||
def test_extra_param_list():
|
||||
response = client.post(
|
||||
"/form-extra-allow/",
|
||||
data={
|
||||
"param": "123",
|
||||
"extra_params": ["456", "789"],
|
||||
},
|
||||
)
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"param": "123",
|
||||
"extra_params": ["456", "789"],
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
from fastapi import FastAPI, Form
|
||||
from fastapi.testclient import TestClient
|
||||
from typing_extensions import Annotated
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.post("/form/")
|
||||
def post_form(username: Annotated[str, Form()]):
|
||||
return username
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_single_form_field():
|
||||
response = client.post("/form/", data={"username": "Rick"})
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == "Rick"
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/form/": {
|
||||
"post": {
|
||||
"summary": "Post Form",
|
||||
"operationId": "post_form_form__post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/x-www-form-urlencoded": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Body_post_form_form__post"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"Body_post_form_form__post": {
|
||||
"properties": {"username": {"type": "string", "title": "Username"}},
|
||||
"type": "object",
|
||||
"required": ["username"],
|
||||
"title": "Body_post_form_form__post",
|
||||
},
|
||||
"HTTPValidationError": {
|
||||
"properties": {
|
||||
"detail": {
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
"type": "array",
|
||||
"title": "Detail",
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"title": "HTTPValidationError",
|
||||
},
|
||||
"ValidationError": {
|
||||
"properties": {
|
||||
"loc": {
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
"type": "array",
|
||||
"title": "Location",
|
||||
},
|
||||
"msg": {"type": "string", "title": "Message"},
|
||||
"type": {"type": "string", "title": "Error Type"},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"title": "ValidationError",
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,77 @@
|
||||
from typing import TypeVar
|
||||
|
||||
from fastapi import Depends, FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
from typing_extensions import Annotated
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
T = TypeVar("T")
|
||||
|
||||
Dep = Annotated[T, Depends()]
|
||||
|
||||
|
||||
class A:
|
||||
pass
|
||||
|
||||
|
||||
class B:
|
||||
pass
|
||||
|
||||
|
||||
@app.get("/a")
|
||||
async def a(dep: Dep[A]):
|
||||
return {"cls": dep.__class__.__name__}
|
||||
|
||||
|
||||
@app.get("/b")
|
||||
async def b(dep: Dep[B]):
|
||||
return {"cls": dep.__class__.__name__}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_generic_parameterless_depends():
|
||||
response = client.get("/a")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"cls": "A"}
|
||||
|
||||
response = client.get("/b")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"cls": "B"}
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"openapi": "3.1.0",
|
||||
"paths": {
|
||||
"/a": {
|
||||
"get": {
|
||||
"operationId": "a_a_get",
|
||||
"responses": {
|
||||
"200": {
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
"description": "Successful Response",
|
||||
}
|
||||
},
|
||||
"summary": "A",
|
||||
}
|
||||
},
|
||||
"/b": {
|
||||
"get": {
|
||||
"operationId": "b_b_get",
|
||||
"responses": {
|
||||
"200": {
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
"description": "Successful Response",
|
||||
}
|
||||
},
|
||||
"summary": "B",
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,180 @@
|
||||
from typing import Any, Iterator, Set, Type
|
||||
|
||||
import fastapi._compat
|
||||
import fastapi.openapi.utils
|
||||
import pydantic.schema
|
||||
import pytest
|
||||
from fastapi import FastAPI
|
||||
from pydantic import BaseModel
|
||||
from starlette.testclient import TestClient
|
||||
|
||||
from .utils import needs_pydanticv1
|
||||
|
||||
|
||||
class Address(BaseModel):
|
||||
"""
|
||||
This is a public description of an Address
|
||||
\f
|
||||
You can't see this part of the docstring, it's private!
|
||||
"""
|
||||
|
||||
line_1: str
|
||||
city: str
|
||||
state_province: str
|
||||
|
||||
|
||||
class Facility(BaseModel):
|
||||
id: str
|
||||
address: Address
|
||||
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
@app.get("/facilities/{facility_id}")
|
||||
def get_facility(facility_id: str) -> Facility: ...
|
||||
|
||||
|
||||
openapi_schema = {
|
||||
"components": {
|
||||
"schemas": {
|
||||
"Address": {
|
||||
# NOTE: the description of this model shows only the public-facing text, before the `\f` in docstring
|
||||
"description": "This is a public description of an Address\n",
|
||||
"properties": {
|
||||
"city": {"title": "City", "type": "string"},
|
||||
"line_1": {"title": "Line 1", "type": "string"},
|
||||
"state_province": {"title": "State Province", "type": "string"},
|
||||
},
|
||||
"required": ["line_1", "city", "state_province"],
|
||||
"title": "Address",
|
||||
"type": "object",
|
||||
},
|
||||
"Facility": {
|
||||
"properties": {
|
||||
"address": {"$ref": "#/components/schemas/Address"},
|
||||
"id": {"title": "Id", "type": "string"},
|
||||
},
|
||||
"required": ["id", "address"],
|
||||
"title": "Facility",
|
||||
"type": "object",
|
||||
},
|
||||
"HTTPValidationError": {
|
||||
"properties": {
|
||||
"detail": {
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
}
|
||||
},
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
},
|
||||
"ValidationError": {
|
||||
"properties": {
|
||||
"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": {
|
||||
"/facilities/{facility_id}": {
|
||||
"get": {
|
||||
"operationId": "get_facility_facilities__facility_id__get",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "facility_id",
|
||||
"required": True,
|
||||
"schema": {"title": "Facility Id", "type": "string"},
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {"$ref": "#/components/schemas/Facility"}
|
||||
}
|
||||
},
|
||||
"description": "Successful Response",
|
||||
},
|
||||
"422": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description": "Validation Error",
|
||||
},
|
||||
},
|
||||
"summary": "Get Facility",
|
||||
}
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
"""
|
||||
Sanity check to ensure our app's openapi schema renders as we expect
|
||||
"""
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == openapi_schema
|
||||
|
||||
|
||||
class SortedTypeSet(set):
|
||||
"""
|
||||
Set of Types whose `__iter__()` method yields results sorted by the type names
|
||||
"""
|
||||
|
||||
def __init__(self, seq: Set[Type[Any]], *, sort_reversed: bool):
|
||||
super().__init__(seq)
|
||||
self.sort_reversed = sort_reversed
|
||||
|
||||
def __iter__(self) -> Iterator[Type[Any]]:
|
||||
members_sorted = sorted(
|
||||
super().__iter__(),
|
||||
key=lambda type_: type_.__name__,
|
||||
reverse=self.sort_reversed,
|
||||
)
|
||||
yield from members_sorted
|
||||
|
||||
|
||||
@needs_pydanticv1
|
||||
@pytest.mark.parametrize("sort_reversed", [True, False])
|
||||
def test_model_description_escaped_with_formfeed(sort_reversed: bool):
|
||||
"""
|
||||
Regression test for bug fixed by https://github.com/fastapi/fastapi/pull/6039.
|
||||
|
||||
Test `get_model_definitions` with models passed in different order.
|
||||
"""
|
||||
from fastapi._compat import v1
|
||||
|
||||
all_fields = fastapi.openapi.utils.get_fields_from_routes(app.routes)
|
||||
|
||||
flat_models = v1.get_flat_models_from_fields(all_fields, known_models=set())
|
||||
model_name_map = pydantic.schema.get_model_name_map(flat_models)
|
||||
|
||||
expected_address_description = "This is a public description of an Address\n"
|
||||
|
||||
models = v1.get_model_definitions(
|
||||
flat_models=SortedTypeSet(flat_models, sort_reversed=sort_reversed),
|
||||
model_name_map=model_name_map,
|
||||
)
|
||||
assert models["Address"]["description"] == expected_address_description
|
||||
@@ -0,0 +1,107 @@
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
class Product(BaseModel):
|
||||
name: str
|
||||
description: str = None # type: ignore
|
||||
price: float
|
||||
|
||||
|
||||
@app.get("/product")
|
||||
async def create_item(product: Product):
|
||||
return product
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_get_with_body():
|
||||
body = {"name": "Foo", "description": "Some description", "price": 5.5}
|
||||
response = client.request("GET", "/product", json=body)
|
||||
assert response.json() == body
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/product": {
|
||||
"get": {
|
||||
"summary": "Create Item",
|
||||
"operationId": "create_item_product_get",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {"$ref": "#/components/schemas/Product"}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"HTTPValidationError": {
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
}
|
||||
},
|
||||
},
|
||||
"Product": {
|
||||
"title": "Product",
|
||||
"required": ["name", "price"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {"title": "Name", "type": "string"},
|
||||
"description": {"title": "Description", "type": "string"},
|
||||
"price": {"title": "Price", "type": "number"},
|
||||
},
|
||||
},
|
||||
"ValidationError": {
|
||||
"title": "ValidationError",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"loc": {
|
||||
"title": "Location",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
},
|
||||
"msg": {"title": "Message", "type": "string"},
|
||||
"type": {"title": "Error Type", "type": "string"},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
from fastapi import Depends, FastAPI
|
||||
from fastapi.requests import HTTPConnection
|
||||
from fastapi.testclient import TestClient
|
||||
from starlette.websockets import WebSocket
|
||||
|
||||
app = FastAPI()
|
||||
app.state.value = 42
|
||||
|
||||
|
||||
async def extract_value_from_http_connection(conn: HTTPConnection):
|
||||
return conn.app.state.value
|
||||
|
||||
|
||||
@app.get("/http")
|
||||
async def get_value_by_http(value: int = Depends(extract_value_from_http_connection)):
|
||||
return value
|
||||
|
||||
|
||||
@app.websocket("/ws")
|
||||
async def get_value_by_ws(
|
||||
websocket: WebSocket, value: int = Depends(extract_value_from_http_connection)
|
||||
):
|
||||
await websocket.accept()
|
||||
await websocket.send_json(value)
|
||||
await websocket.close()
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_value_extracting_by_http():
|
||||
response = client.get("/http")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == 42
|
||||
|
||||
|
||||
def test_value_extracting_by_ws():
|
||||
with client.websocket_connect("/ws") as websocket:
|
||||
assert websocket.receive_json() == 42
|
||||
@@ -0,0 +1,22 @@
|
||||
from fastapi import APIRouter, FastAPI, Request
|
||||
from fastapi.responses import JSONResponse
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
router = APIRouter()
|
||||
|
||||
|
||||
@router.route("/items/")
|
||||
def read_items(request: Request):
|
||||
return JSONResponse({"hello": "world"})
|
||||
|
||||
|
||||
app.include_router(router)
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_sub_router():
|
||||
response = client.get("/items/")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"hello": "world"}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,357 @@
|
||||
from typing import Optional
|
||||
|
||||
from dirty_equals import IsDict
|
||||
from fastapi import APIRouter, FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
user_router = APIRouter()
|
||||
item_router = APIRouter()
|
||||
|
||||
|
||||
@user_router.get("/")
|
||||
def get_users():
|
||||
return [{"user_id": "u1"}, {"user_id": "u2"}]
|
||||
|
||||
|
||||
@user_router.get("/{user_id}")
|
||||
def get_user(user_id: str):
|
||||
return {"user_id": user_id}
|
||||
|
||||
|
||||
@item_router.get("/")
|
||||
def get_items(user_id: Optional[str] = None):
|
||||
if user_id is None:
|
||||
return [{"item_id": "i1", "user_id": "u1"}, {"item_id": "i2", "user_id": "u2"}]
|
||||
else:
|
||||
return [{"item_id": "i2", "user_id": user_id}]
|
||||
|
||||
|
||||
@item_router.get("/{item_id}")
|
||||
def get_item(item_id: str, user_id: Optional[str] = None):
|
||||
if user_id is None:
|
||||
return {"item_id": item_id}
|
||||
else:
|
||||
return {"item_id": item_id, "user_id": user_id}
|
||||
|
||||
|
||||
app.include_router(user_router, prefix="/users")
|
||||
app.include_router(item_router, prefix="/items")
|
||||
|
||||
app.include_router(item_router, prefix="/users/{user_id}/items")
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_get_users():
|
||||
"""Check that /users returns expected data"""
|
||||
response = client.get("/users")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == [{"user_id": "u1"}, {"user_id": "u2"}]
|
||||
|
||||
|
||||
def test_get_user():
|
||||
"""Check that /users/{user_id} returns expected data"""
|
||||
response = client.get("/users/abc123")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"user_id": "abc123"}
|
||||
|
||||
|
||||
def test_get_items_1():
|
||||
"""Check that /items returns expected data"""
|
||||
response = client.get("/items")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == [
|
||||
{"item_id": "i1", "user_id": "u1"},
|
||||
{"item_id": "i2", "user_id": "u2"},
|
||||
]
|
||||
|
||||
|
||||
def test_get_items_2():
|
||||
"""Check that /items returns expected data with user_id specified"""
|
||||
response = client.get("/items?user_id=abc123")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == [{"item_id": "i2", "user_id": "abc123"}]
|
||||
|
||||
|
||||
def test_get_item_1():
|
||||
"""Check that /items/{item_id} returns expected data"""
|
||||
response = client.get("/items/item01")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"item_id": "item01"}
|
||||
|
||||
|
||||
def test_get_item_2():
|
||||
"""Check that /items/{item_id} returns expected data with user_id specified"""
|
||||
response = client.get("/items/item01?user_id=abc123")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"item_id": "item01", "user_id": "abc123"}
|
||||
|
||||
|
||||
def test_get_users_items():
|
||||
"""Check that /users/{user_id}/items returns expected data"""
|
||||
response = client.get("/users/abc123/items")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == [{"item_id": "i2", "user_id": "abc123"}]
|
||||
|
||||
|
||||
def test_get_users_item():
|
||||
"""Check that /users/{user_id}/items returns expected data"""
|
||||
response = client.get("/users/abc123/items/item01")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"item_id": "item01", "user_id": "abc123"}
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/users/": {
|
||||
"get": {
|
||||
"summary": "Get Users",
|
||||
"operationId": "get_users_users__get",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
}
|
||||
},
|
||||
}
|
||||
},
|
||||
"/users/{user_id}": {
|
||||
"get": {
|
||||
"summary": "Get User",
|
||||
"operationId": "get_user_users__user_id__get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "User Id", "type": "string"},
|
||||
"name": "user_id",
|
||||
"in": "path",
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/items/": {
|
||||
"get": {
|
||||
"summary": "Get Items",
|
||||
"operationId": "get_items_items__get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": False,
|
||||
"name": "user_id",
|
||||
"in": "query",
|
||||
"schema": IsDict(
|
||||
{
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}],
|
||||
"title": "User Id",
|
||||
}
|
||||
)
|
||||
| IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{"title": "User Id", "type": "string"}
|
||||
),
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/items/{item_id}": {
|
||||
"get": {
|
||||
"summary": "Get Item",
|
||||
"operationId": "get_item_items__item_id__get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "Item Id", "type": "string"},
|
||||
"name": "item_id",
|
||||
"in": "path",
|
||||
},
|
||||
{
|
||||
"required": False,
|
||||
"name": "user_id",
|
||||
"in": "query",
|
||||
"schema": IsDict(
|
||||
{
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}],
|
||||
"title": "User Id",
|
||||
}
|
||||
)
|
||||
| IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{"title": "User Id", "type": "string"}
|
||||
),
|
||||
},
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/users/{user_id}/items/": {
|
||||
"get": {
|
||||
"summary": "Get Items",
|
||||
"operationId": "get_items_users__user_id__items__get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"name": "user_id",
|
||||
"in": "path",
|
||||
"schema": IsDict(
|
||||
{
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}],
|
||||
"title": "User Id",
|
||||
}
|
||||
)
|
||||
| IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{"title": "User Id", "type": "string"}
|
||||
),
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/users/{user_id}/items/{item_id}": {
|
||||
"get": {
|
||||
"summary": "Get Item",
|
||||
"operationId": "get_item_users__user_id__items__item_id__get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "Item Id", "type": "string"},
|
||||
"name": "item_id",
|
||||
"in": "path",
|
||||
},
|
||||
{
|
||||
"required": True,
|
||||
"name": "user_id",
|
||||
"in": "path",
|
||||
"schema": IsDict(
|
||||
{
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}],
|
||||
"title": "User Id",
|
||||
}
|
||||
)
|
||||
| IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{"title": "User Id", "type": "string"}
|
||||
),
|
||||
},
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"HTTPValidationError": {
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
}
|
||||
},
|
||||
},
|
||||
"ValidationError": {
|
||||
"title": "ValidationError",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"loc": {
|
||||
"title": "Location",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
},
|
||||
"msg": {"title": "Message", "type": "string"},
|
||||
"type": {"title": "Error Type", "type": "string"},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,111 @@
|
||||
import uuid
|
||||
|
||||
import pytest
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel
|
||||
|
||||
from .utils import needs_pydanticv1, needs_pydanticv2
|
||||
|
||||
|
||||
class MyUuid:
|
||||
def __init__(self, uuid_string: str):
|
||||
self.uuid = uuid_string
|
||||
|
||||
def __str__(self):
|
||||
return self.uuid
|
||||
|
||||
@property # type: ignore
|
||||
def __class__(self):
|
||||
return uuid.UUID
|
||||
|
||||
@property
|
||||
def __dict__(self):
|
||||
"""Spoof a missing __dict__ by raising TypeError, this is how
|
||||
asyncpg.pgroto.pgproto.UUID behaves"""
|
||||
raise TypeError("vars() argument must have __dict__ attribute")
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_pydanticv2():
|
||||
from pydantic import field_serializer
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
@app.get("/fast_uuid")
|
||||
def return_fast_uuid():
|
||||
asyncpg_uuid = MyUuid("a10ff360-3b1e-4984-a26f-d3ab460bdb51")
|
||||
assert isinstance(asyncpg_uuid, uuid.UUID)
|
||||
assert type(asyncpg_uuid) is not uuid.UUID
|
||||
with pytest.raises(TypeError):
|
||||
vars(asyncpg_uuid)
|
||||
return {"fast_uuid": asyncpg_uuid}
|
||||
|
||||
class SomeCustomClass(BaseModel):
|
||||
model_config = {"arbitrary_types_allowed": True}
|
||||
|
||||
a_uuid: MyUuid
|
||||
|
||||
@field_serializer("a_uuid")
|
||||
def serialize_a_uuid(self, v):
|
||||
return str(v)
|
||||
|
||||
@app.get("/get_custom_class")
|
||||
def return_some_user():
|
||||
# Test that the fix also works for custom pydantic classes
|
||||
return SomeCustomClass(a_uuid=MyUuid("b8799909-f914-42de-91bc-95c819218d01"))
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
with client:
|
||||
response_simple = client.get("/fast_uuid")
|
||||
response_pydantic = client.get("/get_custom_class")
|
||||
|
||||
assert response_simple.json() == {
|
||||
"fast_uuid": "a10ff360-3b1e-4984-a26f-d3ab460bdb51"
|
||||
}
|
||||
|
||||
assert response_pydantic.json() == {
|
||||
"a_uuid": "b8799909-f914-42de-91bc-95c819218d01"
|
||||
}
|
||||
|
||||
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
@needs_pydanticv1
|
||||
def test_pydanticv1():
|
||||
app = FastAPI()
|
||||
|
||||
@app.get("/fast_uuid")
|
||||
def return_fast_uuid():
|
||||
asyncpg_uuid = MyUuid("a10ff360-3b1e-4984-a26f-d3ab460bdb51")
|
||||
assert isinstance(asyncpg_uuid, uuid.UUID)
|
||||
assert type(asyncpg_uuid) is not uuid.UUID
|
||||
with pytest.raises(TypeError):
|
||||
vars(asyncpg_uuid)
|
||||
return {"fast_uuid": asyncpg_uuid}
|
||||
|
||||
class SomeCustomClass(BaseModel):
|
||||
class Config:
|
||||
arbitrary_types_allowed = True
|
||||
json_encoders = {uuid.UUID: str}
|
||||
|
||||
a_uuid: MyUuid
|
||||
|
||||
@app.get("/get_custom_class")
|
||||
def return_some_user():
|
||||
# Test that the fix also works for custom pydantic classes
|
||||
return SomeCustomClass(a_uuid=MyUuid("b8799909-f914-42de-91bc-95c819218d01"))
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
with client:
|
||||
response_simple = client.get("/fast_uuid")
|
||||
response_pydantic = client.get("/get_custom_class")
|
||||
|
||||
assert response_simple.json() == {
|
||||
"fast_uuid": "a10ff360-3b1e-4984-a26f-d3ab460bdb51"
|
||||
}
|
||||
|
||||
assert response_pydantic.json() == {
|
||||
"a_uuid": "b8799909-f914-42de-91bc-95c819218d01"
|
||||
}
|
||||
@@ -0,0 +1,77 @@
|
||||
from typing import Dict, List, Tuple
|
||||
|
||||
import pytest
|
||||
from fastapi import FastAPI
|
||||
from pydantic import BaseModel
|
||||
|
||||
|
||||
def test_invalid_sequence():
|
||||
with pytest.raises(AssertionError):
|
||||
app = FastAPI()
|
||||
|
||||
class Item(BaseModel):
|
||||
title: str
|
||||
|
||||
@app.get("/items/{id}")
|
||||
def read_items(id: List[Item]):
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
def test_invalid_tuple():
|
||||
with pytest.raises(AssertionError):
|
||||
app = FastAPI()
|
||||
|
||||
class Item(BaseModel):
|
||||
title: str
|
||||
|
||||
@app.get("/items/{id}")
|
||||
def read_items(id: Tuple[Item, Item]):
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
def test_invalid_dict():
|
||||
with pytest.raises(AssertionError):
|
||||
app = FastAPI()
|
||||
|
||||
class Item(BaseModel):
|
||||
title: str
|
||||
|
||||
@app.get("/items/{id}")
|
||||
def read_items(id: Dict[str, Item]):
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
def test_invalid_simple_list():
|
||||
with pytest.raises(AssertionError):
|
||||
app = FastAPI()
|
||||
|
||||
@app.get("/items/{id}")
|
||||
def read_items(id: list):
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
def test_invalid_simple_tuple():
|
||||
with pytest.raises(AssertionError):
|
||||
app = FastAPI()
|
||||
|
||||
@app.get("/items/{id}")
|
||||
def read_items(id: tuple):
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
def test_invalid_simple_set():
|
||||
with pytest.raises(AssertionError):
|
||||
app = FastAPI()
|
||||
|
||||
@app.get("/items/{id}")
|
||||
def read_items(id: set):
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
def test_invalid_simple_dict():
|
||||
with pytest.raises(AssertionError):
|
||||
app = FastAPI()
|
||||
|
||||
@app.get("/items/{id}")
|
||||
def read_items(id: dict):
|
||||
pass # pragma: no cover
|
||||
@@ -0,0 +1,53 @@
|
||||
from typing import Dict, List, Optional, Tuple
|
||||
|
||||
import pytest
|
||||
from fastapi import FastAPI, Query
|
||||
from pydantic import BaseModel
|
||||
|
||||
|
||||
def test_invalid_sequence():
|
||||
with pytest.raises(AssertionError):
|
||||
app = FastAPI()
|
||||
|
||||
class Item(BaseModel):
|
||||
title: str
|
||||
|
||||
@app.get("/items/")
|
||||
def read_items(q: List[Item] = Query(default=None)):
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
def test_invalid_tuple():
|
||||
with pytest.raises(AssertionError):
|
||||
app = FastAPI()
|
||||
|
||||
class Item(BaseModel):
|
||||
title: str
|
||||
|
||||
@app.get("/items/")
|
||||
def read_items(q: Tuple[Item, Item] = Query(default=None)):
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
def test_invalid_dict():
|
||||
with pytest.raises(AssertionError):
|
||||
app = FastAPI()
|
||||
|
||||
class Item(BaseModel):
|
||||
title: str
|
||||
|
||||
@app.get("/items/")
|
||||
def read_items(q: Dict[str, Item] = Query(default=None)):
|
||||
pass # pragma: no cover
|
||||
|
||||
|
||||
def test_invalid_simple_dict():
|
||||
with pytest.raises(AssertionError):
|
||||
app = FastAPI()
|
||||
|
||||
class Item(BaseModel):
|
||||
title: str
|
||||
|
||||
@app.get("/items/")
|
||||
def read_items(q: Optional[dict] = Query(default=None)):
|
||||
pass # pragma: no cover
|
||||
@@ -0,0 +1,336 @@
|
||||
from collections import deque
|
||||
from dataclasses import dataclass
|
||||
from datetime import datetime, timezone
|
||||
from decimal import Decimal
|
||||
from enum import Enum
|
||||
from math import isinf, isnan
|
||||
from pathlib import PurePath, PurePosixPath, PureWindowsPath
|
||||
from typing import Optional
|
||||
|
||||
import pytest
|
||||
from fastapi._compat import PYDANTIC_V2, Undefined
|
||||
from fastapi.encoders import jsonable_encoder
|
||||
from pydantic import BaseModel, Field, ValidationError
|
||||
|
||||
from .utils import needs_pydanticv1, needs_pydanticv2
|
||||
|
||||
|
||||
class Person:
|
||||
def __init__(self, name: str):
|
||||
self.name = name
|
||||
|
||||
|
||||
class Pet:
|
||||
def __init__(self, owner: Person, name: str):
|
||||
self.owner = owner
|
||||
self.name = name
|
||||
|
||||
|
||||
@dataclass
|
||||
class Item:
|
||||
name: str
|
||||
count: int
|
||||
|
||||
|
||||
class DictablePerson(Person):
|
||||
def __iter__(self):
|
||||
return ((k, v) for k, v in self.__dict__.items())
|
||||
|
||||
|
||||
class DictablePet(Pet):
|
||||
def __iter__(self):
|
||||
return ((k, v) for k, v in self.__dict__.items())
|
||||
|
||||
|
||||
class Unserializable:
|
||||
def __iter__(self):
|
||||
raise NotImplementedError()
|
||||
|
||||
@property
|
||||
def __dict__(self):
|
||||
raise NotImplementedError()
|
||||
|
||||
|
||||
class RoleEnum(Enum):
|
||||
admin = "admin"
|
||||
normal = "normal"
|
||||
|
||||
|
||||
class ModelWithConfig(BaseModel):
|
||||
role: Optional[RoleEnum] = None
|
||||
|
||||
if PYDANTIC_V2:
|
||||
model_config = {"use_enum_values": True}
|
||||
else:
|
||||
|
||||
class Config:
|
||||
use_enum_values = True
|
||||
|
||||
|
||||
class ModelWithAlias(BaseModel):
|
||||
foo: str = Field(alias="Foo")
|
||||
|
||||
|
||||
class ModelWithDefault(BaseModel):
|
||||
foo: str = ... # type: ignore
|
||||
bar: str = "bar"
|
||||
bla: str = "bla"
|
||||
|
||||
|
||||
def test_encode_dict():
|
||||
pet = {"name": "Firulais", "owner": {"name": "Foo"}}
|
||||
assert jsonable_encoder(pet) == {"name": "Firulais", "owner": {"name": "Foo"}}
|
||||
assert jsonable_encoder(pet, include={"name"}) == {"name": "Firulais"}
|
||||
assert jsonable_encoder(pet, exclude={"owner"}) == {"name": "Firulais"}
|
||||
assert jsonable_encoder(pet, include={}) == {}
|
||||
assert jsonable_encoder(pet, exclude={}) == {
|
||||
"name": "Firulais",
|
||||
"owner": {"name": "Foo"},
|
||||
}
|
||||
|
||||
|
||||
def test_encode_class():
|
||||
person = Person(name="Foo")
|
||||
pet = Pet(owner=person, name="Firulais")
|
||||
assert jsonable_encoder(pet) == {"name": "Firulais", "owner": {"name": "Foo"}}
|
||||
assert jsonable_encoder(pet, include={"name"}) == {"name": "Firulais"}
|
||||
assert jsonable_encoder(pet, exclude={"owner"}) == {"name": "Firulais"}
|
||||
assert jsonable_encoder(pet, include={}) == {}
|
||||
assert jsonable_encoder(pet, exclude={}) == {
|
||||
"name": "Firulais",
|
||||
"owner": {"name": "Foo"},
|
||||
}
|
||||
|
||||
|
||||
def test_encode_dictable():
|
||||
person = DictablePerson(name="Foo")
|
||||
pet = DictablePet(owner=person, name="Firulais")
|
||||
assert jsonable_encoder(pet) == {"name": "Firulais", "owner": {"name": "Foo"}}
|
||||
assert jsonable_encoder(pet, include={"name"}) == {"name": "Firulais"}
|
||||
assert jsonable_encoder(pet, exclude={"owner"}) == {"name": "Firulais"}
|
||||
assert jsonable_encoder(pet, include={}) == {}
|
||||
assert jsonable_encoder(pet, exclude={}) == {
|
||||
"name": "Firulais",
|
||||
"owner": {"name": "Foo"},
|
||||
}
|
||||
|
||||
|
||||
def test_encode_dataclass():
|
||||
item = Item(name="foo", count=100)
|
||||
assert jsonable_encoder(item) == {"name": "foo", "count": 100}
|
||||
assert jsonable_encoder(item, include={"name"}) == {"name": "foo"}
|
||||
assert jsonable_encoder(item, exclude={"count"}) == {"name": "foo"}
|
||||
assert jsonable_encoder(item, include={}) == {}
|
||||
assert jsonable_encoder(item, exclude={}) == {"name": "foo", "count": 100}
|
||||
|
||||
|
||||
def test_encode_unsupported():
|
||||
unserializable = Unserializable()
|
||||
with pytest.raises(ValueError):
|
||||
jsonable_encoder(unserializable)
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_encode_custom_json_encoders_model_pydanticv2():
|
||||
from pydantic import field_serializer
|
||||
|
||||
class ModelWithCustomEncoder(BaseModel):
|
||||
dt_field: datetime
|
||||
|
||||
@field_serializer("dt_field")
|
||||
def serialize_dt_field(self, dt):
|
||||
return dt.replace(microsecond=0, tzinfo=timezone.utc).isoformat()
|
||||
|
||||
class ModelWithCustomEncoderSubclass(ModelWithCustomEncoder):
|
||||
pass
|
||||
|
||||
model = ModelWithCustomEncoder(dt_field=datetime(2019, 1, 1, 8))
|
||||
assert jsonable_encoder(model) == {"dt_field": "2019-01-01T08:00:00+00:00"}
|
||||
subclass_model = ModelWithCustomEncoderSubclass(dt_field=datetime(2019, 1, 1, 8))
|
||||
assert jsonable_encoder(subclass_model) == {"dt_field": "2019-01-01T08:00:00+00:00"}
|
||||
|
||||
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
@needs_pydanticv1
|
||||
def test_encode_custom_json_encoders_model_pydanticv1():
|
||||
class ModelWithCustomEncoder(BaseModel):
|
||||
dt_field: datetime
|
||||
|
||||
class Config:
|
||||
json_encoders = {
|
||||
datetime: lambda dt: dt.replace(
|
||||
microsecond=0, tzinfo=timezone.utc
|
||||
).isoformat()
|
||||
}
|
||||
|
||||
class ModelWithCustomEncoderSubclass(ModelWithCustomEncoder):
|
||||
class Config:
|
||||
pass
|
||||
|
||||
model = ModelWithCustomEncoder(dt_field=datetime(2019, 1, 1, 8))
|
||||
assert jsonable_encoder(model) == {"dt_field": "2019-01-01T08:00:00+00:00"}
|
||||
subclass_model = ModelWithCustomEncoderSubclass(dt_field=datetime(2019, 1, 1, 8))
|
||||
assert jsonable_encoder(subclass_model) == {"dt_field": "2019-01-01T08:00:00+00:00"}
|
||||
|
||||
|
||||
def test_encode_model_with_config():
|
||||
model = ModelWithConfig(role=RoleEnum.admin)
|
||||
assert jsonable_encoder(model) == {"role": "admin"}
|
||||
|
||||
|
||||
def test_encode_model_with_alias_raises():
|
||||
with pytest.raises(ValidationError):
|
||||
ModelWithAlias(foo="Bar")
|
||||
|
||||
|
||||
def test_encode_model_with_alias():
|
||||
model = ModelWithAlias(Foo="Bar")
|
||||
assert jsonable_encoder(model) == {"Foo": "Bar"}
|
||||
|
||||
|
||||
def test_encode_model_with_default():
|
||||
model = ModelWithDefault(foo="foo", bar="bar")
|
||||
assert jsonable_encoder(model) == {"foo": "foo", "bar": "bar", "bla": "bla"}
|
||||
assert jsonable_encoder(model, exclude_unset=True) == {"foo": "foo", "bar": "bar"}
|
||||
assert jsonable_encoder(model, exclude_defaults=True) == {"foo": "foo"}
|
||||
assert jsonable_encoder(model, exclude_unset=True, exclude_defaults=True) == {
|
||||
"foo": "foo"
|
||||
}
|
||||
assert jsonable_encoder(model, include={"foo"}) == {"foo": "foo"}
|
||||
assert jsonable_encoder(model, exclude={"bla"}) == {"foo": "foo", "bar": "bar"}
|
||||
assert jsonable_encoder(model, include={}) == {}
|
||||
assert jsonable_encoder(model, exclude={}) == {
|
||||
"foo": "foo",
|
||||
"bar": "bar",
|
||||
"bla": "bla",
|
||||
}
|
||||
|
||||
|
||||
@needs_pydanticv1
|
||||
def test_custom_encoders():
|
||||
class safe_datetime(datetime):
|
||||
pass
|
||||
|
||||
class MyModel(BaseModel):
|
||||
dt_field: safe_datetime
|
||||
|
||||
instance = MyModel(dt_field=safe_datetime.now())
|
||||
|
||||
encoded_instance = jsonable_encoder(
|
||||
instance, custom_encoder={safe_datetime: lambda o: o.strftime("%H:%M:%S")}
|
||||
)
|
||||
assert encoded_instance["dt_field"] == instance.dt_field.strftime("%H:%M:%S")
|
||||
|
||||
encoded_instance2 = jsonable_encoder(instance)
|
||||
assert encoded_instance2["dt_field"] == instance.dt_field.isoformat()
|
||||
|
||||
|
||||
def test_custom_enum_encoders():
|
||||
def custom_enum_encoder(v: Enum):
|
||||
return v.value.lower()
|
||||
|
||||
class MyEnum(Enum):
|
||||
ENUM_VAL_1 = "ENUM_VAL_1"
|
||||
|
||||
instance = MyEnum.ENUM_VAL_1
|
||||
|
||||
encoded_instance = jsonable_encoder(
|
||||
instance, custom_encoder={MyEnum: custom_enum_encoder}
|
||||
)
|
||||
assert encoded_instance == custom_enum_encoder(instance)
|
||||
|
||||
|
||||
def test_encode_model_with_pure_path():
|
||||
class ModelWithPath(BaseModel):
|
||||
path: PurePath
|
||||
|
||||
if PYDANTIC_V2:
|
||||
model_config = {"arbitrary_types_allowed": True}
|
||||
else:
|
||||
|
||||
class Config:
|
||||
arbitrary_types_allowed = True
|
||||
|
||||
test_path = PurePath("/foo", "bar")
|
||||
obj = ModelWithPath(path=test_path)
|
||||
assert jsonable_encoder(obj) == {"path": str(test_path)}
|
||||
|
||||
|
||||
def test_encode_model_with_pure_posix_path():
|
||||
class ModelWithPath(BaseModel):
|
||||
path: PurePosixPath
|
||||
|
||||
if PYDANTIC_V2:
|
||||
model_config = {"arbitrary_types_allowed": True}
|
||||
else:
|
||||
|
||||
class Config:
|
||||
arbitrary_types_allowed = True
|
||||
|
||||
obj = ModelWithPath(path=PurePosixPath("/foo", "bar"))
|
||||
assert jsonable_encoder(obj) == {"path": "/foo/bar"}
|
||||
|
||||
|
||||
def test_encode_model_with_pure_windows_path():
|
||||
class ModelWithPath(BaseModel):
|
||||
path: PureWindowsPath
|
||||
|
||||
if PYDANTIC_V2:
|
||||
model_config = {"arbitrary_types_allowed": True}
|
||||
else:
|
||||
|
||||
class Config:
|
||||
arbitrary_types_allowed = True
|
||||
|
||||
obj = ModelWithPath(path=PureWindowsPath("/foo", "bar"))
|
||||
assert jsonable_encoder(obj) == {"path": "\\foo\\bar"}
|
||||
|
||||
|
||||
@needs_pydanticv1
|
||||
def test_encode_root():
|
||||
class ModelWithRoot(BaseModel):
|
||||
__root__: str
|
||||
|
||||
model = ModelWithRoot(__root__="Foo")
|
||||
assert jsonable_encoder(model) == "Foo"
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_decimal_encoder_float():
|
||||
data = {"value": Decimal(1.23)}
|
||||
assert jsonable_encoder(data) == {"value": 1.23}
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_decimal_encoder_int():
|
||||
data = {"value": Decimal(2)}
|
||||
assert jsonable_encoder(data) == {"value": 2}
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_decimal_encoder_nan():
|
||||
data = {"value": Decimal("NaN")}
|
||||
assert isnan(jsonable_encoder(data)["value"])
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_decimal_encoder_infinity():
|
||||
data = {"value": Decimal("Infinity")}
|
||||
assert isinf(jsonable_encoder(data)["value"])
|
||||
data = {"value": Decimal("-Infinity")}
|
||||
assert isinf(jsonable_encoder(data)["value"])
|
||||
|
||||
|
||||
def test_encode_deque_encodes_child_models():
|
||||
class Model(BaseModel):
|
||||
test: str
|
||||
|
||||
dq = deque([Model(test="test")])
|
||||
|
||||
assert jsonable_encoder(dq)[0]["test"] == "test"
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_encode_pydantic_undefined():
|
||||
data = {"value": Undefined}
|
||||
assert jsonable_encoder(data) == {"value": None}
|
||||
@@ -0,0 +1,67 @@
|
||||
import inspect
|
||||
|
||||
from fastapi.openapi.docs import get_redoc_html, get_swagger_ui_html
|
||||
|
||||
|
||||
def test_strings_in_generated_swagger():
|
||||
sig = inspect.signature(get_swagger_ui_html)
|
||||
swagger_js_url = sig.parameters.get("swagger_js_url").default # type: ignore
|
||||
swagger_css_url = sig.parameters.get("swagger_css_url").default # type: ignore
|
||||
swagger_favicon_url = sig.parameters.get("swagger_favicon_url").default # type: ignore
|
||||
html = get_swagger_ui_html(openapi_url="/docs", title="title")
|
||||
body_content = html.body.decode()
|
||||
assert swagger_js_url in body_content
|
||||
assert swagger_css_url in body_content
|
||||
assert swagger_favicon_url in body_content
|
||||
|
||||
|
||||
def test_strings_in_custom_swagger():
|
||||
swagger_js_url = "swagger_fake_file.js"
|
||||
swagger_css_url = "swagger_fake_file.css"
|
||||
swagger_favicon_url = "swagger_fake_file.png"
|
||||
html = get_swagger_ui_html(
|
||||
openapi_url="/docs",
|
||||
title="title",
|
||||
swagger_js_url=swagger_js_url,
|
||||
swagger_css_url=swagger_css_url,
|
||||
swagger_favicon_url=swagger_favicon_url,
|
||||
)
|
||||
body_content = html.body.decode()
|
||||
assert swagger_js_url in body_content
|
||||
assert swagger_css_url in body_content
|
||||
assert swagger_favicon_url in body_content
|
||||
|
||||
|
||||
def test_strings_in_generated_redoc():
|
||||
sig = inspect.signature(get_redoc_html)
|
||||
redoc_js_url = sig.parameters.get("redoc_js_url").default # type: ignore
|
||||
redoc_favicon_url = sig.parameters.get("redoc_favicon_url").default # type: ignore
|
||||
html = get_redoc_html(openapi_url="/docs", title="title")
|
||||
body_content = html.body.decode()
|
||||
assert redoc_js_url in body_content
|
||||
assert redoc_favicon_url in body_content
|
||||
|
||||
|
||||
def test_strings_in_custom_redoc():
|
||||
redoc_js_url = "fake_redoc_file.js"
|
||||
redoc_favicon_url = "fake_redoc_file.png"
|
||||
html = get_redoc_html(
|
||||
openapi_url="/docs",
|
||||
title="title",
|
||||
redoc_js_url=redoc_js_url,
|
||||
redoc_favicon_url=redoc_favicon_url,
|
||||
)
|
||||
body_content = html.body.decode()
|
||||
assert redoc_js_url in body_content
|
||||
assert redoc_favicon_url in body_content
|
||||
|
||||
|
||||
def test_google_fonts_in_generated_redoc():
|
||||
body_with_google_fonts = get_redoc_html(
|
||||
openapi_url="/docs", title="title"
|
||||
).body.decode()
|
||||
assert "fonts.googleapis.com" in body_with_google_fonts
|
||||
body_without_google_fonts = get_redoc_html(
|
||||
openapi_url="/docs", title="title", with_google_fonts=False
|
||||
).body.decode()
|
||||
assert "fonts.googleapis.com" not in body_without_google_fonts
|
||||
@@ -0,0 +1,8 @@
|
||||
from fastapi import APIRouter, Body
|
||||
|
||||
router = APIRouter()
|
||||
|
||||
|
||||
@router.post("/compute")
|
||||
def compute(a: int = Body(), b: str = Body()):
|
||||
return {"a": a, "b": b}
|
||||
@@ -0,0 +1,8 @@
|
||||
from fastapi import APIRouter, Body
|
||||
|
||||
router = APIRouter()
|
||||
|
||||
|
||||
@router.post("/compute/")
|
||||
def compute(a: int = Body(), b: str = Body()):
|
||||
return {"a": a, "b": b}
|
||||
@@ -0,0 +1,8 @@
|
||||
from fastapi import FastAPI
|
||||
|
||||
from . import a, b
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
app.include_router(a.router, prefix="/a")
|
||||
app.include_router(b.router, prefix="/b")
|
||||
@@ -0,0 +1,149 @@
|
||||
import pytest
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
from .app.main import app
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"path", ["/a/compute", "/a/compute/", "/b/compute", "/b/compute/"]
|
||||
)
|
||||
def test_post(path):
|
||||
data = {"a": 2, "b": "foo"}
|
||||
response = client.post(path, json=data)
|
||||
assert response.status_code == 200, response.text
|
||||
assert data == response.json()
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"path", ["/a/compute", "/a/compute/", "/b/compute", "/b/compute/"]
|
||||
)
|
||||
def test_post_invalid(path):
|
||||
data = {"a": "bar", "b": "foo"}
|
||||
response = client.post(path, json=data)
|
||||
assert response.status_code == 422, response.text
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/a/compute": {
|
||||
"post": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
"summary": "Compute",
|
||||
"operationId": "compute_a_compute_post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Body_compute_a_compute_post"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
}
|
||||
},
|
||||
"/b/compute/": {
|
||||
"post": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
"summary": "Compute",
|
||||
"operationId": "compute_b_compute__post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Body_compute_b_compute__post"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
}
|
||||
},
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"Body_compute_b_compute__post": {
|
||||
"title": "Body_compute_b_compute__post",
|
||||
"required": ["a", "b"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"a": {"title": "A", "type": "integer"},
|
||||
"b": {"title": "B", "type": "string"},
|
||||
},
|
||||
},
|
||||
"Body_compute_a_compute_post": {
|
||||
"title": "Body_compute_a_compute_post",
|
||||
"required": ["a", "b"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"a": {"title": "A", "type": "integer"},
|
||||
"b": {"title": "B", "type": "string"},
|
||||
},
|
||||
},
|
||||
"ValidationError": {
|
||||
"title": "ValidationError",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"loc": {
|
||||
"title": "Location",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
},
|
||||
"msg": {"title": "Message", "type": "string"},
|
||||
"type": {"title": "Error Type", "type": "string"},
|
||||
},
|
||||
},
|
||||
"HTTPValidationError": {
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,239 @@
|
||||
from decimal import Decimal
|
||||
from typing import List
|
||||
|
||||
from dirty_equals import IsDict, IsOneOf
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel, condecimal
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
class Item(BaseModel):
|
||||
name: str
|
||||
age: condecimal(gt=Decimal(0.0)) # type: ignore
|
||||
|
||||
|
||||
@app.post("/items/")
|
||||
def save_item_no_body(item: List[Item]):
|
||||
return {"item": item}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_put_correct_body():
|
||||
response = client.post("/items/", json=[{"name": "Foo", "age": 5}])
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"item": [
|
||||
{
|
||||
"name": "Foo",
|
||||
"age": IsOneOf(
|
||||
5,
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
"5",
|
||||
),
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
def test_jsonable_encoder_requiring_error():
|
||||
response = client.post("/items/", json=[{"name": "Foo", "age": -1.0}])
|
||||
assert response.status_code == 422, response.text
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "greater_than",
|
||||
"loc": ["body", 0, "age"],
|
||||
"msg": "Input should be greater than 0",
|
||||
"input": -1.0,
|
||||
"ctx": {"gt": 0},
|
||||
}
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"ctx": {"limit_value": 0.0},
|
||||
"loc": ["body", 0, "age"],
|
||||
"msg": "ensure this value is greater than 0",
|
||||
"type": "value_error.number.not_gt",
|
||||
}
|
||||
]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def test_put_incorrect_body_multiple():
|
||||
response = client.post("/items/", json=[{"age": "five"}, {"age": "six"}])
|
||||
assert response.status_code == 422, response.text
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["body", 0, "name"],
|
||||
"msg": "Field required",
|
||||
"input": {"age": "five"},
|
||||
},
|
||||
{
|
||||
"type": "decimal_parsing",
|
||||
"loc": ["body", 0, "age"],
|
||||
"msg": "Input should be a valid decimal",
|
||||
"input": "five",
|
||||
},
|
||||
{
|
||||
"type": "missing",
|
||||
"loc": ["body", 1, "name"],
|
||||
"msg": "Field required",
|
||||
"input": {"age": "six"},
|
||||
},
|
||||
{
|
||||
"type": "decimal_parsing",
|
||||
"loc": ["body", 1, "age"],
|
||||
"msg": "Input should be a valid decimal",
|
||||
"input": "six",
|
||||
},
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["body", 0, "name"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
},
|
||||
{
|
||||
"loc": ["body", 0, "age"],
|
||||
"msg": "value is not a valid decimal",
|
||||
"type": "type_error.decimal",
|
||||
},
|
||||
{
|
||||
"loc": ["body", 1, "name"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
},
|
||||
{
|
||||
"loc": ["body", 1, "age"],
|
||||
"msg": "value is not a valid decimal",
|
||||
"type": "type_error.decimal",
|
||||
},
|
||||
]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/items/": {
|
||||
"post": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
"summary": "Save Item No Body",
|
||||
"operationId": "save_item_no_body_items__post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"title": "Item",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/Item"},
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"Item": {
|
||||
"title": "Item",
|
||||
"required": ["name", "age"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {"title": "Name", "type": "string"},
|
||||
"age": IsDict(
|
||||
{
|
||||
"title": "Age",
|
||||
"anyOf": [
|
||||
{"exclusiveMinimum": 0.0, "type": "number"},
|
||||
IsOneOf(
|
||||
# pydantic < 2.12.0
|
||||
{"type": "string"},
|
||||
# pydantic >= 2.12.0
|
||||
{
|
||||
"type": "string",
|
||||
"pattern": r"^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$",
|
||||
},
|
||||
),
|
||||
],
|
||||
}
|
||||
)
|
||||
| IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"title": "Age",
|
||||
"exclusiveMinimum": 0.0,
|
||||
"type": "number",
|
||||
}
|
||||
),
|
||||
},
|
||||
},
|
||||
"ValidationError": {
|
||||
"title": "ValidationError",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"loc": {
|
||||
"title": "Location",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
},
|
||||
"msg": {"title": "Message", "type": "string"},
|
||||
"type": {"title": "Error Type", "type": "string"},
|
||||
},
|
||||
},
|
||||
"HTTPValidationError": {
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,136 @@
|
||||
from typing import List
|
||||
|
||||
from dirty_equals import IsDict
|
||||
from fastapi import FastAPI, Query
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.get("/items/")
|
||||
def read_items(q: List[int] = Query(default=None)):
|
||||
return {"q": q}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_multi_query():
|
||||
response = client.get("/items/?q=5&q=6")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"q": [5, 6]}
|
||||
|
||||
|
||||
def test_multi_query_incorrect():
|
||||
response = client.get("/items/?q=five&q=six")
|
||||
assert response.status_code == 422, response.text
|
||||
assert response.json() == IsDict(
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"type": "int_parsing",
|
||||
"loc": ["query", "q", 0],
|
||||
"msg": "Input should be a valid integer, unable to parse string as an integer",
|
||||
"input": "five",
|
||||
},
|
||||
{
|
||||
"type": "int_parsing",
|
||||
"loc": ["query", "q", 1],
|
||||
"msg": "Input should be a valid integer, unable to parse string as an integer",
|
||||
"input": "six",
|
||||
},
|
||||
]
|
||||
}
|
||||
) | IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": ["query", "q", 0],
|
||||
"msg": "value is not a valid integer",
|
||||
"type": "type_error.integer",
|
||||
},
|
||||
{
|
||||
"loc": ["query", "q", 1],
|
||||
"msg": "value is not a valid integer",
|
||||
"type": "type_error.integer",
|
||||
},
|
||||
]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/items/": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
"summary": "Read Items",
|
||||
"operationId": "read_items_items__get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": False,
|
||||
"schema": {
|
||||
"title": "Q",
|
||||
"type": "array",
|
||||
"items": {"type": "integer"},
|
||||
},
|
||||
"name": "q",
|
||||
"in": "query",
|
||||
}
|
||||
],
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"ValidationError": {
|
||||
"title": "ValidationError",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"loc": {
|
||||
"title": "Location",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
},
|
||||
"msg": {"title": "Message", "type": "string"},
|
||||
"type": {"title": "Error Type", "type": "string"},
|
||||
},
|
||||
},
|
||||
"HTTPValidationError": {
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,149 @@
|
||||
import warnings
|
||||
|
||||
import pytest
|
||||
from fastapi import FastAPI, File, Form, UploadFile
|
||||
from fastapi.dependencies.utils import (
|
||||
multipart_incorrect_install_error,
|
||||
multipart_not_installed_error,
|
||||
)
|
||||
|
||||
|
||||
def test_incorrect_multipart_installed_form(monkeypatch):
|
||||
monkeypatch.setattr("python_multipart.__version__", "0.0.12")
|
||||
with warnings.catch_warnings(record=True):
|
||||
warnings.simplefilter("always")
|
||||
monkeypatch.delattr("multipart.multipart.parse_options_header", raising=False)
|
||||
with pytest.raises(RuntimeError, match=multipart_incorrect_install_error):
|
||||
app = FastAPI()
|
||||
|
||||
@app.post("/")
|
||||
async def root(username: str = Form()):
|
||||
return username # pragma: nocover
|
||||
|
||||
|
||||
def test_incorrect_multipart_installed_file_upload(monkeypatch):
|
||||
monkeypatch.setattr("python_multipart.__version__", "0.0.12")
|
||||
with warnings.catch_warnings(record=True):
|
||||
warnings.simplefilter("always")
|
||||
monkeypatch.delattr("multipart.multipart.parse_options_header", raising=False)
|
||||
with pytest.raises(RuntimeError, match=multipart_incorrect_install_error):
|
||||
app = FastAPI()
|
||||
|
||||
@app.post("/")
|
||||
async def root(f: UploadFile = File()):
|
||||
return f # pragma: nocover
|
||||
|
||||
|
||||
def test_incorrect_multipart_installed_file_bytes(monkeypatch):
|
||||
monkeypatch.setattr("python_multipart.__version__", "0.0.12")
|
||||
with warnings.catch_warnings(record=True):
|
||||
warnings.simplefilter("always")
|
||||
monkeypatch.delattr("multipart.multipart.parse_options_header", raising=False)
|
||||
with pytest.raises(RuntimeError, match=multipart_incorrect_install_error):
|
||||
app = FastAPI()
|
||||
|
||||
@app.post("/")
|
||||
async def root(f: bytes = File()):
|
||||
return f # pragma: nocover
|
||||
|
||||
|
||||
def test_incorrect_multipart_installed_multi_form(monkeypatch):
|
||||
monkeypatch.setattr("python_multipart.__version__", "0.0.12")
|
||||
with warnings.catch_warnings(record=True):
|
||||
warnings.simplefilter("always")
|
||||
monkeypatch.delattr("multipart.multipart.parse_options_header", raising=False)
|
||||
with pytest.raises(RuntimeError, match=multipart_incorrect_install_error):
|
||||
app = FastAPI()
|
||||
|
||||
@app.post("/")
|
||||
async def root(username: str = Form(), password: str = Form()):
|
||||
return username # pragma: nocover
|
||||
|
||||
|
||||
def test_incorrect_multipart_installed_form_file(monkeypatch):
|
||||
monkeypatch.setattr("python_multipart.__version__", "0.0.12")
|
||||
with warnings.catch_warnings(record=True):
|
||||
warnings.simplefilter("always")
|
||||
monkeypatch.delattr("multipart.multipart.parse_options_header", raising=False)
|
||||
with pytest.raises(RuntimeError, match=multipart_incorrect_install_error):
|
||||
app = FastAPI()
|
||||
|
||||
@app.post("/")
|
||||
async def root(username: str = Form(), f: UploadFile = File()):
|
||||
return username # pragma: nocover
|
||||
|
||||
|
||||
def test_no_multipart_installed(monkeypatch):
|
||||
monkeypatch.setattr("python_multipart.__version__", "0.0.12")
|
||||
with warnings.catch_warnings(record=True):
|
||||
warnings.simplefilter("always")
|
||||
monkeypatch.delattr("multipart.__version__", raising=False)
|
||||
with pytest.raises(RuntimeError, match=multipart_not_installed_error):
|
||||
app = FastAPI()
|
||||
|
||||
@app.post("/")
|
||||
async def root(username: str = Form()):
|
||||
return username # pragma: nocover
|
||||
|
||||
|
||||
def test_no_multipart_installed_file(monkeypatch):
|
||||
monkeypatch.setattr("python_multipart.__version__", "0.0.12")
|
||||
with warnings.catch_warnings(record=True):
|
||||
warnings.simplefilter("always")
|
||||
monkeypatch.delattr("multipart.__version__", raising=False)
|
||||
with pytest.raises(RuntimeError, match=multipart_not_installed_error):
|
||||
app = FastAPI()
|
||||
|
||||
@app.post("/")
|
||||
async def root(f: UploadFile = File()):
|
||||
return f # pragma: nocover
|
||||
|
||||
|
||||
def test_no_multipart_installed_file_bytes(monkeypatch):
|
||||
monkeypatch.setattr("python_multipart.__version__", "0.0.12")
|
||||
with warnings.catch_warnings(record=True):
|
||||
warnings.simplefilter("always")
|
||||
monkeypatch.delattr("multipart.__version__", raising=False)
|
||||
with pytest.raises(RuntimeError, match=multipart_not_installed_error):
|
||||
app = FastAPI()
|
||||
|
||||
@app.post("/")
|
||||
async def root(f: bytes = File()):
|
||||
return f # pragma: nocover
|
||||
|
||||
|
||||
def test_no_multipart_installed_multi_form(monkeypatch):
|
||||
monkeypatch.setattr("python_multipart.__version__", "0.0.12")
|
||||
with warnings.catch_warnings(record=True):
|
||||
warnings.simplefilter("always")
|
||||
monkeypatch.delattr("multipart.__version__", raising=False)
|
||||
with pytest.raises(RuntimeError, match=multipart_not_installed_error):
|
||||
app = FastAPI()
|
||||
|
||||
@app.post("/")
|
||||
async def root(username: str = Form(), password: str = Form()):
|
||||
return username # pragma: nocover
|
||||
|
||||
|
||||
def test_no_multipart_installed_form_file(monkeypatch):
|
||||
monkeypatch.setattr("python_multipart.__version__", "0.0.12")
|
||||
with warnings.catch_warnings(record=True):
|
||||
warnings.simplefilter("always")
|
||||
monkeypatch.delattr("multipart.__version__", raising=False)
|
||||
with pytest.raises(RuntimeError, match=multipart_not_installed_error):
|
||||
app = FastAPI()
|
||||
|
||||
@app.post("/")
|
||||
async def root(username: str = Form(), f: UploadFile = File()):
|
||||
return username # pragma: nocover
|
||||
|
||||
|
||||
def test_old_multipart_installed(monkeypatch):
|
||||
monkeypatch.setattr("python_multipart.__version__", "0.0.12")
|
||||
with warnings.catch_warnings(record=True):
|
||||
warnings.simplefilter("always")
|
||||
app = FastAPI()
|
||||
|
||||
@app.post("/")
|
||||
async def root(username: str = Form()):
|
||||
return username # pragma: nocover
|
||||
@@ -0,0 +1,203 @@
|
||||
# Test with parts from, and to verify the report in:
|
||||
# https://github.com/fastapi/fastapi/discussions/14177
|
||||
# Made an issue in:
|
||||
# https://github.com/fastapi/fastapi/issues/14247
|
||||
from enum import Enum
|
||||
from typing import List
|
||||
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
from inline_snapshot import snapshot
|
||||
from pydantic import BaseModel, Field
|
||||
|
||||
from tests.utils import pydantic_snapshot
|
||||
|
||||
|
||||
class MessageEventType(str, Enum):
|
||||
alpha = "alpha"
|
||||
beta = "beta"
|
||||
|
||||
|
||||
class MessageEvent(BaseModel):
|
||||
event_type: MessageEventType = Field(default=MessageEventType.alpha)
|
||||
output: str
|
||||
|
||||
|
||||
class MessageOutput(BaseModel):
|
||||
body: str = ""
|
||||
events: List[MessageEvent] = []
|
||||
|
||||
|
||||
class Message(BaseModel):
|
||||
input: str
|
||||
output: MessageOutput
|
||||
|
||||
|
||||
app = FastAPI(title="Minimal FastAPI App", version="1.0.0")
|
||||
|
||||
|
||||
@app.post("/messages", response_model=Message)
|
||||
async def create_message(input_message: str) -> Message:
|
||||
return Message(
|
||||
input=input_message,
|
||||
output=MessageOutput(body=f"Processed: {input_message}"),
|
||||
)
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_create_message():
|
||||
response = client.post("/messages", params={"input_message": "Hello"})
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"input": "Hello",
|
||||
"output": {"body": "Processed: Hello", "events": []},
|
||||
}
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == snapshot(
|
||||
{
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "Minimal FastAPI App", "version": "1.0.0"},
|
||||
"paths": {
|
||||
"/messages": {
|
||||
"post": {
|
||||
"summary": "Create Message",
|
||||
"operationId": "create_message_messages_post",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "input_message",
|
||||
"in": "query",
|
||||
"required": True,
|
||||
"schema": {"type": "string", "title": "Input Message"},
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Message"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"HTTPValidationError": {
|
||||
"properties": {
|
||||
"detail": {
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/ValidationError"
|
||||
},
|
||||
"type": "array",
|
||||
"title": "Detail",
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"title": "HTTPValidationError",
|
||||
},
|
||||
"Message": {
|
||||
"properties": {
|
||||
"input": {"type": "string", "title": "Input"},
|
||||
"output": {"$ref": "#/components/schemas/MessageOutput"},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["input", "output"],
|
||||
"title": "Message",
|
||||
},
|
||||
"MessageEvent": {
|
||||
"properties": {
|
||||
"event_type": pydantic_snapshot(
|
||||
v2=snapshot(
|
||||
{
|
||||
"$ref": "#/components/schemas/MessageEventType",
|
||||
"default": "alpha",
|
||||
}
|
||||
),
|
||||
v1=snapshot(
|
||||
{
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/MessageEventType"
|
||||
}
|
||||
],
|
||||
"default": "alpha",
|
||||
}
|
||||
),
|
||||
),
|
||||
"output": {"type": "string", "title": "Output"},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["output"],
|
||||
"title": "MessageEvent",
|
||||
},
|
||||
"MessageEventType": pydantic_snapshot(
|
||||
v2=snapshot(
|
||||
{
|
||||
"type": "string",
|
||||
"enum": ["alpha", "beta"],
|
||||
"title": "MessageEventType",
|
||||
}
|
||||
),
|
||||
v1=snapshot(
|
||||
{
|
||||
"type": "string",
|
||||
"enum": ["alpha", "beta"],
|
||||
"title": "MessageEventType",
|
||||
"description": "An enumeration.",
|
||||
}
|
||||
),
|
||||
),
|
||||
"MessageOutput": {
|
||||
"properties": {
|
||||
"body": {"type": "string", "title": "Body", "default": ""},
|
||||
"events": {
|
||||
"items": {"$ref": "#/components/schemas/MessageEvent"},
|
||||
"type": "array",
|
||||
"title": "Events",
|
||||
"default": [],
|
||||
},
|
||||
},
|
||||
"type": "object",
|
||||
"title": "MessageOutput",
|
||||
},
|
||||
"ValidationError": {
|
||||
"properties": {
|
||||
"loc": {
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
"type": "array",
|
||||
"title": "Location",
|
||||
},
|
||||
"msg": {"type": "string", "title": "Message"},
|
||||
"type": {"type": "string", "title": "Error Type"},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"title": "ValidationError",
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
)
|
||||
@@ -0,0 +1,31 @@
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI(swagger_ui_oauth2_redirect_url=None)
|
||||
|
||||
|
||||
@app.get("/items/")
|
||||
async def read_items():
|
||||
return {"id": "foo"}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_swagger_ui():
|
||||
response = client.get("/docs")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.headers["content-type"] == "text/html; charset=utf-8"
|
||||
assert "swagger-ui-dist" in response.text
|
||||
print(client.base_url)
|
||||
assert "oauth2RedirectUrl" not in response.text
|
||||
|
||||
|
||||
def test_swagger_ui_no_oauth2_redirect():
|
||||
response = client.get("/docs/oauth2-redirect")
|
||||
assert response.status_code == 404, response.text
|
||||
|
||||
|
||||
def test_response():
|
||||
response = client.get("/items/")
|
||||
assert response.json() == {"id": "foo"}
|
||||
@@ -0,0 +1,471 @@
|
||||
from typing import Union
|
||||
|
||||
from dirty_equals import IsDict
|
||||
from fastapi import Body, Cookie, FastAPI, Header, Path, Query
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
class Item(BaseModel):
|
||||
data: str
|
||||
|
||||
|
||||
@app.post("/examples/")
|
||||
def examples(
|
||||
item: Item = Body(
|
||||
examples=[
|
||||
{"data": "Data in Body examples, example1"},
|
||||
],
|
||||
openapi_examples={
|
||||
"Example One": {
|
||||
"summary": "Example One Summary",
|
||||
"description": "Example One Description",
|
||||
"value": {"data": "Data in Body examples, example1"},
|
||||
},
|
||||
"Example Two": {
|
||||
"value": {"data": "Data in Body examples, example2"},
|
||||
},
|
||||
},
|
||||
),
|
||||
):
|
||||
return item
|
||||
|
||||
|
||||
@app.get("/path_examples/{item_id}")
|
||||
def path_examples(
|
||||
item_id: str = Path(
|
||||
examples=[
|
||||
"json_schema_item_1",
|
||||
"json_schema_item_2",
|
||||
],
|
||||
openapi_examples={
|
||||
"Path One": {
|
||||
"summary": "Path One Summary",
|
||||
"description": "Path One Description",
|
||||
"value": "item_1",
|
||||
},
|
||||
"Path Two": {
|
||||
"value": "item_2",
|
||||
},
|
||||
},
|
||||
),
|
||||
):
|
||||
return item_id
|
||||
|
||||
|
||||
@app.get("/query_examples/")
|
||||
def query_examples(
|
||||
data: Union[str, None] = Query(
|
||||
default=None,
|
||||
examples=[
|
||||
"json_schema_query1",
|
||||
"json_schema_query2",
|
||||
],
|
||||
openapi_examples={
|
||||
"Query One": {
|
||||
"summary": "Query One Summary",
|
||||
"description": "Query One Description",
|
||||
"value": "query1",
|
||||
},
|
||||
"Query Two": {
|
||||
"value": "query2",
|
||||
},
|
||||
},
|
||||
),
|
||||
):
|
||||
return data
|
||||
|
||||
|
||||
@app.get("/header_examples/")
|
||||
def header_examples(
|
||||
data: Union[str, None] = Header(
|
||||
default=None,
|
||||
examples=[
|
||||
"json_schema_header1",
|
||||
"json_schema_header2",
|
||||
],
|
||||
openapi_examples={
|
||||
"Header One": {
|
||||
"summary": "Header One Summary",
|
||||
"description": "Header One Description",
|
||||
"value": "header1",
|
||||
},
|
||||
"Header Two": {
|
||||
"value": "header2",
|
||||
},
|
||||
},
|
||||
),
|
||||
):
|
||||
return data
|
||||
|
||||
|
||||
@app.get("/cookie_examples/")
|
||||
def cookie_examples(
|
||||
data: Union[str, None] = Cookie(
|
||||
default=None,
|
||||
examples=["json_schema_cookie1", "json_schema_cookie2"],
|
||||
openapi_examples={
|
||||
"Cookie One": {
|
||||
"summary": "Cookie One Summary",
|
||||
"description": "Cookie One Description",
|
||||
"value": "cookie1",
|
||||
},
|
||||
"Cookie Two": {
|
||||
"value": "cookie2",
|
||||
},
|
||||
},
|
||||
),
|
||||
):
|
||||
return data
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_call_api():
|
||||
response = client.post("/examples/", json={"data": "example1"})
|
||||
assert response.status_code == 200, response.text
|
||||
|
||||
response = client.get("/path_examples/foo")
|
||||
assert response.status_code == 200, response.text
|
||||
|
||||
response = client.get("/query_examples/")
|
||||
assert response.status_code == 200, response.text
|
||||
|
||||
response = client.get("/header_examples/")
|
||||
assert response.status_code == 200, response.text
|
||||
|
||||
response = client.get("/cookie_examples/")
|
||||
assert response.status_code == 200, response.text
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/examples/": {
|
||||
"post": {
|
||||
"summary": "Examples",
|
||||
"operationId": "examples_examples__post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": IsDict(
|
||||
{
|
||||
"$ref": "#/components/schemas/Item",
|
||||
"examples": [
|
||||
{"data": "Data in Body examples, example1"}
|
||||
],
|
||||
}
|
||||
)
|
||||
| IsDict(
|
||||
{
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
"allOf": [
|
||||
{"$ref": "#/components/schemas/Item"}
|
||||
],
|
||||
"title": "Item",
|
||||
"examples": [
|
||||
{"data": "Data in Body examples, example1"}
|
||||
],
|
||||
}
|
||||
),
|
||||
"examples": {
|
||||
"Example One": {
|
||||
"summary": "Example One Summary",
|
||||
"description": "Example One Description",
|
||||
"value": {
|
||||
"data": "Data in Body examples, example1"
|
||||
},
|
||||
},
|
||||
"Example Two": {
|
||||
"value": {
|
||||
"data": "Data in Body examples, example2"
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/path_examples/{item_id}": {
|
||||
"get": {
|
||||
"summary": "Path Examples",
|
||||
"operationId": "path_examples_path_examples__item_id__get",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "item_id",
|
||||
"in": "path",
|
||||
"required": True,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"examples": [
|
||||
"json_schema_item_1",
|
||||
"json_schema_item_2",
|
||||
],
|
||||
"title": "Item Id",
|
||||
},
|
||||
"examples": {
|
||||
"Path One": {
|
||||
"summary": "Path One Summary",
|
||||
"description": "Path One Description",
|
||||
"value": "item_1",
|
||||
},
|
||||
"Path Two": {"value": "item_2"},
|
||||
},
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/query_examples/": {
|
||||
"get": {
|
||||
"summary": "Query Examples",
|
||||
"operationId": "query_examples_query_examples__get",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "data",
|
||||
"in": "query",
|
||||
"required": False,
|
||||
"schema": IsDict(
|
||||
{
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}],
|
||||
"examples": [
|
||||
"json_schema_query1",
|
||||
"json_schema_query2",
|
||||
],
|
||||
"title": "Data",
|
||||
}
|
||||
)
|
||||
| IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"examples": [
|
||||
"json_schema_query1",
|
||||
"json_schema_query2",
|
||||
],
|
||||
"type": "string",
|
||||
"title": "Data",
|
||||
}
|
||||
),
|
||||
"examples": {
|
||||
"Query One": {
|
||||
"summary": "Query One Summary",
|
||||
"description": "Query One Description",
|
||||
"value": "query1",
|
||||
},
|
||||
"Query Two": {"value": "query2"},
|
||||
},
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/header_examples/": {
|
||||
"get": {
|
||||
"summary": "Header Examples",
|
||||
"operationId": "header_examples_header_examples__get",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "data",
|
||||
"in": "header",
|
||||
"required": False,
|
||||
"schema": IsDict(
|
||||
{
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}],
|
||||
"examples": [
|
||||
"json_schema_header1",
|
||||
"json_schema_header2",
|
||||
],
|
||||
"title": "Data",
|
||||
}
|
||||
)
|
||||
| IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"type": "string",
|
||||
"examples": [
|
||||
"json_schema_header1",
|
||||
"json_schema_header2",
|
||||
],
|
||||
"title": "Data",
|
||||
}
|
||||
),
|
||||
"examples": {
|
||||
"Header One": {
|
||||
"summary": "Header One Summary",
|
||||
"description": "Header One Description",
|
||||
"value": "header1",
|
||||
},
|
||||
"Header Two": {"value": "header2"},
|
||||
},
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/cookie_examples/": {
|
||||
"get": {
|
||||
"summary": "Cookie Examples",
|
||||
"operationId": "cookie_examples_cookie_examples__get",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "data",
|
||||
"in": "cookie",
|
||||
"required": False,
|
||||
"schema": IsDict(
|
||||
{
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}],
|
||||
"examples": [
|
||||
"json_schema_cookie1",
|
||||
"json_schema_cookie2",
|
||||
],
|
||||
"title": "Data",
|
||||
}
|
||||
)
|
||||
| IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"type": "string",
|
||||
"examples": [
|
||||
"json_schema_cookie1",
|
||||
"json_schema_cookie2",
|
||||
],
|
||||
"title": "Data",
|
||||
}
|
||||
),
|
||||
"examples": {
|
||||
"Cookie One": {
|
||||
"summary": "Cookie One Summary",
|
||||
"description": "Cookie One Description",
|
||||
"value": "cookie1",
|
||||
},
|
||||
"Cookie Two": {"value": "cookie2"},
|
||||
},
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"HTTPValidationError": {
|
||||
"properties": {
|
||||
"detail": {
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
"type": "array",
|
||||
"title": "Detail",
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"title": "HTTPValidationError",
|
||||
},
|
||||
"Item": {
|
||||
"properties": {"data": {"type": "string", "title": "Data"}},
|
||||
"type": "object",
|
||||
"required": ["data"],
|
||||
"title": "Item",
|
||||
},
|
||||
"ValidationError": {
|
||||
"properties": {
|
||||
"loc": {
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
"type": "array",
|
||||
"title": "Location",
|
||||
},
|
||||
"msg": {"type": "string", "title": "Message"},
|
||||
"type": {"type": "string", "title": "Error Type"},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"title": "ValidationError",
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
class MyModel(BaseModel):
|
||||
"""
|
||||
A model with a form feed character in the title.
|
||||
\f
|
||||
Text after form feed character.
|
||||
"""
|
||||
|
||||
|
||||
@app.get("/foo")
|
||||
def foo(v: MyModel): # pragma: no cover
|
||||
pass
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_openapi():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
openapi_schema = response.json()
|
||||
|
||||
assert openapi_schema["components"]["schemas"]["MyModel"]["description"] == (
|
||||
"A model with a form feed character in the title.\n"
|
||||
)
|
||||
@@ -0,0 +1,137 @@
|
||||
from typing import Optional
|
||||
|
||||
from dirty_equals import IsDict
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.get(
|
||||
"/",
|
||||
openapi_extra={
|
||||
"parameters": [
|
||||
{
|
||||
"required": False,
|
||||
"schema": {"title": "Extra Param 1"},
|
||||
"name": "extra_param_1",
|
||||
"in": "query",
|
||||
},
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "Extra Param 2"},
|
||||
"name": "extra_param_2",
|
||||
"in": "query",
|
||||
},
|
||||
]
|
||||
},
|
||||
)
|
||||
def route_with_extra_query_parameters(standard_query_param: Optional[int] = 50):
|
||||
return {}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_get_route():
|
||||
response = client.get("/")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {}
|
||||
|
||||
|
||||
def test_openapi():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/": {
|
||||
"get": {
|
||||
"summary": "Route With Extra Query Parameters",
|
||||
"operationId": "route_with_extra_query_parameters__get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": False,
|
||||
"schema": IsDict(
|
||||
{
|
||||
"anyOf": [{"type": "integer"}, {"type": "null"}],
|
||||
"default": 50,
|
||||
"title": "Standard Query Param",
|
||||
}
|
||||
)
|
||||
| IsDict(
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
{
|
||||
"title": "Standard Query Param",
|
||||
"type": "integer",
|
||||
"default": 50,
|
||||
}
|
||||
),
|
||||
"name": "standard_query_param",
|
||||
"in": "query",
|
||||
},
|
||||
{
|
||||
"required": False,
|
||||
"schema": {"title": "Extra Param 1"},
|
||||
"name": "extra_param_1",
|
||||
"in": "query",
|
||||
},
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "Extra Param 2"},
|
||||
"name": "extra_param_2",
|
||||
"in": "query",
|
||||
},
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"HTTPValidationError": {
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
}
|
||||
},
|
||||
},
|
||||
"ValidationError": {
|
||||
"title": "ValidationError",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"loc": {
|
||||
"title": "Location",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
},
|
||||
"msg": {"title": "Message", "type": "string"},
|
||||
"type": {"title": "Error Type", "type": "string"},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.get("/", openapi_extra={"x-custom-extension": "value"})
|
||||
def route_with_extras():
|
||||
return {}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_get_route():
|
||||
response = client.get("/")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {}
|
||||
|
||||
|
||||
def test_openapi():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
},
|
||||
"summary": "Route With Extras",
|
||||
"operationId": "route_with_extras__get",
|
||||
"x-custom-extension": "value",
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
from typing import List, Optional, Union
|
||||
|
||||
import pytest
|
||||
from fastapi.openapi.models import Schema, SchemaType
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"type_value",
|
||||
[
|
||||
"array",
|
||||
["string", "null"],
|
||||
None,
|
||||
],
|
||||
)
|
||||
def test_allowed_schema_type(
|
||||
type_value: Optional[Union[SchemaType, List[SchemaType]]],
|
||||
) -> None:
|
||||
"""Test that Schema accepts SchemaType, List[SchemaType] and None for type field."""
|
||||
schema = Schema(type=type_value)
|
||||
assert schema.type == type_value
|
||||
|
||||
|
||||
def test_invalid_type_value() -> None:
|
||||
"""Test that Schema raises ValueError for invalid type values."""
|
||||
with pytest.raises(ValueError, match="2 validation errors for Schema"):
|
||||
Schema(type=True) # type: ignore[arg-type]
|
||||
@@ -0,0 +1,680 @@
|
||||
from typing import List, Optional
|
||||
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
from inline_snapshot import snapshot
|
||||
from pydantic import BaseModel
|
||||
|
||||
from .utils import PYDANTIC_V2, needs_pydanticv2
|
||||
|
||||
|
||||
class SubItem(BaseModel):
|
||||
subname: str
|
||||
sub_description: Optional[str] = None
|
||||
tags: List[str] = []
|
||||
if PYDANTIC_V2:
|
||||
model_config = {"json_schema_serialization_defaults_required": True}
|
||||
|
||||
|
||||
class Item(BaseModel):
|
||||
name: str
|
||||
description: Optional[str] = None
|
||||
sub: Optional[SubItem] = None
|
||||
if PYDANTIC_V2:
|
||||
model_config = {"json_schema_serialization_defaults_required": True}
|
||||
|
||||
|
||||
if PYDANTIC_V2:
|
||||
from pydantic import computed_field
|
||||
|
||||
class WithComputedField(BaseModel):
|
||||
name: str
|
||||
|
||||
@computed_field
|
||||
@property
|
||||
def computed_field(self) -> str:
|
||||
return f"computed {self.name}"
|
||||
|
||||
|
||||
def get_app_client(separate_input_output_schemas: bool = True) -> TestClient:
|
||||
app = FastAPI(separate_input_output_schemas=separate_input_output_schemas)
|
||||
|
||||
@app.post("/items/", responses={402: {"model": Item}})
|
||||
def create_item(item: Item) -> Item:
|
||||
return item
|
||||
|
||||
@app.post("/items-list/")
|
||||
def create_item_list(item: List[Item]):
|
||||
return item
|
||||
|
||||
@app.get("/items/")
|
||||
def read_items() -> List[Item]:
|
||||
return [
|
||||
Item(
|
||||
name="Portal Gun",
|
||||
description="Device to travel through the multi-rick-verse",
|
||||
sub=SubItem(subname="subname"),
|
||||
),
|
||||
Item(name="Plumbus"),
|
||||
]
|
||||
|
||||
if PYDANTIC_V2:
|
||||
|
||||
@app.post("/with-computed-field/")
|
||||
def create_with_computed_field(
|
||||
with_computed_field: WithComputedField,
|
||||
) -> WithComputedField:
|
||||
return with_computed_field
|
||||
|
||||
client = TestClient(app)
|
||||
return client
|
||||
|
||||
|
||||
def test_create_item():
|
||||
client = get_app_client()
|
||||
client_no = get_app_client(separate_input_output_schemas=False)
|
||||
response = client.post("/items/", json={"name": "Plumbus"})
|
||||
response2 = client_no.post("/items/", json={"name": "Plumbus"})
|
||||
assert response.status_code == response2.status_code == 200, response.text
|
||||
assert (
|
||||
response.json()
|
||||
== response2.json()
|
||||
== {"name": "Plumbus", "description": None, "sub": None}
|
||||
)
|
||||
|
||||
|
||||
def test_create_item_with_sub():
|
||||
client = get_app_client()
|
||||
client_no = get_app_client(separate_input_output_schemas=False)
|
||||
data = {
|
||||
"name": "Plumbus",
|
||||
"sub": {"subname": "SubPlumbus", "sub_description": "Sub WTF"},
|
||||
}
|
||||
response = client.post("/items/", json=data)
|
||||
response2 = client_no.post("/items/", json=data)
|
||||
assert response.status_code == response2.status_code == 200, response.text
|
||||
assert (
|
||||
response.json()
|
||||
== response2.json()
|
||||
== {
|
||||
"name": "Plumbus",
|
||||
"description": None,
|
||||
"sub": {"subname": "SubPlumbus", "sub_description": "Sub WTF", "tags": []},
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def test_create_item_list():
|
||||
client = get_app_client()
|
||||
client_no = get_app_client(separate_input_output_schemas=False)
|
||||
data = [
|
||||
{"name": "Plumbus"},
|
||||
{
|
||||
"name": "Portal Gun",
|
||||
"description": "Device to travel through the multi-rick-verse",
|
||||
},
|
||||
]
|
||||
response = client.post("/items-list/", json=data)
|
||||
response2 = client_no.post("/items-list/", json=data)
|
||||
assert response.status_code == response2.status_code == 200, response.text
|
||||
assert (
|
||||
response.json()
|
||||
== response2.json()
|
||||
== [
|
||||
{"name": "Plumbus", "description": None, "sub": None},
|
||||
{
|
||||
"name": "Portal Gun",
|
||||
"description": "Device to travel through the multi-rick-verse",
|
||||
"sub": None,
|
||||
},
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
def test_read_items():
|
||||
client = get_app_client()
|
||||
client_no = get_app_client(separate_input_output_schemas=False)
|
||||
response = client.get("/items/")
|
||||
response2 = client_no.get("/items/")
|
||||
assert response.status_code == response2.status_code == 200, response.text
|
||||
assert (
|
||||
response.json()
|
||||
== response2.json()
|
||||
== [
|
||||
{
|
||||
"name": "Portal Gun",
|
||||
"description": "Device to travel through the multi-rick-verse",
|
||||
"sub": {"subname": "subname", "sub_description": None, "tags": []},
|
||||
},
|
||||
{"name": "Plumbus", "description": None, "sub": None},
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_with_computed_field():
|
||||
client = get_app_client()
|
||||
client_no = get_app_client(separate_input_output_schemas=False)
|
||||
response = client.post("/with-computed-field/", json={"name": "example"})
|
||||
response2 = client_no.post("/with-computed-field/", json={"name": "example"})
|
||||
assert response.status_code == response2.status_code == 200, response.text
|
||||
assert (
|
||||
response.json()
|
||||
== response2.json()
|
||||
== {
|
||||
"name": "example",
|
||||
"computed_field": "computed example",
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_openapi_schema():
|
||||
client = get_app_client()
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == snapshot(
|
||||
{
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/items/": {
|
||||
"get": {
|
||||
"summary": "Read Items",
|
||||
"operationId": "read_items_items__get",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/Item-Output"
|
||||
},
|
||||
"type": "array",
|
||||
"title": "Response Read Items Items Get",
|
||||
}
|
||||
}
|
||||
},
|
||||
}
|
||||
},
|
||||
},
|
||||
"post": {
|
||||
"summary": "Create Item",
|
||||
"operationId": "create_item_items__post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Item-Input"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Item-Output"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
"402": {
|
||||
"description": "Payment Required",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Item-Output"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
"/items-list/": {
|
||||
"post": {
|
||||
"summary": "Create Item List",
|
||||
"operationId": "create_item_list_items_list__post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/Item-Input"
|
||||
},
|
||||
"type": "array",
|
||||
"title": "Item",
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/with-computed-field/": {
|
||||
"post": {
|
||||
"summary": "Create With Computed Field",
|
||||
"operationId": "create_with_computed_field_with_computed_field__post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/WithComputedField-Input"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/WithComputedField-Output"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"HTTPValidationError": {
|
||||
"properties": {
|
||||
"detail": {
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/ValidationError"
|
||||
},
|
||||
"type": "array",
|
||||
"title": "Detail",
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"title": "HTTPValidationError",
|
||||
},
|
||||
"Item-Input": {
|
||||
"properties": {
|
||||
"name": {"type": "string", "title": "Name"},
|
||||
"description": {
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}],
|
||||
"title": "Description",
|
||||
},
|
||||
"sub": {
|
||||
"anyOf": [
|
||||
{"$ref": "#/components/schemas/SubItem-Input"},
|
||||
{"type": "null"},
|
||||
]
|
||||
},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["name"],
|
||||
"title": "Item",
|
||||
},
|
||||
"Item-Output": {
|
||||
"properties": {
|
||||
"name": {"type": "string", "title": "Name"},
|
||||
"description": {
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}],
|
||||
"title": "Description",
|
||||
},
|
||||
"sub": {
|
||||
"anyOf": [
|
||||
{"$ref": "#/components/schemas/SubItem-Output"},
|
||||
{"type": "null"},
|
||||
]
|
||||
},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["name", "description", "sub"],
|
||||
"title": "Item",
|
||||
},
|
||||
"SubItem-Input": {
|
||||
"properties": {
|
||||
"subname": {"type": "string", "title": "Subname"},
|
||||
"sub_description": {
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}],
|
||||
"title": "Sub Description",
|
||||
},
|
||||
"tags": {
|
||||
"items": {"type": "string"},
|
||||
"type": "array",
|
||||
"title": "Tags",
|
||||
"default": [],
|
||||
},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["subname"],
|
||||
"title": "SubItem",
|
||||
},
|
||||
"SubItem-Output": {
|
||||
"properties": {
|
||||
"subname": {"type": "string", "title": "Subname"},
|
||||
"sub_description": {
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}],
|
||||
"title": "Sub Description",
|
||||
},
|
||||
"tags": {
|
||||
"items": {"type": "string"},
|
||||
"type": "array",
|
||||
"title": "Tags",
|
||||
"default": [],
|
||||
},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["subname", "sub_description", "tags"],
|
||||
"title": "SubItem",
|
||||
},
|
||||
"WithComputedField-Input": {
|
||||
"properties": {"name": {"type": "string", "title": "Name"}},
|
||||
"type": "object",
|
||||
"required": ["name"],
|
||||
"title": "WithComputedField",
|
||||
},
|
||||
"WithComputedField-Output": {
|
||||
"properties": {
|
||||
"name": {"type": "string", "title": "Name"},
|
||||
"computed_field": {
|
||||
"type": "string",
|
||||
"title": "Computed Field",
|
||||
"readOnly": True,
|
||||
},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["name", "computed_field"],
|
||||
"title": "WithComputedField",
|
||||
},
|
||||
"ValidationError": {
|
||||
"properties": {
|
||||
"loc": {
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
"type": "array",
|
||||
"title": "Location",
|
||||
},
|
||||
"msg": {"type": "string", "title": "Message"},
|
||||
"type": {"type": "string", "title": "Error Type"},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"title": "ValidationError",
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
@needs_pydanticv2
|
||||
def test_openapi_schema_no_separate():
|
||||
client = get_app_client(separate_input_output_schemas=False)
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/items/": {
|
||||
"get": {
|
||||
"summary": "Read Items",
|
||||
"operationId": "read_items_items__get",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"items": {"$ref": "#/components/schemas/Item"},
|
||||
"type": "array",
|
||||
"title": "Response Read Items Items Get",
|
||||
}
|
||||
}
|
||||
},
|
||||
}
|
||||
},
|
||||
},
|
||||
"post": {
|
||||
"summary": "Create Item",
|
||||
"operationId": "create_item_items__post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {"$ref": "#/components/schemas/Item"}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {"$ref": "#/components/schemas/Item"}
|
||||
}
|
||||
},
|
||||
},
|
||||
"402": {
|
||||
"description": "Payment Required",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {"$ref": "#/components/schemas/Item"}
|
||||
}
|
||||
},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
"/items-list/": {
|
||||
"post": {
|
||||
"summary": "Create Item List",
|
||||
"operationId": "create_item_list_items_list__post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"items": {"$ref": "#/components/schemas/Item"},
|
||||
"type": "array",
|
||||
"title": "Item",
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/with-computed-field/": {
|
||||
"post": {
|
||||
"summary": "Create With Computed Field",
|
||||
"operationId": "create_with_computed_field_with_computed_field__post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/WithComputedField-Input"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": True,
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/WithComputedField-Output"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"HTTPValidationError": {
|
||||
"properties": {
|
||||
"detail": {
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
"type": "array",
|
||||
"title": "Detail",
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"title": "HTTPValidationError",
|
||||
},
|
||||
"Item": {
|
||||
"properties": {
|
||||
"name": {"type": "string", "title": "Name"},
|
||||
"description": {
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}],
|
||||
"title": "Description",
|
||||
},
|
||||
"sub": {
|
||||
"anyOf": [
|
||||
{"$ref": "#/components/schemas/SubItem"},
|
||||
{"type": "null"},
|
||||
]
|
||||
},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["name"],
|
||||
"title": "Item",
|
||||
},
|
||||
"SubItem": {
|
||||
"properties": {
|
||||
"subname": {"type": "string", "title": "Subname"},
|
||||
"sub_description": {
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}],
|
||||
"title": "Sub Description",
|
||||
},
|
||||
"tags": {
|
||||
"items": {"type": "string"},
|
||||
"type": "array",
|
||||
"title": "Tags",
|
||||
"default": [],
|
||||
},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["subname"],
|
||||
"title": "SubItem",
|
||||
},
|
||||
"WithComputedField-Input": {
|
||||
"properties": {"name": {"type": "string", "title": "Name"}},
|
||||
"type": "object",
|
||||
"required": ["name"],
|
||||
"title": "WithComputedField",
|
||||
},
|
||||
"WithComputedField-Output": {
|
||||
"properties": {
|
||||
"name": {"type": "string", "title": "Name"},
|
||||
"computed_field": {
|
||||
"type": "string",
|
||||
"title": "Computed Field",
|
||||
"readOnly": True,
|
||||
},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["name", "computed_field"],
|
||||
"title": "WithComputedField",
|
||||
},
|
||||
"ValidationError": {
|
||||
"properties": {
|
||||
"loc": {
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
"type": "array",
|
||||
"title": "Location",
|
||||
},
|
||||
"msg": {"type": "string", "title": "Message"},
|
||||
"type": {"type": "string", "title": "Error Type"},
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"title": "ValidationError",
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,68 @@
|
||||
from dirty_equals import IsOneOf
|
||||
from fastapi import FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI(
|
||||
servers=[
|
||||
{"url": "/", "description": "Default, relative server"},
|
||||
{
|
||||
"url": "http://staging.localhost.tiangolo.com:8000",
|
||||
"description": "Staging but actually localhost still",
|
||||
},
|
||||
{"url": "https://prod.example.com"},
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
@app.get("/foo")
|
||||
def foo():
|
||||
return {"message": "Hello World"}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_app():
|
||||
response = client.get("/foo")
|
||||
assert response.status_code == 200, response.text
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"servers": [
|
||||
{"url": "/", "description": "Default, relative server"},
|
||||
{
|
||||
"url": IsOneOf(
|
||||
"http://staging.localhost.tiangolo.com:8000/",
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
"http://staging.localhost.tiangolo.com:8000",
|
||||
),
|
||||
"description": "Staging but actually localhost still",
|
||||
},
|
||||
{
|
||||
"url": IsOneOf(
|
||||
"https://prod.example.com/",
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
"https://prod.example.com",
|
||||
)
|
||||
},
|
||||
],
|
||||
"paths": {
|
||||
"/foo": {
|
||||
"get": {
|
||||
"summary": "Foo",
|
||||
"operationId": "foo_foo_get",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
import inspect
|
||||
|
||||
from fastapi import APIRouter, FastAPI
|
||||
|
||||
method_names = ["get", "put", "post", "delete", "options", "head", "patch", "trace"]
|
||||
|
||||
|
||||
def test_signatures_consistency():
|
||||
base_sig = inspect.signature(APIRouter.get)
|
||||
for method_name in method_names:
|
||||
router_method = getattr(APIRouter, method_name)
|
||||
app_method = getattr(FastAPI, method_name)
|
||||
router_sig = inspect.signature(router_method)
|
||||
app_sig = inspect.signature(app_method)
|
||||
param: inspect.Parameter
|
||||
for key, param in base_sig.parameters.items():
|
||||
router_param: inspect.Parameter = router_sig.parameters[key]
|
||||
app_param: inspect.Parameter = app_sig.parameters[key]
|
||||
assert param.annotation == router_param.annotation
|
||||
assert param.annotation == app_param.annotation
|
||||
assert param.default == router_param.default
|
||||
assert param.default == app_param.default
|
||||
@@ -0,0 +1,30 @@
|
||||
from typing import List, Optional
|
||||
|
||||
from fastapi import FastAPI, File
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.post("/files")
|
||||
async def upload_files(files: Optional[List[bytes]] = File(None)):
|
||||
if files is None:
|
||||
return {"files_count": 0}
|
||||
return {"files_count": len(files), "sizes": [len(f) for f in files]}
|
||||
|
||||
|
||||
def test_optional_bytes_list():
|
||||
client = TestClient(app)
|
||||
response = client.post(
|
||||
"/files",
|
||||
files=[("files", b"content1"), ("files", b"content2")],
|
||||
)
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"files_count": 2, "sizes": [8, 8]}
|
||||
|
||||
|
||||
def test_optional_bytes_list_no_files():
|
||||
client = TestClient(app)
|
||||
response = client.post("/files")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"files_count": 0}
|
||||
@@ -0,0 +1,21 @@
|
||||
from fastapi import FastAPI
|
||||
from fastapi.responses import ORJSONResponse
|
||||
from fastapi.testclient import TestClient
|
||||
from sqlalchemy.sql.elements import quoted_name
|
||||
|
||||
app = FastAPI(default_response_class=ORJSONResponse)
|
||||
|
||||
|
||||
@app.get("/orjson_non_str_keys")
|
||||
def get_orjson_non_str_keys():
|
||||
key = quoted_name(value="msg", quote=False)
|
||||
return {key: "Hello World", 1: 1}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_orjson_non_str_keys():
|
||||
with client:
|
||||
response = client.get("/orjson_non_str_keys")
|
||||
assert response.json() == {"msg": "Hello World", "1": 1}
|
||||
@@ -0,0 +1,27 @@
|
||||
from typing import Optional
|
||||
|
||||
from fastapi import FastAPI
|
||||
from fastapi.params import Param
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.get("/items/")
|
||||
def read_items(q: Optional[str] = Param(default=None)): # type: ignore
|
||||
return {"q": q}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_default_param_query_none():
|
||||
response = client.get("/items/")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"q": None}
|
||||
|
||||
|
||||
def test_default_param_query():
|
||||
response = client.get("/items/?q=foo")
|
||||
assert response.status_code == 200, response.text
|
||||
assert response.json() == {"q": "foo"}
|
||||
@@ -0,0 +1,93 @@
|
||||
from fastapi import Depends, FastAPI
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
async def user_exists(user_id: int):
|
||||
return True
|
||||
|
||||
|
||||
@app.get("/users/{user_id}", dependencies=[Depends(user_exists)])
|
||||
async def read_users(user_id: int):
|
||||
pass
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_read_users():
|
||||
response = client.get("/users/42")
|
||||
assert response.status_code == 200, response.text
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
response = client.get("/openapi.json")
|
||||
data = response.json()
|
||||
assert data == {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/users/{user_id}": {
|
||||
"get": {
|
||||
"summary": "Read Users",
|
||||
"operationId": "read_users_users__user_id__get",
|
||||
"parameters": [
|
||||
{
|
||||
"required": True,
|
||||
"schema": {"title": "User Id", "type": "integer"},
|
||||
"name": "user_id",
|
||||
"in": "path",
|
||||
},
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"HTTPValidationError": {
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
}
|
||||
},
|
||||
},
|
||||
"ValidationError": {
|
||||
"title": "ValidationError",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"loc": {
|
||||
"title": "Location",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}]
|
||||
},
|
||||
},
|
||||
"msg": {"title": "Message", "type": "string"},
|
||||
"type": {"title": "Error Type", "type": "string"},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,242 @@
|
||||
from typing import Optional
|
||||
|
||||
import pytest
|
||||
from fastapi import Cookie, FastAPI, Header, Path, Query
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.get("/hidden_cookie")
|
||||
async def hidden_cookie(
|
||||
hidden_cookie: Optional[str] = Cookie(default=None, include_in_schema=False),
|
||||
):
|
||||
return {"hidden_cookie": hidden_cookie}
|
||||
|
||||
|
||||
@app.get("/hidden_header")
|
||||
async def hidden_header(
|
||||
hidden_header: Optional[str] = Header(default=None, include_in_schema=False),
|
||||
):
|
||||
return {"hidden_header": hidden_header}
|
||||
|
||||
|
||||
@app.get("/hidden_path/{hidden_path}")
|
||||
async def hidden_path(hidden_path: str = Path(include_in_schema=False)):
|
||||
return {"hidden_path": hidden_path}
|
||||
|
||||
|
||||
@app.get("/hidden_query")
|
||||
async def hidden_query(
|
||||
hidden_query: Optional[str] = Query(default=None, include_in_schema=False),
|
||||
):
|
||||
return {"hidden_query": hidden_query}
|
||||
|
||||
|
||||
openapi_schema = {
|
||||
"openapi": "3.1.0",
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"},
|
||||
"paths": {
|
||||
"/hidden_cookie": {
|
||||
"get": {
|
||||
"summary": "Hidden Cookie",
|
||||
"operationId": "hidden_cookie_hidden_cookie_get",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/hidden_header": {
|
||||
"get": {
|
||||
"summary": "Hidden Header",
|
||||
"operationId": "hidden_header_hidden_header_get",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/hidden_path/{hidden_path}": {
|
||||
"get": {
|
||||
"summary": "Hidden Path",
|
||||
"operationId": "hidden_path_hidden_path__hidden_path__get",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
"/hidden_query": {
|
||||
"get": {
|
||||
"summary": "Hidden Query",
|
||||
"operationId": "hidden_query_hidden_query_get",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {"application/json": {"schema": {}}},
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"HTTPValidationError": {
|
||||
"title": "HTTPValidationError",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"title": "Detail",
|
||||
"type": "array",
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"},
|
||||
}
|
||||
},
|
||||
},
|
||||
"ValidationError": {
|
||||
"title": "ValidationError",
|
||||
"required": ["loc", "msg", "type"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"loc": {
|
||||
"title": "Location",
|
||||
"type": "array",
|
||||
"items": {"anyOf": [{"type": "string"}, {"type": "integer"}]},
|
||||
},
|
||||
"msg": {"title": "Message", "type": "string"},
|
||||
"type": {"title": "Error Type", "type": "string"},
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
def test_openapi_schema():
|
||||
client = TestClient(app)
|
||||
response = client.get("/openapi.json")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == openapi_schema
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"path,cookies,expected_status,expected_response",
|
||||
[
|
||||
(
|
||||
"/hidden_cookie",
|
||||
{},
|
||||
200,
|
||||
{"hidden_cookie": None},
|
||||
),
|
||||
(
|
||||
"/hidden_cookie",
|
||||
{"hidden_cookie": "somevalue"},
|
||||
200,
|
||||
{"hidden_cookie": "somevalue"},
|
||||
),
|
||||
],
|
||||
)
|
||||
def test_hidden_cookie(path, cookies, expected_status, expected_response):
|
||||
client = TestClient(app, cookies=cookies)
|
||||
response = client.get(path)
|
||||
assert response.status_code == expected_status
|
||||
assert response.json() == expected_response
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"path,headers,expected_status,expected_response",
|
||||
[
|
||||
(
|
||||
"/hidden_header",
|
||||
{},
|
||||
200,
|
||||
{"hidden_header": None},
|
||||
),
|
||||
(
|
||||
"/hidden_header",
|
||||
{"Hidden-Header": "somevalue"},
|
||||
200,
|
||||
{"hidden_header": "somevalue"},
|
||||
),
|
||||
],
|
||||
)
|
||||
def test_hidden_header(path, headers, expected_status, expected_response):
|
||||
client = TestClient(app)
|
||||
response = client.get(path, headers=headers)
|
||||
assert response.status_code == expected_status
|
||||
assert response.json() == expected_response
|
||||
|
||||
|
||||
def test_hidden_path():
|
||||
client = TestClient(app)
|
||||
response = client.get("/hidden_path/hidden_path")
|
||||
assert response.status_code == 200
|
||||
assert response.json() == {"hidden_path": "hidden_path"}
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"path,expected_status,expected_response",
|
||||
[
|
||||
(
|
||||
"/hidden_query",
|
||||
200,
|
||||
{"hidden_query": None},
|
||||
),
|
||||
(
|
||||
"/hidden_query?hidden_query=somevalue",
|
||||
200,
|
||||
{"hidden_query": "somevalue"},
|
||||
),
|
||||
],
|
||||
)
|
||||
def test_hidden_query(path, expected_status, expected_response):
|
||||
client = TestClient(app)
|
||||
response = client.get(path)
|
||||
assert response.status_code == expected_status
|
||||
assert response.json() == expected_response
|
||||
@@ -0,0 +1,143 @@
|
||||
from typing import Any, List
|
||||
|
||||
from dirty_equals import IsOneOf
|
||||
from fastapi.params import Body, Cookie, Header, Param, Path, Query
|
||||
|
||||
test_data: List[Any] = ["teststr", None, ..., 1, []]
|
||||
|
||||
|
||||
def get_user():
|
||||
return {} # pragma: no cover
|
||||
|
||||
|
||||
def test_param_repr_str():
|
||||
assert repr(Param("teststr")) == "Param(teststr)"
|
||||
|
||||
|
||||
def test_param_repr_none():
|
||||
assert repr(Param(None)) == "Param(None)"
|
||||
|
||||
|
||||
def test_param_repr_ellipsis():
|
||||
assert repr(Param(...)) == IsOneOf(
|
||||
"Param(PydanticUndefined)",
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
"Param(Ellipsis)",
|
||||
)
|
||||
|
||||
|
||||
def test_param_repr_number():
|
||||
assert repr(Param(1)) == "Param(1)"
|
||||
|
||||
|
||||
def test_param_repr_list():
|
||||
assert repr(Param([])) == "Param([])"
|
||||
|
||||
|
||||
def test_path_repr():
|
||||
assert repr(Path()) == IsOneOf(
|
||||
"Path(PydanticUndefined)",
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
"Path(Ellipsis)",
|
||||
)
|
||||
assert repr(Path(...)) == IsOneOf(
|
||||
"Path(PydanticUndefined)",
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
"Path(Ellipsis)",
|
||||
)
|
||||
|
||||
|
||||
def test_query_repr_str():
|
||||
assert repr(Query("teststr")) == "Query(teststr)"
|
||||
|
||||
|
||||
def test_query_repr_none():
|
||||
assert repr(Query(None)) == "Query(None)"
|
||||
|
||||
|
||||
def test_query_repr_ellipsis():
|
||||
assert repr(Query(...)) == IsOneOf(
|
||||
"Query(PydanticUndefined)",
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
"Query(Ellipsis)",
|
||||
)
|
||||
|
||||
|
||||
def test_query_repr_number():
|
||||
assert repr(Query(1)) == "Query(1)"
|
||||
|
||||
|
||||
def test_query_repr_list():
|
||||
assert repr(Query([])) == "Query([])"
|
||||
|
||||
|
||||
def test_header_repr_str():
|
||||
assert repr(Header("teststr")) == "Header(teststr)"
|
||||
|
||||
|
||||
def test_header_repr_none():
|
||||
assert repr(Header(None)) == "Header(None)"
|
||||
|
||||
|
||||
def test_header_repr_ellipsis():
|
||||
assert repr(Header(...)) == IsOneOf(
|
||||
"Header(PydanticUndefined)",
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
"Header(Ellipsis)",
|
||||
)
|
||||
|
||||
|
||||
def test_header_repr_number():
|
||||
assert repr(Header(1)) == "Header(1)"
|
||||
|
||||
|
||||
def test_header_repr_list():
|
||||
assert repr(Header([])) == "Header([])"
|
||||
|
||||
|
||||
def test_cookie_repr_str():
|
||||
assert repr(Cookie("teststr")) == "Cookie(teststr)"
|
||||
|
||||
|
||||
def test_cookie_repr_none():
|
||||
assert repr(Cookie(None)) == "Cookie(None)"
|
||||
|
||||
|
||||
def test_cookie_repr_ellipsis():
|
||||
assert repr(Cookie(...)) == IsOneOf(
|
||||
"Cookie(PydanticUndefined)",
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
"Cookie(Ellipsis)",
|
||||
)
|
||||
|
||||
|
||||
def test_cookie_repr_number():
|
||||
assert repr(Cookie(1)) == "Cookie(1)"
|
||||
|
||||
|
||||
def test_cookie_repr_list():
|
||||
assert repr(Cookie([])) == "Cookie([])"
|
||||
|
||||
|
||||
def test_body_repr_str():
|
||||
assert repr(Body("teststr")) == "Body(teststr)"
|
||||
|
||||
|
||||
def test_body_repr_none():
|
||||
assert repr(Body(None)) == "Body(None)"
|
||||
|
||||
|
||||
def test_body_repr_ellipsis():
|
||||
assert repr(Body(...)) == IsOneOf(
|
||||
"Body(PydanticUndefined)",
|
||||
# TODO: remove when deprecating Pydantic v1
|
||||
"Body(Ellipsis)",
|
||||
)
|
||||
|
||||
|
||||
def test_body_repr_number():
|
||||
assert repr(Body(1)) == "Body(1)"
|
||||
|
||||
|
||||
def test_body_repr_list():
|
||||
assert repr(Body([])) == "Body([])"
|
||||
+1242
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user