python-sp-api-24 Need to handle 429 errors (Rate Limit throttled)

Author: saleweaver

docs/exceptions.rst

@@ -1,6 +1,19 @@
 Exceptions
 ==========
 
-..  autoclass:: sp_api.base.SellingApiException
-
 ..  autoclass:: sp_api.base.MissingCredentials
+
+..  autoclass:: sp_api.base.exceptions.SellingApiException
+
+..  autoclass:: sp_api.base.SellingApiBadRequestException
+
+..  autoclass:: sp_api.base.SellingApiForbiddenException
+
+..  autoclass:: sp_api.base.SellingApiNotFoundException
+
+..  autoclass:: sp_api.base.SellingApiRequestThrottledException
+
+..  autoclass:: sp_api.base.SellingApiServerException
+
+..  autoclass:: sp_api.base.SellingApiTemporarilyUnavailableException
+

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='python-amazon-sp-api',
-    version='0.1.6',
+    version='0.1.7',
     install_requires=[
         "requests",
         "six~=1.15.0",

sp_api/api/feeds/feeds.py

@@ -8,7 +8,7 @@
 from sp_api.api.feeds.models.create_feed_response import CreateFeedResponse
 from sp_api.api.feeds.models.get_feed_document_response import GetFeedDocumentResponse
 from sp_api.api.feeds.models.get_feed_response import GetFeedResponse
-from sp_api.base import Client, sp_endpoint, Marketplaces, fill_query_params, SellingApiException
+from sp_api.base import Client, sp_endpoint, Marketplaces, fill_query_params
 
 import zlib
 
@@ -97,6 +97,7 @@ def create_feed_document(self, file, content_type='text/tsv', **kwargs) -> Creat
         )
         if 200 <= upload.status_code < 300:
             return response
+        from sp_api.base.exceptions import SellingApiException
         raise SellingApiException(upload.headers)
 
     def submit_feed(self, feed_type, file, content_type='text/tsv', **kwargs) -> [CreateFeedDocumentResponse, CreateFeedResponse]:

sp_api/api/products/products.py

@@ -133,4 +133,4 @@ def _create_get_pricing_request(self, item_list, item_type, **kwargs):
                                 [urllib.parse.quote_plus(s) for s in item_list])},
                                     'ItemType': item_type,
                                     **({'ItemCondition': kwargs.pop('ItemCondition')} if 'ItemCondition' in kwargs else {}),
-                                    'MarketplaceId': self.marketplace_id}).json())
+                                    'MarketplaceId': kwargs.get('MarketplaceId', self.marketplace_id)}).json())

sp_api/base/__init__.py

@@ -3,7 +3,13 @@
 from .client import Client
 from .helpers import fill_query_params, sp_endpoint, decrypt_aes, encrypt_aes
 from .marketplaces import Marketplaces
-from .client import SellingApiException
+from .exceptions import SellingApiException
+from .exceptions import SellingApiBadRequestException
+from .exceptions import SellingApiNotFoundException
+from .exceptions import SellingApiForbiddenException
+from .exceptions import SellingApiRequestThrottledException
+from .exceptions import SellingApiServerException
+from .exceptions import SellingApiTemporarilyUnavailableException
 from .schedules import Schedules
 from .report_status import ReportStatus
 from .sales_enum import FirstDayOfWeek, Granularity, BuyerType
@@ -20,6 +26,12 @@
     'fill_query_params',
     'sp_endpoint',
     'SellingApiException',
+    'SellingApiBadRequestException',
+    'SellingApiNotFoundException',
+    'SellingApiForbiddenException',
+    'SellingApiBadRequestException',
+    'SellingApiRequestThrottledException',
+    'SellingApiTemporarilyUnavailableException',
     'Schedules',
     'ReportStatus',
     'FirstDayOfWeek',

sp_api/base/client.py

@@ -10,16 +10,13 @@
 
 from sp_api.auth import AccessTokenClient, AccessTokenResponse
 from .base_client import BaseClient
+from .exceptions import get_exception_for_code
 from .marketplaces import Marketplaces
 from sp_api.base import AWSSigV4
 
 role_cache = TTLCache(maxsize=10, ttl=3600)
 
 
