Merge pull request #90 from HackSoftware/add-django-stubs

mypy / django-stubs support

Author: RadoRado

.github/workflows/django.yml

@@ -24,7 +24,8 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -r requirements/local.txt
-        pip install -r requirements/tests.txt
+    - name: Type check
+      run: mypy styleguide_example/
     - name: Run migrations
       run: python manage.py migrate
     - name: Run tests

README.md

@@ -22,6 +22,9 @@ Few important things:
 * It comes with [`whitenoise`](http://whitenoise.evans.io/en/stable/) setup.
 * It can be easily deployed to Heroku.
 * It comes with an example list API, that uses [`django-filter`](https://django-filter.readthedocs.io/en/stable/) for filtering & pagination from DRF.
+* It comes with [`mypy`](https://mypy.readthedocs.io/en/stable/) configured, using both <https://github.com/typeddjango/django-stubs> and <https://github.com/typeddjango/djangorestframework-stubs/>
+  * Basic `mypy` configuration is located in [`setup.cfg`](setup.cfg)
+  * `mypy` is ran as a build step in [`.github/workflows/django.yml`](.github/workflows/django.yml)
 
 ## General API Stuff
 

requirements/local.txt

@@ -2,6 +2,15 @@
 
 pytest==6.2.5
 pytest-django==4.5.2
+
+factory-boy==3.2.1
+Faker==11.3.0
+
 flake8==4.0.1
+
 ipdb==0.13.9
 ipython==7.31.0
+
+mypy==0.931
+django-stubs==1.9.0
+djangorestframework-stubs==1.4.0

requirements/tests.txt

@@ -4,3 +4,39 @@ exclude =
     .git,
     __pycache__,
     */migrations/*
+
+[mypy]
+plugins =
+    mypy_django_plugin.main,
+    mypy_drf_plugin.main
+
+[mypy.plugins.django-stubs]
+django_settings_module = "config.django.base"
+
+[mypy-config.*]
+# Ignore everything related to Django config
+ignore_errors = true
+
+[mypy-styleguide_example.*.migrations.*]
+# Ignore Django migrations
+ignore_errors = true
+
+[mypy-celery.*]
+# Remove this when celery stubs are present
+ignore_missing_imports = True
+
+[mypy-django_celery_beat.*]
+# Remove this when django_celery_beat stubs are present
+ignore_missing_imports = True
+
+[mypy-django_filters.*]
+# Remove this when django_filters stubs are present
+ignore_missing_imports = True
+
+[mypy-factory.*]
+# Remove this when factory stubs are present
+ignore_missing_imports = True
+
+[mypy-rest_framework_jwt.*]
+# Remove this when rest_framework_jwt stubs are present
+ignore_missing_imports = True

setup.cfg

@@ -1,10 +1,12 @@
+from typing import Sequence, Type, TYPE_CHECKING
+
 from importlib import import_module
 
 from django.conf import settings
 
 from django.contrib import auth
 
-from rest_framework.permissions import IsAuthenticated
+from rest_framework.permissions import IsAuthenticated, BasePermission
 from rest_framework.authentication import SessionAuthentication, BaseAuthentication
 
 from rest_framework_jwt.authentication import JSONWebTokenAuthentication
@@ -60,10 +62,20 @@ def enforce_csrf(self, request):
         return
 
 
+if TYPE_CHECKING:
+    # This is going to be resolved in the stub library
+    # https://github.com/typeddjango/djangorestframework-stubs/
+    from rest_framework.permissions import _PermissionClass
+
+    PermissionClassesType = Sequence[_PermissionClass]
+else:
+    PermissionClassesType = Sequence[Type[BasePermission]]
+
+
 class ApiAuthMixin:
-    authentication_classes = (
+    authentication_classes: Sequence[Type[BaseAuthentication]] = [
         CsrfExemptedSessionAuthentication,
         SessionAsHeaderAuthentication,
         JSONWebTokenAuthentication
-    )
-    permission_classes = (IsAuthenticated, )
+    ]
+    permission_classes: PermissionClassesType = (IsAuthenticated, )

styleguide_example/api/mixins.py

@@ -1,7 +1,7 @@
 from datetime import date
-from typing import Optional, Iterable
+from typing import Optional
 
-from django.db.models.query import Q
+from django.db.models.query import Q, QuerySet
 from django.core.exceptions import ValidationError
 
 from styleguide_example.testing_examples.models import School, SchoolCourse
@@ -16,7 +16,7 @@ def school_list_school_courses(
     school: School,
     start_date: Optional[date] = None,
     end_date: Optional[date] = None
-) -> Iterable[SchoolCourse]:
+) -> QuerySet[SchoolCourse]:
     if start_date is None and end_date:
         raise ValidationError(SCHOOL_LIST_SCHOOL_COURSES_PROVIDE_START_DATE_MSG)
 

styleguide_example/common/types.py

@@ -1,4 +1,4 @@
-from styleguide_example.common.types import QuerySetType
+from django.db.models.query import QuerySet
 
 from styleguide_example.users.models import BaseUser
 from styleguide_example.users.filters import BaseUserFilter
@@ -14,7 +14,7 @@ def user_get_login_data(*, user: BaseUser):
     }
 
 
-def user_list(*, filters=None) -> QuerySetType[BaseUser]:
+def user_list(*, filters=None) -> QuerySet[BaseUser]:
     filters = filters or {}
 
     qs = BaseUser.objects.all()