Skip to content

Comments

replace poetry plugin commands with more generic poetry self commands#5450

Merged
abn merged 12 commits intopython-poetry:masterfrom
abn:refactor-plugin-management
May 30, 2022
Merged

replace poetry plugin commands with more generic poetry self commands#5450
abn merged 12 commits intopython-poetry:masterfrom
abn:refactor-plugin-management

Conversation

@abn
Copy link
Member

@abn abn commented Apr 14, 2022 •
edited
Loading

Conceptual Changes

  1. The poetry instance's runtime additional packages are now maintained in <user-config-dir>/pypoetry/pyproject.toml instead of the current (1.2.0b1) localtion at the base of the virtual envrionment. This was changes in order to preserve plugin/additional package configuration even when the virtual environment (Poetry's runtime environment) was recreated. You can simply do poetry self install to get everything back in order. (Might need to implement self lock command to faciititate some use cases).
  2. The self command now simply switches context to <user-config-dir>/pypoetry and treats it as a Poetry managed project.
  3. Additional packages are stored in the tool.poetry.group.additional.dependencies section of the <user-config-dir>/pypoetry/pyproject.toml file and can be listed using poetry self show --addons.
  4. Additional packages can now be any package, not just Poetry plugins. This allows for use cases where you want to override a single dependency in the environment and/or add plugin for another package (eg: keyring, requests etc.).

Commands Added

self add 

$ poetry self add --help

Description:
  Add additional packages to Poetry's runtime environment.

Usage:
  self add [options] [--] <name>...

Arguments:
  name                     The packages to add.

Options:
  -e, --editable           Add vcs/path dependencies as editable.
  -E, --extras=EXTRAS      Extras to activate for the dependency. (multiple values allowed)
      --source=SOURCE      Name of the source to use to install the package.
      --allow-prereleases  Accept prereleases.
      --dry-run            Output the operations but do not execute anything (implicitly enables --verbose).
<--snipped-->

Help:
  The self add command installs additional package's to Poetry's runtime environment.
  
  This is managed in the /home/abn/.config/pypoetry/pyproject.toml file.
  
  If you do not specify a version constraint, poetry will choose a suitable one based on the available package versions.
  
  You can specify a package in the following forms:
<--snipped-->

self remove 

$ poetry self remove --help

Description:
  Remove additional packages from Poetry's runtime environment.

Usage:
  self remove [options] [--] <packages>...

Arguments:
  packages              The packages to remove.

Options:
      --dry-run         Output the operations but do not execute anything (implicitly enables --verbose).
<--snipped-->

Help:
  The self remove command removes additional package's to Poetry's runtime environment.
  
  This is managed in the /home/abn/.config/pypoetry/pyproject.toml file.

self install 

$ poetry self install --help

Description:
  Add additional packages to Poetry's runtime environment.

Usage:
  self install [options]

Options:
      --sync            Synchronize the environment with the locked packages and the specified groups.
      --dry-run         Output the operations but do not execute anything (implicitly enables --verbose).
<--snipped-->

Help:
  The self install command all additional packages specified are installed in the current runtime environment.
  
  This is managed in the /home/abn/.config/pypoetry/pyproject.toml file.
  
  You can add more packages using the self add command and remove them using the self remove command.

self show 

$ poetry self show --help

Description:
  Show packages from Poetry's runtime environment.

Usage:
  self show [options] [--] [<package>]

Arguments:
  package               The package to inspect

Options:
      --addons          List only add-on packages installed.
  -t, --tree            List the dependencies as a tree.
  -l, --latest          Show the latest version.
  -o, --outdated        Show the latest version but only for packages that are outdated.
<--snipped-->

Help:
  The self show command behaves similar to the show command, but
  working within Poetry's runtime environment. This lists all packages installed within
  the Poetry install environment.
  
  To show only additional packages that have been added via self add and their
  dependencies use self show --addons.
  
  This is managed in the /home/abn/.config/pypoetry/pyproject.toml file.

self show plugins 

$ poetry self show plugins --help

Description:
  Shows information about the currently installed plugins.

Usage:
  self show plugins [options]

Options:
<--snipped-->

Help:
  The self show plugins command lists all installed Poetry plugins.
  
  Plugins can be added and removed using the self add and self remove commands respectively.
  
  This command does not list packages that do not provide a Poetry plugin.

Commands Changed

  1. self update now wraps around update instead for special handling.
  2. plugin add is now deprecated and re-routes to self add
  3. plugin remove is now deprecated and re-routes to self remove
  4. plugin show is now deprecated and re-routes to self show plugins

Example Usages

poetry self add artifacts-keyring
poetry self add git+https://github.com/python-poetry/poetry-core@master
poetry self add poetry-plugin-export

Testing

Using pipx

pipx install --suffix=@5450 'poetry @ git+https://github.com/python-poetry/poetry.git@refs/pull/5450/head'
poetry@5450 self add poetry-export-plugin
poetry@5450 self remove poetry-export-plugin
poetry@5450 self install --sync
poetry@5450 self update --preview
poetry@5450 self add artifacts-keyring
poetry@5450 self add git+https://github.com/python-poetry/poetry-core@master
cat ~/.config/pypoetry/pyproject.toml

