Add Poetry support to virtualenv

[alexjurkiewicz]

Integrate Poetry virtualenv detection into the existing virtualenv segment. For poetry virtualenvs, use the package name as reported by poetry version.

Fixes #1994.

This PR isn't working quite right. I'll add review comments where I need help from someone more experience 🙏

[alexjurkiewicz]

It would be nice if this code had the structure

_virtualenv_name=''
if in_virtual_env; then
  load_name_from_env_vars
elif in_poetry_project; then
  load_poetry_project_name
fi

The current structure is functionally the same, but harder to reason about.

Here's an alternate implementation. I'm not sure if it's better or worse, what do you think?

_virtualenv_load_name_from_env_vars || _virtualenv_load_name_from_poetry || _virtualenv_name=''

_virtualenv_load_name_from_env_vars() {
  [[ -z ${VIRTUAL_ENV} ]] && return 1
  _virtualenv_name=${VIRTUAL_ENV}
}
_virtualenv_load_name_from_poetry() {
  _p9k_upglob pyproject.toml || return 1
  _p9k_cached_cmd 0 "$pyproject" poetry -C "$dir" version
  _virtualenv_name="${_p9k__ret%% *}"
}

Or do you have a better idea?

[alexjurkiewicz]

Future improvement. Currently there's logic to show virtualenv segment if the current Python version differs from pyenv's. Personally I would like the opposite: show pyenv only if there's no active virtualenv.

[romkatv]

#1994 (comment) applies here as well.

I'll keep the PR open in case I do find time to learn poetry and implement support for it in powerlevel10k. At that point your changes might be useful.

[alexjurkiewicz]

Sure, thanks. Is there anything I can do to help? 🙏

…

On Sun, 15 Oct 2023, 4:09 pm Roman Perepelitsa, ***@***.***> wrote: #1994 (comment) <#1994 (comment)> applies here as well. I'll keep the PR open in case I do find time to learn poetry and implement support for it in powerlevel10k. At that point your changes might be useful. — Reply to this email directly, view it on GitHub <#2450 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAC4U5L4WBWH6K67YVDIFRTX7OKZZAVCNFSM6AAAAAA55BLJMCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONRTGMYTGNZRG4> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[romkatv]

Sure, thanks. Is there anything I can do to help? 🙏

Either I need to learn poetry and implement support for it in powerlevel10k (this is how I've developed all other prompt segments), or someone needs to send a PR that I can merge with no changes. The latter can happen not only when the PR is 100% correct in terms of functionality and style, but also when it's obvious to me that it is indeed 100% correct (not an easy thing to achieve given that I never used poetry and don't know what it does).

You have two options that don't rely on me:

1. Implement the segment you need as a custom segment.
2. Fork powerlevel10k and implement your changes invasively.

(1) will be easier for you to maintain.

[alexjurkiewicz]

Thanks for the info. Just to clarify what you mean by "custom segment". Do you mean creating a new segment called e.g. "poetry" which I submit as a pull request? If so, I'll rework this PR so that the `virtualenv` segment is left as-is, and create a new segment which contains support for virtualenv, pyenv, and poetry. Thanks!

…

On Mon, 16 Oct 2023 at 19:11, Roman Perepelitsa ***@***.***> wrote: Sure, thanks. Is there anything I can do to help? 🙏 Either I need to learn poetry and implement support for it in powerlevel10k (this is how I've developed all other prompt segments), or someone needs to send a PR that I can merge with no changes. The latter can happen not only when the PR is 100% correct in terms of functionality and style, but also when it's obvious to me that it is indeed 100% correct (not an easy thing to achieve given that I never used poetry and don't know what it does). You have two options that don't rely on me: 1. Implement the segment you need as a custom segment. 2. Fork powerlevel10k and implement your changes invasively. (1) will be easier for you to maintain. — Reply to this email directly, view it on GitHub <#2450 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAC4U5NUPKDEZ6QD5OV76HDX7UI5LAVCNFSM6AAAAAA55BLJMCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONRUGI2DEMJWGI> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[romkatv]

Just to clarify what you mean by "custom segment". Do you mean creating a new segment called e.g. "poetry" which I submit as a pull request?

I won't merge a PR unless it's obviously correct and matches the style of the surrounding code perfectly. This is a ridiculously high bar. In practice this means that a non-trivial PR has virtually no chance of getting merged.

This is why I suggested that instead of sending PRs you implement a custom prompt segment for yourself using the public and documented API provided by powerlevel10k. See p10k help segment and search for "example" in ~/.p10k.zsh. This will allow you to implement the segment(s) you need without depending on my merging anything.

[alexjurkiewicz]

Got it. I'll leave this PR as-is and use something custom locally 👌

[android10]

@alexjurkiewicz if you want to benefit from the current venv functionality from @romkatv, you can set up poetry to create virtual environments in the project directory, thus, your prompt will show you this information as if you were using pip.

I use this approach for python project compatibility and full isolation, although of course that is my opinion :).

You can achieve what I mentioned above by either setting an ENV variable:

export POETRY_VIRTUALENVS_IN_PROJECT=true

or by having poetry global config in your $XDG_CONFIG_HOME/pypoetry/config.toml.
Here is mine for example:

virtualenvs.in-project = true
virtualenvs.prefer-active-python = true
virtualenvs.options.always-copy = true

Then you can activate your virtual environment and it will be display the right information:

$ source .venv/bin/activate

or

$ poetry shell

Check the Poetry Official Documentation for more.

I hope that helps.

[romkatv]

Thanks for posting this tip!