bump: 1.2.0 (#7)

Author: CoderJoshDK

.gitignore

@@ -11,5 +11,4 @@ build/
 *.egg-info
 instructions.txt
 
-asyncTests.py
-tests.py
+*tests.py

README.md

@@ -72,6 +72,16 @@ data = walmart_io.catalog_product(category='3944', maxId='8342714')
 
 A catalog response contains category, format, nextPage, totalPages, and a list of items
 
+The returned API data is paginated. To get the next page, pass in `data.nextPage` as a kwarg.
+All other kwargs will be stripped out. They will be embed in the nextPage response.
+
+```py
+data = walmart_io.catalog_product(category="3944", maxId="8342714")
+next_data = walmart_io.catalog_product(nextPage=data.nextPage)
+# or
+next_data = walmart_io.catalog_product(category="3944", maxId="8342714", nextPage=data.nextPage) 
+```
+
 ### [Post Browsed Products](https://walmart.io/docs/affiliate/post-browsed-products)
 
 The post browsed products API allows you to recommend products to someone based on their product viewing history.

pyproject.toml

@@ -1,11 +1,11 @@
 [project]
 name = "WIOpy"
-version = "1.1.1"
+version = "1.2.0"
 description = "A Python wrapper for the Walmart IO API"
 readme = { file = "README.md", content-type = "text/markdown" }
 license = { file = "LICENSE" }
 authors = [{ name = "CoderJoshDK" }]
-requires-python = ">= 3.8"
+requires-python = ">=3.9"
 dependencies = [
     "requests",
     "pycryptodome",
@@ -26,19 +26,23 @@ classifiers = [
     "Intended Audience :: Developers",
     "Natural Language :: English",
     "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Topic :: Internet",
     "Topic :: Software Development :: Libraries",
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Topic :: Utilities",
     "Typing :: Typed",
 ]
 
-[project.optional-dependencies]
-dev = ["ruff", "pre-commit"]
+[dependency-groups]
+dev = [
+    "basedpyright>=1.24.0",
+    "ruff>=0.9.3",
+]
 
 [project.urls]
 "Homepage" = "https://github.com/CoderJoshDK/WIOpy"
@@ -48,7 +52,7 @@ dev = ["ruff", "pre-commit"]
 [tool.ruff]
 line-length = 100
 fix = true
-target-version = "py38"
+target-version = "py39"
 
 [tool.ruff.lint]
 select = ["E", "F", "B", "W", "Q", "A", "I", "D",
@@ -62,3 +66,17 @@ package = true
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
+
+[tool.basedpyright]
+include = ["wiopy"]
+exclude = [
+    "**/__pycache__",
+    "wiopy/typestubs"
+]
+defineConstant = { DEBUG = true }
+
+reportMissingImports = "error"
+reportMissingTypeStubs = false
+reportAny = false
+reportExplicitAny = false
+reportImplicitStringConcatenation = false

uv.lock

@@ -10,14 +10,15 @@
 import datetime
 import logging
 import time
-from typing import Any, Generator
+from collections.abc import AsyncGenerator, Generator
+from typing import Any, Final
 
 import aiohttp
 from Crypto.Hash import SHA256
 from Crypto.PublicKey import RSA
 from Crypto.Signature import PKCS1_v1_5
 
-from .utils import InvalidRequestException, _get_items_ids, _ttl_cache
+from .utils import InvalidRequestException, get_items_ids, ttl_cache
 from .WalmartResponse import (
     WalmartCatalog,
     WalmartProduct,
@@ -54,7 +55,7 @@ class AsyncWalmartIO:
 
     """
 
-    __slots__ = (
+    __slots__: tuple[str, ...] = (
         "_consumer_id",
         "_private_key",
         "_private_key_version",
@@ -65,7 +66,7 @@ class AsyncWalmartIO:
         "publisherId",
     )
 
-    ENDPOINT = "https://developer.api.walmart.com/api-proxy/service"
+    ENDPOINT: Final[str] = "https://developer.api.walmart.com/api-proxy/service"
 
     def __init__(
         self,
@@ -102,27 +103,29 @@ def __init__(
         The filename will look something like `./WM_IO_private_key.pem`
 
         """
-        self._private_key_version = private_key_version
+        self._private_key_version: Final[str] = private_key_version
 
         # IOError is triggered if the file cannot be opened
         with open(private_key_filename) as f:
-            self._private_key = RSA.importKey(f.read())
+            self._private_key: Final[RSA.RsaKey] = RSA.importKey(f.read())
 
-        self._consumer_id = consumer_id
+        self._consumer_id: Final[str] = consumer_id
 
-        self.headers = {}
+        self.headers: dict[str, str] = {}
         self.headers["WM_CONSUMER.ID"] = consumer_id
         self.headers["WM_SEC.KEY_VERSION"] = private_key_version
 
-        self._update_daily_calls_time = datetime.datetime.now() + datetime.timedelta(days=1)
-        self.daily_calls = daily_calls
-        self.daily_calls_remaining = daily_calls
+        self._update_daily_calls_time: datetime.datetime = (
+            datetime.datetime.now() + datetime.timedelta(days=1)
+        )
+        self.daily_calls: int = daily_calls
+        self.daily_calls_remaining: int = daily_calls
 
-        self.publisherId = publisherId or None
+        self.publisherId: Final[str | None] = publisherId or None
 
         log.info(f"Walmart IO connection with consumer id ending in {consumer_id[-6:]}")
 
-    async def catalog_product(self, **kwargs) -> WalmartCatalog:
+    async def catalog_product(self, **kwargs: str | int | bool) -> WalmartCatalog:
         """
         Catalog Product Endpoint.
 
@@ -165,13 +168,15 @@ async def catalog_product(self, **kwargs) -> WalmartCatalog:
         https://www.walmart.io/docs/affiliate/catalog-product
 
         """
-        if "nextPage" in kwargs:
-            url = "https://developer.api.walmart.com" + kwargs.pop("nextPage")
-        else:
-            url = self.ENDPOINT + "/affil/product/v2/paginated/items"
+        if next_page := kwargs.pop("nextPage", ""):
+            assert isinstance(next_page, str), ValueError(
+                "Expected type string for kwarg 'nextPage'"
+            )
+            url = "https://developer.api.walmart.com" + next_page
+            return WalmartCatalog(await self._send_request(url))
 
-        response = await self._send_request(url, **kwargs)
-        return WalmartCatalog(response)
+        url = self.ENDPOINT + "/affil/product/v2/paginated/items"
+        return WalmartCatalog(await self._send_request(url, **kwargs))
 
     async def post_browsed_products(self, itemId: str) -> list[WalmartProduct]:
         """
@@ -208,10 +213,10 @@ async def post_browsed_products(self, itemId: str) -> list[WalmartProduct]:
 
         """
         url = f"{self.ENDPOINT}/affil/product/v2/postbrowse?itemId={itemId}"
-        response = await self._send_request(url)
+        response: list[dict[str, Any]] = await self._send_request(url)
         return [WalmartProduct(item) for item in response]
 
-    async def product_lookup(self, ids: str | list[str], **kwargs) -> list[WalmartProduct]:
+    async def product_lookup(self, ids: str | list[str], **kwargs: str) -> list[WalmartProduct]:
         """
         Walmart product lookup.
 
@@ -244,13 +249,13 @@ async def product_lookup(self, ids: str | list[str], **kwargs) -> list[WalmartPr
         url = self.ENDPOINT + "/affil/product/v2/items"
 
         params = kwargs
-        ids = _get_items_ids(ids)
+        ids = get_items_ids(ids)
         if len(ids) > 200:
             log.debug(
                 "For large id lists, try using bulk_product_lookup. "
-                "It will continue to run even if one chunk of ids raise an error"
+                "It will continue to run even if one chunk of ids raise an error",
             )
-        products = []
+        products: list[WalmartProduct] = []
 
         for idGroup in self._get_product_id_chunk(list(set(ids)), 20):
             params["ids"] = idGroup
@@ -261,8 +266,12 @@ async def product_lookup(self, ids: str | list[str], **kwargs) -> list[WalmartPr
         return products
 
     async def bulk_product_lookup(
-        self, ids: str | list[str], amount: int = 20, retries: int = 1, **kwargs
-    ):
+        self,
+        ids: str | list[str],
+        amount: int = 20,
+        retries: int = 1,
+        **kwargs: str,
+    ) -> AsyncGenerator[list[WalmartProduct]]:
         """
         Walmart product lookup for a bulk of products.
 
@@ -286,8 +295,6 @@ async def bulk_product_lookup(
                 Your Impact Radius Advertisement Id
              campaignId:
                 Your Impact Radius Campaign Id
-             format:
-                Type of response required, allowed values [json, xml(deprecated)]. Default is json.
              upc:
                 upc of the item
 
@@ -308,7 +315,7 @@ async def bulk_product_lookup(
         url = self.ENDPOINT + "/affil/product/v2/items"
 
         params = kwargs
-        ids = _get_items_ids(ids)
+        ids = get_items_ids(ids)
 
         # Clamp amount [1, 20]
         amount = min(max(1, amount), 20)
@@ -367,7 +374,7 @@ async def product_recommendation(self, itemId: str) -> list[WalmartProduct]:
         response = await self._send_request(url)
         return [WalmartProduct(item) for item in response]
 
-    async def reviews(self, itemId: str, **kwargs) -> WalmartReviewResponse:
+    async def reviews(self, itemId: str, **kwargs: str) -> WalmartReviewResponse:
         """
         Reviews Endpoint.
 
@@ -405,7 +412,7 @@ async def reviews(self, itemId: str, **kwargs) -> WalmartReviewResponse:
         response = await self._send_request(url, **kwargs)
         return WalmartReviewResponse(response)
 
-    async def search(self, query: str, **kwargs) -> WalmartSearch:
+    async def search(self, query: str, **kwargs: str | int) -> WalmartSearch:
         """
         Search Endpoint.
 
@@ -482,7 +489,7 @@ async def search(self, query: str, **kwargs) -> WalmartSearch:
         response = await self._send_request(url, **kwargs)
         return WalmartSearch(response)
 
-    async def stores(self, **kwargs) -> list[WalmartStore]:
+    async def stores(self, **kwargs: float) -> list[WalmartStore]:
         """
         Store Locator Endpoint.
 
@@ -508,7 +515,7 @@ async def stores(self, **kwargs) -> list[WalmartStore]:
         response = await self._send_request(url, **kwargs)
         return [WalmartStore(store) for store in response]
 
-    async def taxonomy(self, **kwargs) -> WalmartTaxonomy:
+    async def taxonomy(self) -> WalmartTaxonomy:
         """
         Taxonomy Endpoint.
 
@@ -524,16 +531,11 @@ async def taxonomy(self, **kwargs) -> WalmartTaxonomy:
         For example, Search API can be restricted to search within a category by supplying id as
         per the taxonomy.
 
-        Parameters
-        ----------
-        **kwargs
-            unknown; WalmartIO documentation does not expose what the acceptable
-
         """
         url = self.ENDPOINT + "/affil/product/v2/taxonomy"
-        return WalmartTaxonomy(await self._send_request(url, **kwargs))
+        return WalmartTaxonomy(await self._send_request(url))
 
-    async def trending(self, publisherId=None) -> list[WalmartProduct]:
+    async def trending(self, publisherId: str | None = None) -> list[WalmartProduct]:
         """
         Trending Items Endpoint.
 
@@ -557,13 +559,13 @@ async def trending(self, publisherId=None) -> list[WalmartProduct]:
         url = self.ENDPOINT + "/affil/product/v2/trends"
 
         if publisherId:
-            response = await self._send_request(url, publisherId=publisherId)
+            response: dict[str, Any] = await self._send_request(url, publisherId=publisherId)
         else:
             response = await self._send_request(url)
         return [WalmartProduct(item) for item in response["items"]]
 
-    @_ttl_cache(maxsize=2, ttl=170)
-    def _get_headers(self) -> dict:
+    @ttl_cache(maxsize=2, ttl=170)
+    def _get_headers(self) -> dict[str, str]:
         """
         Get the headers required for making an API call.
 
@@ -609,7 +611,7 @@ def _get_headers(self) -> dict:
 
         return self.headers
 
-    async def _send_request(self, url, **kwargs) -> Any:
+    async def _send_request(self, url: str, **kwargs: str | int | float | bool) -> Any:
         """
         Send a request to the Walmart API and return the HTTP response.
 
@@ -637,13 +639,13 @@ async def _send_request(self, url, **kwargs) -> Any:
         log.debug(f"Making connection to {url}")
 
         # Avoid format to be changed, always go for json
-        kwargs.pop("format", None)
+        _ = kwargs.pop("format", None)
         request_params = kwargs
 
         # Convert from native boolean python type to string 'true' or 'false'. This allows to set
         # richAttributes with python boolean types
         if "richAttributes" in request_params and isinstance(
-            request_params["richAttributes"], bool
+            request_params.get("richAttributes"), bool
         ):
             if request_params["richAttributes"]:
                 request_params["richAttributes"] = "true"
@@ -661,16 +663,17 @@ async def _send_request(self, url, **kwargs) -> Any:
                 "Too many calls in one day. If this is incorrect, try increasing `daily_calls`"
             )
 
-        async with aiohttp.ClientSession() as session, session.get(
-            url, headers=self._get_headers(), params=request_params
-        ) as response:
+        async with (
+            aiohttp.ClientSession() as session,
+            session.get(url, headers=self._get_headers(), params=request_params) as response,
+        ):
             status_code = response.status
             if status_code in (200, 201):
                 return await response.json()
 
             if status_code == 400:
                 # Send exception detail when it is a 400 bad error
-                jsonData = await response.json()
+                jsonData: dict[str, Any] = await response.json()
                 raise InvalidRequestException(status_code, detail=jsonData["errors"][0]["message"])
             raise InvalidRequestException(status_code)