Using a container (podman | docker)

podman run --rm -i --entrypoint bash docker.io/python:3.10 <<EOF
set -xe
python -m pip install -q git+https://github.com/python-poetry/poetry.git@refs/pull/5450/head
poetry self add poetry-export-plugin
poetry self remove poetry-export-plugin
poetry self install --sync
poetry self update --preview
poetry self add artifacts-keyring
poetry self add git+https://github.com/python-poetry/poetry-core@master
cat ~/.config/pypoetry/pyproject.toml
EOF

@abn abn requested a review from a team April 14, 2022 20:38
@abn abn force-pushed the refactor-plugin-management branch 2 times, most recently from c3ecbda to 8d92477 Compare April 14, 2022 23:14
@abn abn changed the title wip: replace poetry plugin commands with more generic poetry self commands replace poetry plugin commands with more generic poetry self commands Apr 15, 2022
@abn abn marked this pull request as ready for review April 15, 2022 23:02
@abn
Copy link
Member Author

abn commented Apr 15, 2022

Functional changes are ready for review. Will need to add some documentation changes.

@abn abn added this to the 1.2 milestone Apr 15, 2022
finswimmer
finswimmer reviewed Apr 19, 2022
View reviewed changes
@abn abn force-pushed the refactor-plugin-management branch 5 times, most recently from 1d4c79b to 92c3986 Compare April 19, 2022 13:20
finswimmer
finswimmer reviewed Apr 23, 2022
View reviewed changes
@abn abn force-pushed the refactor-plugin-management branch from 92c3986 to 9857880 Compare April 23, 2022 22:48
finswimmer
finswimmer previously requested changes Apr 24, 2022
View reviewed changes
@abn abn force-pushed the refactor-plugin-management branch from 9857880 to 09d695e Compare April 26, 2022 11:43
This was referenced Apr 26, 2022
Merged
Merged
Merged
Merged
@abn abn force-pushed the refactor-plugin-management branch from 09d695e to 3cae4e8 Compare April 27, 2022 00:58
@abn abn force-pushed the refactor-plugin-management branch from 3cae4e8 to d54bb20 Compare May 6, 2022 10:07
@abn abn requested a review from finswimmer May 6, 2022 10:44
@abn abn force-pushed the refactor-plugin-management branch from d54bb20 to 53e9298 Compare May 7, 2022 17:08
@abn abn dismissed finswimmer’s stale review May 7, 2022 17:19

Review feedback resolved.

@abn abn mentioned this pull request May 10, 2022
Closed
@abn abn force-pushed the refactor-plugin-management branch from 53e9298 to 2d6a480 Compare May 10, 2022 13:59
finswimmer
finswimmer reviewed May 10, 2022
View reviewed changes
finswimmer
finswimmer previously approved these changes May 14, 2022
View reviewed changes
@abn abn mentioned this pull request May 27, 2022
Merged
@abn
Copy link
Member Author

abn commented May 27, 2022

One scenario that has not been handled is a case where multiple poetry instances exist. Right now everything shares the config.

@abn abn dismissed finswimmer’s stale review May 27, 2022 15:41

Docs added.

@abn abn force-pushed the refactor-plugin-management branch from 7ed4c68 to 90dd80c Compare May 27, 2022 16:47
@Secrus Secrus linked an issue May 30, 2022 that may be closed by this pull request
(📚) The documentation doesn't mention the self command at all #5031
Closed
1 task
@abn abn force-pushed the refactor-plugin-management branch 2 times, most recently from 2eb14bb to 08778ce Compare May 30, 2022 17:07
@abn abn force-pushed the refactor-plugin-management branch from 08778ce to 5847c83 Compare May 30, 2022 17:11
@abn
Copy link
Member Author

abn commented May 30, 2022

@finswimmer gentle nudge

finswimmer
finswimmer approved these changes May 30, 2022
View reviewed changes
Copy link
Member

@finswimmer finswimmer left a comment

Choose a reason for hiding this comment

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

Let it fly ✈️

@abn abn merged commit d5c22c2 into python-poetry:master May 30, 2022
@abn abn deleted the refactor-plugin-management branch May 30, 2022 18:45
@branchv branchv mentioned this pull request May 30, 2022
Merged
ashnair1 added a commit to ashnair1/poetry that referenced this pull request May 30, 2022
@ashnair1
Modify test per python-poetry#5450
2e15231
@finswimmer finswimmer mentioned this pull request Jun 4, 2022
Closed
2 tasks
@abn abn mentioned this pull request Jun 6, 2022
Merged
@github-actions
Copy link

github-actions bot commented Feb 29, 2024

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 github-actions bot locked as resolved and limited conversation to collaborators Feb 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@finswimmer finswimmer finswimmer approved these changes

Assignees

No one assigned

Labels

area/docs Documentation issues/improvements

Projects

None yet

Milestone

1.2

Development

Successfully merging this pull request may close these issues.

(📚) The documentation doesn't mention the self command at all

3 participants

@abn @Secrus @finswimmer