some changes

This commit is contained in:
Carlo Sala 2024-03-03 13:02:06 +01:00
parent 81f16ed03d
commit b6839fdea8
No known key found for this signature in database
GPG key ID: DA6FB450C1A4FE9A
2 changed files with 26 additions and 40 deletions

View file

@ -22,33 +22,18 @@ plugins=(... python)
## Virtual environments ## Virtual environments
The plugin provides three utilities to manage Python 3.3+ The plugin provides three utilities to manage Python 3.3+ [venv](https://docs.python.org/3/library/venv.html)
[venv](https://docs.python.org/3/library/venv.html) virtual virtual environments:
environments:
- `mkv [name]`: Make a new virtual environment called *name* (else - `mkv [name]`: make a new virtual environment called `name` (default: if set `$PYTHON_VENV_NAME`, else
`$PYTHON_VENV_NAME`, else "venv") in the current directory. `venv`) in the current directory.
- `vrun [name]`: Activate the virtual environment called *name* (else - `vrun [name]`: Activate the virtual environment called `name` (default: if set `$PYTHON_VENV_NAME`, else
`$PYTHON_VENV_NAME`, else "venv") in the current directory. `venv`) in the current directory.
- `auto_vrun`: Automatically activate the venv virtual environment when - `auto_vrun`: Automatically activate the venv virtual environment when entering a directory containing
cding into a directory containing `venv/bin/activate`, and `<venv-name>/bin/activate`, and automatically deactivate it when navigating out of it (including
automatically deactivate it when cding into any other directory, subdirectories!).
including subdirectories. - To enable the feature, set `export PYTHON_AUTO_VRUN=true` before sourcing oh-my-zsh.
- To enable, set `PYTHON_AUTO_VRUN` to anything. For example: - The default virtual environment name is `venv`. To use a different name, set
`export PYTHON_VENV_NAME=<venv-name>`. For example: `export PYTHON_VENV_NAME=".venv"`
export PYTHON_AUTO_VRUN='true'
- To disable, either unset the environment variable:
unset PYTHON_AUTO_VRUN
or entirely remove `auto_vrun` from the list of functions associated
with the `chpwd` hook:
add-zsh-hook -d chpwd auto_vrun
If you disable `auto_vrun` while a virtual environment is active,
you'll need to manually `deactivate`.
- The default virtual environment name is "venv". To use a different
name, set `PYTHON_VENV_NAME`. For example:
export PYTHON_VENV_NAME='.venv'

View file

@ -51,11 +51,12 @@ alias pyserver="python3 -m http.server"
## venv utilities ## venv utilities
: ${PYTHON_VENV_NAME:=venv}
# Activate a the python virtual environment specified. # Activate a the python virtual environment specified.
# If none specified, use $PYTHON_VENV_NAME, else 'venv'. # If none specified, use $PYTHON_VENV_NAME, else 'venv'.
function vrun() { function vrun() {
local name="${1:-${PYTHON_VENV_NAME:-venv}}" local name="${1:-$PYTHON_VENV_NAME}"
local venvpath="${name:P}" local venvpath="${name:P}"
if [[ ! -d "$venvpath" ]]; then if [[ ! -d "$venvpath" ]]; then
@ -73,9 +74,9 @@ function vrun() {
} }
# Create a new virtual environment using the specified name. # Create a new virtual environment using the specified name.
# If none specfied, use $PYTHON_VENV_NAME, else 'venv'. # If none specfied, use $PYTHON_VENV_NAME
function mkv() { function mkv() {
local name="${1:-${PYTHON_VENV_NAME:-venv}}" local name="${1:-$PYTHON_VENV_NAME}"
local venvpath="${name:P}" local venvpath="${name:P}"
python3 -m venv "${name}" || return python3 -m venv "${name}" || return
@ -83,15 +84,15 @@ function mkv() {
vrun "${name}" vrun "${name}"
} }
# Automatically activate venv when cd'ing into a directory if [[ "$PYTHON_AUTO_VRUN" == "true" ]]; then
auto_vrun() { # Automatically activate venv when changing dir
[[ ! -n "$PYTHON_AUTO_VRUN" ]] && return 0 auto_vrun() {
local venvpath="${PYTHON_VENV_NAME:-venv}" if [[ -f "${PYTHON_VENV_NAME}/bin/activate" ]]; then
if [[ -f "${venvpath}/bin/activate" ]]; then source "${PYTHON_VENV_NAME}/bin/activate" > /dev/null 2>&1
source "${venvpath}/bin/activate" > /dev/null 2>&1
else else
[[ -n "$(command -v deactivate)" ]] && deactivate > /dev/null 2>&1 (( $+functions[deactivate] )) && deactivate > /dev/null 2>&1
fi fi
} }
add-zsh-hook chpwd auto_vrun add-zsh-hook chpwd auto_vrun
auto_vrun auto_vrun
fi