fix `poetry self show` by radoering · Pull Request #10560 · python-poetry/poetry

radoering · 2025-09-20T11:10:12Z

Pull Request Check List

Resolves: #10553

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

Summary by Sourcery

Add format support to the poetry self show command by introducing a --format flag, updating documentation, and adding corresponding tests

New Features:

Add --format option to poetry self show command to specify JSON or text output

Documentation:

Document the new --format flag in the self show CLI reference

Tests:

Add tests for poetry self show covering default, JSON, and text formats

sourcery-ai · 2025-09-20T11:10:23Z

Reviewer's Guide

This PR enhances the poetry self show command by adding a --format option, updating its documentation, and covering the new functionality with tests.

File-Level Changes

Change	Details	Files
Enable a `--format` flag in the self show command	Include `format` in the filtered ShowCommand options Expand the options list comprehension to accept `format`	`src/poetry/console/commands/self/show/__init__.py`
Update CLI documentation for the format option	Add `--format (-f)` entry with description and usage rules Note that `json` format cannot be combined with `--tree`	`docs/cli.md`
Add tests for JSON and text output formats	Parametrize tests for default, JSON, and text formats Set up temporary system pyproject and lock files Assert exit codes and output matches expected format	`tests/console/commands/self/test_show.py`

Possibly linked issues

Poetry 2.2.0: broke existing poetry self show --outdated command #10553: The PR fixes the 'Invalid output format' error in poetry self show --outdated by adding the --format option to specify output.

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/self/test_show.py:17` </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.}

tests/console/commands/self/test_show.py

github-actions · 2025-09-21T08:54:17Z

Deploy preview for website ready!

✅ Preview
https://website-m9fn4d4l4-python-poetry.vercel.app

Built with commit 46c59a3.
This pull request is being automatically deployed with vercel-action

This PR contains the following updates: | Package | Update | Change | |---|---|---| | [poetry](https://github.com/python-poetry/poetry) ([changelog](https://python-poetry.org/history/)) | minor | `2.1.4` -> `2.2.1` | --- ### Release Notes <details> <summary>python-poetry/poetry (poetry)</summary> ### [`v2.2.1`](https://github.com/python-poetry/poetry/blob/HEAD/CHANGELOG.md#221---2025-09-21) [Compare Source](python-poetry/poetry@2.2.0...2.2.1) ##### Fixed - Fix an issue where `poetry self show` failed with a message about an invalid output format ([#10560](python-poetry/poetry#10560)). ##### Docs - Remove outdated statements about dependency groups ([#10561](python-poetry/poetry#10561)). ##### poetry-core ([`2.2.1`](https://github.com/python-poetry/poetry-core/releases/tag/2.2.1)) - Fix an issue where it was not possible to declare a PEP 735 dependency group as optional ([#888](python-poetry/poetry-core#888)). ### [`v2.2.0`](https://github.com/python-poetry/poetry/blob/HEAD/CHANGELOG.md#220---2025-09-14) [Compare Source](python-poetry/poetry@2.1.4...2.2.0) ##### Added - **Add support for nesting dependency groups** ([#10166](python-poetry/poetry#10166)). - **Add support for PEP 735 dependency groups** ([#10130](python-poetry/poetry#10130)). - **Add support for PEP 639 license clarity** ([#10413](python-poetry/poetry#10413)). - Add a `--format` option to `poetry show` to alternatively output json format ([#10487](python-poetry/poetry#10487)). - Add official support for Python 3.14 ([#10514](python-poetry/poetry#10514)). ##### Changed - **Normalize dependency group names** ([#10387](python-poetry/poetry#10387)). - Change `installer.no-binary` and `installer.only-binary` so that explicit package names will take precedence over `:all:` ([#10278](python-poetry/poetry#10278)). - Improve log output during `poetry install` when a wheel is built from source ([#10404](python-poetry/poetry#10404)). - Improve error message in case a file lock could not be acquired while cloning a git repository ([#10535](python-poetry/poetry#10535)). - Require `dulwich>=0.24.0` ([#10492](python-poetry/poetry#10492)). - Allow `virtualenv>=20.33` again ([#10506](python-poetry/poetry#10506)). - Allow `findpython>=0.7` ([#10510](python-poetry/poetry#10510)). - Allow `importlib-metadata>=8.7` ([#10511](python-poetry/poetry#10511)). ##### Fixed - Fix an issue where `poetry new` did not create the project structure in an existing empty directory ([#10431](python-poetry/poetry#10431)). - Fix an issue where a dependency that was required for a specific Python version was not installed into an environment of a pre-release Python version ([#10516](python-poetry/poetry#10516)). ##### poetry-core ([`2.2.0`](https://github.com/python-poetry/poetry-core/releases/tag/2.2.0)) - Deprecate table values and values that are not valid SPDX expressions for `[project.license]` ([#870](python-poetry/poetry-core#870)). - Fix an issue where explicitly included files that are in `.gitignore` were not included in the distribution ([#874](python-poetry/poetry-core#874)). - Fix an issue where marker operations could result in invalid markers ([#875](python-poetry/poetry-core#875)). </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.walbeck.it/walbeck-it/docker-python-poetry/pulls/1588 Co-authored-by: renovate-bot <[email protected]> Co-committed-by: renovate-bot <[email protected]>

github-actions · 2025-10-22T00:34:16Z

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.

fix poetry self show

46c59a3

sourcery-ai bot reviewed Sep 20, 2025

View reviewed changes

tests/console/commands/self/test_show.py Show resolved Hide resolved

radoering added the impact/docs Contains or requires documentation changes label Sep 21, 2025

radoering merged commit 8e3c537 into python-poetry:main Sep 21, 2025
65 checks passed

radoering mentioned this pull request Sep 21, 2025

release: bump version to 2.2.1 #10562

Merged

github-actions bot locked as resolved and limited conversation to collaborators Oct 22, 2025

radoering deleted the fix-self-show branch December 13, 2025 17:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

fix `poetry self show`#10560

fix `poetry self show`#10560
radoering merged 1 commit intopython-poetry:mainfrom
radoering:fix-self-show

radoering commented Sep 20, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Sep 20, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Uh oh!

github-actions bot commented Sep 21, 2025

Uh oh!

Uh oh!

github-actions bot commented Oct 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Comments

Conversation

radoering commented Sep 20, 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 by Sourcery

Uh oh!

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

Uh oh!

Reviewer's Guide

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!

Uh oh!

github-actions bot commented Sep 21, 2025

Uh oh!

Uh oh!

github-actions bot commented Oct 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

radoering commented Sep 20, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Sep 20, 2025 •

edited

Loading