Skip to content

Add activate command alias for env commad #10339

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Sharan-Robinson
Copy link

@Sharan-Robinson Sharan-Robinson commented Apr 16, 2025

Pull Request Check List

Resolves: #10266

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

This PR adds a new command called activate that acts as an alias for the "env activate" command.

Summary by Sourcery

Add an alias command 'activate' for the existing 'env activate' command in Poetry

New Features:

  • Introduce a new 'activate' command that directly maps to 'poetry env activate', providing a more convenient shorthand for activating virtual environments

Documentation:

  • Update documentation to explain the new 'activate' command and its relationship to 'env activate'

Tests:

  • Add comprehensive test cases for the new 'activate' command, covering different shell environments and activation scenarios

Sharan Robinson added 2 commits April 15, 2025 18:09
Copy link

sourcery-ai bot commented Apr 16, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new activate command as an alias for the existing env activate command. The implementation involves creating a new command class that inherits from the original, updating the command list, adding documentation, and creating new tests to ensure the new command functions as expected across different shells and operating systems.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a new activate command as an alias for env activate.
  • Created a new ActivateCommand class that inherits from EnvActivateCommand.
  • Set the name of the command to activate.
  • Set the description of the command to Alias for the env activate command.
  • Added activate to the list of available commands.
src/poetry/console/application.py
src/poetry/console/commands/activate.py
Added documentation for the new activate command.
  • Added a line to the documentation stating that the poetry activate command acts as an alias for poetry env activate.
docs/managing-environments.md
Added tests for the new activate command.
  • Created a new test file for the activate command.
  • Added tests to verify that the command prints the correct activation script for different shells on Unix.
  • Added tests to verify that the command prints the correct activation script for different shells on Windows.
tests/console/commands/test_activate.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 @Sharan-Robinson - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a test to ensure that the activate command functions identically to env activate.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

@@ -86,6 +86,8 @@ The `poetry env activate` command prints the activate command of the virtual env
You can run the output command manually or feed it to the eval command of your shell to activate the environment.
This way you won't leave the current shell.

The `poetry activate` command acts an alias for `poetry env activate` and is interchangeable with each other.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (typo): Typo: "acts an alias" should be "acts as an alias"

Suggested change
The `poetry activate` command acts an alias for `poetry env activate` and is interchangeable with each other.
The `poetry activate` command acts as an alias for `poetry env activate` and is interchangeable with each other.

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.

poetry env as an allias for poetry env activate
1 participant