Skip to content

Comments

improve reduce_by_python_constraint#841

Merged
radoering merged 1 commit intopython-poetry:mainfrom
radoering:improve-reduce-by-python-constraint
Feb 23, 2025
Merged

improve reduce_by_python_constraint#841
radoering merged 1 commit intopython-poetry:mainfrom
radoering:improve-reduce-by-python-constraint

Conversation

@radoering
Copy link
Member

@radoering radoering commented Feb 22, 2025 •
edited by sourcery-ai bot
Loading

Related to: python-poetry/poetry#10195

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

Summary by Sourcery

This pull request enhances the reduce_by_python_constraint function to improve its accuracy when dealing with Python version constraints. It also adds new test cases to ensure the correctness of the changes.

Enhancements:

  • Improves the reduce_by_python_constraint function to better handle version constraints, especially when intersecting with python_version markers.

Tests:

  • Adds new test cases to cover the improved logic for reducing markers based on Python version constraints.

@sourcery-ai
Copy link

sourcery-ai bot commented Feb 22, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request enhances the reduce_by_python_constraint method in poetry.core.version.markers.py to improve its ability to reduce markers based on Python version constraints. The changes include handling cases where the marker's constraint is fully outside the Python constraint, and implementing intersection logic to refine the marker. Additionally, new test cases have been added to ensure the correctness of the updated logic.

Sequence diagram for reduce_by_python_constraint method

sequenceDiagram
  participant Marker as M
  participant VersionConstraint as VC
  M->>M: reduce_by_python_constraint(python_constraint: VC)
  alt self.name in PYTHON_VERSION_MARKERS
    M->>M: get_python_constraint_from_marker()
    M->>VC: allows_any(python_constraint)
    alt not constraint.allows_any(python_constraint)
      M-->>M: return EmptyMarker()
    else constraint.allows_any(python_constraint)
      M->>M: create_nested_marker("python_version", python_constraint)
      M->>M: parse_marker()
      M->>M: intersect(python_marker)
      alt isinstance(intersection, SingleMarker)
        M-->>M: return intersection
      end
    end
  end
  M-->>M: return self
Loading

File-Level Changes

Change Details Files
Improved the reduce_by_python_constraint method to better handle version constraints and intersections with Python version markers.
  • Added logic to handle cases where the marker's constraint is fully outside the Python constraint, resulting in an EmptyMarker.
  • Implemented intersection logic to refine the marker based on the Python constraint, returning a SingleMarker when appropriate.
  • Added a test case for when the marker's constraint is fully outside the Python constraint.
  • Added test cases for when the marker's constraint is equal to or less than the Python constraint.
  • Modified test cases to reflect the new logic.
 tests/version/test_markers.py
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

sourcery-ai[bot]
sourcery-ai bot reviewed Feb 22, 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:

  • It looks like you're importing create_nested_marker twice - you only need to import it once.
  • Consider adding a comment explaining the logic behind intersecting with python_marker.
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 force-pushed the improve-reduce-by-python-constraint branch from cacc856 to 5e46abc Compare February 23, 2025 05:47
@radoering radoering merged commit db5b8d4 into python-poetry:main Feb 23, 2025
18 checks passed
@radoering radoering mentioned this pull request Feb 23, 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

@abn abn abn 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.

2 participants

@radoering @abn