feat: Show hint for --verbose on pip-compile error

Author: brandonchinn178

CHANGELOG.md

@@ -133,6 +133,7 @@ Unreleased changes template.
   configure them.
 * (toolchains) Expose `$(PYTHON2_ROOTPATH)` and `$(PYTHON3_ROOTPATH)` which are runfiles
   locations equivalents of `$(PYTHON2)` and `$(PYTHON3) respectively.
+* (pypi) A hint to run `//requirements.update` or `//requirements_test` with `--verbose` is now outputted if pip-compile throws an unexpected error
 
 
 {#v0-0-0-removed}

python/private/pypi/dependency_resolver/dependency_resolver.py

@@ -85,15 +85,15 @@ def _locate(bazel_runfiles, file):
 @click.command(context_settings={"ignore_unknown_options": True})
 @click.option("--src", "srcs", multiple=True, required=True)
 @click.argument("requirements_txt")
-@click.argument("update_target_label")
+@click.argument("target_label_prefix")
 @click.option("--requirements-linux")
 @click.option("--requirements-darwin")
 @click.option("--requirements-windows")
 @click.argument("extra_args", nargs=-1, type=click.UNPROCESSED)
 def main(
     srcs: Tuple[str, ...],
     requirements_txt: str,
-    update_target_label: str,
+    target_label_prefix: str,
     requirements_linux: Optional[str],
     requirements_darwin: Optional[str],
     requirements_windows: Optional[str],
@@ -155,9 +155,10 @@ def main(
         # or shutil.copyfile, as they will fail with OSError: [Errno 18] Invalid cross-device link.
         shutil.copy(resolved_requirements_file, requirements_out)
 
-    update_command = os.getenv("CUSTOM_COMPILE_COMMAND") or "bazel run %s" % (
-        update_target_label,
+    update_command = (
+        os.getenv("CUSTOM_COMPILE_COMMAND") or f"bazel run {target_label_prefix}.update"
     )
+    test_command = f"bazel test {target_label_prefix}_test"
 
     os.environ["CUSTOM_COMPILE_COMMAND"] = update_command
     os.environ["PIP_CONFIG_FILE"] = os.getenv("PIP_CONFIG_FILE") or os.devnull
@@ -196,15 +197,15 @@ def main(
                 atexit.register(
                     lambda: shutil.copy(absolute_output_file, requirements_file_tree)
                 )
-        _run_pip_compile()
+        _run_pip_compile(verbose_command=f"{update_command} -- --verbose")
         requirements_file_relative_path = Path(requirements_file_relative)
         content = requirements_file_relative_path.read_text()
         content = content.replace(absolute_path_prefix, "")
         requirements_file_relative_path.write_text(content)
     else:
         print("Checking " + requirements_file)
         sys.stdout.flush()
-        _run_pip_compile()
+        _run_pip_compile(verbose_command=f"{test_command} --test_arg=--verbose")
         golden = open(_locate(bazel_runfiles, requirements_file)).readlines()
         out = open(requirements_out).readlines()
         out = [line.replace(absolute_path_prefix, "") for line in out]
@@ -213,7 +214,7 @@ def main(
 
             print("".join(difflib.unified_diff(golden, out)), file=sys.stderr)
             print(
-                "Lock file out of date. Run '" + update_command + "' to update.",
+                f"Lock file out of date. Run '{update_command}' to update.",
                 file=sys.stderr,
             )
             sys.exit(1)
@@ -223,6 +224,7 @@ def run_pip_compile(
     args: List[str],
     *,
     srcs_relative: List[str],
+    verbose_command: str,
 ) -> None:
     try:
         cli(args, standalone_mode=False)
@@ -241,13 +243,17 @@ def run_pip_compile(
             print(
                 "pip-compile exited with code 2. This means that pip-compile found "
                 "incompatible requirements or could not find a version that matches "
-                f"the install requirement in one of {srcs_relative}.",
+                f"the install requirement in one of {srcs_relative}.\n"
+                "Try re-running with verbose:\n"
+                f"    {verbose_command}",
                 file=sys.stderr,
             )
             sys.exit(1)
         else:
             print(
-                f"pip-compile unexpectedly exited with code {e.code}.",
+                f"pip-compile unexpectedly exited with code {e.code}.\n"
+                "Try re-running with verbose:\n"
+                f"    {verbose_command}",
                 file=sys.stderr,
             )
             sys.exit(1)

python/private/pypi/pip_compile.bzl

@@ -110,7 +110,7 @@ def pip_compile(
 
     args = ["--src=%s" % loc.format(src) for src in srcs] + [
         loc.format(requirements_txt),
-        "//%s:%s.update" % (native.package_name(), name),
+        "//%s:%s" % (native.package_name(), name),
         "--resolver=backtracking",
         "--allow-unsafe",
     ]