Skip to content

Comments

fix: ensure_project_plugins is not called when --no-plugins flag is true#10405

Merged
radoering merged 1 commit intopython-poetry:mainfrom
dfavato:fix-install-ensure-plugins
May 22, 2025
Merged

fix: ensure_project_plugins is not called when --no-plugins flag is true#10405
radoering merged 1 commit intopython-poetry:mainfrom
dfavato:fix-install-ensure-plugins

Conversation

@dfavato
Copy link
Contributor

@dfavato dfavato commented May 20, 2025 •
edited by sourcery-ai bot
Loading

Pull Request Check List

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

This PR fixes when the user wants to run poetry install but does not want to install the plugins.

Many poetry plugins (shell, export, ...) are usually intended for development environments only. Ensuring plugin installation whenever poetry install is run means that all environments need to be compatible, not only with project dependencies, but also with plugins (which might not always be the case).

For instance, I'm trying to install a project in Databricks, but I can't because the plugin is incompatible.
image

However, if I manually edit the pyproject.toml and remove the plugins, I can install it.
image

Currently, the --no-plugins documentation is minimal; however, in IMHO, --no-plugins should prevent the installation.

Summary by Sourcery

Modify the installer command to skip plugin setup when the --no-plugins flag is used

Bug Fixes:

  • Respect the --no-plugins flag by not calling PluginManager.ensure_project_plugins during install

Tests:

  • Add parameterized test to verify ensure_project_plugins is called only when plugins are enabled

@sourcery-ai
Copy link

sourcery-ai bot commented May 20, 2025 •
edited
Loading

Reviewer's Guide

Adds conditional plugin installation controlled by the --no-plugins flag and updates the corresponding test to verify this behavior.

Sequence diagram: Conditional call to PluginManager.ensure_project_plugins()

sequenceDiagram
    participant IC as InstallCommand
    participant PM as PluginManager

    IC->>IC: Check self.option("no-plugins")
    alt --no-plugins is false
        IC->>PM: ensure_project_plugins(poetry, io)
        activate PM
        PM-->>IC: Plugins ensured
        deactivate PM
    else --no-plugins is true
        IC->>IC: Skip plugin installation
    end
Loading

File-Level Changes

Change Details Files
Guard plugin installation with --no-plugins option
  • Wrap call to PluginManager.ensure_project_plugins in an if-check for the no-plugins flag
 src/poetry/console/commands/install.py
Parameterize and adjust test for plugin installation behavior
  • Add pytest.mark.parametrize for options and expected call counts
  • Pass the options string to tester.execute instead of a hardcoded empty string
  • Replace ensure_project_plugins.assert_called_once with a call_count assertion
 tests/console/commands/test_install.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!

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 May 20, 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 @dfavato - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: 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 approved these changes May 22, 2025
View reviewed changes
Copy link
Member

@radoering radoering left a comment

Choose a reason for hiding this comment

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

makes sense

@radoering radoering merged commit 85f997b into python-poetry:main May 22, 2025
53 checks passed
@github-actions
Copy link

github-actions bot commented Jun 22, 2025

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 22, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@radoering radoering radoering 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

@dfavato @radoering