fix mypy errors

Author: sabadroiback

amazon_paapi/api.py

@@ -11,6 +11,7 @@
 from .helpers import arguments, requests
 from .helpers.generators import get_list_chunks
 from .helpers.items import sort_items
+from .models.regions import CountryCode
 from .sdk.api.default_api import DefaultApi
 
 
@@ -21,7 +22,8 @@ class AmazonApi:
         key (``str``): Your API key.
         secret (``str``): Your API secret.
         tag (``str``): Your affiliate tracking id, used to create the affiliate link.
-        country (``models.Country``): Country code for your affiliate account.
+        country (``CountryCode``): Country code for your affiliate account.
+            Use values from ``models.Country``, e.g. ``Country.ES``.
         throttling (``float``, optional): Wait time in seconds between API calls. Use it
             to avoid reaching Amazon limits. Defaults to 1 second.
 
@@ -35,7 +37,7 @@ def __init__(
         key: str,
         secret: str,
         tag: str,
-        country: models.Country,
+        country: CountryCode,
         throttling: float = 1,
         **kwargs,
     ) -> None:

amazon_paapi/helpers/arguments.py

@@ -7,18 +7,27 @@
 
 
 def get_items_ids(items: Union[str, List[str]]) -> List[str]:
-    if not isinstance(items, str) and not isinstance(items, List):
-        msg = "Invalid items argument, it should be a string or List of strings"
-        raise InvalidArgument(msg)
+    """Parse and extract ASINs from items input.
 
+    Args:
+        items: Either a comma-separated string of ASINs/URLs or a list of ASINs/URLs.
+
+    Returns:
+        A list of extracted ASINs.
+
+    Raises:
+        InvalidArgument: If items is not a string or list.
+
+    """
     if isinstance(items, str):
         items_ids = items.split(",")
-        items_ids = [get_asin(x.strip()) for x in items_ids]
+        return [get_asin(x.strip()) for x in items_ids]
 
-    else:
-        items_ids = [get_asin(x.strip()) for x in items]
+    if isinstance(items, list):
+        return [get_asin(x.strip()) for x in items]
 
-    return items_ids
+    msg = "Invalid items argument, it should be a string or List of strings"  # type: ignore[unreachable]
+    raise InvalidArgument(msg)
 
 
 def check_search_args(**kwargs) -> None:
@@ -46,29 +55,25 @@ def check_search_mandatory_args(**kwargs) -> None:
 
 
 def check_search_pagination_args(**kwargs) -> 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")]
-    pagination_args = [arg for arg in pagination_args if arg]
 
-    if not all(isinstance(arg, int) for arg in pagination_args):
-        raise InvalidArgument(error_message)
-
-    if not all(1 <= arg <= 10 for arg in pagination_args):
-        raise InvalidArgument(error_message)
+    for arg in pagination_args:
+        if arg is not None and (not isinstance(arg, int) or not 1 <= arg <= 10):
+            raise InvalidArgument(error_message)
 
 
 def check_variations_args(**kwargs) -> None:
+    """Validate variation arguments for get_variations requests."""
     error_message = (
         "Args variation_count and variation_page should be integers between 1 and 10."
     )
     variation_args = [kwargs.get("variation_count"), kwargs.get("variation_page")]
-    variation_args = [arg for arg in variation_args if arg]
-
-    if not all(isinstance(arg, int) for arg in variation_args):
-        raise InvalidArgument(error_message)
 
-    if not all(1 <= arg <= 10 for arg in variation_args):
-        raise InvalidArgument(error_message)
+    for arg in variation_args:
+        if arg is not None and (not isinstance(arg, int) or not 1 <= arg <= 10):
+            raise InvalidArgument(error_message)
 
 
 def check_browse_nodes_args(**kwargs) -> None:

amazon_paapi/helpers/items.py

@@ -8,10 +8,11 @@
 def sort_items(
     items: List[models.Item], items_ids: List[str], include_unavailable: bool
 ) -> List[models.Item]:
-    sorted_items = []
+    """Sort items by the order of the provided items_ids list."""
+    sorted_items: List[models.Item] = []
 
     for asin in items_ids:
-        matches = list(filter(lambda item, asin=asin: item.asin == asin, items))
+        matches: List[models.Item] = [item for item in items if item.asin == asin]
         if matches:
             sorted_items.append(matches[0])
         elif include_unavailable:

amazon_paapi/helpers/requests.py

@@ -1,7 +1,7 @@
 """Module with helper functions for creating requests."""
 
 import inspect
-from typing import List
+from typing import List, NoReturn, cast
 
 from amazon_paapi.errors import (
     AssociateValidationError,
@@ -52,7 +52,7 @@ def get_items_response(amazon_api, request: GetItemsRequest) -> List[Item]:
         msg = "No items have been found"
         raise ItemsNotFound(msg)
 
-    return response.items_result.items
+    return cast(List[Item], response.items_result.items)
 
 
 def get_search_items_request(amazon_api, **kwargs) -> SearchItemsRequest:
@@ -79,7 +79,7 @@ def get_search_items_response(amazon_api, request: SearchItemsRequest) -> Search
         msg = "No items have been found"
         raise ItemsNotFound(msg)
 
-    return response.search_result
+    return cast(SearchResult, response.search_result)
 
 
 def get_variations_request(amazon_api, **kwargs) -> GetVariationsRequest:
@@ -108,7 +108,7 @@ def get_variations_response(
         msg = "No variation items have been found"
         raise ItemsNotFound(msg)
 
-    return response.variations_result
+    return cast(VariationsResult, response.variations_result)
 
 
 def get_browse_nodes_request(amazon_api, **kwargs) -> GetBrowseNodesRequest:
@@ -137,15 +137,15 @@ def get_browse_nodes_response(
         msg = "No browse nodes have been found"
         raise ItemsNotFound(msg)
 
-    return response.browse_nodes_result.browse_nodes
+    return cast(List[BrowseNode], response.browse_nodes_result.browse_nodes)
 
 
 def _get_request_resources(resources) -> List[str]:
     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) -> None:
+def _manage_response_exceptions(error) -> NoReturn:
     error_status = getattr(error, "status", None)
     error_body = getattr(error, "body", "") or ""
 

amazon_paapi/models/__init__.py

@@ -2,18 +2,19 @@
 
 from .browse_nodes_result import BrowseNode
 from .item_result import Item
-from .regions import Country
+from .regions import Country, CountryCode
 from .search_result import SearchResult
 from .variations_result import VariationsResult
 
 __all__ = [
     "Availability",
-    "Condition",
-    "Merchant",
-    "SortBy",
     "BrowseNode",
-    "Item",
+    "Condition",
     "Country",
+    "CountryCode",
+    "Item",
+    "Merchant",
     "SearchResult",
+    "SortBy",
     "VariationsResult",
 ]

amazon_paapi/models/regions.py

@@ -1,27 +1,62 @@
+from __future__ import annotations
+
+from typing import Literal
+
+# Type alias for valid country codes
+CountryCode = Literal[
+    "AU",
+    "BE",
+    "BR",
+    "CA",
+    "FR",
+    "DE",
+    "IN",
+    "IT",
+    "JP",
+    "MX",
+    "NL",
+    "PL",
+    "SG",
+    "SA",
+    "ES",
+    "SE",
+    "TR",
+    "AE",
+    "UK",
+    "US",
+]
+
+
 class Country:
-    AU = "AU"
-    BE = "BE"
-    BR = "BR"
-    CA = "CA"
-    FR = "FR"
-    DE = "DE"
-    IN = "IN"
-    IT = "IT"
-    JP = "JP"
-    MX = "MX"
-    NL = "NL"
-    PL = "PL"
-    SG = "SG"
-    SA = "SA"
-    ES = "ES"
-    SE = "SE"
-    TR = "TR"
-    AE = "AE"
-    UK = "UK"
-    US = "US"
+    """Constants for supported Amazon countries.
+
+    Use these constants when specifying the country parameter.
+    Example: AmazonApi(key, secret, tag, Country.ES)
+    """
+
+    AU: CountryCode = "AU"
+    BE: CountryCode = "BE"
+    BR: CountryCode = "BR"
+    CA: CountryCode = "CA"
+    FR: CountryCode = "FR"
+    DE: CountryCode = "DE"
+    IN: CountryCode = "IN"
+    IT: CountryCode = "IT"
+    JP: CountryCode = "JP"
+    MX: CountryCode = "MX"
+    NL: CountryCode = "NL"
+    PL: CountryCode = "PL"
+    SG: CountryCode = "SG"
+    SA: CountryCode = "SA"
+    ES: CountryCode = "ES"
+    SE: CountryCode = "SE"
+    TR: CountryCode = "TR"
+    AE: CountryCode = "AE"
+    UK: CountryCode = "UK"
+    US: CountryCode = "US"
 
 
-REGIONS = {
+REGIONS: dict[str, str] = {
     "AU": "us-west-2",
     "BE": "eu-west-1",
     "BR": "us-east-1",
@@ -45,7 +80,7 @@ class Country:
 }
 
 
-DOMAINS = {
+DOMAINS: dict[str, str] = {
     "AU": "com.au",
     "BE": "com.be",
     "BR": "com.br",

pyproject.toml

@@ -40,7 +40,7 @@ exclude = [
 ]
 
 [tool.mypy]
-python_version = "3.7"
+python_version = "3.9"
 ignore_missing_imports = true
 no_implicit_optional = true
 strict_equality = true

setup.py

@@ -1,6 +1,8 @@
+from pathlib import Path
+
 import setuptools
 
-with open("README.md", encoding="utf8") as fh:
+with Path("README.md").open(encoding="utf8") as fh:
     long_description = fh.read()
 
 setuptools.setup(
@@ -20,5 +22,5 @@
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ],
-    python_requires=">=3.7",
+    python_requires=">=3.9",
 )