mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2026-01-23 02:35:38 +01:00
d7dd980970Add PYTHON_AUTO_VRUN_RECURSIVE option to search parent directories for virtual environments, useful for monorepos where venv is at project root but you work in subdirectories.
135 lines
4.2 KiB
Bash
135 lines
4.2 KiB
Bash
# set python command if 'py' not installed
|
|
builtin which py > /dev/null || alias py='python3'
|
|
|
|
# Find python file
|
|
alias pyfind='find . -name "*.py"'
|
|
|
|
# Remove python compiled byte-code and mypy/pytest cache in either the current
|
|
# directory or in a list of specified directories (including sub directories).
|
|
function pyclean() {
|
|
find "${@:-.}" -type f -name "*.py[co]" -delete
|
|
find "${@:-.}" -type d -name "__pycache__" -delete
|
|
find "${@:-.}" -depth -type d -name ".mypy_cache" -exec rm -r "{}" +
|
|
find "${@:-.}" -depth -type d -name ".pytest_cache" -exec rm -r "{}" +
|
|
}
|
|
|
|
# Add the user installed site-packages paths to PYTHONPATH, only if the
|
|
# directory exists. Also preserve the current PYTHONPATH value.
|
|
# Feel free to autorun this when .zshrc loads.
|
|
function pyuserpaths() {
|
|
setopt localoptions extendedglob
|
|
|
|
# Check for a non-standard install directory.
|
|
local user_base="${PYTHONUSERBASE:-"${HOME}/.local"}"
|
|
|
|
local python version site_pkgs
|
|
for python in python2 python3; do
|
|
# Check if command exists
|
|
(( ${+commands[$python]} )) || continue
|
|
|
|
# Get minor release version.
|
|
# The patch version is variable length, truncate it.
|
|
version=${(M)${"$($python -V 2>&1)":7}#[^.]##.[^.]##}
|
|
|
|
# Add version specific path, if:
|
|
# - it exists in the filesystem
|
|
# - it isn't in $PYTHONPATH already.
|
|
site_pkgs="${user_base}/lib/python${version}/site-packages"
|
|
[[ -d "$site_pkgs" && ! "$PYTHONPATH" =~ (^|:)"$site_pkgs"(:|$) ]] || continue
|
|
export PYTHONPATH="${site_pkgs}${PYTHONPATH+":${PYTHONPATH}"}"
|
|
done
|
|
}
|
|
|
|
# Grep among .py files
|
|
alias pygrep='grep -nr --include="*.py"'
|
|
|
|
# Share local directory as a HTTP server
|
|
alias pyserver="python3 -m http.server"
|
|
|
|
|
|
## venv settings
|
|
: ${PYTHON_VENV_NAME:=venv}
|
|
|
|
# Array of possible virtual environment names to look for, in order
|
|
# -U for removing duplicates
|
|
typeset -gaU PYTHON_VENV_NAMES
|
|
[[ -n "$PYTHON_VENV_NAMES" ]] || PYTHON_VENV_NAMES=($PYTHON_VENV_NAME venv .venv)
|
|
|
|
# Activate a the python virtual environment specified.
|
|
# If none specified, use the first existing in $PYTHON_VENV_NAMES.
|
|
function vrun() {
|
|
if [[ -z "$1" ]]; then
|
|
local name
|
|
for name in $PYTHON_VENV_NAMES; do
|
|
local venvpath="${name:P}"
|
|
if [[ -d "$venvpath" ]]; then
|
|
vrun "$name"
|
|
return $?
|
|
fi
|
|
done
|
|
echo >&2 "Error: no virtual environment found in current directory"
|
|
fi
|
|
|
|
local name="${1:-$PYTHON_VENV_NAME}"
|
|
local venvpath="${name:P}"
|
|
|
|
if [[ ! -d "$venvpath" ]]; then
|
|
echo >&2 "Error: no such venv in current directory: $name"
|
|
return 1
|
|
fi
|
|
|
|
if [[ ! -f "${venvpath}/bin/activate" ]]; then
|
|
echo >&2 "Error: '${name}' is not a proper virtual environment"
|
|
return 1
|
|
fi
|
|
|
|
. "${venvpath}/bin/activate" || return $?
|
|
echo "Activated virtual environment ${name}"
|
|
}
|
|
|
|
# Create a new virtual environment using the specified name.
|
|
# If none specified, use $PYTHON_VENV_NAME
|
|
function mkv() {
|
|
local name="${1:-$PYTHON_VENV_NAME}"
|
|
local venvpath="${name:P}"
|
|
|
|
python3 -m venv "${name}" || return
|
|
echo >&2 "Created venv in '${venvpath}'"
|
|
vrun "${name}"
|
|
}
|
|
|
|
if [[ "$PYTHON_AUTO_VRUN" == "true" ]]; then
|
|
# Automatically activate venv when changing dir
|
|
function auto_vrun() {
|
|
# deactivate if we're on a different dir than VIRTUAL_ENV states
|
|
# we don't deactivate subdirectories!
|
|
if (( $+functions[deactivate] )) && [[ $PWD != ${VIRTUAL_ENV:h}* ]]; then
|
|
deactivate > /dev/null 2>&1
|
|
fi
|
|
|
|
if [[ $PWD != ${VIRTUAL_ENV:h} ]]; then
|
|
local file
|
|
for file in "${^PYTHON_VENV_NAMES[@]}"/bin/activate(N.); do
|
|
# make sure we're not in a venv already
|
|
(( $+functions[deactivate] )) && deactivate > /dev/null 2>&1
|
|
source $file > /dev/null 2>&1
|
|
return
|
|
done
|
|
|
|
# Search parent directories if recursive mode is enabled
|
|
if [[ "$PYTHON_AUTO_VRUN_RECURSIVE" == "true" ]]; then
|
|
local search_dir="$PWD:h"
|
|
while [[ "$search_dir" != "/" && "$search_dir" != "." ]]; do
|
|
for file in "${search_dir}/"${^PYTHON_VENV_NAMES[@]}"/bin/activate"(N.); do
|
|
(( $+functions[deactivate] )) && deactivate > /dev/null 2>&1
|
|
source $file > /dev/null 2>&1
|
|
return
|
|
done
|
|
search_dir="${search_dir:h}"
|
|
done
|
|
fi
|
|
fi
|
|
}
|
|
add-zsh-hook chpwd auto_vrun
|
|
auto_vrun
|
|
fi
|