githubkit 0.11.0__py3-none-any.whl → 0.11.0a1__py3-none-any.whl

githubkit/compat.py

@@ -29,9 +29,8 @@ if TYPE_CHECKING:
     CVC = TypeVar("CVC", bound=CustomValidationClass)
 
 
-if PYDANTIC_V2:  # pragma: pydantic-v2
+if PYDANTIC_V2:
     from pydantic_core import CoreSchema, core_schema
-    from pydantic_core import to_jsonable_python as to_jsonable_python
     from pydantic import (
         BaseModel,
         ConfigDict,
@@ -55,7 +54,7 @@ if PYDANTIC_V2:  # pragma: pydantic-v2
     def model_dump(model: BaseModel, by_alias: bool = True) -> Dict[str, Any]:
         return model.model_dump(by_alias=by_alias)
 
-    def model_rebuild(model: Type[BaseModel]):
+    def model_rebuild(model: BaseModel):
         model.model_rebuild()
 
     def model_before_validator(func: "ModelBeforeValidator"):
@@ -81,8 +80,7 @@ if PYDANTIC_V2:  # pragma: pydantic-v2
         )
         return class_
 
-else:  # pragma: pydantic-v1
-    from pydantic.json import pydantic_encoder
+else:
     from pydantic import Extra, BaseModel, parse_obj_as, parse_raw_as, root_validator
 
     class GitHubModel(BaseModel):
@@ -99,22 +97,10 @@ else:  # pragma: pydantic-v1
     def type_validate_json(type_: Type[T], data: Any) -> T:
         return parse_raw_as(type_, data)
 
-    def to_jsonable_python(obj: Any) -> Any:
-        if isinstance(obj, dict):
-            return {k: to_jsonable_python(v) for k, v in obj.items()}
-
-        if isinstance(obj, (list, tuple)):
-            return [to_jsonable_python(item) for item in obj]
-
-        if obj is None or isinstance(obj, (int, float, str, bool)):
-            return obj
-
-        return pydantic_encoder(obj)
-
     def model_dump(model: BaseModel, by_alias: bool = True) -> Dict[str, Any]:
         return model.dict(by_alias=by_alias)
 
-    def model_rebuild(model: Type[BaseModel]):
+    def model_rebuild(model: BaseModel):
         return model.update_forward_refs()
 
     def model_before_validator(func: "ModelBeforeValidator"):

githubkit/config.py

@@ -4,9 +4,6 @@ from typing import Any, Dict, List, Union, Optional
 
 import httpx
 
-from .retry import RETRY_DEFAULT
-from .typing import RetryDecisionFunc
-
 
 @dataclass(frozen=True)
 class Config:
@@ -16,7 +13,6 @@ class Config:
     follow_redirects: bool
     timeout: httpx.Timeout
     http_cache: bool
-    auto_retry: Optional[RetryDecisionFunc]
 
     def dict(self) -> Dict[str, Any]:
         return asdict(self)
