merge in patches from noirbizarre to add support for MSYS environment; clean up doc addition; fix resulting problem is lsvirtualenv

Author: dhellmann

docs/en/history.rst

@@ -5,6 +5,9 @@ Release History
 dev
 
   - Use VIRTUALENVWRAPPER_VIRTUALENV in `cpvirtualenv` (:bbissue:`104`).
+  - Add support for `MSYS <http://www.mingw.org/wiki/MSYS>`_
+    environment under Windows. Contributed by Axel
+    H. (:bbuser:`noirbizarre`).
 
 2.7.2
 

docs/en/install.rst

@@ -196,3 +196,29 @@ supported.  In your startup file, change ``source
 /usr/local/bin/virtualenvwrapper.sh``.
 
 .. _pip: http://pypi.python.org/pypi/pip
+
+Using virtualenvwrapper Under MSys
+==================================
+
+It is possible to use virtualenv wrapper under `MSYS
+<http://www.mingw.org/wiki/MSYS>`_ with a native Windows Python
+installation.  In order to make it work, you need to define an extra
+environment variable named ``MSYS_HOME`` containing the root path to
+the MSYS installation.
+
+::
+
+    export WORKON_HOME=$HOME/.virtualenvs
+    export MSYS_HOME=/c/msys/1.0
+    source /usr/local/bin/virtualenvwrapper.sh
+
+or::
+
+    export WORKON_HOME=$HOME/.virtualenvs
+    export MSYS_HOME=C:\msys\1.0
+    source /usr/local/bin/virtualenvwrapper.sh
+
+Depending on your MSYS setup, you may need to install the `MSYS mktemp
+binary`_ in the ``MSYS_HOME/bin`` folder.
+
+.. _MSYS mktemp binary: http://sourceforge.net/projects/mingw/files/MSYS/mktemp/

virtualenvwrapper.sh

@@ -56,6 +56,15 @@ then
     VIRTUALENVWRAPPER_VIRTUALENV="virtualenv"
 fi
 
+# Define script folder depending on the platorm (Win32/Unix)
+VIRTUALENVWRAPPER_ENV_BIN_DIR="bin"
+if [ "$OS" = "Windows_NT" ] && [ "$MSYSTEM" = "MINGW32" ]
+then
+	# Only assign this for msys, cygwin use standard Unix paths
+	# and its own python installation 
+	VIRTUALENVWRAPPER_ENV_BIN_DIR="Scripts"
+fi
+
 virtualenvwrapper_derive_workon_home() {
     typeset workon_home_dir="$WORKON_HOME"
 
@@ -326,8 +335,8 @@ virtualenvwrapper_show_workon_options () {
     # NOTE: DO NOT use ls here because colorized versions spew control characters
     #       into the output list.
     # echo seems a little faster than find, even with -depth 3.
-    (\cd "$WORKON_HOME"; for f in */bin/activate; do echo $f; done) 2>/dev/null | \sed 's|^\./||' | \sed 's|/bin/activate||' | \sort | (unset GREP_OPTIONS; \egrep -v '^\*$')
-    
+    (\cd "$WORKON_HOME"; for f in */$VIRTUALENVWRAPPER_ENV_BIN_DIR/activate; do echo $f; done) 2>/dev/null | \sed 's|^\./||' | \sed "s|/$VIRTUALENVWRAPPER_ENV_BIN_DIR/activate||" | \sort | (unset GREP_OPTIONS; \egrep -v '^\*$')
+
 #    (\cd "$WORKON_HOME"; find -L . -depth 3 -path '*/bin/activate') | sed 's|^\./||' | sed 's|/bin/activate||' | sort
 }
 
@@ -342,23 +351,43 @@ _lsvirtualenv_usage () {
 #
 # Usage: lsvirtualenv [-l]
 lsvirtualenv () {
-    typeset -a args
-    args=($(getopt blh "$@"))
-    if [ $? != 0 ]
+    
+    typeset long_mode=true
+    if command -v "getopts" &> /dev/null 
     then
-        _lsvirtualenv_usage
-        return 1
+		# Use getopts when possible
+    	OPTIND=1
+		while getopts ":blh" opt "$@"
+		do
+			case "$opt" in
+				l) long_mode=true;;
+				b) long_mode=false;;
+				h)  _lsvirtualenv_usage;
+					return 1;;
+				?) echo "Invalid option: -$OPTARG" >&2;
+					_lsvirtualenv_usage;
+					return 1;;
+			esac
+		done
+    else
+    	# fallback on getopt for other shell
+	    typeset -a args
+	    args=($(getopt blh "$@"))
+	    if [ $? != 0 ]
+	    then
+	        _lsvirtualenv_usage
+	        return 1
+	    fi
+	    for opt in $args
+	    do
+	        case "$opt" in
+	            -l) long_mode=true;;
+	            -b) long_mode=false;;
+	            -h) _lsvirtualenv_usage;
+	                return 1;;
+	        esac
+	    done
     fi
