Skip to content

Comments

simplify extra markers 3#847

Merged
radoering merged 1 commit intopython-poetry:mainfrom
radoering:simplify-extra-marker3
Mar 13, 2025
Merged

simplify extra markers 3#847
radoering merged 1 commit intopython-poetry:mainfrom
radoering:simplify-extra-marker3

Conversation

@radoering
Copy link
Member

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

With this change unions of multi markers and intersections of union markers where one marker is the subset of the other are simplified.

Related to: python-poetry/poetry#10195

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

Summary by Sourcery

Tests:

  • Adds tests for the changed code.

@sourcery-ai
Copy link

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

Reviewer's Guide by Sourcery

This pull request simplifies extra markers by implementing optimizations for unions of multi markers and intersections of union markers. The changes involve modifying the intersect method in UnionConstraint and the union method in MultiConstraint to handle subset relationships between constraints. New tests were added to ensure the correctness of the changes.

Sequence diagram for intersecting UnionConstraint with another UnionConstraint

sequenceDiagram
  participant UC1 as UnionConstraint (A or B)
  participant UC2 as UnionConstraint (A or B or C)
  UC1->>UC2: intersect(UC1)
  UC2->>UC2: our_constraints.issubset(their_constraints) is true
  UC2-->>UC1: return self (UC1)

  participant UC3 as UnionConstraint (A or B)
  participant UC4 as UnionConstraint (A or B or C)
  UC4->>UC3: intersect(UC4)
  UC3->>UC3: their_constraints.issubset(our_constraints) is true
  UC3-->>UC4: return other (UC4)
Loading

Sequence diagram for intersecting UnionConstraint with a MultiConstraint

sequenceDiagram
  participant UC as UnionConstraint (A or B)
  participant MC as MultiConstraint (A and D)
  UC->>MC: intersect(UC)
  loop for each constraint in UC
    UC->>MC: intersection = our_constraint
    loop for each constraint in MC
      UC->>MC: intersection = intersection.intersect(their_constraint)
    end
  end
  UC-->>MC: return new UnionConstraint
Loading

Updated class diagram for MultiConstraint

classDiagram
    class MultiConstraint {
        -constraints: list[BaseConstraint]
        +intersect(other: BaseConstraint): BaseConstraint
        +union(other: BaseConstraint): BaseConstraint
        + __bool__() : bool
    }

    MultiConstraint -- BaseConstraint : contains
Loading

File-Level Changes

Change Details Files
Simplified unions of multi markers and intersections of union markers where one marker is the subset of the other.
  • Added logic to UnionConstraint.intersect to return the smaller union when intersecting two unions where one is a subset of the other.
  • Added logic to MultiConstraint.union to return the larger multi-constraint when unioning two multi-constraints where one is a subset of the other.
  • Added tests for the new logic in test_markers.py and test_constraint.py.
 tests/version/test_markers.py
tests/constraints/generic/test_constraint.py
src/poetry/core/constraints/generic/union_constraint.py
src/poetry/core/constraints/generic/multi_constraint.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 6, 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 might be helpful to add a comment explaining the logic behind the simplification rules.
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 ✨
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 6, 2025 17:06
@radoering
simplify extra markers 3
c3d0c9f 
With this change unions of multi markers and intersections of union markers where one marker is the subset of the other are simplified.
@radoering radoering force-pushed the simplify-extra-marker3 branch from 44fd5e7 to c3d0c9f Compare March 11, 2025 14:04
@radoering radoering merged commit 629a794 into python-poetry:main Mar 13, 2025
18 checks passed
This was referenced Mar 29, 2025
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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