GitHubKit 0.12.11__tar.gz → 0.12.12__tar.gz

{githubkit-0.12.11 → githubkit-0.12.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: GitHubKit
-Version: 0.12.11
+Version: 0.12.12
 Summary: GitHub SDK for Python
 License: MIT
 Keywords: github,octokit

{githubkit-0.12.11 → githubkit-0.12.12}/githubkit/rest/paginator.py

@@ -6,6 +6,7 @@ from typing import (
     Callable,
     Generic,
     Optional,
+    TypedDict,
     TypeVar,
     Union,
     cast,
@@ -16,6 +17,7 @@ from typing_extensions import ParamSpec, Self
 import httpx
 
 from githubkit.response import Response
+from githubkit.typing import HeaderTypes
 from githubkit.utils import is_async
 
 if TYPE_CHECKING:
@@ -35,6 +37,12 @@ R = Union[
 NEXT_LINK_PATTERN = r'<([^<>]+)>;\s*rel="next"'
 
 
+class PaginatorState(TypedDict):
+    next_link: Optional[httpx.URL]
+    request_method: str
+    response_model: Any
+
+
 # https://docs.github.com/en/rest/using-the-rest-api/using-pagination-in-the-rest-api
 # https://github.com/octokit/plugin-paginate-rest.js/blob/1f44b5469b31ddec9621000e6e1aee63c71ea8bf/src/iterator.ts
 class Paginator(Generic[RT]):
@@ -76,10 +84,7 @@ class Paginator(Generic[RT]):
 
         self.map_func = map_func
 
-        self._initialized: bool = False
-        self._request_method: Optional[str] = None
-        self._response_model: Optional[Any] = None
-        self._next_link: Optional[httpx.URL] = None
+        self._state: Optional[PaginatorState] = None
 
         self._index: int = 0
         self._cached_data: list[RT] = []
@@ -87,22 +92,26 @@ class Paginator(Generic[RT]):
     @property
     def finalized(self) -> bool:
         """Whether the paginator is finalized or not."""
-        return self._initialized and self._next_link is None
+        return (self._state["next_link"] is None) if self._state is not None else False
+
+    @property
+    def _headers(self) -> Optional[HeaderTypes]:
+        return self.kwargs.get("headers")  # type: ignore
 
     def reset(self) -> None:
         """Reset the paginator to the initial state."""
 
-        self._initialized = False
-        self._next_link = None
+        self._state = None
         self._index = 0
         self._cached_data = []
 
     def __next__(self) -> RT:
         while self._index >= len(self._cached_data):
-            self._get_next_page()
             if self.finalized:
                 raise StopIteration
 
+            self._get_next_page()
+
         current = self._cached_data[self._index]
         self._index += 1
         return current
@@ -114,10 +123,11 @@ class Paginator(Generic[RT]):
 
     async def __anext__(self) -> RT:
         while self._index >= len(self._cached_data):
-            await self._aget_next_page()
             if self.finalized:
                 raise StopAsyncIteration
 
+            await self._aget_next_page()
+
         current = self._cached_data[self._index]
         self._index += 1
         return current
@@ -151,64 +161,56 @@ class Paginator(Generic[RT]):
         self._index = 0
 
     def _get_next_page(self) -> None:
-        if not self._initialized:
+        if self._state is None:
             # First request
-            response = cast(
-                Response[Any],
-                self.request(*self.args, **self.kwargs),
-            )
-            self._initialized = True
-            self._request_method = response.raw_request.method
+            response = cast(Response[Any], self.request(*self.args, **self.kwargs))
         else:
-            # Next request
-            if self._next_link is None:
-                raise RuntimeError("Paginator is finalized, no more pages to fetch.")
-            if self._request_method is None:
-                raise RuntimeError("Request method is not set, this should not happen.")
-            if self._response_model is None:
-                raise RuntimeError("Response model is not set, this should not happen.")
-
             # we request the next page with the same method and response model
+            if self._state["next_link"] is None:
+                raise RuntimeError("No next page to request")
+
             response = cast(
                 Response[Any],
                 self.rest._github.request(
-                    self._request_method,
-                    self._next_link,
-                    headers=self.kwargs.get("headers"),  # type: ignore
-                    response_model=self._response_model,  # type: ignore
+                    self._state["request_method"],
+                    self._state["next_link"],
+                    headers=self._headers,  # type: ignore
+                    response_model=self._state["response_model"],  # type: ignore
                 ),
             )
 
-        self._next_link = self._find_next_link(response)
+        self._state = PaginatorState(
+            next_link=self._find_next_link(response),
+            request_method=response.raw_request.method,
+            response_model=response._data_model,
+        )
         self._fill_cache_data(self._apply_map_func(response))
 
     async def _aget_next_page(self) -> None:
-        if not self._initialized:
+        if self._state is None:
             # First request
             response = cast(
                 Response[Any],
                 await self.request(*self.args, **self.kwargs),  # type: ignore
             )
-            self._initialized = True
-            self._request_method = response.raw_request.method
         else:
-            # Next request
-            if self._next_link is None:
-                raise RuntimeError("Paginator is finalized, no more pages to fetch.")
-            if self._request_method is None:
-                raise RuntimeError("Request method is not set, this should not happen.")
-            if self._response_model is None:
-                raise RuntimeError("Response model is not set, this should not happen.")
+            # we request the next page with the same method and response model
+            if self._state["next_link"] is None:
+                raise RuntimeError("No next page to request")
 
             response = cast(
                 Response[Any],
-                await self.rest._github.request(
-                    self._request_method,
-                    self._next_link,
-                    headers=self.kwargs.get("headers"),  # type: ignore
-                    response_model=self._response_model,  # type: ignore
+                await self.rest._github.arequest(
+                    self._state["request_method"],
+                    self._state["next_link"],
+                    headers=self._headers,  # type: ignore
+                    response_model=self._state["response_model"],  # type: ignore
                 ),
             )
 
-        self._next_link = self._find_next_link(response)
+        self._state = PaginatorState(
+            next_link=self._find_next_link(response),
+            request_method=response.raw_request.method,
+            response_model=response._data_model,
+        )
         self._fill_cache_data(self._apply_map_func(response))

{githubkit-0.12.11 → githubkit-0.12.12}/githubkit/versions/ghec_v2022_11_28/rest/checks.py

@@ -822,8 +822,6 @@ class ChecksClient:
 
         For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)".
 
-        OAuth apps and personal access tokens (classic) cannot use this endpoint.
-
         See also: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run
         """
 
@@ -861,8 +859,6 @@ class ChecksClient:
 
         For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)".
 
-        OAuth apps and personal access tokens (classic) cannot use this endpoint.
-
         See also: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run
         """
 
@@ -1354,8 +1350,6 @@ class ChecksClient:
 
         Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
 
-        OAuth apps and personal access tokens (classic) cannot use this endpoint.
-
         See also: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite
         """
 
@@ -1386,8 +1380,6 @@ class ChecksClient:
 
         Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
 
-        OAuth apps and personal access tokens (classic) cannot use this endpoint.
-
         See also: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite
         """
 

{githubkit-0.12.11 → githubkit-0.12.12}/githubkit/versions/ghec_v2022_11_28/rest/dependabot.py

@@ -20,7 +20,7 @@ from githubkit.typing import Missing, UnsetType
 from githubkit.utils import UNSET, exclude_unset
 
 if TYPE_CHECKING:
-    from typing import Literal
+    from typing import Literal, Union
 
     from githubkit import GitHubCore
     from githubkit.response import Response
@@ -79,6 +79,7 @@ class DependabotClient:
         ecosystem: Missing[str] = UNSET,
         package: Missing[str] = UNSET,
         epss_percentage: Missing[str] = UNSET,
+        has: Missing[Union[str, list[Literal["patch"]]]] = UNSET,
         scope: Missing[Literal["development", "runtime"]] = UNSET,
         sort: Missing[Literal["created", "updated", "epss_percentage"]] = UNSET,
         direction: Missing[Literal["asc", "desc"]] = UNSET,
@@ -120,6 +121,7 @@ class DependabotClient:
             "ecosystem": ecosystem,
             "package": package,
             "epss_percentage": epss_percentage,
+            "has": has,
             "scope": scope,
             "sort": sort,
             "direction": direction,
@@ -154,6 +156,7 @@ class DependabotClient:
         ecosystem: Missing[str] = UNSET,
         package: Missing[str] = UNSET,
         epss_percentage: Missing[str] = UNSET,
+        has: Missing[Union[str, list[Literal["patch"]]]] = UNSET,
         scope: Missing[Literal["development", "runtime"]] = UNSET,
         sort: Missing[Literal["created", "updated", "epss_percentage"]] = UNSET,
         direction: Missing[Literal["asc", "desc"]] = UNSET,
@@ -195,6 +198,7 @@ class DependabotClient:
             "ecosystem": ecosystem,
             "package": package,
             "epss_percentage": epss_percentage,
+            "has": has,
             "scope": scope,
             "sort": sort,
             "direction": direction,
@@ -229,6 +233,7 @@ class DependabotClient:
         ecosystem: Missing[str] = UNSET,
         package: Missing[str] = UNSET,
         epss_percentage: Missing[str] = UNSET,
+        has: Missing[Union[str, list[Literal["patch"]]]] = UNSET,
         scope: Missing[Literal["development", "runtime"]] = UNSET,
         sort: Missing[Literal["created", "updated", "epss_percentage"]] = UNSET,
         direction: Missing[Literal["asc", "desc"]] = UNSET,
@@ -268,6 +273,7 @@ class DependabotClient:
             "ecosystem": ecosystem,
             "package": package,
             "epss_percentage": epss_percentage,
+            "has": has,
             "scope": scope,
             "sort": sort,
             "direction": direction,
@@ -303,6 +309,7 @@ class DependabotClient:
         ecosystem: Missing[str] = UNSET,
         package: Missing[str] = UNSET,
         epss_percentage: Missing[str] = UNSET,
+        has: Missing[Union[str, list[Literal["patch"]]]] = UNSET,
         scope: Missing[Literal["development", "runtime"]] = UNSET,
         sort: Missing[Literal["created", "updated", "epss_percentage"]] = UNSET,
         direction: Missing[Literal["asc", "desc"]] = UNSET,
@@ -342,6 +349,7 @@ class DependabotClient:
             "ecosystem": ecosystem,
             "package": package,
             "epss_percentage": epss_percentage,
+            "has": has,
             "scope": scope,
             "sort": sort,
             "direction": direction,
@@ -1143,6 +1151,7 @@ class DependabotClient:
         package: Missing[str] = UNSET,
         manifest: Missing[str] = UNSET,
         epss_percentage: Missing[str] = UNSET,
+        has: Missing[Union[str, list[Literal["patch"]]]] = UNSET,
         scope: Missing[Literal["development", "runtime"]] = UNSET,
         sort: Missing[Literal["created", "updated", "epss_percentage"]] = UNSET,
         direction: Missing[Literal["asc", "desc"]] = UNSET,
@@ -1174,6 +1183,7 @@ class DependabotClient:
             "package": package,
             "manifest": manifest,
             "epss_percentage": epss_percentage,
+            "has": has,
             "scope": scope,
             "sort": sort,
             "direction": direction,
@@ -1212,6 +1222,7 @@ class DependabotClient:
         package: Missing[str] = UNSET,
         manifest: Missing[str] = UNSET,
         epss_percentage: Missing[str] = UNSET,
+        has: Missing[Union[str, list[Literal["patch"]]]] = UNSET,
         scope: Missing[Literal["development", "runtime"]] = UNSET,
         sort: Missing[Literal["created", "updated", "epss_percentage"]] = UNSET,
         direction: Missing[Literal["asc", "desc"]] = UNSET,
@@ -1243,6 +1254,7 @@ class DependabotClient:
             "package": package,
             "manifest": manifest,
             "epss_percentage": epss_percentage,
+            "has": has,
             "scope": scope,
             "sort": sort,
             "direction": direction,

{githubkit-0.12.11 → githubkit-0.12.12}/githubkit/versions/v2022_11_28/rest/checks.py

@@ -822,8 +822,6 @@ class ChecksClient:
 
         For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)".
 
-        OAuth apps and personal access tokens (classic) cannot use this endpoint.
-
         See also: https://docs.github.com/rest/checks/runs#rerequest-a-check-run
         """
 
@@ -861,8 +859,6 @@ class ChecksClient:
 
         For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)".
 
-        OAuth apps and personal access tokens (classic) cannot use this endpoint.
-
         See also: https://docs.github.com/rest/checks/runs#rerequest-a-check-run
         """
 
@@ -1354,8 +1350,6 @@ class ChecksClient:
 
         Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
 
-        OAuth apps and personal access tokens (classic) cannot use this endpoint.
-
         See also: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite
         """
 
@@ -1386,8 +1380,6 @@ class ChecksClient:
 
         Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
 
-        OAuth apps and personal access tokens (classic) cannot use this endpoint.
-
         See also: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite
         """
 

{githubkit-0.12.11 → githubkit-0.12.12}/githubkit/versions/v2022_11_28/rest/dependabot.py

@@ -20,7 +20,7 @@ from githubkit.typing import Missing, UnsetType
 from githubkit.utils import UNSET, exclude_unset
 
 if TYPE_CHECKING:
-    from typing import Literal
+    from typing import Literal, Union
 
     from githubkit import GitHubCore
     from githubkit.response import Response
@@ -79,6 +79,7 @@ class DependabotClient:
         ecosystem: Missing[str] = UNSET,
         package: Missing[str] = UNSET,
         epss_percentage: Missing[str] = UNSET,
+        has: Missing[Union[str, list[Literal["patch"]]]] = UNSET,
         scope: Missing[Literal["development", "runtime"]] = UNSET,
         sort: Missing[Literal["created", "updated", "epss_percentage"]] = UNSET,
         direction: Missing[Literal["asc", "desc"]] = UNSET,
@@ -120,6 +121,7 @@ class DependabotClient:
             "ecosystem": ecosystem,
             "package": package,
             "epss_percentage": epss_percentage,
+            "has": has,
             "scope": scope,
             "sort": sort,
             "direction": direction,
@@ -154,6 +156,7 @@ class DependabotClient:
         ecosystem: Missing[str] = UNSET,
         package: Missing[str] = UNSET,
         epss_percentage: Missing[str] = UNSET,
+        has: Missing[Union[str, list[Literal["patch"]]]] = UNSET,
         scope: Missing[Literal["development", "runtime"]] = UNSET,
         sort: Missing[Literal["created", "updated", "epss_percentage"]] = UNSET,
         direction: Missing[Literal["asc", "desc"]] = UNSET,
@@ -195,6 +198,7 @@ class DependabotClient:
             "ecosystem": ecosystem,
             "package": package,
             "epss_percentage": epss_percentage,
+            "has": has,
             "scope": scope,
             "sort": sort,
             "direction": direction,
@@ -229,6 +233,7 @@ class DependabotClient:
         ecosystem: Missing[str] = UNSET,
         package: Missing[str] = UNSET,
         epss_percentage: Missing[str] = UNSET,
+        has: Missing[Union[str, list[Literal["patch"]]]] = UNSET,
         scope: Missing[Literal["development", "runtime"]] = UNSET,
         sort: Missing[Literal["created", "updated", "epss_percentage"]] = UNSET,
         direction: Missing[Literal["asc", "desc"]] = UNSET,
@@ -268,6 +273,7 @@ class DependabotClient:
             "ecosystem": ecosystem,
             "package": package,
             "epss_percentage": epss_percentage,
+            "has": has,
             "scope": scope,
             "sort": sort,
             "direction": direction,
@@ -303,6 +309,7 @@ class DependabotClient:
         ecosystem: Missing[str] = UNSET,
         package: Missing[str] = UNSET,
         epss_percentage: Missing[str] = UNSET,
+        has: Missing[Union[str, list[Literal["patch"]]]] = UNSET,
         scope: Missing[Literal["development", "runtime"]] = UNSET,
         sort: Missing[Literal["created", "updated", "epss_percentage"]] = UNSET,
         direction: Missing[Literal["asc", "desc"]] = UNSET,
@@ -342,6 +349,7 @@ class DependabotClient:
             "ecosystem": ecosystem,
             "package": package,
             "epss_percentage": epss_percentage,
+            "has": has,
             "scope": scope,
             "sort": sort,
             "direction": direction,
@@ -1143,6 +1151,7 @@ class DependabotClient:
         package: Missing[str] = UNSET,
         manifest: Missing[str] = UNSET,
         epss_percentage: Missing[str] = UNSET,
+        has: Missing[Union[str, list[Literal["patch"]]]] = UNSET,
         scope: Missing[Literal["development", "runtime"]] = UNSET,
         sort: Missing[Literal["created", "updated", "epss_percentage"]] = UNSET,
         direction: Missing[Literal["asc", "desc"]] = UNSET,
@@ -1174,6 +1183,7 @@ class DependabotClient:
             "package": package,
             "manifest": manifest,
             "epss_percentage": epss_percentage,
+            "has": has,
             "scope": scope,
             "sort": sort,
             "direction": direction,
@@ -1212,6 +1222,7 @@ class DependabotClient:
         package: Missing[str] = UNSET,
         manifest: Missing[str] = UNSET,
         epss_percentage: Missing[str] = UNSET,
+        has: Missing[Union[str, list[Literal["patch"]]]] = UNSET,
         scope: Missing[Literal["development", "runtime"]] = UNSET,
         sort: Missing[Literal["created", "updated", "epss_percentage"]] = UNSET,
         direction: Missing[Literal["asc", "desc"]] = UNSET,
@@ -1243,6 +1254,7 @@ class DependabotClient:
             "package": package,
             "manifest": manifest,
             "epss_percentage": epss_percentage,
+            "has": has,
             "scope": scope,
             "sort": sort,
             "direction": direction,

{githubkit-0.12.11 → githubkit-0.12.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "GitHubKit"
-version = "0.12.11"
+version = "0.12.12"
 description = "GitHub SDK for Python"
 authors = ["yanyongyu <yyy@yyydl.top>"]
 license = "MIT"