Merge pull request #78 from eadwinCode/context_var

switched to context var

Author: eadwinCode

Makefile

@@ -10,31 +10,27 @@ clean: ## Removing cached python compiled files
 	find . -name \*~  | xargs  rm -fv
 	find . -name __pycache__  | xargs  rm -rfv
 
-install: ## Install dependencies
-	make clean
+install:clean ## Install dependencies
 	flit install --deps develop --symlink
 	pre-commit install -f
 
-lint: ## Run code linters
+lint:fmt ## Run code linters
 	make clean
 	black --check ninja_extra tests
 	ruff check ninja_extra tests
 	mypy ninja_extra
 
-fmt format: ## Run code formatters
-	make clean
+fmt format:clean ## Run code formatters
 	black ninja_extra tests
 	ruff check --fix ninja_extra tests
 
 
-test: ## Run tests
-	make clean
+test:clean ## Run tests
 	pytest .
 
-test-cov: ## Run tests with coverage
+test-cov:clean ## Run tests with coverage
 	make clean
 	pytest --cov=ninja_extra --cov-report term-missing tests
 
-doc-deploy: ## Run Deploy Documentation
-	make clean
+doc-deploy:clean ## Run Deploy Documentation
 	mkdocs gh-deploy --force

mypy.ini

@@ -1,3 +1,10 @@
+import contextvars
+import typing as t
+
+if t.TYPE_CHECKING:  # pragma: no cover
+    from ninja_extra.controllers.route.context import RouteContext
+
+
 POST = "POST"
 PUT = "PUT"
 PATCH = "PATCH"
@@ -9,3 +16,8 @@
 ROUTE_METHODS = [POST, PUT, PATCH, DELETE, GET, HEAD, OPTIONS, TRACE]
 THROTTLED_FUNCTION = "__throttled_endpoint__"
 ROUTE_FUNCTION = "__route_function__"
+
+ROUTE_CONTEXT_VAR: contextvars.ContextVar[
+    t.Optional["RouteContext"]
+] = contextvars.ContextVar("ROUTE_CONTEXT_VAR")
+ROUTE_CONTEXT_VAR.set(None)

ninja_extra/constants.py

@@ -166,8 +166,7 @@ def _get_permissions(self) -> Iterable[BasePermission]:
         """
         Instantiates and returns the list of permissions that this view requires.
         """
-        if not self.context:
-            return
+        assert self.context
 
         for permission_class in self.context.permission_classes:
             if isinstance(permission_class, (type, OperationHolderMixin)):

ninja_extra/controllers/base.py

