base-api-utils 1.1.100__tar.gz → 1.1.102__tar.gz

{base_api_utils-1.1.100/src/base_api_utils.egg-info → base_api_utils-1.1.102}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: base-api-utils
-Version: 1.1.100
+Version: 1.1.102
 Summary: Django Rest Framework micro services common utilities
 Author-email: Román Gutierrez <roman@tipit.net>, Sebastian Marcet <sebastian@tipit.net>
 Project-URL: Homepage, https://github.com/fntechgit/base-api-utils

{base_api_utils-1.1.100 → base_api_utils-1.1.102}/pyproject.toml

@@ -7,7 +7,7 @@ where = ["src"]
 
 [project]
 name = "base-api-utils"
-version = "1.1.100"
+version = "1.1.102"
 dependencies = [
     "boto3",
     "celery",

{base_api_utils-1.1.100 → base_api_utils-1.1.102}/src/base_api_utils/filters/filter_utils_mixin.py

@@ -52,3 +52,7 @@ class FilterUtilsMixin:
         except ValueError:
             raise ValidationError("Invalid filter format. Expected 'key=value'.")
         return field_name, operator, value
+
+    def filter_isnull(self, queryset, field_name, value):
+        is_null = str(value).lower() == 'true'
+        return Q(**{f"{field_name}__isnull": is_null})

{base_api_utils-1.1.100 → base_api_utils-1.1.102}/src/base_api_utils/utils/__init__.py

@@ -6,6 +6,7 @@ from .debounce_helpers import debounce_task
 from .enums import EnumChoices
 from .env_var_eval import env_bool
 from .exceptions import S3Exception, custom_exception_handler
+from .expand_queryset_optimization_mixin import ExpandQuerysetOptimizationMixin
 from .external_errors import NamedCircuitBreakerError, handle_external_service_errors
 from .file_lock import FileLock
 from .fingerprint_helpers import (

base_api_utils-1.1.102/src/base_api_utils/utils/expand_queryset_optimization_mixin.py

@@ -0,0 +1,140 @@
+from typing import Any, Iterable, List, Set, Tuple
+
+from rest_framework.response import Response
+
+from src.base_api_utils.serializers.v2.query_params import (
+    parse_request_trees,
+    should_expand,
+    subtree,
+)
+
+class ExpandQuerysetOptimizationMixin:
+    """Auto-optimizes queryset from serializer.expand_mappings (recursive), plus runs bulk hooks for computed relations."""
+
+    def _parse_trees(self):
+        return parse_request_trees(self.request)
+
+    def _include_field(self, fields_tree: dict | None, attr: str) -> bool:
+        if fields_tree is None:
+            return True
+        return attr in fields_tree
+
+    def _collect_orm_recursive(
+        self,
+        serializer_cls: type,
+        *,
+        expand_tree: dict,
+        fields_tree: dict | None,
+        relations_tree: dict | None,
+        prefix: str = "",
+    ) -> Tuple[Set[str], Set[str], List[Tuple[str, dict, dict | None, dict | None]]]:
+        select_paths: Set[str] = set()
+        prefetch_paths: Set[str] = set()
+        bulk_hooks: List[Tuple[str, dict, dict | None, dict | None]] = []
+
+        mappings = getattr(serializer_cls, "expand_mappings", {}) or {}
+        for attr, spec in mappings.items():
+            if not spec:
+                continue
+
+            orm = spec.get("orm") or {}
+            verify = bool(spec.get("verify_relation", False))
+
+            is_included = self._include_field(fields_tree, attr)
+            is_expanded = should_expand(expand_tree, relations_tree, attr, verify)
+
+            for sr in orm.get("select_related", []) or []:
+                if is_expanded:
+                    select_paths.add(f"{prefix}{sr}" if prefix else sr)
+
+            for pr in orm.get("prefetch_related", []) or []:
+                if is_included:
+                    prefetch_paths.add(f"{prefix}{pr}" if prefix else pr)
+
+            hook = orm.get("bulk_prefetch")
+            if hook and is_expanded:
+                bulk_hooks.append(
+                    (
+                        hook,
+                        subtree(expand_tree, attr) or {},
+                        subtree(fields_tree, attr),
+                        subtree(relations_tree, attr),
+                    )
+                )
+
+            # recurse only if expanded
+            if is_expanded:
+                child_cls = spec.get("serializer")
+                if child_cls:
+                    child_expand = subtree(expand_tree, attr) or {}
+                    child_fields = subtree(fields_tree, attr)
+                    child_relations = subtree(relations_tree, attr)
+
+                    join_seg = spec.get("source") or attr
+                    if orm.get("nested_prefix") is not None:
+                        join_seg = orm.get("nested_prefix")
+
+                    # If this relation is computed/bulk, we can't build ORM paths on base qs,
+                    # but recursion still matters for hooks (they get subtrees).
+                    if not orm.get("bulk_prefetch"):
+                        child_prefix = (
+                            f"{prefix}{join_seg}__" if prefix else f"{join_seg}__"
+                        )
+                        c_sel, c_pre, c_hooks = self._collect_orm_recursive(
+                            child_cls,
+                            expand_tree=child_expand,
+                            fields_tree=child_fields,
+                            relations_tree=child_relations,
+                            prefix=child_prefix,
+                        )
+                        select_paths |= c_sel
+                        prefetch_paths |= c_pre
+                        bulk_hooks += c_hooks
+
+        return select_paths, prefetch_paths, bulk_hooks
+
+    def get_queryset(self):
+        qs = super().get_queryset()
+        expand_tree, fields_tree, relations_tree = self._parse_trees()
+        serializer_cls = self.get_serializer_class()
+
+        select_paths, prefetch_paths, _ = self._collect_orm_recursive(
+            serializer_cls,
+            expand_tree=expand_tree,
+            fields_tree=fields_tree,
+            relations_tree=relations_tree,
+            prefix="",
+        )
+
+        if select_paths:
+            qs = qs.select_related(*sorted(select_paths))
+        if prefetch_paths:
+            qs = qs.prefetch_related(*sorted(prefetch_paths))
+        return qs
+
+    def _run_bulk_hooks(self, objects: Iterable[Any]):
+        expand_tree, fields_tree, relations_tree = self._parse_trees()
+        serializer_cls = self.get_serializer_class()
+        _, _, hooks = self._collect_orm_recursive(
+            serializer_cls,
+            expand_tree=expand_tree,
+            fields_tree=fields_tree,
+            relations_tree=relations_tree,
+            prefix="",
+        )
+        for hook_name, ex_sub, fi_sub, rel_sub in hooks:
+            fn = getattr(self, f"bulk_prefetch__{hook_name}", None)
+            if fn:
+                fn(objects, ex_sub, fi_sub, rel_sub)
+
+    def list(self, request, *args, **kwargs):
+        queryset = self.filter_queryset(self.get_queryset())
+        page = self.paginate_queryset(queryset)
+        items = page if page is not None else list(queryset)
+
+        self._run_bulk_hooks(items)
+
+        serializer = self.get_serializer(items, many=True)
+        if page is not None:
+            return self.get_paginated_response(serializer.data)
+        return Response(serializer.data)

{base_api_utils-1.1.100 → base_api_utils-1.1.102}/src/base_api_utils/views/base_view.py

@@ -1,8 +1,9 @@
 from rest_framework.viewsets import ModelViewSet
-from ..utils import config, ReadWriteSerializerMixin
 
+from ..utils import config, ReadWriteSerializerMixin, ExpandQuerysetOptimizationMixin
 
-class BaseView(ReadWriteSerializerMixin, ModelViewSet):
+
+class BaseView(ReadWriteSerializerMixin, ExpandQuerysetOptimizationMixin, ModelViewSet):
     ordering_fields = {}
 
     def get_queryset(self):

{base_api_utils-1.1.100 → base_api_utils-1.1.102/src/base_api_utils.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: base-api-utils
-Version: 1.1.100
+Version: 1.1.102
 Summary: Django Rest Framework micro services common utilities
 Author-email: Román Gutierrez <roman@tipit.net>, Sebastian Marcet <sebastian@tipit.net>
 Project-URL: Homepage, https://github.com/fntechgit/base-api-utils

{base_api_utils-1.1.100 → base_api_utils-1.1.102}/src/base_api_utils.egg-info/SOURCES.txt

@@ -83,6 +83,7 @@ src/base_api_utils/utils/debounce_helpers.py
 src/base_api_utils/utils/enums.py
 src/base_api_utils/utils/env_var_eval.py
 src/base_api_utils/utils/exceptions.py
+src/base_api_utils/utils/expand_queryset_optimization_mixin.py
 src/base_api_utils/utils/external_errors.py
 src/base_api_utils/utils/file_lock.py
 src/base_api_utils/utils/fingerprint_helpers.py