♻️ separate github core

Author: yanyongyu

codegen/templates/client/client.py.jinja

@@ -21,11 +21,11 @@ from pydantic import BaseModel, parse_obj_as
 from githubkit.utils import exclude_unset
 
 if TYPE_CHECKING:
-    from githubkit import GitHub
+    from githubkit import GitHubCore
     from githubkit.response import Response
 
 class {{ pascal_case(tag) }}Client:
-    def __init__(self, github: "GitHub"):
+    def __init__(self, github: "GitHubCore"):
         self._github = github
 
     {% for endpoint in endpoints %}

codegen/templates/namespace/namespace.py.jinja

@@ -13,11 +13,11 @@ from .{{ tag }} import {{ pascal_case(tag) }}Client
 {% endfor %}
 
 if TYPE_CHECKING:
-    from githubkit import GitHub
+    from githubkit import GitHubCore
 
 
 class RestNamespace:
-    def __init__(self, github: "GitHub"):
+    def __init__(self, github: "GitHubCore"):
         self._github = github
 
     {% for tag in tags %}

githubkit/__init__.py

@@ -1,5 +1,6 @@
-from .core import GitHub as GitHub
 from .config import Config as Config
+from .github import GitHub as GitHub
+from .core import GitHubCore as GitHubCore
 from .response import Response as Response
 from .paginator import Paginator as Paginator
 from .auth import AppAuthStrategy as AppAuthStrategy

githubkit/auth/action.py

@@ -8,7 +8,7 @@
 from .base import BaseAuthStrategy
 
 if TYPE_CHECKING:
-    from githubkit import GitHub
+    from githubkit import GitHubCore
 
 
 class ActionAuth(httpx.Auth):
@@ -25,5 +25,5 @@ def auth_flow(
 
 
 class ActionAuthStrategy(BaseAuthStrategy):
-    def get_auth_flow(self, github: "GitHub") -> httpx.Auth:
+    def get_auth_flow(self, github: "GitHubCore") -> httpx.Auth:
         return ActionAuth()

githubkit/auth/app.py

@@ -24,15 +24,15 @@
     jwt = None
 
 if TYPE_CHECKING:
-    from githubkit import GitHub, Response
+    from githubkit import Response, GitHubCore
     from githubkit.rest.types import AppPermissionsType
 
 
 @dataclass(slots=True)
 class AppAuth(httpx.Auth):
     """GitHub App or Installation Authentication Hook"""
 
-    github: "GitHub"
+    github: "GitHubCore"
     app_id: str
     private_key: str
     client_id: Optional[str] = None
@@ -251,7 +251,7 @@ def as_oauth_app(self) -> OAuthAppAuthStrategy:
             )
         return OAuthAppAuthStrategy(self.client_id, self.client_secret)
 
-    def get_auth_flow(self, github: "GitHub") -> httpx.Auth:
+    def get_auth_flow(self, github: "GitHubCore") -> httpx.Auth:
         return AppAuth(
             github,
             self.app_id,
@@ -285,7 +285,7 @@ def as_app(self) -> AppAuthStrategy:
             self.cache,
         )
 
