Merge pull request #49 from namespace-ee/documentation-and-prefetch-ordering

Django 5 support

Author: lnagel

.travis.yml

@@ -8,11 +8,12 @@ python:
   - "3.9"
   - "3.10"
   - "3.11"
+  - "3.12"
 
 matrix:
   fast_finish: true
   include:
-    - python: 3.11
+    - python: 3.12
       env: TOXENV=lint
 
 # command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors

HISTORY.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 2.2.0 (2024-10-22)
+- Support for Django 5
+  - Django supported versions `5.0 -> 5.1`
+  - Python supported versions `3.10 -> 3.12`
+  - Django-rest-framework supported versions. `3.15`
+- Add support for request dependant prefetch filtering
+- refactored code for better readability
+- prefetches from view are also used when determining sideloading prefetches
+- Add support for drf_spectacular documentation
+- Add prefetch related support for multi source fields
+
 ## 2.1.0 (2024-01-26)
 
 - Support for Django 4

README.md

@@ -127,6 +127,7 @@ DRF-sideloading is an extension to provide side-loading functionality of related
    Include **SideloadableRelationsMixin** mixin in ViewSet and define **sideloading_serializer_class** as shown in example below. 
    Everything else stays just like a regular ViewSet.
    Since version 2.0.0 there are 3 new methods that allow to overwrite the serializer used based on the request version for example
+   Since version 2.1.0 an additional method was added that allow to add request dependent filters to sideloaded relations
 
     ```python
     from drf_sideloading.mixins import SideloadableRelationsMixin
@@ -144,11 +145,11 @@ DRF-sideloading is an extension to provide side-loading functionality of related
             # Add prefetches for the viewset as normal 
             return super().get_queryset().prefetch_related("created_by")
    
-        def get_sideloading_serializer_class(self):
+        def get_sideloading_serializer_class(self, request=None):
             # use a different sideloadable serializer for older version 
             if self.request.version < "1.0.0":
                 return OldProductSideloadableSerializer
-            return super().get_sideloading_serializer_class()
+            return super().get_sideloading_serializer_class(request=request)
    
         def get_sideloading_serializer(self, *args, **kwargs):
             # if modifications are required to the serializer initialization this method can be used.
@@ -157,6 +158,14 @@ DRF-sideloading is an extension to provide side-loading functionality of related
         def get_sideloading_serializer_context(self):
             # Extra context provided to the serializer class.
             return {"request": self.request, "format": self.format_kwarg, "view": self}
+      
+        def add_sideloading_prefetch_filter(self, source, queryset, request):
+             # 
+            if source == "model1__relation1":
+                return queryset.filter(is_active=True), True
+            if hasattr(queryset, "readable"):
+                return queryset.readable(user=request.user), True
+            return queryset, False
     ```
 
 6. Enjoy your API with sideloading support