fix prefetching

Author: tonisvain

HISTORY.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.4.1 (2021-04-09)
+
+- Fix sideloadable prefetches
+
 ## 1.4.0 (2021-04-07)
 
 - Python supported versions `3.6 -> 3.9`

README.md

@@ -14,100 +14,100 @@ DRF-sideloading is an extension to provide side-loading functionality of related
 
 ## Quickstart
 
-1. Install drf-sideloading:
+1.  Install drf-sideloading:
 
-```shell
-pip install drf-sideloading
-```
+    ```shell
+    pip install drf-sideloading
+    ```
 
 2. Import `SideloadableRelationsMixin`:
 
-```python
-from drf_sideloading.mixins import SideloadableRelationsMixin
-```
+    ```python
+    from drf_sideloading.mixins import SideloadableRelationsMixin
+    ```
 
 3. Write your SideLoadableSerializer
    You need to define the **primary** serializer in the Meta data and can define prefetching rules. Also notice the **many=True** on the sideloadable relationships.
 
-```python
-from drf_sideloading.serializers import SideLoadableSerializer
-
-class ProductSideloadableSerializer(SideLoadableSerializer):
-    products = ProductSerializer(many=True)
-    categories = CategorySerializer(source="category", many=True)
-    suppliers = SupplierSerializer(source="supplier", many=True)
-    partners = PartnerSerializer(many=True)
-
-    class Meta:
-        primary = "products"
-        prefetches = {
-            "categories": "category",
-            "suppliers": "supplier",
-            "partners": "partners",
-        }
-```
+    ```python
+    from drf_sideloading.serializers import SideLoadableSerializer
+    
+    class ProductSideloadableSerializer(SideLoadableSerializer):
+        products = ProductSerializer(many=True)
+        categories = CategorySerializer(source="category", many=True)
+        suppliers = SupplierSerializer(source="supplier", many=True)
+        partners = PartnerSerializer(many=True)
+    
+        class Meta:
+            primary = "products"
+            prefetches = {
+                "categories": "category",
+                "suppliers": "supplier",
+                "partners": "partners",
+            }
+    ```
 
 4. Configure sideloading
    Include **SideloadableRelationsMixin** mixin in ViewSet and define **sideloading_serializer_class** as shown in example below. Evrything else stays just like a regular ViewSet
 
-```python
-from drf_sideloading.mixins import SideloadableRelationsMixin
-
-class ProductViewSet(SideloadableRelationsMixin, viewsets.ModelViewSet):
-    """
-    A simple ViewSet for viewing and editing products.
-    """
-
-    queryset = Product.objects.all()
-    serializer_class = ProductSerializer
-    sideloading_serializer_class = ProductSideloadableSerializer
-```
+    ```python
+    from drf_sideloading.mixins import SideloadableRelationsMixin
+    
+    class ProductViewSet(SideloadableRelationsMixin, viewsets.ModelViewSet):
+        """
+        A simple ViewSet for viewing and editing products.
+        """
+    
+        queryset = Product.objects.all()
+        serializer_class = ProductSerializer
+        sideloading_serializer_class = ProductSideloadableSerializer
+    ```
 
 5. Enjoy your API with sideloading support
 
-```http
-GET /api/products/?sideload=categories,partners,suppliers,products
-```
+    ```http
+    GET /api/products/?sideload=categories,partners,suppliers,products
+    ```
 
-```json
-{
-  "products": [
-    {
-      "id": 1,
-      "name": "Product 1",
-      "category": 1,
-      "supplier": 1,
-      "partners": [1, 2, 3]
-    }
-  ],
-  "categories": [
+    ```json
     {
-      "id": 1,
-      "name": "Category1"
-    }
-  ],
-  "suppliers": [
-    {
-      "id": 1,
-      "name": "Supplier1"
-    }
-  ],
-  "partners": [
-    {
-      "id": 1,
-      "name": "Partner1"
-    },
-    {
-      "id": 2,
-      "name": "Partner1"
-    },
-    {
-      "id": 3,
-      "name": "Partner3"
+      "products": [
+        {
+          "id": 1,
+          "name": "Product 1",
+          "category": 1,
+          "supplier": 1,
+          "partners": [1, 2, 3]
+        }
+      ],
+      "categories": [
+        {
+          "id": 1,
+          "name": "Category1"
+        }
+      ],
+      "suppliers": [
+        {
+          "id": 1,
+          "name": "Supplier1"
+        }
+      ],
+      "partners": [
+        {
+          "id": 1,
+          "name": "Partner1"
+        },
+        {
+          "id": 2,
+          "name": "Partner1"
+        },
+        {
+          "id": 3,
+          "name": "Partner3"
+        }
+      ]
     }
-  ]
-}
-```
+    ```
 
 ## Example Project
 

drf_sideloading/__init__.py

@@ -1 +1 @@
-__version__ = "1.4.0"
+__version__ = "1.4.1"

drf_sideloading/mixins.py

@@ -80,6 +80,7 @@ def get_sideloading_prefetches(self):
                 for vi in v:
                     if not isinstance(vi, (str, Prefetch)):
                         raise RuntimeError("Sideloadable prefetch values must be a list of strings or Prefetch objects")
+                cleaned_prefetches[k] = v
         return cleaned_prefetches
 
     def initialize_request(self, request, *args, **kwargs):

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.4.0
+current_version = 1.4.1
 commit = True
 tag = True