GitHubKit 0.12.14__py3-none-any.whl → 0.12.15__py3-none-any.whl

githubkit/cache/base.py

@@ -4,6 +4,8 @@ from typing import Optional
 
 from hishel import AsyncBaseStorage, BaseStorage, Controller
 
+from githubkit.typing import HishelControllerOptions
+
 
 class BaseCache(abc.ABC):
     @abc.abstractmethod
@@ -42,12 +44,18 @@ class BaseCacheStrategy(abc.ABC):
         """
         raise NotImplementedError
 
-    def get_hishel_controller(self) -> Optional[Controller]:
+    def get_hishel_controller_options(self) -> HishelControllerOptions:
+        """Get the hishel controller options"""
+        # set always revalidate by default
+        # See: https://hishel.com/examples/github/
+        return HishelControllerOptions(always_revalidate=True)
+
+    def get_hishel_controller(self) -> Controller:
         """Get the hishel controller instance
 
-        Return `None` to use the default controller
+        Get the controller options from `get_hishel_controller_options` method
         """
-        return None
+        return Controller(**self.get_hishel_controller_options())
 
     @abc.abstractmethod
     def get_hishel_storage(self) -> BaseStorage:

githubkit/cache/redis.py

@@ -3,9 +3,10 @@ from functools import partial
 from typing import TYPE_CHECKING, Any, NoReturn, Optional
 from typing_extensions import override
 
-from hishel import AsyncBaseStorage, AsyncRedisStorage, Controller, RedisStorage
+from hishel import AsyncBaseStorage, AsyncRedisStorage, RedisStorage
 
 from githubkit.exception import CacheUnsupportedError
+from githubkit.typing import HishelControllerOptions
 from githubkit.utils import hishel_key_generator_with_prefix
 
 from .base import AsyncBaseCache, BaseCache, BaseCacheStrategy
@@ -82,14 +83,16 @@ class RedisCacheStrategy(BaseCacheStrategy):
         )
 
     @override
-    def get_hishel_controller(self) -> Optional[Controller]:
+    def get_hishel_controller_options(self) -> HishelControllerOptions:
+        options = super().get_hishel_controller_options()
+
         if self.prefix is not None:
-            return Controller(
-                key_generator=partial(
-                    hishel_key_generator_with_prefix, prefix=self.prefix
-                )
+            options["key_generator"] = partial(
+                hishel_key_generator_with_prefix, prefix=self.prefix
             )
 
+        return options
+
     @override
     def get_hishel_storage(self) -> RedisStorage:
         return RedisStorage(client=self.client)

githubkit/config.py

@@ -8,7 +8,7 @@ import httpx
 from .cache import DEFAULT_CACHE_STRATEGY, BaseCacheStrategy
 from .retry import RETRY_DEFAULT
 from .throttling import BaseThrottler, LocalThrottler
-from .typing import RetryDecisionFunc
+from .typing import ProxyTypes, RetryDecisionFunc
 
 if TYPE_CHECKING:
     import ssl
@@ -22,6 +22,8 @@ class Config:
     follow_redirects: bool
     timeout: httpx.Timeout
     ssl_verify: Union[bool, "ssl.SSLContext"]
+    trust_env: bool  # effects the `httpx` proxy and ssl cert
+    proxy: Optional[ProxyTypes]
     cache_strategy: BaseCacheStrategy
     http_cache: bool
     throttler: BaseThrottler
@@ -109,6 +111,8 @@ def get_config(
     follow_redirects: bool = True,
     timeout: Optional[Union[float, httpx.Timeout]] = None,
     ssl_verify: Union[bool, "ssl.SSLContext"] = True,
+    trust_env: bool = True,
+    proxy: Optional[ProxyTypes] = None,
     cache_strategy: Optional[BaseCacheStrategy] = None,
     http_cache: bool = True,
     throttler: Optional[BaseThrottler] = None,
@@ -123,6 +127,8 @@ def get_config(
         follow_redirects,
         build_timeout(timeout),
         ssl_verify,
+        trust_env,
+        proxy,
         build_cache_strategy(cache_strategy),
         http_cache,
         build_throttler(throttler),

githubkit/core.py

@@ -28,6 +28,7 @@ from .typing import (
     ContentTypes,
     CookieTypes,
     HeaderTypes,
+    ProxyTypes,
     QueryParamTypes,
     RequestFiles,
     RetryDecisionFunc,
@@ -85,6 +86,8 @@ class GitHubCore(Generic[A]):
         follow_redirects: bool = True,
         timeout: Optional[Union[float, httpx.Timeout]] = None,
         ssl_verify: Union[bool, "ssl.SSLContext"] = ...,
+        trust_env: bool = True,
+        proxy: Optional[ProxyTypes] = None,
         cache_strategy: Optional[BaseCacheStrategy] = None,
         http_cache: bool = True,
         throttler: Optional[BaseThrottler] = None,
@@ -105,6 +108,8 @@ class GitHubCore(Generic[A]):
         follow_redirects: bool = True,
         timeout: Optional[Union[float, httpx.Timeout]] = None,
         ssl_verify: Union[bool, "ssl.SSLContext"] = ...,
+        trust_env: bool = True,
+        proxy: Optional[ProxyTypes] = None,
         cache_strategy: Optional[BaseCacheStrategy] = None,
         http_cache: bool = True,
         throttler: Optional[BaseThrottler] = None,
@@ -125,6 +130,8 @@ class GitHubCore(Generic[A]):
         follow_redirects: bool = True,
         timeout: Optional[Union[float, httpx.Timeout]] = None,
         ssl_verify: Union[bool, "ssl.SSLContext"] = ...,
+        trust_env: bool = True,
+        proxy: Optional[ProxyTypes] = None,
         cache_strategy: Optional[BaseCacheStrategy] = None,
         http_cache: bool = True,
         throttler: Optional[BaseThrottler] = None,
@@ -144,6 +151,8 @@ class GitHubCore(Generic[A]):
         follow_redirects: bool = True,
         timeout: Optional[Union[float, httpx.Timeout]] = None,
         ssl_verify: Union[bool, "ssl.SSLContext"] = True,
+        trust_env: bool = True,
+        proxy: Optional[ProxyTypes] = None,
         cache_strategy: Optional[BaseCacheStrategy] = None,
         http_cache: bool = True,
         throttler: Optional[BaseThrottler] = None,
@@ -163,6 +172,8 @@ class GitHubCore(Generic[A]):
             follow_redirects=follow_redirects,
             timeout=timeout,
             ssl_verify=ssl_verify,
+            trust_env=trust_env,
+            proxy=proxy,
             cache_strategy=cache_strategy,
             http_cache=http_cache,
             throttler=throttler,
@@ -209,8 +220,9 @@ class GitHubCore(Generic[A]):
         await cast(httpx.AsyncClient, self.__async_client.get()).aclose()
         self.__async_client.set(None)
 
-    # default args for creating client
-    def _get_client_defaults(self):
+    def _get_client_defaults(self) -> dict[str, Any]:
+        """Get default arguments for creating a httpx client."""
+
         return {
             "auth": self.auth.get_auth_flow(self),
             "base_url": self.config.base_url,
@@ -221,20 +233,19 @@ class GitHubCore(Generic[A]):
             "timeout": self.config.timeout,
             "follow_redirects": self.config.follow_redirects,
             "verify": self.config.ssl_verify,
+            "trust_env": self.config.trust_env,
+            "proxy": self.config.proxy,
         }
 
-    # create sync client
     def _create_sync_client(self) -> httpx.Client:
         if self.config.http_cache:
-            transport = hishel.CacheTransport(
-                httpx.HTTPTransport(),
+            return hishel.CacheClient(
+                **self._get_client_defaults(),
                 storage=self.config.cache_strategy.get_hishel_storage(),
                 controller=self.config.cache_strategy.get_hishel_controller(),
             )
-        else:
-            transport = httpx.HTTPTransport()
 
-        return httpx.Client(**self._get_client_defaults(), transport=transport)
+        return httpx.Client(**self._get_client_defaults())
 
     # get or create sync client
     @contextmanager
@@ -248,18 +259,15 @@ class GitHubCore(Generic[A]):
             finally:
                 client.close()
 
-    # create async client
     def _create_async_client(self) -> httpx.AsyncClient:
         if self.config.http_cache:
-            transport = hishel.AsyncCacheTransport(
-                httpx.AsyncHTTPTransport(),
+            return hishel.AsyncCacheClient(
+                **self._get_client_defaults(),
                 storage=self.config.cache_strategy.get_async_hishel_storage(),
                 controller=self.config.cache_strategy.get_hishel_controller(),
             )
-        else:
-            transport = httpx.AsyncHTTPTransport()
 
-        return httpx.AsyncClient(**self._get_client_defaults(), transport=transport)
+        return httpx.AsyncClient(**self._get_client_defaults())
 
     # get or create async client
     @asynccontextmanager
@@ -286,6 +294,7 @@ class GitHubCore(Generic[A]):
         json: Optional[Any] = None,
         headers: Optional[HeaderTypes] = None,
         cookies: Optional[CookieTypes] = None,
+        stream: bool = False,
     ) -> httpx.Response:
         with self.get_sync_client() as client:
             request = client.build_request(
@@ -301,7 +310,7 @@ class GitHubCore(Generic[A]):
             )
             with self.config.throttler.acquire(request):
                 try:
-                    return client.send(request)
+                    return client.send(request, stream=stream)
                 except httpx.TimeoutException as e:
                     raise RequestTimeout(e) from e
                 except Exception as e:
@@ -320,6 +329,7 @@ class GitHubCore(Generic[A]):
         json: Optional[Any] = None,
         headers: Optional[HeaderTypes] = None,
         cookies: Optional[CookieTypes] = None,
+        stream: bool = False,
     ) -> httpx.Response:
         async with (
             self.get_async_client() as client,
@@ -337,7 +347,7 @@ class GitHubCore(Generic[A]):
             )
             async with self.config.throttler.async_acquire(request):
                 try:
-                    return await client.send(request)
+                    return await client.send(request, stream=stream)
                 except httpx.TimeoutException as e:
                     raise RequestTimeout(e) from e
                 except Exception as e:
@@ -360,13 +370,17 @@ class GitHubCore(Generic[A]):
         error_models: Optional[Mapping[str, type]] = 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: Union[type[T], UnsetType] = UNSET,
         error_models: Optional[Mapping[str, type]] = None,
     ) -> Union[Response[T], Response[Any]]:
-        if response.is_error:
+        if self._check_is_error(response):
             error_models = error_models or {}
             status_code = str(response.status_code)
 
@@ -386,7 +400,7 @@ class GitHubCore(Generic[A]):
         if response.status_code in (403, 429):
             self._check_rate_limit(resp)
 
-        if response.is_error:
+        if self._check_is_error(response):
             raise RequestFailed(resp)
         return resp
 
@@ -453,6 +467,7 @@ class GitHubCore(Generic[A]):
         json: Optional[Any] = None,
         headers: Optional[HeaderTypes] = None,
         cookies: Optional[CookieTypes] = None,
+        stream: bool = False,
         response_model: type[T],
         error_models: Optional[Mapping[str, type]] = None,
     ) -> Response[T]: ...
@@ -470,6 +485,7 @@ class GitHubCore(Generic[A]):
         json: Optional[Any] = None,
         headers: Optional[HeaderTypes] = None,
         cookies: Optional[CookieTypes] = None,
+        stream: bool = False,
         response_model: UnsetType = UNSET,
         error_models: Optional[Mapping[str, type]] = None,
     ) -> Response[Any]: ...
@@ -486,6 +502,7 @@ class GitHubCore(Generic[A]):
         json: Optional[Any] = None,
         headers: Optional[HeaderTypes] = None,
         cookies: Optional[CookieTypes] = None,
+        stream: bool = False,
         response_model: Union[type[T], UnsetType] = UNSET,
         error_models: Optional[Mapping[str, type]] = None,
     ) -> Union[Response[T], Response[Any]]:
@@ -507,7 +524,12 @@ class GitHubCore(Generic[A]):
                     json=json,
                     headers=headers,
                     cookies=cookies,
+                    stream=stream,
                 )
+                if self._check_is_error(raw_resp) and stream:
+                    # if the response is an error and stream is True,
+                    # we need to read the response first
+                    raw_resp.read()
                 return self._check(raw_resp, response_model, error_models)
             except GitHubException as e:
                 if self.config.auto_retry is None:
@@ -535,6 +557,7 @@ class GitHubCore(Generic[A]):
         json: Optional[Any] = None,
         headers: Optional[HeaderTypes] = None,
         cookies: Optional[CookieTypes] = None,
+        stream: bool = False,
         response_model: type[T],
         error_models: Optional[Mapping[str, type]] = None,
     ) -> Response[T]: ...
@@ -552,6 +575,7 @@ class GitHubCore(Generic[A]):
         json: Optional[Any] = None,
         headers: Optional[HeaderTypes] = None,
         cookies: Optional[CookieTypes] = None,
+        stream: bool = False,
         response_model: UnsetType = UNSET,
         error_models: Optional[Mapping[str, type]] = None,
     ) -> Response[Any]: ...
@@ -568,6 +592,7 @@ class GitHubCore(Generic[A]):
         json: Optional[Any] = None,
         headers: Optional[HeaderTypes] = None,
         cookies: Optional[CookieTypes] = None,
+        stream: bool = False,
         response_model: Union[type[T], UnsetType] = UNSET,
         error_models: Optional[Mapping[str, type]] = None,
     ) -> Union[Response[T], Response[Any]]:
@@ -589,7 +614,12 @@ class GitHubCore(Generic[A]):
                     json=json,
                     headers=headers,
                     cookies=cookies,
+                    stream=stream,
                 )
+                if self._check_is_error(raw_resp) and stream:
+                    # if the response is an error and stream is True,
+                    # we need to read the response first
+                    await raw_resp.aread()
                 return self._check(raw_resp, response_model, error_models)
             except GitHubException as e:
                 if self.config.auto_retry is None:

githubkit/github.py

@@ -8,7 +8,7 @@ from .core import GitHubCore
 from .graphql import GraphQLNamespace
 from .paginator import Paginator
 from .response import Response
-from .typing import RetryDecisionFunc
+from .typing import ProxyTypes, RetryDecisionFunc
 from .versions import RestVersionSwitcher, WebhooksVersionSwitcher
 
 if TYPE_CHECKING:
@@ -77,6 +77,8 @@ class GitHub(GitHubCore[A]):
             follow_redirects: bool = True,
             timeout: Optional[Union[float, httpx.Timeout]] = None,
             ssl_verify: Union[bool, "ssl.SSLContext"] = ...,
+            trust_env: bool = True,
+            proxy: Optional[ProxyTypes] = None,
             cache_strategy: Optional["BaseCacheStrategy"] = None,
             http_cache: bool = True,
             throttler: Optional["BaseThrottler"] = None,
@@ -97,6 +99,8 @@ class GitHub(GitHubCore[A]):
             follow_redirects: bool = True,
             timeout: Optional[Union[float, httpx.Timeout]] = None,
             ssl_verify: Union[bool, "ssl.SSLContext"] = ...,
+            trust_env: bool = True,
+            proxy: Optional[ProxyTypes] = None,
             cache_strategy: Optional["BaseCacheStrategy"] = None,
             http_cache: bool = True,
             throttler: Optional["BaseThrottler"] = None,
@@ -117,6 +121,8 @@ class GitHub(GitHubCore[A]):
             follow_redirects: bool = True,
             timeout: Optional[Union[float, httpx.Timeout]] = None,
             ssl_verify: Union[bool, "ssl.SSLContext"] = ...,
+            trust_env: bool = True,
+            proxy: Optional[ProxyTypes] = None,
             cache_strategy: Optional["BaseCacheStrategy"] = None,
             http_cache: bool = True,
             throttler: Optional["BaseThrottler"] = None,

githubkit/response.py

@@ -1,9 +1,12 @@
-from typing import Any, Generic
+from collections.abc import AsyncIterator, Iterator
+from contextlib import asynccontextmanager, contextmanager
+from typing import Any, Generic, Optional
 from typing_extensions import TypeVar
 
 import httpx
 
 from .compat import type_validate_json
+from .exception import RequestError, RequestTimeout
 
 MT = TypeVar("MT", default=Any)
 JT = TypeVar("JT", default=Any)
@@ -92,3 +95,63 @@ class Response(Generic[MT, JT]):
     @property
     def parsed_data(self) -> MT:
         return type_validate_json(self._data_model, self.content)
+
+    @contextmanager
+    def _catch_and_close(self):
+        try:
+            yield
+        except httpx.TimeoutException as e:
+            raise RequestTimeout(e) from e
+        except Exception as e:
+            raise RequestError(e) from e
+        finally:
+            self._response.close()
+
+    @asynccontextmanager
+    async def _acatch_and_close(self):
+        try:
+            yield
+        except httpx.TimeoutException as e:
+            raise RequestTimeout(e) from e
+        except Exception as e:
+            raise RequestError(e) from e
+        finally:
+            await self._response.aclose()
+
+    def iter_bytes(self, chunk_size: Optional[int] = None) -> Iterator[bytes]:
+        with self._catch_and_close():
+            yield from self._response.iter_bytes(chunk_size=chunk_size)
+
+    def iter_text(self, chunk_size: Optional[int] = None) -> Iterator[str]:
+        with self._catch_and_close():
+            yield from self._response.iter_text(chunk_size=chunk_size)
+
+    def iter_lines(self) -> Iterator[str]:
+        with self._catch_and_close():
+            yield from self._response.iter_lines()
+
+    def iter_raw(self, chunk_size: Optional[int] = None) -> Iterator[bytes]:
+        with self._catch_and_close():
+            yield from self._response.iter_raw(chunk_size=chunk_size)
+
+    async def aiter_bytes(
+        self, chunk_size: Optional[int] = None
+    ) -> AsyncIterator[bytes]:
+        async with self._acatch_and_close():
+            async for chunk in self._response.aiter_bytes(chunk_size=chunk_size):
+                yield chunk
+
+    async def aiter_text(self, chunk_size: Optional[int] = None) -> AsyncIterator[str]:
+        async with self._acatch_and_close():
+            async for chunk in self._response.aiter_text(chunk_size=chunk_size):
+                yield chunk
+
+    async def aiter_lines(self) -> AsyncIterator[str]:
+        async with self._acatch_and_close():
+            async for line in self._response.aiter_lines():
+                yield line
+
+    async def aiter_raw(self, chunk_size: Optional[int] = None) -> AsyncIterator[bytes]:
+        async with self._acatch_and_close():
+            async for chunk in self._response.aiter_raw(chunk_size=chunk_size):
+                yield chunk

githubkit/rest/__init__.py

@@ -373,6 +373,9 @@ if TYPE_CHECKING:
     from githubkit.versions.v2022_11_28.models import (
         CodeSecurityConfigurationPropCodeScanningDefaultSetupOptions as CodeSecurityConfigurationPropCodeScanningDefaultSetupOptions,
     )
+    from githubkit.versions.v2022_11_28.models import (
+        CodeSecurityConfigurationPropCodeScanningOptions as CodeSecurityConfigurationPropCodeScanningOptions,
+    )
     from githubkit.versions.v2022_11_28.models import (
         CodeSecurityConfigurationPropDependencyGraphAutosubmitActionOptions as CodeSecurityConfigurationPropDependencyGraphAutosubmitActionOptions,
     )
@@ -1303,6 +1306,12 @@ if TYPE_CHECKING:
     from githubkit.versions.v2022_11_28.models import (
         OrgsOrgAttestationsBulkListPostResponse200PropPageInfo as OrgsOrgAttestationsBulkListPostResponse200PropPageInfo,
     )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgAttestationsDeleteRequestPostBodyOneof0 as OrgsOrgAttestationsDeleteRequestPostBodyOneof0,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgAttestationsDeleteRequestPostBodyOneof1 as OrgsOrgAttestationsDeleteRequestPostBodyOneof1,
+    )
     from githubkit.versions.v2022_11_28.models import (
         OrgsOrgAttestationsSubjectDigestGetResponse200 as OrgsOrgAttestationsSubjectDigestGetResponse200,
     )
@@ -3446,6 +3455,18 @@ if TYPE_CHECKING:
     from githubkit.versions.v2022_11_28.models import (
         UserSshSigningKeysPostBody as UserSshSigningKeysPostBody,
     )
+    from githubkit.versions.v2022_11_28.models import (
+        UsersUsernameAttestationsBulkListPostBody as UsersUsernameAttestationsBulkListPostBody,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        UsersUsernameAttestationsBulkListPostResponse200 as UsersUsernameAttestationsBulkListPostResponse200,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        UsersUsernameAttestationsBulkListPostResponse200PropAttestationsSubjectDigests as UsersUsernameAttestationsBulkListPostResponse200PropAttestationsSubjectDigests,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        UsersUsernameAttestationsBulkListPostResponse200PropPageInfo as UsersUsernameAttestationsBulkListPostResponse200PropPageInfo,
+    )
     from githubkit.versions.v2022_11_28.models import (
         UsersUsernameAttestationsDeleteRequestPostBodyOneof0 as UsersUsernameAttestationsDeleteRequestPostBodyOneof0,
     )
@@ -9822,6 +9843,7 @@ else:
             "ClassroomAssignmentGrade",
             "CodeSecurityConfiguration",
             "CodeSecurityConfigurationPropDependencyGraphAutosubmitActionOptions",
+            "CodeSecurityConfigurationPropCodeScanningOptions",
             "CodeSecurityConfigurationPropCodeScanningDefaultSetupOptions",
             "CodeSecurityConfigurationPropSecretScanningDelegatedBypassOptions",
             "CodeSecurityConfigurationPropSecretScanningDelegatedBypassOptionsPropReviewersItems",
@@ -12758,6 +12780,8 @@ else:
             "OrgsOrgAttestationsBulkListPostResponse200",
             "OrgsOrgAttestationsBulkListPostResponse200PropAttestationsSubjectDigests",
             "OrgsOrgAttestationsBulkListPostResponse200PropPageInfo",
+            "OrgsOrgAttestationsDeleteRequestPostBodyOneof0",
+            "OrgsOrgAttestationsDeleteRequestPostBodyOneof1",
             "OrgsOrgAttestationsSubjectDigestGetResponse200",
             "OrgsOrgAttestationsSubjectDigestGetResponse200PropAttestationsItems",
             "OrgsOrgAttestationsSubjectDigestGetResponse200PropAttestationsItemsPropBundle",
@@ -13142,6 +13166,10 @@ else:
             "UserSocialAccountsPostBody",
             "UserSocialAccountsDeleteBody",
             "UserSshSigningKeysPostBody",
+            "UsersUsernameAttestationsBulkListPostBody",
+            "UsersUsernameAttestationsBulkListPostResponse200",
+            "UsersUsernameAttestationsBulkListPostResponse200PropAttestationsSubjectDigests",
+            "UsersUsernameAttestationsBulkListPostResponse200PropPageInfo",
             "UsersUsernameAttestationsDeleteRequestPostBodyOneof0",
             "UsersUsernameAttestationsDeleteRequestPostBodyOneof1",
             "UsersUsernameAttestationsSubjectDigestGetResponse200",

githubkit/typing.py

@@ -2,16 +2,19 @@ from collections.abc import Hashable, Mapping, Sequence
 from datetime import timedelta
 from typing import (
     IO,
+    TYPE_CHECKING,
     Annotated,
     Callable,
     Literal,
     NamedTuple,
     Optional,
+    TypedDict,
     TypeVar,
     Union,
 )
 from typing_extensions import TypeAlias
 
+import httpcore
 import httpx
 from pydantic import Field
 
@@ -19,11 +22,16 @@ from .compat import PYDANTIC_V2
 from .exception import GitHubException
 from .utils import Unset
 
+if TYPE_CHECKING:
+    from hishel._utils import BaseClock
+
 T = TypeVar("T")
 H = TypeVar("H", bound=Hashable)
 
 URLTypes: TypeAlias = Union[httpx.URL, str]
 
+ProxyTypes: TypeAlias = Union[httpx.URL, str, httpx.Proxy]
+
 PrimitiveData: TypeAlias = Optional[Union[str, int, float, bool]]
 QueryParamTypes: TypeAlias = Union[
     httpx.QueryParams,
@@ -89,3 +97,17 @@ class RetryOption(NamedTuple):
 
 
 RetryDecisionFunc: TypeAlias = Callable[[GitHubException, int], RetryOption]
+
+
+class HishelControllerOptions(TypedDict, total=False):
+    """Options for the hishel controller."""
+
+    cacheable_methods: Optional[list[str]]
+    cacheable_status_codes: Optional[list[int]]
+    cache_private: bool
+    allow_heuristics: bool
+    clock: Optional["BaseClock"]
+    allow_stale: bool
+    always_revalidate: bool
+    force_cache: bool
+    key_generator: Optional[Callable[[httpcore.Request, Optional[bytes]], str]]