Merge pull request #209 from maykinmedia/chore/208-type-checking

🏷️ [#208] Configure type checking with pyright

Author: stevenbal

.github/workflows/code_quality.yml

@@ -40,3 +40,23 @@ jobs:
           python-version: '3.12'
       - name: Check environment variables
         run: python bin/check_envvar_usage.py
+
+  type-checking:
+    name: Type checking (Pyright)
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.12'
+      - name: Install additional dependencies
+        run: |
+          pip install uv
+          uv pip install \
+            --system \
+            -e .[type-checking,tests,cors,csp,structlog]
+      - uses: jakebailey/pyright-action@v1
+        with:
+          version: 1.1.407
+          project: pyright.pyproject.toml

open_api_framework/admin.py

@@ -25,14 +25,14 @@ def has_change_permission(self, request, obj=None):
 
     @admin.display(boolean=True)
     def exists(self, obj):
-        return self.SessionStore().exists(obj.session_key)
+        return self.SessionStore().exists(obj.session_key)  # pyright: ignore
 
     def delete_model(self, request, obj):
-        self.SessionStore(obj.session_key).flush()
+        self.SessionStore(obj.session_key).flush()  # pyright: ignore
         super().delete_model(request, obj)
 
     def delete_queryset(self, request, queryset):
         for session_profile in queryset.iterator():
-            self.SessionStore(session_profile.session_key).flush()
+            self.SessionStore(session_profile.session_key).flush()  # pyright: ignore
 
         super().delete_queryset(request, queryset)

open_api_framework/conf/base.py

@@ -3,6 +3,7 @@
 import warnings
 from contextlib import suppress
 from importlib.util import find_spec
+from typing import TYPE_CHECKING, Any
 
 from django.urls import reverse_lazy
 
@@ -18,6 +19,10 @@
     strip_protocol_from_origin,
 )
 
+if TYPE_CHECKING:
+    from psycopg import Connection
+    from psycopg.rows import TupleRow
+
 # optional requirements
 default_cors_headers = []
 with suppress(ImportError):
