rename to venvs_use_declare_symlink

Author: rickeylev

CHANGELOG.md

@@ -78,7 +78,7 @@ Unreleased changes template.
 * (sphinxdocs) Do not crash when `tag_class` does not have a populated `doc` value.
   Fixes ([#2579](https://github.com/bazelbuild/rules_python/issues/2579)).
 * (binaries/tests) Fix packaging when using `--bootstrap_impl=script`: set
-  {obj}`--relative_venv_symlinks=no` to have it avoid creating symlinks at
+  {obj}`--venvs_use_declare_symlink=no` to have it avoid creating symlinks at
   build time.
   Fixes ([#2489](https://github.com/bazelbuild/rules_python/issues/2489)
 

docs/api/rules_python/python/config_settings/index.md

@@ -212,7 +212,7 @@ Values:
 :::
 ::::
 
-::::{bzl:flag} relative_venv_symlinks
+::::{bzl:flag} venvs_use_declare_symlink
 
 Determines if relative symlinks are created using `declare_symlink()` at build
 time.

docs/environment-variables.md

@@ -1,37 +1,9 @@
 # Environment Variables
 
-:::{envvar} RULES_PYTHON_REPO_DEBUG
-
-When `1`, repository rules will print debug information about what they're
-doing. This is mostly useful for development to debug errors.
-:::
-
-:::{envvar} RULES_PYTHON_REPO_DEBUG_VERBOSITY
-
-Determines the verbosity of logging output for repo rules. Valid values:
-
-* `DEBUG`
-* `INFO`
-* `TRACE`
-:::
-
-:::{envvar} RULES_PYTHON_REPO_TOOLCHAIN_VERSION_OS_ARCH
-
-Determines the python interpreter platform to be used for a particular
-interpreter `(version, os, arch)` triple to be used in repository rules.
-Replace the `VERSION_OS_ARCH` part with actual values when using, e.g.
-`3_13_0_linux_x86_64`. The version values must have `_` instead of `.` and the
-os, arch values are the same as the ones mentioned in the
-`//python:versions.bzl` file.
-:::
-
-:::{envvar} RULES_PYTHON_PIP_ISOLATED
-
-Determines if `--isolated` is used with pip.
+:::{envvar} RULES_PYTHON_BOOTSTRAP_VERBOSE
 
-Valid values:
-* `0` and `false` mean to not use isolated mode
-* Other non-empty values mean to use isolated mode.
+When `1`, debug information about bootstrapping of a program is printed to
+stderr.
 :::
 
 :::{envvar} RULES_PYTHON_BZLMOD_DEBUG
@@ -52,23 +24,6 @@ When `1`, the rules_python Starlark implementation of the core rules is used
 instead of the Bazel-builtin rules. Note this requires Bazel 7+.
 :::
 
-:::{envvar} RULES_PYTHON_BOOTSTRAP_VERBOSE
-
-When `1`, debug information about bootstrapping of a program is printed to
-stderr.
-:::
-
-:::{envvar} VERBOSE_COVERAGE
-
-When `1`, debug information about coverage behavior is printed to stderr.
-:::
-
-
-:::{envvar} RULES_PYTHON_GAZELLE_VERBOSE
-
-When `1`, debug information from gazelle is printed to stderr.
-:::
-
 :::{envvar} RULES_PYTHON_EXTRACT_ROOT
 
 Directory to use as the root for creating files necessary for bootstrapping so
@@ -89,3 +44,47 @@ being cleaned up by the OS.
 If not set, then a temporary directory will be created and deleted upon program
 exit.
 :::
+
+:::{envvar} RULES_PYTHON_GAZELLE_VERBOSE
+
+When `1`, debug information from gazelle is printed to stderr.
+:::
+
+:::{envvar} RULES_PYTHON_PIP_ISOLATED
+
+Determines if `--isolated` is used with pip.
+
+Valid values:
+* `0` and `false` mean to not use isolated mode
+* Other non-empty values mean to use isolated mode.
+:::
+
+:::{envvar} RULES_PYTHON_REPO_DEBUG
+
+When `1`, repository rules will print debug information about what they're
+doing. This is mostly useful for development to debug errors.
+:::
+
+:::{envvar} RULES_PYTHON_REPO_DEBUG_VERBOSITY
+
+Determines the verbosity of logging output for repo rules. Valid values:
+
+* `DEBUG`
+* `INFO`
+* `TRACE`
+:::
+
+:::{envvar} RULES_PYTHON_REPO_TOOLCHAIN_VERSION_OS_ARCH
+
+Determines the python interpreter platform to be used for a particular
+interpreter `(version, os, arch)` triple to be used in repository rules.
+Replace the `VERSION_OS_ARCH` part with actual values when using, e.g.
+`3_13_0_linux_x86_64`. The version values must have `_` instead of `.` and the
+os, arch values are the same as the ones mentioned in the
+`//python:versions.bzl` file.
+:::
+
+:::{envvar} VERBOSE_COVERAGE
+
+When `1`, debug information about coverage behavior is printed to stderr.
+:::

python/config_settings/BUILD.bazel

@@ -9,7 +9,7 @@ load(
     "LibcFlag",
     "PrecompileFlag",
     "PrecompileSourceRetentionFlag",
-    "RelativeVenvSymlinksFlag",
+    "VenvsUseDeclareSymlinkFlag",
 )
 load(
     "//python/private/pypi:flags.bzl",
@@ -123,9 +123,9 @@ config_setting(
 )
 
 string_flag(
-    name = "relative_venv_symlinks",
-    build_setting_default = RelativeVenvSymlinksFlag.YES,
-    values = RelativeVenvSymlinksFlag.flag_values(),
+    name = "venvs_use_declare_symlink",
+    build_setting_default = VenvsUseDeclareSymlinkFlag.YES,
+    values = VenvsUseDeclareSymlinkFlag.flag_values(),
     visibility = ["//visibility:public"],
 )
 

python/private/flags.bzl

@@ -123,19 +123,19 @@ PrecompileSourceRetentionFlag = enum(
     get_effective_value = _precompile_source_retention_flag_get_effective_value,
 )
 
-def _relative_venv_symlinks_flag_get_value(ctx):
-    return ctx.attr._relative_venv_symlinks_flag[BuildSettingInfo].value
+def _venvs_use_declare_symlink_flag_get_value(ctx):
+    return ctx.attr._venvs_use_declare_symlink_flag[BuildSettingInfo].value
 
 # Decides if the venv created by bootstrap=script uses declare_file() to
 # create relative symlinks. Workaround for #2489 (packaging rules not supporting
 # declare_link() files).
 # buildifier: disable=name-conventions
-RelativeVenvSymlinksFlag = FlagEnum(
+VenvsUseDeclareSymlinkFlag = FlagEnum(
     # Use declare_file() and relative symlinks in the venv
     YES = "yes",
     # Do not use declare_file() and relative symlinks in the venv
     NO = "no",
-    get_value = _relative_venv_symlinks_flag_get_value,
+    get_value = _venvs_use_declare_symlink_flag_get_value,
 )
 
 # Used for matching freethreaded toolchains and would have to be used in wheels

python/private/py_executable.bzl

@@ -51,7 +51,7 @@ load(
     "target_platform_has_any_constraint",
     "union_attrs",
 )
-load(":flags.bzl", "BootstrapImplFlag", "RelativeVenvSymlinksFlag")
+load(":flags.bzl", "BootstrapImplFlag", "VenvsUseDeclareSymlinkFlag")
 load(":precompile.bzl", "maybe_precompile")
 load(":py_cc_link_params_info.bzl", "PyCcLinkParamsInfo")
 load(":py_executable_info.bzl", "PyExecutableInfo")
@@ -195,8 +195,8 @@ accepting arbitrary Python versions.
         "_python_version_flag": attr.label(
             default = "//python/config_settings:python_version",
         ),
-        "_relative_venv_symlinks_flag": attr.label(
-            default = "//python/config_settings:relative_venv_symlinks",
+        "_venvs_use_declare_symlink_flag": attr.label(
+            default = "//python/config_settings:venvs_use_declare_symlink",
             providers = [BuildSettingInfo],
         ),
         "_windows_constraints": attr.label_list(
@@ -516,11 +516,11 @@ def _create_venv(ctx, output_prefix, imports, runtime_details):
     ctx.actions.write(pyvenv_cfg, "")
 
     runtime = runtime_details.effective_runtime
-    relative_venv_symlinks_enabled = (
-        RelativeVenvSymlinksFlag.get_value(ctx) == RelativeVenvSymlinksFlag.YES
+    venvs_use_declare_symlink_enabled = (
+        VenvsUseDeclareSymlinkFlag.get_value(ctx) == VenvsUseDeclareSymlinkFlag.YES
     )
 
-    if not relative_venv_symlinks_enabled:
+    if not venvs_use_declare_symlink_enabled:
         if runtime.interpreter:
             interpreter_actual_path = _runfiles_root_path(ctx, runtime.interpreter.short_path)
         else:
@@ -593,7 +593,7 @@ def _create_venv(ctx, output_prefix, imports, runtime_details):
 
     return struct(
         interpreter = interpreter,
-        recreate_venv_at_runtime = not relative_venv_symlinks_enabled,
+        recreate_venv_at_runtime = not venvs_use_declare_symlink_enabled,
         # Runfiles root relative path or absolute path
         interpreter_actual_path = interpreter_actual_path,
         files_without_interpreter = [pyvenv_cfg, pth, site_init],

tests/bootstrap_impls/BUILD.bazel

@@ -62,12 +62,12 @@ sh_py_run_test(
 )
 
 sh_py_run_test(
-    name = "run_binary_relative_venv_symlinks_no_test",
+    name = "run_binary_venvs_use_declare_symlink_no_test",
     bootstrap_impl = "script",
     py_src = "bin.py",
-    relative_venv_symlinks = "no",
-    sh_src = "run_binary_relative_venv_symlinks_no_test.sh",
+    sh_src = "run_binary_venvs_use_declare_symlink_no_test.sh",
     target_compatible_with = SUPPORTS_BOOTSTRAP_SCRIPT,
+    venvs_use_declare_symlink = "no",
 )
 
 sh_py_run_test(

tests/bootstrap_impls/run_binary_relative_venv_symlinks_no_test.sh renamed to tests/bootstrap_impls/run_binary_venvs_use_declare_symlink_no_test.sh

@@ -30,10 +30,10 @@ py_reconfig_test(
     srcs = ["bin.py"],
     bootstrap_impl = "script",
     main = "bin.py",
+    target_compatible_with = SUPPORTS_BOOTSTRAP_SCRIPT,
     # Needed until https://github.com/bazelbuild/rules_pkg/issues/929 is fixed
     # See: https://github.com/bazelbuild/rules_python/issues/2489
-    relative_venv_symlinks = "no",
-    target_compatible_with = SUPPORTS_BOOTSTRAP_SCRIPT,
+    venvs_use_declare_symlink = "no",
 )
 
 pkg_tar(

tests/packaging/BUILD.bazel

@@ -33,8 +33,8 @@ def _perform_transition_impl(input_settings, attr):
         settings["//command_line_option:extra_toolchains"] = attr.extra_toolchains
     if attr.python_version:
         settings["//python/config_settings:python_version"] = attr.python_version
-    if attr.relative_venv_symlinks:
-        settings["//python/config_settings:relative_venv_symlinks"] = attr.relative_venv_symlinks
+    if attr.venvs_use_declare_symlink:
+        settings["//python/config_settings:venvs_use_declare_symlink"] = attr.venvs_use_declare_symlink
     return settings
 
 _perform_transition = transition(
@@ -43,14 +43,14 @@ _perform_transition = transition(
         "//python/config_settings:bootstrap_impl",
         "//command_line_option:extra_toolchains",
         "//python/config_settings:python_version",
-        "//python/config_settings:relative_venv_symlinks",
+        "//python/config_settings:venvs_use_declare_symlink",
     ],
     outputs = [
         "//command_line_option:build_python_zip",
         "//command_line_option:extra_toolchains",
         "//python/config_settings:bootstrap_impl",
         "//python/config_settings:python_version",
-        "//python/config_settings:relative_venv_symlinks",
+        "//python/config_settings:venvs_use_declare_symlink",
         VISIBLE_FOR_TESTING,
     ],
 )
@@ -109,8 +109,8 @@ toolchain.
 """,
         ),
         "python_version": attr.string(),
-        "relative_venv_symlinks": attr.string(),
         "target": attr.label(executable = True, cfg = "target"),
+        "venvs_use_declare_symlink": attr.string(),
         "_allowlist_function_transition": attr.label(
             default = "@bazel_tools//tools/allowlists/function_transition_allowlist",
         ),
@@ -133,7 +133,7 @@ def _py_reconfig_executable(*, name, py_reconfig_rule, py_inner_rule, **kwargs):
         "build_python_zip",
         "extra_toolchains",
         "python_version",
-        "relative_venv_symlinks",
+        "venvs_use_declare_symlink",
     ]
     reconfig_kwargs = {
         key: kwargs.pop(key, None)