Merge pull request #114 from sergioteula/fix-pylint-errors

Fix pylint errors

Author: sergioteula

.githooks/pre-push

@@ -6,5 +6,6 @@ source "${ROOT_DIR}/scripts/helpers"
 ./scripts/check_isort
 ./scripts/check_black
 ./scripts/check_flake8
+./scripts/check_pylint
 
 header "Proceeding with push"

.github/workflows/lint-and-test.yml

@@ -40,3 +40,15 @@ jobs:
       uses: actions/checkout@v2
     - name: Check code errors
       run: ./scripts/check_flake8
+
+  pylint:
+    runs-on: ubuntu-latest
+    container:
+      image: sergioteula/pytools
+      volumes:
+        - ${{github.workspace}}:/code
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v2
+    - name: Check code errors
+      run: ./scripts/check_pylint

amazon_paapi/api.py

@@ -40,19 +40,19 @@ def __init__(
     ):
         self._key = key
         self._secret = secret
-        self._tag = tag
-        self._country = country
-        self._throttling = float(throttling)
         self._last_query_time = time.time() - throttling
+        self.tag = tag
+        self.country = country
+        self.throttling = float(throttling)
 
         try:
             self._host = "webservices.amazon." + models.regions.DOMAINS[country]
-            self._region = models.regions.REGIONS[country]
-            self._marketplace = "www.amazon." + models.regions.DOMAINS[country]
+            self.region = models.regions.REGIONS[country]
+            self.marketplace = "www.amazon." + models.regions.DOMAINS[country]
         except KeyError as error:
             raise InvalidArgumentException("Country code is not correct") from error
 
-        self._api = DefaultApi(key, secret, self._host, self._region)
+        self.api = DefaultApi(key, secret, self._host, self.region)
 
     def get_items(
         self,
@@ -329,7 +329,7 @@ def get_browse_nodes(
         return requests.get_browse_nodes_response(self, request)
 
     def _throttle(self):
-        wait_time = self._throttling - (time.time() - self._last_query_time)
+        wait_time = self.throttling - (time.time() - self._last_query_time)
         if wait_time > 0:
             time.sleep(wait_time)
         self._last_query_time = time.time()

amazon_paapi/errors/exceptions.py

@@ -9,52 +9,36 @@ def __init__(self, reason: str):
         self.reason = reason
 
     def __str__(self) -> str:
-        return "%s" % self.reason
+        return self.reason
 
 
 class InvalidArgumentException(AmazonException):
     """Raised when arguments are not correct."""
 
-    pass
-
 
 class AsinNotFoundException(AmazonException):
     """Raised if the ASIN for an item is not found."""
 
-    pass
-
 
 class ApiRequestException(AmazonException):
     """Raised if the request to Amazon API fails"""
 
-    pass
-
 
 class MalformedRequestException(AmazonException):
     """Raised if the request for Amazon API is not correctly formed"""
 
-    pass
-
 
 class ItemsNotFoundException(AmazonException):
     """Raised if no items are found"""
 
-    pass
-
 
 class TooManyRequestsException(AmazonException):
     """Raised when requests limit is reached"""
 
-    pass
-
 
 class InvalidPartnerTagException(AmazonException):
     """Raised if the partner tag is not present or invalid"""
 
-    pass
-
 
 class AssociateValidationException(AmazonException):
     """Raised when credentials are not valid for the selected country"""
-
-    pass

amazon_paapi/helpers/requests.py

@@ -33,22 +33,22 @@ def get_items_request(amazon_api, asin_chunk: List[str], **kwargs) -> GetItemsRe
         return GetItemsRequest(
             resources=_get_request_resources(GetItemsResource),
             partner_type=PartnerType.ASSOCIATES,
-            marketplace=amazon_api._marketplace,
-            partner_tag=amazon_api._tag,
+            marketplace=amazon_api.marketplace,
+            partner_tag=amazon_api.tag,
             item_ids=asin_chunk,
-            **kwargs
+            **kwargs,
         )
-    except TypeError as e:
+    except TypeError as exc:
         raise MalformedRequestException(
-            "Parameters for get_items request are not correct: " + str(e)
-        )
+            f"Parameters for get_items request are not correct: {exc}"
+        ) from exc
 
 
 def get_items_response(amazon_api, request: GetItemsRequest) -> List[Item]:
     try:
-        response = amazon_api._api.get_items(request)
-    except ApiException as e:
-        _manage_response_exceptions(e)
+        response = amazon_api.api.get_items(request)
+    except ApiException as exc:
+        _manage_response_exceptions(exc)
 
     if response.items_result is None:
         raise ItemsNotFoundException("No items have been found")
@@ -61,21 +61,21 @@ def get_search_items_request(amazon_api, **kwargs) -> SearchItemsRequest:
         return SearchItemsRequest(
             resources=_get_request_resources(SearchItemsResource),
             partner_type=PartnerType.ASSOCIATES,
-            marketplace=amazon_api._marketplace,
-            partner_tag=amazon_api._tag,
-            **kwargs
+            marketplace=amazon_api.marketplace,
+            partner_tag=amazon_api.tag,
+            **kwargs,
         )
-    except TypeError as e:
+    except TypeError as exc:
         raise MalformedRequestException(
-            "Parameters for search_items request are not correct: " + str(e)
-        )
+            f"Parameters for search_items request are not correct: {exc}"
+        ) from exc
 
 
 def get_search_items_response(amazon_api, request: SearchItemsRequest) -> SearchResult:
     try:
