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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
from datetime import date, datetime
from typing import Any, Dict, List, Optional, Type, Union
import pytest
from litestar import Controller, MediaType, delete, get, patch, post, put
from litestar.datastructures import ResponseHeader, State
from litestar.dto import DataclassDTO, DTOConfig, DTOData
from litestar.openapi.controller import OpenAPIController
from litestar.openapi.spec.example import Example
from litestar.params import Parameter
from tests.models import DataclassPerson, DataclassPersonFactory, DataclassPet
from tests.unit.test_openapi.utils import Gender, LuckyNumber, PetException
class PartialDataclassPersonDTO(DataclassDTO[DataclassPerson]):
config = DTOConfig(partial=True)
def create_person_controller() -> Type[Controller]:
class PersonController(Controller):
path = "/{service_id:int}/person"
@get(sync_to_thread=False)
def get_persons(
self,
# expected to be ignored
headers: Any,
request: Any,
state: State,
query: Dict[str, Any],
cookies: Dict[str, Any],
# path parameter
service_id: int,
# required query parameters below
page: int,
name: Optional[Union[str, List[str]]], # intentionally without default
page_size: int = Parameter(
query="pageSize",
description="Page Size Description",
title="Page Size Title",
examples=[Example(description="example value", value=1)],
),
# non-required query parameters below
from_date: Optional[Union[int, datetime, date]] = None,
to_date: Optional[Union[int, datetime, date]] = None,
gender: Optional[Union[Gender, List[Gender]]] = Parameter(
examples=[Example(value=Gender.MALE), Example(value=[Gender.MALE, Gender.OTHER])]
),
lucky_number: Optional[LuckyNumber] = Parameter(examples=[Example(value=LuckyNumber.SEVEN)]),
# header parameter
secret_header: str = Parameter(header="secret"),
# cookie parameter
cookie_value: int = Parameter(cookie="value"),
) -> List[DataclassPerson]:
return []
@post(media_type=MediaType.TEXT, sync_to_thread=False)
def create_person(
self, data: DataclassPerson, secret_header: str = Parameter(header="secret")
) -> DataclassPerson:
return data
@post(path="/bulk", dto=PartialDataclassPersonDTO, sync_to_thread=False)
def bulk_create_person(
self, data: DTOData[List[DataclassPerson]], secret_header: str = Parameter(header="secret")
) -> List[DataclassPerson]:
return []
@put(path="/bulk", sync_to_thread=False)
def bulk_update_person(
self, data: List[DataclassPerson], secret_header: str = Parameter(header="secret")
) -> List[DataclassPerson]:
return []
@patch(path="/bulk", dto=PartialDataclassPersonDTO, sync_to_thread=False)
def bulk_partial_update_person(
self, data: DTOData[List[DataclassPerson]], secret_header: str = Parameter(header="secret")
) -> List[DataclassPerson]:
return []
@get(path="/{person_id:str}", sync_to_thread=False)
def get_person_by_id(self, person_id: str) -> DataclassPerson:
"""Description in docstring."""
return DataclassPersonFactory.build(id=person_id)
@patch(
path="/{person_id:str}",
description="Description in decorator",
dto=PartialDataclassPersonDTO,
sync_to_thread=False,
)
def partial_update_person(self, person_id: str, data: DTOData[DataclassPerson]) -> DataclassPerson:
"""Description in docstring."""
return DataclassPersonFactory.build(id=person_id)
@put(path="/{person_id:str}", sync_to_thread=False)
def update_person(self, person_id: str, data: DataclassPerson) -> DataclassPerson:
"""Multiline docstring example.
Line 3.
"""
return data
@delete(path="/{person_id:str}", sync_to_thread=False)
def delete_person(self, person_id: str) -> None:
return None
@get(path="/dataclass", sync_to_thread=False)
def get_person_dataclass(self) -> DataclassPerson:
return DataclassPerson(
first_name="Moishe", last_name="zuchmir", id="1", optional=None, complex={}, pets=None
)
return PersonController
def create_pet_controller() -> Type[Controller]:
class PetController(Controller):
path = "/pet"
@get(sync_to_thread=False)
def pets(self) -> List[DataclassPet]:
return []
@get(
path="/owner-or-pet",
response_headers=[ResponseHeader(name="x-my-tag", value="123")],
raises=[PetException],
sync_to_thread=False,
)
def get_pets_or_owners(self) -> List[Union[DataclassPerson, DataclassPet]]:
return []
return PetController
@pytest.fixture
def person_controller(disable_warn_implicit_sync_to_thread: None) -> Type[Controller]:
"""Fixture without a top-level mark."""
return create_person_controller()
@pytest.fixture
def pet_controller(disable_warn_implicit_sync_to_thread: None) -> Type[Controller]:
"""Fixture without a top-level mark."""
return create_pet_controller()
@pytest.fixture(params=[OpenAPIController, None])
def openapi_controller(request: pytest.FixtureRequest) -> Optional[Type[OpenAPIController]]:
return request.param # type: ignore[no-any-return]
|
