Merge branch 'main' into feat/entry-point-bzlmod-minimal

examples/build_file_generation/README.md

@@ -5,7 +5,9 @@ extension, so that targets like `py_library` and `py_binary` can be
 automatically created just by running
 
 ```sh
-$ bazel run //:gazelle
+bazel run //:requirements.update
+bazel run //:gazelle_python_manifest.update
+bazel run //:gazelle
 ```
 
 As a demo, try creating a `__main__.py` file in this directory, then

examples/bzlmod/BUILD.bazel

@@ -1,4 +1,5 @@
-load("@pip//:requirements.bzl", "requirement")
+load("@bazel_skylib//rules:build_test.bzl", "build_test")
+load("@pip//:requirements.bzl", "all_requirements", "all_whl_requirements", "requirement")
 load("@python3_9//:defs.bzl", py_test_with_transition = "py_test")
 load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
 load("@rules_python//python:pip.bzl", "compile_pip_requirements")
@@ -44,3 +45,13 @@ py_test_with_transition(
     main = "test.py",
     deps = [":lib"],
 )
+
+build_test(
+    name = "all_wheels",
+    targets = all_whl_requirements,
+)
+
+build_test(
+    name = "all_requirements",
+    targets = all_requirements,
+)

examples/bzlmod/MODULE.bazel

@@ -4,6 +4,7 @@ module(
     compatibility_level = 1,
 )
 
+bazel_dep(name = "bazel_skylib", version = "1.4.1")
 bazel_dep(name = "rules_python", version = "0.0.0")
 local_path_override(
     module_name = "rules_python",
@@ -34,6 +35,8 @@ pip = use_extension("@rules_python//python/extensions:pip.bzl", "pip")
 pip.parse(
     name = "pip",
     python_interpreter_target = "@interpreter_python3_9//:python",
+    # Intentionally set it false because the "true" case is already covered by examples/bzlmod_build_file_generation
+    incompatible_generate_aliases = False,
     requirements_lock = "//:requirements_lock.txt",
     requirements_windows = "//:requirements_windows.txt",
 )

examples/bzlmod/test.py

@@ -12,12 +12,57 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import os
+import pathlib
+import sys
 import unittest
 
 from lib import main
 
 
 class ExampleTest(unittest.TestCase):
+    def test_coverage_doesnt_shadow_stdlib(self):
+        # When we try to import the html module
+        import html as html_stdlib
+
+        try:
+            import coverage.html as html_coverage
+        except ImportError:
+            self.skipTest("not running under coverage, skipping")
+
+        self.assertNotEqual(
+            html_stdlib,
+            html_coverage,
+            "'html' import should not be shadowed by coverage",
+        )
+
+    def test_coverage_sys_path(self):
+        all_paths = ",\n    ".join(sys.path)
+
+        for i, path in enumerate(sys.path[1:-2]):
+            self.assertFalse(
+                "/coverage" in path,
+                f"Expected {i + 2}th '{path}' to not contain 'coverage.py' paths, "
+                f"sys.path has {len(sys.path)} items:\n    {all_paths}",
+            )
+
+        first_item, last_item = sys.path[0], sys.path[-1]
+        self.assertFalse(
+            first_item.endswith("coverage"),
+            f"Expected the first item in sys.path '{first_item}' to not be related to coverage",
+        )
+        if os.environ.get("COVERAGE_MANIFEST"):
+            # we are running under the 'bazel coverage :test'
+            self.assertTrue(
+                "pypi__coverage_cp" in last_item,
+                f"Expected {last_item} to be related to coverage",
+            )
+            self.assertEqual(pathlib.Path(last_item).name, "coverage")
+        else:
+            self.assertFalse(
+                "coverage" in last_item, f"Expected coverage tooling to not be present"
+            )
+
     def test_main(self):
         self.assertEquals(
             """\

python/extensions/pip.bzl

@@ -34,6 +34,7 @@ def _pip_impl(module_ctx):
             # this does not create the install_deps() macro.
             pip_repository_bzlmod(
                 name = attr.name,
+                repo_name = attr.name,
                 requirements_lock = attr.requirements_lock,
                 incompatible_generate_aliases = attr.incompatible_generate_aliases,
             )

python/pip_install/pip_repository.bzl

@@ -358,7 +358,7 @@ def _pip_repository_bzlmod_impl(rctx):
 
     bzl_packages = sorted([name for name, _ in packages])
 
-    repo_name = rctx.attr.name.split("~")[-1]
+    repo_name = rctx.attr.repo_name
 
     build_contents = _BUILD_FILE_CONTENTS
 
@@ -379,11 +379,11 @@ def _pip_repository_bzlmod_impl(rctx):
     rctx.file("BUILD.bazel", build_contents)
     rctx.template("requirements.bzl", rctx.attr._template, substitutions = {
         "%%ALL_REQUIREMENTS%%": _format_repr_list([
-            "@{}//{}".format(repo_name, p) if rctx.attr.incompatible_generate_aliases else "@{}_{}//:pkg".format(rctx.attr.name, p)
+            macro_tmpl.format(p, p) if rctx.attr.incompatible_generate_aliases else macro_tmpl.format(p, "pkg")
             for p in bzl_packages
         ]),
         "%%ALL_WHL_REQUIREMENTS%%": _format_repr_list([
-            "@{}//{}:whl".format(repo_name, p) if rctx.attr.incompatible_generate_aliases else "@{}_{}//:whl".format(rctx.attr.name, p)
+            macro_tmpl.format(p, "whl")
             for p in bzl_packages
         ]),
         "%%MACRO_TMPL%%": macro_tmpl,
@@ -396,6 +396,10 @@ pip_repository_bzlmod_attrs = {
         default = False,
         doc = "Allow generating aliases in '@pip//:<pkg>' -> '@pip_<pkg>//:pkg'. This replaces the aliases generated by the `bzlmod` tooling.",
     ),
+    "repo_name": attr.string(
+        mandatory = True,
+        doc = "The apparent name of the repo. This is needed because in bzlmod, the name attribute becomes the canonical name",
+    ),
     "requirements_darwin": attr.label(
         allow_single_file = True,
         doc = "Override the requirements_lock attribute when the host platform is Mac OS",

python/pip_install/private/test/requirements_parser_tests.bzl

@@ -62,6 +62,9 @@ SomeProject == 1.3 # This is a comment
 FooProject==1.0.0
 # Comment
 BarProject==2.0.0 #Comment
+""").requirements)
+    asserts.equals(env, [("requests", "requests @ https://github.com/psf/requests/releases/download/v2.29.0/requests-2.29.0.tar.gz#sha1=3897c249b51a1a405d615a8c9cb92e5fdbf0dd49")], parse("""\
+requests @ https://github.com/psf/requests/releases/download/v2.29.0/requests-2.29.0.tar.gz#sha1=3897c249b51a1a405d615a8c9cb92e5fdbf0dd49
 """).requirements)
 
     # Multiline
