Make poetry venv path static (#2076)

* Make poetry venv path static

- Disable auto venv creation for dev containers
- Manually create the poetry venv with a static path
- Set vscode default interpreter path to the static venv
- Ensure all shells started post container creation auto-activate the venv

* Make the venv path a variable

* Fix env path

* Rename venv to generic name: workspace

---------

Co-authored-by: Jumana B <[email protected]>

.devcontainer/devcontainer.json

@@ -39,6 +39,8 @@
 				"[python]": {
 					"editor.defaultFormatter": "charliermarsh.ruff"
 				},
+				"python.defaultInterpreterPath": "/home/vscode/.venv/workspace/bin/python",
+				"python.venvPath": "/home/vscode/.venv",
 				"useAdminDebug": true,
 				"debug.default.configuration": "Python: Remote Attach",
 				"debug.toolBarLocation": "docked",
@@ -127,7 +129,7 @@
 						}
 					]
 				}
-			}			
+			}
 		}
 	},
 	"features": {

.devcontainer/scripts/installations.sh

@@ -2,6 +2,7 @@
 set -ex
 
 export POETRY_VERSION="1.7.1"
+export POETRY_VENV_PATH="/home/vscode/.venv/workspace"
 
 # Define aliases
 echo -e "\n\n# User's Aliases" >> ~/.zshrc
@@ -21,26 +22,35 @@ echo -e "source /usr/share/doc/fzf/examples/completion.zsh" >> ~/.zshrc
 echo -e "fpath+=/.zfunc" >> ~/.zshrc
 echo -e "autoload -Uz compinit && compinit"
 
-# Install Poetry
+# Install and configure Poetry
 pip install poetry==${POETRY_VERSION} poetry-plugin-sort
 echo "PATH=$PATH"
 #echo "/home/vscode/.local/bin/.."
 export PATH=$PATH:/home/vscode/.local/bin/
 which poetry
 poetry --version
+# Disable poetry auto-venv creation
+poetry config virtualenvs.create false
 
 # Initialize poetry autocompletions
 mkdir -p ~/.zfunc
 touch ~/.zfunc/_poetry
 poetry completions zsh > ~/.zfunc/_poetry
 
+# Manually create and activate a virtual environment with a static path
+python -m venv ${POETRY_VENV_PATH}
+source ${POETRY_VENV_PATH}/bin/activate
+
 # Set up git blame to ignore certain revisions e.g. sweeping code formatting changes.
 cd /workspace
 git config blame.ignoreRevsFile .git-blame-ignore-revs
 
 # Install dependencies
 poetry install
 
+# Ensure newly created shells activate the poetry venv
+echo "source ${POETRY_VENV_PATH}/bin/activate" >> ~/.zshrc
+
 # Poe the Poet plugin tab completions
 touch ~/.zfunc/_poe
 poetry run poe _zsh_completion > ~/.zfunc/_poe