Add support for mypy

Makefile

@@ -1,4 +1,4 @@
-.PHONY: run install dev lint test coverage check docker-test
+.PHONY: run install dev mypy lint test coverage check docker-test
 
 PACKAGE_DIR:=python_template_project
 
@@ -11,8 +11,12 @@ install:
 dev:
 	poetry install && poetry run pre-commit install
 
+mypy:
+	poetry run mypy $(PACKAGE_DIR) tests main.py
+
 lint:
-	poetry run flake8 $(PACKAGE_DIR) tests
+	$(MAKE) mypy
+	poetry run flake8 $(PACKAGE_DIR) tests main.py
 
 test:
 	poetry run pytest

pyproject.toml

@@ -7,6 +7,7 @@ authors = ["Audun Nes <REDACTED>"]
 [tool.poetry.dependencies]
 python = "^3.9"
 requests = "^2.25.1"
+types-requests = "^0.1.11"
 
 [tool.poetry.dev-dependencies]
 pytest = "^5.2"
@@ -16,6 +17,7 @@ pre-commit = "^2.13.0"
 pytest-cov = "^2.12.1"
 bandit = "^1.7.0"
 isort = "^5.8.0"
+mypy = "^0.902"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

python_template_project/demo.py

@@ -1,5 +1,7 @@
-import requests
+from typing import Dict, Optional
+
 from requests import Response
+from requests import get as requests_get
 
 API_URL: str = "http://api.icndb.com/jokes/random"
 
@@ -14,16 +16,21 @@ def __init__(self) -> None:
         pass
 
     @staticmethod
-    def _get_joke() -> dict:
+    def _get_joke() -> Optional[Dict]:
         """
         Get a random joke from the internet Chuck Norris database.
 
-        return: dict
+        return: Optional[Dict]
         """
-        response: Response = requests.get(API_URL)
-        return response.json()
+        response: Response = requests_get(API_URL)
+        joke: Optional[Dict] = response.json()
+        return joke
 
     def print_joke(self) -> None:
         """Print the joke to standard out."""
-        joke: dict = self._get_joke()
-        print(joke.get("value").get("joke"))
+        joke: Optional[Dict] = self._get_joke()
+        if joke is not None:
+            joke_value: Optional[Dict] = joke.get("value")
+        if joke_value is not None:
+            joke_msg: Optional[str] = joke_value.get("joke")
+        print(joke_msg)