-        response = amazon_api._api.search_items(request)
-    except ApiException as e:
-        _manage_response_exceptions(e)
+        response = amazon_api.api.search_items(request)
+    except ApiException as exc:
+        _manage_response_exceptions(exc)
 
     if response.search_result is None:
         raise ItemsNotFoundException("No items have been found")
@@ -88,23 +88,23 @@ def get_variations_request(amazon_api, **kwargs) -> GetVariationsRequest:
         return GetVariationsRequest(
             resources=_get_request_resources(GetVariationsResource),
             partner_type=PartnerType.ASSOCIATES,
-            marketplace=amazon_api._marketplace,
-            partner_tag=amazon_api._tag,
-            **kwargs
+            marketplace=amazon_api.marketplace,
+            partner_tag=amazon_api.tag,
+            **kwargs,
         )
-    except TypeError as e:
+    except TypeError as exc:
         raise MalformedRequestException(
-            "Parameters for get_variations request are not correct: " + str(e)
-        )
+            f"Parameters for get_variations request are not correct: {exc}"
+        ) from exc
 
 
 def get_variations_response(
     amazon_api, request: GetVariationsRequest
 ) -> VariationsResult:
     try:
-        response = amazon_api._api.get_variations(request)
-    except ApiException as e:
-        _manage_response_exceptions(e)
+        response = amazon_api.api.get_variations(request)
+    except ApiException as exc:
+        _manage_response_exceptions(exc)
 
     if response.variations_result is None:
         raise ItemsNotFoundException("No variation items have been found")
@@ -117,23 +117,23 @@ def get_browse_nodes_request(amazon_api, **kwargs) -> GetBrowseNodesRequest:
         return GetBrowseNodesRequest(
             resources=_get_request_resources(GetBrowseNodesResource),
             partner_type=PartnerType.ASSOCIATES,
-            marketplace=amazon_api._marketplace,
-            partner_tag=amazon_api._tag,
-            **kwargs
+            marketplace=amazon_api.marketplace,
+            partner_tag=amazon_api.tag,
+            **kwargs,
         )
-    except TypeError as e:
+    except TypeError as exc:
         raise MalformedRequestException(
-            "Parameters for get_browse_nodes request are not correct: " + str(e)
-        )
+            f"Parameters for get_browse_nodes request are not correct: {exc}"
+        ) from exc
 
 
 def get_browse_nodes_response(
     amazon_api, request: GetBrowseNodesRequest
 ) -> List[BrowseNode]:
     try:
-        response = amazon_api._api.get_browse_nodes(request)
-    except ApiException as e:
-        _manage_response_exceptions(e)
+        response = amazon_api.api.get_browse_nodes(request)
+    except ApiException as exc:
+        _manage_response_exceptions(exc)
 
     if response.browse_nodes_result is None:
         raise ItemsNotFoundException("No browse nodes have been found")
@@ -142,7 +142,7 @@ def get_browse_nodes_response(
 
 
 def _get_request_resources(resources) -> List[str]:
-    resources = inspect.getmembers(resources, lambda a: not (inspect.isroutine(a)))
+    resources = inspect.getmembers(resources, lambda a: not inspect.isroutine(a))
     resources = [
         x[-1] for x in resources if isinstance(x[-1], str) and x[0][0:2] != "__"
     ]
@@ -157,16 +157,16 @@ def _manage_response_exceptions(error) -> None:
                 " trying again"
             )
 
