django-ninja-aio-crud 2.10.1__py3-none-any.whl → 2.11.0__py3-none-any.whl

{django_ninja_aio_crud-2.10.1.dist-info → django_ninja_aio_crud-2.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-ninja-aio-crud
-Version: 2.10.1
+Version: 2.11.0
 Summary: Django Ninja AIO CRUD - Rest Framework
 Author: Giuseppe Casillo
 Requires-Python: >=3.10, <3.15

{django_ninja_aio_crud-2.10.1.dist-info → django_ninja_aio_crud-2.11.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-ninja_aio/__init__.py,sha256=89U1Dj8vplVSbgWDcQsklzcAzW070HQlarC0u9_LOX4,120
+ninja_aio/__init__.py,sha256=HbzxvEfM0l-SDrJKZVbQVJlyH0xXwCQMNB6zSwH9Onw,120
 ninja_aio/api.py,sha256=tuC7vdvn7s1GkCnSFy9Kn1zv0glZfYptRQVvo8ZRtGQ,2429
 ninja_aio/auth.py,sha256=4sWdFPjKiQgUL1d_CSGDblVjnY5ptP6LQha6XXdluJA,9157
 ninja_aio/exceptions.py,sha256=_3xFqfFCOfrrMhSA0xbMqgXy8R0UQjhXaExrFvaDAjY,3891
@@ -16,14 +16,15 @@ ninja_aio/helpers/query.py,sha256=NMGkS_v-ZVYKNtf1XohEUzfwca52Eq5FTcQ5lehHjus,46
 ninja_aio/models/__init__.py,sha256=L3UQnQAlKoI3F7jinadL-Nn55hkPvnSRPYW0JtnbWFo,114
 ninja_aio/models/serializers.py,sha256=I7pUz_vl0FElaVsrGaogT_Lj9T4uaNG7UDMGf5VMwW4,38468
 ninja_aio/models/utils.py,sha256=dxzwqE25b0lFZ--30XxeIJB-y4xbIDtc624vGaa_wOg,32885
-ninja_aio/schemas/__init__.py,sha256=_a092xZezlLc9QWCPWrybeklByCs39jbvf33zwdnrys,603
-ninja_aio/schemas/api.py,sha256=InzZgIFU4Zxkgj9u_zZzAMYs_vdaPD5eu12gG7xAFoQ,1047
+ninja_aio/schemas/__init__.py,sha256=dHILiYBKMb51lDcyQdiXRw_0nzqM7Lu81UX2hv7kEfo,837
+ninja_aio/schemas/api.py,sha256=dGUpJXR1iAf93QNR4kYj1uqIkTjiMfXultCotY6GtaQ,361
+ninja_aio/schemas/filters.py,sha256=VxzH2xSWok8cUSkyfeqtrGhRewtFVmNHQfHNvY8Aynw,2662
 ninja_aio/schemas/generics.py,sha256=frjJsKJMAdM_NdNKv-9ddZNGxYy5PNzjIRGtuycgr-w,112
 ninja_aio/schemas/helpers.py,sha256=Vti5BfHWpxaJXj_ixZBJb34VRwhHODrlVjRlIuHh_ug,8428
 ninja_aio/views/__init__.py,sha256=DEzjWA6y3WF0V10nNF8eEurLNEodgxKzyFd09AqVp3s,148
-ninja_aio/views/api.py,sha256=LUJBvD7oxE3nq6DlMDOHYzNi2KBYQMSbb7SzfZdqcp0,22197
-ninja_aio/views/mixins.py,sha256=YKdJVCjya-VB8bs62DNQZ9Gj3qHpsEJ-2257RbI0K1A,14238
-django_ninja_aio_crud-2.10.1.dist-info/licenses/LICENSE,sha256=yrDAYcm0gRp_Qyzo3GQa4BjYjWRkAhGC8QRva__RYq0,1073
-django_ninja_aio_crud-2.10.1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-django_ninja_aio_crud-2.10.1.dist-info/METADATA,sha256=G-t2gFVZicsgYER6sY8HKnSwcNUfBwgClgRqkMRVCUE,9964
-django_ninja_aio_crud-2.10.1.dist-info/RECORD,,
+ninja_aio/views/api.py,sha256=AAqkj0xT8J3PmJvsbluZ33cfrmrXJHiV9ARe2BqnfQ8,22492
+ninja_aio/views/mixins.py,sha256=Zl6J8gbVagwT85bzDuKyJTk3iFxxFgX0YgYkjiUxZGg,17040
+django_ninja_aio_crud-2.11.0.dist-info/licenses/LICENSE,sha256=yrDAYcm0gRp_Qyzo3GQa4BjYjWRkAhGC8QRva__RYq0,1073
+django_ninja_aio_crud-2.11.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+django_ninja_aio_crud-2.11.0.dist-info/METADATA,sha256=GtNHDrOvlRcojF2TWz5UPOla1cuslKzAqA7uTqUb9Z0,9964
+django_ninja_aio_crud-2.11.0.dist-info/RECORD,,

ninja_aio/__init__.py

@@ -1,6 +1,6 @@
 """Django Ninja AIO CRUD - Rest Framework"""
 
-__version__ = "2.10.1"
+__version__ = "2.11.0"
 
 from .api import NinjaAIO
 

ninja_aio/schemas/__init__.py

@@ -5,9 +5,20 @@ from .api import (
     M2MAddSchemaIn,
     M2MRemoveSchemaIn,
     M2MSchemaIn,
+)
+from .filters import (
     RelationFilterSchema,
+    MatchCaseFilterSchema,
+    MatchConditionFilterSchema,
+    BooleanMatchFilterSchema,
+)
+from .helpers import (
+    M2MRelationSchema,
+    QuerySchema,
+    ModelQuerySetSchema,
+    ObjectQuerySchema,
+    ObjectsQuerySchema,
 )
-from .helpers import M2MRelationSchema, QuerySchema, ModelQuerySetSchema, ObjectQuerySchema, ObjectsQuerySchema
 
 __all__ = [
     "GenericMessageSchema",
@@ -22,4 +33,7 @@ __all__ = [
     "ObjectQuerySchema",
     "ObjectsQuerySchema",
     "RelationFilterSchema",
+    "MatchCaseFilterSchema",
+    "MatchConditionFilterSchema",
+    "BooleanMatchFilterSchema",
 ]

ninja_aio/schemas/api.py

@@ -1,5 +1,3 @@
-from typing import Any
-
 from ninja import Schema
 
 
@@ -24,20 +22,3 @@ class M2MRemoveSchemaIn(Schema):
 class M2MSchemaIn(Schema):
     add: list = []
     remove: list = []
-
-
-class RelationFilterSchema(Schema):
-    """
-    Schema for configuring relation-based filters in RelationFilterViewSetMixin.
-
-    Attributes:
-        filter_type: A tuple of (type, default_value) used to generate the query parameter
-            field in the filters schema. Example: (int, None) for optional integer filter.
-        query_param: The name of the query parameter exposed in the API endpoint.
-            This is what clients will use in requests (e.g., ?author_id=5).
-        query_filter: The Django ORM lookup to apply (e.g., "author__id", "category__slug").
-    """
-
-    filter_type: tuple[type, Any]
-    query_param: str
-    query_filter: str

ninja_aio/schemas/filters.py

@@ -0,0 +1,73 @@
+from typing import Any
+
+from ninja import Schema
+
+
+class FilterSchema(Schema):
+    """
+    Schema for configuring basic filters in FilterViewSetMixin.
+
+    Attributes:
+        filter_type: A tuple of (type, default_value) used to generate the query parameter
+            field in the filters schema. Example: (str, None) for optional string filter.
+        query_param: The name of the query parameter exposed in the API endpoint.
+            This is what clients will use in requests (e.g., ?name=example).
+    """
+
+    filter_type: tuple[type, Any]
+    query_param: str
+
+
+class MatchConditionFilterSchema(Schema):
+    """
+    Schema for configuring match condition filters in MatchConditionFilterViewSetMixin.
+    Attributes:
+        query_filter: The Django ORM lookup to apply (e.g., "status", "category__name").
+        include: Whether to include records matching the condition (default: True).
+    """
+    query_filter: dict[str, Any]
+    include: bool = True
+
+
+class BooleanMatchFilterSchema(Schema):
+    """
+    Schema for configuring boolean match filters in BooleanMatchFilterViewSetMixin.
+
+    Attributes:
+        true: MatchConditionFilterSchema for when the boolean filter is True.
+        false: MatchConditionFilterSchema for when the boolean filter is False.
+    """
+
+    true: MatchConditionFilterSchema
+    false: MatchConditionFilterSchema
+
+
+class RelationFilterSchema(FilterSchema):
+    """
+    Schema for configuring relation-based filters in RelationFilterViewSetMixin.
+
+    Attributes:
+        filter_type: A tuple of (type, default_value) used to generate the query parameter
+            field in the filters schema. Example: (int, None) for optional integer filter.
+        query_param: The name of the query parameter exposed in the API endpoint.
+            This is what clients will use in requests (e.g., ?author_id=5).
+        query_filter: The Django ORM lookup to apply (e.g., "author__id", "category__slug").
+    """
+
+    query_filter: str
+
+
+class MatchCaseFilterSchema(FilterSchema):
+    """
+    Schema for configuring match-case filters in MatchCaseFilterViewSetMixin.
+
+    Attributes:
+        filter_type: A tuple of (type, default_value) used to generate the query parameter
+            field in the filters schema. Defaults to (bool, None) for optional boolean filter.
+        query_param: The name of the query parameter exposed in the API endpoint.
+            This is what clients will use in requests (e.g., ?is_active=true).
+        cases: A BooleanMatchFilterSchema defining the filter conditions for True and False cases.
+    """
+
+    filter_type: tuple[type, Any] = (bool, None)
+    cases: BooleanMatchFilterSchema

ninja_aio/views/api.py

@@ -314,6 +314,14 @@ class APIViewSet(API):
     def _check_relations_filters(self, filter: str):
         return filter in getattr(self, "relations_filters_fields", [])
 
+    def _check_match_cases_filters(self, filter: str):
+        return filter in getattr(self, "filters_match_cases_fields", [])
+
+    def _is_special_filter(self, filter: str):
+        return self._check_relations_filters(filter) or self._check_match_cases_filters(
+            filter
+        )
+
     def _auth_view(self, view_type: str):
         """
         Resolve auth for a specific HTTP verb; falls back to self.auth if NOT_SET.

ninja_aio/views/mixins.py

@@ -1,5 +1,5 @@
 from ninja_aio.views.api import APIViewSet
-from ninja_aio.schemas import RelationFilterSchema
+from ninja_aio.schemas import RelationFilterSchema, MatchCaseFilterSchema
 
 
 class IcontainsFilterViewSetMixin(APIViewSet):
@@ -56,7 +56,7 @@ class IcontainsFilterViewSetMixin(APIViewSet):
             **{
                 f"{key}__icontains": value
                 for key, value in filters.items()
-                if isinstance(value, str) and not self._check_relations_filters(key)
+                if isinstance(value, str) and not self._is_special_filter(key)
             }
         )
 
@@ -98,7 +98,7 @@ class BooleanFilterViewSetMixin(APIViewSet):
             **{
                 key: value
                 for key, value in filters.items()
-                if isinstance(value, bool) and not self._check_relations_filters(key)
+                if isinstance(value, bool) and not self._is_special_filter(key)
             }
         )
 
@@ -140,8 +140,7 @@ class NumericFilterViewSetMixin(APIViewSet):
             **{
                 key: value
                 for key, value in filters.items()
-                if isinstance(value, (int, float))
-                and not self._check_relations_filters(key)
+                if isinstance(value, (int, float)) and not self._is_special_filter(key)
             }
         )
 
@@ -183,8 +182,7 @@ class DateFilterViewSetMixin(APIViewSet):
             **{
                 f"{key}{self._compare_attr}": value
                 for key, value in filters.items()
-                if hasattr(value, "isoformat")
-                and not self._check_relations_filters(key)
+                if hasattr(value, "isoformat") and not self._is_special_filter(key)
             }
         )
 
@@ -346,3 +344,70 @@ class RelationFilterViewSetMixin(APIViewSet):
             if value is not None:
                 rel_filters[rel_filter.query_filter] = value
         return base_qs.filter(**rel_filters) if rel_filters else base_qs
+
+
+class MatchCaseFilterViewSetMixin(APIViewSet):
+    """
+    Mixin providing match-case filtering for Django QuerySets.
+    This mixin applies filters based on boolean query parameters defined in
+    MatchCaseFilterSchema entries. Each entry specifies different filter conditions
+    for True and False cases.
+    Attributes:
+        filters_match_cases: List of MatchCaseFilterSchema defining the match-case filters.
+            Each schema specifies:
+            - query_param: The API query parameter name (e.g., "is_active")
+            - cases: A BooleanMatchFilterSchema with 'true' and 'false' MatchConditionFilterSchema
+    Example:
+        class UserViewSet(MatchCaseFilterViewSetMixin, APIViewSet):
+            filters_match_cases = [
+                MatchCaseFilterSchema(
+                    query_param="is_active",
+                    cases=BooleanMatchFilterSchema(
+                        true=MatchConditionFilterSchema(
+                            query_filter={"status": "active"},
+                            include=True,
+                        ),
+                        false=MatchConditionFilterSchema(
+                            query_filter={"status": "inactive"},
+                            include=True,
+                        ),
+                    ),
+                ),
+            ]
+        # GET /users?is_active=true -> queryset.filter(status="active")
+        # GET /users?is_active=false -> queryset.filter(status="inactive")
+    Notes:
+        - If the query parameter is not provided, no filtering is applied for that case.
+        - This mixin automatically registers query_params from filters_match_cases.
+    """
+
+    filters_match_cases: list[MatchCaseFilterSchema] = []
+
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+        cls.query_params = {
+            **cls.query_params,
+            **{
+                filter_match.query_param: filter_match.filter_type
+                for filter_match in cls.filters_match_cases
+            },
+        }
+
+    @property
+    def filters_match_cases_fields(self):
+        return [filter_match.query_param for filter_match in self.filters_match_cases]
+
+    async def query_params_handler(self, queryset, filters):
+        base_qs = await super().query_params_handler(queryset, filters)
+        for filter_match in self.filters_match_cases:
+            value = filters.get(filter_match.query_param)
+            if value is not None:
+                case_filter = (
+                    filter_match.cases.true if value else filter_match.cases.false
+                )
+                lookup = case_filter.query_filter
+                if case_filter.include:
+                    base_qs = base_qs.filter(**lookup)
+                else:
+                    base_qs = base_qs.exclude(**lookup)
+        return base_qs