simplify extra markers

[radoering]

Without this change the intersection of extra == "a" and extra == "b" and extra == "a" or extra == "b" is extra == "a" and extra == "b" and (extra == "a" or extra == "b"). With the change, it is simplified to extra == "a" and extra == "b".

Related to: python-poetry/poetry#10195

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

Summary by Sourcery

Simplifies the intersection logic for union and multi constraints, particularly when dealing with extra markers, to produce cleaner and more concise expressions. Adds new test cases to ensure the correctness of the intersection logic.

Bug Fixes:

• Fixes an issue where intersecting union and multi constraints involving extra markers could result in unnecessarily complex expressions.

Tests:

• Adds test cases to verify the correct intersection of union and multi constraints with extra markers.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request simplifies the intersection logic for UnionConstraint and MultiConstraint objects in Poetry's constraint system. It prevents redundant constraints from being added to the result of an intersection, leading to more concise and efficient constraint representations. A helper function add_unseen_constraint was introduced to avoid adding duplicate or empty constraints. Tests were added to verify the correctness of the new intersection logic.

Sequence diagram for intersecting UnionConstraint and MultiConstraint

sequenceDiagram
  participant UC as UnionConstraint
  participant MC as MultiConstraint
  participant C1 as Constraint1
  participant C2 as Constraint2
  participant C3 as Constraint3

  UC->MC: intersect(other: MultiConstraint)
  loop for each our_constraint in UC
    UC->C1: our_constraint
    C1->C2: intersect(their_constraint)
    C2->C3: intersect(their_constraint)
    C1->UC: intersection
    UC->UC: add_unseen_constraint(intersection)
    alt intersection is not empty and not seen
      UC->UC: new_constraints.append(intersection)
    end
  end
  UC->MC: return new UnionConstraint(new_constraints)

Loading

Updated class diagram for UnionConstraint and MultiConstraint

classDiagram
  class BaseConstraint {
    <<Abstract>>
  }
  class UnionConstraint {
    -List~BaseConstraint~ _constraints
    +intersect(other: BaseConstraint): BaseConstraint
    -add_unseen_constraint(constraint: BaseConstraint): void
  }
  class MultiConstraint {
    -List~BaseConstraint~ constraints
    +intersect(other: BaseConstraint): BaseConstraint
  }
  class EmptyConstraint {
  }

  BaseConstraint <|-- UnionConstraint
  BaseConstraint <|-- MultiConstraint
  BaseConstraint <|-- EmptyConstraint
  UnionConstraint o-- BaseConstraint : contains
  MultiConstraint o-- BaseConstraint : contains
  note for UnionConstraint "The intersect method is updated to avoid duplicate constraints"
  note for UnionConstraint "The add_unseen_constraint method is added to avoid duplicate constraints"

Loading

File-Level Changes

Change	Details	Files
Implements a more efficient intersection for UnionConstraint and MultiConstraint objects, avoiding redundant constraints in the result.	Introduces a add_unseen_constraint helper function to prevent adding duplicate or empty constraints. Uses a seen_multi_constraints set to track MultiConstraint objects already added to the result. Simplifies the intersection logic to leverage the new helper function. Adds a test case to verify the intersection of extra == "a" and extra == "b" and extra == "a" or extra == "b" simplifies to extra == "a" and extra == "b".	src/poetry/core/constraints/generic/union_constraint.py tests/version/test_markers.py tests/constraints/generic/test_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

• 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:

• The add_unseen_constraint function is a good way to avoid code duplication.
• Consider extracting the intersection logic into a separate function for better readability.

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 ✨

• 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.}