django-ninja-aio-crud 2.9.0__py3-none-any.whl → 2.10.0__py3-none-any.whl

{django_ninja_aio_crud-2.9.0.dist-info → django_ninja_aio_crud-2.10.0.dist-info}/METADATA

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

{django_ninja_aio_crud-2.9.0.dist-info → django_ninja_aio_crud-2.10.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-ninja_aio/__init__.py,sha256=YE75I1ewNyWylWEf1tZjFFmQlFLdsdYyYiQgxSr1Jdk,119
+ninja_aio/__init__.py,sha256=FZKyvJwguGusKjYpVUXSYB45Fssox9yEFHg47WX0BaE,120
 ninja_aio/api.py,sha256=tuC7vdvn7s1GkCnSFy9Kn1zv0glZfYptRQVvo8ZRtGQ,2429
 ninja_aio/auth.py,sha256=4sWdFPjKiQgUL1d_CSGDblVjnY5ptP6LQha6XXdluJA,9157
 ninja_aio/exceptions.py,sha256=_3xFqfFCOfrrMhSA0xbMqgXy8R0UQjhXaExrFvaDAjY,3891
@@ -15,15 +15,15 @@ ninja_aio/helpers/api.py,sha256=2beyexep-ehgaA_1bV5Yuh3zRDVcRCMkrW94nmfDWEA,2081
 ninja_aio/helpers/query.py,sha256=NMGkS_v-ZVYKNtf1XohEUzfwca52Eq5FTcQ5lehHjus,4682
 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=N7waJGOCsoFvbbO1xXy94acKeG85WRK3hjZJz7IukhU,32885
-ninja_aio/schemas/__init__.py,sha256=iLBwHg0pmL9k_UkIui5Q8QIl_gO4fgxSv2JHxDzqnSI,549
-ninja_aio/schemas/api.py,sha256=-VwXhBRhmMsZLIAmWJ-P7tB5klxXS75eukjabeKKYsc,360
+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/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=CW74JB1tsdWfv3Y3x4K9o8yXsrMxCKWZ4QalhqJGan8,22072
-ninja_aio/views/mixins.py,sha256=Jh6BG8Cs823nurVlODlzCquTxKrLH7Pmo5udPqUGZek,11378
-django_ninja_aio_crud-2.9.0.dist-info/licenses/LICENSE,sha256=yrDAYcm0gRp_Qyzo3GQa4BjYjWRkAhGC8QRva__RYq0,1073
-django_ninja_aio_crud-2.9.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-django_ninja_aio_crud-2.9.0.dist-info/METADATA,sha256=7hbmX5K1ixoBn0RnFlkpnp3runSgZ1pi70v606cUX3Q,9963
-django_ninja_aio_crud-2.9.0.dist-info/RECORD,,
+ninja_aio/views/mixins.py,sha256=01kEGMmpD3eTd8R5mX8sNr7KoizOfN0wvbV5y180IdE,13835
+django_ninja_aio_crud-2.10.0.dist-info/licenses/LICENSE,sha256=yrDAYcm0gRp_Qyzo3GQa4BjYjWRkAhGC8QRva__RYq0,1073
+django_ninja_aio_crud-2.10.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+django_ninja_aio_crud-2.10.0.dist-info/METADATA,sha256=-cSLMUj-s7djNL2RxRhLNkErv0yM49NK8CA8-zp-4zw,9964
+django_ninja_aio_crud-2.10.0.dist-info/RECORD,,

ninja_aio/__init__.py

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

ninja_aio/models/utils.py

@@ -566,10 +566,10 @@ class ModelUtil:
         serializable_fields = self._get_serializable_field_names(is_for)
         for f in serializable_fields:
             field_obj = getattr(self.model, f)
-            if isinstance(field_obj, ForwardManyToOneDescriptor):
+            if isinstance(field_obj, ForwardOneToOneDescriptor):
                 select_rels.append(f)
                 continue
-            if isinstance(field_obj, ForwardOneToOneDescriptor):
+            if isinstance(field_obj, ForwardManyToOneDescriptor):
                 select_rels.append(f)
         return select_rels
 

ninja_aio/schemas/__init__.py

@@ -5,6 +5,7 @@ from .api import (
     M2MAddSchemaIn,
     M2MRemoveSchemaIn,
     M2MSchemaIn,
+    RelationFilterSchema,
 )
 from .helpers import M2MRelationSchema, QuerySchema, ModelQuerySetSchema, ObjectQuerySchema, ObjectsQuerySchema
 
@@ -20,4 +21,5 @@ __all__ = [
     "ModelQuerySetSchema",
     "ObjectQuerySchema",
     "ObjectsQuerySchema",
+    "RelationFilterSchema",
 ]

ninja_aio/schemas/api.py

@@ -1,3 +1,5 @@
+from typing import Any
+
 from ninja import Schema
 
 
@@ -21,4 +23,21 @@ class M2MRemoveSchemaIn(Schema):
 
 class M2MSchemaIn(Schema):
     add: list = []
-    remove: 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/views/mixins.py

@@ -1,4 +1,5 @@
 from ninja_aio.views.api import APIViewSet
+from ninja_aio.schemas import RelationFilterSchema
 
 
 class IcontainsFilterViewSetMixin(APIViewSet):
@@ -273,3 +274,65 @@ class LessEqualDateFilterViewSetMixin(DateFilterViewSetMixin):
     """
 
     _compare_attr = "__lte"
+
+
+class RelationFilterViewSetMixin(APIViewSet):
+    """
+    Mixin providing filtering for related fields in Django QuerySets.
+
+    This mixin applies filters on related fields based on configured RelationFilterSchema
+    entries. Each entry maps a query parameter name to a Django ORM lookup path.
+
+    Attributes:
+        relations_filters: List of RelationFilterSchema defining the relation filters.
+            Each schema specifies:
+            - query_param: The API query parameter name (e.g., "author_id")
+            - query_filter: The Django ORM lookup (e.g., "author__id")
+            - filter_type: Tuple of (type, default) for schema generation
+
+    Example:
+        class BookViewSet(RelationFilterViewSetMixin, APIViewSet):
+            relations_filters = [
+                RelationFilterSchema(
+                    query_param="author_id",
+                    query_filter="author__id",
+                    filter_type=(int, None),
+                ),
+                RelationFilterSchema(
+                    query_param="category_slug",
+                    query_filter="category__slug",
+                    filter_type=(str, None),
+                ),
+            ]
+
+        # GET /books?author_id=5 -> queryset.filter(author__id=5)
+        # GET /books?category_slug=fiction -> queryset.filter(category__slug="fiction")
+
+    Notes:
+        - Filter values that are None or falsy are skipped.
+        - This mixin automatically registers query_params from relations_filters.
+    """
+
+    relations_filters: list[RelationFilterSchema] = []
+
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+        cls.query_params = {
+            **cls.query_params,
+            **{
+                rel_filter.query_param: rel_filter.filter_type
+                for rel_filter in cls.relations_filters
+            },
+        }
+
+    async def query_params_handler(self, queryset, filters):
+        """
+        Apply relation filters to the queryset based on configured relations_filters.
+        """
+        base_qs = await super().query_params_handler(queryset, filters)
+        rel_filters = {}
+        for rel_filter in self.relations_filters:
+            value = filters.get(rel_filter.query_param)
+            if value is not None:
+                rel_filters[rel_filter.query_filter] = value
+        return base_qs.filter(**rel_filters) if rel_filters else base_qs