Skip to content

Replace inference of shell with explicit parameter detection#36

Open
davidjxwu wants to merge 1 commit intopyenv-win:mainfrom
davidjxwu:explicit-call-parameter
Open

Replace inference of shell with explicit parameter detection#36
davidjxwu wants to merge 1 commit intopyenv-win:mainfrom
davidjxwu:explicit-call-parameter

Conversation

@davidjxwu
Copy link

@davidjxwu davidjxwu commented Jan 29, 2025

When calling pyenv-win-venv using the pyenv-venv invocation, the CommandType is mapped to an "ExternalScript", which then makes the activation of a virtualenv create a CMD shell, even if initially called from powershell.

This removes that inference in favour of an explicit call parameter which is set to True only when the .bat file is called, which should (only) be whenever pyenv-win-venv is invoked from a CMD shell.

Summary by Sourcery

Bug Fixes:

  • Fix an issue where virtual environments were always activated in CMD shell, even when invoked from PowerShell.

@sourcery-ai
Copy link

sourcery-ai bot commented Jan 29, 2025

Reviewer's Guide by Sourcery

This pull request replaces the inference of the shell type with an explicit parameter, which is set to true when the script is called from a .bat file. This ensures that the correct shell is used when activating a virtual environment.

Sequence diagram for shell detection flow before and after changes

sequenceDiagram
    participant User
    participant bat as pyenv-win-venv.bat
    participant ps1 as pyenv-win-venv.ps1

    rect rgb(200, 200, 200)
    Note right of User: Before Changes
    alt Called from CMD
    User->>bat: Execute script
    bat->>ps1: Execute with CommandType=ExternalScript
    ps1->>ps1: Infer shell as 'bat'
    else Called from PowerShell
    User->>ps1: Execute directly
    ps1->>ps1: Infer shell as 'ps1'
    end
    end

    rect rgb(200, 255, 200)
    Note right of User: After Changes
    alt Called from CMD
    User->>bat: Execute script
    bat->>ps1: Execute with CalledFromCMD=true
    ps1->>ps1: Set shell as 'bat'
    else Called from PowerShell
    User->>ps1: Execute directly
    ps1->>ps1: Set shell as 'ps1'
    end
    end
Loading

Flow diagram for shell detection logic changes

flowchart TD
    A[Start] --> B{CalledFromCMD?}
    B -->|Yes| C[Set shell = 'bat']
    B -->|No| D[Set shell = 'ps1']
    C --> E[Continue script execution]
    D --> E
Loading

File-Level Changes

Change Details Files
Replaced shell type inference with an explicit parameter.
  • Removed the automatic detection of the shell type using $MyInvocation.MyCommand.CommandType.
  • Added a new parameter $CalledFromCMD to the script.
  • The shell type is now determined based on the value of the $CalledFromCMD parameter.
  • Added a debug log to show the detected shell.
bin/pyenv-win-venv.ps1
Set the new parameter when calling the powershell script from the batch file.
  • Added the -CalledFromCMD parameter to the powershell call in the batch file.
bin/pyenv-win-venv.bat

Possibly linked issues

  • #0: The PR fixes the issue by changing how the shell is detected when calling pyenv-win-venv. The PR replaces inference of the shell with explicit parameter detection.

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 @davidjxwu - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The .bat file needs to be updated to pass the new -CalledFromCMD parameter when invoking the PowerShell script, otherwise the shell detection won't work correctly.
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.

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.

1 participant