asyncgh 0.3.2__tar.gz → 0.5.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: asyncgh
-Version: 0.3.2
+Version: 0.5.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.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "asyncgh"
-version = "0.3.2"
+version = "0.5.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.5.0}/src/asyncgh/__init__.py

@@ -30,6 +30,7 @@ from .endpoints import (
     get_repo_public_key,
     public_repos,
     set_repo_secret,
+    set_repo_variable,
 )
 
 __all__ = [
@@ -48,4 +49,5 @@ __all__ = [
     "paginated",
     "public_repos",
     "set_repo_secret",
+    "set_repo_variable",
 ]

{asyncgh-0.3.2 → asyncgh-0.5.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.5.0}/src/asyncgh/endpoints.py

@@ -15,7 +15,7 @@ from typing import TypedDict, cast
 
 from nacl import encoding, public
 
-from .client import GitHubClient, _get_default_client
+from .client import GhError, GitHubClient, _get_default_client, error_message
 
 
 class RepoJSON(TypedDict, total=False):
@@ -122,3 +122,36 @@ async def set_repo_secret(
         f"/repos/{owner}/{repo_name}/actions/secrets/{secret_name}",
         json={"encrypted_value": encrypted_value, "key_id": key_data["key_id"]},
     )
+
+
+async def set_repo_variable(
+    owner: str,
+    repo_name: str,
+    name: str,
+    value: str,
+    *,
+    client: GitHubClient | None = None,
+) -> None:
+    """Creates or updates one repo's Actions variable via GitHub's REST API.
+
+    GitHub splits this across two endpoints -- POST .../actions/variables to
+    create, PATCH .../actions/variables/{name} to update -- so this PATCHes
+    first and falls back to POST on the 404 a not-yet-existing variable
+    returns. Unlike a secret, a variable's value is plaintext both in the
+    request and in GitHub's API responses.
+    """
+    client = client or _get_default_client()
+    response = await client.api_raw(
+        "PATCH",
+        f"/repos/{owner}/{repo_name}/actions/variables/{name}",
+        json={"name": name, "value": value},
+    )
+    if response.status_code == 404:
+        await client.api_json(
+            "POST",
+            f"/repos/{owner}/{repo_name}/actions/variables",
+            json={"name": name, "value": value},
+        )
+        return
+    if not response.is_success:
+        raise GhError(error_message(response), status_code=response.status_code)

{asyncgh-0.3.2 → asyncgh-0.5.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=[

{asyncgh-0.3.2 → asyncgh-0.5.0}/tests/test_endpoints.py

@@ -2,16 +2,19 @@ import base64
 import json
 
 import httpx
+import pytest
 import respx
 from nacl import encoding, public
 
 from asyncgh import (
     API_BASE,
+    GhError,
     encrypt_secret_value,
     fetch_repos,
     get_repo_public_key,
     public_repos,
     set_repo_secret,
+    set_repo_variable,
 )
 
 
@@ -173,3 +176,47 @@ async def test_set_repo_secret_reuses_a_passed_in_public_key(
     )
 
     _assert_put_body_encrypts(put_route, private_key, b"the-value")
+
+
+async def test_set_repo_variable_patches_an_existing_variable(
+    httpx2_mock: respx.Router,
+):
+    patch_route = httpx2_mock.patch(
+        f"{API_BASE}/repos/hugoh/repo/actions/variables/NAME"
+    ).mock(return_value=httpx.Response(204))
+
+    await set_repo_variable("hugoh", "repo", "NAME", "the-value")
+
+    assert patch_route.call_count == 1
+    assert json.loads(patch_route.calls[0].request.content) == {
+        "name": "NAME",
+        "value": "the-value",
+    }
+
+
+async def test_set_repo_variable_creates_when_patch_returns_404(
+    httpx2_mock: respx.Router,
+):
+    httpx2_mock.patch(f"{API_BASE}/repos/hugoh/repo/actions/variables/NAME").mock(
+        return_value=httpx.Response(404, json={"message": "Not Found"})
+    )
+    post_route = httpx2_mock.post(
+        f"{API_BASE}/repos/hugoh/repo/actions/variables"
+    ).mock(return_value=httpx.Response(201))
+
+    await set_repo_variable("hugoh", "repo", "NAME", "the-value")
+
+    assert post_route.call_count == 1
+    assert json.loads(post_route.calls[0].request.content) == {
+        "name": "NAME",
+        "value": "the-value",
+    }
+
+
+async def test_set_repo_variable_raises_on_a_non_404_error(httpx2_mock: respx.Router):
+    httpx2_mock.patch(f"{API_BASE}/repos/hugoh/repo/actions/variables/NAME").mock(
+        return_value=httpx.Response(422, json={"message": "Unprocessable"})
+    )
+
+    with pytest.raises(GhError):
+        await set_repo_variable("hugoh", "repo", "NAME", "the-value")