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

perf: Iterate only once over properties when pruning record #2887

Merged

Conversation

edgarrmondragon
Copy link
Collaborator

@edgarrmondragon edgarrmondragon commented Feb 25, 2025

Summary by Sourcery

Enhancements:

  • Improved performance when pruning records by iterating only once over properties.

📚 Documentation preview 📚: https://meltano-sdk--2887.org.readthedocs.build/en/2887/

@edgarrmondragon edgarrmondragon self-assigned this Feb 25, 2025
Copy link
Contributor

sourcery-ai bot commented Feb 25, 2025

Reviewer's Guide by Sourcery

This pull request enhances the performance of the pop_deselected_record_properties function by iterating directly over the record's items instead of creating a list copy. This avoids unnecessary memory allocation and improves efficiency.

Sequence diagram for pop_deselected_record_properties function

sequenceDiagram
  participant CatalogHelper
  participant record

  CatalogHelper->>record: Iterate over record.copy().items()
  loop For each property_name, val in items
    CatalogHelper->>CatalogHelper: Check if property is selected
    alt not selected
      CatalogHelper->>record: Pop property from record
    end
  end
Loading

File-Level Changes

Change Details Files
Improved performance by iterating directly over record items instead of creating a list copy.
  • Replaced record.items() with record.copy().items() in the loop to avoid modifying the dictionary during iteration.
singer_sdk/helpers/_catalog.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

@edgarrmondragon edgarrmondragon changed the title refactor: Iterate only once over properties when pruning record perf: Iterate only once over properties when pruning record Feb 25, 2025
Copy link

codspeed-hq bot commented Feb 25, 2025

CodSpeed Performance Report

Merging #2887 will not alter performance

Comparing edgarrmondragon/refactor/iter-once-record-pop-properties (02951d6) with main (002d77b)

Summary

✅ 7 untouched benchmarks

Copy link

codecov bot commented Feb 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.33%. Comparing base (002d77b) to head (02951d6).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2887   +/-   ##
=======================================
  Coverage   91.33%   91.33%           
=======================================
  Files          62       62           
  Lines        5207     5207           
  Branches      675      675           
=======================================
  Hits         4756     4756           
  Misses        319      319           
  Partials      132      132           

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

@edgarrmondragon edgarrmondragon marked this pull request as ready for review February 25, 2025 15:23
@edgarrmondragon edgarrmondragon merged commit 57a9bb4 into main Feb 25, 2025
36 checks passed
@edgarrmondragon edgarrmondragon deleted the edgarrmondragon/refactor/iter-once-record-pop-properties branch February 25, 2025 15:23
@edgarrmondragon edgarrmondragon added this to the v0.45 milestone Feb 25, 2025
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 @edgarrmondragon - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider whether record.items() is safe instead of record.copy().items().
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant