Response binary format support

Author: p1c2u

openapi_core/contrib/aiohttp/responses.py

@@ -13,13 +13,13 @@ def __init__(self, response: web.Response):
         self.response = response
 
     @property
-    def data(self) -> str:
+    def data(self) -> bytes:
         if self.response.body is None:
-            return ""
+            return b""
         if isinstance(self.response.body, bytes):
-            return self.response.body.decode("utf-8")
+            return self.response.body
         assert isinstance(self.response.body, str)
-        return self.response.body
+        return self.response.body.encode("utf-8")
 
     @property
     def status_code(self) -> int:

openapi_core/contrib/django/responses.py

@@ -1,20 +1,28 @@
 """OpenAPI core contrib django responses module"""
+from itertools import tee
+
 from django.http.response import HttpResponse
+from django.http.response import StreamingHttpResponse
 from werkzeug.datastructures import Headers
 
 
 class DjangoOpenAPIResponse:
     def __init__(self, response: HttpResponse):
-        if not isinstance(response, HttpResponse):
+        if not isinstance(response, (HttpResponse, StreamingHttpResponse)):
             raise TypeError(
-                f"'response' argument is not type of {HttpResponse}"
+                f"'response' argument is not type of {HttpResponse} or {StreamingHttpResponse}"
             )
         self.response = response
 
     @property
-    def data(self) -> str:
+    def data(self) -> bytes:
+        if isinstance(self.response, StreamingHttpResponse):
+            resp_iter1, resp_iter2 = tee(self.response._iterator)
+            self.response.streaming_content = resp_iter1
+            content = b"".join(map(self.response.make_bytes, resp_iter2))
+            return content
         assert isinstance(self.response.content, bytes)
-        return self.response.content.decode("utf-8")
+        return self.response.content
 
     @property
     def status_code(self) -> int:

openapi_core/contrib/falcon/responses.py

@@ -1,4 +1,6 @@
 """OpenAPI core contrib falcon responses module"""
+from itertools import tee
+
 from falcon.response import Response
 from werkzeug.datastructures import Headers
 
@@ -10,11 +12,16 @@ def __init__(self, response: Response):
         self.response = response
 
     @property
-    def data(self) -> str:
+    def data(self) -> bytes:
         if self.response.text is None:
-            return ""
+            if self.response.stream is None:
+                return b""
+            resp_iter1, resp_iter2 = tee(self.response.stream)
+            self.response.stream = resp_iter1
+            content = b"".join(resp_iter2)
+            return content
         assert isinstance(self.response.text, str)
-        return self.response.text
+        return self.response.text.encode("utf-8")
 
     @property
     def status_code(self) -> int:

openapi_core/contrib/requests/responses.py

@@ -10,9 +10,9 @@ def __init__(self, response: Response):
         self.response = response
 
     @property
-    def data(self) -> str:
+    def data(self) -> bytes:
         assert isinstance(self.response.content, bytes)
-        return self.response.content.decode("utf-8")
+        return self.response.content
 
     @property
     def status_code(self) -> int:

openapi_core/contrib/starlette/responses.py

@@ -1,20 +1,31 @@
 """OpenAPI core contrib starlette responses module"""
+from typing import Optional
+
 from starlette.datastructures import Headers
 from starlette.responses import Response
+from starlette.responses import StreamingResponse
 
 
 class StarletteOpenAPIResponse:
-    def __init__(self, response: Response):
+    def __init__(self, response: Response, data: Optional[bytes] = None):
         if not isinstance(response, Response):
             raise TypeError(f"'response' argument is not type of {Response}")
         self.response = response
 
+        if data is None and isinstance(response, StreamingResponse):
+            raise RuntimeError(
+                f"'data' argument is required for {StreamingResponse}"
+            )
+        self._data = data
+
     @property
-    def data(self) -> str:
+    def data(self) -> bytes:
+        if self._data is not None:
+            return self._data
         if isinstance(self.response.body, bytes):
-            return self.response.body.decode("utf-8")
+            return self.response.body
         assert isinstance(self.response.body, str)
-        return self.response.body
+        return self.response.body.encode("utf-8")
 
     @property
     def status_code(self) -> int:

openapi_core/contrib/werkzeug/responses.py

@@ -1,4 +1,6 @@
 """OpenAPI core contrib werkzeug responses module"""
+from itertools import tee
+
 from werkzeug.datastructures import Headers
 from werkzeug.wrappers import Response
 
@@ -10,8 +12,12 @@ def __init__(self, response: Response):
         self.response = response
 
     @property
-    def data(self) -> str:
-        return self.response.get_data(as_text=True)
+    def data(self) -> bytes:
+        if not self.response.is_sequence:
+            resp_iter1, resp_iter2 = tee(self.response.iter_encoded())
+            self.response.response = resp_iter1
+            return b"".join(resp_iter2)
+        return self.response.get_data(as_text=False)
 
     @property
     def status_code(self) -> int:

openapi_core/protocols.py

@@ -120,7 +120,7 @@ class Response(Protocol):
     """
 
     @property
-    def data(self) -> str:
+    def data(self) -> Optional[bytes]:
         ...
 
     @property

openapi_core/testing/responses.py

@@ -9,7 +9,7 @@
 class MockResponse:
     def __init__(
         self,
-        data: str,
+        data: bytes,
         status_code: int = 200,
         headers: Optional[Dict[str, Any]] = None,
         content_type: str = "application/json",

openapi_core/validation/response/validators.py

@@ -5,6 +5,7 @@
 from typing import Iterator
 from typing import List
 from typing import Mapping
+from typing import Optional
 
 from jsonschema_path import SchemaPath
 from openapi_spec_validator import OpenAPIV30SpecValidator
@@ -41,7 +42,7 @@ class BaseResponseValidator(BaseValidator):
     def _iter_errors(
         self,
         status_code: int,
-        data: str,
+        data: Optional[bytes],
         headers: Mapping[str, Any],
         mimetype: str,
         operation: SchemaPath,
@@ -66,7 +67,11 @@ def _iter_errors(
             yield from exc.context
 
     def _iter_data_errors(
-        self, status_code: int, data: str, mimetype: str, operation: SchemaPath
+        self,
+        status_code: int,
+        data: Optional[bytes],
+        mimetype: str,
+        operation: SchemaPath,
     ) -> Iterator[Exception]:
         try:
             operation_response = self._find_operation_response(
@@ -114,7 +119,10 @@ def _find_operation_response(
 
     @ValidationErrorWrapper(DataValidationError, InvalidData)
     def _get_data(
-        self, data: str, mimetype: str, operation_response: SchemaPath
+        self,
+        data: Optional[bytes],
+        mimetype: str,
+        operation_response: SchemaPath,
     ) -> Any:
         if "content" not in operation_response:
             return None
@@ -125,7 +133,7 @@ def _get_data(
         value, _ = self._get_content_and_schema(raw_data, content, mimetype)
         return value
 
-    def _get_data_value(self, data: str) -> Any:
+    def _get_data_value(self, data: Optional[bytes]) -> bytes:
         if not data:
             raise MissingData
 

tests/integration/contrib/aiohttp/test_aiohttp_project.py

@@ -38,10 +38,6 @@ def api_key_encoded(self):
 
 
 class TestPetPhotoView(BaseTestPetstore):
-    @pytest.mark.xfail(
-        reason="response binary format not supported",
-        strict=True,
-    )
     async def test_get_valid(self, client, data_gif):
         headers = {
             "Authorization": "Basic testuser",