feat!: Remove deprecated body param from streaming and file responses (#4034)

remove 'body' param from streaming and file responses

Author: provinzkraut

docs/release-notes/whats-new-3.rst

@@ -272,3 +272,12 @@ of the abstract :class:`~litestar.plugins.SerializationPlugin`. The functionalit
 interface remain the same, the only difference being that plugins that wish to provide
 this functionality are now required to inherit from
 :class:`~.plugins.SerializationPlugin`.
+
+
+Removal of ``body`` in streaming responses
+-------------------------------------------
+
+The unsupported ``body`` parameter of :class:`~.ASGIStreamingResponse`
+and :class:`.ASGIFileResponse` has been removed.
+
+This does not change any behaviour, as this parameter was previously ignored.

litestar/response/file.py

@@ -124,7 +124,6 @@ def __init__(
         self,
         *,
         background: BackgroundTask | BackgroundTasks | None = None,
-        body: bytes | str = b"",
         chunk_size: int = ONE_MEGABYTE,
         content_disposition_type: Literal["attachment", "inline"] = "attachment",
         content_length: int | None = None,
@@ -146,7 +145,6 @@ def __init__(
 
         Args:
             background: A background task or a list of background tasks to be executed after the response is sent.
-            body: encoded content to send in the response body.
             chunk_size: The chunk size to use.
             content_disposition_type: The type of the ``Content-Disposition``. Either ``inline`` or ``attachment``.
             content_length: The response content length.
@@ -181,7 +179,6 @@ def __init__(
             cookies=cookies,
             background=background,
             status_code=status_code,
-            body=body,
             content_length=content_length,
             encoding=encoding,
             is_head_response=is_head_response,
@@ -370,7 +367,6 @@ def to_asgi_response(
         """Create an :class:`ASGIFileResponse <litestar.response.file.ASGIFileResponse>` instance.
 
         Args:
-            app: The :class:`Litestar <.app.Litestar>` application instance.
             background: Background task(s) to be executed after the response is sent.
             cookies: A list of cookies to be set on the response.
             encoded_headers: A list of already encoded headers.
@@ -394,7 +390,6 @@ def to_asgi_response(
 
         return ASGIFileResponse(
             background=self.background or background,
-            body=b"",
             chunk_size=self.chunk_size,
             content_disposition_type=self.content_disposition_type,  # pyright: ignore
             content_length=0,

litestar/response/streaming.py

@@ -38,7 +38,6 @@ def __init__(
         *,
         iterator: StreamType,
         background: BackgroundTask | BackgroundTasks | None = None,
-        body: bytes | str = b"",
         content_length: int | None = None,
         cookies: Iterable[Cookie] | None = None,
         encoded_headers: Iterable[tuple[bytes, bytes]] | None = None,
@@ -52,8 +51,6 @@ def __init__(
 
         Args:
             background: A background task or a list of background tasks to be executed after the response is sent.
-            body: encoded content to send in the response body.
-                .. deprecated:: 2.16
             content_length: The response content length.
             cookies: The response cookies.
             encoded_headers: The response headers.
@@ -65,18 +62,8 @@ def __init__(
             status_code: The response status code.
         """
 
-        if body:
-            warn_deprecation(
-                version="2.16",
-                kind="parameter",
-                deprecated_name="body",
-                removal_in="3.0",
-                info="'body' passed to a streaming response will be ignored. Streams should always be iterables",
-            )
-
         super().__init__(
             background=background,
-            body=body,
             content_length=content_length,
             cookies=cookies,
             encoding=encoding,