Fix progress bar not always closed in file_download.py #2308
Conversation
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
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
cbensimon
reviewed
Jun 3, 2024
src/huggingface_hub/file_download.py
Outdated
| "Consider upgrading to latest version to enable progress bars " | ||
| "using `pip install -U hf_transfer`." | ||
| ) | ||
| with progress: |
There was a problem hiding this comment.
Suggested change
| with progress: | |
| with progress as progress: |
Not 100% sure but I think that the value from nullcontext is only returned in __enter__ : https://docs.python.org/3/library/contextlib.html#contextlib.nullcontext
This shouldn't break the case where _tqdm_bar is None because __enter__ method of a tqdm.tqdm instance returns self
There was a problem hiding this comment.
Correct, thanks for the hint. Corrected it in 63dfdaf
cbensimon
approved these changes
Jun 3, 2024
|
Thanks for the review! |
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.
When downloading files in
file_download.py, we use a progress bar. This progress bar can be either passed by the user or we create a classic tqdm bar (see update in #2143).As @cbensimon noticed, the progress bar is not correctly closed when an error occurs or when
hf_transferis used. This PR fixes this by using a context manager. The progress bar is now always closed if created internally. When passed by the user, the progress bar is not closed as it is a the user's discretion to manage it.Better to review with "hide whitespace" checked.