python-amazon-sp-api 1.7.5__py3-none-any.whl → 2.0.10__py3-none-any.whl

sp_api/base/client.py

@@ -1,61 +1,45 @@
-import hashlib
-import json
 from datetime import datetime
 import logging
 import os
 
-from requests import request
-from requests.exceptions import JSONDecodeError
-
 from sp_api.auth import AccessTokenClient, AccessTokenResponse
 from .ApiResponse import ApiResponse
 from .base_client import BaseClient
-from .exceptions import get_exception_for_code, MissingScopeException
+from .exceptions import MissingScopeException
 from .marketplaces import Marketplaces
 from sp_api.base.credential_provider import CredentialProvider
+from ._core import prepare_request, parse_response, resolve_method
+from ._transport_httpx import HttpxTransport
 
 log = logging.getLogger(__name__)
+log.setLevel(logging.INFO)  # Set default to DEBUG; users can override externally
 
 
-def show_donation_message():
-    import os
-    if os.environ.get('ENV_DISABLE_DONATION_MSG', 0) == '1':
-        return
-
-    print("🌟 Thank you for using python-amazon-sp-api! 🌟")
-    print("This tool helps developers and businesses connect seamlessly with Amazon's vast marketplace,")
-    print("enabling powerful automations and data management.")
-    print("If you appreciate this project and find it useful, please consider supporting its continued development:")
-    print(" - 🙌 GitHub Sponsors: https://github.com/sponsors/saleweaver")
-    print(" - 🌐 BTC Address: bc1q6uqgczasmnvnc5upumarugw2mksnwneg0f65ws")
-    print(" - 🌐 ETH Address: 0xf59534F7a7F5410DBCD0c779Ac3bB6503bd32Ae5")
-    print("\nYour support helps keep the project alive and evolving, and is greatly appreciated!")
-    print("\nTo disable this donation message, set the ENV_DISABLE_DONATION_MSG=1 environment variable.")
-
 
 class Client(BaseClient):
-    grantless_scope: str = ''
+    grantless_scope: str = ""
     keep_restricted_data_token: bool = False
     version = None
 
     def __init__(
-            self,
-            marketplace: Marketplaces = Marketplaces[
-                os.environ.get('SP_API_DEFAULT_MARKETPLACE', Marketplaces.US.name)],
-            *,
-            refresh_token=None,
-            account='default',
-            credentials=None,
-            restricted_data_token=None,
-            proxies=None,
-            verify=True,
-            timeout=None,
-            version=None,
-            credential_providers=None,
-            auth_token_client_class=AccessTokenClient,
+        self,
+        marketplace: Marketplaces = Marketplaces[
+            os.environ.get("SP_API_DEFAULT_MARKETPLACE", Marketplaces.US.name)
+        ],
+        *,
+        refresh_token=None,
+        account="default",
+        credentials=None,
+        restricted_data_token=None,
+        proxies=None,
+        verify=True,
+        timeout=None,
+        version=None,
+        credential_providers=None,
+        auth_token_client_class=AccessTokenClient,
     ):
