update ruff linter

.pre-commit-config.yaml

@@ -15,7 +15,7 @@ repos:
       - id: black
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.0.269"
+    rev: "v0.1.8"
     hooks:
       - id: ruff
-        args: [--fix, --exit-non-zero-on-fix]
+        args: [--fix, --exit-non-zero-on-fix, --unsafe-fixes]

README.md

@@ -30,7 +30,7 @@ Create a test.py file and copy the following code into it
 
 ```python
 from pathlib import Path
-from typing import Any, Dict
+from typing import Any, ClassVar, Dict
 
 import uvicorn
 from fastapi import APIRouter, Depends, FastAPI
@@ -120,7 +120,7 @@ def session_dependency_handler(view: ViewBase, dto: SessionDependency) -> Dict[s
 
 
 class UserDetailView(DetailViewBaseGeneric):
-    method_dependencies = {
+    method_dependencies: ClassVar[Dict[HTTPMethod, HTTPMethodConfig]] = {
         HTTPMethod.ALL: HTTPMethodConfig(
             dependencies=SessionDependency,
             prepare_data_layer_kwargs=session_dependency_handler,
@@ -129,7 +129,7 @@ class UserDetailView(DetailViewBaseGeneric):
 
 
 class UserListView(ListViewBaseGeneric):
-    method_dependencies = {
+    method_dependencies: ClassVar[Dict[HTTPMethod, HTTPMethodConfig]] = {
         HTTPMethod.ALL: HTTPMethodConfig(
             dependencies=SessionDependency,
             prepare_data_layer_kwargs=session_dependency_handler,

docs/python_snippets/client_generated_id/schematic_example.py

@@ -1,5 +1,6 @@
 import sys
 from pathlib import Path
+from typing import ClassVar
 
 import uvicorn
 from fastapi import APIRouter, Depends, FastAPI
@@ -82,7 +83,7 @@ def session_dependency_handler(view: ViewBase, dto: SessionDependency) -> dict:
 
 
 class UserDetailView(DetailViewBaseGeneric):
-    method_dependencies = {
+    method_dependencies: ClassVar = {
         HTTPMethod.ALL: HTTPMethodConfig(
             dependencies=SessionDependency,
             prepare_data_layer_kwargs=session_dependency_handler,
@@ -91,7 +92,7 @@ class UserDetailView(DetailViewBaseGeneric):
 
 
 class UserListView(ListViewBaseGeneric):
-    method_dependencies = {
+    method_dependencies: ClassVar = {
         HTTPMethod.ALL: HTTPMethodConfig(
             dependencies=SessionDependency,
             prepare_data_layer_kwargs=session_dependency_handler,

docs/python_snippets/view_dependencies/main_example.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing import ClassVar, Dict
+
 from fastapi import Depends, Header
 from pydantic import BaseModel
 from sqlalchemy.engine import make_url
@@ -52,7 +54,7 @@ class Config:
         arbitrary_types_allowed = True
 
 
-async def common_handler(view: ViewBase, dto: BaseModel) -> dict:
+async def common_handler(view: ViewBase, dto: SessionDependency) -> dict:
     return {"session": dto.session}
 
 
@@ -66,7 +68,7 @@ class AdminOnlyPermission(BaseModel):
 
 
 class DetailView(DetailViewBaseGeneric):
-    method_dependencies: dict[HTTPMethod, HTTPMethodConfig] = {
+    method_dependencies: ClassVar[Dict[HTTPMethod, HTTPMethodConfig]] = {
         HTTPMethod.ALL: HTTPMethodConfig(
             dependencies=SessionDependency,
             prepare_data_layer_kwargs=common_handler,
@@ -75,7 +77,7 @@ class DetailView(DetailViewBaseGeneric):
 
 
 class ListView(ListViewBaseGeneric):
-    method_dependencies: dict[HTTPMethod, HTTPMethodConfig] = {
+    method_dependencies: ClassVar[Dict[HTTPMethod, HTTPMethodConfig]] = {
         HTTPMethod.GET: HTTPMethodConfig(dependencies=AdminOnlyPermission),
         HTTPMethod.ALL: HTTPMethodConfig(
             dependencies=SessionDependency,

docs/python_snippets/view_dependencies/several_dependencies.py

@@ -1,3 +1,5 @@
+from typing import ClassVar
+
 from fastapi import Depends
 from pydantic import BaseModel
 
@@ -35,7 +37,7 @@ def get_handler(view: ViewBase, dto: DependencyMix):
 
 
 class DetailView(DetailViewBaseGeneric):
-    method_dependencies = {
+    method_dependencies: ClassVar = {
         HTTPMethod.ALL: HTTPMethodConfig(
             dependencies=CommonDependency,
             prepare_data_layer_kwargs=common_handler,

examples/api_for_sqlalchemy/api/views_base.py

@@ -1,4 +1,4 @@
-from typing import Dict
+from typing import ClassVar, Dict
 
 from fastapi import Depends
 from pydantic import BaseModel
@@ -29,7 +29,7 @@ class DetailViewBase(DetailViewBaseGeneric):
 
     data_layer_cls = SqlalchemyDataLayer
 
-    method_dependencies = {
+    method_dependencies: ClassVar = {
         HTTPMethod.ALL: HTTPMethodConfig(
             dependencies=SessionDependency,
             prepare_data_layer_kwargs=handler,
@@ -44,7 +44,7 @@ class ListViewBase(ListViewBaseGeneric):
 
     data_layer_cls = SqlalchemyDataLayer
 
-    method_dependencies = {
+    method_dependencies: ClassVar = {
         HTTPMethod.ALL: HTTPMethodConfig(
             dependencies=SessionDependency,
             prepare_data_layer_kwargs=handler,

examples/api_limited_methods.py

@@ -1,6 +1,6 @@
 import sys
 from pathlib import Path
-from typing import Any, Dict
+from typing import Any, ClassVar, Dict
 
 import uvicorn
 from fastapi import APIRouter, Depends, FastAPI
@@ -82,7 +82,7 @@ def session_dependency_handler(view: ViewBase, dto: SessionDependency) -> Dict[s
 
 
 class UserDetailView(DetailViewBaseGeneric):
-    method_dependencies = {
+    method_dependencies: ClassVar = {
         HTTPMethod.ALL: HTTPMethodConfig(
             dependencies=SessionDependency,
             prepare_data_layer_kwargs=session_dependency_handler,
@@ -91,7 +91,7 @@ class UserDetailView(DetailViewBaseGeneric):
 
 
 class UserListView(ListViewBaseGeneric):
-    method_dependencies = {
+    method_dependencies: ClassVar = {
         HTTPMethod.ALL: HTTPMethodConfig(
             dependencies=SessionDependency,
             prepare_data_layer_kwargs=session_dependency_handler,

examples/api_minimal.py

@@ -1,6 +1,6 @@
 import sys
 from pathlib import Path
-from typing import Any, Dict
+from typing import Any, ClassVar, Dict
 
 import uvicorn
 from fastapi import APIRouter, Depends, FastAPI
@@ -82,7 +82,7 @@ def session_dependency_handler(view: ViewBase, dto: SessionDependency) -> Dict[s
 
 
 class UserDetailView(DetailViewBaseGeneric):
-    method_dependencies = {
+    method_dependencies: ClassVar = {
         HTTPMethod.ALL: HTTPMethodConfig(
             dependencies=SessionDependency,
             prepare_data_layer_kwargs=session_dependency_handler,
@@ -91,7 +91,7 @@ class UserDetailView(DetailViewBaseGeneric):
 
 
 class UserListView(ListViewBaseGeneric):
-    method_dependencies = {
+    method_dependencies: ClassVar = {
         HTTPMethod.ALL: HTTPMethodConfig(
             dependencies=SessionDependency,
             prepare_data_layer_kwargs=session_dependency_handler,

fastapi_jsonapi/api.py

@@ -5,6 +5,7 @@
     TYPE_CHECKING,
     Any,
     Callable,
+    ClassVar,
     Dict,
     Iterable,
     List,
@@ -56,7 +57,7 @@ class RoutersJSONAPI:
     """
 
     # xxx: store in app, not in routers!
-    all_jsonapi_routers: Dict[str, "RoutersJSONAPI"] = {}
+    all_jsonapi_routers: ClassVar[Dict[str, "RoutersJSONAPI"]] = {}
     Methods = ViewMethods
     DEFAULT_METHODS = tuple(str(method) for method in ViewMethods)
 
@@ -172,6 +173,8 @@ def get_endpoint_name(
         kind: Literal["list", "detail"],
     ):
         """
+        Generate view name
+
         :param action
         :param kind: list / detail
         :return:
@@ -458,6 +461,8 @@ async def handle_view_dependencies(
         method: HTTPMethod,
     ) -> Dict[str, Any]:
         """
+        Combines all dependencies (prepared) and returns them as list
+
         Consider method config is already prepared for generic views
         Reuse the same config for atomic operations
 
@@ -483,6 +488,7 @@ def handle_dependencies(**dep_kwargs):
     def _create_get_resource_list_view(self):
         """
         Create wrapper for GET list (get objects list)
+
         :return:
         """
 

fastapi_jsonapi/atomic/atomic.py

@@ -38,7 +38,7 @@ async def view_atomic(
             return result
         return Response(status_code=status.HTTP_204_NO_CONTENT)
 
-    def _register_view(self):
+    def _register_view(self) -> None:
         self.router.add_api_route(
             path=self.url_path,
             endpoint=self.view_atomic,

fastapi_jsonapi/atomic/atomic_handler.py

@@ -75,6 +75,8 @@ def __init__(
 
     async def prepare_one_operation(self, operation: AtomicOperation):
         """
+        Prepare one atomic operation
+
         :param operation:
         :return:
         """

fastapi_jsonapi/atomic/prepared_atomic_operation.py

@@ -178,6 +178,8 @@ async def handle(
         dl: BaseDataLayer,
     ) -> None:
         """
+        Calls view to delete object
+
         Todo: fix atomic delete
          Deleting Resources
            An operation that deletes a resource

fastapi_jsonapi/atomic/schemas.py

@@ -39,6 +39,7 @@ class OperationItemInSchema(BaseModel):
 
 class AtomicOperationRef(BaseModel):
     """
+    This schema represents operation ref - reference to a resource
 
     ref: an object that MUST contain one of the following combinations of members:
         type and id: to target an individual resource.
@@ -57,8 +58,7 @@ class AtomicOperationRef(BaseModel):
     @root_validator
     def validate_atomic_operation_ref(cls, values: dict):
         """
-        type is required on schema
-        so id or lid has to be present
+        type is required on schema, so id or lid has to be present
 
         :param values:
         :return:
@@ -125,6 +125,8 @@ class AtomicOperation(BaseModel):
     @classmethod
     def _validate_one_of_ref_or_href(cls, values: dict):
         """
+        Make sure ref confirms spec
+
         An operation object MAY contain either of the following members,
         but not both, to specify the target of the operation: (ref, href)
 
@@ -152,6 +154,8 @@ def _validate_one_of_ref_or_href(cls, values: dict):
     @root_validator
     def validate_operation(cls, values: dict):
         """
+        Make sure atomic operation request conforms the spec
+
         :param values:
         :return:
         """

fastapi_jsonapi/data_layers/base.py

@@ -1,5 +1,6 @@
 """
 The base class of a data layer.
+
 If you want to create your own data layer
 you must inherit from this base class
 """
@@ -30,6 +31,8 @@ def __init__(
         **kwargs,
     ):
         """
+        Init
+
         :param request:
         :param schema:
         :param model:
@@ -70,6 +73,8 @@ def _apply_client_generated_id(
         model_kwargs: dict,
     ):
         """
+        Set custom id (if allowed)
+
         :param data_create: the data validated by pydantic.
         :param model_kwargs: the data validated by pydantic.
         """
@@ -101,6 +106,7 @@ async def create_object(self, data_create: BaseJSONAPIItemInSchema, view_kwargs:
     def get_object_id_field_name(self):
         """
         compound key may cause errors
+
         :return:
         """
         return self.id_name_field
@@ -249,6 +255,7 @@ def get_related_object_query(
     ):
         """
         Prepare query to get related object
+
         :param related_model:
         :param related_id_field:
         :param id_value:
@@ -264,6 +271,7 @@ def get_related_objects_list_query(
     ):
         """
         Prepare query to get related objects list
+
         :param related_model:
         :param related_id_field:
         :param ids:

fastapi_jsonapi/data_layers/filtering/sqlalchemy.py

@@ -45,6 +45,7 @@
 def create_filters(model: Type[TypeModel], filter_info: Union[list, dict], schema: Type[TypeSchema]):
     """
     Apply filters from filters information to base query
+
     :param model: the model of the node
     :param filter_info: current node filter information
     :param schema: the resource
@@ -91,6 +92,7 @@ def _cast_value_with_scheme(self, field_types: List[ModelField], value: Any) ->
     def create_filter(self, schema_field: ModelField, model_column, operator, value):
         """
         Create sqlalchemy filter
+
         :param schema_field:
         :param model_column: column sqlalchemy
         :param operator:
@@ -155,9 +157,12 @@ def create_filter(self, schema_field: ModelField, model_column, operator, value)
 
     def _separate_types(self, types: List[Type]) -> Tuple[List[Type], List[Type]]:
         """
-        Separates the types into two kinds. The first are those for which
+        Separates the types into two kinds.
+
+        The first are those for which
         there are already validators defined by pydantic - str, int, datetime
-        and some other built-in types. The second are all other types for which
+        and some other built-in types.
+        The second are all other types for which
         the `arbitrary_types_allowed` config is applied when defining the pydantic model
         """
         pydantic_types = [
@@ -287,7 +292,8 @@ def _relationship_filtering(self, value):
 
     def _create_filters(self, type_filter: str) -> FilterAndJoins:
         """
-        Создаём  фильтр or или and
+        Create or / and filters
+
         :param type_filter: 'or' или 'and'
         :return:
         """