Skip to content
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.

Sign up for GitHub

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

Add Poetry support to virtualenv #2450

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

Add Poetry support to virtualenv #2450

Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
ffc1f17
Document some logic in prompt_virtualenv()
alexjurkiewicz Oct 12, 2023
e3e5605
Add Poetry support to virtualenv
alexjurkiewicz Oct 12, 2023
a79a934
Remove POWERLEVEL9K_VIRTUALENV_ENABLE_POETRY
alexjurkiewicz Oct 12, 2023
e162e2a
Fix up function return value passing
alexjurkiewicz Oct 12, 2023
db4b650
cosmetics
alexjurkiewicz Oct 12, 2023
c10e62a
Try to cache poetry command
alexjurkiewicz Oct 12, 2023
414c330
fixup! Fix up function return value passing
alexjurkiewicz Oct 12, 2023
8608896
Improve function names
alexjurkiewicz Oct 12, 2023
fe9b9f9
Fix cleanup of generic virtualenv names
alexjurkiewicz Oct 12, 2023
893e130
Fix POWERLEVEL9K_VIRTUALENV_SHOW_WITH_PYENV=if-different (I think)
alexjurkiewicz Oct 12, 2023
7e835be
Correct caching for pyproject.toml
alexjurkiewicz Oct 12, 2023
f2772bd
virtualenv: Handle not being in a virtualenv
alexjurkiewicz Oct 12, 2023
81c474c
Add error handling for poetry cmd
alexjurkiewicz Oct 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 46 additions & 9 deletions internal/p10k.zsh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2403,6 +2403,7 @@ _p9k_prompt_load_sync() {
# The first argument says whether to capture stderr (1) or ignore it (0).
# The second argument can be empty or a file. If it's a file, the
# output of the command is presumed to potentially depend on it.
# Returns output in $_p9k__ret.
function _p9k_cached_cmd() {
local cmd=$commands[$3]
[[ -n $cmd ]] || return
Expand Down Expand Up @@ -4280,24 +4281,59 @@ function instant_prompt_chezmoi_shell() {
# Virtualenv: current working virtualenv
# More information on virtualenv (Python):
# https://virtualenv.pypa.io/en/latest/
_virtualenv_load_name_VIRTUAL_ENV() {
# VIRTUAL_ENV is the on-disk path, VIRTUAL_ENV_PROMPT is `(name_of_virtualenv) `.
# Use custom name if it was set (python -m venv -p "foo" .venv)
if [[ $VIRTUAL_ENV_PROMPT == '('?*') ' && $VIRTUAL_ENV_PROMPT != "($n) " ]]; then
_virtualenv_name=$VIRTUAL_ENV_PROMPT[2,-3]
# Use parent directory name if virtualenv name is generic (eg .venv)
elif [[ ${VIRTUAL_ENV:t} == $~_POWERLEVEL9K_VIRTUALENV_GENERIC_NAMES ]]; then
_virtualenv_name=${VIRTUAL_ENV:h:t}
# Otherwise use the name as-is
else
_virtualenv_name=${VIRTUAL_ENV:t}
fi
}
_virtualenv_load_name_poetry() {
local idx=$1
local dir=${_p9k__parent_dirs[idx]}
local pyproject="$dir/pyproject.toml"
if ! _p9k_cached_cmd 0 "$pyproject" poetry -C "$dir" version; then
# poetry execution failed. Display nothing.
_virtualenv_name=""
fi
# Return the first word only, eg the value of pyproject.toml's `poetry.name`
_virtualenv_name="${_p9k__ret%% *}"
}
prompt_virtualenv() {
local msg=''
local version=''
if (( _POWERLEVEL9K_VIRTUALENV_SHOW_PYTHON_VERSION )) && _p9k_python_version; then
msg="${_p9k__ret//\%/%%} "
version="${_p9k__ret//\%/%%}"
msg="$version "
fi
local v=${VIRTUAL_ENV:t}
if [[ $VIRTUAL_ENV_PROMPT == '('?*') ' && $VIRTUAL_ENV_PROMPT != "($v) " ]]; then
v=$VIRTUAL_ENV_PROMPT[2,-3]
elif [[ $v == $~_POWERLEVEL9K_VIRTUALENV_GENERIC_NAMES ]]; then
v=${VIRTUAL_ENV:h:t}
_virtualenv_name=''
if [[ -n $VIRTUAL_ENV ]]; then
_virtualenv_load_name_VIRTUAL_ENV
else
local start end
_p9k_upglob pyproject.toml
local idx=$?
if (( idx > 0 )); then
_virtualenv_load_name_poetry $idx
fi
fi
Comment on lines +4315 to +4325
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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?

# Display nothing if there's no active virtualenv
if [[ -z $_virtualenv_name ]]; then
return
fi
msg+="$_POWERLEVEL9K_VIRTUALENV_LEFT_DELIMITER${v//\%/%%}$_POWERLEVEL9K_VIRTUALENV_RIGHT_DELIMITER"
msg+="$_POWERLEVEL9K_VIRTUALENV_LEFT_DELIMITER${_virtualenv_name//\%/%%}$_POWERLEVEL9K_VIRTUALENV_RIGHT_DELIMITER"
case $_POWERLEVEL9K_VIRTUALENV_SHOW_WITH_PYENV in
false)
_p9k_prompt_segment "$0" "blue" "$_p9k_color1" 'PYTHON_ICON' 0 '${(M)${#P9K_PYENV_PYTHON_VERSION}:#0}' "$msg"
;;
if-different)
_p9k_escape $v
_p9k_escape $version
_p9k_prompt_segment "$0" "blue" "$_p9k_color1" 'PYTHON_ICON' 0 '${${:-'$_p9k__ret'}:#$_p9k__pyenv_version}' "$msg"
;;
*)
Expand All @@ -4307,7 +4343,8 @@ prompt_virtualenv() {
}

_p9k_prompt_virtualenv_init() {
typeset -g "_p9k__segment_cond_${_p9k__prompt_side}[_p9k__segment_index]"='$VIRTUAL_ENV'
# Init if VIRTUAL_ENV is non-null or poetry is installed
typeset -g "_p9k__segment_cond_${_p9k__prompt_side}[_p9k__segment_index]"='${VIRTUAL_ENV:-${commands[poetry]:-${${+functions[poetry]}:#0}}}'
}

# _p9k_read_pyenv_like_version_file <filepath> [prefix]
Expand Down