Merge pull request #17 from fastapi-mvc/add_type_checking

Add type checking

Author: rszamszur

template/Makefile.jinja

@@ -37,7 +37,7 @@ image:  ## Build {{container_image_name}} image
 .PHONY: metrics
 metrics: install ## Run {{project_name}} metrics checks
 	echo "[metrics] Run {{project_name}} PEP 8 checks."
-	${POETRY_BINARY} run flake8 --select=E,W,I --max-line-length 80 --import-order-style pep8 --statistics --count {{package_name}}
+	${POETRY_BINARY} run flake8 --select=E,W,I --max-line-length 88 --import-order-style pep8 --statistics --count {{package_name}}
 	echo "[metrics] Run {{project_name}} PEP 257 checks."
 	${POETRY_BINARY} run flake8 --select=D --ignore D301 --statistics --count {{package_name}}
 	echo "[metrics] Run {{project_name}} pyflakes checks."
@@ -47,7 +47,7 @@ metrics: install ## Run {{project_name}} metrics checks
 	echo "[metrics] Run {{project_name}} open TODO checks."
 	${POETRY_BINARY} run flake8 --select=T --statistics --count {{package_name}} tests
 	echo "[metrics] Run {{project_name}} black checks."
-	${POETRY_BINARY} run black -l 80 --check {{package_name}}
+	${POETRY_BINARY} run black --check {{package_name}}
 
 .PHONY: unit-test
 unit-test: install ## Run {{project_name}} unit tests
@@ -71,6 +71,11 @@ test: unit-test integration-test  ## Run {{project_name}} tests
 docs: install ## Build {{project_name}} documentation
 	echo "[docs] Build {{project_name}} documentation."
 	${POETRY_BINARY} run sphinx-build docs site
+
+.PHONY: mypy
+mypy: install  ## Run {{project_name}} mypy checks
+	echo "[mypy] Run {{project_name}} mypy checks."
+	${POETRY_BINARY} run mypy {{package_name}}
 {% if helm %}
 .PHONY: dev-env
 dev-env: image ## Start a local Kubernetes cluster using minikube and deploy application

template/pyproject.toml.jinja

@@ -29,7 +29,7 @@ redis = "~4.5.1"
 aiohttp = "~3.8.4"
 {%- endif %}
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 pytest = "~7.2.1"
 pytest-cov = "~4.0.0"
 pytest-asyncio = "~0.20.3"
@@ -38,6 +38,7 @@ httpx = "~0.23.3"
 {%- if aiohttp %}
 aioresponses = "~0.7.3"
 {%- endif %}
+mypy = "~1.0.1"
 flake8 = "~5.0.4"
 flake8-docstrings = "~1.7.0"
 flake8-import-order = "~0.18.1"
@@ -67,3 +68,31 @@ omit = [
 exclude_lines = [
     "pass",
 ]
+
+[tool.mypy]
+exclude = [
+    "config/gunicorn.py"
+]
+python_version = '3.10'
+show_error_codes = true
+follow_imports = 'silent'
+strict_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+disallow_any_generics = true
+check_untyped_defs = true
+no_implicit_reexport = true
+warn_unused_configs = true
+disallow_subclassing_any = true
+disallow_incomplete_defs = true
+disallow_untyped_decorators = true
+disallow_untyped_calls = true
+disallow_untyped_defs = true
+implicit_optional = true
+
+[[tool.mypy.overrides]]
+module = [
+    "gunicorn.*",
+    "redis.*",
+]
+ignore_missing_imports = true

template/{% if github_actions %}.github{% endif %}/workflows/main.yml

@@ -13,6 +13,7 @@ env:
   POETRY_CONFIG_DIR: /opt/poetry
   POETRY_CACHE_DIR: /opt/poetry/cache
   POETRY_VIRTUALENVS_PATH: /opt/poetry/store
+  DEFAULT_PYTHON: '3.10'
 
 jobs:
   # This job checks if an identical workflow is being triggered by different
@@ -48,7 +49,7 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ${{ env.POETRY_HOME }}
-          key: ${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('./pyproject.toml') }}-{{ hashFiles('./poetry.lock') }}
+          key: ${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('./pyproject.toml') }}-${{ hashFiles('./poetry.lock') }}
       - name: Install package
         run: make install
         if: steps.cached-poetry.outputs.cache-hit != 'true'
@@ -58,15 +59,15 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Python 3.9
+      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
         uses: actions/setup-python@v4
         with:
-          python-version: 3.9
+          python-version: ${{ env.DEFAULT_PYTHON }}
       - name: Load Poetry cache
         uses: actions/cache@v3
         with:
           path: ${{ env.POETRY_HOME }}
-          key: ${{ runner.os }}-3.9-${{ hashFiles('./pyproject.toml') }}-{{ hashFiles('./poetry.lock') }}
+          key: ${{ runner.os }}-${{ env.DEFAULT_PYTHON }}-${{ hashFiles('./pyproject.toml') }}-${{ hashFiles('./poetry.lock') }}
       - name: Build wheel
         run: make build
       - name: Archive build artifacts
@@ -81,15 +82,15 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Python 3.9
+      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
         uses: actions/setup-python@v4
         with:
-          python-version: 3.9
+          python-version: ${{ env.DEFAULT_PYTHON }}
       - name: Load Poetry cache
         uses: actions/cache@v3
         with:
           path: ${{ env.POETRY_HOME }}
