githubkit 0.16.1__tar.gz → 0.17.0__tar.gz

{githubkit-0.16.1 → githubkit-0.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: GitHubKit
-Version: 0.16.1
+Version: 0.17.0
 Summary: GitHub SDK for Python
 Keywords: github,octokit
 Author: yanyongyu
@@ -8,8 +8,8 @@ Author-email: yanyongyu <yyy@yyydl.top>
 License-Expression: MIT
 Requires-Dist: anyio>=3.6.1,<5.0.0
 Requires-Dist: httpx>=0.23.0,<1.0.0
-Requires-Dist: hishel[async,httpx]>=1.3.0,<=2.0.0
-Requires-Dist: typing-extensions>=4.11.0,<5.0.0
+Requires-Dist: hishel[async,httpx]>=1.4.0,<=2.0.0
+Requires-Dist: typing-extensions>=4.13.0,<5.0.0
 Requires-Dist: pydantic>=1.9.1,!=2.5.0,!=2.5.1,<3.0.0
 Requires-Dist: githubkit-schemas>=26.5.7
 Requires-Dist: pyjwt[crypto]>=2.4.0,<3.0.0 ; extra == 'all'

githubkit-0.17.0/githubkit/_httpx.py

@@ -0,0 +1,39 @@
+import os
+from typing import TYPE_CHECKING
+import warnings
+
+GITHUBKIT_HTTPX2_DISABLE_FLAG = "GITHUBKIT_HTTPX2_DISABLE_FLAG"
+
+if TYPE_CHECKING:
+    from hishel.httpx2 import AsyncCacheTransport as AsyncCacheTransport
+    from hishel.httpx2 import SyncCacheTransport as SyncCacheTransport
+    import httpx2 as httpx
+else:
+    httpx = None
+    if not os.getenv(GITHUBKIT_HTTPX2_DISABLE_FLAG):
+        try:
+            from hishel.httpx2 import AsyncCacheTransport, SyncCacheTransport
+            import httpx2 as httpx
+        except ImportError:
+            # Hishel wraps a missing HTTP client in ImportError.
+            pass
+
+    if httpx is None:
+        try:
+            from hishel.httpx import AsyncCacheTransport as AsyncCacheTransport
+            from hishel.httpx import SyncCacheTransport as SyncCacheTransport
+            import httpx as httpx
+        except ImportError:
+            raise RuntimeError(
+                "GitHubKit requires httpx2 and its Hishel integration "
+                "to be installed.\n"
+                "You can install them with:\n"
+                '    $ pip install httpx2 "hishel[async,httpx2]>=1.4.0"\n'
+            ) from None
+        else:
+            warnings.warn(
+                "Using `httpx` with GitHubKit is deprecated; install `httpx2` "
+                "and `hishel[async,httpx2]>=1.4.0` instead.",
+                DeprecationWarning,
+                stacklevel=2,
+            )

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/auth/_url.py

@@ -1,6 +1,6 @@
 import re
 
-import httpx
+from githubkit._httpx import httpx
 
 APP_ROUTES = {
     r"/app",

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/auth/action.py

@@ -2,8 +2,7 @@ from collections.abc import Generator
 import os
 from typing import TYPE_CHECKING
 
-import httpx
-
+from githubkit._httpx import httpx
 from githubkit.exception import AuthCredentialError
 
 from .base import BaseAuthStrategy

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/auth/app.py

@@ -4,14 +4,13 @@ from datetime import datetime, timedelta, timezone
 from typing import TYPE_CHECKING, ClassVar
 from typing_extensions import LiteralString
 
-import httpx
-
+from githubkit._httpx import httpx
 from githubkit.compat import model_dump, type_validate_python
 from githubkit.exception import AuthCredentialError
 from githubkit.utils import UNSET, Unset, exclude_unset
 
 from ._url import require_app_auth, require_basic_auth, require_bypass
-from .base import BaseAuthStrategy
+from .base import BaseAuthStrategy, build_request_with_options
 from .oauth import OAuthAppAuthStrategy
 
 try:
@@ -104,7 +103,7 @@ class AppAuth(httpx.Auth):
             await cache.aset(cache_key, token, timedelta(minutes=8))
         return token
 
-    def _build_installation_auth_request(self) -> httpx.Request:
+    def _build_installation_auth_request(self, request: httpx.Request) -> httpx.Request:
         from githubkit_schemas.latest.models import (
             AppInstallationsInstallationIdAccessTokensPostBody,
         )
@@ -130,9 +129,11 @@ class AppAuth(httpx.Auth):
                 },
             )
         )
