Automatically close underlying file object when response closes #12
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit fixes ResourceWarnings in Python 3 where file objects do not appear to be closed at the end of the request, and the Django server will emit ResourceWarnings about unclosed files. The `_closable_objects` list is managed by the base FileResponse class in Django and will call `.close()` on objects at the end of the request.
Added RangedFileReader.close() method, which allows underlying StreamingHttpResponse to add to `_closable_objects` more naturally to fix unclosed files. Also initialized `RangedFileReader.size` using `file_like.size` property (if available, i.e. Django File/FieldFile) rather than reading entire file contents.
No longer need to add file to `_closable_objects` explicitly with new reader close() method.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Expected behaviour
Underlying file object should get closed when the response gets closed. The underlying
StreamingHttpResponseshould add theRangedFileReaderto the_closable_objectslist.Actual behaviour
Without a
RangedFileReader.close()method, theStreamingHttpResponsedoesn't see theRangedFileReader(and its underlying file) as a closable object.Description of fix
_closable_objects.RangedFileReader.sizeusingfile_like.sizeproperty (if available, i.e. Django File/FieldFile) rather than reading entire file contents.This supercedes the changes in #11