Merge pull request #116 from sergioteula/clean-code

Clean code

Author: sergioteula

.github/workflows/codecov-upload.yml

@@ -1,27 +1,27 @@
-# This workflow will upload a Python Package using Twine when a release is created
-# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
-
 name: Upload Python Package
 
 on:
   release:
     types: [created]
 
 jobs:
-  deploy:
 
+  deploy:
     runs-on: ubuntu-latest
-
     steps:
-    - uses: actions/checkout@v2
+    - name: Check out code
+      uses: actions/checkout@v3
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: '3.x'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install setuptools wheel twine
+    - name: Update version number
+      run: |
+        sed -i 's/<PACKAGE_VERSION>/${{ github.ref_name }}/' setup.py
     - name: Build and publish
       env:
         TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}

.github/workflows/python-publish.yml

@@ -1,18 +1,18 @@
 # Amazon Product Advertising API 5.0 wrapper for Python
 
-A simple Python wrapper for the [last version of the Amazon Product Advertising API](https://webservices.amazon.com/paapi5/documentation/quick-start/using-sdk.html). This module allows interacting with Amazon using the official API in an easier way.
+A simple Python wrapper for the [last version of the Amazon Product Advertising
+API](https://webservices.amazon.com/paapi5/documentation/quick-start/using-sdk.html).
+This module allows interacting with Amazon using the official API in an easier way.
 
 [![PyPI](https://img.shields.io/pypi/v/python-amazon-paapi?color=%231182C2&label=PyPI)](https://pypi.org/project/python-amazon-paapi/)
 [![Python](https://img.shields.io/badge/Python->3.6-%23FFD140)](https://www.python.org/)
 [![License](https://img.shields.io/badge/License-MIT-%23e83633)](https://github.com/sergioteula/python-amazon-paapi/blob/master/LICENSE)
 [![Amazon API](https://img.shields.io/badge/Amazon%20API-5.0-%23FD9B15)](https://webservices.amazon.com/paapi5/documentation/)
-[![Codecov](https://img.shields.io/codecov/c/github/sergioteula/python-amazon-paapi?label=Coverage)](https://app.codecov.io/gh/sergioteula/python-amazon-paapi/)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=sergioteula_python-amazon-paapi&metric=coverage)](https://sonarcloud.io/summary/new_code?id=sergioteula_python-amazon-paapi)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=sergioteula_python-amazon-paapi&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=sergioteula_python-amazon-paapi)
 [![Support](https://img.shields.io/badge/Support-Good-brightgreen)](https://github.com/sergioteula/python-amazon-paapi/issues)
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/python-amazon-paapi?label=Installs)](https://pypi.org/project/python-amazon-paapi/)
 
-> If you are still using the old version, go [here](https://github.com/sergioteula/python-amazon-paapi/blob/master/amazon/README.md) for documentation or check our
-[migration guide](https://github.com/sergioteula/python-amazon-paapi/blob/master/docs/pages/migration-guide.md).
-
 ## Features
 
 - Object oriented interface for simple usage.
@@ -92,7 +92,8 @@ asin = get_asin('https://www.amazon.com/dp/B01N5IB20Q')
 
 **Throttling:**
 
-Throttling value represents the wait time in seconds between API calls, being the default value 1 second. Use it to avoid reaching Amazon request limits.
+Throttling value represents the wait time in seconds between API calls, being the
+default value 1 second. Use it to avoid reaching Amazon request limits.
 
 ```python
 amazon = AmazonApi(KEY, SECRET, TAG, COUNTRY, throttling=4)  # Makes 1 request every 4 seconds
@@ -101,12 +102,20 @@ amazon = AmazonApi(KEY, SECRET, TAG, COUNTRY, throttling=0)  # No wait time betw
 
 ## Contribution
 
-Activate githooks with:
+Creating pull requests for this repo is higly appreciated to add new features or solve
+bugs. To help during development process, githooks can be activated to run some scripts
+before pushing new commits. This will run checks for code format and tests, to ensure
+everything follows this repo guidelines. Use next command to activate them:
 
 ```
 git config core.hooksPath .githooks
 ```
 
+The same checks will also run on the repo with GitHub Actions to ensure all tests pass
+before merge.
+
 ## License
 
-Copyright © 2021 Sergio Abad. See [license](https://github.com/sergioteula/python-amazon-paapi/blob/master/LICENSE) for details.
+Copyright © 2021 Sergio Abad. See
+[license](https://github.com/sergioteula/python-amazon-paapi/blob/master/LICENSE) for
+details.

README.md

@@ -7,7 +7,7 @@
 from typing import List, Union
 
 from . import models
-from .errors import InvalidArgumentException
+from .errors import InvalidArgument
 from .helpers import arguments, requests
 from .helpers.generators import get_list_chunks
 from .helpers.items import sort_items
@@ -50,7 +50,7 @@ def __init__(
             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
+            raise InvalidArgument("Country code is not correct") from error
 
         self.api = DefaultApi(key, secret, self._host, self.region)
 

amazon_paapi/api.py

@@ -1,23 +1,23 @@
 from .exceptions import (
-    AmazonException,
-    ApiRequestException,
-    AsinNotFoundException,
-    AssociateValidationException,
-    InvalidArgumentException,
-    InvalidPartnerTagException,
-    ItemsNotFoundException,
-    MalformedRequestException,
-    TooManyRequestsException,
+    AmazonError,
+    AsinNotFound,
+    AssociateValidationError,
+    InvalidArgument,
+    InvalidPartnerTag,
+    ItemsNotFound,
+    MalformedRequest,
+    RequestError,
+    TooManyRequests,
 )
 
 __all__ = [
-    "AmazonException",
-    "ApiRequestException",
-    "AsinNotFoundException",
-    "AssociateValidationException",
-    "InvalidArgumentException",
-    "InvalidPartnerTagException",
-    "ItemsNotFoundException",
-    "MalformedRequestException",
-    "TooManyRequestsException",
+    "AmazonError",
+    "AsinNotFound",
+    "AssociateValidationError",
+    "InvalidArgument",
+    "InvalidPartnerTag",
+    "ItemsNotFound",
+    "MalformedRequest",
+    "RequestError",
+    "TooManyRequests",
 ]

amazon_paapi/errors/__init__.py

@@ -1,7 +1,7 @@
 """Custom exceptions module"""
 
 
-class AmazonException(Exception):
+class AmazonError(Exception):
     """Common base class for all Amazon API exceptions."""
 
     def __init__(self, reason: str):
@@ -12,33 +12,33 @@ def __str__(self) -> str:
         return self.reason
 
 
-class InvalidArgumentException(AmazonException):
-    """Raised when arguments are not correct."""
+class AsinNotFound(AmazonError):
+    """Raised if the ASIN for an item is not found."""
 
 
-class AsinNotFoundException(AmazonException):
-    """Raised if the ASIN for an item is not found."""
+class AssociateValidationError(AmazonError):
+    """Raised when credentials are not valid for the selected country."""
 
 
-class ApiRequestException(AmazonException):
-    """Raised if the request to Amazon API fails"""
+class InvalidArgument(AmazonError):
+    """Raised when arguments are not correct."""
 
 
-class MalformedRequestException(AmazonException):
-    """Raised if the request for Amazon API is not correctly formed"""
+class InvalidPartnerTag(AmazonError):
+    """Raised if the partner tag is not present or invalid."""
 
 
-class ItemsNotFoundException(AmazonException):
-    """Raised if no items are found"""
+class ItemsNotFound(AmazonError):
+    """Raised if no items are found."""
 
 
-class TooManyRequestsException(AmazonException):
-    """Raised when requests limit is reached"""
+class MalformedRequest(AmazonError):
+    """Raised if the request for Amazon API is not correctly formed."""
 
 
-class InvalidPartnerTagException(AmazonException):
-    """Raised if the partner tag is not present or invalid"""
+class RequestError(AmazonError):
+    """Raised if the request to Amazon API fails."""
 
 
-class AssociateValidationException(AmazonException):
-    """Raised when credentials are not valid for the selected country"""
+class TooManyRequests(AmazonError):
+    """Raised when requests limit is reached."""

amazon_paapi/errors/exceptions.py

@@ -3,13 +3,13 @@
 
 from typing import List, Union
 
-from ..errors import AsinNotFoundException, InvalidArgumentException
+from ..errors import InvalidArgument
 from ..tools import get_asin
 
 
 def get_items_ids(items: Union[str, List[str]]) -> List[str]:
     if not isinstance(items, str) and not isinstance(items, List):
-        raise InvalidArgumentException(
+        raise InvalidArgument(
             "Invalid items argument, it should be a string or List of strings"
         )
 
@@ -20,63 +20,60 @@ def get_items_ids(items: Union[str, List[str]]) -> List[str]:
     else:
         items_ids = [get_asin(x.strip()) for x in items]
 
-    if items_ids:
-        return items_ids
-
-    raise AsinNotFoundException("No ASIN codes have been found.")
+    return items_ids
 
 
 def check_search_args(**kwargs):
-    _check_search_mandatory_args(**kwargs)
-    _check_search_pagination_args(**kwargs)
+    check_search_mandatory_args(**kwargs)
+    check_search_pagination_args(**kwargs)
 
 
-def _check_search_mandatory_args(**kwargs):
+def check_search_mandatory_args(**kwargs):
     mandatory_args = [
-        kwargs["keywords"],
-        kwargs["actor"],
-        kwargs["artist"],
-        kwargs["author"],
-        kwargs["brand"],
-        kwargs["title"],
-        kwargs["browse_node_id"],
-        kwargs["search_index"],
+        kwargs.get("keywords"),
+        kwargs.get("actor"),
+        kwargs.get("artist"),
+        kwargs.get("author"),
+        kwargs.get("brand"),
+        kwargs.get("title"),
+        kwargs.get("browse_node_id"),
+        kwargs.get("search_index"),
     ]
     if all(arg is None for arg in mandatory_args):
         error_message = (
             "At least one of the following args should be provided: keywords, actor,"
             " artist, author, brand, title, browse_node_id or search_index."
         )
-        raise InvalidArgumentException(error_message)
+        raise InvalidArgument(error_message)
 
 
-def _check_search_pagination_args(**kwargs):
+def check_search_pagination_args(**kwargs):
     error_message = "Args item_count and item_page should be integers between 1 and 10."
-    pagination_args = [kwargs["item_count"], kwargs["item_page"]]
+    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 InvalidArgumentException(error_message)
+        raise InvalidArgument(error_message)
 
     if not all(1 <= arg <= 10 for arg in pagination_args):
-        raise InvalidArgumentException(error_message)
+        raise InvalidArgument(error_message)
 
 
 def check_variations_args(**kwargs):
     error_message = (
         "Args variation_count and variation_page should be integers between 1 and 10."
     )
-    variation_args = [kwargs["variation_count"], kwargs["variation_page"]]
+    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 InvalidArgumentException(error_message)
+        raise InvalidArgument(error_message)
 
     if not all(1 <= arg <= 10 for arg in variation_args):
-        raise InvalidArgumentException(error_message)
+        raise InvalidArgument(error_message)
 
 
 def check_browse_nodes_args(**kwargs):
-    if not isinstance(kwargs["browse_node_ids"], List):
+    if not isinstance(kwargs.get("browse_node_ids"), List):
         error_message = "Argument browse_node_ids should be a List of strings."
-        raise InvalidArgumentException(error_message)
+        raise InvalidArgument(error_message)