Skip to content
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

fix reduce_by_python_constraint #824

Merged
merged 1 commit into from
Jan 24, 2025

Conversation

radoering
Copy link
Member

@radoering radoering commented Jan 24, 2025

This fixes a bug that caused incorrect markers to be written into the lock file. See python-poetry/poetry-plugin-export#319.

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

Looks like I forgot that python_marker is special so that you cannot just use its constraint...

Summary by Sourcery

Bug Fixes:

  • Fix incorrect markers being written to the lock file when reducing markers by Python constraints.

This fixes a bug that caused incorrect markers to be written into the lock file. See poetry-plugin-export#319.
Copy link

sourcery-ai bot commented Jan 24, 2025

Reviewer's Guide by Sourcery

This pull request fixes a bug in the reduce_by_python_constraint function that caused incorrect markers to be written into the lock file. The fix ensures that the python_marker is correctly handled when reducing markers by a python constraint.

Sequence diagram for reduce_by_python_constraint marker handling

sequenceDiagram
    participant M as Marker
    participant R as reduce_by_python_constraint
    participant U as Utils

    M->>R: reduce_by_python_constraint(python_constraint)
    alt python version marker
        R->>U: get_python_constraint_from_marker(marker)
        U-->>R: constraint
        alt constraint allows all python_constraint
            R-->>M: AnyMarker()
        else constraint allows none of python_constraint
            R-->>M: EmptyMarker()
        else
            R-->>M: original marker
        end
    else
        R-->>M: original marker
    end
Loading

Class diagram for marker handling

classDiagram
    class BaseMarker {
        +reduce_by_python_constraint(python_constraint: VersionConstraint)
    }
    class SingleMarker {
        -name: str
        -constraint: VersionConstraint
        +reduce_by_python_constraint(python_constraint: VersionConstraint)
    }
    class MultiMarker {
        -markers: List[BaseMarker]
        +reduce_by_python_constraint(python_constraint: VersionConstraint)
    }
    class AnyMarker {
    }
    class EmptyMarker {
    }

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

    note for SingleMarker "Fixed to use get_python_constraint_from_marker"
    note for MultiMarker "Updated to handle VersionRange"
Loading

File-Level Changes

Change Details Files
Correctly handle python_marker when reducing markers by a python constraint.
  • Use get_python_constraint_from_marker to get the correct constraint from the marker.
  • Check if the constraint allows all or any of the python constraint.
src/poetry/core/version/markers.py
Add test cases for reduce_by_python_constraint.
  • Add test cases for python_version and python_full_version markers.
  • Add test cases for complex markers with or and and operators.
tests/version/test_markers.py
Handle VersionRange and VersionUnion types in reduce_by_python_constraint.
  • Check if the python_constraint is an instance of VersionRange or VersionUnion.
src/poetry/core/version/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

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:

  • Please add documentation describing the fix and expected behavior for Python version constraint handling in markers. This will help users understand how version constraints are processed, especially since this fixes a bug in lock file generation.
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.

@abn abn merged commit 4e7c384 into python-poetry:main Jan 24, 2025
18 checks passed
@radoering radoering mentioned this pull request Feb 9, 2025
3 tasks
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