@@ -293,8 +298,8 @@ class WrapperConnectionClass(psycopg.Connection):
         def connect(
             cls,
             conninfo: str = "",
-            **kwargs,
-        ) -> "psycopg.Connection[psycopg.rows.TupleRow]":
+            **kwargs: Any,
+        ) -> Connection[TupleRow]:
             return psycopg.connect(conninfo, **kwargs)
 
     DATABASES["default"]["OPTIONS"] = {
@@ -365,7 +370,7 @@ def connect(
 #
 # APPLICATIONS enabled for this project
 #
-INSTALLED_APPS = importable(
+INSTALLED_APPS: list[str] = importable(
     # Note: contenttypes should be first, see Django ticket #10827
     "django.contrib.contenttypes",
     "django.contrib.auth",
@@ -1423,7 +1428,7 @@ def connect(
 # NOTE: make sure values are a tuple or list, and to quote special values like 'self'
 
 
-def get_content_security_policy():
+def get_content_security_policy() -> dict[str, dict[str, list[str] | int]]:
     # ideally we'd use BASE_URI but it'd have to be lazy or cause issues
     extra_default_src = config(
         "CSP_EXTRA_DEFAULT_SRC",
@@ -1483,7 +1488,7 @@ def get_content_security_policy():
     if not csp_installed:
         return {}
 
-    csp_default_src = [SELF] + extra_default_src
+    csp_default_src = [SELF] + extra_default_src  # pyright: ignore
     return {
         "DIRECTIVES": {
             "default-src": csp_default_src,
@@ -1492,13 +1497,13 @@ def get_content_security_policy():
             "img-src": csp_default_src + ["data:", "cdn.redoc.ly"] + extra_img_src,
             "object-src": object_src,
             "style-src": csp_default_src
-            + [NONCE, "'unsafe-inline'", "fonts.googleapis.com"],
-            "script-src": csp_default_src + [NONCE, "'unsafe-inline'"],
-            "font-src": [SELF, "fonts.gstatic.com"],
-            "worker-src": [SELF, "blob:"],
-            "base-uri": [SELF],
-            "frame-ancestors": [NONE],
-            "frame-src": [SELF],
+            + [NONCE, "'unsafe-inline'", "fonts.googleapis.com"],  # pyright: ignore
+            "script-src": csp_default_src + [NONCE, "'unsafe-inline'"],  # pyright: ignore
+            "font-src": [SELF, "fonts.gstatic.com"],  # pyright: ignore
+            "worker-src": [SELF, "blob:"],  # pyright: ignore
+            "base-uri": [SELF],  # pyright: ignore
+            "frame-ancestors": [NONE],  # pyright: ignore
+            "frame-src": [SELF],  # pyright: ignore
             "upgrade-insecure-requests": False,  # Enable only in production
             "report-uri": report_uri,
         },

open_api_framework/conf/utils.py

@@ -31,18 +31,18 @@ def __eq__(self, other):
         return isinstance(other, EnvironmentVariable) and self.name == other.name
 
 
-ENVVAR_REGISTRY = []
+ENVVAR_REGISTRY: list[EnvironmentVariable] = []
 
 _T = TypeVar("_T")
 
 
 def config(
     option: str,
     default: _T = undefined,
-    help_text="",
-    group=None,
+    help_text: str = "",
+    group: str | None = None,
     add_to_docs: str | bool = True,
-    auto_display_default=True,
+    auto_display_default: bool = True,
     *args,
     **kwargs,
 ) -> _T:
@@ -158,7 +158,7 @@ def strip_protocol_from_origin(origin: str) -> str:
 
 
 def get_project_dirname() -> str:
-    return config("DJANGO_SETTINGS_MODULE", add_to_docs=False).split(".")[0]
+    return config("DJANGO_SETTINGS_MODULE", add_to_docs=False).split(".")[0]  # pyright: ignore
 
 
 def get_django_project_dir() -> Path:

open_api_framework/context_processors.py

@@ -2,8 +2,8 @@
 from django.http.request import HttpRequest
 
 
-def admin_settings(request: HttpRequest) -> dict:
-    show_version = request.user.is_staff
+def admin_settings(request: HttpRequest) -> dict[str, str | bool | None]:
+    show_version = request.user.is_staff  # pyright: ignore
 
     return {
         "show_environment": getattr(settings, "ENVIRONMENT_SHOWN_IN_ADMIN", None),

pyproject.toml

@@ -63,6 +63,12 @@ tests = [
     "django-rosetta",
     "django-webtest"
 ]
+type-checking = [
+    "decouple-types",
+    "django-stubs",
+    "django-stubs-ext",
+    "gitpython",
+]
 coverage = [
     "pytest-cov",
 ]
@@ -146,3 +152,6 @@ exclude_also = [
     "\\.\\.\\.",
     "pass",
 ]
+
+[tool.setuptools.package-data]
+open_api_framework = ["py.typed"]

pyright.pyproject.toml

@@ -0,0 +1,4 @@
+[tool.pyright]
+pythonVersion = "3.12"
+pythonPlatform = "Linux"
+reportUnnecessaryTypeIgnoreComment = "error"

tests/factories.py

@@ -1,16 +1,17 @@
 import factory.fuzzy
+from factory.helpers import post_generation
 from sessionprofile.models import SessionProfile
 
 from open_api_framework.utils import get_session_store
 
 
-class SessionProfileFactory(factory.django.DjangoModelFactory):
+class SessionProfileFactory(factory.django.DjangoModelFactory[SessionProfile]):
     session_key = factory.fuzzy.FuzzyText(length=40)
 
-    class Meta:
+    class Meta:  # pyright: ignore
         model = SessionProfile
 
-    @factory.post_generation
+    @post_generation
     def session(self, create, extracted, **kwargs):
         SessionStore = get_session_store()
-        SessionStore(self.session_key).save(True)
+        SessionStore(self.session_key).save(True)  # pyright: ignore

tests/test_admin.py

@@ -87,7 +87,7 @@ def test_cant_delete_other_users_session(client, admin_user, django_user_model):
 
     SessionStore = get_session_store()
 
-    assert SessionStore().exists(other_user_session.session_key)
+    assert SessionStore().exists(other_user_session.session_key)  # pyright: ignore
 
 
 def test_delete_with_session_db_backend(client, admin_user, session_changelist_url):