Merge pull request #10 from Natim/add-mypy

Natim · web-flow · commit f4b38265636e · 2020-01-31T17:52:01.000+01:00
Add mypy
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -29,3 +29,8 @@ repos:
       - id: flake8
         args: [--max-line-length=99]
         language_version: python3.7
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v0.761'
+    hooks:
+    -   id: mypy
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,13 @@
+dist: bionic
+language: python
+cache: pip
+install: pip install tox tox-travis
+script: tox -v
+python:
+- 3.7
+- 3.8
+matrix:
+  fast_finish: true
+  include:
+  - python: 3.8
+    env: TOXENV=flake8
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,4 +7,3 @@
 - Handle the refund endpoint
 - Handle pagination for orders
 - Handle the send-sms API for payments.
-
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1 @@
+include README.md CHANGELOG.md tox.ini Makefile LICENSE
diff --git a/Makefile b/Makefile
@@ -40,10 +40,13 @@ black: install-dev
 	$(VENV)/bin/black setup.py alma
 
 isort: install-dev
-	$(VENV)/bin/isort --recursive setup.py alma
+	$(VENV)/bin/isort --recursive setup.py alma tests
 
 flake8: install-dev
-	$(VENV)/bin/flake8 setup.py alma
+	$(VENV)/bin/flake8 setup.py alma tests
+
+mypy: install-dev
+	$(VENV)/bin/mypy --ignore-missing-imports --scripts-are-modules alma
 
 build-requirements:
 	$(VIRTUALENV) $(TEMPDIR)
diff --git a/alma/__init__.py b/alma/__init__.py
@@ -1,9 +1,5 @@
-# flake8: noqa
-
-import pkg_resources
-
-from . import endpoints, entities
 from .api_modes import ApiModes
 from .client import Client
+from .version import __version__
 
-__version__ = pkg_resources.get_distribution(__package__).version
+__all__ = ["Client", "ApiModes", "__version__"]
diff --git a/alma/client.py b/alma/client.py
@@ -1,10 +1,10 @@
 import logging
 import platform
 
-from . import __version__ as alma_version
 from . import endpoints
 from .api_modes import ApiModes
 from .context import Context
+from .version import __version__ as alma_version
 
 
 class Client:
diff --git a/alma/endpoints/orders.py b/alma/endpoints/orders.py
@@ -13,7 +13,7 @@ def update(self, order_id, data):
         return Order(response.json)
 
     def fetch_all(self, limit: int = 20, starting_after: str = None, **filters):
-        args = {"limit": limit}
+        args = {"limit": str(limit)}
 
         if starting_after:
             args["starting_after"] = starting_after
diff --git a/alma/endpoints/payments.py b/alma/endpoints/payments.py
@@ -19,7 +19,7 @@ def create(self, data):
         return Payment(response.json)
 
     def fetch_all(self, limit: int = 20, states: list = None, starting_after: str = None):
-        args = {"limit": limit}
+        args = {"limit": str(limit)}
         if starting_after:
             args["starting_after"] = starting_after
         if states:
@@ -55,7 +55,7 @@ def add_orders_to(self, payment_id, order_data: Union[List[dict], dict]) -> List
                            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:
+        if isinstance(order_data, dict):
             order_data = [order_data]
 
         response = (
@@ -75,7 +75,7 @@ def set_orders_for(self, payment_id, order_data: Union[List[dict], dict]) -> Lis
                            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:
+        if isinstance(order_data, dict):
             order_data = [order_data]
 
         response = (
diff --git a/alma/entities/eligibility.py b/alma/entities/eligibility.py
@@ -1,4 +1,4 @@
-from . import Base
+from .base import Base
 
 
 class Eligibility(Base):
diff --git a/alma/entities/order.py b/alma/entities/order.py
@@ -1,4 +1,4 @@
-from . import Base
+from .base import Base
 
 
 class Order(Base):
diff --git a/alma/entities/payment.py b/alma/entities/payment.py
@@ -1,6 +1,9 @@
 from enum import Enum
 
-from . import Base, Installment, Order, Refund
+from .base import Base
+from .installment import Installment
+from .order import Order
+from .refund import Refund
 
 
 class PaymentState(Enum):
diff --git a/alma/paginated_results.py b/alma/paginated_results.py
@@ -1,13 +1,11 @@
-from collections.abc import Iterable, Sequence
-from typing import Callable, Type, Union
+from collections.abc import Iterable
+from typing import Callable, Type
 
 from alma.entities import Base as BaseEntity
 
 
-class PaginatedResults(Sequence, Iterable):
-    def __init__(
-        self, data: dict, entity: Union[None, Type[BaseEntity]], next_page: Union[None, Callable]
-    ):
+class PaginatedResults(Iterable):
+    def __init__(self, data: dict, entity: Type[BaseEntity], next_page: Callable):
         self._data = data
         self._entities = [entity(d) for d in data.get("data", [])]
         self._next_page = next_page
diff --git a/alma/version.py b/alma/version.py
@@ -0,0 +1,3 @@
+import pkg_resources
+
+__version__ = pkg_resources.get_distribution("alma-client").version
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -1,4 +1,10 @@
 black
+flake8
 isort
+mypy
 pytest
-flake8
+pytest-cache
+pytest-cov
+pytest-sugar
+pytest-xdist
+tox
diff --git a/tests/test_client.py b/tests/test_client.py
@@ -0,0 +1,20 @@
+from unittest import TestCase
+
+import pytest
+from alma import Client
+
+
+class ClientTest(TestCase):
+    def test_client_raises_with_no_api_key_arguments(self):
+        with pytest.raises(
+            TypeError, match=r"__init__\(\) missing 1 required positional argument: 'api_key'"
+        ):
+            Client()
+
+    def test_client_raises_with_empty_api_key_value(self):
+        with pytest.raises(ValueError, match=r"An API key is required"):
+            Client(api_key="")
+
+    def test_client_raises_with_empty_api_key_set_to_None(self):
+        with pytest.raises(ValueError, match=r"An API key is required"):
+            Client(api_key=None)
diff --git a/tox.ini b/tox.ini
@@ -3,7 +3,8 @@ envlist = py37,py38,flake8
 
 [testenv]
 commands =
-    pytest tests --cov-report term-missing --cov-fail-under 100 --cov alma {posargs}
+    mypy --ignore-missing-imports --scripts-are-modules alma
+    pytest tests --cov-report term-missing --cov alma {posargs} # --cov-fail-under 100
 deps = -rdev-requirements.txt
 install_command = pip install {opts} {packages}
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+include README.md CHANGELOG.md tox.ini Makefile LICENSE`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-from . import Base`
	`1`	`+from .base import Base`
`2`	`2`
`3`	`3`
`4`	`4`	`class Eligibility(Base):`