@@ -63,17 +59,6 @@ def build_timeout(
     return timeout if isinstance(timeout, httpx.Timeout) else httpx.Timeout(timeout)
 
 
-def build_auto_retry(
-    auto_retry: Union[bool, RetryDecisionFunc] = True
-) -> Optional[RetryDecisionFunc]:
-    if auto_retry is True:
-        return RETRY_DEFAULT
-    elif auto_retry:
-        return auto_retry
-    else:
-        return None
-
-
 def get_config(
     base_url: Optional[Union[str, httpx.URL]] = None,
     accept_format: Optional[str] = None,
@@ -82,7 +67,6 @@ def get_config(
     follow_redirects: bool = True,
     timeout: Optional[Union[float, httpx.Timeout]] = None,
     http_cache: bool = True,
-    auto_retry: Union[bool, RetryDecisionFunc] = True,
 ) -> Config:
     return Config(
         build_base_url(base_url),
@@ -91,5 +75,4 @@ def get_config(
         follow_redirects,
         build_timeout(timeout),
         http_cache,
-        build_auto_retry(auto_retry),
     )

githubkit/core.py

@@ -1,7 +1,5 @@
-import time
 from types import TracebackType
 from contextvars import ContextVar
-from datetime import datetime, timezone, timedelta
 from contextlib import contextmanager, asynccontextmanager
 from typing import (
     Any,
@@ -18,13 +16,13 @@ from typing import (
     overload,
 )
 
-import anyio
 import httpx
 import hishel
 
 from .response import Response
-from .compat import to_jsonable_python
+from .utils import obj_to_jsonable
 from .config import Config, get_config
+from .exception import RequestError, RequestFailed, RequestTimeout
 from .auth import BaseAuthStrategy, TokenAuthStrategy, UnauthAuthStrategy
 from .typing import (
     URLTypes,
@@ -33,15 +31,6 @@ from .typing import (
     ContentTypes,
     RequestFiles,
     QueryParamTypes,
-    RetryDecisionFunc,
-)
-from .exception import (
-    RequestError,
-    RequestFailed,
-    RequestTimeout,
-    GitHubException,
-    PrimaryRateLimitExceeded,
-    SecondaryRateLimitExceeded,
 )
 
 T = TypeVar("T")
@@ -92,7 +81,6 @@ class GitHubCore(Generic[A]):
         follow_redirects: bool = True,
         timeout: Optional[Union[float, httpx.Timeout]] = None,
         http_cache: bool = True,
-        auto_retry: Union[bool, RetryDecisionFunc] = True,
     ):
         ...
 
@@ -109,7 +97,6 @@ class GitHubCore(Generic[A]):
         follow_redirects: bool = True,
         timeout: Optional[Union[float, httpx.Timeout]] = None,
         http_cache: bool = True,
-        auto_retry: Union[bool, RetryDecisionFunc] = True,
     ):
         ...
 
@@ -126,7 +113,6 @@ class GitHubCore(Generic[A]):
         follow_redirects: bool = True,
         timeout: Optional[Union[float, httpx.Timeout]] = None,
         http_cache: bool = True,
-        auto_retry: Union[bool, RetryDecisionFunc] = True,
     ):
         ...
 
@@ -142,7 +128,6 @@ class GitHubCore(Generic[A]):
         follow_redirects: bool = True,
         timeout: Optional[Union[float, httpx.Timeout]] = None,
         http_cache: bool = True,
-        auto_retry: Union[bool, RetryDecisionFunc] = True,
     ):
         auth = auth or UnauthAuthStrategy()  # type: ignore
         self.auth: A = (  # type: ignore
@@ -157,7 +142,6 @@ class GitHubCore(Generic[A]):
             follow_redirects,
             timeout,
             http_cache,
-            auto_retry,
         )
 
         self.__sync_client: ContextVar[Optional[httpx.Client]] = ContextVar(
@@ -281,7 +265,7 @@ class GitHubCore(Generic[A]):
                     content=content,
                     data=data,
                     files=files,
-                    json=to_jsonable_python(json),
+                    json=obj_to_jsonable(json),
                     headers=headers,
                     cookies=cookies,
                 )
@@ -313,7 +297,7 @@ class GitHubCore(Generic[A]):
                     content=content,
                     data=data,
                     files=files,
-                    json=to_jsonable_python(json),
+                    json=obj_to_jsonable(json),
                     headers=headers,
                     cookies=cookies,
                 )
@@ -332,73 +316,15 @@ class GitHubCore(Generic[A]):
         if response.is_error:
             error_models = error_models or {}
             status_code = str(response.status_code)
-
             error_model = error_models.get(
                 status_code,
                 error_models.get(
                     f"{status_code[:-2]}XX", error_models.get("default", Any)
                 ),
             )
