novaposhta-python-client 0.1.1__tar.gz → 0.1.2__tar.gz

{novaposhta_python_client-0.1.1 → novaposhta_python_client-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: novaposhta-python-client
-Version: 0.1.1
+Version: 0.1.2
 Summary: Python client for Nova Poshta API
 Home-page: https://github.com/semolex/novaposhta-python-client
 License: MIT
@@ -65,6 +65,25 @@ return_reason = client.additional_service.get_return_reasons()
 print(settlements, my_pack_list, return_reason)
 ```
 
+## Error handling
+
+```python
+import httpx
+from novaposhta.client import NovaPoshtaApi, InvalidAPIKeyError, APIRequestError
+
+# Instantiate the client
+client = NovaPoshtaApi('my-api-token', timeout=30, raise_for_errors=True)
+
+try:
+    client.common.get_cargo_types()
+except httpx.HTTPError as error:
+    print(f"HTTP error: {error}")
+except InvalidAPIKeyError as error:
+    print(f"API key expired or otherwise invalid: {error}")
+except APIRequestError as error:
+    print(f"Something else is wrong with API request: {error}")
+```
+
 ## Extending the Client
 
 ### Custom HTTP Client

{novaposhta_python_client-0.1.1 → novaposhta_python_client-0.1.2}/README.md

@@ -41,6 +41,25 @@ return_reason = client.additional_service.get_return_reasons()
 print(settlements, my_pack_list, return_reason)
 ```
 
+## Error handling
+
+```python
+import httpx
+from novaposhta.client import NovaPoshtaApi, InvalidAPIKeyError, APIRequestError
+
+# Instantiate the client
+client = NovaPoshtaApi('my-api-token', timeout=30, raise_for_errors=True)
+
+try:
+    client.common.get_cargo_types()
+except httpx.HTTPError as error:
+    print(f"HTTP error: {error}")
+except InvalidAPIKeyError as error:
+    print(f"API key expired or otherwise invalid: {error}")
+except APIRequestError as error:
+    print(f"Something else is wrong with API request: {error}")
+```
+
 ## Extending the Client
 
 ### Custom HTTP Client

{novaposhta_python_client-0.1.1 → novaposhta_python_client-0.1.2}/novaposhta/client.py

@@ -35,6 +35,7 @@ class NovaPoshtaApi:
         api_endpoint="https://api.novaposhta.ua/v2.0/json/",
         http_client=httpx,
         timeout=10,
+        raise_for_errors=False,
     ):
         """
         Initialize Nova Poshta API client.
@@ -43,11 +44,13 @@ class NovaPoshtaApi:
         :param api_endpoint: API endpoint to use.
         :param http_client: HTTP client to use. Defaults to httpx.
         :param timeout: Timeout for HTTP requests.
+        :param raise_for_errors: Whether to check and raise errors as exceptions.
         """
         self.api_key = api_key
         self.api_endpoint = api_endpoint
         self.http_client = http_client.Client
         self.timeout = timeout
+        self.raise_for_errors = raise_for_errors
         self._models_pool = {}
 
     def send(
@@ -71,7 +74,7 @@ class NovaPoshtaApi:
             response = client.post(
                 self.api_endpoint, json=request, headers=HEADERS, timeout=self.timeout
             )
-        return response.json()
+        return self._maybe_check_errors(response.json())
 
     def new(self, model: Type[BaseModelType]) -> BaseModelType:
         """
@@ -96,6 +99,19 @@ class NovaPoshtaApi:
         """
         return self._models_pool.get(name)
 
+    def _maybe_check_errors(self, response):
+        if not self.raise_for_errors:
+            return response
+
+        if response["success"]:
+            return response
+
+        error = response["errors"][0]
+        if error.startswith("API key"):
+            raise InvalidAPIKeyError(error)
+        else:
+            raise APIRequestError(error)
+
     @property
     def address(self) -> Address:
         """
@@ -151,3 +167,15 @@ class NovaPoshtaApi:
         Provide access to the TrackingDocument model.
         """
         return self.new(TrackingDocument)
+
+
+class NovaPoshtaError(Exception):
+    """General Nova Poshta exception."""
+
+
+class InvalidAPIKeyError(NovaPoshtaError):
+    """Invalid API key exception."""
+
+
+class APIRequestError(NovaPoshtaError):
+    """Invalid API request exception."""

{novaposhta_python_client-0.1.1 → novaposhta_python_client-0.1.2}/pyproject.toml

@@ -3,7 +3,7 @@ name = "novaposhta-python-client"
 packages = [
     { include = "novaposhta"}
 ]
-version = "0.1.1"
+version = "0.1.2"
 description = "Python client for Nova Poshta API"
 authors = ["Oleksii <semolex@live.com>"]
 license = "MIT"