novaposhta-python-client 0.1.9__tar.gz → 0.1.10__tar.gz

{novaposhta_python_client-0.1.9 → novaposhta_python_client-0.1.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: novaposhta-python-client
-Version: 0.1.9
+Version: 0.1.10
 Summary: Python client for Nova Poshta API
 Home-page: https://github.com/semolex/novaposhta-python-client
 License: MIT
@@ -164,7 +164,8 @@ my_custom_model = client.get(MyCustomModel.name)
 ## Testing and linting
 
 ```bash
-poetry run black novaposhta
+poetry run black novaposhta/
+poetry run isort novaposhta/
 poetry run mypy novaposhta/
 poetry run pytest tests/
 ```
@@ -173,5 +174,5 @@ poetry run pytest tests/
 
 We welcome contributions that can help in enhancing the functionality and improving the consistency of the client. For
 bugs or feature requests, please open an issue on the GitHub repository.
-Please, use `black` and `mypy` as your instrument for code formatting and type checking.
+Please, use `black`, `isort` and `mypy` as your instrument for code formatting and type checking.
 

{novaposhta_python_client-0.1.9 → novaposhta_python_client-0.1.10}/README.md

@@ -139,7 +139,8 @@ my_custom_model = client.get(MyCustomModel.name)
 ## Testing and linting
 
 ```bash
-poetry run black novaposhta
+poetry run black novaposhta/
+poetry run isort novaposhta/
 poetry run mypy novaposhta/
 poetry run pytest tests/
 ```
@@ -148,4 +149,4 @@ poetry run pytest tests/
 
 We welcome contributions that can help in enhancing the functionality and improving the consistency of the client. For
 bugs or feature requests, please open an issue on the GitHub repository.
-Please, use `black` and `mypy` as your instrument for code formatting and type checking.
+Please, use `black`, `isort` and `mypy` as your instrument for code formatting and type checking.

{novaposhta_python_client-0.1.9 → novaposhta_python_client-0.1.10}/novaposhta/client.py

@@ -1,6 +1,6 @@
 """Client for Nova Poshta API. """
 
-from typing import Type, TypeVar, Optional, Callable
+from typing import Callable, Final, Optional, Type, TypeVar
 
 import httpx
 
@@ -13,9 +13,11 @@ from .models.counterparty import Counterparty
 from .models.internet_document import InternetDocument
 from .models.scan_sheet import ScanSheet
 from .models.tracking_document import TrackingDocument
-from .types import DictStrAny, MaybeAsync
+from .types import DictStrAny, HttpRequest, MaybeAsync, RequestData, RequestSender
 
-HEADERS = {"Content-Type": "application/json"}
+HEADERS: Final[dict[str, str]] = {"Content-Type": "application/json"}
+API_DEFAULT_ENDPOINT: Final[str] = "https://api.novaposhta.ua/v2.0/json/"
+DEFAULT_TIMEOUT: Final[int] = 10
 
 BaseModelType = TypeVar("BaseModelType", bound=BaseModel)
 
@@ -35,7 +37,7 @@ class NovaPoshtaApi:
     def __init__(
         self,
         api_key: str,
-        api_endpoint: str = "https://api.novaposhta.ua/v2.0/json/",
+        api_endpoint: str = API_DEFAULT_ENDPOINT,
         http_client=httpx,
         timeout: int = 10,
         raise_for_errors: bool = False,
@@ -51,10 +53,17 @@ class NovaPoshtaApi:
         :param raise_for_errors: Whether to check and raise errors as exceptions.
         :param async_mode: Whether to use async mode.
         """
+        if not api_key:
+            raise ValueError("API key is required")
+        if timeout <= 0:
+            raise ValueError("Timeout must be positive")
+        if not api_endpoint or not api_endpoint.startswith(("http://", "https://")):
+            raise ValueError("Invalid API endpoint URL")
+
         self.api_key = api_key
         self.api_endpoint = api_endpoint
         self.timeout = timeout
-        self._send: Callable[[DictStrAny], MaybeAsync]
+        self._send: RequestSender
         if async_mode:
             self.async_http_client: Optional[httpx.AsyncClient] = (
                 http_client.AsyncClient(timeout=timeout)
@@ -65,11 +74,12 @@ class NovaPoshtaApi:
                 timeout=timeout
             )
             self._send = self._send_sync
+            self._send = self._send_sync
         self.raise_for_errors = raise_for_errors
         self.async_mode = async_mode
         self._models_pool: DictStrAny = {}
 
-    def _send_sync(self, request: DictStrAny) -> DictStrAny:
+    def _send_sync(self, request: HttpRequest) -> DictStrAny:
         """
         Sends sync request to the API.
 
@@ -81,7 +91,7 @@ class NovaPoshtaApi:
         response = self.sync_http_client.post(**request)
         return self._maybe_check_errors(response.json())
 
-    async def _send_async(self, request: DictStrAny) -> DictStrAny:
+    async def _send_async(self, request: HttpRequest) -> DictStrAny:
         """
         Sends async request to the API.
 
@@ -104,13 +114,13 @@ class NovaPoshtaApi:
         :param method_props: properties to pass to the method.
         :return: response dict.
         """
-        data = {
+        data: RequestData = {
             "apiKey": self.api_key,
             "modelName": model_name,
             "calledMethod": api_method,
             "methodProperties": method_props,
         }
-        request = {
+        request: HttpRequest = {
             "url": self.api_endpoint,
             "headers": HEADERS,
             "json": data,
@@ -147,23 +157,29 @@ class NovaPoshtaApi:
 
         :param response: response dict.
         :return: response dict.
+        :raises InvalidAPIKeyError: if API key is invalid
+        :raises APIRequestError: if any other API error occurs
         """
         if not self.raise_for_errors:
             return response
 
         if response["success"]:
             return response
+
         errors = response["errors"]
-        error = ""
-        if isinstance(errors, list):
-            error = ", ".join(errors)
-        elif isinstance(errors, dict):
-            error = ", ".join([f"{k}: {v}" for k, v in errors.items()])
-
-        if "API key" in error:
-            raise InvalidAPIKeyError(error)
-        else:
-            raise APIRequestError(error)
+        error_msg = (
+            ", ".join(errors)
+            if isinstance(errors, list)
+            else (
+                ", ".join(f"{k}: {v}" for k, v in errors.items())
+                if isinstance(errors, dict)
+                else str(errors)
+            )
+        )
+
+        if "API key" in error_msg:
+            raise InvalidAPIKeyError(error_msg)
+        raise APIRequestError(error_msg)
 
     def close_sync(self):
         """

{novaposhta_python_client-0.1.9 → novaposhta_python_client-0.1.10}/novaposhta/models/additional_service.py

@@ -1,8 +1,7 @@
 """AdditionalService model module."""
 
-from .base import BaseModel, api_method
-
 from ..types import OptStr, StrOrNum
+from .base import BaseModel, api_method
 
 
 class AdditionalService(BaseModel):

{novaposhta_python_client-0.1.9 → novaposhta_python_client-0.1.10}/novaposhta/models/address.py

@@ -1,9 +1,8 @@
 """Address model module."""
 
+from ..types import OptBool, OptStr
 from .base import BaseModel, api_method
 
-from ..types import OptStr, OptBool
-
 
 class Address(BaseModel):
     """

{novaposhta_python_client-0.1.9 → novaposhta_python_client-0.1.10}/novaposhta/models/common.py

@@ -1,9 +1,8 @@
 """Common model module."""
 
+from ..types import OptInt, OptStr
 from .base import BaseModel, api_method
 
-from ..types import OptStr, OptInt
-
 
 class Common(BaseModel):
     """

{novaposhta_python_client-0.1.9 → novaposhta_python_client-0.1.10}/novaposhta/models/counterparty.py

@@ -1,8 +1,7 @@
 """Counterparty model module."""
 
-from .base import BaseModel, api_method
-
 from ..types import OptStr
+from .base import BaseModel, api_method
 
 
 class Counterparty(BaseModel):

{novaposhta_python_client-0.1.9 → novaposhta_python_client-0.1.10}/novaposhta/models/internet_document.py

@@ -2,15 +2,8 @@
 
 from typing import List
 
+from ..types import OptDict, OptInt, OptListOfDicts, OptStr, OptStrOrNum, StrOrNum
 from .base import BaseModel, api_method
-from ..types import (
-    OptStr,
-    StrOrNum,
-    OptListOfDicts,
-    OptDict,
-    OptInt,
-    OptStrOrNum,
-)
 
 
 class InternetDocument(BaseModel):

{novaposhta_python_client-0.1.9 → novaposhta_python_client-0.1.10}/novaposhta/models/scan_sheet.py

@@ -1,8 +1,9 @@
 """ScanSheet model module."""
 
-from .base import BaseModel, api_method
 from typing import List
 
+from .base import BaseModel, api_method
+
 
 class ScanSheet(BaseModel):
     """

{novaposhta_python_client-0.1.9 → novaposhta_python_client-0.1.10}/novaposhta/models/tracking_document.py

@@ -1,8 +1,8 @@
 """TrackingDocument model module."""
 
-from .base import BaseModel, api_method
+from typing import Dict, List
 
-from typing import List, Dict
+from .base import BaseModel, api_method
 
 
 class TrackingDocument(BaseModel):

novaposhta_python_client-0.1.10/novaposhta/types.py

@@ -0,0 +1,39 @@
+"""Type aliases for novaposhta package."""
+
+from typing import Any, Callable, Coroutine, Dict, List, Optional, TypedDict, Union
+
+
+class RequestData(TypedDict):
+    """
+    Request data for Nova Poshta API.
+    """
+    apiKey: str
+    modelName: str
+    calledMethod: str
+    methodProperties: Dict[str, Any]
+
+
+class HttpRequest(TypedDict):
+    """
+    Request data for HTTP client.
+    """
+    url: str
+    headers: Dict[str, str]
+    json: RequestData
+    timeout: int
+
+
+OptStr = Optional[str]
+StrOrNum = Union[str, float, int]
+DictStrAny = Dict[str, Any]
+MaybeAsync = Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
+SyncSender = Callable[[HttpRequest], Dict[str, Any]]
+AsyncSender = Callable[[HttpRequest], Coroutine[Any, Any, Dict[str, Any]]]
+RequestSender = Union[SyncSender, AsyncSender]
+OptStrOrNum = Optional[StrOrNum]
+OptDict = Optional[Dict[str, str]]
+OptListOfDicts = Optional[List[Dict[str, Any]]]
+OptInt = Optional[int]
+OptBool = Optional[
+    Union[bool, int]
+]  # assume that support for cases: 0 is False, 1 is True

{novaposhta_python_client-0.1.9 → novaposhta_python_client-0.1.10}/pyproject.toml

@@ -3,7 +3,7 @@ name = "novaposhta-python-client"
 packages = [
     { include = "novaposhta"}
 ]
-version = "0.1.9"
+version = "0.1.10"
 description = "Python client for Nova Poshta API"
 authors = ["Oleksii <semolex@live.com>"]
 license = "MIT"
@@ -33,6 +33,7 @@ pytest = "^7.4.2"
 pytest-httpx = "^0.26.0"
 coverage = "^7.3.2"
 pytest-asyncio = "^0.21.1"
+isort = "^5.13.2"
 
 [build-system]
 requires = ["poetry-core"]

novaposhta_python_client-0.1.9/novaposhta/types.py

@@ -1,15 +0,0 @@
-"""Type aliases for novaposhta package."""
-
-from typing import List, Optional, Dict, Union, Any, Coroutine
-
-OptStr = Optional[str]
-StrOrNum = Union[str, float, int]
-DictStrAny = Dict[str, Any]
-MaybeAsync = Union[DictStrAny, Coroutine[Any, Any, Any]]
-OptStrOrNum = Optional[StrOrNum]
-OptDict = Optional[Dict[str, str]]
-OptListOfDicts = Optional[List[Dict[str, Any]]]
-OptInt = Optional[int]
-OptBool = Optional[
-    Union[bool, int]
-]  # assume that support for cases: 0 is False, 1 is True