Skip to content

Comments

fix enriching [project.optional-dependencies]#857

Merged
radoering merged 1 commit intopython-poetry:mainfrom
radoering:fix-enrich-optional-dependencies
Apr 24, 2025
Merged

fix enriching [project.optional-dependencies]#857
radoering merged 1 commit intopython-poetry:mainfrom
radoering:fix-enrich-optional-dependencies

Conversation

@radoering
Copy link
Member

@radoering radoering commented Apr 12, 2025 •
edited by sourcery-ai bot
Loading

Resolves: python-poetry/poetry#10331

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

Summary by Sourcery

Fix dependency enrichment process to correctly preserve optional dependencies and extras

Bug Fixes:

  • Ensure that optional dependencies and their extras are correctly maintained during dependency enrichment process

Enhancements:

  • Improved dependency enrichment logic to handle optional dependencies and extras more accurately

Tests:

  • Added test cases to verify preservation of optional dependencies and extras during dependency group operations

@sourcery-ai
Copy link

sourcery-ai bot commented Apr 12, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request fixes an issue where optional dependencies and their extras were not being correctly handled during dependency enrichment. The changes ensure that the optional and in_extras properties are preserved when creating new dependencies, and that extras are not duplicated.

Sequence diagram for enriching dependency

sequenceDiagram
    participant DependencyGroup
    participant Dependency
    participant PoetryDependency
    participant ProjectDependency

    DependencyGroup->>DependencyGroup: _enrich_dependency(project_dependency, poetry_dependency, constraint, marker)
    alt poetry_dependency is None
        DependencyGroup->>ProjectDependency: with_features(project_dependency.features)
        ProjectDependency-->>DependencyGroup: dependency
        DependencyGroup->>dependency: _optional = project_dependency.is_optional()
        DependencyGroup->>dependency: _in_extras = project_dependency.in_extras
    end
    DependencyGroup->>Dependency: constraint = constraint
    DependencyGroup->>Dependency: marker = marker
Loading

Updated class diagram for Dependency

classDiagram
    class Dependency {
        - _in_extras: list[str]
        - _optional: bool
        + marker(marker: str | BaseMarker) : void
    }
    note for Dependency._in_extras "List of extras the dependency is in"
    note for Dependency._optional "Whether the dependency is optional"
Loading

File-Level Changes

Change Details Files
Ensured that optional dependencies and their associated extras are correctly handled when enriching dependencies.
  • Added test cases to verify the correct handling of optional dependencies and extras during dependency enrichment.
  • Modified the _enrich_dependency method in DependencyGroup to preserve the optional and in_extras properties from the project dependency when creating a new dependency.
  • Modified the marker method in Dependency to avoid duplicating extras.
 tests/packages/test_dependency_group.py
src/poetry/core/packages/dependency.py
src/poetry/core/packages/dependency_group.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 Apr 12, 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 modifying _in_extras in multiple places; consider consolidating this logic into a single helper function.
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 fix-enrich-optional-dependencies branch from ac29f1a to 006d07e Compare April 12, 2025 15:02
@radoering radoering requested a review from a team April 21, 2025 15:43
Secrus
Secrus reviewed Apr 23, 2025
View reviewed changes
@radoering radoering force-pushed the fix-enrich-optional-dependencies branch from 006d07e to 1bb2555 Compare April 24, 2025 03:44
@radoering radoering merged commit 6eacbbb into python-poetry:main Apr 24, 2025
18 checks passed
This was referenced May 4, 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.

Optional dependencies are treated as non-optional if a source is specified for them

2 participants

@radoering @Secrus