Raise informative IOError on corrupt tfidf vectors cache file#588
Open
H2908 wants to merge 1 commit into
Open
Conversation
When scipy.sparse.load_npz encounters a corrupted .npz file (e.g. from an interrupted download), it raises BadZipFile or EOFError with no indication of which file is affected or how to fix it. This commit catches those exceptions and raises an IOError that includes the local file path and instructs the user to delete the file so it can be re-downloaded. Fixes allenai#534
Author
|
Hi, I'd like to work on this issue. |
This file contains hidden or 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
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.
Problem
When scipy.sparse.load_npz() encounters a corrupted .npz file (typically from an interrupted download), it raises BadZipFile, EOFError, or ValueError with no indication of which file is affected or how to fix it. Users are left with a cryptic traceback and no recovery path.
This was noted in issue #534 where a maintainer suggested modifying the package to print out which paths it is trying to load.
Fix
In load_approximate_nearest_neighbours_index:
Extract the resolved local cache path into a named variable before calling load_npz()
Catch BadZipFile, EOFError, and ValueError
Re-raise as IOError with the exact file path and instructions to delete the file so it can be re-downloaded
Testing
Added a test in tests/test_candidate_generation.py that writes a malformed .npz file to a temporary directory and asserts that the new IOError is raised.