-            resp = Response(response, error_model)
-        else:
-            resp = Response(response, response_model)
-
-        # only check rate limit when response is 403 or 429
-        if response.status_code in (403, 429):
-            self._check_rate_limit(resp)
-
-        if response.is_error:
-            raise RequestFailed(resp)
-        return resp
-
-    # check rate limit
-    def _check_rate_limit(self, response: Response) -> None:
-        # check rate limit exceeded
-        # https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api#exceeding-the-rate-limit
-        # https://docs.github.com/en/graphql/overview/rate-limits-and-node-limits-for-the-graphql-api#exceeding-the-rate-limit
-        # https://github.com/octokit/plugin-throttling.js/blob/135a0f556752a6c4c0ed3b2798bb58e228cd179a/src/index.ts#L134-L179
-
-        # Secondary rate limits
-        # the `retry-after` response header is present
-        if "retry-after" in response.headers:
-            raise SecondaryRateLimitExceeded(
-                response, self._extract_retry_after(response)
-            )
-
-        if (
-            "x-ratelimit-remaining" in response.headers
-            and response.headers["x-ratelimit-remaining"] == "0"
-        ):
-            retry_after = self._extract_retry_after(response)
-
-            try:
-                error = response.json()
-            except Exception:
-                error = None
-
-            # Secondary rate limits
-            # error message indicates that you exceeded a secondary rate limit
-            if (
-                isinstance(error, dict)
-                and "message" in error
-                and "secondary rate" in error["message"]
-            ):
-                raise SecondaryRateLimitExceeded(response, retry_after)
-
-            # Primary rate limits
-            raise PrimaryRateLimitExceeded(response, retry_after)
-
-    def _extract_retry_after(self, response: Response) -> timedelta:
-        if "retry-after" in response.headers:
-            return timedelta(seconds=int(response.headers["retry-after"]))
-        elif "x-ratelimit-reset" in response.headers:
-            retry_after = datetime.fromtimestamp(
-                int(response.headers["x-ratelimit-reset"]), tz=timezone.utc
-            ) - datetime.now(tz=timezone.utc)
-            return max(retry_after, timedelta())
-        else:
-            # wait for at least one minute before retrying
-            return timedelta(seconds=60)
+            rep = Response(response, error_model)
+            raise RequestFailed(rep)
+        return Response(response, response_model)
 
     # sync request and check
     def request(
@@ -416,32 +342,18 @@ class GitHubCore(Generic[A]):
         response_model: Type[T] = Any,
         error_models: Optional[Dict[str, type]] = None,
     ) -> Response[T]:
-        retry_count: int = 0
-        while True:
-            try:
-                raw_resp = self._request(
-                    method,
-                    url,
-                    params=params,
-                    content=content,
-                    data=data,
-                    files=files,
-                    json=json,
-                    headers=headers,
-                    cookies=cookies,
-                )
-                return self._check(raw_resp, response_model, error_models)
-            except GitHubException as e:
-                if self.config.auto_retry is None:
-                    raise
-                else:
-                    do_retry, retry_after = self.config.auto_retry(e, retry_count)
-
-                if not do_retry:
-                    raise
-
-                time.sleep(retry_after.total_seconds() if retry_after else 60)
-                retry_count += 1
+        raw_resp = self._request(
+            method,
+            url,
+            params=params,
+            content=content,
+            data=data,
+            files=files,
+            json=json,
+            headers=headers,
+            cookies=cookies,
+        )
+        return self._check(raw_resp, response_model, error_models)
 
     # async request and check
     async def arequest(
@@ -459,29 +371,15 @@ class GitHubCore(Generic[A]):
         response_model: Type[T] = Any,
         error_models: Optional[Dict[str, type]] = None,
     ) -> Response[T]:
-        retry_count: int = 0
-        while True:
-            try:
-                raw_resp = await self._arequest(
-                    method,
-                    url,
-                    params=params,
-                    content=content,
-                    data=data,
-                    files=files,
-                    json=json,
-                    headers=headers,
-                    cookies=cookies,
-                )
-                return self._check(raw_resp, response_model, error_models)
-            except GitHubException as e:
-                if self.config.auto_retry is None:
-                    raise
-                else:
-                    do_retry, retry_after = self.config.auto_retry(e, retry_count)
-
-                if not do_retry:
-                    raise
-
-                await anyio.sleep(retry_after.total_seconds() if retry_after else 60)
-                retry_count += 1
+        raw_resp = await self._arequest(
+            method,
+            url,
+            params=params,
+            content=content,
+            data=data,
+            files=files,
+            json=json,
+            headers=headers,
+            cookies=cookies,
+        )
+        return self._check(raw_resp, response_model, error_models)

githubkit/exception.py

@@ -1,4 +1,3 @@
-from datetime import timedelta
 from typing import TYPE_CHECKING
 
 import httpx
@@ -51,29 +50,6 @@ class RequestFailed(GitHubException):
         )
 
 
-class RateLimitExceeded(RequestFailed):
-    """API request failed with rate limit exceeded"""
-
-    def __init__(self, response: "Response", retry_after: timedelta):
-        super().__init__(response)
-        self.retry_after = retry_after
-
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}(method={self.request.method}, "
-            f"url={self.request.url}, status_code={self.response.status_code}, "
-            f"retry_after={self.retry_after})"
-        )
-
-
-class PrimaryRateLimitExceeded(RateLimitExceeded):
-    """API request failed with primary rate limit exceeded"""
-
-
-class SecondaryRateLimitExceeded(RateLimitExceeded):
-    """API request failed with secondary rate limit exceeded"""
-
-
 class GraphQLFailed(GitHubException):
     """GraphQL request with errors in response"""
 

