simplify `python_version` markers by radoering · Pull Request #851 · python-poetry/poetry-core

radoering · 2025-03-14T16:06:45Z

Resolves: python-poetry/poetry#10249
Requires: python-poetry/poetry#10274

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

Summary by Sourcery

Tests:

Adds test cases to verify the correct simplification of python_version markers.

Summary by Sourcery

Tests:

Adds test cases to verify the correct simplification of python_version markers.

sourcery-ai · 2025-03-14T16:06:50Z

Reviewer's Guide by Sourcery

This pull request simplifies python_version markers by implementing logic to convert unions and intersections of single version markers into range markers where appropriate. It also includes new test cases to verify the correct simplification and addresses a potential combinatorial explosion issue.

Sequence diagram for union simplification of python_version markers

sequenceDiagram
  participant MultiMarker
  participant SingleMarker
  participant VersionRange

  MultiMarker->>SingleMarker: union(other: SingleMarker)
  SingleMarker->>SingleMarker: get_python_constraint_from_marker()
  SingleMarker->>VersionRange: allows_all(constraint)
  alt other_constraint.allows_all(constraint)
    SingleMarker-->>MultiMarker: return other
  else
    SingleMarker-->>MultiMarker: return None
  end

Sequence diagram for intersect simplification of python_version markers

sequenceDiagram
  participant MarkerUnion
  participant SingleMarker
  participant VersionRange

  MarkerUnion->>SingleMarker: intersect(other: SingleMarker)
  SingleMarker->>SingleMarker: get_python_constraint_from_marker()
  SingleMarker->>VersionRange: allows_all(other_constraint)
  alt constraint.allows_all(other_constraint)
    SingleMarker-->>MarkerUnion: return other
  else
    SingleMarker-->>MarkerUnion: return None
  end

Updated class diagram for BaseMarker and related classes

classDiagram
  class BaseMarker {
    +complexity: Tuple[int, int]
    +union(other: BaseMarker): BaseMarker | None
    +intersect(other: BaseMarker): BaseMarker | None
  }
  class MultiMarker {
    -markers: Set[BaseMarker]
    +of(*markers: BaseMarker): BaseMarker
  }
  class MarkerUnion {
    -markers: Set[BaseMarker]
    +of(*markers: BaseMarker): BaseMarker
  }
  class SingleMarkerLike {
    +name: str
    +constraint: Constraint
  }
  class SingleMarker {
    +name: str
    +constraint: Constraint
  }
  class AnyMarker
  class EmptyMarker

  BaseMarker <|-- MultiMarker
  BaseMarker <|-- MarkerUnion
  BaseMarker <|-- SingleMarkerLike
  SingleMarkerLike <|-- SingleMarker
  BaseMarker <|-- AnyMarker
  BaseMarker <|-- EmptyMarker

  MultiMarker *-- BaseMarker : contains
  MarkerUnion *-- BaseMarker : contains

  note for BaseMarker "Added union and intersect methods for simplification"
  note for MultiMarker "Added of method for simplification"
  note for MarkerUnion "Added of method for simplification"

File-Level Changes

