add lsvirtualenv command with -l option

Author: dhellmann

docs/en/command_ref.rst

@@ -45,6 +45,26 @@ new environment is automatically activated after being initialized.
    * :ref:`scripts-premkvirtualenv`
    * :ref:`scripts-postmkvirtualenv`
 
+.. _command-lsvirtualenv:
+
+lsvirtualenv
+------------
+
+List all of the environments.
+
+Syntax::
+
+    lsvirtualenv [-l] [-h]
+
+-l
+  Long mode, enables verbose output.
+-h
+  Print the help for lsvirtualenv.
+
+.. seealso::
+
+   * :ref:`scripts-get_env_details`
+
 rmvirtualenv
 ------------
 

docs/en/history.rst

@@ -2,6 +2,12 @@
 Release History
 ===============
 
+2.4
+
+  - Add ``lsvirtualenv`` command with ``-l`` option to run
+    ``get_env_details`` hook instead of always running it when
+    ``workon`` has no arguments.
+
 2.3
 
   - Added ``get_env_details`` hook.

setup.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 
 PROJECT = 'virtualenvwrapper'
-VERSION = '2.3'
+VERSION = '2.4'
 
 # Bootstrap installation of Distribute
 import distribute_setup

virtualenvwrapper.sh

@@ -240,20 +240,52 @@ virtualenvwrapper_show_workon_options () {
 #    (cd "$WORKON_HOME"; find -L . -depth 3 -path '*/bin/activate') | sed 's|^\./||' | sed 's|/bin/activate||' | sort
 }
 
-# List or change working virtual environments
-#
-# Usage: workon [environment_name]
+_lsvirtualenv_usage () {
+    echo "lsvirtualenv [-lh]"
+}
+
+# List virtual environments
 #
-workon () {
-	typeset env_name="$1"
-	if [ "$env_name" = "" ]
+# Usage: lsvirtualenv [-l]
+lsvirtualenv () {
+    typeset args=$(getopt lh $*)
+    if [ $? != 0 ]
+    then
+        _lsvirtualenv_usage
+        return 1
+    fi
+    typeset long_mode=false
+    for opt in $args
+    do
+        case "$opt" in
+            -l) long_mode=true;;
+            -h) _lsvirtualenv_usage;
+                return 1;;
+        esac
+    done
+
+    if $long_mode
     then
         for env_name in $(virtualenvwrapper_show_workon_options)
         do
             echo -n "$env_name"
             virtualenvwrapper_run_hook "get_env_details" "$env_name"
             echo
         done
+    else
+        virtualenvwrapper_show_workon_options
+    fi
+}
+
+# List or change working virtual environments
+#
+# Usage: workon [environment_name]
+#
+workon () {
+	typeset env_name="$1"
+	if [ "$env_name" = "" ]
+    then
+        lsvirtualenv
         return 1
     fi
 

virtualenvwrapper/user_scripts.py

@@ -95,7 +95,7 @@ def run_global(script_name, *args):
 
     # get_env_details
     ("get_env_details",
-     "This hook is run when the list of virtualenvs is printed so each name can include details."),
+     "This hook is run when the list of virtualenvs is printed in 'long' mode so each name can include details."),
     ]