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
|
from typing import Annotated, Any, Optional, Union
from uuid import UUID
import uvicorn
from litestar import Controller, Litestar, delete, get, patch, post
from litestar.datastructures import UploadFile
from litestar.enums import RequestEncodingType
from litestar.params import Body, Dependency
from pydantic import BaseModel, Field, computed_field
from sqlalchemy.orm import Mapped, mapped_column
from advanced_alchemy.extensions.litestar import (
AsyncSessionConfig,
SQLAlchemyAsyncConfig,
SQLAlchemyPlugin,
base,
filters,
providers,
repository,
service,
)
from advanced_alchemy.types import FileObject, storages
from advanced_alchemy.types.file_object.backends.obstore import ObstoreBackend
from advanced_alchemy.types.file_object.data_type import StoredObject
# Object storage backend
s3_backend = ObstoreBackend(
key="local",
fs="s3://static-files/",
aws_endpoint="http://localhost:9000",
aws_access_key_id="minioadmin",
aws_secret_access_key="minioadmin", # noqa: S106
)
storages.register_backend(s3_backend)
# SQLAlchemy Model
class DocumentModel(base.UUIDBase):
__tablename__ = "document"
name: Mapped[str]
file: Mapped[FileObject] = mapped_column(StoredObject(backend="local"))
# Pydantic Schema
class Document(BaseModel):
id: Optional[UUID]
name: str
file: Optional[FileObject] = Field(default=None, exclude=True)
@computed_field
def file_url(self) -> Optional[Union[str, list[str]]]:
if self.file is None:
return None
return self.file.sign()
class CreateDocument(BaseModel):
model_config = {"arbitrary_types_allowed": True}
name: str
file: Optional[UploadFile] = None
class PatchDocument(BaseModel):
model_config = {"arbitrary_types_allowed": True}
name: Optional[str] = None
file: Optional[UploadFile] = None
# Advanced Alchemy Service
class DocumentService(service.SQLAlchemyAsyncRepositoryService[DocumentModel]):
"""Document repository."""
class Repo(repository.SQLAlchemyAsyncRepository[DocumentModel]):
"""Document repository."""
model_type = DocumentModel
repository_type = Repo
# Litestar Controller
class DocumentController(Controller):
path = "/documents"
dependencies = providers.create_service_dependencies(
DocumentService,
"documents_service",
load=[DocumentModel.file],
filters={"pagination_type": "limit_offset", "id_filter": UUID, "search": "name", "search_ignore_case": True},
)
@get(path="/", response_model=service.OffsetPagination[Document])
async def list_documents(
self,
documents_service: DocumentService,
filters: Annotated[list[filters.FilterTypes], Dependency(skip_validation=True)],
) -> service.OffsetPagination[Document]:
results, total = await documents_service.list_and_count(*filters)
return documents_service.to_schema(results, total, filters=filters, schema_type=Document)
@post(path="/")
async def create_document(
self,
data: Annotated[CreateDocument, Body(media_type=RequestEncodingType.MULTI_PART)],
documents_service: DocumentService,
) -> Document:
obj = await documents_service.create(
DocumentModel(
name=data.name,
file=FileObject(
backend="local",
filename=data.file.filename or "uploaded_file",
content_type=data.file.content_type,
content=await data.file.read(),
)
if data.file
else None,
)
)
return documents_service.to_schema(obj, schema_type=Document)
@get(path="/{document_id:uuid}")
async def get_document(
self,
documents_service: DocumentService,
document_id: UUID,
) -> Document:
obj = await documents_service.get(document_id)
return documents_service.to_schema(obj, schema_type=Document)
@patch(path="/{document_id:uuid}")
async def update_document(
self,
document_id: UUID,
data: Annotated[PatchDocument, Body(media_type=RequestEncodingType.MULTI_PART)],
documents_service: DocumentService,
) -> Document:
update_data: dict[str, Any] = {}
if data.name:
update_data["name"] = data.name
if data.file:
update_data["file"] = FileObject(
backend="local",
filename=data.file.filename or "uploaded_file",
content_type=data.file.content_type,
content=await data.file.read(),
)
obj = await documents_service.update(update_data, item_id=document_id)
return documents_service.to_schema(obj, schema_type=Document)
@delete(path="/{document_id:uuid}")
async def delete_document(
self,
documents_service: DocumentService,
document_id: UUID,
) -> None:
_ = await documents_service.delete(document_id)
alchemy_config = SQLAlchemyAsyncConfig(
connection_string="sqlite+aiosqlite:///test.sqlite",
session_config=AsyncSessionConfig(expire_on_commit=False),
before_send_handler="autocommit",
create_all=True,
)
app = Litestar(route_handlers=[DocumentController], plugins=[SQLAlchemyPlugin(config=alchemy_config)])
if __name__ == "__main__":
uvicorn.run(app, host="0.0.0.0", port=8000) # noqa: S104
|
