Support Falcon 4

Author: p1c2u

docs/integrations/falcon.md

@@ -1,11 +1,16 @@
 # Falcon
 
-This section describes integration with [Falcon](https://falconframework.org) web framework.
-The integration supports Falcon from version 3.0 and above.
+This section describes the integration with the [Falcon](https://falconframework.org) web framework.
+The integration supports Falcon version 3.0 and above.
+
+!!! warning
+
+    This integration does not support multipart form body requests.
+
 
 ## Middleware
 
-The Falcon API can be integrated by `FalconOpenAPIMiddleware` middleware.
+The Falcon API can be integrated using the `FalconOpenAPIMiddleware`.
 
 ``` python hl_lines="1 3 7"
 from openapi_core.contrib.falcon.middlewares import FalconOpenAPIMiddleware
@@ -34,7 +39,7 @@ app = falcon.App(
 )
 ```
 
-You can skip response validation process: by setting `response_cls` to `None`
+You can skip the response validation process by setting `response_cls` to `None`.
 
 ``` python hl_lines="5"
 from openapi_core.contrib.falcon.middlewares import FalconOpenAPIMiddleware
@@ -50,20 +55,20 @@ app = falcon.App(
 )
 ```
 
-After that you will have access to validation result object with all validated request data from Falcon view through request context.
+After this, you will have access to the validation result object, which contains all validated request data, from the Falcon view through the request context.
 
 ``` python
 class ThingsResource:
     def on_get(self, req, resp):
-        # get parameters object with path, query, cookies and headers parameters
+        # Get the parameters object with path, query, cookies, and headers parameters
         validated_params = req.context.openapi.parameters
-        # or specific location parameters
+        # Or specific location parameters
         validated_path_params = req.context.openapi.parameters.path
 
-        # get body
+        # Get the body
         validated_body = req.context.openapi.body
 
-        # get security data
+        # Get security data
         validated_security = req.context.openapi.security
 ```
 

openapi_core/contrib/falcon/requests.py

@@ -67,7 +67,7 @@ def body(self) -> Optional[bytes]:
         )
         try:
             body = handler.serialize(
-                media, content_type=self.request.content_type
+                media, content_type=self.content_type
             )
         # multipart form serialization is not supported
         except NotImplementedError:

openapi_core/contrib/falcon/responses.py

@@ -1,6 +1,8 @@
 """OpenAPI core contrib falcon responses module"""
 
+from io import BytesIO
 from itertools import tee
+from typing import Iterable
 
 from falcon.response import Response
 from werkzeug.datastructures import Headers
@@ -17,16 +19,22 @@ def data(self) -> bytes:
         if self.response.text is None:
             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
+            if isinstance(self.response.stream, Iterable):
+                resp_iter1, resp_iter2 = tee(self.response.stream)
+                self.response.stream = resp_iter1
+                content = b"".join(resp_iter2)
+                return content
+            # checks ReadableIO protocol
+            if hasattr(self.response.stream, "read"):
+                data = self.response.stream.read()
+                self.response.stream = BytesIO(data)
+                return data
         assert isinstance(self.response.text, str)
         return self.response.text.encode("utf-8")
 
     @property
     def status_code(self) -> int:
-        return int(self.response.status[:3])
+        return self.response.status_code
 
     @property
     def content_type(self) -> str:

openapi_core/contrib/falcon/util.py

@@ -1,11 +1,11 @@
 from typing import Any
-from typing import Dict
 from typing import Generator
+from typing import Mapping
 from typing import Tuple
 
 
 def unpack_params(
-    params: Dict[str, Any]
+    params: Mapping[str, Any]
 ) -> Generator[Tuple[str, Any], None, None]:
     for k, v in params.items():
         if isinstance(v, list):

tests/integration/contrib/django/test_django_project.py

@@ -184,7 +184,7 @@ def test_post_media_type_invalid(self, client):
                     "title": (
                         "Content for the following mimetype not found: "
                         "text/html. "
-                        "Valid mimetypes: ['application/json', 'application/x-www-form-urlencoded', 'text/plain']"
+                        "Valid mimetypes: ['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data', 'text/plain']"
                     ),
                 }
             ]

