✨ add httpx exception catch

Author: yanyongyu

githubkit/core.py

@@ -22,8 +22,8 @@
 import httpx
 
 from .response import Response
-from .exception import RequestFailed
 from .config import Config, get_config
+from .exception import RequestError, RequestFailed, RequestTimeout
 from .auth import BaseAuthStrategy, TokenAuthStrategy, UnauthAuthStrategy
 from .typing import (
     URLTypes,
@@ -228,17 +228,22 @@ def _request(
         cookies: Optional[CookieTypes] = None,
     ) -> httpx.Response:
         with self.get_sync_client() as client:
-            return client.request(
-                method,
-                url,
-                params=params,
-                content=content,
-                data=data,
-                files=files,
-                json=json,
-                headers=headers,
-                cookies=cookies,
-            )
+            try:
+                return client.request(
+                    method,
+                    url,
+                    params=params,
+                    content=content,
+                    data=data,
+                    files=files,
+                    json=json,
+                    headers=headers,
+                    cookies=cookies,
+                )
+            except httpx.TimeoutException as e:
+                raise RequestTimeout(e.request) from e
+            except Exception as e:
+                raise RequestError(repr(e)) from e
 
     # async request
     async def _arequest(
@@ -255,17 +260,22 @@ async def _arequest(
         cookies: Optional[CookieTypes] = None,
     ) -> httpx.Response:
         async with self.get_async_client() as client:
-            return await client.request(
-                method,
-                url,
-                params=params,
-                content=content,
-                data=data,
-                files=files,
-                json=json,
-                headers=headers,
-                cookies=cookies,
-            )
+            try:
+                return await client.request(
+                    method,
+                    url,
+                    params=params,
+                    content=content,
+                    data=data,
+                    files=files,
+                    json=json,
+                    headers=headers,
+                    cookies=cookies,
+                )
+            except httpx.TimeoutException as e:
+                raise RequestTimeout(e.request) from e
+            except Exception as e:
+                raise RequestError(repr(e)) from e
 
     # check and parse response
     def _check(

githubkit/exception.py

@@ -1,5 +1,7 @@
 from typing import TYPE_CHECKING
 
+import httpx
+
 if TYPE_CHECKING:
     from .response import Response
     from .graphql import GraphQLResponse
@@ -17,10 +19,22 @@ class AuthExpiredError(GitHubException):
     """Auth Expired Error"""
 
 
+class RequestError(GitHubException):
+    """Simple API request failed with unknown error"""
+
+
+class RequestTimeout(GitHubException):
+    """Simple API request timeout"""
+
+    def __init__(self, request: httpx.Request):
+        self.request = request
+
+
 class RequestFailed(GitHubException):
     """Simple API request failed with error status code"""
 
     def __init__(self, response: "Response"):
+        self.request = response.raw_request
         self.response = response
 
     def __repr__(self) -> str:

githubkit/github.py

@@ -33,8 +33,6 @@
 
 
 class GitHub(GitHubCore[A]):
-    # high level methods
-
     # copy github instance with other auth
     def with_auth(self, auth: A_o) -> "GitHub[A_o]":
         return GitHub(auth=auth, config=self.config.copy())