shell version set in activate should be unset in deactivate (#61)

Some doc fixes: typos, grammar, clarification and formatting

README.md

@@ -3,26 +3,28 @@
 [![Build Status](https://travis-ci.org/yyuu/pyenv-virtualenv.png)](https://travis-ci.org/yyuu/pyenv-virtualenv)
 
 pyenv-virtualenv is a [pyenv](https://github.com/yyuu/pyenv) plugin
-that provides a `pyenv virtualenv` command to create virtualenv for Python
+that provides a `pyenv virtualenv` command to create virtualenvs for Python
 on UNIX-like systems.
 
 (NOTICE: If you are an existing user of [virtualenvwrapper](http://pypi.python.org/pypi/virtualenvwrapper)
 and you love it, [pyenv-virtualenvwrapper](https://github.com/yyuu/pyenv-virtualenvwrapper) may help you
-to manage your virtualenvs.)
+(additionally) to manage your virtualenvs.)
 
 ## Installation
 
 ### Installing as a pyenv plugin
 
 This will install the latest development version of pyenv-virtualenv into
-the `~/.pyenv/plugins/pyenv-virtualenv` directory. 
+the `~/.pyenv/plugins/pyenv-virtualenv` directory.
 
-**Important note:**  If you installed pyenv into a non-standard directory, make sure that you clone this
-repo into the 'plugins' directory of wherever you installed into.
+**Important note:**  If you installed pyenv into a non-standard directory, make
+sure that you clone this repo into the 'plugins' directory of wherever you
+installed into.
 
 From inside that directory you can:
- - Check out a specific release tag. 
- - Get the latest development release by running `git pull` to download the latest changes.
+ - Check out a specific release tag.
+ - Get the latest development release by running `git pull` to download the
+   latest changes.
 
 1. **Check out pyenv-virtualenv into plugin directory**
 
@@ -31,10 +33,10 @@ From inside that directory you can:
 2. **Add `pyenv virtualenv-init` to your shell** to enable activation of virtualenv. This is entirely optional but pretty useful.
 
         $ echo 'eval "$(pyenv virtualenv-init -)"' >> ~/.bash_profile
-
     **Zsh note**: Modify your `~/.zshenv` file instead of `~/.bash_profile`.
+    **Pyenv note**: You may also need to add 'eval "$(pyenv init -)"' to your profile if you haven't done so already.
 
-3. **Restart your shell to the enable pyenv-virtualenv**
+3. **Restart your shell to enable pyenv-virtualenv**
 
         $ exec "$SHELL"
 
@@ -42,11 +44,11 @@ From inside that directory you can:
 ### Installing with Homebrew (for OS X users)
 
 Mac OS X users can install pyenv-virtualenv with the
-[Homebrew](http://brew.sh) package manager. This
-will give you access to the `pyenv-virtualenv` command. If you have pyenv
+[Homebrew](http://brew.sh) package manager.
+This will give you access to the `pyenv-virtualenv` command. If you have pyenv
 installed, you will also be able to use the `pyenv virtualenv` command.
 
-*This is recommended method of installation if you installed pyenv
+*This is the recommended method of installation if you installed pyenv
  with Homebrew.*
 
 ```
@@ -59,15 +61,16 @@ Or, if you would like to install the latest development release:
 $ brew install --HEAD pyenv-virtualenv
 ```
 
-After installation, you'll still need to add `eval "$(pyenv virtualenv-init -)"` to your
-profile (as stated in the caveats). You'll only ever have to do this once.
+After installation, you'll still need to add `eval "$(pyenv virtualenv-init
+-)"` to your profile (as stated in the caveats). You'll only ever have to do
+this once.
 
 
 ## Usage
 
 ### Using `pyenv virtualenv` with pyenv
 
-To create a virtualenv for the Python version use with pyenv, run
+To create a virtualenv for the Python version used with pyenv, run
 `pyenv virtualenv`, specifying the Python version you want and the name
 of the virtualenv directory. For example,
 
@@ -75,26 +78,25 @@ of the virtualenv directory. For example,
 $ pyenv virtualenv 2.7.7 my-virtual-env-2.7.7
 ```
 
-will create a virtualenv based on Python 2.7.7
-under `~/.pyenv/versions` in a folder called `my-virtual-env-2.7.7`. 
+will create a virtualenv based on Python 2.7.7 under `~/.pyenv/versions` in a
+folder called `my-virtual-env-2.7.7`.
 
 
 ### Create virtualenv from current version
 
-If there is only one argument is given to `pyenv virtualenv`,
-virtualenv will be created with given name based on current
-version.
+If there is only one argument given to `pyenv virtualenv`, the virtualenv will
+be created with the given name based on the current pyenv Python version.
 
 ```
 $ pyenv version
-3.4.1 (set by /home/yyuu/.pyenv/version)
+3.4.2 (set by /home/yyuu/.pyenv/version)
 $ pyenv virtualenv venv34
 ```
 
 
 ### List existing virtualenvs
 
-`pyenv virtualenvs` shows you the list of existing virtualenvs.
+`pyenv virtualenvs` shows you the list of existing virtualenvs:
 
 ```
 $ pyenv shell venv27
@@ -106,10 +108,13 @@ $ pyenv virtualenvs
 
 ### Activate virtualenv
 
-Some external tools (e.g. [jedi](https://github.com/davidhalter/jedi)) might require you to `activate` the virtualenv.
-The `pyenv-virtualenv` will automatically activate/deactivate the virtualenv if the `eval "$(pyenv virtualenv-init -)"` is properly configured in your shell.
+Some external tools (e.g. [jedi](https://github.com/davidhalter/jedi)) might
+require you to `activate` the virtualenv.
 
-You can also activate and deactivate a pyenv virtualenv this way:
+`pyenv-virtualenv` will automatically activate/deactivate the virtualenv if
+the `eval "$(pyenv virtualenv-init -)"` is properly configured in your shell.
+
+You can also activate and deactivate a pyenv virtualenv manually:
 
     pyenv activate <name>
     pyenv deactivate
@@ -124,27 +129,30 @@ Removing the directory in `~/.pyenv/versions` will delete the virtualenv, or you
 
 ### virtualenv and pyvenv
 
-There is [venv](http://docs.python.jp/3/library/venv.html) module available for CPython 3.3 and newer.
-It provides a command-line tool `pyvenv` which is the successor of `virtualenv` and distributed by default.
+There is a [venv](http://docs.python.jp/3/library/venv.html) module available
+for CPython 3.3 and newer.
+It provides a command-line tool `pyvenv` which is the successor of `virtualenv`
+and distributed by default.
 
-The `pyenv-virtualenv` uses `pyvenv` if it is available and the `virtualenv` is not available.
+`pyenv-virtualenv` uses `pyvenv` if it is available and the `virtualenv`
+command is not available.
 
 
 ### Special environment variables
 
-You can set certain environment variables to control the pyenv-virtualenv.
+You can set certain environment variables to control pyenv-virtualenv.
 
 * `PYENV_VIRTUALENV_CACHE_PATH`, if set, specifies a directory to use for
   caching downloaded package files.
-* `VIRTUALENV_VERSION`, if set, forces pyenv-virtualenv to install desired
-  version of virtualenv. If the virtualenv has not been installed,
+* `VIRTUALENV_VERSION`, if set, forces pyenv-virtualenv to install the desired
+  version of virtualenv. If `virtualenv` has not been installed,
   pyenv-virtualenv will try to install the given version of virtualenv.
-* `EZ_SETUP` and `GET_PIP`, if set and pyvenv is preferred than virtualenv,
-  use `ez_setup.py` and `get_pip.py` at specified location.
-* `EZ_SETUP_URL` and `GET_PIP_URL`, if set and pyvenv is preferred
-  than virtualenv, download `ez_setup.py` and `get_pip.py` from specified URL.
-* `SETUPTOOLS_VERSION` and `PIP_VERSION`, if set and pyvenv is preferred
-  than virtualenv, install specified version of setuptools and pip.
+* `EZ_SETUP` and `GET_PIP`, if set and `pyvenv` is preferred over `virtualenv`,
+  use `ez_setup.py` and `get_pip.py` from the specified location.
+* `EZ_SETUP_URL` and `GET_PIP_URL`, if set and `pyvenv` is preferred over
+  `virtualenv`, download `ez_setup.py` and `get_pip.py` from the specified URL.
+* `SETUPTOOLS_VERSION` and `PIP_VERSION`, if set and `pyvenv` is preferred
+  over `virtualenv`, install the specified version of setuptools and pip.
 
 
 ## Version History

bin/pyenv-sh-activate

@@ -41,8 +41,9 @@ while [ $# -gt 0 ]; do
   shift 1
 done
 
+no_shell=
 versions=("$@")
-if [ -z "$versions" ]; then
+if [ -z "${versions}" ]; then
   no_shell=1
   OLDIFS="$IFS"
   IFS=: versions=($(pyenv-version-name))
@@ -97,6 +98,16 @@ fi
 
 if [ -z "$no_shell" ]; then
   echo "pyenv shell \"${versions}\";"
+  # shell version set in pyenv-sh-activate should be unset
+  # https://github.com/yyuu/pyenv-virtualenv/issues/61
+  case "$shell" in
+  fish )
+    echo "setenv PYENV_ACTIVATE_SHELL 1;"
+    ;;
+  * )
+    echo "export PYENV_ACTIVATE_SHELL=1;"
+    ;;
+  esac
 fi
 
 prefix="$(pyenv-prefix "${versions}")"

bin/pyenv-sh-deactivate

@@ -43,10 +43,18 @@ if [ -n "$VERBOSE" ]; then
   echo "  echo \"pyenv-virtualenv: deactivate ${prefix##*/}\" 1>&2;"
 fi
 
-if [ -z "${PYENV_VIRTUALENV_INIT}" ]; then
-  # Backward compatibility issue
-  # https://github.com/yyuu/pyenv-virtualenv/issues/26
+if [ -n "${PYENV_ACTIVATE_SHELL}" ]; then
+  # shell version set in pyenv-sh-activate should be unset
+  # https://github.com/yyuu/pyenv-virtualenv/issues/61
   echo "  pyenv shell --unset;"
+  case "$shell" in
+  fish )
+    echo "  set -e PYENV_ACTIVATE_SHELL;"
+    ;;
+  * )
+    echo "  unset PYENV_ACTIVATE_SHELL;"
+    ;;
+  esac
 fi
 
 case "$shell" in

bin/pyenv-virtualenv-init

@@ -76,12 +76,12 @@ fish )
   cat <<EOS
 function _pyenv_virtualenv_hook --on-event fish_prompt;
   if [ -n "\$PYENV_ACTIVATE" ]
-    if [ (pyenv version-name) = "system" ]
+    if [ (pyenv version-name 2>/dev/null; or true) = "system" ]
       pyenv deactivate --no-error --verbose
       set -e PYENV_DEACTIVATE
       return 0
     end
-    if [ "\$PYENV_ACTIVATE" != (pyenv prefix 2>/dev/null) ]
+    if [ "\$PYENV_ACTIVATE" != (pyenv prefix 2>/dev/null; or true) ]
       if pyenv deactivate --no-error --verbose
         set -e PYENV_DEACTIVATE
         pyenv activate --no-error --verbose; or set -e PYENV_DEACTIVATE
@@ -90,7 +90,7 @@ function _pyenv_virtualenv_hook --on-event fish_prompt;
       end
     end
   else
-    if [ -z "\$VIRTUAL_ENV" ]; and [ "\$PYENV_DEACTIVATE" != (pyenv prefix 2>/dev/null) ]
+    if [ -z "\$VIRTUAL_ENV" ]; and [ "\$PYENV_DEACTIVATE" != (pyenv prefix 2>/dev/null; or true) ]
       pyenv activate --no-error --verbose
     end
   end
@@ -112,12 +112,12 @@ esac
 if [[ "$shell" != "fish" ]]; then
   cat <<EOS
   if [ -n "\$PYENV_ACTIVATE" ]; then
-    if [ "\$(pyenv version-name)" = "system" ]; then
+    if [ "\$(pyenv version-name 2>/dev/null || true)" = "system" ]; then
       pyenv deactivate --no-error --verbose
       unset PYENV_DEACTIVATE
       return 0
     fi
-    if [ "\$PYENV_ACTIVATE" != "\$(pyenv prefix 2>/dev/null)" ]; then
+    if [ "\$PYENV_ACTIVATE" != "\$(pyenv prefix 2>/dev/null || true)" ]; then
       if pyenv deactivate --no-error --verbose; then
         unset PYENV_DEACTIVATE
         pyenv activate --no-error --verbose || unset PYENV_DEACTIVATE
@@ -126,7 +126,7 @@ if [[ "$shell" != "fish" ]]; then
       fi
     fi
   else
-    if [ -z "\$VIRTUAL_ENV" ] && [ "\$PYENV_DEACTIVATE" != "\$(pyenv prefix 2>/dev/null)" ]; then
+    if [ -z "\$VIRTUAL_ENV" ] && [ "\$PYENV_DEACTIVATE" != "\$(pyenv prefix 2>/dev/null || true)" ]; then
       pyenv activate --no-error --verbose
     fi
   fi

test/activate.bats

@@ -66,6 +66,7 @@ EOS
   assert_success
   assert_output <<EOS
 pyenv shell "venv";
+export PYENV_ACTIVATE_SHELL=1;
 unset PYENV_DEACTIVATE;
 export PYENV_ACTIVATE="${PYENV_ROOT}/versions/venv";
 . "${PYENV_ROOT}/versions/venv/bin/activate";
@@ -109,6 +110,7 @@ EOS
   assert_success
   assert_output <<EOS
 pyenv shell "venv";
+setenv PYENV_ACTIVATE_SHELL 1;
 set -e PYENV_DEACTIVATE;
 setenv PYENV_ACTIVATE "${PYENV_ROOT}/versions/venv";
 . "${PYENV_ROOT}/versions/venv/bin/activate.fish";
@@ -129,6 +131,7 @@ EOS
   assert_success
   assert_output <<EOS
 pyenv shell "venv27";
+export PYENV_ACTIVATE_SHELL=1;
 unset PYENV_DEACTIVATE;
 export PYENV_ACTIVATE="${PYENV_ROOT}/versions/venv27";
 . "${PYENV_ROOT}/versions/venv27/bin/activate";
@@ -149,6 +152,7 @@ EOS
   assert_success
   assert_output <<EOS
 pyenv shell "venv27";
+export PYENV_ACTIVATE_SHELL=1;
 unset PYENV_DEACTIVATE;
 export PYENV_ACTIVATE="${PYENV_ROOT}/versions/venv27";
 . "${PYENV_ROOT}/versions/venv27/bin/activate";

test/deactivate.bats

@@ -7,8 +7,8 @@ setup() {
 }
 
 @test "deactivate virtualenv" {
-  export PYENV_VIRTUALENV_INIT=1
   export PYENV_ACTIVATE="${PYENV_ROOT}/versions/venv"
+  export PYENV_ACTIVATE_SHELL=
 
   PYENV_SHELL="bash" run pyenv-sh-deactivate
 
@@ -26,8 +26,8 @@ EOS
 }
 
 @test "deactivate virtualenv (verbose)" {
-  export PYENV_VIRTUALENV_INIT=1
   export PYENV_ACTIVATE="${PYENV_ROOT}/versions/venv"
+  export PYENV_ACTIVATE_SHELL=
 
   PYENV_SHELL="bash" run pyenv-sh-deactivate --verbose
 
@@ -46,8 +46,8 @@ EOS
 }
 
 @test "deactivate virtualenv (no-error)" {
-  export PYENV_VIRTUALENV_INIT=1
   export PYENV_ACTIVATE="${PYENV_ROOT}/versions/venv"
+  export PYENV_ACTIVATE_SHELL=
 
   PYENV_SHELL="bash" run pyenv-sh-deactivate --no-error
 
@@ -63,9 +63,9 @@ fi;
 EOS
 }
 
-@test "deactivate virtualenv (without pyenv-virtualenv-init)" {
-  export PYENV_VIRTUALENV_INIT=
+@test "deactivate virtualenv (with shell activation)" {
   export PYENV_ACTIVATE="${PYENV_ROOT}/versions/venv"
+  export PYENV_ACTIVATE_SHELL=1
 
   PYENV_SHELL="bash" run pyenv-sh-deactivate
 
@@ -73,6 +73,7 @@ EOS
   assert_output <<EOS
 if declare -f deactivate 1>/dev/null 2>&1; then
   pyenv shell --unset;
+  unset PYENV_ACTIVATE_SHELL;
   export PYENV_DEACTIVATE="$PYENV_ACTIVATE";
   unset PYENV_ACTIVATE;
   deactivate;
@@ -83,9 +84,9 @@ fi;
 EOS
 }
 
-@test "deactivate virtualenv (without pyenv-virtualenv-init) (no-error)" {
-  export PYENV_VIRTUALENV_INIT=
+@test "deactivate virtualenv (with shell activation) (no-error)" {
   export PYENV_ACTIVATE="${PYENV_ROOT}/versions/venv"
+  export PYENV_ACTIVATE_SHELL=1
 
   PYENV_SHELL="bash" run pyenv-sh-deactivate --no-error
 
@@ -93,6 +94,7 @@ EOS
   assert_output <<EOS
 if declare -f deactivate 1>/dev/null 2>&1; then
   pyenv shell --unset;
+  unset PYENV_ACTIVATE_SHELL;
   export PYENV_DEACTIVATE="$PYENV_ACTIVATE";
   unset PYENV_ACTIVATE;
   deactivate;
@@ -103,8 +105,8 @@ EOS
 }
 
 @test "deactivate virtualenv which has been activated manually" {
-  export PYENV_VIRTUALENV_INIT=1
   export VIRTUAL_ENV="${PYENV_ROOT}/versions/venv"
+  export PYENV_ACTIVATE_SHELL=
 
   PYENV_SHELL="bash" run pyenv-sh-deactivate
 
@@ -122,8 +124,8 @@ EOS
 }
 
 @test "deactivate virtualenv (fish)" {
-  export PYENV_VIRTUALENV_INIT=1
   export PYENV_ACTIVATE="${PYENV_ROOT}/versions/venv"
+  export PYENV_ACTIVATE_SHELL=
 
   PYENV_SHELL="fish" run pyenv-sh-deactivate
 
@@ -141,8 +143,8 @@ EOS
 }
 
 @test "deactivate virtualenv (fish) (no-error)" {
-  export PYENV_VIRTUALENV_INIT=1
   export PYENV_ACTIVATE="${PYENV_ROOT}/versions/venv"
+  export PYENV_ACTIVATE_SHELL=
 
   PYENV_SHELL="fish" run pyenv-sh-deactivate --no-error
 
@@ -158,9 +160,9 @@ end;
 EOS
 }
 
-@test "deactivate virtualenv (fish) (without pyenv-virtualenv-init)" {
-  export PYENV_VIRTUALENV_INIT=
+@test "deactivate virtualenv (fish) (with shell activation)" {
   export PYENV_ACTIVATE="${PYENV_ROOT}/versions/venv"
+  export PYENV_ACTIVATE_SHELL=1
 
   PYENV_SHELL="fish" run pyenv-sh-deactivate
 
@@ -168,6 +170,7 @@ EOS
   assert_output <<EOS
 if functions -q deactivate;
   pyenv shell --unset;
+  set -e PYENV_ACTIVATE_SHELL;
   setenv PYENV_DEACTIVATE "$PYENV_ACTIVATE";
   set -e PYENV_ACTIVATE;
   deactivate;
@@ -178,9 +181,9 @@ end;
 EOS
 }
 
-@test "deactivate virtualenv (fish) (without pyenv-virtualenv-init) (no-error)" {
-  export PYENV_VIRTUALENV_INIT=
+@test "deactivate virtualenv (fish) (with shell activation) (no-error)" {
   export PYENV_ACTIVATE="${PYENV_ROOT}/versions/venv"
+  export PYENV_ACTIVATE_SHELL=1
 
   PYENV_SHELL="fish" run pyenv-sh-deactivate --no-error
 
@@ -188,6 +191,7 @@ EOS
   assert_output <<EOS
 if functions -q deactivate;
   pyenv shell --unset;
+  set -e PYENV_ACTIVATE_SHELL;
   setenv PYENV_DEACTIVATE "$PYENV_ACTIVATE";
   set -e PYENV_ACTIVATE;
   deactivate;
@@ -198,8 +202,8 @@ EOS
 }
 
 @test "deactivate virtualenv which has been activated manually (fish)" {
-  export PYENV_VIRTUALENV_INIT=1
   export VIRTUAL_ENV="${PYENV_ROOT}/versions/venv"
+  export PYENV_ACTIVATE_SHELL=
 
   PYENV_SHELL="fish" run pyenv-sh-deactivate
 

test/init.bats

@@ -32,12 +32,12 @@ load test_helper
 export PYENV_VIRTUALENV_INIT=1;
 _pyenv_virtualenv_hook() {
   if [ -n "\$PYENV_ACTIVATE" ]; then
-    if [ "\$(pyenv version-name)" = "system" ]; then
+    if [ "\$(pyenv version-name 2>/dev/null || true)" = "system" ]; then
       pyenv deactivate --no-error --verbose
       unset PYENV_DEACTIVATE
       return 0
     fi
-    if [ "\$PYENV_ACTIVATE" != "\$(pyenv prefix 2>/dev/null)" ]; then
+    if [ "\$PYENV_ACTIVATE" != "\$(pyenv prefix 2>/dev/null || true)" ]; then
       if pyenv deactivate --no-error --verbose; then
         unset PYENV_DEACTIVATE
         pyenv activate --no-error --verbose || unset PYENV_DEACTIVATE
@@ -46,7 +46,7 @@ _pyenv_virtualenv_hook() {
       fi
     fi
   else
-    if [ -z "\$VIRTUAL_ENV" ] && [ "\$PYENV_DEACTIVATE" != "\$(pyenv prefix 2>/dev/null)" ]; then
+    if [ -z "\$VIRTUAL_ENV" ] && [ "\$PYENV_DEACTIVATE" != "\$(pyenv prefix 2>/dev/null || true)" ]; then
       pyenv activate --no-error --verbose
     fi
   fi
@@ -64,12 +64,12 @@ EOS
 setenv PYENV_VIRTUALENV_INIT 1;
 function _pyenv_virtualenv_hook --on-event fish_prompt;
   if [ -n "\$PYENV_ACTIVATE" ]
-    if [ (pyenv version-name) = "system" ]
+    if [ (pyenv version-name 2>/dev/null; or true) = "system" ]
       pyenv deactivate --no-error --verbose
       set -e PYENV_DEACTIVATE
       return 0
     end
-    if [ "\$PYENV_ACTIVATE" != (pyenv prefix 2>/dev/null) ]
+    if [ "\$PYENV_ACTIVATE" != (pyenv prefix 2>/dev/null; or true) ]
       if pyenv deactivate --no-error --verbose
         set -e PYENV_DEACTIVATE
         pyenv activate --no-error --verbose; or set -e PYENV_DEACTIVATE
@@ -78,7 +78,7 @@ function _pyenv_virtualenv_hook --on-event fish_prompt;
       end
     end
   else
-    if [ -z "\$VIRTUAL_ENV" ]; and [ "\$PYENV_DEACTIVATE" != (pyenv prefix 2>/dev/null) ]
+    if [ -z "\$VIRTUAL_ENV" ]; and [ "\$PYENV_DEACTIVATE" != (pyenv prefix 2>/dev/null; or true) ]
       pyenv activate --no-error --verbose
     end
   end
@@ -93,12 +93,12 @@ EOS
 export PYENV_VIRTUALENV_INIT=1;
 _pyenv_virtualenv_hook() {
   if [ -n "\$PYENV_ACTIVATE" ]; then
-    if [ "\$(pyenv version-name)" = "system" ]; then
+    if [ "\$(pyenv version-name 2>/dev/null || true)" = "system" ]; then
       pyenv deactivate --no-error --verbose
       unset PYENV_DEACTIVATE
       return 0
     fi
-    if [ "\$PYENV_ACTIVATE" != "\$(pyenv prefix 2>/dev/null)" ]; then
+    if [ "\$PYENV_ACTIVATE" != "\$(pyenv prefix 2>/dev/null || true)" ]; then
       if pyenv deactivate --no-error --verbose; then
         unset PYENV_DEACTIVATE
         pyenv activate --no-error --verbose || unset PYENV_DEACTIVATE
@@ -107,7 +107,7 @@ _pyenv_virtualenv_hook() {
       fi
     fi
   else
-    if [ -z "\$VIRTUAL_ENV" ] && [ "\$PYENV_DEACTIVATE" != "\$(pyenv prefix 2>/dev/null)" ]; then
+    if [ -z "\$VIRTUAL_ENV" ] && [ "\$PYENV_DEACTIVATE" != "\$(pyenv prefix 2>/dev/null || true)" ]; then
       pyenv activate --no-error --verbose
     fi
   fi