-
-
Notifications
You must be signed in to change notification settings - Fork 168
/
Copy path_base.py
209 lines (177 loc) · 7.13 KB
/
_base.py
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
from typing import Any, Callable, Generic, List, Optional, Type, Union
from fastapi import APIRouter, HTTPException
from fastapi.types import DecoratedCallable
from ._types import T, DEPENDENCIES
from ._utils import pagination_factory, schema_factory
NOT_FOUND = HTTPException(404, "Item not found")
class CRUDGenerator(Generic[T], APIRouter):
schema: Type[T]
create_schema: Type[T]
update_schema: Type[T]
_base_path: str = "/"
def __init__(
self,
schema: Type[T],
create_schema: Optional[Type[T]] = None,
update_schema: Optional[Type[T]] = None,
prefix: Optional[str] = None,
tags: Optional[List[str]] = None,
paginate: Optional[int] = None,
get_all_route: Union[bool, DEPENDENCIES] = True,
get_one_route: Union[bool, DEPENDENCIES] = True,
create_route: Union[bool, DEPENDENCIES] = True,
update_route: Union[bool, DEPENDENCIES] = True,
delete_one_route: Union[bool, DEPENDENCIES] = True,
delete_all_route: Union[bool, DEPENDENCIES] = True,
**kwargs: Any,
) -> None:
self.schema = schema
self.pagination = pagination_factory(max_limit=paginate)
self._pk: str = self._pk if hasattr(self, "_pk") else "id"
self.create_schema = (
create_schema
if create_schema
else schema_factory(self.schema, pk_field_name=self._pk, name="Create")
)
self.update_schema = (
update_schema
if update_schema
else schema_factory(self.schema, pk_field_name=self._pk, name="Update")
)
prefix = str(prefix if prefix else self.schema.__name__).lower()
item_name = self.schema.__name__.lower()
prefix = self._base_path + prefix.strip("/")
tags = tags or [prefix.strip("/").capitalize()]
super().__init__(prefix=prefix, tags=tags, **kwargs)
if get_all_route:
self._add_api_route(
"",
self._get_all(),
methods=["GET"],
response_model=Optional[List[self.schema]], # type: ignore
summary="Get All",
dependencies=get_all_route,
name=f"get_all_{item_name}",
)
if create_route:
self._add_api_route(
"",
self._create(),
methods=["POST"],
response_model=self.schema,
summary="Create One",
dependencies=create_route,
name=f"create_one_{item_name}",
)
if delete_all_route:
self._add_api_route(
"",
self._delete_all(),
methods=["DELETE"],
response_model=Optional[List[self.schema]], # type: ignore
summary="Delete All",
dependencies=delete_all_route,
name=f"delete_all_{item_name}",
)
if get_one_route:
self._add_api_route(
"/{item_id}",
self._get_one(),
methods=["GET"],
response_model=self.schema,
summary="Get One",
dependencies=get_one_route,
error_responses=[NOT_FOUND],
name=f"get_one_{item_name}",
)
if update_route:
self._add_api_route(
"/{item_id}",
self._update(),
methods=["PUT"],
response_model=self.schema,
summary="Update One",
dependencies=update_route,
error_responses=[NOT_FOUND],
name=f"update_one_{item_name}",
)
if delete_one_route:
self._add_api_route(
"/{item_id}",
self._delete_one(),
methods=["DELETE"],
response_model=self.schema,
summary="Delete One",
dependencies=delete_one_route,
error_responses=[NOT_FOUND],
name=f"delete_one_{item_name}",
)
def _add_api_route(
self,
path: str,
endpoint: Callable[..., Any],
dependencies: Union[bool, DEPENDENCIES],
error_responses: Optional[List[HTTPException]] = None,
**kwargs: Any,
) -> None:
dependencies = [] if isinstance(dependencies, bool) else dependencies
responses: Any = (
{err.status_code: {"detail": err.detail} for err in error_responses}
if error_responses
else None
)
super().add_api_route(
path, endpoint, dependencies=dependencies, responses=responses, **kwargs
)
def api_route(
self, path: str, *args: Any, **kwargs: Any
) -> Callable[[DecoratedCallable], DecoratedCallable]:
"""Overrides and exiting route if it exists"""
methods = kwargs["methods"] if "methods" in kwargs else ["GET"]
self.remove_api_route(path, methods)
return super().api_route(path, *args, **kwargs)
def get(
self, path: str, *args: Any, **kwargs: Any
) -> Callable[[DecoratedCallable], DecoratedCallable]:
self.remove_api_route(path, ["Get"])
return super().get(path, *args, **kwargs)
def post(
self, path: str, *args: Any, **kwargs: Any
) -> Callable[[DecoratedCallable], DecoratedCallable]:
self.remove_api_route(path, ["POST"])
return super().post(path, *args, **kwargs)
def put(
self, path: str, *args: Any, **kwargs: Any
) -> Callable[[DecoratedCallable], DecoratedCallable]:
self.remove_api_route(path, ["PUT"])
return super().put(path, *args, **kwargs)
def delete(
self, path: str, *args: Any, **kwargs: Any
) -> Callable[[DecoratedCallable], DecoratedCallable]:
self.remove_api_route(path, ["DELETE"])
return super().delete(path, *args, **kwargs)
def remove_api_route(self, path: str, methods: List[str]) -> None:
methods_ = set(methods)
for route in self.routes:
if (
route.path == f"{self.prefix}{path}" # type: ignore
and route.methods == methods_ # type: ignore
):
self.routes.remove(route)
def _get_all(self, *args: Any, **kwargs: Any) -> Callable[..., Any]:
raise NotImplementedError
def _get_one(self, *args: Any, **kwargs: Any) -> Callable[..., Any]:
raise NotImplementedError
def _create(self, *args: Any, **kwargs: Any) -> Callable[..., Any]:
raise NotImplementedError
def _update(self, *args: Any, **kwargs: Any) -> Callable[..., Any]:
raise NotImplementedError
def _delete_one(self, *args: Any, **kwargs: Any) -> Callable[..., Any]:
raise NotImplementedError
def _delete_all(self, *args: Any, **kwargs: Any) -> Callable[..., Any]:
raise NotImplementedError
def _raise(self, e: Exception, status_code: int = 422) -> HTTPException:
raise HTTPException(422, ", ".join(e.args)) from e
@staticmethod
def get_routes() -> List[str]:
return ["get_all", "create", "delete_all", "get_one", "update", "delete_one"]