Skip to content

fix: Warn about using streaming responses with a body#4033

Merged
provinzkraut merged 1 commit intomainfrom
fix-stream-with-body
Feb 27, 2025
Merged

fix: Warn about using streaming responses with a body#4033
provinzkraut merged 1 commit intomainfrom
fix-stream-with-body

Conversation

@provinzkraut
Copy link
Copy Markdown
Member

Litestar allows passing in a body parameter for a streaming response, but this parameter is ignored.

I'm adding a deprecation warning for this parameter, so we can remove it in v3.

@provinzkraut provinzkraut enabled auto-merge (squash) February 27, 2025 16:14
@sonarqubecloud
Copy link
Copy Markdown

@codecov
Copy link
Copy Markdown

codecov bot commented Feb 27, 2025

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 98.34%. Comparing base (e7477ac) to head (12acc4d).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
litestar/response/streaming.py 0.00% 1 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4033      +/-   ##
==========================================
- Coverage   98.35%   98.34%   -0.02%     
==========================================
  Files         348      348              
  Lines       15821    15823       +2     
  Branches     1747     1748       +1     
==========================================
  Hits        15561    15561              
- Misses        124      125       +1     
- Partials      136      137       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@github-actions
Copy link
Copy Markdown

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/4033

@provinzkraut provinzkraut merged commit 05005ca into main Feb 27, 2025
28 of 29 checks passed
@provinzkraut provinzkraut deleted the fix-stream-with-body branch February 27, 2025 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants