- update tests

Author: jdwpeterson

dashboards/component/base.py

@@ -130,6 +130,7 @@ def get_value(
                 value = self.defer(request=request, object=self.object, filters=filters)
             else:
                 value = self.defer
+
         else:
             serializable = getattr(self.value, "serialize", None)
             if serializable:
@@ -154,6 +155,8 @@ def _get_media_from_definition(self) -> Optional[asset_definitions.Media]:
         if definition:
             return asset_definitions.Media(media=definition)
 
+        return None
+
     def get_media(self) -> asset_definitions.Media:
         # component level media
         media = self._get_media_from_definition() or asset_definitions.Media()
@@ -166,6 +169,10 @@ def get_media(self) -> asset_definitions.Media:
         return media
 
     def render_value(self, context: Context, call_deferred: bool = False) -> str:
+        # if value is deferred and we are not ready to call it, return loading template
+        if self.is_deferred and not call_deferred:
+            return render_to_string(self.defer_loading_template_name)
+
         request = context.get("request")
         if request:
             filters = (

dashboards/component/chart/serializers.py

@@ -1,7 +1,8 @@
 import json
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List, Optional, Type
 
 from django.core.exceptions import ImproperlyConfigured
+from django.db.models import Model
 from django.template.loader import render_to_string
 
 import asset_definitions
@@ -18,7 +19,9 @@ class ModelDataMixin:
 
     class Meta:
         fields: Optional[List[str]] = None
-        model: Optional[str] = None
+        model: Optional[Model] = None
+
+    _meta: Type["ModelDataMixin.Meta"]
 
     def get_fields(self) -> Optional[List[str]]:
         # TODO: for some reason mypy complains about this one line
@@ -56,9 +59,13 @@ class PlotlyChartSerializerMixin:
     template_name: str = "dashboards/components/chart/plotly.html"
     meta_layout_attrs = ["title", "width", "height"]
     layout: Optional[Dict[str, Any]] = None
-    displayModeBar: Optional[bool] = True
-    staticPlot: Optional[bool] = False
-    responsive: Optional[bool] = True
+
+    _meta: Type[Any]
+
+    class Meta:
+        displayModeBar: Optional[bool] = True
+        staticPlot: Optional[bool] = False
+        responsive: Optional[bool] = True
 
     def empty_chart(self) -> str:
         return json.dumps(
@@ -123,14 +130,16 @@ def render(cls, template_id, **kwargs) -> str:
         context = {
             "template_id": template_id,
             "value": value,
-            "displayModeBar": self.displayModeBar,
-            "staticPlot": self.staticPlot,
-            "responsive": self.responsive,
+            "displayModeBar": self._meta.displayModeBar,
+            "staticPlot": self._meta.staticPlot,
+            "responsive": self._meta.responsive,
         }
         return render_to_string(cls.template_name, context)
 
 
 class BaseChartSerializer(ClassWithMeta, asset_definitions.MediaDefiningClass):
+    _meta: Type[Any]
+
     class Meta:
         title: Optional[str] = None
         width: Optional[int] = None
@@ -165,6 +174,9 @@ class PlotlyChartSerializer(PlotlyChartSerializerMixin, BaseChartSerializer):
     Serializer to convert data into a plotly js format
     """
 
+    class Meta(PlotlyChartSerializerMixin.Meta, BaseChartSerializer.Meta):
+        pass
+
     class Media:
         js = ("dashboards/vendor/js/plotly.min.js",)
 
@@ -174,3 +186,8 @@ class ChartSerializer(ModelDataMixin, PlotlyChartSerializer):
     Default chart serializer to read data from a django model
     and serialize it to something plotly js can render
     """
+
+    class Meta(ModelDataMixin.Meta, PlotlyChartSerializer.Meta):
+        pass
+
+    _meta: Type["ChartSerializer.Meta"]

dashboards/component/table/mixins.py

@@ -1,4 +1,5 @@
-from typing import Any, Dict, List, Tuple, Union
+from collections.abc import Iterable
+from typing import Any, Dict, List, Tuple, Type, Union
 
 from django.core.exceptions import FieldDoesNotExist
 from django.core.paginator import Page, Paginator
@@ -34,7 +35,7 @@ def filter(qs: QuerySet, fields: List[str], filters: Dict[str, Any]) -> QuerySet
 
     @staticmethod
     def sort(
-        qs: QuerySet, fields: List[str], filters: Dict[str, Any], force_lower: bool
+        qs: QuerySet, fields: List[Any], filters: Dict[str, Any], force_lower: bool
     ) -> QuerySet:
         """
         Apply ordering to a queryset based on the order[{field}][column] column request params.
@@ -140,29 +141,32 @@ def count(data: List) -> int:
 
 
 class TableDataProcessorMixin:
+    _meta: Type[Any]
+
     @classmethod
     def get_data_processor(cls, data):
         if isinstance(data, QuerySet):
             return TableQuerysetProcessor
-        elif isinstance(data, List):
+        elif isinstance(data, Iterable):
             return TableListProcessor
 
         raise Exception("data must be either a queryset or a list")
 
     @classmethod
     def filter(
-        cls, data: Union[QuerySet, List], fields: List[str], filters: Dict[str, Any]
+        cls, data: Union[QuerySet, List], filters: Dict[str, Any]
     ) -> Union[List, QuerySet]:
+        fields = list(cls._meta.columns)
         return cls.get_data_processor(data).filter(data, fields, filters)
 
     @classmethod
     def sort(
         cls,
         data: Union[QuerySet, List],
-        fields: List[str],
         filters: Dict[str, Any],
-        force_lower: bool,
     ) -> Union[List, QuerySet]:
+        force_lower = cls._meta.force_lower
+        fields = list(cls._meta.columns)
         return cls.get_data_processor(data).sort(data, fields, filters, force_lower)
 
     @classmethod

dashboards/component/table/serializers.py

@@ -5,7 +5,7 @@
 
 from django.contrib.humanize.templatetags.humanize import naturaltime
 from django.core.exceptions import ImproperlyConfigured
-from django.db.models import QuerySet
+from django.db.models import Model, QuerySet
 
 import asset_definitions
 
@@ -78,10 +78,8 @@ def serialize(cls, **serialize_kwargs) -> SerializedTable:
             draw = int(filters.get("draw", draw))
 
         # apply filtering, sorting and pagination (datatables)
-        data = self.filter(data=data, fields=fields, filters=filters)
-        data = self.sort(
-            data=data, fields=fields, filters=filters, force_lower=cls._meta.force_lower
-        )
+        data = self.filter(data=data, filters=filters)
+        data = self.sort(data=data, filters=filters)
         processed_data = []
         filtered_count = 0
 
@@ -156,10 +154,15 @@ class TableSerializer(BaseTableSerializer):
     SerializedTable returns the in a format accepted by datatables.js
     """
 
-    _meta: Type["TableSerializer.Meta"]
+    _meta: Type[Any]
 
-    class Meta(BaseTableSerializer.Meta):
-        model: Optional[str] = None
+    class Meta:
+        columns: Dict[str, str]
+        order: List[str]
+        title: Optional[str] = None
+        first_as_absolute_url = False
+        force_lower = True
+        model: Optional[Model] = None
 
     def __init_subclass__(cls, **kwargs):
         super().__init_subclass__(**kwargs)

requirements.txt

@@ -63,7 +63,11 @@ decorator==5.1.1
 distlib==0.3.6
     # via virtualenv
 django==4.1.7
-    # via model-bakery
+    # via
+    #   django-asset-definitions
+    #   model-bakery
+django-asset-definitions==1.0.0
+    # via -r requirements.in
 django-webtest==1.9.10
     # via -r requirements.in
 docutils==0.18.1
@@ -96,7 +100,7 @@ idna==3.4
     # via requests
 imagesize==1.4.1
     # via sphinx
-importlib-metadata==6.1.0
+importlib-metadata==6.8.0
     # via sphinx
 iniconfig==2.0.0
     # via pytest
@@ -291,6 +295,7 @@ urllib3==1.26.15
     # via requests
 vine==5.0.0
     # via
+    #   amqp
     #   celery
     #   kombu
 virtualenv==20.21.0
@@ -309,7 +314,7 @@ webtest==3.0.0
     # via django-webtest
 wheel==0.40.0
     # via pip-tools
-zipp==3.15.0
+zipp==3.16.2
     # via importlib-metadata
 
 # The following packages are considered to be unsafe in a requirements file:

setup.cfg

@@ -30,6 +30,7 @@ python_requires = >=3.9
 install_requires =
     Django >= 3.2
     django-cors-headers
+    django-asset-definitions
     pandas
     plotly
     plotly_express