-    def get_auth_flow(self, github: "GitHub") -> httpx.Auth:
+    def get_auth_flow(self, github: "GitHubCore") -> httpx.Auth:
         return AppAuth(
             github,
             self.app_id,

githubkit/auth/base.py

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

githubkit/auth/oauth.py

@@ -29,11 +29,11 @@
 from ._url import require_bypass, get_oauth_base_url, require_basic_auth
 
 if TYPE_CHECKING:
-    from githubkit import GitHub
+    from githubkit import GitHubCore
 
 
 def create_device_code(
-    github: "GitHub", client_id: str, scopes: Optional[List[str]] = None
+    github: "GitHubCore", client_id: str, scopes: Optional[List[str]] = 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)
@@ -55,7 +55,7 @@ def create_device_code(
 
 
 def exchange_web_flow_code(
-    github: "GitHub",
+    github: "GitHubCore",
     client_id: str,
     client_secret: str,
     code: str,
@@ -85,7 +85,7 @@ def exchange_web_flow_code(
 
 
 def exchange_device_code(
-    github: "GitHub", client_id: str, device_code: str
+    github: "GitHubCore", client_id: str, device_code: str
 ) -> Generator[httpx.Request, httpx.Response, Dict[str, Any]]:
     """Exchange device code for token."""
     base_url = get_oauth_base_url(github.config.base_url)
@@ -108,7 +108,7 @@ def exchange_device_code(
 
 
 def refresh_token(
-    github: "GitHub", client_id: str, client_secret: str, refresh_token: str
+    github: "GitHubCore", client_id: str, client_secret: str, refresh_token: str
 ) -> Generator[httpx.Request, httpx.Response, Dict[str, Any]]:
     """Refresh token."""
     base_url = get_oauth_base_url(github.config.base_url)
@@ -132,7 +132,7 @@ def refresh_token(
 class OAuthWebAuth(httpx.Auth):
     """OAuth Web Flow Hook Authentication"""
 
-    github: "GitHub"
+    github: "GitHubCore"
     client_id: str
     client_secret: str
     code: str
@@ -237,7 +237,7 @@ def auth_flow(
 class OAuthDeviceAuth(httpx.Auth):
     """OAuth Device Flow Hook Authentication"""
 
-    github: "GitHub"
+    github: "GitHubCore"
     client_id: str
     on_verification: Union[
         Callable[[Dict[str, Any]], None],
@@ -394,7 +394,7 @@ def as_web_user(
             self.client_id, self.client_secret, code, redirect_uri
         )
 
-    def get_auth_flow(self, github: "GitHub") -> httpx.Auth:
+    def get_auth_flow(self, github: "GitHubCore") -> httpx.Auth:
         return httpx.BasicAuth(self.client_id, self.client_secret)
 
 
@@ -410,7 +410,7 @@ class OAuthWebAuthStrategy(BaseAuthStrategy):
     def as_oauth_app(self) -> OAuthAppAuthStrategy:
         return OAuthAppAuthStrategy(self.client_id, self.client_secret)
 
-    def get_auth_flow(self, github: "GitHub") -> httpx.Auth:
+    def get_auth_flow(self, github: "GitHubCore") -> httpx.Auth:
         return OAuthWebAuth(
             github, self.client_id, self.client_secret, self.code, self.redirect_uri
         )
@@ -423,5 +423,5 @@ class OAuthDeviceAuthStrategy(BaseAuthStrategy):
     client_id: str
     on_verification: Callable
 
-    def get_auth_flow(self, github: "GitHub") -> httpx.Auth:
+    def get_auth_flow(self, github: "GitHubCore") -> httpx.Auth:
         return OAuthDeviceAuth(github, self.client_id, self.on_verification)

githubkit/auth/token.py

@@ -6,7 +6,7 @@
 from .base import BaseAuthStrategy
 
 if TYPE_CHECKING:
-    from githubkit import GitHub
+    from githubkit import GitHubCore
 
 
 @dataclass(slots=True)
@@ -31,5 +31,5 @@ class TokenAuthStrategy(BaseAuthStrategy):
 
     token: str
 
-    def get_auth_flow(self, github: "GitHub") -> httpx.Auth:
+    def get_auth_flow(self, github: "GitHubCore") -> httpx.Auth:
         return TokenAuth(self.token)

githubkit/auth/unauth.py

@@ -5,11 +5,11 @@
 from .base import BaseAuthStrategy
 
 if TYPE_CHECKING:
-    from githubkit import GitHub
+    from githubkit import GitHubCore
 
 
 class UnauthAuthStrategy(BaseAuthStrategy):
     """Unauthenticated GitHubKit"""
 
-    def get_auth_flow(self, github: "GitHub") -> httpx.Auth:
+    def get_auth_flow(self, github: "GitHubCore") -> httpx.Auth:
         return httpx.Auth()

githubkit/core.py

@@ -22,12 +22,9 @@
 import httpx
 
 from .response import Response
-from .rest import RestNamespace
-from .paginator import Paginator
 from .exception import RequestFailed
 from .config import Config, get_config
 from .auth import BaseAuthStrategy, TokenAuthStrategy, UnauthAuthStrategy
-from .graphql import GraphQLResponse, build_graphql_request, parse_graphql_response
 from .typing import (
     URLTypes,
     CookieTypes,
@@ -39,23 +36,13 @@
 
 T = TypeVar("T")
 A = TypeVar("A", bound="BaseAuthStrategy")
-A_o = TypeVar("A_o", bound="BaseAuthStrategy")
 
-CP = ParamSpec("CP")
-CT = TypeVar("CT")
-RT = TypeVar("RT")
 
-R = Union[
-    Callable[CP, Response[List[RT]]],
-    Callable[CP, Awaitable[Response[List[RT]]]],
-]
-
-
-class GitHub(Generic[A]):
+class GitHubCore(Generic[A]):
     # none auth with config
     @overload
     def __init__(
-        self: "GitHub[UnauthAuthStrategy]",
+        self: "GitHubCore[UnauthAuthStrategy]",
         auth: None = None,
         *,
         config: Config,
@@ -65,7 +52,7 @@ def __init__(
     # token auth with config
     @overload
     def __init__(
-        self: "GitHub[TokenAuthStrategy]",
+        self: "GitHubCore[TokenAuthStrategy]",
         auth: str,
         *,
         config: Config,
@@ -75,7 +62,7 @@ def __init__(
     # other auth strategies with config
     @overload
     def __init__(
-        self: "GitHub[A]",
+        self: "GitHubCore[A]",
         auth: A,
         *,
         config: Config,
@@ -85,7 +72,7 @@ def __init__(
     # none auth without config
     @overload
     def __init__(
-        self: "GitHub[UnauthAuthStrategy]",
+        self: "GitHubCore[UnauthAuthStrategy]",
         auth: None = None,
         *,
         base_url: Optional[Union[str, httpx.URL]] = None,
@@ -100,7 +87,7 @@ def __init__(
     # token auth without config
     @overload
     def __init__(
-        self: "GitHub[TokenAuthStrategy]",
+        self: "GitHubCore[TokenAuthStrategy]",
         auth: str,
         *,
         base_url: Optional[Union[str, httpx.URL]] = None,
@@ -115,7 +102,7 @@ def __init__(
     # other auth strategies without config
     @overload
     def __init__(
-        self: "GitHub[A]",
+        self: "GitHubCore[A]",
         auth: A,
         *,
         base_url: Optional[Union[str, httpx.URL]] = None,
@@ -357,71 +344,3 @@ async def arequest(
             cookies=cookies,
         )
         return self._check(raw_resp, response_model, error_models)
-
-    # copy github instance with other auth
-    def with_auth(self, auth: A_o) -> "GitHub[A_o]":
-        return GitHub(auth=auth, config=self.config.copy())
-
-    # high level methods
-
-    # rest api
-    @cached_property
-    def rest(self) -> RestNamespace:
-        return RestNamespace(self)
-
-    # graphql
-    def graphql(
-        self, query: str, variables: Optional[Dict[str, Any]] = None
-    ) -> Dict[str, Any]:
-        json = build_graphql_request(query, variables)
-
-        return parse_graphql_response(
-            self.request("POST", "/graphql", json=json, response_model=GraphQLResponse)
-        )
-
-    async def async_graphql(
-        self, query: str, variables: Optional[Dict[str, Any]] = None
-    ) -> Dict[str, Any]:
-        json = build_graphql_request(query, variables)
-
-        return parse_graphql_response(
-            await self.arequest(
-                "POST", "/graphql", json=json, response_model=GraphQLResponse
-            )
-        )
-
-    # rest pagination
-    @overload
-    @staticmethod
-    def paginate(
-        request: R[CP, RT],
-        page: int = 1,
-        per_page: int = 100,
-        map_func: None = None,
-        *args: CP.args,
-        **kwargs: CP.kwargs,
-    ) -> Paginator[RT]:
-        ...
-
-    @overload
-    @staticmethod
-    def paginate(
-        request: R[CP, CT],
-        page: int = 1,
-        per_page: int = 100,
-        map_func: Callable[[Response[List[CT]]], List[RT]] = ...,  # type: ignore
-        *args: CP.args,
-        **kwargs: CP.kwargs,
-    ) -> Paginator[RT]:
-        ...
-
-    @staticmethod
-    def paginate(
-        request: R[CP, CT],
-        page: int = 1,
-        per_page: int = 100,
-        map_func: Optional[Callable[[Response[List[CT]]], List[RT]]] = None,
-        *args: CP.args,
-        **kwargs: CP.kwargs,
-    ) -> Paginator[RT]:
-        return Paginator(request, page, per_page, map_func, *args, **kwargs)  # type: ignore