novaposhta-python-client 0.1.5__tar.gz → 0.1.7__tar.gz

{novaposhta_python_client-0.1.5 → novaposhta_python_client-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: novaposhta-python-client
-Version: 0.1.5
+Version: 0.1.7
 Summary: Python client for Nova Poshta API
 Home-page: https://github.com/semolex/novaposhta-python-client
 License: MIT
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Software Development :: Build Tools
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
@@ -63,7 +64,9 @@ return_reason = client.additional_service.get_return_reasons()
 
 # Print results
 print(settlements, my_pack_list, return_reason)
+client.close_sync()
 ```
+Please, close the client whenever you are done with it to avoid resource leaks.
 
 You can also use async client:
 
@@ -71,10 +74,28 @@ You can also use async client:
 import asyncio
 from novaposhta.client import NovaPoshtaApi
 
-async_client = NovaPoshtaApi('my-api-token', timeout=30, async_mode=True)
-a_address = async_client.address
-a_settlement = asyncio.run(a_address.search_settlements(city_name='Київ', limit=5))
-print(a_settlement)
+async def use_api_async():
+    async_client = NovaPoshtaApi('your_api_key', timeout=30, async_mode=True, raise_for_errors=True)
+    address = async_client.address
+    settlements = await address.search_settlements(city_name='Київ', limit=5)
+    print(settlements)
+    await async_client.close_async()
+asyncio.run(use_api_async())
+```
+
+You can use context manager to automatically close the client:
+
+```python
+from novaposhta.client import NovaPoshtaApi
+def use_api_sync():
+    with NovaPoshtaApi(api_key='your_api_key', async_mode=False) as api:
+        # Do something with the API
+        pass
+
+async def use_api_async():
+    async with NovaPoshtaApi(api_key='your_api_key', async_mode=True) as api:
+        # Do something with the API
+        pass
 ```
 
 ## Error handling
@@ -84,7 +105,7 @@ import httpx
 from novaposhta.client import NovaPoshtaApi, InvalidAPIKeyError, APIRequestError
 
 # Instantiate the client
-client = NovaPoshtaApi('my-api-token', timeout=30, raise_for_errors=True)
+client = NovaPoshtaApi('your_api_key', timeout=30, raise_for_errors=True)
 
 try:
     client.common.get_cargo_types()
@@ -107,16 +128,7 @@ follows the same interface:
 from novaposhta.client import NovaPoshtaApi
 import my_http_client
 
-client = NovaPoshtaApi('my-api-token', http_client=my_http_client.Client)
-```
-
-Custom client should support context manager, e.g:
-
-```python
-with self.http_client() as client:
-    response = client.post(
-        self.api_endpoint, json=request, headers=HEADERS, timeout=self.timeout
-    )
+client = NovaPoshtaApi('your_api_key', http_client=my_http_client.Client)
 ```
 
 ### Adding New Methods

{novaposhta_python_client-0.1.5 → novaposhta_python_client-0.1.7}/README.md

@@ -39,7 +39,9 @@ return_reason = client.additional_service.get_return_reasons()
 
 # Print results
 print(settlements, my_pack_list, return_reason)
+client.close_sync()
 ```
+Please, close the client whenever you are done with it to avoid resource leaks.
 
 You can also use async client:
 
@@ -47,10 +49,28 @@ You can also use async client:
 import asyncio
 from novaposhta.client import NovaPoshtaApi
 
-async_client = NovaPoshtaApi('my-api-token', timeout=30, async_mode=True)
-a_address = async_client.address
-a_settlement = asyncio.run(a_address.search_settlements(city_name='Київ', limit=5))
-print(a_settlement)
+async def use_api_async():
+    async_client = NovaPoshtaApi('your_api_key', timeout=30, async_mode=True, raise_for_errors=True)
+    address = async_client.address
+    settlements = await address.search_settlements(city_name='Київ', limit=5)
+    print(settlements)
+    await async_client.close_async()
+asyncio.run(use_api_async())
+```
+
+You can use context manager to automatically close the client:
+
+```python
+from novaposhta.client import NovaPoshtaApi
+def use_api_sync():
+    with NovaPoshtaApi(api_key='your_api_key', async_mode=False) as api:
+        # Do something with the API
+        pass
+
+async def use_api_async():
+    async with NovaPoshtaApi(api_key='your_api_key', async_mode=True) as api:
+        # Do something with the API
+        pass
 ```
 
 ## Error handling
@@ -60,7 +80,7 @@ import httpx
 from novaposhta.client import NovaPoshtaApi, InvalidAPIKeyError, APIRequestError
 
 # Instantiate the client
-client = NovaPoshtaApi('my-api-token', timeout=30, raise_for_errors=True)
+client = NovaPoshtaApi('your_api_key', timeout=30, raise_for_errors=True)
 
 try:
     client.common.get_cargo_types()
@@ -83,16 +103,7 @@ follows the same interface:
 from novaposhta.client import NovaPoshtaApi
 import my_http_client
 
-client = NovaPoshtaApi('my-api-token', http_client=my_http_client.Client)
-```
-
-Custom client should support context manager, e.g:
-
-```python
-with self.http_client() as client:
-    response = client.post(
-        self.api_endpoint, json=request, headers=HEADERS, timeout=self.timeout
-    )
+client = NovaPoshtaApi('your_api_key', http_client=my_http_client.Client)
 ```
 
 ### Adding New Methods

{novaposhta_python_client-0.1.5 → novaposhta_python_client-0.1.7}/novaposhta/client.py

@@ -1,20 +1,20 @@
 """Client for Nova Poshta API. """
 
+from typing import Type, TypeVar, Optional, Callable
+
 import httpx
 
-from .models.base import BaseModel
+from .models.additional_service import AdditionalService
 from .models.address import Address
-from .models.counterparty import Counterparty
-from .models.contact_person import ContactPerson
-from .models.scan_sheet import ScanSheet
+from .models.base import BaseModel
 from .models.common import Common
-from .models.additional_service import AdditionalService
+from .models.contact_person import ContactPerson
+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 typing import Type, TypeVar, Union
-
 HEADERS = {"Content-Type": "application/json"}
 
 BaseModelType = TypeVar("BaseModelType", bound=BaseModel)
@@ -29,14 +29,17 @@ class NovaPoshtaApi:
     https://developers.novaposhta.ua/documentation
     """
 
+    sync_http_client: Optional[httpx.Client] = None
+    async_http_client: Optional[httpx.AsyncClient] = None
+
     def __init__(
         self,
-        api_key,
-        api_endpoint="https://api.novaposhta.ua/v2.0/json/",
+        api_key: str,
+        api_endpoint: str = "https://api.novaposhta.ua/v2.0/json/",
         http_client=httpx,
-        timeout=10,
-        raise_for_errors=False,
-        async_mode=False,
+        timeout: int = 10,
+        raise_for_errors: bool = False,
+        async_mode: bool = False,
     ):
         """
         Initialize Nova Poshta API client.
@@ -50,19 +53,21 @@ class NovaPoshtaApi:
         """
         self.api_key = api_key
         self.api_endpoint = api_endpoint
-        self.http_client = (
-            http_client.Client if not async_mode else http_client.AsyncClient
-        )
         self.timeout = timeout
-        self.raise_for_errors = raise_for_errors
-        self.async_mode = async_mode
-        self._models_pool = {}
-
-        if self.async_mode:
+        self._send: Callable[[DictStrAny], MaybeAsync]
+        if async_mode:
+            self.async_http_client: Optional[httpx.AsyncClient] = (
+                http_client.AsyncClient(timeout=timeout)
+            )
             self._send = self._send_async
-
         else:
+            self.sync_http_client: Optional[httpx.Client] = http_client.Client(
+                timeout=timeout
+            )
             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:
         """
@@ -71,9 +76,9 @@ class NovaPoshtaApi:
         :param request: request dict.
         :return: response dict.
         """
-
-        with self.http_client() as client:
-            response = client.post(**request)
+        if not self.sync_http_client:
+            raise ValueError("Sync client is not initialized")
+        response = self.sync_http_client.post(**request)
         return self._maybe_check_errors(response.json())
 
     async def _send_async(self, request: DictStrAny) -> DictStrAny:
@@ -83,8 +88,9 @@ class NovaPoshtaApi:
         :param request: request dict.
         :return: response dict.
         """
-        async with self.http_client() as client:
-            response = await client.post(**request)
+        if not self.async_http_client:
+            raise ValueError("Async client is not initialized")
+        response: httpx.Response = await self.async_http_client.post(**request)
         return self._maybe_check_errors(response.json())
 
     def send(
@@ -127,7 +133,7 @@ class NovaPoshtaApi:
         self._models_pool[model.name] = model(self)
         return self._models_pool[model.name]
 
-    def get(self, name: str) -> Union[BaseModelType, None]:
+    def get(self, name: str) -> Optional[BaseModel]:
         """
         Get model from the pool.
 
@@ -135,7 +141,13 @@ class NovaPoshtaApi:
         """
         return self._models_pool.get(name)
 
-    def _maybe_check_errors(self, response):
+    def _maybe_check_errors(self, response: DictStrAny) -> DictStrAny:
+        """
+        Check response for errors.
+
+        :param response: response dict.
+        :return: response dict.
+        """
         if not self.raise_for_errors:
             return response
 
@@ -148,6 +160,45 @@ class NovaPoshtaApi:
         else:
             raise APIRequestError(error)
 
+    def close_sync(self):
+        """
+        Close sync client.
+        """
+        if self.sync_http_client:
+            self.sync_http_client.close()
+
+    async def close_async(self):
+        """
+        Close async client.
+        """
+        if self.async_http_client:
+            await self.async_http_client.aclose()
+
+    def __enter__(self):
+        """
+        Enter the context.
+        """
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """
+        Exit the context.
+        Close the client.
+        """
+        self.close_sync()
+
+    async def __aenter__(self):
+        """
+        Enter the async context.
+        """
+        return self
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb):
+        """
+        Exit the async context.
+        """
+        await self.close_async()
+
     @property
     def address(self) -> Address:
         """

{novaposhta_python_client-0.1.5 → novaposhta_python_client-0.1.7}/pyproject.toml

@@ -3,7 +3,7 @@ name = "novaposhta-python-client"
 packages = [
     { include = "novaposhta"}
 ]
-version = "0.1.5"
+version = "0.1.7"
 description = "Python client for Nova Poshta API"
 authors = ["Oleksii <semolex@live.com>"]
 license = "MIT"
@@ -28,10 +28,7 @@ httpx = ">=0.24.0"
 
 [tool.poetry.group.dev.dependencies]
 mypy = "^1.5.1"
-black = "^23.9.1"
-sphinx = "^7.2.6"
-myst-parser = "^2.0.0"
-sphinx-rtd-theme = "^1.3.0"
+black = "^24"
 pytest = "^7.4.2"
 pytest-httpx = "^0.26.0"
 coverage = "^7.3.2"