Merge pull request #74 from eadwinCode/linting_with_ruff

Linting with Ruff

Author: eadwinCode

.github/workflows/test_full.yml

@@ -34,16 +34,14 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.9
+          python-version: 3.8
       - name: Install Flit
         run: pip install flit
       - name: Install Dependencies
         run: flit install --symlink
       - name: Black
         run: black --check ninja_extra tests
-      - name: isort
-        run: isort --check ninja_extra tests
-      - name: Flake8
-        run: flake8 ninja_extra tests
+      - name: Ruff Linting Check
+        run: ruff check ninja_extra tests
       - name: mypy
         run: mypy ninja_extra

Makefile

@@ -18,14 +18,14 @@ install: ## Install dependencies
 lint: ## Run code linters
 	make clean
 	black --check ninja_extra tests
-	isort --check ninja_extra tests
-	flake8 ninja_extra tests
+	ruff check ninja_extra tests
 	mypy ninja_extra
 
 fmt format: ## Run code formatters
 	make clean
 	black ninja_extra tests
-	isort ninja_extra tests
+	ruff check --fix ninja_extra tests
+
 
 test: ## Run tests
 	make clean

mypy.ini

@@ -1,5 +1,5 @@
 [mypy]
-python_version = 3.6
+python_version = 3.8
 
 show_column_numbers = True
 
@@ -19,4 +19,4 @@ check_untyped_defs = True
 no_implicit_reexport = True
 
 [mypy-ninja_extra.compatible.*]
-ignore_errors = True
+ignore_errors = True

ninja_extra/conf/settings.py

@@ -1,7 +1,7 @@
 from typing import Any, Dict, List, Optional
 
 from django.conf import settings as django_settings
-from django.test.signals import setting_changed
+from django.core.signals import setting_changed
 from ninja import Schema
 from pydantic import Field, root_validator, validator
 
@@ -13,17 +13,17 @@ def __init__(self, data: dict) -> None:
         self.__dict__ = data
 
 
