Merge pull request #8 from Natim/add-flake8

Add flake8

Author: olance

.pre-commit-config.yaml

@@ -22,3 +22,10 @@ repos:
     rev: v4.3.21
     hooks:
       - id: isort
+
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.7.9
+    hooks:
+      - id: flake8
+        args: [--max-line-length=99]
+        language_version: python3.7

Makefile

@@ -42,6 +42,9 @@ black: install-dev
 isort: install-dev
 	$(VENV)/bin/isort --recursive setup.py alma
 
+flake8: install-dev
+	$(VENV)/bin/flake8 setup.py alma
+
 build-requirements:
 	$(VIRTUALENV) $(TEMPDIR)
 	$(TEMPDIR)/bin/pip install -U pip

alma/__init__.py

@@ -1,7 +1,9 @@
+# flake8: noqa
+
+import pkg_resources
+
 from . import endpoints, entities
 from .api_modes import ApiModes
 from .client import Client
 
-import pkg_resources
-
 __version__ = pkg_resources.get_distribution(__package__).version

alma/client.py

@@ -23,7 +23,10 @@ def __init__(self, api_key, **options):
         }
 
         if type(options["api_root"]) is str:
-            options["api_root"] = {ApiModes.TEST: options["api_root"], ApiModes.LIVE: options["api_root"]}
+            options["api_root"] = {
+                ApiModes.TEST: options["api_root"],
+                ApiModes.LIVE: options["api_root"],
+            }
         elif type(options["api_root"]) is not dict:
             raise TypeError("`api_root` option must be a dict or a string")
 

alma/endpoints/__init__.py

@@ -1,3 +1,5 @@
+# flake8: noqa
+
 from .base import Base
 from .merchants import Merchants
 from .orders import Orders

alma/endpoints/payments.py

@@ -51,14 +51,17 @@ def add_orders_to(self, payment_id, order_data: Union[List[dict], dict]) -> List
         Adds one or several orders to the given payment
 
         :param payment_id: ID of the payment to add the order(s) to
-        :param order_data: Either a dict of attributes for a single order, or a list of such dicts for several
+        :param order_data: Either a dict of attributes for a single order,
+                           or a list of such dicts for several
         :return: List of Order instances that were added to the payment
         """
         if type(order_data) is dict:
             order_data = [order_data]
 
         response = (
-            self.request(f"{self.PAYMENTS_PATH}/{payment_id}/orders").set_body({"orders": order_data}).put()
+            self.request(f"{self.PAYMENTS_PATH}/{payment_id}/orders")
+            .set_body({"orders": order_data})
+            .put()
         )
 
         return [Order(o) for o in response.json]
@@ -68,14 +71,17 @@ def set_orders_for(self, payment_id, order_data: Union[List[dict], dict]) -> Lis
         Sets one or several orders on the given payment (replacing existing ones)
 
         :param payment_id: ID of the payment to add the order(s) to
-        :param order_data: Either a dict of attributes for a single order, or a list of such dicts for several
+        :param order_data: Either a dict of attributes for a single order,
+                           or a list of such dicts for several
         :return: List of Order instances that were added to the payment
         """
         if type(order_data) is dict:
             order_data = [order_data]
 
         response = (
-            self.request(f"{self.PAYMENTS_PATH}/{payment_id}/orders").set_body({"orders": order_data}).post()
+            self.request(f"{self.PAYMENTS_PATH}/{payment_id}/orders")
+            .set_body({"orders": order_data})
+            .post()
         )
 
         return [Order(o) for o in response.json]
@@ -86,12 +92,14 @@ def get_orders_for(self, payment_id) -> List[Order]:
 
     def refund(self, payment_id: str, amount: int, full_refund: bool = False, **params) -> Payment:
         """
-        Refunds given payment of the given amount (in cents). If `full_refund` is `True`, `amount` is ignored
+        Refunds given payment of the given amount (in cents).
+        If `full_refund` is `True`, `amount` is ignored
         to trigger a full refund of the payment, including potential customer fees.
 
         :param payment_id: ID of the payment to refund
         :param amount: Amount, in cents, to be refunded on the payment
-        :param full_refund: True if the full payment should be refunded (with customer fees). Default: false.
+        :param full_refund: True if the full payment should be refunded (with customer fees).
+                            Default: false.
         :return: Updated payment object
         """
         req = self.request(f"{self.PAYMENTS_PATH}/{payment_id}/refund")
@@ -109,8 +117,8 @@ def send_sms(self, payment_id: str):
         """
         Sends a payment link via SMS, to the customer's saved mobile phone number.
 
-        Will raise RequestError if the SMS API is not activated on your account or in case of any other error,
-        otherwise returns True.
+        Will raise RequestError if the SMS API is not activated on your account or
+        in case of any other error, otherwise returns True.
         """
         self.request(f"{self.PAYMENTS_PATH}/{payment_id}/send-sms").post()
 

alma/entities/__init__.py

@@ -1,3 +1,5 @@
+# flake8: noqa
+
 from .base import Base
 from .eligibility import Eligibility
 from .installment import Installment, InstallmentState

alma/entities/installment.py

@@ -18,7 +18,8 @@ def __init__(self, data):
             try:
                 self.state = InstallmentState(state)
             except ValueError:
-                # Pass on unrecognized state values - they will be accessible as-is in the Installment data
+                # Pass on unrecognized state values
+                # they will be accessible as-is in the Installment data
                 pass
 
         super(Installment, self).__init__(data)

alma/entities/payment.py

@@ -27,8 +27,8 @@ class PaymentState(Enum):
     LATE_DUNNING = "late_dunning"
     # Next installment is very late, between 8 and 15 days. Contacting customer with email and SMS
     LATE_CONTACT_CUSTOMER = "late_contact_customer"
-    # More than 15 days late, payment is considered in default: (i) claim is opened and (ii) payments
-    # switches to judiciary collection
+    # More than 15 days late, payment is considered in default:
+    # (i) claim is opened and (ii) payments switches to judiciary collection
     DEFAULT = "default"
     # After default, we may recover part of the payment through judiciary collection.
     # Once collection has been completed, this stage is reached and nothing happens anymore
@@ -50,7 +50,8 @@ def __init__(self, data):
             try:
                 self.state = PaymentState(state)
             except ValueError:
-                # Pass on unrecognized state values - they will be accessible as-is in the Payment data
+                # Pass on unrecognized state values
+                # they will be accessible as-is in the Payment data
                 pass
 
         orders = data.pop("orders", [])

alma/paginated_results.py

@@ -5,7 +5,9 @@
 
 
 class PaginatedResults(Sequence, Iterable):
-    def __init__(self, data: dict, entity: Union[None, Type[BaseEntity]], next_page: Union[None, Callable]):
+    def __init__(
+        self, data: dict, entity: Union[None, Type[BaseEntity]], next_page: Union[None, Callable]
+    ):
         self._data = data
         self._entities = [entity(d) for d in data.get("data", [])]
         self._next_page = next_page