Merge pull request #199 from python-ellar/minor_patches

Minor Fixes

Author: eadwinCode

ellar/__init__.py

@@ -1,3 +1,3 @@
 """Ellar - Python ASGI web framework for building fast, efficient, and scalable RESTful APIs and server-side applications."""
 
-__version__ = "0.7.2"
+__version__ = "0.7.3"

ellar/common/params/decorators/__init__.py

@@ -111,7 +111,7 @@ def P(
     Path = Annotated[T, param_functions.Path()]
     Query = Annotated[T, param_functions.Query()]
     WsBody = Annotated[T, param_functions.WsBody()]
-    Inject = InjectShortcut()
+    Inject = Annotated[T, InjectShortcut()]
 
 else:
     Body = _ParamShortcut(param_functions.Body)

ellar/common/responses/models/__init__.py

@@ -3,7 +3,6 @@
 from .file import (
     FileResponseModel,
     StreamingResponseModel,
-    StreamingResponseModelInvalidContent,
 )
 from .helper import create_response_model
 from .html import HTMLResponseModel, HTMLResponseModelRuntimeError
@@ -23,7 +22,6 @@
     "HTMLResponseModel",
     "create_response_model",
     "HTMLResponseModelRuntimeError",
-    "StreamingResponseModelInvalidContent",
     "RouteResponseExecution",
     "ResponseTypeDefinitionConverter",
 ]

ellar/common/responses/models/file.py

@@ -4,15 +4,12 @@
 from ellar.common.interfaces import IExecutionContext
 from ellar.common.logging import request_logger
 from ellar.common.serializer import Serializer, SerializerFilter
+from ellar.pydantic import field_validator
 
 from ..response_types import FileResponse, Response, StreamingResponse
 from .base import ResponseModel, ResponseModelField
 
 
-class StreamingResponseModelInvalidContent(RuntimeError):
-    pass
-
-
 class ContentDispositionType(str, Enum):
     inline = "inline"
     attachment = "attachment"
@@ -26,6 +23,17 @@ class FileResponseModelSchema(Serializer):
     content_disposition_type: ContentDispositionType = ContentDispositionType.attachment
 
 
+class StreamResponseModelSchema(Serializer):
+    media_type: t.Optional[str] = None
+    content: t.Any
+
+    @field_validator("content", mode="before")
+    def pre_validate_content(cls, value: t.Dict) -> t.Any:
+        if not isinstance(value, (t.AsyncGenerator, t.Generator)):
+            raise ValueError("Content must typing.AsyncIterable OR typing.Iterable")
+        return value
+
+
 class FileResponseModel(ResponseModel):
     __slots__ = ("_file_init_schema",)
 
@@ -79,11 +87,23 @@ def serialize(
 
 class StreamingResponseModel(ResponseModel):
     response_type = StreamingResponse
+    file_schema_type = StreamResponseModelSchema
 
     def get_model_field(self) -> t.Optional[t.Union[ResponseModelField, t.Any]]:
         # We don't want any schema for this.
         return None
 
+    def serialize(
+        self,
+        response_obj: t.Any,
+        serializer_filter: t.Optional[SerializerFilter] = None,
+    ) -> t.Union[t.List[t.Dict], t.Dict, t.Any, StreamResponseModelSchema]:
+        if isinstance(response_obj, (t.AsyncGenerator, t.Generator)):
+            response_obj = {"content": response_obj, "media_type": self.media_type}
+
+        value = self.file_schema_type.from_orm(response_obj)
+        return value
+
     def create_response(
         self, context: IExecutionContext, response_obj: t.Any, status_code: int
     ) -> Response:
@@ -94,12 +114,12 @@ def create_response(
         response_args, headers = self.get_context_response(
             context=context, status_code=status_code
         )
-        if not isinstance(response_obj, (t.AsyncGenerator, t.Generator)):
-            raise StreamingResponseModelInvalidContent(
-                "Content must typing.AsyncIterable OR typing.Iterable"
-            )
+        data = t.cast(StreamResponseModelSchema, self.serialize(response_obj))
 
         response = self._response_type(
-            **response_args, headers=headers, content=response_obj
+            **response_args,
+            headers=headers,
+            content=data.content,
+            media_type=data.media_type or self.media_type,
         )
         return response

tests/test_response/test_response_streaming.py

@@ -3,10 +3,7 @@
 
 import pytest
 from ellar.common import Controller, ModuleRouter, file, get, serialize_object
-from ellar.common.responses.models import (
-    StreamingResponseModel,
-    StreamingResponseModelInvalidContent,
-)
+from ellar.common.responses.models import StreamingResponseModel
 from ellar.openapi import OpenAPIDocumentBuilder
 from ellar.testing import Test
 
@@ -40,7 +37,7 @@ def file_template():
 @streaming_mr.get("/index-decorator")
 @file(media_type="text/html", streaming=True)
 def render_template():
-    return slow_numbers(1, 4)
+    return {"content": slow_numbers(1, 4)}
 
 
 @Controller
@@ -57,16 +54,18 @@ def index2(self):
     @file(media_type="text/html", streaming=True)
     def index(self):
         """detest its mvc and Looks for ellar/index"""
-        return slow_numbers(1, 4)
+        return {"content": slow_numbers(1, 4), "media_type": "text/html"}
 
     @get("/index-invalid")
     @file(media_type="text/html", streaming=True)
     def index3(self):
         """detest its mvc and Looks for ellar/index"""
         return {
-            "path": f"{BASEDIR}/private/test.css",
-            "filename": "file-test-css.css",
-            "content_disposition_type": "whatever",
+            "content": {
+                "path": f"{BASEDIR}/private/test.css",
+                "filename": "file-test-css.css",
+                "content_disposition_type": "whatever",
+            }
         }
 
 
@@ -115,7 +114,7 @@ def test_response_schema(path):
 def test_invalid_parameter_returned():
     client = test_module.get_test_client()
     with pytest.raises(
-        StreamingResponseModelInvalidContent,
+        ValueError,
         match="Content must typing.AsyncIterable OR typing.Iterable",
     ):
         client.get("/ellar/index-invalid")