-class SellingApiException(BaseException):
-    pass
-
-
 class Client(BaseClient):
     boto3_client = None
 
@@ -105,8 +102,10 @@ def _request(self, path: str, *, data: dict = None, params: dict = None, headers
                       auth=self._sign_request())
 
         e = res.json().get('errors', None)
+        print(e)
         if e:
-            raise SellingApiException(e)
+            exception = get_exception_for_code(res.status_code)
+            raise exception(e)
         return res
 
     def _request_grantless_operation(self, path: str, *, data: dict = None, params: dict = None):

sp_api/base/config.py

@@ -3,6 +3,9 @@
 
 
 class MissingCredentials(Exception):
+    """
+    Credentials are missing, see the error output to find possible causes
+    """
     pass
 
 

sp_api/base/exceptions.py

@@ -0,0 +1,89 @@
+class SellingApiException(BaseException):
+    """
+    Generic Exception
+
+    Parameters:
+
+        message: str The error message
+        amzn_code: str Amazon Error Code
+        error: list Amazon Error list
+
+    """
+
+    def __init__(self, error):
+        try:
+            self.message = error[0].get('message')
+            self.amzn_code = error[0].get('code')
+        except IndexError:
+            pass
+        self.error = error
+
+
+class SellingApiBadRequestException(SellingApiException):
+    """
+    400	Request has missing or invalid parameters and cannot be parsed.
+    """
+    code = 400
+
+    def __init__(self, error):
+        super(SellingApiBadRequestException, self).__init__(error)
+
+
+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):
+        super(SellingApiForbiddenException, self).__init__(error)
+
+
+class SellingApiNotFoundException(SellingApiException):
+    """
+    404	The resource specified does not exist.
+    """
+    code = 404
+
+    def __init__(self, error):
+        super(SellingApiNotFoundException, self).__init__(error)
+
+
+class SellingApiRequestThrottledException(SellingApiException):
+    """
+    429	The frequency of requests was greater than allowed.
+    """
+    code = 429
+
+    def __init__(self, error):
+        super(SellingApiRequestThrottledException, self).__init__(error)
+
+
+class SellingApiServerException(SellingApiException):
+    """
+    500	An unexpected condition occurred that prevented the server from fulfilling the request.
+    """
+    code = 500
+
+    def __init__(self, error):
+        super(SellingApiServerException, self).__init__(error)
+
+
+class SellingApiTemporarilyUnavailableException(SellingApiException):
+    """
+    503	Temporary overloading or maintenance of the server.
+    """
+    code = 503
+
+    def __init__(self, error):
+        super(SellingApiTemporarilyUnavailableException, self).__init__(error)
+
+
+def get_exception_for_code(code: int):
+    return {
+        400: SellingApiBadRequestException,
+        403: SellingApiForbiddenException,
+        429: SellingApiRequestThrottledException,
+        500: SellingApiServerException,
+        503: SellingApiTemporarilyUnavailableException
+    }.get(code, SellingApiException)

tests/api/catalog/test_catalog.py

@@ -1,6 +1,2 @@
 from sp_api.api import Catalog
 from sp_api.base import Marketplaces
-
-
-
-

tests/api/feeds/test_feeds.py

@@ -1,4 +1,5 @@
 from sp_api.api import Feeds
+from sp_api.base import SellingApiBadRequestException, SellingApiServerException
 
 
 def test_create_feed():
@@ -13,3 +14,18 @@ def test_get_feed():
     assert res.payload.get('feedId') == 'FeedId1'
     assert res.payload.get('processingStatus') == 'CANCELLED'
 
+
+def test_get_feed_expect_400():
+    try:
+        Feeds().get_feed('badFeedId1')
+    except SellingApiBadRequestException as br:
+        assert type(br) == SellingApiBadRequestException
+        assert br.code == 400
+
+
+def test_get_feed_expect_500():
+    try:
+        Feeds().get_feed('giberish')
+    except SellingApiServerException as br:
+        assert type(br) == SellingApiServerException
+        assert br.code == 500