-
Notifications
You must be signed in to change notification settings - Fork 269
[Python] Change .venv
script to be more compatible with IDEs
#2259
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -1,8 +1,92 @@ | ||||||
#!/bin/sh | ||||||
set -eu | ||||||
STATE_FILE="$DEVBOX_PROJECT_ROOT/.devbox/venv_check_completed" | ||||||
echo $STATE_FILE | ||||||
|
||||||
|
||||||
if ! [ -d "$VENV_DIR" ]; then | ||||||
echo "Creating new venv environment in path: '${VENV_DIR}'" | ||||||
python3 -m venv "$VENV_DIR" | ||||||
echo "You can activate the virtual environment by running '. \$VENV_DIR/bin/activate' (for fish shell, replace '.' with 'source')" >&2 | ||||||
is_valid_venv() { | ||||||
[ -f "$1/bin/activate" ] && [ -f "$1/bin/python" ] | ||||||
} | ||||||
|
||||||
# Function to check if Python is a symlink to a Devbox Python | ||||||
is_devbox_python() { | ||||||
|
||||||
if [ -z "$DEVBOX_PACKAGES_DIR" ]; then | ||||||
echo "DEVBOX_PACKAGES_DIR is not set. Unable to check for Devbox Python." | ||||||
return 1 | ||||||
fi | ||||||
local python_path="$1/bin/python" | ||||||
local link_target | ||||||
|
||||||
while true; do | ||||||
if [ ! -L "$python_path" ]; then | ||||||
# Not a symlink, we're done | ||||||
break | ||||||
fi | ||||||
|
||||||
link_target=$(readlink "$python_path") | ||||||
echo "Checking symlink: $link_target" | ||||||
|
||||||
if [[ "$link_target" == /* ]]; then | ||||||
# Absolute path, we're done | ||||||
python_path="$link_target" | ||||||
break | ||||||
elif [[ "$link_target" == python* ]] || [[ "$link_target" == ./* ]] || [[ "$link_target" == ../* ]]; then | ||||||
# Relative path or python symlink, continue resolving | ||||||
python_path=$(dirname "$python_path")/"$link_target" | ||||||
else | ||||||
# Unexpected format, stop here | ||||||
break | ||||||
fi | ||||||
done | ||||||
|
||||||
[[ $python_path == $DEVBOX_PACKAGES_DIR/* ]] | ||||||
} | ||||||
|
||||||
# Function to check Python version | ||||||
check_python_version() { | ||||||
python_version=$(python -c 'import sys; print(".".join(map(str, sys.version_info[:2])))') | ||||||
if [ "$(printf '%s\n' "3.3" "$python_version" | sort -V | head -n1)" = "3.3" ]; then | ||||||
return 0 | ||||||
else | ||||||
return 1 | ||||||
fi | ||||||
} | ||||||
|
||||||
# Check if we've already run this script | ||||||
if [ -f "$STATE_FILE" ]; then | ||||||
# "We've already run this script. Exiting..." | ||||||
exit 0 | ||||||
fi | ||||||
|
||||||
# Check Python version | ||||||
if ! check_python_version; then | ||||||
|
if ! check_python_version; then | |
if ! python -c "import venv" &>/dev/null; then |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah that's a much nicer approach
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Had to tweak this because for some reason it was failing the automated tests (but not when run locally)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does this work after the user has updated their python version?
i.e. by creating the state-file, will it skip running again to create the venv after upgrading python
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes it should, because the python in the venv is a symlink to the python in our Devbox profile, which is a symlink to the nix store. I'll test a few times to make sure
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Confirmed, once the .venv
is created, updating python automatically updates the python linked in the .venv
folder
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you can use python3 -m venv --clear
to overwrite.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,14 @@ | ||
{ | ||
"name": "python", | ||
"version": "0.0.3", | ||
"description": "Python in Devbox works best when used with a virtual environment (vent, virtualenv, etc.). Devbox will automatically create a virtual environment using `venv` for python3 projects, so you can install packages with pip as normal.\nTo activate the environment, run `. $VENV_DIR/bin/activate` or add it to the init_hook of your devbox.json\nTo change where your virtual environment is created, modify the $VENV_DIR environment variable in your init_hook", | ||
"version": "0.0.4", | ||
"description": "Python in Devbox works best when used with a virtual environment (venv, virtualenv, etc.). Devbox will automatically create a virtual environment using `venv` for python3 projects, so you can install packages with pip as normal.\nTo activate the environment, run `. $VENV_DIR/bin/activate` or add it to the init_hook of your devbox.json\nTo change where your virtual environment is created, modify the $VENV_DIR environment variable in your init_hook", | ||
"env": { | ||
/* | ||
This is a block comment | ||
*/ | ||
"VENV_DIR": "{{ .Virtenv }}/.venv" | ||
"VENV_DIR": "{{ .DevboxProjectDir }}/.venv" | ||
}, | ||
"create_files": { | ||
"{{ .Virtenv }}/bin/venvShellHook.sh": "pip/venvShellHook.sh" | ||
"{{ .Virtenv }}/bin/venvShellHook.sh": "pip/venvShellHook.sh" | ||
}, | ||
// this is a line comment above shell | ||
"shell": { | ||
"init_hook": [ | ||
"{{ .Virtenv }}/bin/venvShellHook.sh" | ||
] | ||
"init_hook": ["{{ .Virtenv }}/bin/venvShellHook.sh"] | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why get rid of the shebang?