various cleanup

Author: rickeylev

.bazelignore

@@ -25,6 +25,7 @@ examples/pip_parse/bazel-pip_parse
 examples/pip_parse_vendored/bazel-pip_parse_vendored
 examples/pip_repository_annotations/bazel-pip_repository_annotations
 examples/py_proto_library/bazel-py_proto_library
+gazelle/bazel-gazelle
 tests/integration/compile_pip_requirements/bazel-compile_pip_requirements
 tests/integration/ignore_root_user_error/bazel-ignore_root_user_error
 tests/integration/local_toolchains/bazel-local_toolchains

examples/bzlmod/BUILD.bazel

@@ -17,16 +17,10 @@ load("@rules_python//python:py_test.bzl", "py_test")
 # with pip-compile for a particular python version.
 compile_pip_requirements_3_10(
     name = "requirements_3_10",
-    ##timeout = "moderate",
-    ##src = "requirements.in",
-    ##src = "pyproject.toml",
-    srcs = [
-        # no sort
-        "pyproject.toml",
-        "b/pyproject.toml",
-    ],
+    timeout = "moderate",
+    src = "requirements.in",
     requirements_txt = "requirements_lock_3_10.txt",
-    #requirements_windows = "requirements_windows_3_10.txt",
+    requirements_windows = "requirements_windows_3_10.txt",
 )
 
 # The rules below are language specific rules defined in

python/private/py_executable.bzl

@@ -621,17 +621,14 @@ def _create_venv(ctx, output_prefix, imports, runtime_details):
     )
     site_packages_symlinks = _create_site_packages_symlinks(ctx, site_packages)
 
-    ##ctx.actions.write(site_customize,
-    ##                  "import site\nsite.addsitedir('{}')\n".format(
-
     return struct(
         interpreter = interpreter,
         recreate_venv_at_runtime = recreate_venv_at_runtime,
         # Runfiles root relative path or absolute path
         interpreter_actual_path = interpreter_actual_path,
         files_without_interpreter = [pyvenv_cfg, pth, site_init] + site_packages_symlinks,
+        # string; venv-relative path to the site-packages directory.
         venv_site_packages = venv_site_packages,
-        ##runtime_symlinks = runtime_symlinks,
     )
 
 def _create_site_packages_symlinks(ctx, site_packages):
@@ -753,8 +750,8 @@ def _create_stage2_bootstrap(
             "%imports%": ":".join(imports.to_list()),
             "%main%": main_py_path,
             "%main_module%": ctx.attr.main_module,
-            "%site_packages%": venv.venv_site_packages if venv else "",
             "%target%": str(ctx.label),
+            "%venv_rel_site_packages%": venv.venv_site_packages if venv else "",
             "%workspace_name%": ctx.workspace_name,
         },
         is_executable = True,

python/private/py_runtime_info.bzl

