Skip to content

Comments

fix reduce_by_python_constraint for marker unions#846

Merged
radoering merged 1 commit intopython-poetry:mainfrom
radoering:fix-reduce-by-python-constraint-for-union
Mar 5, 2025
Merged

fix reduce_by_python_constraint for marker unions#846
radoering merged 1 commit intopython-poetry:mainfrom
radoering:fix-reduce-by-python-constraint-for-union

Conversation

@radoering
Copy link
Member

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

E.g. if the python constraint is >=3.9, reducing python_version >= "3.8" or sys_platform == "linux" should be AnyMarker (not sys_platform == "linux").

Resolves: python-poetry/poetry#10239
Related-to: python-poetry/poetry#10237

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

Summary by Sourcery

Bug Fixes:

  • Fixes an issue in reduce_by_python_constraint where marker unions were not correctly reduced when a python constraint was applied, resulting in incorrect marker evaluation.

@sourcery-ai
Copy link

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

Reviewer's Guide by Sourcery

This pull request fixes an issue in reduce_by_python_constraint where marker unions were not correctly reduced when the Python constraint allowed all Python versions specified in the union. The fix ensures that such markers are reduced to AnyMarker. Additionally, new test cases have been added to verify the corrected behavior.

Updated class diagram for Marker

classDiagram
    class Marker {
        +reduce_by_python_constraint(python_constraint: Constraint) Marker
    }
    Marker : Implements marker reduction logic
    note for Marker "Fixes an issue in `reduce_by_python_constraint` where marker unions were not correctly reduced when the Python constraint allowed all Python versions specified in the union."
Loading

File-Level Changes

Change Details Files
Improved the reduce_by_python_constraint function to correctly handle marker unions, ensuring that when the Python constraint allows all Python versions specified in the union, the entire marker is reduced to AnyMarker.
  • Modified the reduce_by_python_constraint function to return AnyMarker when the Python constraint allows all Python versions specified in a marker union.
  • Removed unnecessary conditional logic that preserved other markers when the Python constraint allowed all Python versions in the union.
 src/poetry/core/version/markers.py
Added new test cases to verify the correct behavior of reduce_by_python_constraint with marker unions and Python version constraints.
  • Added test cases to cover scenarios where a marker union should be reduced to an empty marker based on the Python constraint.
  • Added test cases to cover scenarios where a marker union contains platform-specific conditions combined with Python version constraints.
 tests/version/test_markers.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 2, 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:

  • The change in test_only from 'python_version >= "3.8"', "~3.8", "" to 'python_version == "3.8"', "~3.8", "" seems incorrect.
  • The logic in reduce_by_python_constraint could be simplified by returning AnyMarker() earlier if python_only_markers is empty.
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
radoering commented Mar 2, 2025
View reviewed changes
tests/version/test_markers.py
("<empty>", "~3.8", "<empty>"),
('sys_platform == "linux"', "~3.8", 'sys_platform == "linux"'),
('python_version >= "3.8"', "~3.8", ""),
('python_version == "3.8"', "~3.8", ""),
Copy link
Member Author

@radoering radoering Mar 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just changed this test because there is a duplicate of the original test some lines below.

radoering
radoering commented Mar 2, 2025
View reviewed changes
tests/version/test_markers.py
' or python_version >= "3.9" or sys_platform == "win32"'
),
"~3.7 || ~3.9",
'sys_platform == "linux" or sys_platform == "win32"',
Copy link
Member Author

@radoering radoering Mar 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed these test because with the fix they are not that intesting anymore because they are too similar to the test above.

This was referenced Mar 2, 2025
Merged
Closed
@radoering radoering requested a review from a team March 2, 2025 16:49
@radoering
fix reduce_by_python_constraint for marker unions
22edd5c 
E.g. if the python constraint is `>=3.9`, reducing `python_version >= "3.8" or sys_platform == "linux"` should result in `AnyMarker` (not `sys_platform == "linux"`).
@radoering radoering force-pushed the fix-reduce-by-python-constraint-for-union branch from 5859f41 to 22edd5c Compare March 5, 2025 18:54
@radoering radoering enabled auto-merge (squash) March 5, 2025 18:56
@radoering radoering merged commit 5209a79 into python-poetry:main Mar 5, 2025
18 checks passed
@ostefano ostefano mentioned this pull request Mar 12, 2025
Closed
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.

markers in poetry.lock are inaccurate

2 participants

@radoering @Secrus