Allow spaces in whl_librarys

Author: mark-thm

python/private/glob_excludes.bzl

@@ -0,0 +1,34 @@
+# Copyright 2024 The Bazel Authors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"Utilities for glob exclusions."
+
+def _version_dependent_exclusions():
+    """Returns glob exclusions that are sensitive to Bazel version.
+
+    Bazel 7.4.0+ added support for files with spaces. Prior versions of Bazel
+    do not support files with spaces.
+
+    Returns:
+        a list of glob exclusion patterns
+    """
+    major, minor, _ = native.bazel_version.split(".")
+    if major < 7 or (major == 7 and minor < 4):
+        return ["**/* *"]
+    else:
+        return []
+
+glob_excludes = struct(
+    version_dependent_exclusions = _version_dependent_exclusions,
+)

python/private/hermetic_runtime_repo_setup.bzl

@@ -17,6 +17,7 @@ load("@rules_cc//cc:defs.bzl", "cc_import", "cc_library")
 load("//python:py_runtime.bzl", "py_runtime")
 load("//python:py_runtime_pair.bzl", "py_runtime_pair")
 load("//python/cc:py_cc_toolchain.bzl", "py_cc_toolchain")
+load(":glob_excludes.bzl", "glob_excludes")
 load(":py_exec_tools_toolchain.bzl", "py_exec_tools_toolchain")
 load(":semver.bzl", "semver")
 
@@ -64,7 +65,6 @@ def define_hermetic_runtime_toolchain_impl(
             # Platform-agnostic filegroup can't match on all patterns.
             allow_empty = True,
             exclude = [
-                "**/* *",  # Bazel does not support spaces in file names.
                 # Unused shared libraries. `python` executable and the `:libpython` target
                 # depend on `libpython{python_version}.so.1.0`.
                 "lib/libpython{major}.{minor}.so".format(**version_dict),
@@ -74,7 +74,7 @@ def define_hermetic_runtime_toolchain_impl(
                 "lib/python{major}.{minor}/**/test/**".format(**version_dict),
                 "lib/python{major}.{minor}/**/tests/**".format(**version_dict),
                 "**/__pycache__/*.pyc.*",  # During pyc creation, temp files named *.pyc.NNN are created
-            ] + extra_files_glob_exclude,
+            ] + glob_excludes.version_dependent_exclusions() + extra_files_glob_exclude,
         ),
     )
     cc_import(

python/private/pypi/deps.bzl

@@ -16,6 +16,7 @@
 
 load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 load("@bazel_tools//tools/build_defs/repo:utils.bzl", "maybe")
+load("//python/private:glob_excludes.bzl", "glob_excludes")
 
 _RULE_DEPS = [
     # START: maintained by 'bazel run //tools/private/update_deps:update_pip_deps'
@@ -97,6 +98,31 @@ _RULE_DEPS = [
     # END: maintained by 'bazel run //tools/private/update_deps:update_pip_deps'
 ]
 
+_EXCLUSIONS = [
+    ("**/*.py", None),
+    ("**/*.pyc", None),
+    ("**/*.pyc.*", "During pyc creation, temp files named *.pyc.NNN are created"),
+    ("**/*.dist-info/RECORD", None),
+    ("BUILD", None),
+    ("WORKSPACE", None),
+] + [(e, None) for e in glob_excludes.version_dependent_exclusions()]
+
+def _to_comment(comment):
+    if comment:
+        return "  #" + comment
+    return ""
+
+def _format_exclusions(exclusions, indent_depth):
+    indent = " " * indent_depth
+    return "\n".join([
+        "{indent}{excl},{comment}".format(
+            indent = indent,
+            excl = excl,
+            comment = _to_comment(comment),
+        )
+        for excl, comment in exclusions
+    ])
+
 _GENERIC_WHEEL = """\
 package(default_visibility = ["//visibility:public"])
 
@@ -105,22 +131,19 @@ load("@rules_python//python:defs.bzl", "py_library")
 py_library(
     name = "lib",
     srcs = glob(["**/*.py"]),
-    data = glob(["**/*"], exclude=[
+    data = glob(
+        ["**/*"], 
         # These entries include those put into user-installed dependencies by
         # data_exclude to avoid non-determinism.
-        "**/*.py",
-        "**/*.pyc",
-        "**/*.pyc.*",  # During pyc creation, temp files named *.pyc.NNN are created
-        "**/* *",
-        "**/*.dist-info/RECORD",
-        "BUILD",
-        "WORKSPACE",
-    ]),
+        exclude=[
+{exclusions}
+        ],
+    ),
     # This makes this directory a top-level in the python import
     # search path for anything that depends on this.
     imports = ["."],
 )
-"""
+""".format(exclusions = _format_exclusions(_EXCLUSIONS, 12))
 
 # Collate all the repository names so they can be easily consumed
 all_repo_names = [name for (name, _, _) in _RULE_DEPS]

python/private/pypi/generate_whl_library_build_bazel.bzl

@@ -14,6 +14,7 @@
 
 """Generate the BUILD.bazel contents for a repo defined by a whl_library."""
 
+load("//python/private:glob_excludes.bzl", "glob_excludes")
 load("//python/private:normalize_name.bzl", "normalize_name")
 load("//python/private:text_util.bzl", "render")
 load(
@@ -257,15 +258,14 @@ def generate_whl_library_build_bazel(
             additional_content.append(annotation.additive_build_content)
 
     _data_exclude = [
-        "**/* *",
         "**/*.py",
         "**/*.pyc",
         "**/*.pyc.*",  # During pyc creation, temp files named *.pyc.NNNN are created
         # RECORD is known to contain sha256 checksums of files which might include the checksums
         # of generated files produced when wheels are installed. The file is ignored to avoid
         # Bazel caching issues.
         "**/*.dist-info/RECORD",
-    ]
+    ] + glob_excludes.version_dependent_exclusions()
     for item in data_exclude:
         if item not in _data_exclude:
             _data_exclude.append(item)