Add type hints to complete developer interface (#7)

Author: mawassk

Makefile

@@ -11,7 +11,7 @@ lint: # Run code linters
 	isort --profile black --check --diff .
 	black --check --diff --color .
 	flake8 --max-line-length 88 --max-complexity 8 --select C,E,F,W,B,B950,S --ignore E203,E501 ninja_apikey
-#	TODO: mypy ninja_apikey
+	mypy --strict ninja_apikey/security.py
 
 test: # Run tests
 	pytest --ds=sample_project.settings -v sample_project ninja_apikey/tests.py

ninja_apikey/admin.py

@@ -4,7 +4,7 @@
 from .security import generate_key
 
 
-@admin.action(description="Revoke selected API keys")
+@admin.action(description="Revoke selected API keys")  # type: ignore
 def revoke_key(modeladmin, request, queryset):
     queryset.update(revoked=True)
 
@@ -24,7 +24,7 @@ class APIKeyAdmin(admin.ModelAdmin):
     actions = [revoke_key]
     list_filter = ["revoked"]
 
-    @admin.display
+    @admin.display  # type: ignore
     def is_active(self, obj: APIKey):
         return obj.is_valid
 

ninja_apikey/models.py

@@ -1,3 +1,4 @@
+# type: ignore
 from django.contrib.auth import get_user_model
 from django.db import models
 from django.utils import timezone

ninja_apikey/security.py

@@ -1,10 +1,12 @@
 from collections import namedtuple
+from typing import Any, Optional
 
 from django.contrib.auth.hashers import check_password, make_password
+from django.http import HttpRequest
 from django.utils.crypto import get_random_string
 from ninja.security import APIKeyHeader
 
-from .models import APIKey
+from .models import APIKey  # type: ignore
 
 KeyData = namedtuple("KeyData", "prefix key hashed_key")
 
@@ -16,7 +18,7 @@ def generate_key() -> KeyData:
     return KeyData(prefix, key, hashed_key)
 
 
-def check_apikey(api_key: str):
+def check_apikey(api_key: str) -> Any:
     if not api_key:
         return False
 
@@ -53,7 +55,10 @@ def check_apikey(api_key: str):
 class APIKeyAuth(APIKeyHeader):
     param_name = "X-API-Key"
 
-    def authenticate(self, request, key):
+    def authenticate(self, request: HttpRequest, key: Optional[str]) -> Any:
+        if not key:
+            return False
+
         user = check_apikey(key)
 
         if not user:

pyproject.toml

@@ -53,4 +53,5 @@ test = [
     "flake8-bugbear",
     "flake8-bandit",
     "mypy",
+    "django-stubs",
     ]