improve performance for merging marker overrides - volume 2

[radoering]

Pull Request Check List

Related to: #9956

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

Testing with the pyproject.toml from #9956 (comment):

poetry version	lock (--no-update)
1.8	14.5 s
main	19.5 s
PR	17.5 s

Getting closer...

By the way, this PR increases the probability to get more concise markers as can be seen in the test case (or the mentioned pyproject.toml).

Summary by Sourcery

Tests:

• Add a test case for merging marker overrides with shortcut logic.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request improves the performance of merging marker overrides by adding a shortcut for cases where the markers are the same for all overrides. Additionally, it introduces a function to remove a marker from another marker, which helps to hit the performance shortcut more often.

Sequence diagram for improved marker override merging

sequenceDiagram
    participant Solver
    participant MergeOverride
    participant RemoveMarker

    Solver->>MergeOverride: merge_override_packages()
    Note over MergeOverride: Process each package
    loop For each package override
        MergeOverride->>RemoveMarker: remove_other_from_marker()
        RemoveMarker-->>MergeOverride: simplified marker
    end
    Note over MergeOverride: Check if markers are same
    alt Markers are same
        Note over MergeOverride: Use performance shortcut
    else Markers differ
        Note over MergeOverride: Use fallback algorithm
    end
    MergeOverride-->>Solver: merged packages

Loading

File-Level Changes

Change	Details	Files
Added a test case for the performance shortcut.	Added a new test case test_merge_override_packages_shortcut to verify the new shortcut logic.	tests/puzzle/test_solver_internals.py
Implemented a performance shortcut for merging marker overrides.	Added a check to see if all markers are the same for all overrides. If the markers are the same, use a less expensive marker operation. Modified the loop to iterate over the remaining packages instead of all of them.	src/poetry/puzzle/solver.py
Added a function to remove a marker from another marker.	Added a new function remove_other_from_marker to remove a marker from another marker. This function is used to increase the probability of hitting the performance shortcut.	src/poetry/puzzle/solver.py
Use the new remove_other_from_marker function to remove the override marker from the marker.	Call remove_other_from_marker to remove the override marker from the marker before merging.	src/poetry/puzzle/solver.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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

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

Overall Comments:

• Please add documentation for the marker simplification optimization, as it changes how markers are generated and could affect downstream users.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟡 Testing: 1 issue found
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}