Skip to content
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

fix(cli): sort global opts prior to io config #10128

Merged
merged 1 commit into from
Jan 30, 2025

Conversation

abn
Copy link
Member

@abn abn commented Jan 30, 2025

Testing this change

Using pipx

pipx install --suffix=@10128 'poetry @ git+https://github.com/python-poetry/poetry.git@refs/pull/10128/head'
alias poetry=poetry@10128
mkdir foobar
cd foobar
poetry init -n

Using a container (podman | docker)

podman run --rm -i --entrypoint bash docker.io/python:latest <<EOF
set -xe
python -m pip install --disable-pip-version-check -q git+https://github.com/python-poetry/poetry.git@refs/pull/10128/head
mkdir foobar
cd foobar
poetry init -n
EOF

Summary by Sourcery

Bug Fixes:

  • Fix incorrect handling of global options when combined with IO configuration.

@abn abn added kind/bug Something isn't working as expected area/cli Related to the command line labels Jan 30, 2025
@abn abn requested a review from a team January 30, 2025 15:50
Copy link

sourcery-ai bot commented Jan 30, 2025

Reviewer's Guide by Sourcery

This pull request addresses an issue where global options were not being correctly applied due to incorrect ordering of operations. The fix involves reordering the call to sort global options to ensure they are applied before IO configuration.

Sequence diagram for updated global options configuration flow

sequenceDiagram
    participant App as Application
    participant IO as IO Configuration
    participant Options as Global Options

    Note over App,Options: Before Change
    App->>Options: _sort_global_options()
    App->>IO: Configure IO
    App->>Options: Configure global options

    Note over App,Options: After Change
    App->>IO: _configure_run_command()
    App->>Options: _sort_global_options()
    App->>IO: Configure IO
    App->>Options: Configure global options
Loading

File-Level Changes

Change Details Files
Reordered the call to _sort_global_options to ensure global options are applied before IO configuration.
  • Moved the call to _sort_global_options before the call to super()._configure_io(io) in the _configure_io method.
src/poetry/console/application.py
Added a test case to verify that IO options are correctly set.
  • Added a new test case test_application_io_options_are_set to verify that IO options such as --ansi, --no-ansi, --no-interaction, --verbose, -vv, and -vvv are correctly set.
tests/console/test_application_global_options.py
Ensured that the input stream and interactivity are preserved when sorting global options.
  • Set the stream of the sorted input to the original input stream.
  • Set the interactivity of the sorted input to the original input interactivity.
src/poetry/console/application.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 @abn - 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
  • 🟢 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.

@abn abn enabled auto-merge (rebase) January 30, 2025 15:56
@abn abn merged commit a194eac into python-poetry:main Jan 30, 2025
55 checks passed
@abn abn deleted the fix/io-interactive branch January 30, 2025 15:58
@radoering radoering mentioned this pull request Feb 9, 2025
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/cli Related to the command line kind/bug Something isn't working as expected
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants