kiba-core 0.5.3.dev86__tar.gz → 0.5.3.dev87__tar.gz

{kiba_core-0.5.3.dev86 → kiba_core-0.5.3.dev87}/CHANGELOG.md

@@ -8,6 +8,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ## [Unreleased]
 
 ### Added
+- [MINOR] Updated `json_route` and `streaming_json_route` (and so `route`) to accept `multipart/form-data` bodies: form fields are used like JSON body fields and uploaded files are passed as `core.api.uploaded_file.UploadedFile` (`filename`, `contentType`, `content`), so request models can declare `file: UploadedFile`. A field given more than once raises `BadRequestException`. The `core-api` extra now installs `python-multipart`
 - [MAJOR] Added abstract `MessageQueue.release_message` to hand a claimed message back to be claimed again straight away without using an attempt (`SqlMessageQueue` and `CosmosMessageQueue` keep `postCount`; `SqsMessageQueue` and `AqsMessageQueue` make the message visible again, though SQS still counts the next receive towards its redrive policy)
 - [MAJOR] Added abstract `MessageQueue.delete_expired_messages`: `SqlMessageQueue` deletes `succeeded` and `deduplicated` messages older than `retentionSeconds` (the other queues remove messages on completion and return 0). `SqlMessageQueue.get_message_count` no longer deletes them and its `shouldSkipRemovingNonRetained` parameter is removed
 - [MINOR] Updated `MessageQueueProcessor` to shut down gracefully: `run`/`run_batches` handle SIGTERM and SIGINT (a second signal falls back to the default handler), as does `request_shutdown()`, by finishing the message being processed, releasing claimed messages not yet started and stopping instead of sleeping. A processed message whose task is cancelled is released rather than left until its lease expires

{kiba_core-0.5.3.dev86 → kiba_core-0.5.3.dev87}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kiba-core
-Version: 0.5.3.dev86
+Version: 0.5.3.dev87
 Summary: Kiba Labs' python utilities
 Project-URL: repository, https://github.com/kibalabs/core-py
 Requires-Python: <4,>=3.12
@@ -14,6 +14,7 @@ Requires-Dist: uvicorn[standard]>=0.54.0; extra == "api"
 Provides-Extra: core-api
 Requires-Dist: starlette>=1.7.0; extra == "core-api"
 Requires-Dist: uvicorn[standard]>=0.54.0; extra == "core-api"
+Requires-Dist: python-multipart>=0.0.29; extra == "core-api"
 Provides-Extra: storage
 Requires-Dist: aiobotocore>=3.9.2; extra == "storage"
 Provides-Extra: queues

{kiba_core-0.5.3.dev86 → kiba_core-0.5.3.dev87}/core/api/json_route.py

@@ -7,10 +7,9 @@ from starlette.requests import Request
 
 from core.api.api_request import KibaApiRequest
 from core.api.api_response import KibaJSONResponse
+from core.api.request_body import read_request_body
 from core.exceptions import BadRequestException
 from core.exceptions import InternalServerErrorException
