feat: uv lock rule instead of genrule

This change implements the uv pip compile as a rule.

In order to also make things easier to debug we provide
a runnable rule that has the same arguments and updates
the source tree output file automatically.

The main design is to have a regular lock rule and then
it returns a custom provider that has all of the recipe
ingredients to construct an executable rule. The execution
depends on having bash or powershell, however the
powershell script is not yet complete and requires some
help from the community.

Work towards bazel-contrib#1975.

Author: aignas

docs/BUILD.bazel

@@ -174,7 +174,11 @@ lock(
     name = "requirements",
     srcs = ["pyproject.toml"],
     out = "requirements.txt",
-    upgrade = True,
+    args = [
+        "--emit-index-url",
+        "--universal",
+        #"--upgrade",
+    ],
     visibility = ["//private:__pkg__"],
 )
 

examples/BUILD.bazel

@@ -21,5 +21,8 @@ lock(
     name = "bzlmod_requirements_3_9",
     srcs = ["bzlmod/requirements.in"],
     out = "bzlmod/requirements_lock_3_9.txt",
+    args = [
+        "--emit-index-url",
+    ],
     python_version = "3.9.19",
 )

examples/bzlmod/requirements_lock_3_9.txt

@@ -26,10 +26,7 @@ chardet==4.0.0 \
 colorama==0.4.6 \
     --hash=sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44 \
     --hash=sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6
-    # via
-    #   -r examples/bzlmod/requirements.in
-    #   pylint
-    #   sphinx
+    # via -r examples/bzlmod/requirements.in
 dill==0.3.6 \
     --hash=sha256:a07ffd2351b8c678dfc4a856a3005f8067aea51d6ba6c700796a4d9e280f39f0 \
     --hash=sha256:e5db55f3687856d8fbdab002ed78544e1c4559a130302693d839dfe8f93f2373
@@ -46,7 +43,7 @@ imagesize==1.4.1 \
     --hash=sha256:0d8d18d08f840c19d0ee7ca1fd82490fdc3729b7ac93f49870406ddde8ef8d8b \
     --hash=sha256:69150444affb9cb0d5cc5a92b3676f0b2fb7cd9ae39e947a5e11a36b4497cd4a
     # via sphinx
-importlib-metadata==8.4.0 ; python_version < '3.10' \
+importlib-metadata==8.4.0 \
     --hash=sha256:66f342cc6ac9818fc6ff340576acd24d65ba0b3efabb2b4ac08b598965a4a2f1 \
     --hash=sha256:9a547d3bc3608b025f93d403fdd1aae741c24fbb8314df4b155675742ce303c5
     # via sphinx
@@ -265,9 +262,7 @@ s3cmd==2.1.0 \
 setuptools==65.6.3 \
     --hash=sha256:57f6f22bde4e042978bcd50176fdb381d7c21a9efa4041202288d3737a0c6a54 \
     --hash=sha256:a7620757bf984b58deaf32fc8a4577a9bbc0850cf92c20e1ce41c38c19e5fb75
-    # via
-    #   babel
-    #   yamllint
+    # via yamllint
 six==1.16.0 \
     --hash=sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926 \
     --hash=sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254
@@ -316,15 +311,15 @@ tabulate==0.9.0 \
     --hash=sha256:0095b12bf5966de529c0feb1fa08671671b3368eec77d7ef7ab114be2c068b3c \
     --hash=sha256:024ca478df22e9340661486f85298cff5f6dcdba14f3813e8830015b9ed1948f
     # via -r examples/bzlmod/requirements.in
-tomli==2.0.1 ; python_version < '3.11' \
+tomli==2.0.1 \
     --hash=sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc \
     --hash=sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f
     # via pylint
 tomlkit==0.11.6 \
     --hash=sha256:07de26b0d8cfc18f871aec595fda24d95b08fef89d147caa861939f37230bf4b \
     --hash=sha256:71b952e5721688937fb02cf9d354dbcf0785066149d2855e44531ebdd2b65d73
     # via pylint
-typing-extensions==4.12.2 ; python_version < '3.10' \
+typing-extensions==4.12.2 \
     --hash=sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d \
     --hash=sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8
     # via
@@ -480,7 +475,7 @@ yamllint==1.28.0 \
     --hash=sha256:89bb5b5ac33b1ade059743cf227de73daa34d5e5a474b06a5e17fc16583b0cf2 \
     --hash=sha256:9e3d8ddd16d0583214c5fdffe806c9344086721f107435f68bad990e5a88826b
     # via -r examples/bzlmod/requirements.in
-zipp==3.20.0 ; python_version < '3.10' \
+zipp==3.20.0 \
     --hash=sha256:0145e43d89664cfe1a2e533adc75adafed82fe2da404b4bbb6b026c0157bdb31 \
     --hash=sha256:58da6168be89f0be59beb194da1250516fdaa062ccebd30127ac65d30045e10d
     # via importlib-metadata

private/BUILD.bazel

@@ -4,6 +4,7 @@ load("@rules_multirun//:defs.bzl", "multirun")
 
 multirun(
     name = "requirements.update",
+    testonly = True,
     commands = [
         "//tools/publish:{}.update".format(r)
         for r in [

python/uv/private/BUILD.bazel

@@ -13,6 +13,16 @@
 # limitations under the License.
 
 load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
+load("//python/private:bzlmod_enabled.bzl", "BZLMOD_ENABLED")  # buildifier: disable=bzl-visibility
+
+exports_files(
+    srcs = [
+        "copy.py",
+        "pip_compile.py",
+    ],
+    # only because this is used from a macro to template
+    visibility = ["//visibility:public"],
+)
 
 filegroup(
     name = "distribution",
@@ -31,9 +41,9 @@ bzl_library(
     srcs = ["lock.bzl"],
     visibility = ["//python/uv:__subpackages__"],
     deps = [
-        "//python:py_binary_bzl",
+        "//python:py_test_bzl",
         "//python/private:bzlmod_enabled_bzl",
-        "@bazel_skylib//rules:write_file",
+        "@bazel_skylib//rules:expand_template",
     ],
 )
 
@@ -81,3 +91,13 @@ bzl_library(
         "//python/private:text_util_bzl",
     ],
 )
+
+filegroup(
+    name = "pip_compile_template",
+    srcs = select({
+        "@platforms//os:windows": ["pip_compile.ps1"],
+        "//conditions:default": ["pip_compile.sh"],
+    }),
+    target_compatible_with = [] if BZLMOD_ENABLED else ["@platforms//:incompatible"],
+    visibility = ["//visibility:public"],
+)

python/uv/private/copy.py

@@ -0,0 +1,50 @@
+import sys
+from difflib import unified_diff
+from os import environ
+from pathlib import Path
+
+
+def main():
+    src = ""
+    dst = ""
+
+    src = Path(src)
+    assert src.exists(), f"the {src} file does not exist"
+
+    if "BUILD_WORKSPACE_DIRECTORY" not in environ:
+        dst = Path(dst)
+        a = dst.read_text() if dst.exists() else "\n"
+        b = src.read_text()
+
+        diff = unified_diff(
+            a.splitlines(),
+            b.splitlines(),
+            str(dst),
+            str(src),
+            lineterm="",
+        )
+        diff = "\n".join(list(diff))
+        print(diff)
+        print(
+            """\
+
+===============================================================================
+The in source file copy is out of date, please run the failed test target with
+'bazel run' to fix the error message update the source file copy.
+===============================================================================
+"""
+        )
+        return 1 if diff else 0
+
+    print(f"cp <bazel-sandbox>/{src}", file=sys.stderr)
+    print(f"    -> <workspace>/{dst}", file=sys.stderr)
+    build_workspace = Path(environ["BUILD_WORKSPACE_DIRECTORY"])
+
+    dst = build_workspace / dst
+    dst.write_text(src.read_text())
+    print("Success!", file=sys.stderr)
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())