asyncgh 0.3.2__tar.gz → 0.4.0__tar.gz

{asyncgh-0.3.2 → asyncgh-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: asyncgh
-Version: 0.3.2
+Version: 0.4.0
 Summary: Minimal async GitHub REST + GraphQL transport: auth, retry, pagination -- no generated models
 Project-URL: Homepage, https://github.com/hugoh/gh-workflows/tree/main/asyncgh
 Project-URL: Issues, https://github.com/hugoh/gh-workflows/issues

{asyncgh-0.3.2 → asyncgh-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "asyncgh"
-version = "0.3.2"
+version = "0.4.0"
 description = "Minimal async GitHub REST + GraphQL transport: auth, retry, pagination -- no generated models"
 readme = "README.md"
 requires-python = ">=3.11"

{asyncgh-0.3.2 → asyncgh-0.4.0}/src/asyncgh/client.py

@@ -106,6 +106,22 @@ def _should_retry_graphql(exc: Exception) -> bool | float:
     return _should_retry(exc)
 
 
+def _format_graphql_errors(errors: list[dict]) -> str:
+    """Joins GraphQL `errors[]` into one message, appending each error's
+    `path` (e.g. `r3.pullRequests.nodes.0.commits`) when present -- a
+    partial-permission failure names only "Resource not accessible by
+    personal access token" otherwise, with no hint which repo or field.
+    """
+    parts = []
+    for error in errors:
+        message = error.get("message", str(error))
+        path = error.get("path")
+        if path:
+            message = f"{message} (at {'.'.join(str(segment) for segment in path)})"
+        parts.append(message)
+    return "; ".join(parts)
+
+
 def error_message(response: httpx2.Response) -> str:
     """Extracts GitHub's own `message` field from an error response body,
     falling back to the raw response text if the body isn't JSON, or isn't
@@ -294,13 +310,9 @@ class GitHubClient:
                     if not errors:
                         return body["data"]
                     if any(error.get("type") == "RATE_LIMITED" for error in errors):
-                        raise _GraphQLRateLimited(
-                            "; ".join(
-                                error.get("message", str(error)) for error in errors
-                            )
-                        )
+                        raise _GraphQLRateLimited(_format_graphql_errors(errors))
                     raise GhError(
-                        "; ".join(error.get("message", str(error)) for error in errors),
+                        _format_graphql_errors(errors),
                         error_type=errors[0].get("type"),
                     )
         except _GraphQLRateLimited as exc:

{asyncgh-0.3.2 → asyncgh-0.4.0}/tests/test_client.py

@@ -244,6 +244,32 @@ async def test_graphql_raises_gh_error_when_errors_present_alongside_partial_dat
         await graphql("query { r0 r1 }")
 
 
+async def test_graphql_error_message_includes_the_error_path(
+    httpx2_mock: respx.Router,
+):
+    httpx2_mock.post(f"{API_BASE}/graphql").mock(
+        return_value=httpx.Response(
+            200,
+            json={
+                "data": {"r3": None},
+                "errors": [
+                    {
+                        "type": "FORBIDDEN",
+                        "message": "Resource not accessible by personal access token",
+                        "path": ["r3", "pullRequests", "nodes", 0, "commits"],
+                    }
+                ],
+            },
+        )
+    )
+    with pytest.raises(
+        GhError,
+        match=r"personal access token \(at r3\.pullRequests\.nodes\.0\.commits\)",
+    ) as exc_info:
+        await graphql("query { r3 { pullRequests { nodes { commits } } } }")
+    assert exc_info.value.error_type == "FORBIDDEN"
+
+
 async def test_graphql_retries_on_transport_error(httpx2_mock: respx.Router):
     route = httpx2_mock.post(f"{API_BASE}/graphql").mock(
         side_effect=[