-        return httpx.Request(
+        return build_request_with_options(
+            self.github,
             "POST",
             url,
+            request=request,
             json=exclude_unset(body),
             headers={
                 "User-Agent": self.github.config.user_agent,
@@ -207,7 +208,7 @@ class AppAuth(httpx.Auth):
         cache = self.github.config.cache_strategy.get_cache_storage()
         key = self._get_installation_cache_key()
         if not (token := cache.get(key)):
-            token_request = self._build_installation_auth_request()
+            token_request = self._build_installation_auth_request(request)
             token_request.headers["Authorization"] = f"Bearer {self.get_jwt()}"
             response = yield token_request
             response.read()
@@ -249,7 +250,7 @@ class AppAuth(httpx.Auth):
         cache = await self.github.config.cache_strategy.get_async_cache_storage()
         key = self._get_installation_cache_key()
         if not (token := await cache.aget(key)):
-            token_request = self._build_installation_auth_request()
+            token_request = self._build_installation_auth_request(request)
             token_request.headers["Authorization"] = f"Bearer {await self.aget_jwt()}"
             response = yield token_request
             await response.aread()

githubkit-0.17.0/githubkit/auth/base.py

@@ -0,0 +1,33 @@
+import abc
+from typing import TYPE_CHECKING, Any
+
+from githubkit._httpx import httpx
+
+if TYPE_CHECKING:
+    from githubkit import GitHubCore
+
+
+class BaseAuthStrategy(abc.ABC):
+    @abc.abstractmethod
+    def get_auth_flow(self, github: "GitHubCore") -> httpx.Auth:
+        raise NotImplementedError
+
+
+def build_request_with_options(
+    github: "GitHubCore",
+    method: str,
+    url: httpx.URL,
+    *,
+    request: httpx.Request | None = None,
+    **kwargs: Any,
+) -> httpx.Request:
+    """Build a request used inside auth flow, keeping the client timeout.
+
+    httpx only sets the timeout extension on the request passed to `send`,
+    not on requests yielded by an auth flow, so copy it from the original
+    request, or fall back to the client config.
+    """
+    timeout = (
+        request.extensions.get("timeout") if request is not None else None
+    ) or github.config.timeout.as_dict()
+    return httpx.Request(method, url, extensions={"timeout": timeout}, **kwargs)

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/auth/oauth.py

@@ -5,13 +5,12 @@ from time import sleep
 from typing import TYPE_CHECKING, Any, ClassVar, TypedDict, cast
 from typing_extensions import Self
 
-import httpx
-
+from githubkit._httpx import httpx
 from githubkit.exception import AuthCredentialError, AuthExpiredError
 from githubkit.utils import is_async
 
 from ._url import get_oauth_base_url, require_basic_auth, require_bypass
-from .base import BaseAuthStrategy
+from .base import BaseAuthStrategy, build_request_with_options
 
 try:
     import anyio
@@ -29,7 +28,10 @@ if TYPE_CHECKING:
 
 
 def create_device_code(
-    github: "GitHubCore", client_id: str, scopes: Sequence[str] | None = None
+    github: "GitHubCore",
+    client_id: str,
+    scopes: Sequence[str] | None = None,
+    request: httpx.Request | None = None,
 ) -> Generator[httpx.Request, httpx.Response, dict[str, Any]]:
     """Create a device code for OAuth."""
     base_url = get_oauth_base_url(github.config.base_url)
@@ -37,9 +39,11 @@ def create_device_code(
     body = {"client_id": client_id}
     if scopes:
         body["scope"] = " ".join(scopes)
-    response = yield httpx.Request(
+    response = yield build_request_with_options(
+        github,
         "POST",
         url,
+        request=request,
         json=body,
         headers={
             "User-Agent": github.config.user_agent,
@@ -56,6 +60,7 @@ def exchange_web_flow_code(
     client_secret: str,
     code: str,
     redirect_uri: str | None = None,
+    request: httpx.Request | None = None,
 ) -> Generator[httpx.Request, httpx.Response, dict[str, Any]]:
     """Exchange web flow code for token."""
     base_url = get_oauth_base_url(github.config.base_url)
@@ -67,9 +72,11 @@ def exchange_web_flow_code(
     }
     if redirect_uri:
         body["redirect_uri"] = redirect_uri
-    response = yield httpx.Request(
+    response = yield build_request_with_options(
+        github,
         "POST",
         url,
+        request=request,
         json=body,
         headers={
             "User-Agent": github.config.user_agent,
@@ -81,14 +88,19 @@ def exchange_web_flow_code(
 
 
 def exchange_device_code(
-    github: "GitHubCore", client_id: str, device_code: str
+    github: "GitHubCore",
+    client_id: str,
+    device_code: str,
+    request: httpx.Request | None = None,
 ) -> Generator[httpx.Request, httpx.Response, dict[str, Any]]:
     """Exchange device code for token."""
     base_url = get_oauth_base_url(github.config.base_url)
     url = base_url.copy_with(raw_path=base_url.raw_path + b"login/oauth/access_token")
-    response = yield httpx.Request(
+    response = yield build_request_with_options(
+        github,
         "POST",
         url,
+        request=request,
         json={
             "client_id": client_id,
             "grant_type": "urn:ietf:params:oauth:grant-type:device_code",
@@ -108,13 +120,16 @@ def refresh_token(
     client_id: str,
     client_secret: str | None,  # client secret is optional in device flow
     refresh_token: str,
+    request: httpx.Request | None = None,
 ) -> Generator[httpx.Request, httpx.Response, dict[str, Any]]:
     """Refresh token."""
     base_url = get_oauth_base_url(github.config.base_url)
     url = base_url.copy_with(raw_path=base_url.raw_path + b"login/oauth/access_token")
-    response = yield httpx.Request(
+    response = yield build_request_with_options(
+        github,
         "POST",
         url,
+        request=request,
         json={
             "client_id": client_id,
             "client_secret": client_secret,
@@ -287,6 +302,7 @@ class OAuthTokenAuth(httpx.Auth):
                 self.client_id,
                 self.client_secret,
                 cast(str, self.refresh_token),
+                request,
             )
             result = _parse_token_exchange_response(data)
             self.token = token = result["token"]
@@ -343,6 +359,7 @@ class OAuthWebAuth(httpx.Auth):
                 self.client_secret,
                 self.code,
                 self.redirect_uri,
+                request,
             )
             exchange_request = next(flow)
             while True:
@@ -374,6 +391,7 @@ class OAuthWebAuth(httpx.Auth):
                 self.client_secret,
                 self.code,
                 self.redirect_uri,
+                request,
             )
             exchange_request = next(flow)
             while True:
@@ -442,7 +460,7 @@ class OAuthDeviceAuth(httpx.Auth):
         # exchange token for the first time
         if (auth_strategy := self._token_auth_strategy) is None:
             # create device code
-            flow = create_device_code(self.github, self.client_id, self.scopes)
+            flow = create_device_code(self.github, self.client_id, self.scopes, request)
             create_request = next(flow)
             while True:
                 response = yield create_request
@@ -462,7 +480,7 @@ class OAuthDeviceAuth(httpx.Auth):
                 if datetime.now(timezone.utc) > result["expire_time"]:
                     raise AuthExpiredError("Device code expired.")
                 flow = exchange_device_code(
-                    self.github, self.client_id, result["device_code"]
+                    self.github, self.client_id, result["device_code"], request
                 )
                 auth_request = next(flow)
                 while True:
@@ -503,7 +521,7 @@ class OAuthDeviceAuth(httpx.Auth):
         # exchange token for the first time
         if (auth_strategy := self._token_auth_strategy) is None:
             # create device code
-            flow = create_device_code(self.github, self.client_id, self.scopes)
+            flow = create_device_code(self.github, self.client_id, self.scopes, request)
             create_request = next(flow)
             while True:
                 response = yield create_request
@@ -523,7 +541,7 @@ class OAuthDeviceAuth(httpx.Auth):
                 if datetime.now(timezone.utc) > result["expire_time"]:
                     raise AuthExpiredError("Device code expired.")
                 flow = exchange_device_code(
-                    self.github, self.client_id, result["device_code"]
+                    self.github, self.client_id, result["device_code"], request
                 )
                 auth_request = next(flow)
                 while True:

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/auth/token.py

@@ -2,7 +2,7 @@ from collections.abc import Generator
 from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
-import httpx
+from githubkit._httpx import httpx
 
 from .base import BaseAuthStrategy
 

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/auth/unauth.py

@@ -1,6 +1,6 @@
 from typing import TYPE_CHECKING
 
-import httpx
+from githubkit._httpx import httpx
 
 from .base import BaseAuthStrategy
 

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/compat.py

@@ -1,5 +1,6 @@
 from collections.abc import Callable, Generator
-from typing import TYPE_CHECKING, Any, Protocol, TypeVar, overload
+from typing import TYPE_CHECKING, Any, Protocol, TypeVar, cast
+from typing_extensions import TypeForm
 
 from pydantic import VERSION
 
@@ -36,24 +37,10 @@ if PYDANTIC_V2:  # pragma: pydantic-v2
     class ExtraGitHubModel(GitHubModel):
         model_config = ConfigDict(extra="allow")
 
-    # Remove the overload once [PEP747](https://peps.python.org/pep-0747/) is accepted
-    # We should use TypeForm here
-    @overload
-    def type_validate_python(type_: type[T], data: Any) -> T: ...
-
-    @overload
-    def type_validate_python(type_: Any, data: Any) -> Any: ...
-
-    def type_validate_python(type_: type[T], data: Any) -> T:
+    def type_validate_python(type_: TypeForm[T], data: Any) -> T:
         return TypeAdapter(type_).validate_python(data)
 
-    @overload
-    def type_validate_json(type_: type[T], data: Any) -> T: ...
-
-    @overload
-    def type_validate_json(type_: Any, data: Any) -> Any: ...
-
-    def type_validate_json(type_: type[T], data: Any) -> T:
+    def type_validate_json(type_: TypeForm[T], data: Any) -> T:
         return TypeAdapter(type_).validate_json(data)
 
     def model_dump(model: BaseModel, by_alias: bool = True) -> dict[str, Any]:
@@ -97,23 +84,11 @@ else:  # pragma: pydantic-v1
         class Config:
             extra = Extra.allow
 
-    @overload
-    def type_validate_python(type_: type[T], data: Any) -> T: ...
-
-    @overload
-    def type_validate_python(type_: Any, data: Any) -> Any: ...
-
-    def type_validate_python(type_: type[T], data: Any) -> T:
-        return parse_obj_as(type_, data)
-
-    @overload
-    def type_validate_json(type_: type[T], data: Any) -> T: ...
-
-    @overload
-    def type_validate_json(type_: Any, data: Any) -> Any: ...
+    def type_validate_python(type_: TypeForm[T], data: Any) -> T:
+        return parse_obj_as(cast(type[T], type_), data)
 
-    def type_validate_json(type_: type[T], data: Any) -> T:
-        return parse_raw_as(type_, data)
+    def type_validate_json(type_: TypeForm[T], data: Any) -> T:
+        return parse_raw_as(cast(type[T], type_), data)
 
     def to_jsonable_python(obj: Any) -> Any:
         if isinstance(obj, dict):

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/config.py

@@ -3,7 +3,7 @@ from dataclasses import dataclass, fields
 from typing import TYPE_CHECKING, Any
 from typing_extensions import Self
 
-import httpx
+from githubkit._httpx import httpx
 
 from .cache import DEFAULT_CACHE_STRATEGY, BaseCacheStrategy
 from .retry import RETRY_DEFAULT

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/core.py

@@ -5,9 +5,11 @@ from datetime import datetime, timedelta, timezone
 import time
 from types import TracebackType
 from typing import TYPE_CHECKING, Any, Generic, TypeVar, overload
+from typing_extensions import TypeForm
 
 import anyio
-import httpx
+
+from githubkit._httpx import httpx
 
 from .auth import BaseAuthStrategy, TokenAuthStrategy, UnauthAuthStrategy
 from .cache import BaseCacheStrategy
@@ -395,12 +397,16 @@ class GitHubCore(Generic[A]):
                     raise RequestError(e) from e
 
     # check and parse response
+    def _check_is_error(self, response: httpx.Response) -> bool:
+        """Check if the response is an error."""
+        return response.is_error
+
     @overload
     def _check(
         self,
         response: httpx.Response,
-        response_model: type[T],
-        error_models: Mapping[str, type] | None = None,
+        response_model: TypeForm[T],
+        error_models: Mapping[str, Any] | None = None,
     ) -> Response[T]: ...
 
     @overload
@@ -408,17 +414,13 @@ class GitHubCore(Generic[A]):
         self,
         response: httpx.Response,
         response_model: UnsetType = UNSET,
-        error_models: Mapping[str, type] | None = None,
+        error_models: Mapping[str, Any] | None = None,
     ) -> Response[Any]: ...
 
-    def _check_is_error(self, response: httpx.Response) -> bool:
-        """Check if the response is an error."""
-        return response.is_error
-
     def _check(
         self,
         response: httpx.Response,
-        response_model: type[T] | UnsetType = UNSET,
+        response_model: TypeForm[T] | UnsetType = UNSET,
         error_models: Mapping[str, Any] | None = None,
     ) -> Response[T] | Response[Any]:
         if self._check_is_error(response):
@@ -509,7 +511,7 @@ class GitHubCore(Generic[A]):
         headers: HeaderTypes | None = None,
         cookies: CookieTypes | None = None,
         stream: bool = False,
-        response_model: type[T],
+        response_model: TypeForm[T],
         error_models: Mapping[str, Any] | None = None,
     ) -> Response[T]: ...
 
@@ -544,7 +546,7 @@ class GitHubCore(Generic[A]):
         headers: HeaderTypes | None = None,
         cookies: CookieTypes | None = None,
         stream: bool = False,
-        response_model: type[T] | UnsetType = UNSET,
+        response_model: TypeForm[T] | UnsetType = UNSET,
         error_models: Mapping[str, Any] | None = None,
     ) -> Response[T] | Response[Any]:
         """Send a request.
@@ -599,7 +601,7 @@ class GitHubCore(Generic[A]):
         headers: HeaderTypes | None = None,
         cookies: CookieTypes | None = None,
         stream: bool = False,
-        response_model: type[T],
+        response_model: TypeForm[T],
         error_models: Mapping[str, Any] | None = None,
     ) -> Response[T]: ...
 
@@ -634,7 +636,7 @@ class GitHubCore(Generic[A]):
         headers: HeaderTypes | None = None,
         cookies: CookieTypes | None = None,
         stream: bool = False,
-        response_model: type[T] | UnsetType = UNSET,
+        response_model: TypeForm[T] | UnsetType = UNSET,
         error_models: Mapping[str, Any] | None = None,
     ) -> Response[T] | Response[Any]:
         """Asynchronously send a request.

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/exception.py

@@ -1,7 +1,7 @@
 from datetime import timedelta
 from typing import TYPE_CHECKING, Generic, TypeVar
 
-import httpx
+from ._httpx import httpx
 
 if TYPE_CHECKING:
     from .graphql import GraphQLResponse

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/github.py

@@ -14,8 +14,7 @@ from .versions import RestVersionSwitcher, WebhooksVersionSwitcher
 if TYPE_CHECKING:
     import ssl
 
-    import httpx
-
+    from ._httpx import httpx
     from .auth import TokenAuthStrategy, UnauthAuthStrategy
     from .cache import BaseCacheStrategy
     from .config import Config

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/hishel.py

@@ -10,8 +10,8 @@ from hishel import (
     SyncBaseStorage,
     SyncSqliteStorage,
 )
-from hishel.httpx import AsyncCacheTransport, SyncCacheTransport
-import httpx
+
+from ._httpx import AsyncCacheTransport, SyncCacheTransport, httpx
 
 
 class SyncCacheClient(httpx.Client):

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/response.py

@@ -1,9 +1,9 @@
 from collections.abc import AsyncIterator, Iterator
 from contextlib import asynccontextmanager, contextmanager
 from typing import Any, Generic
-from typing_extensions import TypeVar
+from typing_extensions import TypeForm, TypeVar
 
-import httpx
+from githubkit._httpx import httpx
 
 from .compat import type_validate_json
 from .exception import RequestError, RequestTimeout
@@ -15,7 +15,7 @@ JT = TypeVar("JT", default=Any)  # pyright: ignore[reportGeneralTypeIssues]
 class Response(Generic[MT, JT]):
     """A wrapper around httpx.Response that provides data model validation."""
 
-    def __init__(self, response: httpx.Response, data_model: type[MT]):
+    def __init__(self, response: httpx.Response, data_model: TypeForm[MT]):
         self._response = response
         self._data_model = data_model
         self._cached_parsed_data: MT | None = None

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/rest/paginator.py

@@ -11,8 +11,7 @@ from typing import (
 )
 from typing_extensions import ParamSpec, Self
 
-import httpx
-
+from githubkit._httpx import httpx
 from githubkit.response import Response
 from githubkit.typing import HeaderTypes
 from githubkit.utils import is_async

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/throttling.py

@@ -6,7 +6,8 @@ from typing import Any
 from typing_extensions import override
 
 import anyio
-import httpx
+
+from githubkit._httpx import httpx
 
 
 class BaseThrottler(abc.ABC):

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/typing.py

@@ -11,9 +11,10 @@ from typing import (
     TypeVar,
 )
 
-import httpx
 from pydantic import Field
 
+from githubkit._httpx import httpx
+
 from .compat import PYDANTIC_V2
 from .exception import GitHubException
 from .utils import Unset

{githubkit-0.16.1 → githubkit-0.17.0}/githubkit/utils.py

@@ -1,7 +1,8 @@
 from enum import Enum
 from functools import partial
 import inspect
-from typing import Any, Generic, Literal, TypeVar, final, overload
+from typing import Any, Generic, Literal, TypeVar, final
+from typing_extensions import TypeForm
 
 from pydantic import BaseModel
 
@@ -96,13 +97,7 @@ def parse_query_params(params: dict[str, Any]) -> dict[str, Any]:
 class TaggedUnion(Generic[T]):
     __slots__ = ("discriminator", "tag", "type_")
 
-    @overload
-    def __init__(self, type_: type[T], discriminator: str, tag: str) -> None: ...
-
-    @overload
-    def __init__(self, type_: Any, discriminator: str, tag: str) -> None: ...
-
-    def __init__(self, type_: type[T], discriminator: str, tag: str) -> None:
+    def __init__(self, type_: TypeForm[T], discriminator: str, tag: str) -> None:
         self.type_ = type_
         self.discriminator = discriminator
         self.tag = tag

{githubkit-0.16.1 → githubkit-0.17.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "GitHubKit"
-version = "0.16.1"
+version = "0.17.0"
 description = "GitHub SDK for Python"
 license = "MIT"
 readme = "README.md"
@@ -12,8 +12,8 @@ requires-python = ">=3.10, <4.0"
 dependencies = [
     "anyio >=3.6.1, <5.0.0",
     "httpx >=0.23.0, <1.0.0",
-    "hishel[async,httpx] >=1.3.0, <=2.0.0",
-    "typing-extensions >=4.11.0, <5.0.0",
+    "hishel[async,httpx] >=1.4.0, <=2.0.0",
+    "typing-extensions >=4.13.0, <5.0.0",
     "pydantic >=1.9.1, <3.0.0, !=2.5.0, !=2.5.1",
     "githubkit-schemas >=26.5.7",
 ]
@@ -46,7 +46,7 @@ dev = [
     { include-group = "codegen" },
     { include-group = "test" },
     { include-group = "docs" },
-    "ruff >=0.16.0, <0.17.0",
+    "ruff >=0.17.0, <0.18.0",
     "nonemoji >=0.1.2, <0.2.0",
     "pre-commit >=4.0.0, <5.0.0",
 ]
@@ -55,9 +55,11 @@ codegen = [
     "tomlkit >=0.13.3, <0.16.0",
     "jsonpointer >=3.0.0, <4.0.0",
     "openapi-pydantic >=0.5.0, <0.6.0",
+    "httpx2 >=2.13.1, <3.0.0",
 ]
 test = [
     { include-group = "thirdparty" },
+    "httpx2 >=2.13.1, <3.0.0",
     "pytest >=8.1.0, <10.0.0",
     "pytest-cov >=7.0.0, <8.0.0",
     "pytest-xdist >=3.5.0, <4.0.0",
@@ -177,9 +179,9 @@ keep-runtime-typing = true
 [tool.pyright]
 typeCheckingMode = "standard"
 reportPrivateImportUsage = false
-reportShadowedImports = false
 disableBytesTypePromotions = true
 pythonPlatform = "All"
+pythonVersion = "3.10"
 
 [tool.pyright.defineConstant]
 PYDANTIC_V2 = true
@@ -188,6 +190,7 @@ PYDANTIC_V2 = true
 root = "packages/**/githubkit_schemas/"
 pythonVersion = "3.10"
 reportOverlappingOverload = false
+reportIncompatibleMethodOverride = false
 
 [[tool.pyright.executionEnvironments]]
 root = "codegen"
@@ -401,6 +404,12 @@ type = [
     "null",
 ]
 
+[tool.codegen.overrides.schema_overrides."/components/schemas/pull-request-stack/properties/base/properties/sha"]
+type = [
+    "string",
+    "null",
+]
+
 [tool.codegen.overrides.schema_overrides."/components/schemas/repository/properties/temp_clone_token"]
 type = [
     "string",
@@ -560,23 +569,24 @@ type = [
 [tool.codegen.overrides.schema_overrides."/components/schemas/app-permissions/properties/organization_copilot_seat_management/enum"]
 "<add>" = ["read"]
 
-[tool.codegen.overrides.schema_overrides."/components/parameters/created/schema"]
-format = "<unset>"
+[[tool.codegen.overrides.schema_overrides."/components/schemas/budget/properties/budget_type/oneOf"."<add>"]]
+type = "string"
+enum = ["BundlePricing"]
 
-[tool.codegen.overrides.schema_overrides."/components/schemas/simple-classroom-assignment/properties/editor"]
-type = [
-    "string",
-    "null",
-]
+[[tool.codegen.overrides.schema_overrides."/components/schemas/create-budget/properties/budget/properties/budget_type/oneOf"."<add>"]]
+type = "string"
+enum = ["BundlePricing"]
 
-[tool.codegen.overrides.schema_overrides."/components/schemas/simple-classroom-assignment/properties/language"]
-type = [
-    "string",
-    "null",
-]
+[[tool.codegen.overrides.schema_overrides."/components/schemas/get-budget/properties/budget_type/oneOf"."<add>"]]
+type = "string"
+enum = ["BundlePricing"]
 
-[tool.codegen.overrides.schema_overrides."/components/schemas/simple-classroom-assignment/required"]
-"<remove>" = ["submitted"]
+[[tool.codegen.overrides.schema_overrides."/components/schemas/update-budget/properties/budget/properties/budget_type/oneOf"."<add>"]]
+type = "string"
+enum = ["BundlePricing"]
+
+[tool.codegen.overrides.schema_overrides."/components/parameters/created/schema"]
+format = "<unset>"
 
 [tool.codegen.overrides.schema_overrides."/paths/~1repos~1{owner}~1{repo}~1check-runs/post/requestBody/content/application~1json/schema"]
 discriminator = "<unset>"
@@ -603,6 +613,9 @@ discriminator = "<unset>"
 [tool.codegen.overrides.schema_overrides."/paths/~1users~1{username}/get/responses/200/content/application~1json/schema"]
 discriminator = "<unset>"
 
+[tool.codegen.overrides.schema_overrides."/components/schemas/rule-suite/properties/rule_evaluations/items/properties/metadata"]
+discriminator = "<unset>"
+
 [tool.codegen.overrides.schema_overrides."/components/schemas/webhook-check-run-completed/required"]
 "<add>" = ["action"]
 
@@ -698,6 +711,30 @@ type = "string"
 type = "object"
 additionalProperties = true
 
+[tool.codegen.overrides.schema_overrides."/components/schemas/webhooks_label/properties/archived_by"]
+type = [
+    "null",
+    "object",
+]
+
+[tool.codegen.overrides.schema_overrides."/components/schemas/webhooks_label_unarchived/allOf/1/properties/archived_by"]
+type = [
+    "null",
+    "object",
+]
+
+[tool.codegen.overrides.schema_overrides."/components/schemas/webhook-issues-labeled/properties/issue/properties/labels/items/properties/archived_by"]
+type = [
+    "null",
+    "object",
+]
+
+[tool.codegen.overrides.schema_overrides."/components/schemas/webhook-pull-request-labeled/properties/pull_request/properties/labels/items/properties/archived_by"]
+type = [
+    "null",
+    "object",
+]
+
 [tool.codegen.overrides.schema_overrides."/components/schemas/webhook-deployment-protection-rule-requested"]
 required = ["action"]
 

{githubkit-0.16.1 → githubkit-0.17.0}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "GitHubKit"
-version = "0.16.1"
+version = "0.17.0"
 description = "GitHub SDK for Python"
 authors = [{ name = "yanyongyu", email = "yyy@yyydl.top" }]
 license = "MIT"
@@ -10,8 +10,8 @@ requires-python = ">=3.10, <4.0"
 dependencies = [
   "anyio >=3.6.1, <5.0.0",
   "httpx >=0.23.0, <1.0.0",
-  "hishel[async,httpx] >=1.3.0, <=2.0.0",
-  "typing-extensions >=4.11.0, <5.0.0",
+  "hishel[async,httpx] >=1.4.0, <=2.0.0",
+  "typing-extensions >=4.13.0, <5.0.0",
   "pydantic >=1.9.1, <3.0.0, !=2.5.0, !=2.5.1",
   "githubkit-schemas >=26.5.7",
 ]
@@ -37,7 +37,7 @@ dev = [
   { include-group = "codegen" },
   { include-group = "test" },
   { include-group = "docs" },
-  "ruff >=0.16.0, <0.17.0",
+  "ruff >=0.17.0, <0.18.0",
   "nonemoji >=0.1.2, <0.2.0",
   "pre-commit >=4.0.0, <5.0.0",
 ]
@@ -46,9 +46,11 @@ codegen = [
   "tomlkit >=0.13.3, <0.16.0",
   "jsonpointer >=3.0.0, <4.0.0",
   "openapi-pydantic >=0.5.0, <0.6.0",
+  "httpx2 >=2.13.1, <3.0.0",
 ]
 test = [
   { include-group = "thirdparty" },
+  "httpx2 >=2.13.1, <3.0.0",                      # exercise the opt-in backend alongside httpx
   "pytest >=8.1.0, <10.0.0",
   "pytest-cov >=7.0.0, <8.0.0",
   "pytest-xdist >=3.5.0, <4.0.0",
@@ -161,15 +163,15 @@ keep-runtime-typing = true
 [tool.pyright]
 typeCheckingMode = "standard"
 reportPrivateImportUsage = false
-reportShadowedImports = false
 disableBytesTypePromotions = true
 
 pythonPlatform = "All"
+pythonVersion = "3.10"
 defineConstant = { PYDANTIC_V2 = true }
 
 executionEnvironments = [
-  # disable overload check for generated version codes
-  { root = "packages/**/githubkit_schemas/", pythonVersion = "3.10", reportOverlappingOverload = false },
+  # disable overload and override checks for generated version codes
+  { root = "packages/**/githubkit_schemas/", pythonVersion = "3.10", reportOverlappingOverload = false, reportIncompatibleMethodOverride = false },
   # codegen env config for dev
   { root = "codegen", pythonVersion = "3.10" },
   { root = ".", pythonVersion = "3.10" },
@@ -313,6 +315,12 @@ target_descriptions = ["ghec-2022-11-28", "ghec-2026-03-10"]
   "null",
 ] }
 
+# https://github.com/yanyongyu/githubkit/issues/326
+"/components/schemas/pull-request-stack/properties/base/properties/sha" = { type = [
+  "string",
+  "null",
+] }
+
 # https://github.com/github/rest-api-description/issues/621
 "/components/schemas/repository/properties/temp_clone_token" = { type = [
   "string",
@@ -465,22 +473,46 @@ target_descriptions = ["ghec-2022-11-28", "ghec-2026-03-10"]
   "read",
 ] }
 
+# https://github.com/yanyongyu/githubkit/issues/322
+# budget type can be "BundlePricing"
+"/components/schemas/budget/properties/budget_type/oneOf" = { "<add>" = [
+  { "type" = "string", "enum" = [
+    "BundlePricing",
+  ] },
+] }
+"/components/schemas/create-budget/properties/budget/properties/budget_type/oneOf" = { "<add>" = [
+  { "type" = "string", "enum" = [
+    "BundlePricing",
+  ] },
+] }
+"/components/schemas/get-budget/properties/budget_type/oneOf" = { "<add>" = [
+  { "type" = "string", "enum" = [
+    "BundlePricing",
+  ] },
+] }
+"/components/schemas/update-budget/properties/budget/properties/budget_type/oneOf" = { "<add>" = [
+  { "type" = "string", "enum" = [
+    "BundlePricing",
+  ] },
+] }
+
 # date-time search syntax should be string
 # https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates
 "/components/parameters/created/schema" = { format = "<unset>" }
 
 # https://github.com/yanyongyu/githubkit/issues/144
-"/components/schemas/simple-classroom-assignment/properties/editor" = { type = [
-  "string",
-  "null",
-] }
-"/components/schemas/simple-classroom-assignment/properties/language" = { type = [
-  "string",
-  "null",
-] }
-"/components/schemas/simple-classroom-assignment/required" = { "<remove>" = [
-  "submitted",
-] }
+# [REMOVED] github classroom closed
+# "/components/schemas/simple-classroom-assignment/properties/editor" = { type = [
+#   "string",
+#   "null",
+# ] }
+# "/components/schemas/simple-classroom-assignment/properties/language" = { type = [
+#   "string",
+#   "null",
+# ] }
+# "/components/schemas/simple-classroom-assignment/required" = { "<remove>" = [
+#   "submitted",
+# ] }
 
 # https://github.com/yanyongyu/githubkit/issues/148
 "/paths/~1repos~1{owner}~1{repo}~1check-runs/post/requestBody/content/application~1json/schema" = { discriminator = "<unset>" }
@@ -506,6 +538,9 @@ target_descriptions = ["ghec-2022-11-28", "ghec-2026-03-10"]
 # get user by username response discriminator not supported
 "/paths/~1users~1{username}/get/responses/200/content/application~1json/schema" = { discriminator = "<unset>" }
 
+# rule suite rule metadata type discriminator not supported
+"/components/schemas/rule-suite/properties/rule_evaluations/items/properties/metadata" = { discriminator = "<unset>" }
+
 # Webhook schema overrides
 # webhook check run action is required
 "/components/schemas/webhook-check-run-completed/required" = { "<add>" = [
@@ -555,6 +590,24 @@ target_descriptions = ["ghec-2022-11-28", "ghec-2026-03-10"]
   { type = "object", additionalProperties = true },
 ] }
 
+# webhook label archived_by user should be null or object
+"/components/schemas/webhooks_label/properties/archived_by" = { type = [
+  "null",
+  "object",
+] }
+"/components/schemas/webhooks_label_unarchived/allOf/1/properties/archived_by" = { type = [
+  "null",
+  "object",
+] }
+"/components/schemas/webhook-issues-labeled/properties/issue/properties/labels/items/properties/archived_by" = { type = [
+  "null",
+  "object",
+] }
+"/components/schemas/webhook-pull-request-labeled/properties/pull_request/properties/labels/items/properties/archived_by" = { type = [
+  "null",
+  "object",
+] }
+
 # webhook deployment protection rule action is required
 "/components/schemas/webhook-deployment-protection-rule-requested" = { required = [
   "action",

githubkit-0.16.1/githubkit/auth/base.py

@@ -1,13 +0,0 @@
-import abc
-from typing import TYPE_CHECKING
-
-import httpx
-
-if TYPE_CHECKING:
-    from githubkit import GitHubCore
-
-
-class BaseAuthStrategy(abc.ABC):
-    @abc.abstractmethod
-    def get_auth_flow(self, github: "GitHubCore") -> httpx.Auth:
-        raise NotImplementedError