tqdm.std: add update_to #1540
Open
tqdm.std: add update_to #1540
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
Porting from dvc's Tqdm progress bar implementation. https://github.com/iterative/dvc/blob/cf8195c829aa67425b87e4145bd33cae8584ee1e/dvc/progress.py#L114-L117 So, the implementation uses `self.update()` so that it refreshes based on `self.update()` logic. Also, adds a way to update `total`. This function is pretty convenient and useful even outside dvc. Take an example of fsspec's callback that uses both `total` and `value` (i.e. current position) at once. https://github.com/fsspec/filesystem_spec/blob/0ffe06cb767456b7c13904b57ec1c3ca60d53eae/fsspec/callbacks.py#L228 I see that there are mentions of `update_to` in docs and examples, which will likely have to change as a result of this PR. So I'm happy to rename this to something else (eg: `set_position` etc.). Related: tqdm#1264.
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.
Porting from dvc's Tqdm progress bar implementation.
https://github.com/iterative/dvc/blob/cf8195c829aa67425b87e4145bd33cae8584ee1e/dvc/progress.py#L114-L117
So, the implementation uses
self.update()so that it refreshes based onself.update()logic. Also, adds a way to updatetotal.This function is pretty convenient and useful even outside dvc. Take an example of fsspec's callback that uses both
total(akaself.size) andvalue(akaself.value) (i.e. current position) at once.https://github.com/fsspec/filesystem_spec/blob/0ffe06cb767456b7c13904b57ec1c3ca60d53eae/fsspec/callbacks.py#L228
I see that there are mentions of
update_toin docs and examples, which will likely have to change as a result of this PR. Also, I'm happy to rename this to something else (eg:set_positionetc.).See https://github.com/search?q=repo%3Atqdm%2Ftqdm+%22def+update_to%22&type=code.
Related: #1264.