diff options
Diffstat (limited to 'oh-my-zsh/plugins/virtualenvwrapper')
| -rw-r--r-- | oh-my-zsh/plugins/virtualenvwrapper/README.md | 38 | ||||
| -rw-r--r-- | oh-my-zsh/plugins/virtualenvwrapper/virtualenvwrapper.plugin.zsh | 91 |
2 files changed, 129 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/virtualenvwrapper/README.md b/oh-my-zsh/plugins/virtualenvwrapper/README.md new file mode 100644 index 0000000..63eb585 --- /dev/null +++ b/oh-my-zsh/plugins/virtualenvwrapper/README.md @@ -0,0 +1,38 @@ +# Virtualenvwrapper plugin + +This plugin loads Python's [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/) shell tools. + +To use it, add `virtualenvwrapper` to the plugins array in your zshrc file: + +```zsh +plugins=(... virtualenvwrapper) +``` + +## Usage + +The plugin allows to automatically activate virtualenvs on cd into git repositories with a matching name: + +``` +➜ github $ cd ansible +(ansible) ➜ ansible git:(devel) $ cd docs +(ansible) ➜ docs git:(devel) $ cd .. +(ansible) ➜ ansible git:(devel) $ cd .. +➜ github $ +``` + +We can override this by having a `.venv` file in the directory containing a differently named virtualenv: + +``` +➜ github $ cat ansible/.venv +myvirtualenv +➜ github $ cd ansible +(myvirtualenv) ➜ ansible git:(devel) $ cd .. +➜ github $ +``` + +We can disable this behaviour by setting `DISABLE_VENV_CD=1` before Oh My Zsh is sourced: +```zsh +DISABLE_VENV_CD=1 +plugins=(... virtualenvwrapper) +source $ZSH/oh-my-zsh.sh +``` diff --git a/oh-my-zsh/plugins/virtualenvwrapper/virtualenvwrapper.plugin.zsh b/oh-my-zsh/plugins/virtualenvwrapper/virtualenvwrapper.plugin.zsh new file mode 100644 index 0000000..d359e0c --- /dev/null +++ b/oh-my-zsh/plugins/virtualenvwrapper/virtualenvwrapper.plugin.zsh @@ -0,0 +1,91 @@ +function { + # search in these locations for the init script: + for virtualenvwrapper in $commands[virtualenvwrapper_lazy.sh] \ + $commands[virtualenvwrapper.sh] \ + /usr/share/virtualenvwrapper/virtualenvwrapper{_lazy,}.sh \ + /usr/local/bin/virtualenvwrapper{_lazy,}.sh \ + /etc/bash_completion.d/virtualenvwrapper \ + /usr/share/bash-completion/completions/virtualenvwrapper \ + $HOME/.local/bin/virtualenvwrapper.sh + do + if [[ -f "$virtualenvwrapper" ]]; then + source "$virtualenvwrapper" + return + fi + done + print "[oh-my-zsh] virtualenvwrapper plugin: Cannot find virtualenvwrapper.sh.\n"\ + "Please install with \`pip install virtualenvwrapper\`" >&2 + return 1 +} + +if [[ $? -eq 0 ]] && ! type workon &>/dev/null; then + print "[oh-my-zsh] virtualenvwrapper plugin: shell function 'workon' not defined.\n"\ + "Please check ${virtualenvwrapper}" >&2 + return +fi + +if [[ -z "$WORKON_HOME" ]]; then + WORKON_HOME="$HOME/.virtualenvs" +fi + +if [[ ! $DISABLE_VENV_CD -eq 1 ]]; then + # Automatically activate Git projects or other customized virtualenvwrapper projects based on the + # directory name of the project. Virtual environment name can be overridden + # by placing a .venv file in the project root with a virtualenv name in it. + function workon_cwd { + if [[ -z "$WORKON_CWD" ]]; then + local WORKON_CWD=1 + # Get absolute path, resolving symlinks + local PROJECT_ROOT="${PWD:A}" + while [[ "$PROJECT_ROOT" != "/" && ! -e "$PROJECT_ROOT/.venv" \ + && ! -d "$PROJECT_ROOT/.git" ]]; do + PROJECT_ROOT="${PROJECT_ROOT:h}" + done + + # Check for virtualenv name override + if [[ -f "$PROJECT_ROOT/.venv" ]]; then + ENV_NAME="$(cat "$PROJECT_ROOT/.venv")" + elif [[ -f "$PROJECT_ROOT/.venv/bin/activate" ]];then + ENV_NAME="$PROJECT_ROOT/.venv" + elif [[ "$PROJECT_ROOT" != "/" ]]; then + ENV_NAME="${PROJECT_ROOT:t}" + else + ENV_NAME="" + fi + + if [[ -n $CD_VIRTUAL_ENV && "$ENV_NAME" != "$CD_VIRTUAL_ENV" ]]; then + # We've just left the repo, deactivate the environment + # Note: this only happens if the virtualenv was activated automatically + if [[ -n "$VIRTUAL_ENV" ]]; then + # Only deactivate if VIRTUAL_ENV was set + # User may have deactivated manually or via another mechanism + deactivate + fi + # clean up regardless + unset CD_VIRTUAL_ENV + fi + if [[ "$ENV_NAME" != "" ]]; then + # Activate the environment only if it is not already active + if [[ ! "$VIRTUAL_ENV" -ef "$WORKON_HOME/$ENV_NAME" ]]; then + if [[ -e "$WORKON_HOME/$ENV_NAME/bin/activate" ]]; then + workon "$ENV_NAME" && export CD_VIRTUAL_ENV="$ENV_NAME" + elif [[ -e "$ENV_NAME/bin/activate" ]]; then + source $ENV_NAME/bin/activate && export CD_VIRTUAL_ENV="$ENV_NAME" + else + ENV_NAME="" + fi + fi + fi + if [[ "$ENV_NAME" == "" && -n $CD_VIRTUAL_ENV && -n $VIRTUAL_ENV ]]; then + # We've just left the repo, deactivate the environment + # Note: this only happens if the virtualenv was activated automatically + deactivate && unset CD_VIRTUAL_ENV + fi + fi + } + + # Append workon_cwd to the chpwd_functions array, so it will be called on cd + # http://zsh.sourceforge.net/Doc/Release/Functions.html + autoload -U add-zsh-hook + add-zsh-hook chpwd workon_cwd +fi |