rapid-api-client 0.3.4__tar.gz → 0.3.6__tar.gz

{rapid_api_client-0.3.4 → rapid_api_client-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rapid-api-client
-Version: 0.3.4
+Version: 0.3.6
 Summary: Rapidly develop your API clients using decorators and annotations
 Author: Sébastien MB
 Author-email: seb@essembeh.org

{rapid_api_client-0.3.4 → rapid_api_client-0.3.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rapid-api-client"
-version = "0.3.4"
+version = "0.3.6"
 description = "Rapidly develop your API clients using decorators and annotations"
 authors = ["Sébastien MB <seb@essembeh.org>"]
 readme = "README.md"

{rapid_api_client-0.3.4 → rapid_api_client-0.3.6}/rapid_api_client/annotations.py

@@ -3,7 +3,7 @@ Model classes
 """
 
 from dataclasses import dataclass
-from typing import Any, Literal
+from typing import Any
 
 from pydantic import BaseModel
 
@@ -49,8 +49,6 @@ class Body(BaseAnnotation):
     Annotation to declare an argument used as http content for post/put/...
     """
 
-    target: Literal["content", "data", "files"] = "content"
-
     def serialize(self, body: Any) -> str | bytes:
         """
         Serialize the annotated parameter value
@@ -58,13 +56,24 @@ class Body(BaseAnnotation):
         return body
 
 
+@dataclass
+class FormBody(Body):
+    """
+    Annotation to declare an argument used as url-encoded parameter
+    If the annotated parameter is a Dict[str, str], its content will be merged to other form parameters,
+    else, its name (or alias) and its serialized value will be added to the the other form parameters.
+
+    """
+
+    alias: str | None = None
+
+
 @dataclass
 class FileBody(Body):
     """
     Annotation to declare an argument used as file to be uploaded
     """
 
-    target: Literal["content", "data", "files"] = "files"
     alias: str | None = None
 
 

{rapid_api_client-0.3.4 → rapid_api_client-0.3.6}/rapid_api_client/client.py

@@ -16,9 +16,13 @@ from typing import (
 
 from httpx import AsyncClient, Request, Response
 from pydantic import BaseModel, TypeAdapter
-from pydantic_xml import BaseXmlModel
 
-from .annotations import BaseAnnotation, Body, FileBody, Header, Path, Query
+try:
+    import pydantic_xml
+except ImportError:  # pragma: nocover
+    pydantic_xml = None  # type: ignore
+
+from .annotations import BaseAnnotation, Body, FileBody, FormBody, Header, Path, Query
 from .utils import filter_none_values, find_annotation
 
 BM = TypeVar("BM", bound=BaseModel)
@@ -103,8 +107,14 @@ class RapidApi:
                 if isinstance(annot, FileBody):
                     files = build_kwargs.setdefault("files", {})
                     files[annot.alias or param] = annot.serialize(value)
+                elif isinstance(annot, FormBody):
+                    data = build_kwargs.setdefault("data", {})
+                    if isinstance(value, dict):
+                        data.update(value)
+                    else:
+                        data[annot.alias or param] = annot.serialize(value)
                 else:
-                    build_kwargs[annot.target] = annot.serialize(value)
+                    build_kwargs["content"] = annot.serialize(value)
 
         # handle extra optional kwargs
         if timeout is not None:
@@ -131,7 +141,9 @@ class RapidApi:
             return response.content
         if isinstance(response_class, TypeAdapter):
             return response_class.validate_json(response.content)
-        if issubclass(response_class, BaseXmlModel):
+        if pydantic_xml is not None and issubclass(
+            response_class, pydantic_xml.BaseXmlModel
+        ):
             return response_class.from_xml(response.content)
         if issubclass(response_class, BaseModel):
             return response_class.model_validate_json(response.content)