Forward warnings from build-backend to build-frontend (#213)

This makes it possible for build-frontends to surface this information
to end users.

---------

Co-authored-by: Pradyun Gedam <[email protected]>
Co-authored-by: Pradyun Gedam <[email protected]>

Author: notatallshaw

src/pyproject_hooks/__init__.py

@@ -4,6 +4,7 @@
 from typing import TYPE_CHECKING
 
 from ._impl import (
+    BuildBackendWarning,
     BackendUnavailable,
     BuildBackendHookCaller,
     HookMissing,
@@ -14,6 +15,7 @@
 
 __version__ = "1.2.0"
 __all__ = [
+    "BuildBackendWarning",
     "BackendUnavailable",
     "BackendInvalid",
     "HookMissing",

src/pyproject_hooks/_impl.py

@@ -7,6 +7,7 @@
 from os.path import join as pjoin
 from subprocess import STDOUT, check_call, check_output
 from typing import TYPE_CHECKING, Any, Iterator, Mapping, Optional, Sequence
+import warnings
 
 from ._in_process import _in_proc_script_path
 
@@ -35,6 +36,10 @@ def read_json(path: str) -> Mapping[str, Any]:
         return json.load(f)
 
 
+class BuildBackendWarning(UserWarning):
+    """Will be emitted for every UserWarning emitted by the hook process."""
+
+
 class BackendUnavailable(Exception):
     """Will be raised if the backend cannot be imported in the hook process."""
 
@@ -407,4 +412,12 @@ def _call_hook(self, hook_name: str, kwargs: Mapping[str, Any]) -> Any:
                 )
             if data.get("hook_missing"):
                 raise HookMissing(data.get("missing_hook_name") or hook_name)
+
+            for w in data.get("warnings", []):
+                warnings.warn_explicit(
+                    message=w["message"],
+                    category=BuildBackendWarning,
+                    filename=w["filename"],
+                    lineno=w["lineno"],
+                )
             return data["return_val"]

src/pyproject_hooks/_in_process/_in_process.py

@@ -23,6 +23,7 @@
 from importlib import import_module
 from importlib.machinery import PathFinder
 from os.path import join as pjoin
+import warnings
 
 # This file is run as a script, and `import wrappers` is not zip-safe, so we
 # include write_json() and read_json() from wrappers.py.
@@ -368,20 +369,30 @@ def main():
 
     hook_input = read_json(pjoin(control_dir, "input.json"))
 
-    json_out = {"unsupported": False, "return_val": None}
-    try:
-        json_out["return_val"] = hook(**hook_input["kwargs"])
-    except BackendUnavailable as e:
-        json_out["no_backend"] = True
-        json_out["traceback"] = e.traceback
-        json_out["backend_error"] = e.message
-    except GotUnsupportedOperation as e:
-        json_out["unsupported"] = True
-        json_out["traceback"] = e.traceback
-    except HookMissing as e:
-        json_out["hook_missing"] = True
-        json_out["missing_hook_name"] = e.hook_name or hook_name
-
+    with warnings.catch_warnings(record=True) as captured_warnings:
+        json_out = {"unsupported": False, "return_val": None}
+        try:
+            json_out["return_val"] = hook(**hook_input["kwargs"])
+        except BackendUnavailable as e:
+            json_out["no_backend"] = True
+            json_out["traceback"] = e.traceback
+            json_out["backend_error"] = e.message
+        except GotUnsupportedOperation as e:
+            json_out["unsupported"] = True
+            json_out["traceback"] = e.traceback
+        except HookMissing as e:
+            json_out["hook_missing"] = True
+            json_out["missing_hook_name"] = e.hook_name or hook_name
+
+    json_out["warnings"] = [
+        {
+            "message": str(w.message),
+            "filename": w.filename,
+            "lineno": w.lineno,
+        }
+        for w in captured_warnings
+        if isinstance(w.category, type) and issubclass(w.category, UserWarning)
+    ]
     write_json(json_out, pjoin(control_dir, "output.json"), indent=2)
 
 

tests/samples/buildsys_pkgs/buildsys_warnings.py

@@ -0,0 +1,9 @@
+"""Test "backend" defining nothing other than a hook that logs a warning.
+"""
+
+import warnings
+
+
+def get_requires_for_build_wheel(config_settings):
+    warnings.warn("this is my example warning")
+    return []

tests/samples/pkg-with-warnings/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["eg_buildsys"]
+build-backend = "buildsys_warnings"

tests/test_call_hooks.py

@@ -12,6 +12,7 @@
 
 from pyproject_hooks import (
     BackendUnavailable,
+    BuildBackendWarning,
     BuildBackendHookCaller,
     UnsupportedOperation,
     default_subprocess_runner,
@@ -225,3 +226,10 @@ def test__supported_features(pkg, expected):
     with modified_env({"PYTHONPATH": BUILDSYS_PKGS}):
         res = hooks._supported_features()
     assert res == expected
+
+
+def test_warnings():
+    hooks = get_hooks("pkg-with-warnings")
+    with modified_env({"PYTHONPATH": BUILDSYS_PKGS}):
+        with pytest.warns(BuildBackendWarning, match="this is my example warning"):
+            hooks.get_requires_for_build_wheel({})