Merge pull request #76 from ponytailer/support-file-response

Support file response

Author: ponytailer

README.md

@@ -79,12 +79,6 @@ And see the examples.
 <details>
 <summary> Change Log </summary>
 
-### v1.0.0: refactor all the code, to be simple. remove the group client.
-
-### v1.0.1: simple to use.
-
-### v1.0.2: use enum to define the client type.
-
 ### v1.0.3: you can define your own client session in `client_config`
 
 ```python
@@ -101,4 +95,17 @@ client_config = ClientConfig(
 
 
 ```
+### v1.0.5: support file response type.
+
+```python
+from pydantic_client.schema.file import File
+from pydantic_client import post
+
+@post("/download")
+def download_file(self) -> File:
+    # you will get the bytes content of the file
+    ...
+
+```
+
 </details>

pydantic_client/clients/abstract_client.py

@@ -13,7 +13,7 @@ def __init__(self, config: ClientConfig):
     def get_session(self):
         return self.config.client_session
 
-    def do_request(self, request: HttpRequest) -> Dict[str, Any]:
+    def do_request(self, request: HttpRequest) -> Any:
         raise NotImplementedError
 
     def parse(self, request: HttpRequest) -> Dict[str, Any]:

pydantic_client/clients/aiohttp.py

@@ -1,4 +1,4 @@
-from typing import Any, Callable, Dict
+from typing import Any, Callable
 
 from pydantic_client.clients.abstract_client import AbstractClient
 from pydantic_client.schema.http_request import HttpRequest
@@ -15,7 +15,7 @@ def get_session(self) -> Callable[[], ClientSession]:
         session = super().get_session()
         return lambda: ClientSession() if not session else session()
 
-    async def do_request(self, request: HttpRequest) -> Dict[str, Any]:
+    async def do_request(self, request: HttpRequest) -> Any:
         session_factory = self.get_session()
         s = session_factory()
         async with s as session:
@@ -24,6 +24,8 @@ async def do_request(self, request: HttpRequest) -> Dict[str, Any]:
                 async with req as resp:
                     resp.raise_for_status()
                     if resp.status == 200:
-                        return await resp.json()
+                        if not request.is_file:
+                            return await resp.json()
+                        return await resp.content.read()
             except BaseException as e:
                 raise e

pydantic_client/clients/httpx.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict
+from typing import Any
 
 from pydantic_client.clients.abstract_client import AbstractClient
 from pydantic_client.schema.http_request import HttpRequest
@@ -16,12 +16,14 @@ def get_session(self):
         return session if isinstance(session, AsyncClient) \
             else AsyncClient(http2=self.config.http2)
 
-    async def do_request(self, request: HttpRequest) -> Dict[str, Any]:
+    async def do_request(self, request: HttpRequest) -> Any:
         async with self.get_session() as session:
             try:
                 response = await session.request(**self.parse(request))
                 response.raise_for_status()
                 if response.is_success:
-                    return response.json()
+                    if not request.is_file:
+                        return response.json()
+                    return response.read()
             except BaseException as e:
                 raise e

pydantic_client/clients/requests.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict
+from typing import Any
 
 from pydantic_client.clients.abstract_client import AbstractClient
 from pydantic_client.schema.http_request import HttpRequest
@@ -16,8 +16,10 @@ def get_session(self) -> Session:
         session = super().get_session()
         return session if isinstance(session, Session) else self.session
 
-    def do_request(self, request: HttpRequest) -> Dict[str, Any]:
+    def do_request(self, request: HttpRequest) -> Any:
         try:
-            return self.get_session().request(**self.parse(request)).json()
+            response = self.get_session().request(**self.parse(request))
+            response.raise_for_status()
+            return response.json() if not request.is_file else response.content
         except BaseException as e:
             raise e

pydantic_client/container.py

@@ -78,7 +78,8 @@ def get_request(method_info: MethodInfo, *args, **kwargs):
             data=data,
             json_body=json,
             method=method_info.http_method,
-            request_headers=request_headers
+            request_headers=request_headers,
+            is_file=method_info.response_type is bytes
         )
 
 

pydantic_client/decorators.py

@@ -6,6 +6,7 @@
 from pydantic._internal._model_construction import ModelMetaclass
 
 from pydantic_client.container import container
+from pydantic_client.schema.file import File
 from pydantic_client.schema.method_info import MethodInfo
 
 logger = logging.getLogger(__name__)
@@ -51,6 +52,9 @@ def convert(value, target_type):
             rt = method_info.response_type
             if not rt:
                 return value
+
+            if isinstance(rt, File) and isinstance(value, bytes):
+                return value
             if isinstance(value, dict) and isinstance(rt, ModelMetaclass):
                 return target_type(**value)
             try:

pydantic_client/schema/file.py

@@ -0,0 +1,3 @@
+from typing_extensions import TypeAlias
+
+File: TypeAlias = bytes

pydantic_client/schema/http_request.py

@@ -9,3 +9,4 @@ class HttpRequest(BaseModel):
     url: str
     method: str
     request_headers: Optional[Dict] = None
+    is_file: bool = False

pydantic_client/schema/method_info.py

@@ -1,12 +1,14 @@
-from typing import Any, Callable, Dict, Optional, Type
+from typing import Any, Callable, Dict, Optional
 
 from pydantic import BaseModel
 
+from pydantic_client.schema.file import File
+
 
 class MethodInfo(BaseModel):
     func: Callable
     http_method: str
     url: str
     request_type: Dict[str, Any]
-    response_type: Optional[Type]
+    response_type: Optional[Any]
     form_body: bool