Setup mypy (#73)

* Setup mypy

* Add py.typed

Author: florimondmanca

.travis.yml

@@ -14,7 +14,7 @@ jobs:
   include:
     - name: Check
       python: "3.6"
-      install: pip install -U black
+      install: pip install -U black mypy
       script: scripts/check
 
 install:

mypy.ini

@@ -0,0 +1,3 @@
+[mypy]
+files = rest_framework_api_key
+ignore_missing_imports = True

pyproject.toml

@@ -9,6 +9,10 @@ readme = "README.md"
 repository = "https://github.com/florimondmanca/djangorestframework-api-key"
 homepage = "https://florimondmanca.github.io/djangorestframework-api-key/"
 documentation = "https://florimondmanca.github.io/djangorestframework-api-key/"
+packages = [
+  { include = "rest_framework_api_key" }
+]
+include = ["rest_framework_api_key/py.typed"]
 license = "MIT"
 classifiers=[
   "Development Status :: 4 - Beta",

rest_framework_api_key/admin.py

@@ -17,8 +17,10 @@ class APIKeyModelAdmin(admin.ModelAdmin):
     list_filter = ("created",)
     search_fields = ("name", "prefix")
 
-    def get_readonly_fields(self, request, obj: APIKey = None) -> typing.Tuple[str]:
-        fields = ("prefix",)
+    def get_readonly_fields(
+        self, request, obj: APIKey = None
+    ) -> typing.Tuple[str, ...]:
+        fields = ("prefix",)  # type: typing.Tuple[str, ...]
         if obj is not None and obj.revoked:
             fields = fields + ("name", "revoked", "expiry_date")
         return fields

rest_framework_api_key/migrations/0001_initial.py

@@ -7,7 +7,7 @@ class Migration(migrations.Migration):
 
     initial = True
 
-    dependencies = []
+    dependencies = []  # type: ignore
 
     operations = [
         migrations.CreateModel(

rest_framework_api_key/models.py

@@ -14,7 +14,7 @@ def assign_key(self, obj: "AbstractAPIKey") -> str:
         try:
             key, prefix, hashed_key = self.key_generator.generate()
         except ValueError:  # Compatibility with < 1.4
-            key, hashed_key = self.key_generator.generate()
+            key, hashed_key = self.key_generator.generate()  # type: ignore
             pk = hashed_key
             prefix, hashed_key = split(hashed_key)
         else:
@@ -108,8 +108,8 @@ def _has_expired(self) -> bool:
             return False
         return self.expiry_date < timezone.now()
 
-    _has_expired.short_description = "Has expired"
-    _has_expired.boolean = True
+    _has_expired.short_description = "Has expired"  # type: ignore
+    _has_expired.boolean = True  # type: ignore
     has_expired = property(_has_expired)
 
     def is_valid(self, key: str) -> bool:

rest_framework_api_key/permissions.py

@@ -6,6 +6,9 @@
 
 from .models import AbstractAPIKey, APIKey
 
+if typing.TYPE_CHECKING:
+    from django.db import models
+
 
 class KeyParser:
     def get(self, request: HttpRequest) -> typing.Optional[str]:
@@ -34,7 +37,7 @@ def get_from_header(self, request: HttpRequest, name: str) -> typing.Optional[st
 
 
 class BaseHasAPIKey(permissions.BasePermission):
-    model = None
+    model = None  # type: typing.Type[models.Model]
     key_parser = KeyParser()
 
     def get_key(self, request: HttpRequest) -> typing.Optional[str]:

rest_framework_api_key/py.typed

@@ -1,4 +1,3 @@
 #!/bin/sh -e
-set -x
-
 black --check --target-version=py35 rest_framework_api_key tests
+mypy

scripts/check

@@ -1,4 +1,2 @@
 #!/bin/sh -e
-set -x
-
 black --target-version=py35 rest_framework_api_key tests