Show Python path for Poetry in `debug info` by jaredahern · Pull Request #10588 · python-poetry/poetry

jaredahern · 2025-10-19T23:30:24Z

Pull Request Check List

Resolves: #10559

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

Summary

Adds the executable and environment path for the Python executable running Poetry to poetry self debug.

I believe the sys calls are correct, but happy to adjust as needed. Also, I did not see any docs that required updating.

Summary by Sourcery

Include the Python environment path and executable in the output of poetry self debug.

Enhancements:

Add 'Path' and 'Executable' fields under the Poetry section in debug info
Adjust label alignment for Version and Python fields

Tests:

Add tests to verify the display of Poetry's path and executable in debug info

sourcery-ai · 2025-10-19T23:30:29Z

Reviewer's Guide

Extends the poetry self debug info command to include the Poetry interpreter’s environment path and executable (using sys.prefix and sys.executable), updates output alignment, and adds tests verifying the enhanced debug output.

Sequence diagram for enhanced debug info output in handle()

sequenceDiagram
    participant User as actor User
    participant DebugInfoCommand
    participant sys
    participant Poetry
    User->>DebugInfoCommand: invoke handle()
    DebugInfoCommand->>Poetry: get VERSION
    DebugInfoCommand->>sys: get python version
    DebugInfoCommand->>sys: get prefix (env path)
    DebugInfoCommand->>sys: get executable
    DebugInfoCommand-->>User: print debug info (Version, Python, Path, Executable)

Class diagram for updated DebugInfoCommand output

classDiagram
    class DebugInfoCommand {
        +handle() int
        -poetry: Poetry
    }
    class Poetry {
        +VERSION: str
    }
    DebugInfoCommand --> Poetry: uses
    %% Updated output attributes in handle()
    %% Now includes Version, Python, Path, Executable

File-Level Changes

Change	Details	Files
Extend debug info output to include environment path and executable	Adjusted spacing for Version and Python lines Introduced Path line using sys.prefix Introduced Executable line using sys.executable with fallback	`src/poetry/console/commands/debug/info.py`
Add tests covering new debug info fields	Mocked EnvManager.get, sys.prefix, and sys.executable fixtures Added test to execute `debug info` and assert complete output	`tests/console/commands/debug/test_info.py`

Possibly linked issues

Show path to poetry self venv python #10559: The PR adds sys.prefix and sys.executable to poetry debug info output, fulfilling the issue's request to show Poetry's Python path.

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

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey there - I've reviewed your changes and they look great!

Prompt for AI Agents

Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `tests/console/commands/debug/test_info.py:18` </location>
<code_context>

</code_context>

<issue_to_address>
**issue (code-quality):** Don't import test modules. ([`dont-import-test-modules`](https://docs.sourcery.ai/Reference/Rules-and-In-Line-Suggestions/Python/Default-Rules/dont-import-test-modules))

<details><summary>Explanation</summary>Don't import test modules.

Tests should be self-contained and don't depend on each other.

If a helper function is used by multiple tests,
define it in a helper module,
instead of importing one test from the other.
</details>
</issue_to_address>

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

LGTM except for the failing Windows tests. Can you take a look, please?

jaredahern · 2025-11-24T02:43:29Z

Hmm. I took a look at the errors, and tried to resolve them. Not sure if I totally have. Here's the original error:

    Poetry
    Version:    2.2.1
    Python:     3.10.11
    Path:       /poetry/prefix
    Executable: /poetry/prefix/bin/python

    Virtualenv
    Python:         3.7.0
    Implementation: CPython
    Path:           \prefix
  - Executable:     /poetry/prefix/bin/python
  ?                 ^      ^      ^   ^
  + Executable:     \poetry\prefix\bin\python
  ?                 ^      ^      ^   ^
    Valid:          True

    Base
    Platform:   darwin
    OS:         posix
    Python:     3.10.11
    Path:       \base\prefix
    Executable: python

So here, the error appears to be with the output from the env info command, which I haven't touched, and directly copied the test for. It confuses me that the related test_env_info_displays_complete_info test does not fail.

That being said, I tried to be more careful with paths, to better support Windows. Happy to take pointers. I rebased onto main and added a commit. There are now different failing tests, which seem to be unrelated to the changes here. Any thoughts on how I should proceed?

radoering · 2025-11-24T16:13:52Z

So here, the error appears to be with the output from the env info command, which I haven't touched, and directly copied the test for. It confuses me that the related test_env_info_displays_complete_info test does not fail.

You mock sys.executable in the new test. Your mock uses forward slashes on Windows. test_env_info_displays_complete_info just uses the real sys.executable, which has backslashes.

There are now different failing tests, which seem to be unrelated to the changes here. Any thoughts on how I should proceed?

Just wait and re-run. That was actions/runner-images#13341

github-actions · 2025-12-25T00:36:25Z

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.

sourcery-ai bot reviewed Oct 19, 2025

View reviewed changes

jaredahern mentioned this pull request Oct 19, 2025

Show path to poetry self venv python #10559

Closed

radoering reviewed Oct 31, 2025

View reviewed changes

jaredahern force-pushed the main branch from aeef6fc to 000cfd8 Compare November 23, 2025 23:17

jaredahern added 3 commits November 24, 2025 17:03

Show Python path for Poetry in debug info

743e6ba

Fix for pre-commit

17f4918

Improve Windows path handing in debug info output

dfe454b

radoering force-pushed the main branch from 000cfd8 to dfe454b Compare November 24, 2025 16:03

radoering approved these changes Nov 24, 2025

View reviewed changes

radoering merged commit 9e1062a into python-poetry:main Nov 24, 2025
63 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Dec 25, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Show Python path for Poetry in `debug info`#10588

Show Python path for Poetry in `debug info`#10588
radoering merged 3 commits intopython-poetry:mainfrom
jaredahern:main

jaredahern commented Oct 19, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Oct 19, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

radoering left a comment

Uh oh!

jaredahern commented Nov 24, 2025 •

edited

Loading

Uh oh!

radoering commented Nov 24, 2025

Uh oh!

Uh oh!

github-actions bot commented Dec 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Conversation

jaredahern commented Oct 19, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Check List

Summary

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Oct 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Sequence diagram for enhanced debug info output in handle()

Class diagram for updated DebugInfoCommand output

File-Level Changes

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

radoering left a comment

Choose a reason for hiding this comment

Uh oh!

jaredahern commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

radoering commented Nov 24, 2025

Uh oh!

Uh oh!

github-actions bot commented Dec 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jaredahern commented Oct 19, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Oct 19, 2025 •

edited

Loading

jaredahern commented Nov 24, 2025 •

edited

Loading