1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
|
from typing import List, Optional
import pytest
from ninja import NinjaAPI, Schema
from ninja.patch_dict import PatchDict
from ninja.testing import TestClient
api = NinjaAPI()
client = TestClient(api)
class SomeSchema(Schema):
name: str
age: int
category: Optional[str] = None
class OtherSchema(SomeSchema):
other: str
category: Optional[List[str]] = None
@api.patch("/patch")
def patch(request, payload: PatchDict[SomeSchema]):
return {"payload": payload, "type": str(type(payload))}
@api.patch("/patch-inherited")
def patch_inherited(request, payload: PatchDict[OtherSchema]):
return {"payload": payload, "type": str(type(payload))}
@pytest.mark.parametrize(
"input,output",
[
({"name": "foo"}, {"name": "foo"}),
({"age": "1"}, {"age": 1}),
({}, {}),
({"wrong_param": 1}, {}),
({"age": None}, {"age": None}),
],
)
def test_patch_calls(input: dict, output: dict):
response = client.patch("/patch", json=input)
assert response.json() == {"payload": output, "type": "<class 'dict'>"}
def test_schema():
"Checking that json schema properties are all optional"
schema = api.get_openapi_schema()
assert schema["components"]["schemas"]["SomeSchemaPatch"] == {
"title": "SomeSchemaPatch",
"type": "object",
"properties": {
"name": {
"anyOf": [{"type": "string"}, {"type": "null"}],
"title": "Name",
},
"age": {
"anyOf": [{"type": "integer"}, {"type": "null"}],
"title": "Age",
},
"category": {
"anyOf": [{"type": "string"}, {"type": "null"}],
"title": "Category",
},
},
}
def test_patch_inherited():
input = {"other": "any", "category": ["cat1", "cat2"]}
expected_output = {"payload": input, "type": "<class 'dict'>"}
response = client.patch("/patch-inherited", json=input)
assert response.json() == expected_output
def test_inherited_schema():
"Checking that json schema properties for inherithed schemas are ok"
schema = api.get_openapi_schema()
assert schema["components"]["schemas"]["OtherSchemaPatch"] == {
"title": "OtherSchemaPatch",
"type": "object",
"properties": {
"name": {
"anyOf": [{"type": "string"}, {"type": "null"}],
"title": "Name",
},
"age": {
"anyOf": [{"type": "integer"}, {"type": "null"}],
"title": "Age",
},
"other": {
"anyOf": [{"type": "string"}, {"type": "null"}],
"title": "Other",
},
"category": {
"anyOf": [
{
"items": {
"type": "string",
},
"type": "array",
},
{"type": "null"},
],
"title": "Category",
},
},
}
|