Skip to content

fix calculation of override markers when merging override packages #10240

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

Conversation

radoering
Copy link
Member

@radoering radoering commented Mar 2, 2025

Pull Request Check List

Related to: #10237
(Fixes the example of the OP but to fix the issue in general both, this PR and python-poetry/poetry-core#846, are required.)

  • Added tests for changed code.
  • Updated documentation for changed code.

Summary by Sourcery

Tests:

  • Adds a test case to verify the correct marker generation based on the project's Python constraint.

Copy link

sourcery-ai bot commented Mar 2, 2025

Reviewer's Guide by Sourcery

This pull request fixes the calculation of override markers when merging override packages. It modifies the merge_override_packages function to accept a python_constraint parameter and simplify the override marker by intersecting it with the project's Python constraint. A new test case has been added to verify the correct calculation of override markers, taking into account the project's Python constraint.

Sequence diagram for merging override packages

sequenceDiagram
  participant Solver
  participant merge_override_packages
  Solver->>merge_override_packages: override_packages, python_constraint
  merge_override_packages->>merge_override_packages: Intersect dependency markers
  merge_override_packages->>merge_override_packages: Simplify marker with python_constraint
  merge_override_packages-->>Solver: result
Loading

File-Level Changes

Change Details Files
Modified the merge_override_packages function to accept a python_constraint parameter and simplify the override marker by intersecting it with the project's Python constraint.
  • Modified the merge_override_packages function signature to accept a python_constraint parameter.
  • Simplified the override_marker by intersecting it with the project's Python constraint using the simplify_marker function.
  • Added python_constraint parameter to the call of merge_override_packages in _solve_in_compatibility_mode.
src/poetry/puzzle/solver.py
Added a new test case to verify the correct calculation of override markers when merging override packages, taking into account the project's Python constraint.
  • Added a new test case test_merge_override_packages_python_constraint to verify the correct calculation of override markers based on the project's Python constraint.
  • Added parametrization to the new test case to cover different Python constraint scenarios.
  • Added parse_constraint to multiple tests.
tests/puzzle/test_solver_internals.py

Possibly linked issues

  • Buggy dependency resolution with poetry v2 #10237: The PR fixes the issue where extra markers are ignored when re-resolve is false, by correctly calculating override markers during package merging. This directly addresses the root cause of the bug described in the issue.

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

@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 might be worth adding a comment to merge_override_packages explaining why the python constraint is needed.
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 review from a team and removed request for a team March 2, 2025 17:40
@radoering radoering force-pushed the fix-merge-override-packages-override-marker branch from 4cf319b to 7e1d753 Compare March 4, 2025 04:58
@radoering radoering requested a review from a team March 4, 2025 05:24
@radoering radoering force-pushed the fix-merge-override-packages-override-marker branch from 7e1d753 to ecedf30 Compare March 5, 2025 04:43
@radoering radoering merged commit a01afef into python-poetry:main Mar 5, 2025
53 checks passed
Copy link

github-actions bot commented Apr 5, 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 5, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants