solve annotation errors for ruff

Author: sabadroiback

amazon_paapi/api.py

@@ -4,7 +4,7 @@
 """
 
 import time
-from typing import List, Optional, Union
+from typing import Any, List, Optional, Union
 
 from . import models
 from .errors import InvalidArgument
@@ -39,7 +39,7 @@ def __init__(
         tag: str,
         country: CountryCode,
         throttling: float = 1,
-        **kwargs,
+        **kwargs: Any,
     ) -> None:
         """Initialize the Amazon API client with the provided credentials."""
         self._key = key
@@ -67,7 +67,7 @@ def get_items(
         currency_of_preference: Optional[str] = None,
         languages_of_preference: Optional[List[str]] = None,
         include_unavailable: bool = False,
-        **kwargs,
+        **kwargs: Any,
     ) -> List[models.Item]:
         """Get items information from Amazon.
 
@@ -141,7 +141,7 @@ def search_items(
         min_reviews_rating: Optional[int] = None,
         search_index: Optional[str] = None,
         sort_by: models.SortBy = None,
-        **kwargs,
+        **kwargs: Any,
     ) -> models.SearchResult:
         """Search for items on Amazon based on a search query.
 
@@ -244,7 +244,7 @@ def get_variations(
         currency_of_preference: Optional[str] = None,
         languages_of_preference: Optional[List[str]] = None,
         merchant: models.Merchant = None,
-        **kwargs,
+        **kwargs: Any,
     ) -> models.VariationsResult:
         """Return a set of items that are the same product but differ by theme.
 
@@ -302,7 +302,7 @@ def get_browse_nodes(
         self,
         browse_node_ids: List[str],
         languages_of_preference: Optional[List[str]] = None,
-        **kwargs,
+        **kwargs: Any,
     ) -> List[models.BrowseNode]:
         """Return the specified browse node's information.
 

amazon_paapi/helpers/arguments.py

@@ -1,6 +1,6 @@
 """Module with helper functions for managing arguments."""
 
-from typing import List, Union
+from typing import Any, List, Union
 
 from amazon_paapi.errors import InvalidArgument
 from amazon_paapi.tools import get_asin
@@ -30,13 +30,13 @@ def get_items_ids(items: Union[str, List[str]]) -> List[str]:
     raise InvalidArgument(msg)
 
 
-def check_search_args(**kwargs) -> None:
+def check_search_args(**kwargs: Any) -> None:
     """Validate all search arguments."""
     check_search_mandatory_args(**kwargs)
     check_search_pagination_args(**kwargs)
 
 
-def check_search_mandatory_args(**kwargs) -> None:
+def check_search_mandatory_args(**kwargs: Any) -> None:
     """Validate that at least one mandatory search argument is provided."""
     mandatory_args = [
         kwargs.get("keywords"),
@@ -56,7 +56,7 @@ def check_search_mandatory_args(**kwargs) -> None:
         raise InvalidArgument(error_message)
 
 
-def check_search_pagination_args(**kwargs) -> None:
+def check_search_pagination_args(**kwargs: Any) -> None:
     """Validate pagination arguments for search requests."""
     error_message = "Args item_count and item_page should be integers between 1 and 10."
     pagination_args = [kwargs.get("item_count"), kwargs.get("item_page")]
@@ -66,7 +66,7 @@ def check_search_pagination_args(**kwargs) -> None:
             raise InvalidArgument(error_message)
 
 
-def check_variations_args(**kwargs) -> None:
+def check_variations_args(**kwargs: Any) -> None:
     """Validate variation arguments for get_variations requests."""
     error_message = (
         "Args variation_count and variation_page should be integers between 1 and 10."
@@ -78,7 +78,7 @@ def check_variations_args(**kwargs) -> None:
             raise InvalidArgument(error_message)
 
 
-def check_browse_nodes_args(**kwargs) -> None:
+def check_browse_nodes_args(**kwargs: Any) -> None:
     """Validate browse node arguments."""
     if not isinstance(kwargs.get("browse_node_ids"), List):
         error_message = "Argument browse_node_ids should be a List of strings."

amazon_paapi/helpers/requests.py

@@ -1,7 +1,13 @@
 """Module with helper functions for creating requests."""
 
+from __future__ import annotations
+
 import inspect
-from typing import List, NoReturn, cast
+from typing import TYPE_CHECKING, Any, List, NoReturn, cast
+
+if TYPE_CHECKING:
+    from amazon_paapi.api import AmazonApi
+    from amazon_paapi.sdk.rest import ApiException as ApiExceptionType
 
 from amazon_paapi.errors import (
     AssociateValidationError,
@@ -27,7 +33,11 @@
 from amazon_paapi.sdk.rest import ApiException
 
 
-def get_items_request(amazon_api, asin_chunk: List[str], **kwargs) -> GetItemsRequest:
+def get_items_request(
+    amazon_api: AmazonApi,
+    asin_chunk: list[str],
+    **kwargs: Any,
+) -> GetItemsRequest:
     """Create a GetItemsRequest for the Amazon API."""
     try:
         return GetItemsRequest(
@@ -43,7 +53,7 @@ def get_items_request(amazon_api, asin_chunk: List[str], **kwargs) -> GetItemsRe
         raise MalformedRequest(msg) from exc
 
 
-def get_items_response(amazon_api, request: GetItemsRequest) -> List[Item]:
+def get_items_response(amazon_api: AmazonApi, request: GetItemsRequest) -> list[Item]:
     """Execute a GetItemsRequest and return the list of items."""
     try:
         response = amazon_api.api.get_items(request)
@@ -57,7 +67,10 @@ def get_items_response(amazon_api, request: GetItemsRequest) -> List[Item]:
     return cast(List[Item], response.items_result.items)
 
 
-def get_search_items_request(amazon_api, **kwargs) -> SearchItemsRequest:
+def get_search_items_request(
+    amazon_api: AmazonApi,
+    **kwargs: Any,
+) -> SearchItemsRequest:
     """Create a SearchItemsRequest for the Amazon API."""
     try:
         return SearchItemsRequest(
@@ -72,7 +85,9 @@ def get_search_items_request(amazon_api, **kwargs) -> SearchItemsRequest:
         raise MalformedRequest(msg) from exc
 
 
-def get_search_items_response(amazon_api, request: SearchItemsRequest) -> SearchResult:
+def get_search_items_response(
+    amazon_api: AmazonApi, request: SearchItemsRequest
+) -> SearchResult:
     """Execute a SearchItemsRequest and return the search result."""
     try:
         response = amazon_api.api.search_items(request)
@@ -86,7 +101,10 @@ def get_search_items_response(amazon_api, request: SearchItemsRequest) -> Search
     return cast(SearchResult, response.search_result)
 
 
-def get_variations_request(amazon_api, **kwargs) -> GetVariationsRequest:
+def get_variations_request(
+    amazon_api: AmazonApi,
+    **kwargs: Any,
+) -> GetVariationsRequest:
     """Create a GetVariationsRequest for the Amazon API."""
     try:
         return GetVariationsRequest(
@@ -102,7 +120,7 @@ def get_variations_request(amazon_api, **kwargs) -> GetVariationsRequest:
 
 
 def get_variations_response(
-    amazon_api, request: GetVariationsRequest
+    amazon_api: AmazonApi, request: GetVariationsRequest
 ) -> VariationsResult:
     """Execute a GetVariationsRequest and return the variations result."""
     try:
@@ -117,7 +135,10 @@ def get_variations_response(
     return cast(VariationsResult, response.variations_result)
 
 
-def get_browse_nodes_request(amazon_api, **kwargs) -> GetBrowseNodesRequest:
+def get_browse_nodes_request(
+    amazon_api: AmazonApi,
+    **kwargs: Any,
+) -> GetBrowseNodesRequest:
     """Create a GetBrowseNodesRequest for the Amazon API."""
     try:
         return GetBrowseNodesRequest(
@@ -133,8 +154,8 @@ def get_browse_nodes_request(amazon_api, **kwargs) -> GetBrowseNodesRequest:
 
 
 def get_browse_nodes_response(
-    amazon_api, request: GetBrowseNodesRequest
-) -> List[BrowseNode]:
+    amazon_api: AmazonApi, request: GetBrowseNodesRequest
+) -> list[BrowseNode]:
     """Execute a GetBrowseNodesRequest and return the list of browse nodes."""
     try:
         response = amazon_api.api.get_browse_nodes(request)
@@ -148,13 +169,13 @@ def get_browse_nodes_response(
     return cast(List[BrowseNode], response.browse_nodes_result.browse_nodes)
 
 
-def _get_request_resources(resources) -> List[str]:
+def _get_request_resources(resources: type[object]) -> list[str]:
     """Extract all resource strings from a resource class."""
     resources = inspect.getmembers(resources, lambda a: not inspect.isroutine(a))
     return [x[-1] for x in resources if isinstance(x[-1], str) and x[0][0:2] != "__"]
 
 
-def _manage_response_exceptions(error) -> NoReturn:
+def _manage_response_exceptions(error: ApiExceptionType) -> NoReturn:
     """Handle API exceptions and raise appropriate custom exceptions."""
     error_status = getattr(error, "status", None)
     error_body = getattr(error, "body", "") or ""

pyproject.toml

@@ -7,20 +7,19 @@ unsafe-fixes = true
 select = ["ALL"]
 ignore = [
     "ANN003",
+    "ANN401",
     "D104",
     "D100",
     "D203",
     "D213",
     "COM812",
     "ISC001",
 ]
-exclude = [
-    "amazon_paapi/sdk/*",
-    "docs/*",
-]
+exclude = ["amazon_paapi/sdk/*", "docs/*"]
 
 [tool.ruff.lint.per-file-ignores]
 "tests/*" = [
+    "ANN001",
     "ANN201",
     "ANN206",
     "D101",
@@ -33,11 +32,7 @@ exclude = [
 ]
 
 [tool.ruff.format]
-exclude = [
-    "amazon_paapi/sdk/*",
-    "docs/*",
-    ".github",
-]
+exclude = ["amazon_paapi/sdk/*", "docs/*", ".github"]
 
 [tool.mypy]
 python_version = "3.9"
@@ -53,9 +48,7 @@ cache_dir = '.cache/mypy'
 exclude = ["amazon_paapi/sdk/*"]
 
 [[tool.mypy.overrides]]
-module = [
-  "amazon_paapi/sdk/*",
-]
+module = ["amazon_paapi/sdk/*"]
 follow_imports = "skip"
 
 [tool.coverage.run]

tests/test_api.py

@@ -3,6 +3,7 @@
 import time
 import unittest
 from unittest import mock
+from unittest.mock import MagicMock
 
 from amazon_paapi import AmazonApi, models
 from amazon_paapi.errors.exceptions import InvalidArgument
@@ -33,14 +34,14 @@ def test_api_throttling_sleeps(self):
         self.assertTrue(start < int(time.time() * 10))
 
     @mock.patch.object(requests, "get_items_response")
-    def test_get_items(self, mocked_get_items_response):
+    def test_get_items(self, mocked_get_items_response: MagicMock):
         mocked_get_items_response.return_value = []
         amazon = AmazonApi("key", "secret", "tag", "ES")
         response = amazon.get_items("ABCDEFGHIJ")
         self.assertTrue(isinstance(response, list))
 
     @mock.patch.object(requests, "get_search_items_response")
-    def test_search_items(self, mocked_get_search_items_response):
+    def test_search_items(self, mocked_get_search_items_response: MagicMock):
         mocked_response = models.SearchResult()
         mocked_response.items = []
         mocked_get_search_items_response.return_value = mocked_response
@@ -49,7 +50,7 @@ def test_search_items(self, mocked_get_search_items_response):
         self.assertTrue(isinstance(response.items, list))
 
     @mock.patch.object(requests, "get_variations_response")
-    def test_get_variations(self, mocked_get_variations_response):
+    def test_get_variations(self, mocked_get_variations_response: MagicMock):
         mocked_response = models.VariationsResult()
         mocked_response.items = []
         mocked_get_variations_response.return_value = mocked_response
@@ -58,7 +59,7 @@ def test_get_variations(self, mocked_get_variations_response):
         self.assertTrue(isinstance(response.items, list))
 
     @mock.patch.object(requests, "get_browse_nodes_response")
-    def test_get_browse_nodes(self, mocked_get_browse_nodes_response):
+    def test_get_browse_nodes(self, mocked_get_browse_nodes_response: MagicMock):
         mocked_response = []
         mocked_get_browse_nodes_response.return_value = mocked_response
         amazon = AmazonApi("key", "secret", "tag", "ES")

tests/test_helpers_items.py

@@ -7,7 +7,7 @@
 
 
 class MockedItem(mock.MagicMock):
-    def __init__(self, asin) -> None:
+    def __init__(self, asin: str) -> None:
         super().__init__()
         self.asin = asin
 

tests/test_helpers_requests.py

@@ -1,7 +1,7 @@
 """Tests for requests helper functions."""
 
 import unittest
-from unittest.mock import Mock, patch
+from unittest.mock import MagicMock, Mock, patch
 
 from amazon_paapi.errors import (
     AssociateValidationError,
@@ -17,56 +17,56 @@
 
 class TestRequests(unittest.TestCase):
     @patch.object(requests, "GetItemsRequest")
-    def test_get_items_request(self, mock_get_items_request):
+    def test_get_items_request(self, mock_get_items_request: MagicMock):
         mock_get_items_request.return_value = "foo"
         result = requests.get_items_request(Mock(), ["test"])
 
         self.assertEqual("foo", result)
 
     @patch.object(requests, "GetItemsRequest")
-    def test_get_items_request_error(self, mock_get_items_request):
+    def test_get_items_request_error(self, mock_get_items_request: MagicMock):
         mock_get_items_request.side_effect = TypeError()
 
         with self.assertRaises(MalformedRequest):
             requests.get_items_request(Mock(), ["test"])
 
     @patch.object(requests, "SearchItemsRequest")
-    def test_search_items_request(self, mock_search_items_request):
+    def test_search_items_request(self, mock_search_items_request: MagicMock):
         mock_search_items_request.return_value = "foo"
         result = requests.get_search_items_request(Mock())
 
         self.assertEqual("foo", result)
 
     @patch.object(requests, "SearchItemsRequest")
-    def test_search_items_request_error(self, mock_search_items_request):
+    def test_search_items_request_error(self, mock_search_items_request: MagicMock):
         mock_search_items_request.side_effect = TypeError()
 
         with self.assertRaises(MalformedRequest):
             requests.get_search_items_request(Mock())
 
     @patch.object(requests, "GetVariationsRequest")
-    def test_variations_request(self, mock_variations_request):
+    def test_variations_request(self, mock_variations_request: MagicMock):
         mock_variations_request.return_value = "foo"
         result = requests.get_variations_request(Mock())
 
         self.assertEqual("foo", result)
 
     @patch.object(requests, "GetVariationsRequest")
-    def test_variations_request_error(self, mock_variations_request):
+    def test_variations_request_error(self, mock_variations_request: MagicMock):
         mock_variations_request.side_effect = TypeError()
 
         with self.assertRaises(MalformedRequest):
             requests.get_variations_request(Mock())
 
     @patch.object(requests, "GetBrowseNodesRequest")
-    def test_browse_nodes_request(self, mock_browse_nodes_request):
+    def test_browse_nodes_request(self, mock_browse_nodes_request: MagicMock):
         mock_browse_nodes_request.return_value = "foo"
         result = requests.get_browse_nodes_request(Mock())
 
         self.assertEqual("foo", result)
 
     @patch.object(requests, "GetBrowseNodesRequest")
-    def test_browse_nodes_request_error(self, mock_browse_nodes_request):
+    def test_browse_nodes_request_error(self, mock_browse_nodes_request: MagicMock):
         mock_browse_nodes_request.side_effect = TypeError()
 
         with self.assertRaises(MalformedRequest):