Skip to content

Comments

provider: do not iterate over sets for more deterministic results#10276

Merged
radoering merged 1 commit intopython-poetry:mainfrom
radoering:deterministic-extras
Mar 25, 2025
Merged

provider: do not iterate over sets for more deterministic results#10276
radoering merged 1 commit intopython-poetry:mainfrom
radoering:deterministic-extras

Conversation

@radoering
Copy link
Member

@radoering radoering commented Mar 15, 2025 •
edited by sourcery-ai bot
Loading

Remove potential sources of non-determinism.

Summary by Sourcery

Enhancements:

  • Sorts the iteration of sets to ensure deterministic results.

@sourcery-ai
Copy link

sourcery-ai bot commented Mar 15, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request addresses potential non-deterministic behavior in the solver by sorting sets before iterating over them. Specifically, it sorts the extras attribute of dependencies in the _search_for_url and complete_package methods within the provider. Additionally, the with_features method in DependencyPackage was updated to accept any iterable of strings instead of only lists.

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

File-Level Changes

Change Details Files
Ensured deterministic iteration order for extras in the _search_for_url method.
  • Sorted the dependency.extras set before iterating over it.
 src/poetry/puzzle/provider.py
Ensured deterministic iteration order for extras in the complete_package method.
  • Sorted the dependency.extras set before converting it to a list and assigning it to the stack variable.
  • Sorted the extra_dependency.extras set before converting it to a list and adding it to the stack variable.
 src/poetry/puzzle/provider.py
Updated the with_features method to accept an iterable of strings instead of a list.
  • Changed the type hint for the features parameter in the with_features method to Iterable[str].
 src/poetry/packages/dependency_package.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

sourcery-ai[bot]
sourcery-ai bot reviewed Mar 15, 2025
View reviewed changes
Copy link

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

Overall Comments:

  • It's great to see efforts to ensure deterministic behavior in the solver.
  • Consider adding a comment explaining why sorting is necessary for these specific iterations.
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.

@radoering radoering requested a review from a team March 15, 2025 18:40
@radoering radoering force-pushed the deterministic-extras branch from 8f70f66 to f53a1eb Compare March 20, 2025 17:01
Secrus
Secrus approved these changes Mar 25, 2025
View reviewed changes
Copy link
Member

@Secrus Secrus left a comment

Choose a reason for hiding this comment

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

Just a small question, otherwise LGTM

@radoering radoering force-pushed the deterministic-extras branch from f53a1eb to fb3643d Compare March 25, 2025 17:04
@radoering radoering enabled auto-merge (squash) March 25, 2025 17:05
@radoering radoering merged commit b7b1cf5 into python-poetry:main Mar 25, 2025
53 checks passed
@radoering radoering mentioned this pull request Mar 29, 2025
Merged
@heidimhurst heidimhurst mentioned this pull request Apr 22, 2025
Open
@github-actions
Copy link

github-actions bot commented Apr 25, 2025

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 25, 2025
@radoering radoering deleted the deterministic-extras branch December 13, 2025 17:12
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@Secrus Secrus Secrus approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@radoering @Secrus