-        elif "InvalidParameterValue" in error.body:
+        if "InvalidParameterValue" in error.body:
             raise InvalidArgumentException(
                 "The value provided in the request for atleast one parameter is"
                 " invalid."
             )
 
-        elif "InvalidPartnerTag" in error.body:
+        if "InvalidPartnerTag" in error.body:
             raise InvalidArgumentException("The partner tag is invalid or not present.")
 
-        elif "InvalidAssociate" in error.body:
+        if "InvalidAssociate" in error.body:
             raise AssociateValidationException(
                 "Used credentials are not valid for the selected country."
             )

amazon_paapi/models/item_result.py

@@ -2,8 +2,6 @@
 
 from ..sdk import models
 
-"""Shared models"""
-
 
 class ApiLabelLocale:
     label: str
@@ -55,9 +53,6 @@ class ApiPrice:
     price_type_label: str
 
 
-"""Image models"""
-
-
 class ApiImageSize(models.ImageSize):
     url: str
     height: str
@@ -75,9 +70,6 @@ class ApiImages(models.Images):
     variants: List[ApiImageType]
 
 
-"""Item info models"""
-
-
 class ApiByLineInfo(models.ByLineInfo):
     brand: ApiSingleStringValuedAttribute
     contributors: ApiSingleStringValuedAttribute
@@ -161,9 +153,6 @@ class ApiItemInfo(models.ItemInfo):
     trade_in_info: ApiTradeInInfo
 
 
-"""Offers model"""
-
-
 class ApiOfferAvailability(models.OfferAvailability):
     max_order_quantity: int
     message: str
@@ -247,9 +236,6 @@ class ApiOffers(models.Offers):
     listings: List[ApiListings]
 
 
-"""Browse node info model"""
-
-
 class ApiBrowseNode(models.BrowseNode):
     ancestor: str
     context_free_name: str
@@ -270,9 +256,6 @@ class ApiBrowseNodeInfo(models.BrowseNodeInfo):
     website_sales_rank: ApiWebsiteSalesRank
 
 
-"""Main model"""
-
-
 class Item(models.Item):
     asin: str
     browse_node_info: ApiBrowseNodeInfo

amazon_paapi/models/regions.py

@@ -1,4 +1,4 @@
-class Country(object):
+class Country:
     AU = "AU"
     BR = "BR"
     CA = "CA"
@@ -20,7 +20,6 @@ class Country(object):
     US = "US"
 
 
-"""Available regions for the Amazon API."""
 REGIONS = {
     "AU": "us-west-2",
     "BR": "us-east-1",
@@ -43,7 +42,7 @@ class Country(object):
     "US": "us-east-1",
 }
 
-"""Domains for each region on the Amazon API."""
+
 DOMAINS = {
     "AU": "com.au",
     "BR": "com.br",

amazon_paapi/models/search_result.py

@@ -1,10 +1,10 @@
 from typing import List
 
-from ..sdk.models import SearchResult
+from ..sdk import models as sdk_models
 from .item_result import Item
 
 
-class SearchResult(SearchResult):
+class SearchResult(sdk_models.SearchResult):
     items: List[Item]
     total_result_count: int
     search_url: str

amazon_paapi/models/variations_result.py

@@ -1,6 +1,6 @@
 from typing import List
 
-from ..sdk.models import VariationsResult, VariationSummary
+from ..sdk import models as sdk_models
 from .item_result import Item
 
 
@@ -21,13 +21,13 @@ class ApiVariationPrice:
     lowest_price: ApiPrice
 
 
-class ApiVariationSummary(VariationSummary):
+class ApiVariationSummary(sdk_models.VariationSummary):
     page_count: int
     price: ApiVariationPrice
     variation_count: int
     variation_dimensions: List[ApiVariationDimension]
 
 
-class VariationsResult(VariationsResult):
+class VariationsResult(sdk_models.VariationsResult):
     items: List[Item]
     variation_summary: ApiVariationSummary

examples/example.py

@@ -2,6 +2,7 @@
 
 from amazon_paapi import AmazonApi
 
+# pylint: disable=no-member
 amazon = AmazonApi(
     secrets.KEY, secrets.SECRET, secrets.TAG, secrets.COUNTRY, throttling=2
 )