Skip to content

fix error handling for git dependencies #10366

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 May 1, 2025

Pull Request Check List

Closes: #10340

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

Summary by Sourcery

Improve error handling and package installation for git and directory dependencies in Poetry's installation executor

Bug Fixes:

  • Fixed error handling for git dependencies during package installation
  • Improved source URL handling for different package source types
  • Ensured correct package information is displayed during installation errors

Enhancements:

  • Extended test coverage for different package source types (directory and git)
  • Added more robust error handling in archive preparation

Tests:

  • Added parametrized tests for different package source types
  • Expanded test scenarios for installation error reporting

Copy link

sourcery-ai bot commented May 1, 2025

Reviewer's Guide

This pull request improves error reporting for Git dependencies during installation by differentiating between Git and directory sources when constructing installation commands and formatting output messages. It also ensures the original Git URL is used in error messages even if the archive preparation step fails.

File-Level Changes

Change Details Files
Updated installation logic to handle Git dependencies correctly.
  • Modified editable install command generation to use the correct Git URL format (git+https://...#egg=...).
  • Added error handling during Git archive preparation to reset the source URL, ensuring correct error reporting if preparation fails.
src/poetry/installation/executor.py
Enhanced test coverage for build errors.
  • Parametrized the build backend error test to run for both 'directory' and 'git' source types.
  • Updated test assertions to correctly reflect the expected output format for Git dependencies, including using the resolved reference (commit hash) in messages.
  • Adjusted test setup to handle package details specific to Git sources (URL, resolved reference, pip requirements).
tests/installation/test_executor.py

Possibly linked issues


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

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 and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 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-git-dependency-error-handling branch from 37d32f4 to 9b893bf Compare May 1, 2025 08:42
@radoering radoering requested a review from a team May 1, 2025 08:58
@radoering radoering force-pushed the fix-git-dependency-error-handling branch from 9b893bf to c0cb1f9 Compare May 2, 2025 17:44
@radoering radoering enabled auto-merge (squash) May 2, 2025 17:45
@radoering radoering merged commit b739891 into python-poetry:main May 2, 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.

2 participants