refact auth extends relation

cozepy/__init__.py

@@ -19,6 +19,7 @@
     OAuthToken,
     PKCEOAuthApp,
     Scope,
+    SyncAuth,
     TokenAuth,
     WebOAuthApp,
     load_oauth_app_from_config,
@@ -175,6 +176,7 @@
     "AsyncWebOAuthApp",
     "Auth",
     "AsyncAuth",
+    "SyncAuth",
     "AsyncJWTAuth",
     "AsyncTokenAuth",
     "DeviceAuthCode",

cozepy/auth/__init__.py

@@ -700,6 +700,15 @@ def token(self) -> str:
         :return: token
         """
 
+    @property
+    @abc.abstractmethod
+    async def atoken(self) -> str:
+        """
+        The token used in the http request header.
+
+        :return: token
+        """
+
     def authentication(self, headers: dict) -> None:
         """
         Construct the authorization header in the http headers.
@@ -709,8 +718,52 @@ def authentication(self, headers: dict) -> None:
         """
         headers["Authorization"] = f"{self.token_type} {self.token}"
 
+    async def aauthentication(self, headers: dict) -> None:
+        """
+        Construct the authorization header in the http headers.
+
+        :param headers: http headers
+        :return: None
+        """
+        headers["Authorization"] = f"{self.token_type} {await self.atoken}"
+
+
+class SyncAuth(Auth, abc.ABC):
+    """
+    This class is the base class for all SyncAuth authorization types.
+
+    It provides the abstract methods for getting the token type and sync token.
+    """
+
+    @property
+    async def atoken(self) -> str:
+        """
+        SyncAuth not need implementation.
+
+        :return: sync token for compatible
+        """
+        return self.token
+
+
+class AsyncAuth(Auth, abc.ABC):
+    """
+    This class is the base class for all authorization types.
+
+    It provides the abstract methods for getting the token type and async token.
+    """
+
+    @property
+    def token(self) -> str:
+        """
+        AsyncAuth not need implementation.
+        Any compatible needed.
+
+        :return: empty
+        """
+        return ""
+
 
-class TokenAuth(Auth):
+class TokenAuth(SyncAuth):
     """
     The fixed access token auth flow.
     """
@@ -729,7 +782,7 @@ def token(self) -> str:
         return self._token
 
 
-class JWTAuth(Auth):
+class JWTAuth(SyncAuth):
     """
     The JWT auth flow.
     """
@@ -775,43 +828,6 @@ def _generate_token(self):
         return self._token
 
 
-class AsyncAuth(abc.ABC):
-    """
-    This class is the base class for all authorization types.
-
-    It provides the abstract methods for getting the token type and token.
-    """
-
-    @property
-    @abc.abstractmethod
-    def token_type(self) -> str:
-        """
-        The authorization type used in the http request header.
-
-        eg: Bearer, Basic, etc.
-
-        :return: token type
-        """
-
-    @property
-    @abc.abstractmethod
-    async def token(self) -> str:
-        """
-        The token used in the http request header.
-
-        :return: token
-        """
-
-    async def authentication(self, headers: dict) -> None:
-        """
-        Construct the authorization header in the http headers.
-
-        :param headers: http headers
-        :return: None
-        """
-        headers["Authorization"] = f"{self.token_type} {await self.token}"
-
-
 class AsyncTokenAuth(AsyncAuth):
     """
     The fixed access token auth flow.
@@ -827,7 +843,7 @@ def token_type(self) -> str:
         return "Bearer"
 
     @property
-    async def token(self) -> str:
+    async def atoken(self) -> str:
         return self._token
 
 
@@ -866,7 +882,7 @@ def token_type(self) -> str:
         return "Bearer"
 
     @property
-    async def token(self) -> str:
+    async def atoken(self) -> str:
         token = await self._generate_token()
         return token.access_token
 

cozepy/coze.py

@@ -1,7 +1,7 @@
 import warnings
-from typing import TYPE_CHECKING, Optional, Union
+from typing import TYPE_CHECKING, Optional
 