-from core.util import json_util
-from core.util.typing_util import JsonObject
 
 
 def json_route[ApiRequest: BaseModel, ApiResponse: BaseModel](
@@ -22,16 +21,7 @@ def json_route[ApiRequest: BaseModel, ApiResponse: BaseModel](
         async def async_wrapper(receivedRequest: Request) -> KibaJSONResponse:
             pathParams = receivedRequest.path_params
             queryParams = receivedRequest.query_params
-            bodyBytes = await receivedRequest.body()
-            if len(bodyBytes) == 0:
-                body: JsonObject = {}
-            else:
-                try:
-                    body = typing.cast(JsonObject, json_util.loads(bodyBytes.decode()))
-                except json_util.JsonDecodeException as exception:
-                    raise BadRequestException(f'Invalid JSON body: {exception}')
-                if not isinstance(body, dict):
-                    raise BadRequestException('Invalid JSON body: expected an object')
+            body = await read_request_body(request=receivedRequest)
             allParams = {**pathParams, **body, **queryParams}
             try:
                 requestParams = requestType(**allParams)

kiba_core-0.5.3.dev87/core/api/request_body.py

@@ -0,0 +1,31 @@
+import typing
+from collections.abc import Mapping
+
+from starlette.datastructures import UploadFile
+from starlette.requests import Request
+
+from core.api.uploaded_file import UploadedFile
+from core.exceptions import BadRequestException
+from core.util import json_util
+from core.util.typing_util import JsonObject
+
+
+async def read_request_body(request: Request) -> Mapping[str, object]:
+    if request.headers.get('Content-Type', '').startswith('multipart/form-data'):
+        form = await request.form()
+        body: dict[str, object] = {}
+        for key, value in form.multi_items():
+            if key in body:
+                raise BadRequestException(f'Invalid form body: {key} is given more than once')
+            body[key] = UploadedFile(filename=value.filename, contentType=value.content_type, content=await value.read()) if isinstance(value, UploadFile) else value
+        return body
+    bodyBytes = await request.body()
+    if len(bodyBytes) == 0:
+        return {}
+    try:
+        jsonBody = typing.cast(JsonObject, json_util.loads(bodyBytes.decode()))
+    except json_util.JsonDecodeException as exception:
+        raise BadRequestException(f'Invalid JSON body: {exception}')
+    if not isinstance(jsonBody, dict):
+        raise BadRequestException('Invalid JSON body: expected an object')
+    return jsonBody

{kiba_core-0.5.3.dev86 → kiba_core-0.5.3.dev87}/core/api/streaming_json_route.py

@@ -9,10 +9,10 @@ from starlette.requests import Request
 from starlette.responses import StreamingResponse
 
 from core.api.api_request import KibaApiRequest
+from core.api.request_body import read_request_body
 from core.exceptions import BadRequestException
 from core.exceptions import InternalServerErrorException
 from core.util import json_util
-from core.util.typing_util import JsonObject
 
 
 async def _convert_to_json_generator[T: BaseModel](response_iterator: AsyncIterator[T], expectedType: typing.Type[T]) -> AsyncIterator[bytes]:
@@ -31,16 +31,7 @@ def streaming_json_route[ApiRequest: BaseModel, ApiResponse: BaseModel](
         async def async_wrapper(receivedRequest: Request) -> StreamingResponse:
             pathParams = receivedRequest.path_params
             queryParams = receivedRequest.query_params
-            bodyBytes = await receivedRequest.body()
-            if len(bodyBytes) == 0:
-                body: JsonObject = {}
-            else:
-                try:
-                    body = typing.cast(JsonObject, json_util.loads(bodyBytes.decode()))
-                except json_util.JsonDecodeException as exception:
-                    raise BadRequestException(f'Invalid JSON body: {exception}')
-                if not isinstance(body, dict):
-                    raise BadRequestException('Invalid JSON body: expected an object')
+            body = await read_request_body(request=receivedRequest)
             allParams = {**pathParams, **body, **queryParams}
             try:
                 requestParams = requestType(**allParams)

kiba_core-0.5.3.dev87/core/api/uploaded_file.py

@@ -0,0 +1,7 @@
+from pydantic import BaseModel
+
+
+class UploadedFile(BaseModel):
+    filename: str | None
+    contentType: str | None
+    content: bytes

{kiba_core-0.5.3.dev86 → kiba_core-0.5.3.dev87}/kiba_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kiba-core
-Version: 0.5.3.dev86
+Version: 0.5.3.dev87
 Summary: Kiba Labs' python utilities
 Project-URL: repository, https://github.com/kibalabs/core-py
 Requires-Python: <4,>=3.12
@@ -14,6 +14,7 @@ Requires-Dist: uvicorn[standard]>=0.54.0; extra == "api"
 Provides-Extra: core-api
 Requires-Dist: starlette>=1.7.0; extra == "core-api"
 Requires-Dist: uvicorn[standard]>=0.54.0; extra == "core-api"
+Requires-Dist: python-multipart>=0.0.29; extra == "core-api"
 Provides-Extra: storage
 Requires-Dist: aiobotocore>=3.9.2; extra == "storage"
 Provides-Extra: queues

{kiba_core-0.5.3.dev86 → kiba_core-0.5.3.dev87}/kiba_core.egg-info/SOURCES.txt

@@ -26,11 +26,13 @@ core/api/health.py
 core/api/json_route.py
 core/api/openapi.py
 core/api/rate_limit.py
+core/api/request_body.py
 core/api/request_context.py
 core/api/route.py
 core/api/route_auth.py
 core/api/route_metadata.py
 core/api/streaming_json_route.py
+core/api/uploaded_file.py
 core/api/middleware/__init__.py
 core/api/middleware/database_connection_middleware.py
 core/api/middleware/exception_handling_middleware.py

{kiba_core-0.5.3.dev86 → kiba_core-0.5.3.dev87}/kiba_core.egg-info/requires.txt

@@ -9,6 +9,7 @@ uvicorn[standard]>=0.54.0
 [core-api]
 starlette>=1.7.0
 uvicorn[standard]>=0.54.0
+python-multipart>=0.0.29
 
 [cron]
 apscheduler<4,>=3.11.3

{kiba_core-0.5.3.dev86 → kiba_core-0.5.3.dev87}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "kiba-core"
-version = "0.5.3.dev86"
+version = "0.5.3.dev87"
 description = "Kiba Labs' python utilities"
 readme = "README.md"
 requires-python = ">=3.12, <4"
@@ -18,6 +18,7 @@ api = [
 core-api = [
     "starlette>=1.7.0",
     "uvicorn[standard]>=0.54.0",
+    "python-multipart>=0.0.29",
 ]
 storage = [
     "aiobotocore>=3.9.2",

{kiba_core-0.5.3.dev86 → kiba_core-0.5.3.dev87}/tests/api/test_json_route.py

@@ -6,6 +6,7 @@ from pydantic import BaseModel
 
 from core.api.json_route import json_route
 from core.api.api_request import KibaApiRequest
+from core.api.uploaded_file import UploadedFile
 from core.api.middleware.exception_handling_middleware import ExceptionHandlingMiddleware
 from core.api.request_context import RequestContext
 from core.api.request_context import RequestContextHolder
@@ -30,6 +31,18 @@ class ExampleResponse(BaseModel):
     path_echo: str | None = None
 
 
+class UploadRequest(BaseModel):
+    file: UploadedFile
+    age: int
+
+
+class UploadResponse(BaseModel):
+    filename: str | None
+    content_type: str | None
+    content: str
+    age: int
+
+
 @pytest.fixture
 def client():
     @json_route(requestType=ExampleRequest, responseType=ExampleResponse)
@@ -52,9 +65,20 @@ def client():
         )
 
 
+    @json_route(requestType=UploadRequest, responseType=UploadResponse)
+    async def test_upload_endpoint(request: KibaApiRequest[UploadRequest]) -> UploadResponse:
+        return UploadResponse(
+            filename=request.data.file.filename,
+            content_type=request.data.file.contentType,
+            content=request.data.file.content.decode(),
+            age=request.data.age,
+        )
+
+
     app = Starlette(routes=[
         Route("/test", test_endpoint, methods=["POST"]),
         Route("/test/{path_param}", test_path_endpoint, methods=["POST"]),
+        Route("/upload", test_upload_endpoint, methods=["POST"]),
     ])
     app.add_middleware(ExceptionHandlingMiddleware)
     app.add_middleware(RequestContextMiddleware, requestContextHolder=requestContextHolder, requestContextFactory=create_request_context)
@@ -145,3 +169,23 @@ def test_json_route_with_non_object_json(client, content):
     )
     assert response.status_code == 400
     assert "expected an object" in response.json().get("message", "")
+
+
+def test_json_route_with_multipart_body_passes_files_and_fields(client):
+    response = client.post(
+        "/upload",
+        files={"file": ("scan.dcm", b"file-content", "application/dicom")},
+        data={"age": "41"},
+    )
+    assert response.status_code == 200
+    assert response.json() == {"filename": "scan.dcm", "content_type": "application/dicom", "content": "file-content", "age": 41}
+
+
+def test_json_route_with_multipart_body_rejects_repeated_fields(client):
+    response = client.post(
+        "/upload",
+        files=[("file", ("first.dcm", b"first", "application/dicom")), ("file", ("second.dcm", b"second", "application/dicom"))],
+        data={"age": "41"},
+    )
+    assert response.status_code == 400
+    assert "file is given more than once" in response.json().get("message", "")

{kiba_core-0.5.3.dev86 → kiba_core-0.5.3.dev87}/uv.lock

@@ -1697,6 +1697,7 @@ api = [
     { name = "uvicorn", extra = ["standard"] },
 ]
 core-api = [
+    { name = "python-multipart" },
     { name = "starlette" },
     { name = "uvicorn", extra = ["standard"] },
 ]
@@ -1757,6 +1758,7 @@ requires-dist = [
     { name = "httpx2", marker = "extra == 'requester'", specifier = ">=2.13.1" },
     { name = "orjson", specifier = ">=3.13.0" },
     { name = "pydantic", specifier = ">=2.14.1" },
+    { name = "python-multipart", marker = "extra == 'core-api'", specifier = ">=0.0.29" },
     { name = "sqlalchemy", extras = ["asyncio"], marker = "extra == 'database-psql'", specifier = ">=2.1.4" },
     { name = "sqlalchemy", extras = ["asyncio"], marker = "extra == 'database-sqlite'", specifier = ">=2.1.4" },
     { name = "starlette", marker = "extra == 'core-api'", specifier = ">=1.7.0" },
@@ -2635,6 +2637,15 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/60/d1/38f3a3405989a89ac18390803e70c6ad7c7760da4f9b83cbeca0c44a0c72/python_dotenv-1.2.4-py3-none-any.whl", hash = "sha256:42269a8a5b3fd54ffa6f3d84b18abed50064717576b4ecf03dc4a55d8aa04fdc", size = 23266, upload-time = "2026-10-01T05:36:08.633Z" },
 ]
 
+[[package]]
+name = "python-multipart"
+version = "0.0.32"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/5b/42/55c32bb9b12693c092ad250a0e82edb5b31ddeda6eb772de5f308b3804ad/python_multipart-0.0.32.tar.gz", hash = "sha256:be54b7f3fa167bb83e4fcd936b887b708f4e57fe75911c02aebf53efaf8d938e", size = 46881, upload-time = "2026-06-04T16:18:58.647Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/e1/04/e8135ebd1ad02c56ec633277529b2602ff99ff634be76cdba5744cf554fd/python_multipart-0.0.32-py3-none-any.whl", hash = "sha256:ff6d3f776f16878c894e52e107296ffc890e913c611b1a4ec6c44e2821fe2e23", size = 30042, upload-time = "2026-06-04T16:18:57.319Z" },
+]
+
 [[package]]
 name = "pyunormalize"
 version = "18.0.0"