@@ -2,7 +2,7 @@
 DRF Exceptions
 """
 import math
-from typing import Any, Dict, List, Optional, Type, Union, cast, no_type_check
+from typing import Any, Dict, List, Optional, Type, Union, no_type_check
 
 from django.http import HttpRequest, HttpResponse, JsonResponse
 from django.utils.encoding import force_str
@@ -104,7 +104,7 @@ def __init__(
         code: Optional[Union[str, int]] = None,
     ) -> None:
         if detail is None:
-            detail = cast(str, self.default_detail)
+            detail = force_str(self.default_detail)
         if code is None:
             code = self.default_code
 
@@ -149,7 +149,7 @@ def __init__(
         code: Optional[Union[str, int]] = None,
     ):
         if detail is None:
-            detail = cast(str, self.default_detail)
+            detail = force_str(self.default_detail)
         if code is None:
             code = self.default_code
 

ninja_extra/exceptions.py

@@ -1,36 +1,30 @@
 import threading
-from typing import Any, Optional, cast
+from typing import Optional
 
-from django.apps import apps
 from django.conf import Settings, settings
-from django.dispatch import receiver
 from injector import Binder, Module, singleton
 
 from ninja_extra.controllers.route.context import RouteContext
 
-from .signals import route_context_finished, route_context_started
+from .constants import ROUTE_CONTEXT_VAR
 
-
-@receiver([route_context_started, route_context_finished], sender=RouteContext)
-def route_context_handler(
-    *args: Any, route_context: Optional[RouteContext] = None, **kwargs: Any
-) -> None:
-    app = cast(Any, apps.get_app_config("ninja_extra"))
-    app.ninja_extra_module.set_route_context(route_context)
+# @receiver([route_context_started, route_context_finished], sender=RouteContext)
+# def route_context_handler(
+#     *args: Any, route_context: Optional[RouteContext] = None, **kwargs: Any
+# ) -> None:
+#     app = cast(Any, apps.get_app_config("ninja_extra"))
+#     app.ninja_extra_module.set_route_context(route_context)
 
 
 class NinjaExtraModule(Module):
     def __init__(self) -> None:
         self._local = threading.local()
 
     def set_route_context(self, route_context: RouteContext) -> None:
-        self._local.route_context = route_context
+        ROUTE_CONTEXT_VAR.set(route_context)
 
     def get_route_context(self) -> Optional[RouteContext]:
-        try:
-            return self._local.route_context  # type:ignore
-        except AttributeError:  # pragma: no cover
-            return None
+        return ROUTE_CONTEXT_VAR.get()
 
     def configure(self, binder: Binder) -> None:
         binder.bind(Settings, to=settings, scope=singleton)  # type: ignore

ninja_extra/modules.py

@@ -35,10 +35,12 @@
 from ninja.utils import check_csrf
 
 from ninja_extra.compatible import asynccontextmanager
+from ninja_extra.constants import ROUTE_CONTEXT_VAR
 from ninja_extra.exceptions import APIException
 from ninja_extra.helper import get_function_name
 from ninja_extra.logger import request_logger
-from ninja_extra.signals import route_context_finished, route_context_started
+
+# from ninja_extra.signals import route_context_finished, route_context_started
 from ninja_extra.types import PermissionType
 
 from .controllers.route.context import RouteContext, get_route_execution_context
@@ -153,7 +155,7 @@ def _prep_run(
                 request, temporal_response=temporal_response, **kw
             )
             # send route_context_started signal
-            route_context_started.send(RouteContext, route_context=context)
+            ROUTE_CONTEXT_VAR.set(context)
 
             yield context
             self._log_action(
@@ -174,7 +176,7 @@ def _prep_run(
             raise e
         finally:
             # send route_context_finished signal
-            route_context_finished.send(RouteContext, route_context=None)
+            ROUTE_CONTEXT_VAR.set(None)
 
     def run(self, request: HttpRequest, **kw: Any) -> HttpResponseBase:
         error = self._run_checks(request)
@@ -265,7 +267,7 @@ def _prep_run(
                 request, temporal_response=temporal_response, **kw
             )
             # send route_context_started signal
-            route_context_started.send(RouteContext, route_context=context)
+            ROUTE_CONTEXT_VAR.set(context)
 
             yield context
             self._log_action(
@@ -286,7 +288,7 @@ def _prep_run(
             raise e
         finally:
             # send route_context_finished signal
-            route_context_finished.send(RouteContext, route_context=None)
+            ROUTE_CONTEXT_VAR.set(None)
 
     def run(self, request: HttpRequest, **kw: Any) -> HttpResponseBase:
         error = self._run_checks(request)
@@ -363,7 +365,7 @@ async def _prep_run(  # type:ignore
             start_time = time.time()
             context = self.get_execution_context(request, **kw)
             # send route_context_started signal
-            route_context_started.send(RouteContext, route_context=context)
+            ROUTE_CONTEXT_VAR.set(context)
 
             yield context
             self._log_action(
@@ -384,7 +386,7 @@ async def _prep_run(  # type:ignore
             raise e
         finally:
             # send route_context_finished signal
-            route_context_finished.send(RouteContext, route_context=None)
+            ROUTE_CONTEXT_VAR.set(None)
 
     async def run(self, request: HttpRequest, **kw: Any) -> HttpResponseBase:  # type: ignore
         error = await self._run_checks(request)
@@ -413,7 +415,7 @@ async def _prep_run(  # type:ignore
             start_time = time.time()
             context = self.get_execution_context(request, **kw)
             # send route_context_started signal
-            route_context_started.send(RouteContext, route_context=context)
+            ROUTE_CONTEXT_VAR.set(context)
 
             yield context
             self._log_action(
@@ -434,7 +436,7 @@ async def _prep_run(  # type:ignore
             raise e
         finally:
             # send route_context_finished signal
-            route_context_finished.send(RouteContext, route_context=None)
+            ROUTE_CONTEXT_VAR.set(None)
 
     async def run(self, request: HttpRequest, **kw: Any) -> HttpResponseBase:  # type: ignore
         error = await self._run_checks(request)

ninja_extra/operation.py

@@ -1,4 +1,4 @@
-from django.dispatch import Signal
+from django.dispatch import Signal  # pragma: no cover
 
-route_context_started = Signal()
-route_context_finished = Signal()
+route_context_started = Signal()  # pragma: no cover
+route_context_finished = Signal()  # pragma: no cover

ninja_extra/signals.py

@@ -22,8 +22,6 @@ classifiers = [
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.6",
-    "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
@@ -62,7 +60,7 @@ test = [
     "pytest-cov",
     "pytest-django",
     "pytest-asyncio",
-    "mypy == 1.4.1",
+    "mypy == 1.5.1",
     "ruff ==0.0.275",
     "black == 23.7.0",
     "injector >= 0.19.0",
@@ -101,3 +99,25 @@ ignore = [
 
 [tool.ruff.isort]
 known-third-party = ["django-ninja-extra", "Django", "injector", "pydantic"]
+
+[tool.mypy]
+show_column_numbers = true
+
+follow_imports = 'normal'
+ignore_missing_imports = true
+
+# be strict
+disallow_untyped_calls = true
+warn_return_any = true
+strict_optional = true
+warn_no_return = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+disallow_untyped_defs = true
+check_untyped_defs = true
+no_implicit_reexport = true
+
+[[tool.mypy.overrides]]
+module = "ninja_extra.compatible.*"
+ignore_errors = true

pyproject.toml

@@ -1,3 +1,5 @@
+import base64
+
 import django
 import pytest
 from django.conf import settings
@@ -14,6 +16,8 @@
     async_django_auth,
 )
 
+user_secret = base64.b64encode("admin:secret".encode("utf-8")).decode()
+
 
 async def callable_auth(request):
     return request.GET.get("auth")
@@ -182,13 +186,13 @@ async def test_csrf_on():
         ("/basic", {}, 401, BODY_UNAUTHORIZED_DEFAULT),
         (
             "/basic",
-            {"headers": {"Authorization": "Basic YWRtaW46c2VjcmV0"}},
+            {"headers": {"Authorization": f"Basic {user_secret}"}},
             200,
             {"auth": "admin"},
         ),
         (
             "/basic",
-            {"headers": {"Authorization": "YWRtaW46c2VjcmV0"}},
+            {"headers": {"Authorization": f"{user_secret}"}},
             200,
             {"auth": "admin"},
         ),