Merge pull request #47 from unmade/rename-json-type

Rename json type

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "apiwrappers"
-version = "0.1.1"
+version = "0.2.0"
 description = "apiwrappers is a library for building API clients that work both with regular and async code"
 keywords = ["api", "wrapper", "http", "client"]
 readme = "README.rst"

src/apiwrappers/entities.py

@@ -9,7 +9,7 @@
 from typing import Any, MutableMapping, Union, cast
 
 from apiwrappers.structures import CaseInsensitiveDict, Url
-from apiwrappers.typedefs import JSON, Auth, Data, Files, QueryParams
+from apiwrappers.typedefs import Auth, Data, Files, Json, QueryParams
 
 
 class Method(enum.Enum):
@@ -94,7 +94,7 @@ class Request:
     auth: Auth = None
     data: Data = None
     files: Files = None
-    json: JSON = None
+    json: Json = None
 
     def __init__(
         self,
@@ -106,7 +106,7 @@ def __init__(
         auth: Auth = None,
         data: Data = None,
         files: Files = None,
-        json: JSON = None,
+        json: Json = None,
     ):
         # pylint: disable=redefined-outer-name,too-many-arguments
         if sum((data is not None, files is not None, json is not None)) > 1:
@@ -164,11 +164,11 @@ def text(self) -> str:
         """
         return self.content.decode(self.encoding)
 
-    def json(self) -> JSON:
+    def json(self) -> Json:
         """
         Returns the json-encoded content of the response.
 
         Raises:
              ValueError: if the response body does not contain valid json.
         """
-        return cast(JSON, json.loads(self.content.decode(self.encoding)))
+        return cast(Json, json.loads(self.content.decode(self.encoding)))

src/apiwrappers/typedefs.py

@@ -27,7 +27,7 @@
 Data = Union[str, None, Mapping[str, Any], Iterable[Tuple[str, Any]]]
 FilesValue = Union[BinaryIO, Tuple[str, BinaryIO], Tuple[str, BinaryIO, str]]
 Files = Optional[Dict[str, FilesValue]]
-JSON = Union[str, int, float, bool, None, Mapping[str, Any], List[Any]]
+Json = Union[str, int, float, bool, None, Mapping[str, Any], List[Any]]
 QueryParams = Mapping[str, Optional[Iterable[str]]]
 Timeout = Union[int, float, None]
 Verify = Union[bool, str]

src/apiwrappers/utils.py

@@ -13,7 +13,7 @@
     get_type_hints,
 )
 
-from apiwrappers.typedefs import JSON
+from apiwrappers.typedefs import Json
 
 T = TypeVar("T")
 
@@ -24,7 +24,7 @@ def build_url(host: str, path: str) -> str:
     return urllib.parse.urlunsplit((scheme, netloc, path, query, fragment))
 
 
-def getitem(data: JSON, key: Optional[str]) -> JSON:
+def getitem(data: Json, key: Optional[str]) -> Json:
     if not key:
         return data
     parts = key.split(".")
@@ -38,7 +38,7 @@ def getitem(data: JSON, key: Optional[str]) -> JSON:
     return data
 
 
-def fromjson(objtype: Union[Callable[..., T], Type[T]], data: JSON) -> T:
+def fromjson(objtype: Union[Callable[..., T], Type[T]], data: Json) -> T:
     if objtype is Any:
         obj = data
     elif dataclasses.is_dataclass(objtype):
@@ -60,7 +60,7 @@ def _is_generic_type(obj: Any) -> bool:
     return hasattr(obj, "__origin__") and hasattr(obj, "__args__")
 
 
-def _handle_dataclass(objtype: Any, data: JSON) -> Any:
+def _handle_dataclass(objtype: Any, data: Json) -> Any:
     if not isinstance(data, Mapping):
         raise ValueError(f"Expected `Mapping`, got: {type(data)}")
     kwargs = {}
@@ -79,7 +79,7 @@ def _handle_dataclass(objtype: Any, data: JSON) -> Any:
     return objtype(**kwargs)
 
 
-def _handle_namedtuple(objtype: Any, data: JSON) -> Any:
+def _handle_namedtuple(objtype: Any, data: Json) -> Any:
     hints = get_type_hints(objtype)
     field_defaults = objtype._field_defaults  # pylint: disable=protected-access
     if isinstance(data, list):
@@ -97,7 +97,7 @@ def _handle_namedtuple(objtype: Any, data: JSON) -> Any:
     raise ValueError(f"Expected `List` or `Mapping`, got: {type(data)}")
 
 
-def _handle_generic_type(objtype: Any, data: JSON) -> Any:
+def _handle_generic_type(objtype: Any, data: Json) -> Any:
     origin = objtype.__origin__
     args = objtype.__args__
     if origin in (list, set, tuple):

tests/test_drivers/httpbin_client.pyi

@@ -3,7 +3,7 @@ from __future__ import annotations
 from typing import Awaitable, Generic, MutableMapping, Optional, TypeVar, overload
 
 from apiwrappers import AsyncDriver, Driver, Response, Url
-from apiwrappers.typedefs import JSON, Data, Files, QueryParams, Timeout
+from apiwrappers.typedefs import Data, Files, Json, QueryParams, Timeout
 
 T = TypeVar("T", Driver, AsyncDriver)
 
@@ -22,14 +22,14 @@ class HttpBin(Generic[T]):
         self: HttpBin[Driver],
         data: Optional[Data] = None,
         files: Optional[Files] = None,
-        json: Optional[JSON] = None,
+        json: Optional[Json] = None,
     ) -> Response: ...
     @overload
     def post(
         self: HttpBin[AsyncDriver],
         data: Optional[Data] = None,
         files: Optional[Files] = None,
-        json: Optional[JSON] = None,
+        json: Optional[Json] = None,
     ) -> Awaitable[Response]: ...
     @overload
     def headers(