Skip to content

fix --directory for plugins that access the poetry instance during activation #10352

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

Merged

Conversation

radoering
Copy link
Member

@radoering radoering commented Apr 20, 2025

Pull Request Check List

Resolves: nat-n/poethepoet#288

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

Summary by Sourcery

Fix the --directory option for plugins that access the Poetry instance during activation

Bug Fixes:

  • Resolve an issue where plugins accessing the Poetry instance during activation would fail when using the --directory option

Enhancements:

  • Modify the plugin loading process to ensure correct working directory context during plugin activation

Tests:

  • Add test cases to verify the correct behavior of the --directory option with plugins that access the Poetry instance early

Copy link

sourcery-ai bot commented Apr 20, 2025

Reviewer's Guide by Sourcery

This pull request fixes an issue where plugins that access the Poetry instance during activation would fail when using a relative --directory option. The fix involves loading plugins before changing the working directory and patching metadata.entry_points to allow filtering by group. A new test case has been added to verify the fix.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a test case to verify that plugins can access the Poetry instance during activation with a relative --directory option.
  • Added a new command CheckProjectPathCommand for testing purposes.
  • Created a plugin EarlyPoetryAccessPlugin that accesses the Poetry instance during activation.
  • Added a fixture with_early_poetry_access_plugin to mock the plugin.
  • Added a fixture relative_project_source_directory to create a relative path to the project directory.
  • Implemented a test case test_application_with_relative_directory_parameter_and_early_poetry_access_plugin to verify the fix.
tests/console/test_application_global_options.py
Patched metadata.entry_points to allow filtering by group.
  • Modified mock_metadata_entry_points to filter entry points by group, preventing conflicts when multiple plugins define entry points with the same name.
tests/helpers.py
Load plugins before changing the working directory.
  • Moved the _load_plugins call before the with directory(self._working_directory) block to ensure plugins are loaded with the correct project context.
src/poetry/console/application.py
Added group attribute to InvalidPlugin class.
  • Added group = "poetry.plugin" to the InvalidPlugin class to fix a bug where the plugin manager would not load the plugin.
tests/plugins/test_plugin_manager.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:

  • It might be worth adding a comment explaining why the entry_points mock needs to be patched in tests/helpers.py.
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-directory-option-with-plugins branch from 8cffb39 to 03926ce Compare April 27, 2025 15:53
@radoering radoering enabled auto-merge (squash) April 27, 2025 15:53
@radoering radoering merged commit 297ae7d into python-poetry:main Apr 27, 2025
53 checks passed
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.

poethepoet breaks poetry check with -C / --directory
2 participants