Update ruff black linters

.pre-commit-config.yaml

@@ -10,12 +10,12 @@ repos:
       - id: requirements-txt-fixer
 
   - repo: https://github.com/psf/black
-    rev: "23.3.0"
+    rev: "24.4.2"
     hooks:
       - id: black
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.1.8"
+    rev: "v0.4.10"
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix, --unsafe-fixes]

docs/changelog.rst

@@ -1,6 +1,20 @@
 Changelog
 #########
 
+**2.8.0**
+*********
+
+Performance improvements
+========================
+
+* added simple cache to SchemaBuilder by `@CosmoV`_ in `#87 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/87>`_
+
+Authors
+"""""""
+
+* `@CosmoV`_
+
+
 **2.7.0**
 *********
 

examples/api_for_sqlalchemy/main.py

@@ -3,6 +3,7 @@
 
 In module placed db initialization functions, app factory.
 """
+
 import sys
 from pathlib import Path
 

examples/api_for_sqlalchemy/models/schemas/__init__.py

@@ -1,6 +1,5 @@
 """schemas package."""
 
-
 from .child import (
     ChildInSchema,
     ChildPatchSchema,

examples/api_for_sqlalchemy/models/schemas/post_comment.py

@@ -1,4 +1,5 @@
 """Post Comment schemas module."""
+
 from datetime import datetime
 from typing import TYPE_CHECKING
 

examples/api_for_sqlalchemy/models/schemas/user.py

@@ -1,4 +1,5 @@
 """User schemas module."""
+
 from __future__ import annotations
 
 from datetime import datetime

examples/api_for_sqlalchemy/models/user.py

@@ -1,4 +1,5 @@
 """User model."""
+
 from __future__ import annotations
 
 from sqlalchemy import Column, Integer, String

examples/api_for_sqlalchemy/models/user_bio.py

@@ -1,4 +1,5 @@
 """User Bio model."""
+
 from typing import Dict, List
 
 from sqlalchemy import JSON, Column, ForeignKey, Integer, String

examples/api_for_tortoise_orm/main.py

@@ -3,6 +3,7 @@
 
 In module placed db initialization functions, app factory.
 """
+
 import sys
 from pathlib import Path
 

examples/api_for_tortoise_orm/models/pydantic/__init__.py

@@ -1,6 +1,5 @@
 """W-mount schemas package."""
 
-
 from .user import (
     UserPatchSchema,
     UserSchema,

examples/api_for_tortoise_orm/models/tortoise/user.py

@@ -1,6 +1,5 @@
 """User model."""
 
-
 from tortoise import (
     fields,
     models,

fastapi_jsonapi/VERSION

@@ -1 +1 @@
-2.7.0
+2.8.0

fastapi_jsonapi/__init__.py

@@ -1,4 +1,5 @@
 """JSON API utils package."""
+
 from pathlib import Path
 
 from fastapi import FastAPI

fastapi_jsonapi/api.py

@@ -1,4 +1,5 @@
 """JSON API router class."""
+
 from enum import Enum, auto
 from inspect import Parameter, Signature, signature
 from typing import (
@@ -78,6 +79,7 @@ def __init__(
         pagination_default_offset: Optional[int] = None,
         pagination_default_limit: Optional[int] = None,
         methods: Iterable[str] = (),
+        max_cache_size: int = 0,
     ) -> None:
         """
         Initialize router items.
@@ -127,7 +129,7 @@ def __init__(
         self.pagination_default_number: Optional[int] = pagination_default_number
         self.pagination_default_offset: Optional[int] = pagination_default_offset
         self.pagination_default_limit: Optional[int] = pagination_default_limit
-        self.schema_builder = SchemaBuilder(resource_type=resource_type)
+        self.schema_builder = SchemaBuilder(resource_type=resource_type, max_cache_size=max_cache_size)
 
         dto = self.schema_builder.create_schemas(
             schema=schema,

fastapi_jsonapi/data_layers/filtering/sqlalchemy.py

@@ -1,4 +1,5 @@
 """Helper to create sqlalchemy filters according to filter querystring parameter"""
+
 import inspect
 import logging
 from collections.abc import Sequence

fastapi_jsonapi/data_layers/filtering/tortoise_operation.py

@@ -1,6 +1,7 @@
 """
 Previously used: '__'
 """
+
 from typing import Protocol
 
 
@@ -292,8 +293,7 @@ def type_op_ilike(field_name: str, type_op: str) -> str:
 
 
 class ProcessTypeOperationFieldName(Protocol):
-    def __call__(self, field_name: str, type_op: str) -> str:
-        ...
+    def __call__(self, field_name: str, type_op: str) -> str: ...
 
 
 filters_dict: dict[str, ProcessTypeOperationFieldName] = {

fastapi_jsonapi/data_layers/sorting/sqlalchemy.py

@@ -1,4 +1,5 @@
 """Helper to create sqlalchemy sortings according to filter querystring parameter"""
+
 from typing import Any, List, Tuple, Type, Union
 
 from pydantic.fields import ModelField

fastapi_jsonapi/data_layers/sqla_orm.py

@@ -1,4 +1,5 @@
 """This module is a CRUD interface between resource managers and the sqlalchemy ORM"""
+
 import logging
 from typing import TYPE_CHECKING, Any, Iterable, List, Literal, Optional, Tuple, Type, Union
 

fastapi_jsonapi/querystring.py

@@ -1,4 +1,5 @@
 """Helper to deal with querystring parameters according to jsonapi specification."""
+
 from collections import defaultdict
 from functools import cached_property
 from typing import (

fastapi_jsonapi/schema.py

@@ -3,6 +3,7 @@
 
 Pydantic (for FastAPI).
 """
+
 from typing import (
     TYPE_CHECKING,
     Dict,

fastapi_jsonapi/schema_builder.py

@@ -1,5 +1,7 @@
 """JSON API schemas builder class."""
+
 from dataclasses import dataclass
+from functools import lru_cache
 from typing import (
     Any,
     Callable,
@@ -122,8 +124,16 @@ class SchemaBuilder:
     def __init__(
         self,
         resource_type: str,
+        max_cache_size: int = 0,
     ):
         self._resource_type = resource_type
+        self._init_cache(max_cache_size)
+
+    def _init_cache(self, max_cache_size: int):
+        # TODO: remove crutch
+        self._get_info_from_schema_for_building_cached = lru_cache(maxsize=max_cache_size)(
+            self._get_info_from_schema_for_building_cached,
+        )
 
     def _create_schemas_objects_list(self, schema: Type[BaseModel]) -> Type[JSONAPIResultListSchema]:
         object_jsonapi_list_schema, list_jsonapi_schema = self.build_list_schemas(schema)
@@ -187,7 +197,7 @@ def build_schema_in(
     ) -> Tuple[Type[BaseJSONAPIDataInSchema], Type[BaseJSONAPIItemInSchema]]:
         base_schema_name = schema_in.__name__.removesuffix("Schema") + schema_name_suffix
 
-        dto = self._get_info_from_schema_for_building(
+        dto = self._get_info_from_schema_for_building_wrapper(
             base_name=base_schema_name,
             schema=schema_in,
             non_optional_relationships=non_optional_relationships,
@@ -258,6 +268,40 @@ def build_list_schemas(
             includes=includes,
         )
 
+    def _get_info_from_schema_for_building_cached(
+        self,
+        base_name: str,
+        schema: Type[BaseModel],
+        includes: Iterable[str],
+        non_optional_relationships: bool,
+    ):
+        return self._get_info_from_schema_for_building(
+            base_name=base_name,
+            schema=schema,
+            includes=includes,
+            non_optional_relationships=non_optional_relationships,
+        )
+
+    def _get_info_from_schema_for_building_wrapper(
+        self,
+        base_name: str,
+        schema: Type[BaseModel],
+        includes: Iterable[str] = not_passed,
+        non_optional_relationships: bool = False,
+    ):
+        """
+        Wrapper function for return cached schema result
+        """
+        if includes is not not_passed:
+            includes = tuple(includes)
+
+        return self._get_info_from_schema_for_building_cached(
+            base_name=base_name,
+            schema=schema,
+            includes=includes,
+            non_optional_relationships=non_optional_relationships,
+        )
+
     def _get_info_from_schema_for_building(
         self,
         base_name: str,
@@ -494,7 +538,7 @@ def create_jsonapi_object_schemas(
         if includes is not not_passed:
             includes = set(includes)
 
-        dto = self._get_info_from_schema_for_building(
+        dto = self._get_info_from_schema_for_building_wrapper(
             base_name=base_name,
             schema=schema,
             includes=includes,

fastapi_jsonapi/signature.py

@@ -1,4 +1,5 @@
 """Functions for extracting and updating signatures."""
+
 import inspect
 import logging
 from enum import Enum