evomedia/zscripts-token-savers
1
0
Fork 0
mirror of https://github.com/kellymichels/zscripts-token-savers synced 2026-10-07 07:18:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat(zstart): warn when falling back to system python (no project venv)

Browse Source 
A python project with no .venv (or only a Windows .venv when on WSL)
silently ran under the system interpreter, which usually lacks the
project's deps - producing a cryptic ModuleNotFoundError far from the
cause. Now zstart prints a clear warning naming the missing venv and the
one-liner to create it, before starting. Bash + PowerShell.
This commit is contained in:
KellyMichels 2026-07-23 17:51:59 -05:00
parent fd53acc23d
commit c4bf4a15af
2 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
bash/zstart
View File

@ -68,7 +68,7 @@ start_prep() { # <key>
} }
start_python() { # <key> <port> start_python() { # <key> <port>
local key="$1" port="$2" root module app exe bv="" run_cmd=() what local key="$1" port="$2" root module app exe bv="" run_cmd=() what using_venv=1
root="$(zproj_root "$key")" root="$(zproj_root "$key")"
module="$(zproj "$key" .startModule)" module="$(zproj "$key" .startModule)"
app="$(zproj "$key" .startApp)" app="$(zproj "$key" .startApp)"
@ -81,8 +81,8 @@ start_python() { # <key> <port>
# executable but can't exec, so guard that branch to fall through to python3. # executable but can't exec, so guard that branch to fall through to python3.
if [ -x "$root/.venv/bin/python" ]; then exe="$root/.venv/bin/python" if [ -x "$root/.venv/bin/python" ]; then exe="$root/.venv/bin/python"
elif [ -x "$root/.venv/Scripts/python.exe" ] && [[ "$OSTYPE" == msys* || "$OSTYPE" == cygwin* ]]; then exe="$root/.venv/Scripts/python.exe" elif [ -x "$root/.venv/Scripts/python.exe" ] && [[ "$OSTYPE" == msys* || "$OSTYPE" == cygwin* ]]; then exe="$root/.venv/Scripts/python.exe"
elif command -v python3 >/dev/null 2>&1; then exe="python3" elif command -v python3 >/dev/null 2>&1; then exe="python3"; using_venv=0
else exe="python"; fi else exe="python"; using_venv=0; fi
# Optional convention: scripts/build_version_tool.py bumps the version on dev start. # Optional convention: scripts/build_version_tool.py bumps the version on dev start.
if [ -f "$root/scripts/build_version_tool.py" ]; then if [ -f "$root/scripts/build_version_tool.py" ]; then
@ -102,6 +102,12 @@ start_python() { # <key> <port>
fi fi
printf '\n'; info "=== zstart ($(zproj "$key" .label)) ===" printf '\n'; info "=== zstart ($(zproj "$key" .label)) ==="
# No project venv found - warn, since the system interpreter usually lacks the
# app's deps (the failure would otherwise be a cryptic ModuleNotFoundError).
if [ "$using_venv" -eq 0 ]; then
warn "No project venv at $root/.venv - using system '$exe' (its deps may be missing)."
dim " Create one: (cd \"$root\" && python3 -m venv .venv && .venv/bin/pip install -e .)"
fi
info "Starting $what on port $port..." info "Starting $what on port $port..."
[ -n "$bv" ] && note "Build Version: $bv" [ -n "$bv" ] && note "Build Version: $bv"
show_project_motd "$root" show_project_motd "$root"

7
zstart.ps1
View File

@ -56,7 +56,8 @@ function Start-PythonProject {
} }
Set-Location -LiteralPath $root Set-Location -LiteralPath $root
$venvPython = Join-Path $root ".venv\Scripts\python.exe" $venvPython = Join-Path $root ".venv\Scripts\python.exe"
$exe = if (Test-Path -LiteralPath $venvPython) { $venvPython } else { "python" } $usingVenv = Test-Path -LiteralPath $venvPython
$exe = if ($usingVenv) { $venvPython } else { "python" }
# Optional convention: if the project ships scripts/build_version_tool.py, # Optional convention: if the project ships scripts/build_version_tool.py,
# bump (or at least read) the build version on every dev start. # bump (or at least read) the build version on every dev start.
@ -92,6 +93,10 @@ function Start-PythonProject {
Write-Host "" Write-Host ""
Write-Host "=== zstart ($($Proj.label)) ===" -ForegroundColor Cyan Write-Host "=== zstart ($($Proj.label)) ===" -ForegroundColor Cyan
if (-not $usingVenv) {
Write-Host "No project venv at $root\.venv - using system 'python' (its deps may be missing)." -ForegroundColor Yellow
Write-Host " Create one: python -m venv .venv; .\.venv\Scripts\pip install -e ." -ForegroundColor DarkGray
}
Write-Host "Starting $what on port $ListenPort..." -ForegroundColor Cyan Write-Host "Starting $what on port $ListenPort..." -ForegroundColor Cyan
if (-not [string]::IsNullOrWhiteSpace($buildVersion)) { if (-not [string]::IsNullOrWhiteSpace($buildVersion)) {
Write-Host "Build Version: $buildVersion" -ForegroundColor Magenta Write-Host "Build Version: $buildVersion" -ForegroundColor Magenta