Skip to content

make complex marker unions and intersections deterministic #843

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

Merged
merged 1 commit into from
Feb 28, 2025

Conversation

radoering
Copy link
Member

@radoering radoering commented Feb 23, 2025

Requires: #842

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

Summary by Sourcery

This pull request makes complex marker unions and intersections deterministic by preventing duplicate constraints and improving performance.

Enhancements:

  • Ensures that marker unions and intersections are deterministic by avoiding duplicate constraints when intersecting union constraints.
  • Improves the performance of marker operations by using generators instead of sets to determine unique markers.

Tests:

  • Adds a test to ensure that complex marker unions are deterministic, preventing sporadic test failures.

Copy link

sourcery-ai bot commented Feb 23, 2025

Reviewer's Guide by Sourcery

This pull request aims to make complex marker unions and intersections deterministic. This is achieved by ensuring that the order of constraints in the resulting markers is consistent, preventing sporadic test failures and ensuring predictable behavior.

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

File-Level Changes

Change Details Files
Ensured deterministic behavior for marker unions and intersections by maintaining a consistent order of constraints.
  • Modified union_simplify and intersect_simplify methods in markers.py to use generators instead of sets when calculating unique markers, preserving the original order of markers.
  • Introduced a add_unseen_constraint helper function to avoid adding duplicate constraints during intersection.
  • Added a test case test_complex_union_is_deterministic to verify the deterministic behavior of complex marker unions.
  • Added a test case to verify intersection between ExtraMultiConstraint and UnionConstraint.
tests/version/test_markers.py
src/poetry/core/constraints/generic/union_constraint.py
src/poetry/core/version/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

@radoering radoering force-pushed the deterministic-marker-union branch from 93d1162 to 04ec72c Compare February 23, 2025 20:38
@radoering radoering marked this pull request as ready for review February 23, 2025 20:38
@radoering radoering requested a review from a team February 23, 2025 20:41
@radoering radoering force-pushed the deterministic-marker-union branch 2 times, most recently from 4d362cb to 0ece14f Compare February 27, 2025 16:32
@radoering radoering force-pushed the deterministic-marker-union branch from 0ece14f to af7a885 Compare February 28, 2025 04:55
@radoering radoering merged commit 369f5a9 into python-poetry:main Feb 28, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants