Added setup_py_script macro to pip_parse and pip_install.

examples/pip_install/BUILD

@@ -6,6 +6,7 @@ load(
     "dist_info_requirement",
     "entry_point",
     "requirement",
+    "setup_py_script",
 )
 load("@rules_python//python:defs.bzl", "py_binary", "py_test")
 load("@rules_python//python:pip.bzl", "compile_pip_requirements")
@@ -58,6 +59,11 @@ alias(
     actual = entry_point("yamllint"),
 )
 
+alias(
+    name = "s3cmd",
+    actual = setup_py_script("s3cmd"),
+)
+
 # Check that our compiled requirements are up-to-date
 compile_pip_requirements(
     name = "requirements",
@@ -69,11 +75,13 @@ py_test(
     name = "pip_install_test",
     srcs = ["pip_install_test.py"],
     data = [
+        ":s3cmd",
         ":yamllint",
         data_requirement("s3cmd"),
         dist_info_requirement("boto3"),
     ],
     env = {
+        "S3CMD_SETUP_PY_SCRIPT": "$(rootpath :s3cmd)",
         "WHEEL_DATA_CONTENTS": "$(rootpaths {})".format(data_requirement("s3cmd")),
         "WHEEL_DIST_INFO_CONTENTS": "$(rootpaths {})".format(dist_info_requirement("boto3")),
         "YAMLLINT_ENTRY_POINT": "$(rootpath :yamllint)",

examples/pip_install/pip_install_test.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 
 import os
+import platform
 import subprocess
 import unittest
 from pathlib import Path
@@ -31,6 +32,28 @@ def test_entry_point(self):
         )
         self.assertEqual(proc.stdout.decode("utf-8").strip(), "yamllint 1.26.3")
 
+    @unittest.skipIf(
+        platform.system() == "Windows",
+        "The `setup_py_script` macro does not currently support windows",
+    )
+    def test_setup_py_script_s3cmd(self):
+        env = os.environ.get("S3CMD_SETUP_PY_SCRIPT")
+        self.assertIsNotNone(env)
+
+        r = runfiles.Create()
+
+        # To find an external target, this must use `{workspace_name}/$(rootpath @external_repo//:target)`
+        script = Path(r.Rlocation("rules_python_pip_install_example/{}".format(env)))
+        self.assertTrue(script.exists())
+
+        proc = subprocess.run(
+            [str(script), "--version"],
+            check=True,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+        )
+        self.assertEqual(proc.stdout.decode("utf-8").strip(), "s3cmd version 2.1.0")
+
     def test_data(self):
         env = os.environ.get("WHEEL_DATA_CONTENTS")
         self.assertIsNotNone(env)

examples/pip_parse/BUILD

@@ -3,6 +3,7 @@ load(
     "data_requirement",
     "dist_info_requirement",
     "entry_point",
+    "setup_py_script",
 )
 load("@rules_python//python:defs.bzl", "py_binary", "py_test")
 load("@rules_python//python:pip.bzl", "compile_pip_requirements")
@@ -55,6 +56,11 @@ alias(
     actual = entry_point("yamllint"),
 )
 
+alias(
+    name = "s3cmd",
+    actual = setup_py_script("s3cmd"),
+)
+
 # This rule adds a convenient way to update the requirements file.
 compile_pip_requirements(
     name = "requirements",
@@ -68,11 +74,13 @@ py_test(
     name = "pip_parse_test",
     srcs = ["pip_parse_test.py"],
     data = [
+        ":s3cmd",
         ":yamllint",
         data_requirement("s3cmd"),
         dist_info_requirement("requests"),
     ],
     env = {
+        "S3CMD_SETUP_PY_SCRIPT": "$(rootpath :s3cmd)",
         "WHEEL_DATA_CONTENTS": "$(rootpaths {})".format(data_requirement("s3cmd")),
         "WHEEL_DIST_INFO_CONTENTS": "$(rootpaths {})".format(dist_info_requirement("requests")),
         "YAMLLINT_ENTRY_POINT": "$(rootpath :yamllint)",

examples/pip_parse/pip_parse_test.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 
 import os
+import platform
 import subprocess
 import unittest
 from pathlib import Path
@@ -29,6 +30,28 @@ def test_entry_point(self):
         )
         self.assertEqual(proc.stdout.decode("utf-8").strip(), "yamllint 1.26.3")
 
+    @unittest.skipIf(
+        platform.system() == "Windows",
+        "The `setup_py_script` macro does not currently support windows",
+    )
+    def test_setup_py_script_s3cmd(self):
+        env = os.environ.get("S3CMD_SETUP_PY_SCRIPT")
+        self.assertIsNotNone(env)
+
+        r = runfiles.Create()
+
+        # To find an external target, this must use `{workspace_name}/$(rootpath @external_repo//:target)`
+        script = Path(r.Rlocation("rules_python_pip_parse_example/{}".format(env)))
+        self.assertTrue(script.exists())
+
+        proc = subprocess.run(
+            [str(script), "--version"],
+            check=True,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+        )
+        self.assertEqual(proc.stdout.decode("utf-8").strip(), "s3cmd version 2.1.0")
+
     def test_data(self):
         env = os.environ.get("WHEEL_DATA_CONTENTS")
         self.assertIsNotNone(env)

python/pip.bzl

@@ -86,6 +86,17 @@ def pip_install(requirements = None, name = "pip", **kwargs):
     )
     ```
 
+    Similar to the `entry_point` macro, `setup_py_script` allows accessing
+    [`setup.py` generated scripts][scripts]:
+    ```python
+    load("@pip_deps//:requirements.bzl", "setup_py_script")
+    alias(
+        name = "flake8",
+        actual = setup_py_script("flake8"),
+    )
+    ```
+    [scripts]: https://docs.python.org/3/distutils/setupscript.html#installing-scripts
+
     Args:
         requirements (Label): A 'requirements.txt' pip requirements file.
         name (str, optional): A unique name for the created external repository (default 'pip').
@@ -170,6 +181,17 @@ def pip_parse(requirements_lock, name = "pip_parsed_deps", **kwargs):
     )
     ```
 
+    Similar to the `entry_point` macro, `setup_py_script` allows accessing
+    [`setup.py` generated scripts][scripts]:
+    ```python
+    load("@pip_deps//:requirements.bzl", "setup_py_script")
+    alias(
+        name = "flake8",
+        actual = setup_py_script("flake8"),
+    )
+    ```
+    [scripts]: https://docs.python.org/3/distutils/setupscript.html#installing-scripts
+
     ## Vendoring the requirements.bzl file
 
     In some cases you may not want to generate the requirements.bzl file as a repository rule

python/pip_install/extract_wheels/__init__.py

@@ -117,6 +117,9 @@ def main() -> None:
                 enable_implicit_namespace_pkgs=args.enable_implicit_namespace_pkgs,
                 repo_prefix=args.repo_prefix,
                 annotation=annotations.get(name),
+                # Only `pip_install` uses this path so the `repo` arg
+                # is what's expected by this parameter.
+                pip_install_repo_name=args.repo,
             ),
         )
         for whl, name in reqs.items()