-        if os.environ.get('SP_API_DEFAULT_MARKETPLACE', None):
-            marketplace = Marketplaces[os.environ.get('SP_API_DEFAULT_MARKETPLACE')]
+        if os.environ.get("SP_API_DEFAULT_MARKETPLACE", None):
+            marketplace = Marketplaces[os.environ.get("SP_API_DEFAULT_MARKETPLACE")]
         self.credentials = CredentialProvider(
             account,
             credentials,
@@ -66,21 +50,30 @@ class Client(BaseClient):
         self.marketplace_id = marketplace.marketplace_id
         self.region = marketplace.region
         self.restricted_data_token = restricted_data_token
-        self._auth = auth_token_client_class(refresh_token=refresh_token, credentials=self.credentials, proxies=proxies, verify=verify)
+        self._auth = auth_token_client_class(
+            refresh_token=refresh_token,
+            credentials=self.credentials,
+            proxies=proxies,
+            verify=verify,
+        )
         self.proxies = proxies
         self.timeout = timeout
         self.version = version
         self.verify = verify
-        show_donation_message()
+        self._transport = HttpxTransport(
+            timeout=timeout,
+            proxies=proxies,
+            verify=verify,
+        )
 
     @property
     def headers(self):
         return {
-            'host': self.endpoint[8:],
-            'user-agent': self.user_agent,
-            'x-amz-access-token': self.restricted_data_token or self.auth.access_token,
-            'x-amz-date': datetime.utcnow().strftime('%Y%m%dT%H%M%SZ'),
-            'content-type': 'application/json'
+            "host": self.endpoint[8:],
+            "user-agent": self.user_agent,
+            "x-amz-access-token": self.restricted_data_token or self.auth.access_token,
+            "x-amz-date": datetime.utcnow().strftime("%Y%m%dT%H%M%SZ"),
+            "content-type": "application/json",
         }
 
     @property
@@ -93,88 +86,113 @@ class Client(BaseClient):
             raise MissingScopeException("Grantless operations require scope")
         return self._auth.get_grantless_auth(self.grantless_scope)
 
-    def _request(self, path: str, *, data: dict = None, params: dict = None, headers=None,
-                 add_marketplace=True, res_no_data: bool = False, bulk: bool = False,
-                 wrap_list: bool = False) -> ApiResponse:
-        if params is None:
-            params = {}
-        if data is None:
-            data = {}
-
-        # Note: The use of isinstance here is to support request schemas that are an array at the
-        # top level, eg get_product_fees_estimate
-        self.method = params.pop('method', data.pop('method', 'GET') if isinstance(data, dict) else 'GET')
-
-        if add_marketplace:
-            self._add_marketplaces(data if self.method in ('POST', 'PUT') else params)
-
-        res = request(self.method,
-                      self.endpoint + self._check_version(path),
-                      params=params,
-                      data=json.dumps(data) if data and self.method in ('POST', 'PUT', 'PATCH') else None,
-                      headers=headers or self.headers,
-                      timeout=self.timeout,
-                      proxies=self.proxies,
-                      verify=self.verify)
+    def _request(
+        self,
+        path: str,
+        *,
+        data: dict = None,
+        params: dict = None,
+        headers=None,
+        add_marketplace=True,
+        res_no_data: bool = False,
+        bulk: bool = False,
+        wrap_list: bool = False,
+    ) -> ApiResponse:
+        method, params, data = resolve_method(params, data)
+        self.method = method
+
+        request_headers = headers or self.headers
+
+        log.debug("HTTP Method: %s", method)
+        log.debug("Making request to URL: %s", self.endpoint + self._check_version(path))
+        log.debug("Request Params: %s", params)
+        log.debug(
+            "Request Data: %s",
+            data if method in ("POST", "PUT", "PATCH") else None,
+        )
+        log.debug("Request Headers: %s", request_headers)
+
+        prepared = prepare_request(
+            method=method,
+            endpoint=self.endpoint,
+            path=path,
+            params=params,
+            data=data,
+            headers=request_headers,
+            add_marketplace=add_marketplace,
+            marketplace_id=self.marketplace_id,
+            version=self.version,
+        )
+        res = self._transport.request(**prepared)
         return self._check_response(res, res_no_data, bulk, wrap_list)
 
-    def _check_response(self, res, res_no_data: bool = False, bulk: bool = False,
-                        wrap_list: bool = False) -> ApiResponse:
-        if (self.method == 'DELETE' or res_no_data) and 200 <= res.status_code < 300:
-            try:
-                js = res.json() or {}
-            except JSONDecodeError:
-                js = {'status_code': res.status_code}
-        else:
-            try:
-                js = res.json() or {}
-            except JSONDecodeError:
-                js = {}
-
-        if isinstance(js, list):
-            if wrap_list:
-                # Support responses that are an array at the top level, eg get_product_fees_estimate
-                js = dict(payload=js)
-            else:
-                js = js[0]
-
-        error = js.get('errors', None)
-
-        if error:
-            exception = get_exception_for_code(res.status_code)
-            raise exception(error, headers=res.headers)
-
-        # show_donation_message()
-
-        return ApiResponse(**js, headers=res.headers)
+    def _check_response(
+        self,
+        res,
+        res_no_data: bool = False,
+        bulk: bool = False,
+        wrap_list: bool = False,
+    ) -> ApiResponse:
+        response = parse_response(
+            res,
+            method=self.method,
+            res_no_data=res_no_data,
+            bulk=bulk,
+            wrap_list=wrap_list,
+        )
+        log.debug("Response: %s", response)
+        return response
 
     def _add_marketplaces(self, data):
-        POST = ['marketplaceIds', 'MarketplaceIds']
-        GET = ['MarketplaceId', 'MarketplaceIds', 'marketplace_ids', 'marketplaceIds']
+        POST = ["marketplaceIds", "MarketplaceIds"]
+        GET = ["MarketplaceId", "MarketplaceIds", "marketplace_ids", "marketplaceIds"]
 
-        if self.method == 'POST':
+        if self.method == "POST":
             if any(x in data.keys() for x in POST):
                 return
-            return data.update({k: self.marketplace_id if not k.endswith('s') else [self.marketplace_id] for k in POST})
+            return data.update(
+                {
+                    k: (
+                        self.marketplace_id
+                        if not k.endswith("s")
+                        else [self.marketplace_id]
+                    )
+                    for k in POST
+                }
+            )
         if any(x in data.keys() for x in GET):
             return
-        return data.update({k: self.marketplace_id if not k.endswith('s') else [self.marketplace_id] for k in GET})
-
-    def _request_grantless_operation(self, path: str, *, data: dict = None, params: dict = None):
+        return data.update(
+            {
+                k: self.marketplace_id if not k.endswith("s") else [self.marketplace_id]
+                for k in GET
+            }
+        )
+
+    def close(self):
+        self._transport.close()
+
+    def _request_grantless_operation(
+        self, path: str, *, data: dict = None, params: dict = None
+    ):
         headers = {
-            'host': self.endpoint[8:],
-            'user-agent': self.user_agent,
-            'x-amz-access-token': self.grantless_auth.access_token,
-            'x-amz-date': datetime.utcnow().strftime('%Y%m%dT%H%M%SZ'),
-            'content-type': 'application/json'
+            "host": self.endpoint[8:],
+            "user-agent": self.user_agent,
+            "x-amz-access-token": self.grantless_auth.access_token,
+            "x-amz-date": datetime.utcnow().strftime("%Y%m%dT%H%M%SZ"),
+            "content-type": "application/json",
         }
-
+        log.debug("HTTP Method: %s", self.method)
+        log.debug("Making request to URL: %s", self.endpoint + self._check_version(path))
+        log.debug("Request Params: %s", params)
+        log.debug("Request Data: %s", data if self.method in ("POST", "PUT", "PATCH") else None)
+        log.debug("Request Headers: %s", headers or self.headers)
         return self._request(path, data=data, params=params, headers=headers)
 
     def _check_version(self, path):
-        if '<version>' not in path:
+        if "<version>" not in path:
             return path
-        return path.replace('<version>', self.version)
+        return path.replace("<version>", self.version)
 
     def __enter__(self):
         self.keep_restricted_data_token = True
@@ -183,3 +201,4 @@ class Client(BaseClient):
     def __exit__(self, *args, **kwargs):
         self.restricted_data_token = None
         self.keep_restricted_data_token = False
+        self.close()

sp_api/base/credential_provider.py

@@ -15,16 +15,14 @@ except ImportError:
     SecretCache = None
 
 
-required_credentials = [
-    'lwa_app_id',
-    'lwa_client_secret'
-]
+required_credentials = ["lwa_app_id", "lwa_client_secret"]
 
 
 class MissingCredentials(Exception):
     """
     Credentials are missing, see the error output to find possible causes
     """
+
     pass
 
 
@@ -32,7 +30,7 @@ class BaseCredentialProvider(abc.ABC):
     errors = []
     credentials = None
 
-    def __init__(self, account: str = 'default', *args, **kwargs):
+    def __init__(self, account: str = "default", *args, **kwargs):
         self.account = account
 
     def __call__(self, *args, **kwargs):
@@ -40,15 +38,19 @@ class BaseCredentialProvider(abc.ABC):
         return self.check_credentials()
 
     @abc.abstractmethod
-    def load_credentials(self):
-        ...
+    def load_credentials(self): ...
 
     def check_credentials(self):
         try:
-            self.errors = [c for c in required_credentials if
-                           c not in self.credentials.keys() or not self.credentials[c]]
+            self.errors = [
+                c
+                for c in required_credentials
+                if c not in self.credentials.keys() or not self.credentials[c]
+            ]
         except (AttributeError, TypeError):
-            raise MissingCredentials(f'Credentials are missing: {", ".join(required_credentials)}')
+            raise MissingCredentials(
+                f'Credentials are missing: {", ".join(required_credentials)}'
+            )
         if not len(self.errors):
             return self.credentials
         raise MissingCredentials(f'Credentials are missing: {", ".join(self.errors)}')
@@ -59,15 +61,15 @@ class FromCodeCredentialProvider(BaseCredentialProvider):
         return None
 
     def __init__(self, credentials: dict, *args, **kwargs):
-        super(FromCodeCredentialProvider, self).__init__('default', credentials)
+        super(FromCodeCredentialProvider, self).__init__("default", credentials)
         self.credentials = credentials
 
 
 class FromConfigFileCredentialProvider(BaseCredentialProvider):
     def load_credentials(self):
         try:
-            config = confuse.Configuration('python-sp-api')
-            config_filename = os.path.join(config.config_dir(), 'credentials.yml')
+            config = confuse.Configuration("python-sp-api")
+            config_filename = os.path.join(config.config_dir(), "credentials.yml")
             config.set_file(config_filename)
             account_data = config[self.account].get()
             self.credentials = account_data
@@ -77,21 +79,20 @@ class FromConfigFileCredentialProvider(BaseCredentialProvider):
 
 class BaseFromSecretsCredentialProvider(BaseCredentialProvider):
     def load_credentials(self):
-        secret_id = os.environ.get('SP_API_AWS_SECRET_ID')
+        secret_id = os.environ.get("SP_API_AWS_SECRET_ID")
         if not secret_id:
             return
         secret = self.get_secret_content(secret_id)
         if not secret:
             return
         self.credentials = dict(
-            refresh_token=secret.get('SP_API_REFRESH_TOKEN'),
-            lwa_app_id=secret.get('LWA_APP_ID'),
-            lwa_client_secret=secret.get('LWA_CLIENT_SECRET'),
+            refresh_token=secret.get("SP_API_REFRESH_TOKEN"),
+            lwa_app_id=secret.get("LWA_APP_ID"),
+            lwa_client_secret=secret.get("LWA_CLIENT_SECRET"),
         )
 
     @abc.abstractmethod
-    def get_secret_content(self, secret_id: str) -> Dict[str, str]:
-        ...
+    def get_secret_content(self, secret_id: str) -> Dict[str, str]: ...
 
 
 class FromSecretsCredentialProvider(BaseFromSecretsCredentialProvider):
@@ -101,11 +102,11 @@ class FromSecretsCredentialProvider(BaseFromSecretsCredentialProvider):
             import boto3
             from botocore.exceptions import ClientError
 
-            client = boto3.client('secretsmanager')
+            client = boto3.client("secretsmanager")
             response = client.get_secret_value(SecretId=secret_id)
-            return json.loads(response.get('SecretString'))
+            return json.loads(response.get("SecretString"))
         except ImportError:
-            print('boto3 not found')
+            print("boto3 not found")
             return {}
         except ClientError:
             return {}
@@ -118,6 +119,7 @@ class FromCachedSecretsCredentialProvider(BaseFromSecretsCredentialProvider):
         if not secret_cache:
             return {}
         from botocore.exceptions import ClientError
+
         try:
             response = secret_cache.get_secret_string(secret_id=secret_id)
             return json.loads(response)
@@ -135,15 +137,14 @@ class FromCachedSecretsCredentialProvider(BaseFromSecretsCredentialProvider):
 class FromEnvironmentVariablesCredentialProvider(BaseCredentialProvider):
     def load_credentials(self):
         account_data = dict(
-            refresh_token=self._get_env('SP_API_REFRESH_TOKEN'),
-            lwa_app_id=self._get_env('LWA_APP_ID'),
-            lwa_client_secret=self._get_env('LWA_CLIENT_SECRET'),
+            refresh_token=self._get_env("SP_API_REFRESH_TOKEN"),
+            lwa_app_id=self._get_env("LWA_APP_ID"),
+            lwa_client_secret=self._get_env("LWA_CLIENT_SECRET"),
         )
         self.credentials = account_data
 
     def _get_env(self, key):
-        return os.environ.get(f'{key}_{self.account}',
-                              os.environ.get(key))
+        return os.environ.get(f"{key}_{self.account}", os.environ.get(key))
 
 
 class CredentialProvider:
@@ -155,17 +156,21 @@ class CredentialProvider:
         FromEnvironmentVariablesCredentialProvider,
         FromCachedSecretsCredentialProvider,
         FromSecretsCredentialProvider,
-        FromConfigFileCredentialProvider
+        FromConfigFileCredentialProvider,
     )
 
     def __init__(
         self,
-        account: str = 'default',
+        account: str = "default",
         credentials: Optional[Dict[str, str]] = None,
         credential_providers: Optional[Iterable[Type[BaseCredentialProvider]]] = None,
     ):
         self.account = account