-from cozepy.auth import AsyncAuth, Auth
+from cozepy.auth import Auth, SyncAuth
 from cozepy.config import COZE_COM_BASE_URL
 from cozepy.request import AsyncHTTPClient, Requester, SyncHTTPClient
 from cozepy.util import remove_url_trailing_slash
@@ -143,22 +143,21 @@ def users(self) -> "UsersClient":
 class AsyncCoze(object):
     def __init__(
         self,
-        auth: Union[Auth, AsyncAuth],
+        auth: Auth,
         base_url: str = COZE_COM_BASE_URL,
         http_client: Optional[AsyncHTTPClient] = None,
     ):
         self._auth = auth
         self._base_url = remove_url_trailing_slash(base_url)
-        if isinstance(auth, Auth):
+        if isinstance(auth, SyncAuth):
             warnings.warn(
-                "The 'coze.Auth' use for AsyncCoze is deprecated and will be removed in a future version. "
+                "The 'coze.SyncAuth' use for AsyncCoze is deprecated and will be removed in a future version. "
                 "Please use 'coze.AsyncAuth' instead.",
                 DeprecationWarning,
                 stacklevel=2,
             )
-            self._requester = Requester(auth=auth, async_client=http_client)
-        else:
-            self._requester = Requester(async_auth=auth, async_client=http_client)
+
+        self._requester = Requester(auth=auth, async_client=http_client)
 
         # service client
         self._bots: Optional[AsyncBotsClient] = None

cozepy/knowledge/documents/__init__.py

@@ -2,15 +2,10 @@
 from typing import List, Optional
 
 from cozepy.datasets.documents import (
-    Document,  # noqa
-    DocumentBase,  # noqa
-    DocumentChunkStrategy,  # noqa
-    # noqa
-    # noqa
-    # noqa
-    # noqa
-    DocumentUpdateRule,  # noqa
-    # noqa
+    Document,
+    DocumentBase,
+    DocumentChunkStrategy,
+    DocumentUpdateRule,
 )
 from cozepy.model import AsyncNumberPaged, CozeModel, HTTPRequest, NumberPaged, NumberPagedResponse
 from cozepy.request import Requester

cozepy/request.py

@@ -28,7 +28,7 @@
 from cozepy.version import coze_client_user_agent, user_agent
 
 if TYPE_CHECKING:
-    from cozepy.auth import AsyncAuth, Auth
+    from cozepy.auth import Auth
 
 T = TypeVar("T", bound=BaseModel)
 
@@ -57,12 +57,10 @@ class Requester(object):
     def __init__(
         self,
         auth: Optional["Auth"] = None,
-        async_auth: Optional["AsyncAuth"] = None,
         sync_client: Optional[SyncHTTPClient] = None,
         async_client: Optional[AsyncHTTPClient] = None,
     ):
         self._auth = auth
-        self._async_auth = async_auth
         self._sync_client = sync_client
         self._async_client = async_client
 
@@ -71,11 +69,8 @@ def auth_header(self, headers: dict):
             self._auth.authentication(headers)
 
     async def async_auth_header(self, headers: dict):
-        if self._async_auth:
-            await self._async_auth.authentication(headers)
-        elif self._auth:
-            # Compatible with old versions, the next version will be removed
-            self._auth.authentication(headers)
+        if self._auth:
+            await self._auth.aauthentication(headers)
 
     def make_request(
         self,
@@ -136,11 +131,8 @@ async def amake_request(
         headers["User-Agent"] = user_agent()
         headers["X-Coze-Client-User-Agent"] = coze_client_user_agent()
 
-        if self._async_auth:
-            await self._async_auth.authentication(headers)
-        elif self._auth:
-            # Compatible with old versions, the next version will be removed
-            self._auth.authentication(headers)
+        if self._auth:
+            await self._auth.aauthentication(headers)
 
         log_debug(
             "request %s#%s sending, params=%s, json=%s, stream=%s, async=%s",