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

Updated RandomSunFlare #2260

Merged
merged 1 commit into from
Jan 7, 2025
Merged

Updated RandomSunFlare #2260

merged 1 commit into from
Jan 7, 2025

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Jan 7, 2025

Summary by Sourcery

Remove deprecated angle_lower, angle_upper, num_flare_circles_lower, and num_flare_circles_upper parameters from RandomSunFlare. Use angle_range and num_flare_circles_range instead.

Enhancements:

  • Refactor RandomSunFlare to use range parameters for angle and number of flare circles.

Tests:

  • Update tests to reflect the changes in RandomSunFlare parameterization.

Copy link
Contributor

sourcery-ai bot commented Jan 7, 2025

Reviewer's Guide by Sourcery

This pull request refactors the RandomSunFlare class by removing deprecated parameters angle_lower, angle_upper, num_flare_circles_lower, and num_flare_circles_upper. These parameters are replaced by the angle_range and num_flare_circles_range tuple parameters. The update simplifies the class initialization and removes redundant logic.

Class diagram showing changes to RandomSunFlare class

classDiagram
    class RandomSunFlare {
        +flare_roi: tuple[float, float, float, float]
        +src_radius: int
        +src_color: tuple[int, ...]
        +angle_range: tuple[float, float]
        +num_flare_circles_range: tuple[int, int]
        +validate_parameters() Self
        +__init__(flare_roi, src_radius, src_color, angle_range, num_flare_circles_range)
    }
    note for RandomSunFlare "Removed deprecated parameters:
    - angle_lower
    - angle_upper
    - num_flare_circles_lower
    - num_flare_circles_upper"
Loading

File-Level Changes

Change Details Files
Removed deprecated parameters and updated usages
  • Removed deprecated parameters angle_lower, angle_upper, num_flare_circles_lower, and num_flare_circles_upper from RandomSunFlare class.
  • Replaced deprecated parameters with angle_range and num_flare_circles_range tuples.
  • Removed corresponding tests for deprecated parameters.
  • Updated validation logic to use the new tuple parameters.
  • Removed deprecation warnings related to the old parameters.
albumentations/augmentations/transforms.py
tests/test_transforms.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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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 @ternaus - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding new test cases that verify the current tuple-based parameters (angle_range, num_flare_circles_range) work correctly, even while removing tests for deprecated parameters.
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.

Copy link

codecov bot commented Jan 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.83%. Comparing base (b1a79c2) to head (4a296f1).
Report is 366 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##           main    #2260       +/-   ##
=========================================
+ Coverage      0   89.83%   +89.83%     
=========================================
  Files         0       50       +50     
  Lines         0     8895     +8895     
=========================================
+ Hits          0     7991     +7991     
- Misses        0      904      +904     
Flag Coverage Δ
ubuntu-py3.12 89.83% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ternaus ternaus merged commit b05b828 into main Jan 7, 2025
16 checks passed
@ternaus ternaus deleted the update_random_sunflare branch January 7, 2025 23:49
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.

1 participant