tests/integration/contrib/falcon/test_falcon_project.py

@@ -1,5 +1,6 @@
 from base64 import b64encode
 from json import dumps
+from urllib3 import encode_multipart_formdata
 
 import pytest
 
@@ -204,7 +205,7 @@ def test_post_media_type_invalid(self, client):
                     "title": (
                         "Content for the following mimetype not found: "
                         f"{content_type}. "
-                        "Valid mimetypes: ['application/json', 'application/x-www-form-urlencoded', 'text/plain']"
+                        "Valid mimetypes: ['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data', 'text/plain']"
                     ),
                 }
             ]
@@ -292,6 +293,43 @@ def test_post_valid(self, client, data_json):
         assert response.status_code == 201
         assert not response.content
 
+    @pytest.mark.xfail(
+        reason="falcon multipart form serialization unsupported",
+        strict=True,
+    )
+    def test_post_multipart_valid(self, client, data_gif):
+        cookies = {"user": 1}
+        auth = "authuser"
+        fields = {
+            "name": "Cat",
+            "address": (
+                "aaddress.json",
+                dumps(dict(city="Warsaw")),
+                "application/json",
+            ),
+            "photo": (
+                "photo.jpg",
+                data_gif,
+                "image/jpeg",
+            ),
+        }
+        body, content_type_header = encode_multipart_formdata(fields)
+        headers = {
+            "Authorization": f"Basic {auth}",
+            "Content-Type": content_type_header,
+        }
+
+        response = client.simulate_post(
+            "/v1/pets",
+            host="staging.gigantic-server.com",
+            headers=headers,
+            body=body,
+            cookies=cookies,
+            protocol="https",
+        )
+
+        assert response.status_code == 200
+
 
 class TestPetDetailResource:
     def test_get_server_invalid(self, client):

tests/integration/contrib/fastapi/test_fastapi_project.py

@@ -183,7 +183,7 @@ def test_post_media_type_invalid(self, client):
                     "title": (
                         "Content for the following mimetype not found: "
                         "text/html. "
-                        "Valid mimetypes: ['application/json', 'application/x-www-form-urlencoded', 'text/plain']"
+                        "Valid mimetypes: ['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data', 'text/plain']"
                     ),
                 }
             ]

tests/integration/contrib/starlette/test_starlette_project.py

@@ -183,7 +183,7 @@ def test_post_media_type_invalid(self, client):
                     "title": (
                         "Content for the following mimetype not found: "
                         "text/html. "
-                        "Valid mimetypes: ['application/json', 'application/x-www-form-urlencoded', 'text/plain']"
+                        "Valid mimetypes: ['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data', 'text/plain']"
                     ),
                 }
             ]

tests/integration/data/v3.0/petstore.yaml

@@ -150,6 +150,9 @@ paths:
           application/x-www-form-urlencoded:
             schema:
               $ref: '#/components/schemas/PetCreate'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PetWithPhotoCreate'
           text/plain: {}
       responses:
         '201':
@@ -375,6 +378,16 @@ components:
       oneOf:
         - $ref: "#/components/schemas/Cat"
         - $ref: "#/components/schemas/Bird"
+    PetWithPhotoCreate:
+      type: object
+      x-model: PetWithPhotoCreate
+      allOf:
+        - $ref: "#/components/schemas/PetCreatePartOne"
+        - $ref: "#/components/schemas/PetCreatePartTwo"
+        - $ref: "#/components/schemas/PetCreatePartPhoto"
+      oneOf:
+        - $ref: "#/components/schemas/Cat"
+        - $ref: "#/components/schemas/Bird"
     PetCreatePartOne:
       type: object
       x-model: PetCreatePartOne
@@ -395,6 +408,15 @@ components:
           $ref: "#/components/schemas/Position"
         healthy:
           type: boolean
+    PetCreatePartPhoto:
+      type: object
+      x-model: PetCreatePartPhoto
+      properties:
+        photo:
+          $ref: "#/components/schemas/PetPhoto"
+    PetPhoto:
+      type: string
+      format: binary
     Bird:
       type: object
       x-model: Bird