-    typeset long_mode=true
-    for opt in $args
-    do
-        case "$opt" in
-            -l) long_mode=true;;
-            -b) long_mode=false;;
-            -h) _lsvirtualenv_usage;
-                return 1;;
-        esac
-    done
 
     if $long_mode
     then
@@ -406,7 +435,7 @@ workon () {
     virtualenvwrapper_verify_workon_home || return 1
     virtualenvwrapper_verify_workon_environment $env_name || return 1
 
-    activate="$WORKON_HOME/$env_name/bin/activate"
+    activate="$WORKON_HOME/$env_name/$VIRTUALENVWRAPPER_ENV_BIN_DIR/activate"
     if [ ! -f "$activate" ]
     then
         echo "ERROR: Environment '$WORKON_HOME/$env_name' does not contain an activate script." >&2
@@ -439,7 +468,7 @@ workon () {
         # any settings made by the local postactivate first.
         virtualenvwrapper_run_hook "pre_deactivate"
         
-        env_postdeactivate_hook="$VIRTUAL_ENV/bin/postdeactivate"
+        env_postdeactivate_hook="$VIRTUAL_ENV/$VIRTUALENVWRAPPER_ENV_BIN_DIR/postdeactivate"
         old_env=$(basename "$VIRTUAL_ENV")
         
         # Call the original function.
@@ -604,7 +633,7 @@ cpvirtualenv() {
     fi
 
     \cp -r "$source_env" "$target_env"
-    for script in $( \ls $target_env/bin/* )
+    for script in $( \ls $target_env/$VIRTUALENVWRAPPER_ENV_BIN_DIR/* )
     do
         newscript="$script-new"
         \sed "s|$source_env|$target_env|g" < "$script" > "$newscript"
@@ -613,7 +642,7 @@ cpvirtualenv() {
     done
 
     "$VIRTUALENVWRAPPER_VIRTUALENV" "$target_env" --relocatable
-    \sed "s/VIRTUAL_ENV\(.*\)$env_name/VIRTUAL_ENV\1$new_env/g" < "$source_env/bin/activate" > "$target_env/bin/activate"
+    \sed "s/VIRTUAL_ENV\(.*\)$env_name/VIRTUAL_ENV\1$new_env/g" < "$source_env/$VIRTUALENVWRAPPER_ENV_BIN_DIR/activate" > "$target_env/$VIRTUALENVWRAPPER_ENV_BIN_DIR/activate"
 
     (\cd "$WORKON_HOME" && ( 
         virtualenvwrapper_run_hook "pre_cpvirtualenv" "$env_name" "$new_env";

virtualenvwrapper/user_scripts.py

@@ -8,19 +8,32 @@
 
 import logging
 import os
+import re
 import stat
 import subprocess
+import sys
 
 import pkg_resources
 
 log = logging.getLogger(__name__)
 
+    
+# Are we running under msys
+if sys.platform == 'win32' and os.environ.get('OS') == 'Windows_NT' and os.environ.get('MSYSTEM') == 'MINGW32':
+    is_msys = True
+    script_folder = 'Scripts'
+else:
+    is_msys = False
+    script_folder = 'bin'
+
 
 def run_script(script_path, *args):
     """Execute a script in a subshell.
     """
     if os.path.exists(script_path):
         cmd = [script_path] + list(args)
+        if is_msys:
+            cmd = [get_path(os.environ['MSYS_HOME'],'bin','sh.exe')] + cmd
         log.debug('running %s', str(cmd))
         try:
             return_code = subprocess.call(cmd)
@@ -33,7 +46,7 @@ def run_script(script_path, *args):
 def run_global(script_name, *args):
     """Run a script from $VIRTUALENVWRAPPER_HOOK_DIR.
     """
-    script_path = os.path.expandvars(os.path.join('$VIRTUALENVWRAPPER_HOOK_DIR', script_name))
+    script_path = get_path('$VIRTUALENVWRAPPER_HOOK_DIR', script_name)
     run_script(script_path, *args)
     return
 
@@ -101,7 +114,7 @@ def make_hook(filename, comment):
     :param filename: The name of the file to write.
     :param comment: The comment to insert into the file.
     """
-    filename = os.path.expanduser(os.path.expandvars(filename))
+    filename = get_path(filename)
     if not os.path.exists(filename):
         log.info('creating %s', filename)
         f = open(filename, 'w')
@@ -122,7 +135,7 @@ def make_hook(filename, comment):
 
 def initialize(args):
     for filename, comment in GLOBAL_HOOKS:
-        make_hook(os.path.join('$VIRTUALENVWRAPPER_HOOK_DIR', filename), comment)
+        make_hook(get_path('$VIRTUALENVWRAPPER_HOOK_DIR', filename), comment)
     return
 
 
@@ -138,7 +151,7 @@ def pre_mkvirtualenv(args):
     log.debug('pre_mkvirtualenv %s', str(args))
     envname=args[0]
     for filename, comment in LOCAL_HOOKS:
-        make_hook(os.path.join('$WORKON_HOME', envname, 'bin', filename), comment)
+        make_hook(get_path('$WORKON_HOME', envname, script_folder, filename), comment)
     run_global('premkvirtualenv', *args)
     return
 
@@ -155,7 +168,7 @@ def pre_cpvirtualenv(args):
     log.debug('pre_cpvirtualenv %s', str(args))
     envname=args[0]
     for filename, comment in LOCAL_HOOKS:
-        make_hook(os.path.join('$WORKON_HOME', envname, 'bin', filename), comment)
+        make_hook(get_path('$WORKON_HOME', envname, script_folder, filename), comment)
     run_global('precpvirtualenv', *args)
     return
 
@@ -184,7 +197,7 @@ def post_rmvirtualenv(args):
 def pre_activate(args):
     log.debug('pre_activate')
     run_global('preactivate', *args)
-    script_path = os.path.expandvars(os.path.join('$WORKON_HOME', args[0], 'bin', 'preactivate'))
+    script_path = get_path('$WORKON_HOME', args[0], script_folder, 'preactivate')
     run_script(script_path, *args)
     return
 
@@ -196,7 +209,7 @@ def post_activate_source(args):
 # Run user-provided scripts
 #
 [ -f "$VIRTUALENVWRAPPER_HOOK_DIR/postactivate" ] && source "$VIRTUALENVWRAPPER_HOOK_DIR/postactivate"
-[ -f "$VIRTUAL_ENV/bin/postactivate" ] && source "$VIRTUAL_ENV/bin/postactivate"
+[ -f "$VIRTUAL_ENV/$VIRTUALENVWRAPPER_ENV_BIN_DIR/postactivate" ] && source "$VIRTUAL_ENV/$VIRTUALENVWRAPPER_ENV_BIN_DIR/postactivate"
 """
 
 
@@ -206,7 +219,7 @@ def pre_deactivate_source(args):
 #
 # Run user-provided scripts
 #
-[ -f "$VIRTUAL_ENV/bin/predeactivate" ] && source "$VIRTUAL_ENV/bin/predeactivate"
+[ -f "$VIRTUAL_ENV/$VIRTUALENVWRAPPER_ENV_BIN_DIR/predeactivate" ] && source "$VIRTUAL_ENV/$VIRTUALENVWRAPPER_ENV_BIN_DIR/predeactivate"
 [ -f "$VIRTUALENVWRAPPER_HOOK_DIR/predeactivate" ] && source "$VIRTUALENVWRAPPER_HOOK_DIR/predeactivate"
 """
 
@@ -227,6 +240,22 @@ def post_deactivate_source(args):
 def get_env_details(args):
     log.debug('get_env_details')
     run_global('get_env_details', *args)
-    script_path = os.path.expandvars(os.path.join('$WORKON_HOME', args[0], 'bin', 'get_env_details'))
+    script_path = get_path('$WORKON_HOME', args[0], script_folder, 'get_env_details')
     run_script(script_path, *args)
     return
+
+def get_path(*args):
+    '''
+    Get a full path from args.
+    Path separator is determined according to the os and the shell and allow to use is_msys.
+    Variables and user are expanded during the process.
+    '''
+    path = os.path.expanduser(os.path.expandvars(os.path.join(*args)))
+    if is_msys:
+        # MSYS accept unix or Win32 and sometimes it drives to mixed style paths
+        if re.match(r'^/[a-zA-Z](/|^)', path):
+            # msys path could starts with '/c/'-form drive letter
+            path = ''.join((path[1],':',path[2:]))
+        path = path.replace('/', os.sep)
+        
+    return os.path.abspath(path)