poetry icon indicating copy to clipboard operation
poetry copied to clipboard

Add activate command alias for env commad

Open Sharan-Robinson opened this issue 8 months ago • 1 comments

Pull Request Check List

Resolves: #10266

  • [x] Added tests for changed code.
  • [x] 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 avatar Apr 16 '25 01:04 Sharan-Robinson

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

  • 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[bot] avatar Apr 16 '25 01:04 sourcery-ai[bot]

I don't think this is something we want. We are reluctant to implement new commands, especially ones that are aliases for other commands. You can make an alias in your own shell or by making a plugin.

Secrus avatar Sep 25 '25 00:09 Secrus

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.

github-actions[bot] avatar Oct 25 '25 00:10 github-actions[bot]