githubkit/github.py

@@ -17,7 +17,6 @@ from .core import GitHubCore
 from .response import Response
 from .paginator import Paginator
 from .auth import BaseAuthStrategy
-from .typing import RetryDecisionFunc
 from .versions import RestVersionSwitcher, WebhooksVersionSwitcher
 from .graphql import GraphQLResponse, build_graphql_request, parse_graphql_response
 
@@ -86,7 +85,6 @@ class GitHub(GitHubCore[A]):
             follow_redirects: bool = True,
             timeout: Optional[Union[float, httpx.Timeout]] = None,
             http_cache: bool = True,
-            auto_retry: Union[bool, RetryDecisionFunc] = True,
         ):
             ...
 
@@ -103,7 +101,6 @@ class GitHub(GitHubCore[A]):
             follow_redirects: bool = True,
             timeout: Optional[Union[float, httpx.Timeout]] = None,
             http_cache: bool = True,
-            auto_retry: Union[bool, RetryDecisionFunc] = True,
         ):
             ...
 
@@ -120,7 +117,6 @@ class GitHub(GitHubCore[A]):
             follow_redirects: bool = True,
             timeout: Optional[Union[float, httpx.Timeout]] = None,
             http_cache: bool = True,
-            auto_retry: Union[bool, RetryDecisionFunc] = True,
         ):
             ...
 
@@ -146,8 +142,7 @@ class GitHub(GitHubCore[A]):
         json = build_graphql_request(query, variables)
 
         return parse_graphql_response(
-            self,
-            self.request("POST", "/graphql", json=json, response_model=GraphQLResponse),
+            self.request("POST", "/graphql", json=json, response_model=GraphQLResponse)
         )
 
     async def async_graphql(
@@ -156,10 +151,9 @@ class GitHub(GitHubCore[A]):
         json = build_graphql_request(query, variables)
 
         return parse_graphql_response(
-            self,
             await self.arequest(
                 "POST", "/graphql", json=json, response_model=GraphQLResponse
-            ),
+            )
         )
 
     # rest pagination

githubkit/graphql/__init__.py

@@ -1,13 +1,12 @@
 from typing import TYPE_CHECKING, Any, Dict, Optional, cast
 
-from githubkit.exception import GraphQLFailed, PrimaryRateLimitExceeded
+from githubkit.exception import GraphQLFailed
 
 from .models import GraphQLError as GraphQLError
 from .models import SourceLocation as SourceLocation
 from .models import GraphQLResponse as GraphQLResponse
 
 if TYPE_CHECKING:
-    from githubkit.core import GitHubCore
     from githubkit.response import Response
 
 
@@ -20,18 +19,8 @@ def build_graphql_request(
     return json
 
 
-def parse_graphql_response(
-    github: "GitHubCore", response: "Response[GraphQLResponse]"
-) -> Dict[str, Any]:
+def parse_graphql_response(response: "Response[GraphQLResponse]") -> Dict[str, Any]:
     response_data = response.parsed_data
     if response_data.errors:
-        # check rate limit exceeded
-        # https://docs.github.com/en/graphql/overview/rate-limits-and-node-limits-for-the-graphql-api#exceeding-the-rate-limit
-        # x-ratelimit-remaining may not be 0, ignore it
-        # https://github.com/octokit/plugin-throttling.js/pull/636
-        if any(error.type == "RATE_LIMITED" for error in response_data.errors):
-            raise PrimaryRateLimitExceeded(
-                response, github._extract_retry_after(response)
-            )
         raise GraphQLFailed(response_data)
     return cast(Dict[str, Any], response_data.data)

githubkit/graphql/models.py

@@ -9,7 +9,6 @@ class SourceLocation(GitHubModel):
 
 
 class GraphQLError(GitHubModel):
-    type: str  # https://github.com/octokit/graphql.js/pull/314
     message: str
     locations: Optional[List[SourceLocation]] = None
     path: Optional[List[Union[int, str]]] = None

githubkit/lazy_module.py

@@ -9,7 +9,6 @@ from importlib.machinery import ModuleSpec, PathFinder, SourceFileLoader
 
 LAZY_MODULES = (
     r"^githubkit\.rest$",
-    r"^githubkit\.versions\.v[^.]+\.models$",
     r"^githubkit\.versions\.v[^.]+\.webhooks$",
     r"^githubkit\.versions\.latest\.models$",
     r"^githubkit\.versions\.latest\.types$",