-NinjaExtra_SETTINGS_DEFAULTS = dict(
-    INJECTOR_MODULES=[],
-    PAGINATION_CLASS="ninja_extra.pagination.LimitOffsetPagination",
-    THROTTLE_CLASSES=[
+NinjaExtra_SETTINGS_DEFAULTS = {
+    "INJECTOR_MODULES": [],
+    "PAGINATION_CLASS": "ninja_extra.pagination.LimitOffsetPagination",
+    "THROTTLE_CLASSES": [
         "ninja_extra.throttling.AnonRateThrottle",
         "ninja_extra.throttling.UserRateThrottle",
     ],
-    THROTTLE_RATES={"user": None, "anon": None},
-    ORDERING_CLASS="ninja_extra.ordering.Ordering",
-    SEARCHING_CLASS="ninja_extra.searching.Searching",
-)
+    "THROTTLE_RATES": {"user": None, "anon": None},
+    "ORDERING_CLASS": "ninja_extra.ordering.Ordering",
+    "SEARCHING_CLASS": "ninja_extra.searching.Searching",
+}
 
 USER_SETTINGS = UserDefinedSettingsMapper(
     getattr(django_settings, "NINJA_EXTRA", NinjaExtra_SETTINGS_DEFAULTS)

ninja_extra/controllers/base.py

@@ -21,7 +21,8 @@
 
 from django.db.models import Model, QuerySet
 from django.http import HttpResponse
-from django.urls import URLPattern, path as django_path
+from django.urls import URLPattern
+from django.urls import path as django_path
 from injector import inject, is_decorated_with_inject
 from ninja import NinjaAPI, Router
 from ninja.constants import NOT_SET
@@ -143,7 +144,7 @@ def permission_denied(cls, permission: BasePermission) -> None:
     def get_object_or_exception(
         self,
         klass: Union[Type[Model], QuerySet],
-        error_message: str = None,
+        error_message: Optional[str] = None,
         exception: Type[APIException] = NotFound,
         **kwargs: Any,
     ) -> Any:
@@ -267,7 +268,6 @@ def __init__(
         permissions: Optional["PermissionType"] = None,
         auto_import: bool = True,
     ) -> None:
-
         self.prefix = prefix
         # `auth` primarily defines APIController route function global authentication method.
         self.auth: Optional[AuthBase] = auth
@@ -278,8 +278,8 @@ def __init__(
         # `controller_class` target class that the APIController wraps
         self._controller_class: Optional[Type["ControllerBase"]] = None
         # `_path_operations` a converted dict of APIController route function used by Django-Ninja library
-        self._path_operations: Dict[str, ControllerPathView] = dict()
-        self._controller_class_route_functions: Dict[str, RouteFunction] = dict()
+        self._path_operations: Dict[str, ControllerPathView] = {}
+        self._controller_class_route_functions: Dict[str, RouteFunction] = {}
         # `permission_classes` a collection of BasePermission Types
         # a fallback if route functions has no permissions definition
         self.permission_classes: PermissionType = permissions or [AllowAny]

ninja_extra/controllers/registry.py

@@ -5,9 +5,7 @@
 
 
 class ControllerBorg:
-    _shared_state_: Dict[str, Dict[str, Type["ControllerBase"]]] = dict(
-        controllers=dict()
-    )
+    _shared_state_: Dict[str, Dict[str, Type["ControllerBase"]]] = {"controllers": {}}
 
     def __init__(self) -> None:
         self.__dict__ = self._shared_state_
@@ -27,11 +25,11 @@ def remove_controller(
         return None
 
     def clear_controller(self) -> None:
-        self._shared_state_["controllers"] = dict()
+        self._shared_state_["controllers"] = {}
 
     @classmethod
     def get_controllers(cls) -> Dict[str, Type["ControllerBase"]]:
-        return cls._shared_state_.get("controllers", dict())
+        return cls._shared_state_.get("controllers", {})
 
 
 class ControllerRegistry(ControllerBorg):

ninja_extra/controllers/response.py

@@ -20,7 +20,7 @@
 SCHEMA_KEY = "_schema"
 
 if sys.version_info < (3, 7):  # pragma: no cover
-    from typing import GenericMeta
+    from typing import GenericMeta  # type: ignore[attr-defined]
 
     class ControllerResponseMeta(GenericMeta):
         @no_type_check
@@ -42,7 +42,6 @@ class GenericControllerResponse(metaclass=ControllerResponseMeta):
         def __new__(
             cls: Type["ControllerResponse[T]"], *args: Any, **kwargs: Any
         ) -> "ControllerResponse[T]":
-
             if cls._gorg is Generic or "_schema" not in cls.__dict__:
                 raise TypeError(
                     "Type Generic cannot be instantiated; "
@@ -62,10 +61,9 @@ class ControllerResponseMeta(type):
         pass
 
     class GenericControllerResponse(metaclass=ControllerResponseMeta):
-        def __new__(
+        def __new__(  # type:ignore[misc]
             cls: Type["ControllerResponse[T]"], *args: Any, **kwargs: Any
         ) -> "ControllerResponse[T]":
-
             if "_schema" not in cls.__dict__:
                 raise TypeError(
                     "Type Generic cannot be instantiated; "
@@ -123,7 +121,7 @@ class Id(ControllerResponse[T]):
                 ==> 201, {id: "883a1a3d-7b10-458d-bccc-f9b7219342c9"}
     """
 
-    _schema = IdSchema[Any]  # type: ignore
+    _schema = IdSchema[Any]
     status_code: int = status.HTTP_201_CREATED
 
     def __init__(self, id: T) -> None:
@@ -156,7 +154,7 @@ class ASchema(BaseModel):
     """
 
     status_code: int = status.HTTP_200_OK
-    _schema = OkSchema[Any]  # type: ignore
+    _schema = OkSchema[Any]
 
     def __init__(self, message: Optional[Any] = None) -> None:
         super(Ok, self).__init__()
@@ -186,7 +184,7 @@ class ErrorSchema(BaseModel):
     """
 
     status_code: int = status.HTTP_200_OK
-    _schema = DetailSchema[Any]  # type: ignore
+    _schema = DetailSchema[Any]
 
     def __init__(
         self, message: Optional[Any] = None, status_code: int = status.HTTP_200_OK

ninja_extra/controllers/route/__init__.py

@@ -67,11 +67,10 @@ def __init__(
         ] = None,
         openapi_extra: Optional[Dict[str, Any]] = None,
     ) -> None:
-
         if not isinstance(methods, list):
             raise RouteInvalidParameterException("methods must be a list")
 
-        methods = list(map(lambda m: m.upper(), methods))
+        methods = [m.upper() for m in methods]
         not_valid_methods = list(set(methods) - set(ROUTE_METHODS))
         if not_valid_methods:
             raise RouteInvalidParameterException(
@@ -85,7 +84,7 @@ def __init__(
             response = cast(ControllerResponse, response)
             _response = {response.status_code: response.get_schema()}
         elif isinstance(response, list):
-            _response_computed = dict()
+            _response_computed = {}
             for item in response:
                 if (
                     inspect.isclass(item) and type(item) == ControllerResponseMeta

ninja_extra/controllers/route/context.py

@@ -1,9 +1,10 @@
-from typing import Any, List, Union
+from typing import Any, List, Optional, Union
 
 from django.http import HttpResponse
 from django.http.request import HttpRequest
 from ninja.types import DictStrAny
-from pydantic import BaseModel as PydanticModel, Field
+from pydantic import BaseModel as PydanticModel
+from pydantic import Field
 
 from ninja_extra.types import PermissionType
 
@@ -25,17 +26,19 @@ class Config:
 
 def get_route_execution_context(
     request: HttpRequest,
-    temporal_response: HttpResponse = None,
-    permission_classes: PermissionType = [],
+    temporal_response: Optional[HttpResponse] = None,
+    permission_classes: Optional[PermissionType] = None,
     *args: Any,
     **kwargs: Any,
 ) -> RouteContext:
-    init_kwargs = dict(
-        permission_classes=permission_classes,
-        request=request,
-        kwargs=kwargs,
-        response=temporal_response,
-        args=args,
-    )
-    context = RouteContext(**init_kwargs)
+    init_kwargs = {
+        "permission_classes": permission_classes
+        if permission_classes is not None
+        else [],
+        "request": request,
+        "kwargs": kwargs,
+        "response": temporal_response,
+        "args": args,
+    }
+    context = RouteContext(**init_kwargs)  # type:ignore[arg-type]
     return context

ninja_extra/controllers/route/route_functions.py

@@ -40,7 +40,7 @@ def __init__(
     def __call__(
         self,
         request: HttpRequest,
-        temporal_response: HttpResponse = None,
+        temporal_response: Optional[HttpResponse] = None,
         *args: Any,
         **kwargs: Any,
     ) -> Any:
@@ -79,7 +79,7 @@ def _resolve_api_func_signature_(self, context_func: Callable) -> Callable:
     def get_view_function(self) -> Callable:
         def as_view(
             request: HttpRequest,
-            context: RouteContext = None,
+            context: Optional[RouteContext] = None,
             *args: Any,
             **kwargs: Any,
         ) -> Any:
@@ -124,14 +124,14 @@ def get_route_execution_context(
         )
         _api_controller = self.get_api_controller()
 
-        init_kwargs = dict(
-            permission_classes=self.route.permissions
+        init_kwargs = {
+            "permission_classes": self.route.permissions
             or _api_controller.permission_classes,
-            request=request,
-            kwargs=kwargs,
-            args=args,
-        )
-        context = RouteContext(**init_kwargs)
+            "request": request,
+            "kwargs": kwargs,
+            "args": args,
+        }
+        context = RouteContext(**init_kwargs)  # type:ignore[arg-type]
         return context
 
     @contextmanager
@@ -166,7 +166,7 @@ class AsyncRouteFunction(RouteFunction):
     def get_view_function(self) -> Callable:
         async def as_view(
             request: HttpRequest,
-            context: RouteContext = None,
+            context: Optional[RouteContext] = None,
             *args: Any,
             **kwargs: Any,
         ) -> Any:
@@ -191,15 +191,16 @@ def __repr__(self) -> str:  # pragma: no cover
     async def __call__(
         self,
         request: HttpRequest,
-        temporal_response: HttpResponse = None,
+        temporal_response: Optional[HttpResponse] = None,
         *args: Any,
         **kwargs: Any,
     ) -> Any:
         _api_controller = self.get_api_controller()
         context = get_route_execution_context(
             request,
             temporal_response,
-            self.route.permissions or _api_controller.permission_classes,  # type: ignore[arg-type]
+            self.route.permissions
+            or _api_controller.permission_classes,  # type:ignore[arg-type]
             *args,
             **kwargs,
         )