@@ -71,6 +74,11 @@ certifi==2021.10.8 \
     --hash=sha256:d62a0163eb4c2344ac042ab2bdf75399a71a2d8c7d47eac2e2ee91b9d6339569
     # via requests
 """).requirements)
+    asserts.equals(env, [("requests", "requests @ https://github.com/psf/requests/releases/download/v2.29.0/requests-2.29.0.tar.gz#sha1=3897c249b51a1a405d615a8c9cb92e5fdbf0dd49     --hash=sha256:eca58eb564b134e4ff521a02aa6f566c653835753e1fc8a50a20cb6bee4673cd")], parse("""\
+requests @ https://github.com/psf/requests/releases/download/v2.29.0/requests-2.29.0.tar.gz#sha1=3897c249b51a1a405d615a8c9cb92e5fdbf0dd49 \
+    --hash=sha256:eca58eb564b134e4ff521a02aa6f566c653835753e1fc8a50a20cb6bee4673cd
+    # via requirements.txt
+""").requirements)
 
     # Options
     asserts.equals(env, ["--pre"], parse("--pre\n").options)

python/pip_install/requirements_parser.bzl

@@ -116,7 +116,7 @@ def _handleParseOption(input, buffer, result):
     elif input == "\n" or input == EOF:
         result.options.append(buffer.rstrip("\n"))
         return (_STATE.ConsumeSpace, "")
-    elif input == "#":
+    elif input == "#" and (len(buffer) == 0 or buffer[-1].isspace()):
         return (_STATE.ConsumeComment, buffer)
 
     return (_STATE.ParseOption, buffer + input)
@@ -127,7 +127,7 @@ def _handleParseRequirement(input, buffer, result):
     elif input == "\n" or input == EOF:
         result.requirements[-1] = (result.requirements[-1][0], buffer.rstrip(" \n"))
         return (_STATE.ConsumeSpace, "")
-    elif input == "#":
+    elif input == "#" and (len(buffer) == 0 or buffer[-1].isspace()):
         return (_STATE.ConsumeComment, buffer)
 
     return (_STATE.ParseRequirement, buffer + input)

python/repositories.bzl

@@ -106,11 +106,11 @@ def _python_repository_impl(rctx):
     python_version = rctx.attr.python_version
     python_short_version = python_version.rpartition(".")[0]
     release_filename = rctx.attr.release_filename
-    url = rctx.attr.urls or [rctx.attr.url]
+    urls = rctx.attr.urls or [rctx.attr.url]
 
     if release_filename.endswith(".zst"):
         rctx.download(
-            url = url,
+            url = urls,
             sha256 = rctx.attr.sha256,
             output = release_filename,
         )
@@ -153,7 +153,7 @@ def _python_repository_impl(rctx):
             fail(fail_msg)
     else:
         rctx.download_and_extract(
-            url = url,
+            url = urls,
             sha256 = rctx.attr.sha256,
             stripPrefix = rctx.attr.strip_prefix,
         )
@@ -348,7 +348,7 @@ py_runtime_pair(
     rctx.file(STANDALONE_INTERPRETER_FILENAME, "# File intentionally left blank. Indicates that this is an interpreter repo created by rules_python.")
     rctx.file("BUILD.bazel", build_content)
 
-    return {
+    attrs = {
         "coverage_tool": rctx.attr.coverage_tool,
         "distutils": rctx.attr.distutils,
         "distutils_content": rctx.attr.distutils_content,
@@ -360,9 +360,15 @@ py_runtime_pair(
         "release_filename": release_filename,
         "sha256": rctx.attr.sha256,
         "strip_prefix": rctx.attr.strip_prefix,
-        "url": url,
     }
 
+    if rctx.attr.url:
+        attrs["url"] = rctx.attr.url
+    else:
+        attrs["urls"] = urls
+
+    return attrs
+
 python_repository = repository_rule(
     _python_repository_impl,
     doc = "Fetches the external tools needed for the Python toolchain.",