-          key: ${{ runner.os }}-3.9-${{ hashFiles('./pyproject.toml') }}-{{ hashFiles('./poetry.lock') }}
+          key: ${{ runner.os }}-${{ env.DEFAULT_PYTHON }}-${{ hashFiles('./pyproject.toml') }}-${{ hashFiles('./poetry.lock') }}
       - name: Run metrics checks
         run: make metrics
   unit-tests:
@@ -110,7 +111,7 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ${{ env.POETRY_HOME }}
-          key: ${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('./pyproject.toml') }}-{{ hashFiles('./poetry.lock') }}
+          key: ${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('./pyproject.toml') }}-${{ hashFiles('./poetry.lock') }}
       - name: Run unit tests
         run: make unit-test
   integration-tests:
@@ -131,7 +132,7 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ${{ env.POETRY_HOME }}
-          key: ${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('./pyproject.toml') }}-{{ hashFiles('./poetry.lock') }}
+          key: ${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('./pyproject.toml') }}-${{ hashFiles('./poetry.lock') }}
       - name: Run integration tests
         run: make integration-test
   coverage:
@@ -140,14 +141,31 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Python 3.9
+      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
         uses: actions/setup-python@v4
         with:
-          python-version: 3.9
+          python-version: ${{ env.DEFAULT_PYTHON }}
       - name: Load Poetry cache
         uses: actions/cache@v3
         with:
           path: ${{ env.POETRY_HOME }}
-          key: ${{ runner.os }}-3.9-${{ hashFiles('./pyproject.toml') }}-{{ hashFiles('./poetry.lock') }}
+          key: ${{ runner.os }}-${{ env.DEFAULT_PYTHON }}-${{ hashFiles('./pyproject.toml') }}-${{ hashFiles('./poetry.lock') }}
       - name: Run coverage
-        run: make coverage
+        run: make coverage
+  mypy:
+    needs: install
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+      - name: Load Poetry cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.POETRY_HOME }}
+          key: ${{ runner.os }}-${{ env.DEFAULT_PYTHON }}-${{ hashFiles('./pyproject.toml') }}-${{ hashFiles('./poetry.lock') }}
+      - name: Run mypy checks
+        run: make mypy

template/{% if github_actions %}.github{% endif %}/workflows/{% if nix %}nix.yml{% endif %}.jinja

@@ -53,6 +53,8 @@ jobs:
         run: nix flake check
       - name: Run metrics checks
         run: nix run .#metrics
+      - name: Run mypy checks
+        run: nix run .#mypy
       - name: Run tests
         run: nix run .#test
   nix-build:

template/{% if nix %}flake.nix{% endif %}.jinja

@@ -68,7 +68,7 @@
               echo "[nix][metrics] Run {{project_name}} open TODO checks."
               flake8 --select=T --statistics --count {{package_name}} tests
               echo "[nix][metrics] Run {{project_name}} black checks."
-              black -l 80 --check {{package_name}}
+              black --check {{package_name}}
             '');
           };
           docs = {
@@ -117,6 +117,17 @@
               pytest --cov={{package_name}} --cov-fail-under=90 --cov-report=xml --cov-report=term-missing tests
             '');
           };
+          mypy = {
+            type = "app";
+            program = toString (pkgs.writeScript "mypy" ''
+              export PATH="${pkgs.lib.makeBinPath [
+                  pkgs.{{project_name}}-dev
+                  pkgs.git
+              ]}"
+              echo "[nix][mypy] Run {{project_name}} mypy checks."
+              mypy {{package_name}}
+            '');
+          };
           test = {
             type = "app";
             program = toString (pkgs.writeScript "test" ''

template/{{package_name}}/app/asgi.py.jinja

@@ -20,7 +20,7 @@ from {{package_name}}.app.exceptions import (
 log = logging.getLogger(__name__)
 
 
-async def on_startup():
+async def on_startup() -> None:
     """Define FastAPI startup event handler.
 
     Resources:
@@ -43,7 +43,7 @@ async def on_startup():
     {%- endif %}
 
 
-async def on_shutdown():
+async def on_shutdown() -> None:
     """Define FastAPI shutdown event handler.
 
     Resources:
@@ -67,7 +67,7 @@ async def on_shutdown():
     {%- endif %}
 
 
-def get_application():
+def get_application() -> FastAPI:
     """Initialize FastAPI application.
 
     Returns:

template/{{package_name}}/app/controllers/ready.py.jinja

@@ -26,7 +26,7 @@ log = logging.getLogger(__name__)
     responses={502: {"model": ErrorResponse}},
     {%- endif %}
 )
-async def readiness_check():
+async def readiness_check() -> ReadyResponse:
     """Run basic application health check.
 
     If the application is up and running then this endpoint will return simple
@@ -50,9 +50,9 @@ async def readiness_check():
         log.error("Could not connect to Redis")
         raise HTTPException(
             status_code=502,
-            content=ErrorResponse(
-                code=502, message="Could not connect to Redis"
-            ).dict(exclude_none=True),
+            content=ErrorResponse(code=502, message="Could not connect to Redis").dict(
+                exclude_none=True
+            ),
         )
 {% else %}
     if settings.USE_REDIS:

template/{{package_name}}/app/exceptions/http.py

@@ -36,7 +36,7 @@ def __init__(
         self.content = content
         self.headers = headers
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         """Class custom __repr__ method implementation.
 
         Returns:
@@ -52,7 +52,9 @@ def __repr__(self):
         return f"{self.__class__.__name__}({', '.join(kwargs)})"
 
 
-async def http_exception_handler(request: Request, exception: HTTPException):
+async def http_exception_handler(
+    request: Request, exception: HTTPException
+) -> JSONResponse:
     """Define custom HTTPException handler.
 
     In this application custom handler is added in asgi.py while initializing