Change	Details	Files
Added new test cases to verify the correct simplification of `python_version` markers.	Added test cases for equivalent ranges, ranges with the same start, adjacent ranges, overlapping ranges, and complex scenarios. Included tests for cases that previously caused endless recursion. Added a test case to address a real-world example from issue #10250, which involves complex intersections and potential combinatorial explosions.	`tests/version/test_markers.py`
Implemented simplification logic for `python_version` markers in `union_simplify` and `intersect_simplify` methods.	Added logic to `union_simplify` to convert unions of single `python_version` markers into a range marker when appropriate. Added logic to `intersect_simplify` to simplify intersections involving `python_version` markers. Modified `union_simplify` to handle cases where the union of unique markers results in a simple marker or a multi-marker with low complexity. Modified `intersect_simplify` to handle cases where the intersection of unique markers results in a simple marker or a multi-marker with low complexity.	`src/poetry/core/version/markers.py`
Implemented a utility function `_unique_product` to remove duplicates from itertools.product while maintaining order.	Added `_unique_product` function to filter out duplicate combinations of markers during CNF/DNF conversion to prevent combinatorial explosions.	`src/poetry/core/version/markers.py`
Updated test cases to reflect changes in `python_version` marker simplification.	Modified the expected marker string in `test_dependency_from_pep_508_with_python_version` to reflect the new simplification logic.	`tests/packages/test_main.py` `tests/packages/utils/test_utils.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:

It looks like you're converting python_version == "3.x" or python_version == "3.y" to python_version >= "3.x" and python_version < "3.(y+1)" - can you confirm this is the expected behavior?
It might be helpful to add a comment explaining the logic behind the changes in _merge_single_markers.

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟡 Complexity: 1 issue found
🟢 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.}

src/poetry/core/version/markers.py

radoering · 2025-03-14T16:17:17Z

It looks like you're converting python_version == "3.x" or python_version == "3.y" to python_version >= "3.x" and python_version < "3.(y+1)" - can you confirm this is the expected behavior?

More exactly, python_version == "3.x" or python_version == "3.(x+1)" is converted to python_version >= "3.x" and python_version < "3.(x+2)". This is expected behavior.

It might be helpful to add a comment explaining the logic behind the changes in _merge_single_markers.

Good point. I added a comment.

sourcery-ai

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

Overall Comments:

It looks like you're adding a lot of new tests, which is great, but some of them seem to have platform-specific conditions combined with python version, which might make them harder to read and maintain.
Consider adding a helper function to simplify the creation of MultiMarker instances in the tests, as there are several places where they are constructed manually.

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟡 Complexity: 1 issue found
🟢 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.}

src/poetry/core/version/markers.py

Improve recognization and merging of adjacent ranges.

… building the cnf/dnf (python-poetry#851)

sourcery-ai

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

Overall Comments:

It looks like you're adding a lot of new tests, which is great, but some of them seem to be testing the same scenarios - can you reduce the redundancy?
The change to test_dependency_from_pep_508_with_python_version in tests/packages/test_main.py seems related, but it's not immediately clear why it's needed - can you add a comment explaining the change?

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 · 2025-03-16T16:27:07Z

It looks like you're adding a lot of new tests, which is great, but some of them seem to be testing the same scenarios - can you reduce the redundancy?

Which tests are redundant?

The change to test_dependency_from_pep_508_with_python_version in tests/packages/test_main.py seems related, but it's not immediately clear why it's needed - can you add a comment explaining the change?

The change is necessary because otherwise the test will fail.

Improve recognization and merging of adjacent ranges.

sourcery-ai bot reviewed Mar 14, 2025

View reviewed changes

src/poetry/core/version/markers.py Show resolved Hide resolved

radoering force-pushed the simplify-python-version-markers branch from b10fdee to faad967 Compare March 14, 2025 16:15

radoering marked this pull request as draft March 14, 2025 16:35

radoering force-pushed the simplify-python-version-markers branch from faad967 to a6d12a4 Compare March 15, 2025 13:36

radoering mentioned this pull request Mar 15, 2025

tests: make tests forwards compatible with poetry-core#851 python-poetry/poetry#10274

Merged

radoering marked this pull request as ready for review March 15, 2025 14:00

sourcery-ai bot reviewed Mar 15, 2025

View reviewed changes

src/poetry/core/version/markers.py Show resolved Hide resolved

radoering marked this pull request as draft March 15, 2025 14:27

simplify python_version markers (python-poetry#851)

43005b1

Improve recognization and merging of adjacent ranges.

radoering added a commit to radoering/poetry-core that referenced this pull request Mar 16, 2025

perf: filter duplicates (and equivalents) from itertools.product when…

b365852

… building the cnf/dnf (python-poetry#851)

radoering force-pushed the simplify-python-version-markers branch from a6d12a4 to b365852 Compare March 16, 2025 15:41

perf: filter duplicates (and equivalents) from itertools.product when…

f984002

… building the cnf/dnf (python-poetry#851)

radoering force-pushed the simplify-python-version-markers branch from b365852 to f984002 Compare March 16, 2025 15:47

radoering marked this pull request as ready for review March 16, 2025 16:22

sourcery-ai bot reviewed Mar 16, 2025

View reviewed changes

radoering requested a review from a team March 16, 2025 16:29

Secrus approved these changes Mar 25, 2025

View reviewed changes

radoering merged commit 7ae0786 into python-poetry:main Mar 25, 2025
18 checks passed

radoering added a commit that referenced this pull request Mar 25, 2025

simplify python_version markers (#851)

3728038

Improve recognization and merging of adjacent ranges.

This was referenced Mar 29, 2025

release: bump version to 2.1.2 #854

Merged

release: bump version to 2.1.2 python-poetry/poetry#10311

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

simplify `python_version` markers#851

simplify `python_version` markers#851
radoering merged 2 commits intopython-poetry:mainfrom
radoering:simplify-python-version-markers

radoering commented Mar 14, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Mar 14, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Uh oh!

radoering commented Mar 14, 2025

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Uh oh!

sourcery-ai bot left a comment

Uh oh!

radoering commented Mar 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Conversation

radoering commented Mar 14, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by Sourcery

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

Sequence diagram for union simplification of python_version markers

Sequence diagram for intersect simplification of python_version markers

Updated class diagram for BaseMarker and related classes

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

radoering commented Mar 14, 2025

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

radoering commented Mar 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

radoering commented Mar 14, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Mar 14, 2025 •

edited

Loading