Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

There would be one case where this wouldn't work #768

Merged
merged 1 commit into from
Feb 10, 2025
Merged

Conversation

ericcurtin
Copy link
Collaborator

@ericcurtin ericcurtin commented Feb 8, 2025

When accumulated_size has just been refreshed to zero

Summary by Sourcery

Bug Fixes:

  • Fix an edge case where the download progress was not being updated correctly when the total downloaded size was a multiple of the read buffer size.

Copy link
Contributor

sourcery-ai bot commented Feb 8, 2025

Reviewer's Guide by Sourcery

This pull request addresses an edge case in the download progress update logic by introducing a new variable ('size') to handle scenarios where accumulated_size has been reset to zero. The change refactors the condition in the progress update check to rely on the new 'size' variable.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Introduce a new variable to correctly handle progress update checks after accumulated_size is reset.
  • Added a new variable 'size' initialized to 0 at the start of the download loop.
  • Modified the condition in the progress update to check 'if size:' instead of 'if accumulated_size:' to handle the specific edge case.
ramalama/http_client.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ericcurtin - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The final condition checks 'if size' but 'size' is never updated, suggesting an unintended switch from accumulated_size to size.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ericcurtin ericcurtin force-pushed the progress-bar-2 branch 2 times, most recently from 2f9b998 to 2956111 Compare February 8, 2025 13:00
if accumulated_size:
self.update_progress(accumulated_size)
if do_final_progress:
if accumulated_size:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes no sense, to add the option.

Why not do

if accumulated_size > 0:

You reset the accumalated_size option right after the do_final_progress.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm trying to remember what I was fixing here. I'll change this to a one-liner:

if accumulated_size > 0:

like you suggested, although that shouldn't make a difference either.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah it's the "\033[K" outside the if block that's the main fix...

I dislike python's indenting as '{' '}' sometimes, makes things like this not so obvious :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait sorry this does make sense... It's just not clear, I'll do it a different way that's more clear

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So you can break out with if not data: when you have accumalated size and do not want to update_progress?

When accumulated_size has just been refreshed to zero. Also check
size is greater than zeor to avoid division by zero.

Signed-off-by: Eric Curtin <[email protected]>
@rhatdan
Copy link
Member

rhatdan commented Feb 10, 2025

LGTM

Much better.

Merge when tests pass.

@rhatdan rhatdan merged commit c86dbaa into main Feb 10, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants