chore: update ruff version and formatting

Author: CoderJoshDK

pyproject.toml

@@ -1,7 +1,3 @@
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
 [project]
 name = "WIOpy"
 version = "1.1.0"
@@ -50,9 +46,12 @@ line-length = 100
 fix = true
 target-version = "py38"
 
-unfixable = ["F841"]
-ignore = ["PLR0913", "ISC001", "PLR2004"]
-
 [tool.ruff.lint]
 select = ["E", "F", "B", "W", "Q", "A", "I", "D",
     "UP", "ASYNC", "FA", "ISC", "RET", "SIM", "ARG", "PL", "RUF"]
+ignore = ["PLR0913", "ISC001", "PLR2004", "D203", "D212"]
+unfixable = ["F841"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

uv.lock

@@ -1,7 +1,9 @@
-"""Walmart IO Async API.
+"""
+Walmart IO Async API.
 
 Please read the Walmart Docs for up to date list of endpoints and parameters
 """
+
 from __future__ import annotations
 
 import base64
@@ -33,7 +35,8 @@
 
 
 class AsyncWalmartIO:
-    """The main Walmart IO API interface.
+    """
+    The main Walmart IO API interface.
 
     Optional:
     -------
@@ -48,16 +51,17 @@ class AsyncWalmartIO:
     ...         private_key_filename='./WM_IO_private_key.pem',
     ...         consumer_id='XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
     ...     )
+
     """
 
     __slots__ = (
-        "_private_key_version",
-        "_private_key",
         "_consumer_id",
-        "headers",
+        "_private_key",
+        "_private_key_version",
         "_update_daily_calls_time",
         "daily_calls",
         "daily_calls_remaining",
+        "headers",
         "publisherId",
     )
 
@@ -72,7 +76,8 @@ def __init__(
         daily_calls: int = 5000,
         publisherId: str | None = None,
     ) -> None:
-        """WalmartIO API Connection.
+        """
+        WalmartIO API Connection.
 
         Parameters
         ----------
@@ -95,6 +100,7 @@ def __init__(
         -----
         To Generate the public and private key (https://walmart.io/key-tutorial).
         The filename will look something like `./WM_IO_private_key.pem`
+
         """
         self._private_key_version = private_key_version
 
@@ -117,7 +123,8 @@ def __init__(
         log.info(f"Walmart IO connection with consumer id ending in {consumer_id[-6:]}")
 
     async def catalog_product(self, **kwargs) -> WalmartCatalog:
-        """Catalog Product Endpoint.
+        """
+        Catalog Product Endpoint.
 
         Allows a developer to retrieve the products catalog in a paginated fashion.
         Catalog can be filtered by category, brand and/or any special offers like rollback,
@@ -156,6 +163,7 @@ async def catalog_product(self, **kwargs) -> WalmartCatalog:
         References
         ----------
         https://www.walmart.io/docs/affiliate/catalog-product
+
         """
         if "nextPage" in kwargs:
             url = "https://developer.api.walmart.com" + kwargs.pop("nextPage")
@@ -166,7 +174,8 @@ async def catalog_product(self, **kwargs) -> WalmartCatalog:
         return WalmartCatalog(response)
 
     async def post_browsed_products(self, itemId: str) -> list[WalmartProduct]:
-        """Post Browsed Products Endpoint.
+        """
+        Post Browsed Products Endpoint.
 
         Allows you to recommend products to someone based on their product viewing history.
 
@@ -196,13 +205,15 @@ async def post_browsed_products(self, itemId: str) -> list[WalmartProduct]:
         References
         ----------
         https://www.walmart.io/docs/affiliate/post-browsed-products
+
         """
         url = f"{self.ENDPOINT}/affil/product/v2/postbrowse?itemId={itemId}"
         response = await self._send_request(url)
         return [WalmartProduct(item) for item in response]
 
     async def product_lookup(self, ids: str | list[str], **kwargs) -> list[WalmartProduct]:
-        """Walmart product lookup.
+        """
+        Walmart product lookup.
 
         For more info: (https://walmart.io/docs/affiliate/product-lookup)
 
@@ -228,6 +239,7 @@ async def product_lookup(self, ids: str | list[str], **kwargs) -> list[WalmartPr
         References
         ----------
         https://www.walmart.io/docs/affiliate/product-lookup
+
         """
         url = self.ENDPOINT + "/affil/product/v2/items"
 
@@ -251,7 +263,8 @@ async def product_lookup(self, ids: str | list[str], **kwargs) -> list[WalmartPr
     async def bulk_product_lookup(
         self, ids: str | list[str], amount: int = 20, retries: int = 1, **kwargs
     ):
-        """Walmart product lookup for a bulk of products.
+        """
+        Walmart product lookup for a bulk of products.
 
         It will keep going even if there are errors
         This function is a generator that gives you #amount products at a time
@@ -290,6 +303,7 @@ async def bulk_product_lookup(
         References
         ----------
         https://www.walmart.io/docs/affiliate/product-lookup
+
         """
         url = self.ENDPOINT + "/affil/product/v2/items"
 
@@ -316,7 +330,8 @@ async def bulk_product_lookup(
                     log.error(e)
 
     async def product_recommendation(self, itemId: str) -> list[WalmartProduct]:
-        """Product Recommendation Endpoint.
+        """
+        Product Recommendation Endpoint.
 
         Extension driven by the science that powers the recommended products container on
         Walmart.com. Walmart has parsed 100s of millions of transactions over their product
@@ -346,13 +361,15 @@ async def product_recommendation(self, itemId: str) -> list[WalmartProduct]:
         References
         ----------
         https://www.walmart.io/docs/affiliate/product-recommendation
+
         """
         url = f"{self.ENDPOINT}/affil/product/v2/nbp?itemId={itemId}"
         response = await self._send_request(url)
         return [WalmartProduct(item) for item in response]
 
     async def reviews(self, itemId: str, **kwargs) -> WalmartReviewResponse:
-        """Reviews Endpoint.
+        """
+        Reviews Endpoint.
 
         Gives you access to the extensive item reviews on Walmart that have been written by the
         users of Walmart.com. This is great content for enriching item descriptions. You are free
@@ -378,6 +395,7 @@ async def reviews(self, itemId: str, **kwargs) -> WalmartReviewResponse:
         References
         ----------
         https://www.walmart.io/docs/affiliate/product-recommendation
+
         """
         if "nextPage" in kwargs:
             page = kwargs.pop("nextPage").split("page=")[1]
@@ -388,7 +406,8 @@ async def reviews(self, itemId: str, **kwargs) -> WalmartReviewResponse:
         return WalmartReviewResponse(response)
 
     async def search(self, query: str, **kwargs) -> WalmartSearch:
-        """Search Endpoint.
+        """
+        Search Endpoint.
 
         Text search on the Walmart.com catalog and returns matching items available for sale online.
 
@@ -443,6 +462,7 @@ async def search(self, query: str, **kwargs) -> WalmartSearch:
         References
         ----------
         https://walmart.io/docs/affiliate/search
+
         """
         if "facet" in kwargs:
             facet = kwargs["facet"]
@@ -463,7 +483,8 @@ async def search(self, query: str, **kwargs) -> WalmartSearch:
         return WalmartSearch(response)
 
     async def stores(self, **kwargs) -> list[WalmartStore]:
-        """Store Locator Endpoint.
+        """
+        Store Locator Endpoint.
 
         Locate nearest Walmart Stores via API. It lets users search for stores by
         latitude and longitude, and by zip code.
@@ -478,6 +499,7 @@ async def stores(self, **kwargs) -> list[WalmartStore]:
         Returns
         -------
         store ('WalmartStore') : closest store to specified location
+
         """
         if not (("lat" in kwargs and "lon" in kwargs) or ("zip" in kwargs)):
             raise ValueError("Missing lat & lon OR zip parameter")
@@ -487,7 +509,8 @@ async def stores(self, **kwargs) -> list[WalmartStore]:
         return [WalmartStore(store) for store in response]
 
     async def taxonomy(self, **kwargs) -> WalmartTaxonomy:
-        """Taxonomy Endpoint.
+        """
+        Taxonomy Endpoint.
 
         Taxonomy used to categorize items on Walmart.com.
 
@@ -505,12 +528,14 @@ async def taxonomy(self, **kwargs) -> WalmartTaxonomy:
         ----------
         **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))
 
     async def trending(self, publisherId=None) -> list[WalmartProduct]:
-        """Trending Items Endpoint.
+        """
+        Trending Items Endpoint.
 
         The Trending Items API is designed to give the information on what is bestselling on
         Walmart.com right now. The items returned by this service are a curated list based on the
@@ -527,6 +552,7 @@ async def trending(self, publisherId=None) -> list[WalmartProduct]:
         -------
         products: list of `WalmartProduct`
             a list of walmart products on the trending list
+
         """
         url = self.ENDPOINT + "/affil/product/v2/trends"
 
@@ -538,7 +564,8 @@ async def trending(self, publisherId=None) -> list[WalmartProduct]:
 
     @_ttl_cache(maxsize=2, ttl=170)
     def _get_headers(self) -> dict:
-        """Get the headers required for making an API call.
+        """
+        Get the headers required for making an API call.
 
         References
         ----------
@@ -552,6 +579,7 @@ def _get_headers(self) -> dict:
              'WM_SEC.AUTH_SIGNATURE' : signature_enc,
              'WM_SEC.KEY_VERSION' : keyVersion
          }
+
         """
         timeInt = int(time.time() * 1000)
 
@@ -582,7 +610,8 @@ def _get_headers(self) -> dict:
         return self.headers
 
     async def _send_request(self, url, **kwargs) -> Any:
-        """Send a request to the Walmart API and return the HTTP response.
+        """
+        Send a request to the Walmart API and return the HTTP response.
 
         Format is json by default and cannot be changed through kwargs. xml is deprecated.
         Send richAttributes='true' by default. Can be set to 'false' through kwargs
@@ -603,6 +632,7 @@ async def _send_request(self, url, **kwargs) -> Any:
         InvalidRequestException:
             If the response's status code is different than 200 or 201,
             raise an InvalidRequestException with the appropriate code
+
         """
         log.debug(f"Making connection to {url}")
 
@@ -645,7 +675,8 @@ async def _send_request(self, url, **kwargs) -> Any:
             raise InvalidRequestException(status_code)
 
     def _validate_call(self) -> bool:
-        """Check if the caller has API calls remaining.
+        """
+        Check if the caller has API calls remaining.
 
         If there are remaining calls, check to see if the headers need to be updated.
         If so, update them.
@@ -654,6 +685,7 @@ def _validate_call(self) -> bool:
         -------
         bool:
             if there are still remaining calls for the day
+
         """
         if datetime.datetime.now() > self._update_daily_calls_time:
             self.daily_calls_remaining = self.daily_calls