-        providers = self.CREDENTIAL_PROVIDERS if credential_providers is None else credential_providers
+        providers = (
+            self.CREDENTIAL_PROVIDERS
+            if credential_providers is None
+            else credential_providers
+        )
         for cp in providers:
             try:
                 self.credentials = cp(account=account, credentials=credentials)()
@@ -175,10 +180,12 @@ class CredentialProvider:
         if self.credentials:
             self.credentials = self.Config(**self.credentials)
         else:
-            raise MissingCredentials(f'Credentials are missing: {", ".join(required_credentials)}')
+            raise MissingCredentials(
+                f'Credentials are missing: {", ".join(required_credentials)}'
+            )
 
     class Config:
         def __init__(self, **kwargs):
-            self.refresh_token = kwargs.get('refresh_token')
-            self.lwa_app_id = kwargs.get('lwa_app_id')
-            self.lwa_client_secret = kwargs.get('lwa_client_secret')
+            self.refresh_token = kwargs.get("refresh_token")
+            self.lwa_app_id = kwargs.get("lwa_app_id")
+            self.lwa_client_secret = kwargs.get("lwa_client_secret")

sp_api/base/exceptions.py

@@ -9,12 +9,13 @@ class SellingApiException(Exception):
         error: list Amazon Error list
 
     """
+
     code = 999
 
     def __init__(self, error, headers):
         try:
-            self.message = error[0].get('message')
-            self.amzn_code = error[0].get('code')
+            self.message = error[0].get("message")
+            self.amzn_code = error[0].get("code")
         except IndexError:
             pass
         self.error = error
@@ -25,6 +26,7 @@ class SellingApiBadRequestException(SellingApiException):
     """
     400	Request has missing or invalid parameters and cannot be parsed.
     """
+
     code = 400
 
     def __init__(self, error, headers=None):
@@ -35,6 +37,7 @@ class SellingApiForbiddenException(SellingApiException):
     """
     403	Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
     """
+
     code = 403
 
     def __init__(self, error, headers=None):
@@ -45,6 +48,7 @@ class SellingApiNotFoundException(SellingApiException):
     """
     404	The resource specified does not exist.
     """
+
     code = 404
 
     def __init__(self, error, headers=None):
@@ -55,6 +59,7 @@ class SellingApiStateConflictException(SellingApiException):
     """
     409	The resource specified conflicts with the current state.
     """
+
     code = 409
 
     def __init__(self, error, headers=None):
@@ -65,6 +70,7 @@ class SellingApiTooLargeException(SellingApiException):
     """
     413	The request size exceeded the maximum accepted size.
     """
+
     code = 413
 
     def __init__(self, error, headers=None):
@@ -75,6 +81,7 @@ class SellingApiUnsupportedFormatException(SellingApiException):
     """
     415	The request payload is in an unsupported format.
     """
+
     code = 415
 
     def __init__(self, error, headers=None):
@@ -85,6 +92,7 @@ class SellingApiRequestThrottledException(SellingApiException):
     """
     429	The frequency of requests was greater than allowed.
     """
+
     code = 429
 
     def __init__(self, error, headers=None):
@@ -95,6 +103,7 @@ class SellingApiServerException(SellingApiException):
     """
     500	An unexpected condition occurred that prevented the server from fulfilling the request.
     """
+
     code = 500
 
     def __init__(self, error, headers=None):
@@ -105,6 +114,7 @@ class SellingApiTemporarilyUnavailableException(SellingApiException):
     """
     503	Temporary overloading or maintenance of the server.
     """
+
     code = 503
 
     def __init__(self, error, headers=None):
@@ -115,6 +125,7 @@ class SellingApiGatewayTimeoutException(SellingApiException):
     """
     503	Temporary overloading or maintenance of the server.
     """
+
     code = 504
 
     def __init__(self, error, headers=None):
@@ -136,5 +147,5 @@ def get_exception_for_code(code: int):
         429: SellingApiRequestThrottledException,
         500: SellingApiServerException,
         503: SellingApiTemporarilyUnavailableException,
-        504: SellingApiGatewayTimeoutException
+        504: SellingApiGatewayTimeoutException,
     }.get(code, SellingApiException)