@@ -318,19 +318,21 @@ apply to Windows.
         "supports_build_time_venv": """
 :type: bool
 
-True if this toolchain supports creating a virtual env at runtime. False if not
-or unknown. If build-time venv creation isn't supported, then binaries may
+True if this toolchain supports the build-time created virtual environment.
+False if not or unknown. If build-time venv creation isn't supported, then binaries may
 fallback to non-venv solutions or creating a venv at runtime.
 
-In order to have a functionalal virtualenv created at build time, two criteria
-must be met:
-1. Specifying that the invoked interpreter (`$venv/bin/python3`, as reported by
-   `sys.executable`) isn't the real interpreter (e.g. `/usr/bin/python3`). This
-   typically requires relative symlinks or support for the `PYTHONEXECUTABLE`
-   environment variable.
-2. Creating a site-packages directory (`sys.prefix`) that the runtime
-   interpreter will recognize (e.g. `$venv/lib/python{version}/site-packages`).
-   This typically requires knowing the Python version at build time.
+In order to use the build-time created virtual environment, a toolchain needs
+to meet two criteria:
+1. Specifying the underlying executable (e.g. `/usr/bin/python3`, as reported by
+   `sys._base_executable`) for the venv executable (`$venv/bin/python3`, as reported
+   by `sys.executable`). This typically requires relative symlinking the venv
+   path to the underlying path at build time, or using the `PYTHONEXECUTABLE`
+   environment variable (Python 3.11+) at runtime.
+2. Having the build-time created site-packages directory
+   (`<venv>/lib/python{version}/site-packages`) recognized by the runtime
+   interpreter. This typically requires the Python version to be known at
+   build-time and match at runtime.
 
 :::{versionadded} VERSION_NEXT_FEATURE
 :::

python/private/pypi/pip_compile.bzl

@@ -165,10 +165,9 @@ def pip_compile(
 
     timeout = kwargs.pop("timeout", "short")
 
-    ##py_test(
-    py_binary(
+    py_test(
         name = name + "_test",
-        ##timeout = timeout,
+        timeout = timeout,
         # setuptools (the default python build tool) attempts to find user
         # configuration in the user's home direcotory. This seems to work fine on
         # linux and macOS, but fails on Windows, so we conditionally provide a fake

python/private/runtime_env_toolchain_interpreter.sh

@@ -67,10 +67,10 @@ if [[ -e "$self_dir/pyvenv.cfg" || -e "$self_dir/../pyvenv.cfg" ]]; then
 
   # PYTHONEXECUTABLE is also used because `exec -a` doesn't fully trick the
   # pyenv wrappers.
-  # NOTE: The PYTHONEXECUTABLE only works for non-Mac starting in Python 3.11
+  # NOTE: The PYTHONEXECUTABLE envvar only works for non-Mac starting in Python 3.11
   export PYTHONEXECUTABLE="$venv_bin"
-  # Use exec -a so that Python looks at the venv's binary, not the
-  # actual one invoked.
+  # Python looks at argv[0] to determine sys.executable, so use exec -a
+  # to make it think it's the venv's binary, not the actual one invoked.
   exec -a "$venv_bin" "$PYTHON_BIN" "$@"
 else
   exec "$PYTHON_BIN" "$@"

python/private/site_init_template.py

@@ -199,6 +199,7 @@ def _maybe_add_path(path):
 
     return coverage_setup
 
+
 # The pyvenv.cfg created for py_binary leaves the `home` key unset. A
 # side-effect of this is `sys._base_executable` points to the venv executable,
 # not the actual executable. This mostly doesn't matter, but does affect
@@ -215,6 +216,7 @@ def _fixup_sys_base_executable():
     _print_verbose("setting sys._base_executable:", exe)
     sys._base_executable = exe
 
+
 _fixup_sys_base_executable()
 
 COVERAGE_SETUP = _setup_sys_path()

python/private/stage1_bootstrap_template.sh

@@ -146,7 +146,6 @@ if [[ "$IS_ZIPFILE" == "1" ]]; then
   mkdir -p "$(dirname $python_exe)"
   ln -s "$symlink_to" "$python_exe"
 elif [[ "$RECREATE_VENV_AT_RUNTIME" == "1" ]]; then
-
   if [[ -n "$RULES_PYTHON_EXTRACT_ROOT" ]]; then
     use_exec=1
     # Use our runfiles path as a unique, reusable, location for the
@@ -169,13 +168,13 @@ elif [[ "$RECREATE_VENV_AT_RUNTIME" == "1" ]]; then
   if [[ ! -e "$python_exe" ]]; then
     if [[ "$PYTHON_BINARY_ACTUAL" == /* ]]; then
       # An absolute path, i.e. platform runtime, e.g. /usr/bin/python3
-      symlink_to=$PYTHON_BINARY_ACTUAL
+      python_exe_actual=$PYTHON_BINARY_ACTUAL
     elif [[ "$PYTHON_BINARY_ACTUAL" == */* ]]; then
       # A runfiles-relative path
-      symlink_to="$RUNFILES_DIR/$PYTHON_BINARY_ACTUAL"
+      python_exe_actual="$RUNFILES_DIR/$PYTHON_BINARY_ACTUAL"
     else
       # A plain word, e.g. "python3". Symlink to where PATH leads
-      symlink_to=$(which $PYTHON_BINARY_ACTUAL)
+      python_exe_actual=$(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"
@@ -202,13 +201,13 @@ elif [[ "$RECREATE_VENV_AT_RUNTIME" == "1" ]]; then
       {
         read -r resolved_py_exe
         read -r resolved_site_packages
-      } < <("$symlink_to" -I <<EOF
+      } < <("$python_exe_actual" -I <<EOF
 import sys, site, os
 print(sys.executable)
 print(site.getsitepackages(["$venv"])[-1])
 EOF
 )
-      symlink_to="$resolved_py_exe"
+      python_exe_actual="$resolved_py_exe"
       runfiles_venv_site_packages=$runfiles_venv/$VENV_REL_SITE_PACKAGES
       venv_site_packages="$resolved_site_packages"
     else
@@ -218,7 +217,7 @@ EOF
     fi
 
     mkdir -p "$venv/bin"
-    ln -s "$symlink_to" "$python_exe"
+    ln -s "$python_exe_actual" "$python_exe"
 
     if [[ ! -e "$venv_site_packages" ]]; then
       mkdir -p $(dirname $venv_site_packages)

python/private/stage2_bootstrap_template.py

@@ -34,7 +34,7 @@
 
 # venv-relative path to the expected location of the binary's site-packages
 # directory.
-VENV_SITE_PACKAGES = "%site_packages%"
+VENV_SITE_PACKAGES = "%venv_rel_site_packages%"
 
 # ===== Template substitutions end =====