Merge pull request #93 from dhellmann/project-dir-hook-files

add project hook scripts

Author: mergify[bot]

docs/source/history.rst

@@ -1,6 +1,12 @@
 CHANGES
 =======
 
+Next
+----
+
+* Look for `./.virtualenvwrapper/postactivate` and
+  `./.virtualenvwrapper/predeactivate` hook scripts.
+
 6.0.0.0a5
 ---------
 

docs/source/projects.rst

@@ -31,6 +31,22 @@ site, combine the :ref:`templates-bitbucket` and
 
     $ mkproject -t bitbucket -t django my_site
 
+Project Hook Files
+==================
+
+The project directory can include additional hook files for the
+`postactivate` and `predeactivate` hooks. Placing hook scripts in the
+project hook directory, `.virtualenvwrapper`, allows them to be
+checked into version control and shared more easily.
+
+When the :ref:`scripts-postactivate` hook runs, it looks for
+`.virtualenvwrapper/postactivate` within the project directory and if
+it is found it sources the file.
+
+When the :ref:`scripts-predeactivate` hook runs, it looks for
+`.virtualenvwrapper/predeactivate` within the project directory and if
+it is found it sources the file.
+
 .. seealso::
 
    * :ref:`extensions-templates`

pyproject.toml

@@ -93,6 +93,7 @@ project = "virtualenvwrapper.project:post_activate_source"
 user_scripts = "virtualenvwrapper.user_scripts:post_activate_source"
 
 [project.entry-points."virtualenvwrapper.pre_deactivate_source"]
+project = "virtualenvwrapper.project:pre_deactivate_source"
 user_scripts = "virtualenvwrapper.user_scripts:pre_deactivate_source"
 
 [project.entry-points."virtualenvwrapper.post_deactivate_source"]

tests/test_project.sh

@@ -52,4 +52,24 @@ test_virtualenvwrapper_verify_project_home_missing_dir() {
     PROJECT_HOME="$old_home"
 }
 
+test_virtualenvwrapper_postactivate_hook() {
+    load_wrappers
+    mkproject "test_project_hook"
+    mkdir .virtualenvwrapper
+    echo "export TEST_PROJECT_HOOK_VAR=true" > .virtualenvwrapper/postactivate
+    echo "unset TEST_PROJECT_HOOK_VAR" > .virtualenvwrapper/predeactivate
+    deactivate
+
+    # Variable should not be set to start
+    assertSame "${TEST_PROJECT_HOOK_VAR}" ""
+
+    # Activating the env should set it
+    workon "test_project_hook"
+    assertSame "true" "${TEST_PROJECT_HOOK_VAR}"
+
+    # Deactivating should unset it
+    deactivate
+    assertSame "" "${TEST_PROJECT_HOOK_VAR}"
+}
+
 . "$test_dir/shunit2"

tox.ini

@@ -23,6 +23,9 @@ setenv =
 deps = .[linter]
 commands = flake8 virtualenvwrapper docs/source/conf.py
 
+[flake8]
+max-line-length = 200
+
 [testenv:zsh]
 setenv =
   USING_TOX = 1

virtualenvwrapper/project.py

@@ -8,7 +8,7 @@
 import logging
 import os
 
-from virtualenvwrapper.user_scripts import make_hook, run_global, PERMISSIONS
+from virtualenvwrapper.user_scripts import PERMISSIONS, make_hook, run_global
 
 log = logging.getLogger(__name__)
 
@@ -58,4 +58,19 @@ def post_activate_source(args):
   -a "$VIRTUALENVWRAPPER_PROJECT_CD" = 1 ] && \
     virtualenvwrapper_cd \
         "$(cat \"$VIRTUAL_ENV/$VIRTUALENVWRAPPER_PROJECT_FILENAME\")"
+if [ -f "$VIRTUAL_ENV/$VIRTUALENVWRAPPER_PROJECT_FILENAME" ]; then
+    if [ -f "$(cat \"$VIRTUAL_ENV/$VIRTUALENVWRAPPER_PROJECT_FILENAME\")/.virtualenvwrapper/postactivate" ]; then
+        source "$(cat \"$VIRTUAL_ENV/$VIRTUALENVWRAPPER_PROJECT_FILENAME\")/.virtualenvwrapper/postactivate"
+    fi
+fi
+"""
+
+
+def pre_deactivate_source(args):
+    return """
+if [ -f "$VIRTUAL_ENV/$VIRTUALENVWRAPPER_PROJECT_FILENAME" ]; then
+    if [ -f "$(cat \"$VIRTUAL_ENV/$VIRTUALENVWRAPPER_PROJECT_FILENAME\")/.virtualenvwrapper/predeactivate" ]; then
+        source "$(cat \"$VIRTUAL_ENV/$VIRTUALENVWRAPPER_PROJECT_FILENAME\")/.virtualenvwrapper/predeactivate"
+    fi
+fi
 """