comment out -x in stage1

Author: rickeylev

python/private/stage1_bootstrap_template.sh

@@ -5,13 +5,13 @@ set -e
 if [[ -n "${RULES_PYTHON_BOOTSTRAP_VERBOSE:-}" ]]; then
   set -x
 fi
-  set -x
+##  set -x
 
 # runfiles-relative path
 STAGE2_BOOTSTRAP="%stage2_bootstrap%"
 
 # runfiles-relative path to python interpreter to use.
-# This is the `bin/python3` file in the binary's venv.
+# This is the `bin/python3` path in the binary's venv.
 PYTHON_BINARY='%python_binary%'
 # The path that PYTHON_BINARY should symlink to.
 # runfiles-relative path, absolute path, or single word.
@@ -147,6 +147,7 @@ if [[ "$IS_ZIPFILE" == "1" ]]; then
   mkdir -p "$(dirname $python_exe)"
   ln -s "$symlink_to" "$python_exe"
 elif [[ "$RECREATE_VENV_AT_RUNTIME" == "1" ]]; then
+  runfiles_venv="$RUNFILES_DIR/$(dirname $(dirname $PYTHON_BINARY))"
 
   if [[ -n "$RULES_PYTHON_EXTRACT_ROOT" ]]; then
     use_exec=1
@@ -164,64 +165,71 @@ elif [[ "$RECREATE_VENV_AT_RUNTIME" == "1" ]]; then
     fi
   fi
 
-  if [[ "$PYTHON_BINARY_ACTUAL" == /* ]]; then
-    # An absolute path, i.e. platform runtime, e.g. /usr/bin/python3
-    symlink_to=$PYTHON_BINARY_ACTUAL
-  elif [[ "$PYTHON_BINARY_ACTUAL" == */* ]]; then
-    # A runfiles-relative path
-    symlink_to="$RUNFILES_DIR/$PYTHON_BINARY_ACTUAL"
-  else
-    # A plain word, e.g. "python3". Symlink to where PATH leads
-    symlink_to=$(which $PYTHON_BINARY_ACTUAL)
-    # Guard against trying to symlink to an empty value
-    if [[ $? -ne 0 ]]; then
-      echo >&2 "ERROR: Python to use not found on PATH: $PYTHON_BINARY_ACTUAL"
-      exit 1
-    fi
-  fi
+  # Match the basename; some tools, e.g. pyvenv key off the executable name
+  venv_py_exe="$venv/bin/$(basename $PYTHON_BINARY_ACTUAL)"
 
-  runfiles_venv="$RUNFILES_DIR/$(dirname $(dirname $PYTHON_BINARY))"
+  if [[ ! -e "$venv_py_exe" ]]; then
+    if [[ "$PYTHON_BINARY_ACTUAL" == /* ]]; then
+      # An absolute path, i.e. platform runtime, e.g. /usr/bin/python3
+      symlink_to=$PYTHON_BINARY_ACTUAL
+    elif [[ "$PYTHON_BINARY_ACTUAL" == */* ]]; then
+      # A runfiles-relative path
+      symlink_to="$RUNFILES_DIR/$PYTHON_BINARY_ACTUAL"
+    else
+      # A plain word, e.g. "python3". Symlink to where PATH leads
+      symlink_to=$(which $PYTHON_BINARY_ACTUAL)
+      # Guard against trying to symlink to an empty value
+      if [[ $? -ne 0 ]]; then
+        echo >&2 "ERROR: Python to use not found on PATH: $PYTHON_BINARY_ACTUAL"
+        exit 1
+      fi
+    fi
 
-  # If the interpreter is a wrapper script that invokes Python, and
-  # is prior to Python 3.11 (PYTHONEXECUTABLE environment variable), then
-  # we can only trigger venv behavior by symlinking to the actual underlying
-  # interpreter.
-  # Additionally, if the build-time lib/pythonX.Y/site-packages path doesn't
-  # match what the runtime interpreter is looking for (i.e. version mismatch
-  # between build vs runtime), then pretend the version mismatch is OK :D,
-  # and create the desired path in the temporary venv.
-  if [[ "$RESOLVE_PYTHON_BINARY_AT_RUNTIME" == "1" ]]; then
-    {
-      read -r resolved_py_exe
-      read -r resolved_site_packages
-    } < <("$symlink_to" -I <<EOF
+    # When RESOLVE_PYTHON_BINARY_AT_RUNTIME is true, it means the toolchain
+    # has thrown two complications at us:
+    # 1. The build-time assumption of the Python version may not match the
+    #    runtime Python version. The site-packages directory path includes the
+    #    Python version, so when the versions don't match, the runtime won't
+    #    find it.
+    # 2. The interpreter might be a wrapper script, which interferes with Python's
+    #    ability to detect when it's within a venv. Starting in Python 3.11,
+    #    the PYTHONEXECUTABLE environment variable can fix this, but due to (1),
+    #    we don't know if that is supported without running Python.
+    # To fix (1), we symlink the desired site-packages path to the build-time
+    # directory. Hopefully the version mismatch is OK :D.
+    # To fix (2), we determine the actual underlying interpreter and symlink
+    # to that.
+    if [[ "$RESOLVE_PYTHON_BINARY_AT_RUNTIME" == "1" ]]; then
+      {
+        read -r resolved_py_exe
+        read -r resolved_site_packages
+      } < <("$symlink_to" -I <<EOF
 import sys, site, os
 print(sys.executable)
 print(site.getsitepackages(["$venv"])[-1])
 EOF
 )
-    symlink_to="$resolved_py_exe"
-    runfiles_venv_site_packages=$runfiles_venv/$VENV_REL_SITE_PACKAGES
-    venv_site_packages="$resolved_site_packages"
-  else
-    # For simplicity, just symlink to the whole lib directory.
-    runfiles_venv_site_packages=$runfiles_venv/lib
-    venv_site_packages=$venv/lib
-  fi
+      symlink_to="$resolved_py_exe"
+      runfiles_venv_site_packages=$runfiles_venv/$VENV_REL_SITE_PACKAGES
+      venv_site_packages="$resolved_site_packages"
+    else
+      # For simplicity, just symlink to the whole lib directory.
+      runfiles_venv_site_packages=$runfiles_venv/lib
+      venv_site_packages=$venv/lib
+    fi
 
-  # Match the basename; some tools, e.g. pyvenv key off the executable name
-  python_exe="$venv/bin/$(basename $PYTHON_BINARY_ACTUAL)"
-  if [[ ! -e "$python_exe" ]]; then
     mkdir -p "$venv/bin"
     ln -s "$symlink_to" "$python_exe"
+
+    if [[ ! -e "$venv_site_packages" ]]; then
+      mkdir -p $(dirname $venv_site_packages)
+      ln -s "$runfiles_venv_site_packages" "$venv_site_packages"
+    fi
   fi
+
   if [[ ! -e "$venv/pyvenv.cfg" ]]; then
     ln -s "$runfiles_venv/pyvenv.cfg" "$venv/pyvenv.cfg"
   fi
-  if [[ ! -e "$venv_site_packages" ]]; then
-    mkdir -p $(dirname $venv_site_packages)
-    ln -s "$runfiles_venv_site_packages" "$venv_site_packages"
-  fi
 
 else
   use_exec=1