test client response.close() closes input stream #2041
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When passing a large amount of data (> 500 KiB) with the test client, it uses a temporary file to store the encoded multipart form data. The test client has no way to close the file, and if it's left open after a test finishes Python may show a
ResourceWarning
. It's not entirely clear when Python decides to do this, pytest doesn't show it but unittest does, but neither show it with the latest Werkzeug code unless-Walways
is used.Now, the input stream is closed automatically when following redirects (except for 307 and 308, which preserve the body), and the final request's
stream.close
method is added to the response'sclose
callbacks. So callingresponse.close()
will close the input stream in addition to the response stream.I couldn't figure out a reliable way to make a test for this, given how inconsistent the warning is in the first place, but all current tests pass.
Checklist:
CHANGES.rst
summarizing the change and linking to the issue... versionchanged::
entries in any relevant code docs.pre-commit
hooks and fix any issues.pytest
andtox
, no tests failed.