githubkit 0.15.2__py3-none-any.whl → 0.15.3__py3-none-any.whl

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 ProxyTypes, RetryDecisionFunc
+from .typing import EventHookTypes, ProxyTypes, RetryDecisionFunc
 
 if TYPE_CHECKING:
     import ssl
@@ -26,6 +26,8 @@ class Config:
     proxy: Optional[ProxyTypes]
     transport: Optional[httpx.BaseTransport]
     async_transport: Optional[httpx.AsyncBaseTransport]
+    event_hooks: Optional[EventHookTypes]
+    async_event_hooks: Optional[EventHookTypes]
     cache_strategy: BaseCacheStrategy
     http_cache: bool
     throttler: BaseThrottler
@@ -117,6 +119,8 @@ def get_config(
     proxy: Optional[ProxyTypes] = None,
     transport: Optional[httpx.BaseTransport] = None,
     async_transport: Optional[httpx.AsyncBaseTransport] = None,
+    event_hooks: Optional[EventHookTypes] = None,
+    async_event_hooks: Optional[EventHookTypes] = None,
     cache_strategy: Optional[BaseCacheStrategy] = None,
     http_cache: bool = True,
     throttler: Optional[BaseThrottler] = None,
@@ -135,6 +139,8 @@ def get_config(
         proxy,
         transport,
         async_transport,
+        event_hooks,
+        async_event_hooks,
         build_cache_strategy(cache_strategy),
         http_cache,
         build_throttler(throttler),

githubkit/core.py

@@ -27,6 +27,7 @@ from .throttling import BaseThrottler
 from .typing import (
     ContentTypes,
     CookieTypes,
+    EventHookTypes,
     HeaderTypes,
     ProxyTypes,
     QueryParamTypes,
@@ -90,6 +91,8 @@ class GitHubCore(Generic[A]):
         proxy: Optional[ProxyTypes] = None,
         transport: Optional[httpx.BaseTransport] = None,
         async_transport: Optional[httpx.AsyncBaseTransport] = None,
+        event_hooks: Optional[EventHookTypes] = None,
+        async_event_hooks: Optional[EventHookTypes] = None,
         cache_strategy: Optional[BaseCacheStrategy] = None,
         http_cache: bool = True,
         throttler: Optional[BaseThrottler] = None,
@@ -114,6 +117,8 @@ class GitHubCore(Generic[A]):
         proxy: Optional[ProxyTypes] = None,
         transport: Optional[httpx.BaseTransport] = None,
         async_transport: Optional[httpx.AsyncBaseTransport] = None,
+        event_hooks: Optional[EventHookTypes] = None,
+        async_event_hooks: Optional[EventHookTypes] = None,
         cache_strategy: Optional[BaseCacheStrategy] = None,
         http_cache: bool = True,
         throttler: Optional[BaseThrottler] = None,
@@ -138,6 +143,8 @@ class GitHubCore(Generic[A]):
         proxy: Optional[ProxyTypes] = None,
         transport: Optional[httpx.BaseTransport] = None,
         async_transport: Optional[httpx.AsyncBaseTransport] = None,
+        event_hooks: Optional[EventHookTypes] = None,
+        async_event_hooks: Optional[EventHookTypes] = None,
         cache_strategy: Optional[BaseCacheStrategy] = None,
         http_cache: bool = True,
         throttler: Optional[BaseThrottler] = None,
@@ -161,6 +168,8 @@ class GitHubCore(Generic[A]):
         proxy: Optional[ProxyTypes] = None,
         transport: Optional[httpx.BaseTransport] = None,
         async_transport: Optional[httpx.AsyncBaseTransport] = None,
+        event_hooks: Optional[EventHookTypes] = None,
+        async_event_hooks: Optional[EventHookTypes] = None,
         cache_strategy: Optional[BaseCacheStrategy] = None,
         http_cache: bool = True,
         throttler: Optional[BaseThrottler] = None,
@@ -184,6 +193,8 @@ class GitHubCore(Generic[A]):
             proxy=proxy,
             transport=transport,
             async_transport=async_transport,
+            event_hooks=event_hooks,
+            async_event_hooks=async_event_hooks,
             cache_strategy=cache_strategy,
             http_cache=http_cache,
             throttler=throttler,
@@ -252,12 +263,15 @@ class GitHubCore(Generic[A]):
             return hishel.CacheClient(
                 **self._get_client_defaults(),
                 transport=self.config.transport,
+                event_hooks=self.config.event_hooks,
                 storage=self.config.cache_strategy.get_hishel_storage(),
                 controller=self.config.cache_strategy.get_hishel_controller(),
             )
 
         return httpx.Client(
-            **self._get_client_defaults(), transport=self.config.transport
+            **self._get_client_defaults(),
+            transport=self.config.transport,
+            event_hooks=self.config.event_hooks,
         )
 
     # get or create sync client
@@ -277,12 +291,15 @@ class GitHubCore(Generic[A]):
             return hishel.AsyncCacheClient(
                 **self._get_client_defaults(),
                 transport=self.config.async_transport,
+                event_hooks=self.config.async_event_hooks,
                 storage=self.config.cache_strategy.get_async_hishel_storage(),
                 controller=self.config.cache_strategy.get_hishel_controller(),
             )
 
         return httpx.AsyncClient(
-            **self._get_client_defaults(), transport=self.config.async_transport
+            **self._get_client_defaults(),
+            transport=self.config.async_transport,
+            event_hooks=self.config.async_event_hooks,
         )
 
     # get or create async client

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 ProxyTypes, RetryDecisionFunc
+from .typing import EventHookTypes, ProxyTypes, RetryDecisionFunc
 from .versions import RestVersionSwitcher, WebhooksVersionSwitcher
 
 if TYPE_CHECKING:
@@ -81,6 +81,8 @@ class GitHub(GitHubCore[A]):
             proxy: Optional[ProxyTypes] = None,
             transport: Optional[httpx.BaseTransport] = None,
             async_transport: Optional[httpx.AsyncBaseTransport] = None,
+            event_hooks: Optional[EventHookTypes] = None,
+            async_event_hooks: Optional[EventHookTypes] = None,
             cache_strategy: Optional["BaseCacheStrategy"] = None,
             http_cache: bool = True,
             throttler: Optional["BaseThrottler"] = None,
@@ -105,6 +107,8 @@ class GitHub(GitHubCore[A]):
             proxy: Optional[ProxyTypes] = None,
             transport: Optional[httpx.BaseTransport] = None,
             async_transport: Optional[httpx.AsyncBaseTransport] = None,
+            event_hooks: Optional[EventHookTypes] = None,
+            async_event_hooks: Optional[EventHookTypes] = None,
             cache_strategy: Optional["BaseCacheStrategy"] = None,
             http_cache: bool = True,
             throttler: Optional["BaseThrottler"] = None,
@@ -129,6 +133,8 @@ class GitHub(GitHubCore[A]):
             proxy: Optional[ProxyTypes] = None,
             transport: Optional[httpx.BaseTransport] = None,
             async_transport: Optional[httpx.AsyncBaseTransport] = None,
+            event_hooks: Optional[EventHookTypes] = None,
+            async_event_hooks: Optional[EventHookTypes] = None,
             cache_strategy: Optional["BaseCacheStrategy"] = None,
             http_cache: bool = True,
             throttler: Optional["BaseThrottler"] = None,

githubkit/typing.py

@@ -4,6 +4,7 @@ from typing import (
     IO,
     TYPE_CHECKING,
     Annotated,
+    Any,
     Callable,
     Literal,
     NamedTuple,
@@ -99,6 +100,9 @@ class RetryOption(NamedTuple):
 RetryDecisionFunc: TypeAlias = Callable[[GitHubException, int], RetryOption]
 
 
+EventHookTypes: TypeAlias = Mapping[str, list[Callable[..., Any]]]
+
+
 class HishelControllerOptions(TypedDict, total=False):
     """Options for the hishel controller."""