dynamicforms-fastapi-viewsets 0.6.4__tar.gz → 0.7.0__tar.gz

{dynamicforms_fastapi_viewsets-0.6.4 → dynamicforms_fastapi_viewsets-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: dynamicforms-fastapi-viewsets
-Version: 0.6.4
+Version: 0.7.0
 Summary: Django REST Framework-style viewsets for FastAPI, with optional Celery-backed async execution and a Vue/TypeScript client counterpart.
 Project-URL: Homepage, https://github.com/dynamicforms/fastapi-viewsets
 Project-URL: Repository, https://github.com/dynamicforms/fastapi-viewsets

dynamicforms_fastapi_viewsets-0.7.0/fastapi_viewsets/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.7.0"

{dynamicforms_fastapi_viewsets-0.6.4 → dynamicforms_fastapi_viewsets-0.7.0}/fastapi_viewsets/decorators/build_schema.py

@@ -94,12 +94,15 @@ def build_schema(cls, base_path: str = "", default_tags=None, get_wrapper=None,
     and attaches them to the class. Idempotent: if already called, returns immediately.
     If get_wrapper is None, only __router is built (no FastAPI app, no endpoint wrapping).
 
-    disable_response_model: pass True when command middleware is configured (see
-    fastapi_viewsets/middleware.py and route_viewset.py) - middleware can change the shape of what's
-    actually served (e.g. strip an internal-only field via ViewSetResult.body), so FastAPI must not
-    coerce/re-validate the endpoint's return value against the ORIGINAL method's declared return
-    type, which would silently undo those changes (missing fields reappear with their model
-    defaults).
+    disable_response_model: pass True when a configured command middleware declares
+    modifies_response_shape=True (see Middleware.modifies_response_shape and
+    any_modifies_response_shape() in fastapi_viewsets/middleware/__init__.py, and route_viewset.py) -
+    such a middleware can change the shape of what's actually served (e.g. strip an internal-only
+    field via ViewSetResult.body), so FastAPI must not coerce/re-validate the endpoint's return value
+    against the ORIGINAL method's declared return type, which would silently undo those changes
+    (missing fields reappear with their model defaults). Middleware that doesn't declare this (the
+    default) leaves the endpoint's declared return type in place, both in the OpenAPI docs and for
+    FastAPI's own response validation.
     """
     if hasattr(cls, "__router") and (get_wrapper is None or getattr(cls, "__router_full", False)):
         return

{dynamicforms_fastapi_viewsets-0.6.4 → dynamicforms_fastapi_viewsets-0.7.0}/fastapi_viewsets/decorators/route_viewset.py

@@ -21,7 +21,7 @@ from fastapi_viewsets.endpoint_docs import (
     register_tag,
     viewset_description,
 )
-from fastapi_viewsets.middleware import Middleware
+from fastapi_viewsets.middleware import any_modifies_response_shape, Middleware
 from fastapi_viewsets.mixins import FilterParam
 from fastapi_viewsets.mux_ws import register_viewset, resolve_register_muxws, resolve_register_rest
 
@@ -342,14 +342,16 @@ def route_viewset(
             return wrapper, new_return_annotation
 
         # Command middleware (see fastapi_viewsets/middleware.py) can reshape the response body via
-        # ViewSetResult - if any is configured, the endpoint's declared return type can no longer
-        # be trusted as the actual response_model, same reasoning as the old finalize_response hook.
+        # ViewSetResult - only middleware that actually declares modifies_response_shape=True
+        # untrusts the endpoint's declared return type as the response_model (same reasoning as the
+        # old finalize_response hook); typical middleware (auth, rate limiting, sessions) only adds
+        # headers/cookies and leaves the declared model - and therefore the OpenAPI docs - in place.
         build_schema(
             cls,
             base_path,
             default_tags,
             get_wrapper,
-            disable_response_model=bool(settings.viewsets_command_middleware),
+            disable_response_model=any_modifies_response_shape(settings.viewsets_command_middleware),
         )
 
         muxws_routes = []

{dynamicforms_fastapi_viewsets-0.6.4 → dynamicforms_fastapi_viewsets-0.7.0}/fastapi_viewsets/middleware/__init__.py

@@ -57,6 +57,20 @@ class Middleware(ABC):
     concrete example) - a bare function would need extra indirection (closures, partials) for that.
     """
 
+    modifies_response_shape: bool = False
+    """
+    Whether this middleware can change the shape of ViewSetResult.body (strip/rename/restructure
+    fields, not just add side-channel headers/cookies or a status code) - see
+    `any_modifies_response_shape()` below. False by default: typical middleware (auth, rate
+    limiting, sessions) only inspects the result or attaches headers/cookies, so the endpoint's
+    declared return type stays a trustworthy response_model. Override to True on a middleware whose
+    __call__ actually reassigns `result.body` to something that no longer matches the original
+    return annotation - otherwise FastAPI's response_model validation will coerce the reshaped body
+    back towards the original model (e.g. reintroducing a stripped field with its default value).
+    A plain function middleware declares this the same way, by setting the attribute on the
+    function object: `my_middleware.modifies_response_shape = True`.
+    """
+
     def config_from(self, context: Context) -> Any:
         """
         This middleware's own @action_configuration value for the current call (see
@@ -104,6 +118,18 @@ class Middleware(ABC):
         raise NotImplementedError
 
 
+def any_modifies_response_shape(middlewares: list) -> bool:
+    """
+    Whether any entry in `middlewares` (a mix of Middleware instances and/or plain functions, as
+    settings.viewsets_command_middleware holds) declares modifies_response_shape=True. A bare
+    function that never set the attribute is treated as False, same default as the Middleware
+    class - see Middleware.modifies_response_shape above. Used by route_viewset/build_schema to
+    decide whether an endpoint's declared response_model can still be trusted for OpenAPI docs and
+    FastAPI's own response validation.
+    """
+    return any(getattr(middleware, "modifies_response_shape", False) for middleware in middlewares)
+
+
 async def run_command_chain(
     middlewares: list[CommandMiddleware],
     request: "Request | None",

dynamicforms_fastapi_viewsets-0.6.4/fastapi_viewsets/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.4"