Uh oh!
There was an error while loading. Please reload this page.
Bump up the total number of ProgressSample items. - #286
Merged
Conversation
When working with `rich` download progress bars with `httpx` we were finding the transfer speed jumping around all over the place. For example, this snippet... ```python import tempfile import httpx import rich.progress with tempfile.NamedTemporaryFile() as download_file: url = "https://speed.hetzner.de/100MB.bin" with httpx.stream("GET", url) as response: total = int(response.headers["Content-Length"]) with rich.progress.Progress( "[progress.percentage]{task.percentage:>3.0f}%", rich.progress.BarColumn(bar_width=None), rich.progress.DownloadColumn(), rich.progress.TransferSpeedColumn(), ) as progress: download_task = progress.add_task("Download", total=total) for chunk in response.iter_bytes(): download_file.write(chunk) progress.update(download_task, completed=response.num_bytes_downloaded) ``` Was resulting in this... ... Have now narrowed down the cause: When calculating transfer speeds, `rich` stores a ProgressSample every time the progress is updated. It then averages out the transfer speed based on the progress samples. The maximum window size of samples that are used is currently set to 30 seconds, or 20 samples, whichever is smaller. That "maximum of 20 samples" is actually pretty small. (For example reading chunks of 16KB at a download speed of 16MB/s will result in 1000 samples/second) This PR changes that window size to be 30 seconds, or 1000 samples, whichever is smaller.
Codecov Report
@@ Coverage Diff @@## master #286 +/- ##
=======================================
Coverage 98.72% 98.72% =======================================
Files 50 50 Lines 4078 4078 =======================================
Hits 4026 4026 Misses 52 52
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
willmcgugan
commented
Sep 16, 2020
Member
Sounds reasonable. Thanks. |
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 working with
richdownload progress bars withhttpxwe were finding the transfer speed jumping around all over the place.For example, this snippet...
Was resulting in this...
Have now narrowed down the cause:
When calculating transfer speeds,
richstores a ProgressSample every time the progress is updated.It then averages out the transfer speed based on the progress samples.
The maximum window size of samples that are used is currently set to 30 seconds, or 20 samples, whichever is smaller.
That "maximum of 20 samples" is actually pretty small. (For example reading chunks of 16KB at a download speed of 16MB/s will result in 1000 samples/second)
This PR changes that window size to be 30 seconds, or 1000 samples, whichever is smaller.
Type of changes
Checklist
Description
Please describe your changes here. If this fixes a bug, please link to the issue, if possible.