|
1 | | -from metrics.api.serializers.downloads.single_category import ( |
2 | | - DownloadListSerializer, |
3 | | - SingleCategoryDownloadsSerializer, |
| 1 | +from rest_framework import serializers |
| 2 | +from rest_framework.request import Request |
| 3 | + |
| 4 | +from metrics.api.serializers import help_texts |
| 5 | +from metrics.api.serializers.downloads.common import BaseDownloadsSerializer |
| 6 | +from metrics.api.serializers.plots import PlotSerializer |
| 7 | +from metrics.domain.charts.colour_scheme import RGBAChartLineColours |
| 8 | +from metrics.domain.common.utils import ( |
| 9 | + DEFAULT_CHART_HEIGHT, |
| 10 | + DEFAULT_CHART_WIDTH, |
| 11 | + DEFAULT_X_AXIS, |
| 12 | + DEFAULT_Y_AXIS, |
| 13 | + ChartAxisFields, |
| 14 | + DataSourceFileType, |
| 15 | + extract_metric_group_from_metric, |
| 16 | +) |
| 17 | +from metrics.domain.models.downloads.dual_category import ( |
| 18 | + DualCategoryDownloadRequestParams, |
4 | 19 | ) |
5 | 20 |
|
6 | 21 |
|
7 | | -class DualCategoryDownloadSerializer(SingleCategoryDownloadsSerializer): |
8 | | - plots = DownloadListSerializer() |
| 22 | +class DualCategoryDownloadSegmentSerializer(serializers.Serializer): |
| 23 | + secondary_field_value = serializers.CharField(required=True) |
| 24 | + colour = serializers.ChoiceField( |
| 25 | + choices=RGBAChartLineColours.choices(), |
| 26 | + required=False, |
| 27 | + allow_blank=True, |
| 28 | + ) |
| 29 | + label = serializers.CharField(required=False, allow_blank=True, default="") |
| 30 | + |
| 31 | + |
| 32 | +class DualCategoryDownloadSerializer(BaseDownloadsSerializer): |
| 33 | + chart_type = serializers.CharField( |
| 34 | + help_text=help_texts.CHART_TYPE_FIELD, |
| 35 | + required=False, |
| 36 | + default="stacked_bar", |
| 37 | + ) |
| 38 | + primary_field_values = serializers.ListField( |
| 39 | + child=serializers.CharField(), |
| 40 | + required=False, |
| 41 | + allow_empty=True, |
| 42 | + ) |
| 43 | + secondary_category = serializers.CharField(required=True) |
| 44 | + static_fields = PlotSerializer(required=True) |
| 45 | + segments = DualCategoryDownloadSegmentSerializer(many=True, required=True) |
| 46 | + |
| 47 | + @classmethod |
| 48 | + def validate(cls, attrs: dict) -> dict: |
| 49 | + """Validate primary field values based on the selected metric type. |
| 50 | +
|
| 51 | + Args: |
| 52 | + attrs: Serializer attributes to validate. |
| 53 | +
|
| 54 | + Returns: |
| 55 | + Validated attributes. |
| 56 | + """ |
| 57 | + x_axis = attrs.get("x_axis") or DEFAULT_X_AXIS |
| 58 | + primary_field_values = attrs.get("primary_field_values") or [] |
| 59 | + metric = attrs["static_fields"]["metric"] |
| 60 | + metric_group = extract_metric_group_from_metric(metric=metric) |
| 61 | + is_timeseries_data = DataSourceFileType[metric_group].is_timeseries |
| 62 | + |
| 63 | + if is_timeseries_data: |
| 64 | + if primary_field_values: |
| 65 | + raise serializers.ValidationError( |
| 66 | + { |
| 67 | + "primary_field_values": ( |
| 68 | + "This field should not be provided for timeseries data." |
| 69 | + ) |
| 70 | + } |
| 71 | + ) |
| 72 | + if x_axis != ChartAxisFields.date.name: |
| 73 | + raise serializers.ValidationError( |
| 74 | + { |
| 75 | + "x_axis": ( |
| 76 | + "This field should be set to 'date' for timeseries data." |
| 77 | + ) |
| 78 | + } |
| 79 | + ) |
| 80 | + |
| 81 | + elif not is_timeseries_data and not primary_field_values: |
| 82 | + raise serializers.ValidationError( |
| 83 | + {"primary_field_values": "This field is required for headline data."} |
| 84 | + ) |
| 85 | + |
| 86 | + return attrs |
| 87 | + |
| 88 | + def to_models(self, request: Request) -> DualCategoryDownloadRequestParams: |
| 89 | + """Convert dual-category payload into plot queries for download. |
| 90 | +
|
| 91 | + Args: |
| 92 | + request: Incoming API request. |
| 93 | +
|
| 94 | + Returns: |
| 95 | + Dual-category download request parameters. |
| 96 | + """ |
| 97 | + |
| 98 | + x_axis = self.data.get("x_axis") or DEFAULT_X_AXIS |
| 99 | + y_axis = self.data.get("y_axis") or DEFAULT_Y_AXIS |
| 100 | + primary_field_values = self.data.get("primary_field_values") or [] |
| 101 | + secondary_category = self.data["secondary_category"] |
| 102 | + static_fields: dict = dict(self.validated_data["static_fields"]) |
| 103 | + segments: list[dict] = self.data["segments"] |
| 104 | + chart_type = self.data.get("chart_type", "stacked_bar") |
| 105 | + segment_secondary_values = [ |
| 106 | + segment["secondary_field_value"] for segment in segments |
| 107 | + ] |
| 108 | + |
| 109 | + if static_fields.get("date_from"): |
| 110 | + static_fields["date_from"] = static_fields["date_from"].isoformat() |
| 111 | + if static_fields.get("date_to"): |
| 112 | + static_fields["date_to"] = static_fields["date_to"].isoformat() |
| 113 | + |
| 114 | + metric_group = extract_metric_group_from_metric(metric=static_fields["metric"]) |
| 115 | + is_timeseries_data = DataSourceFileType[metric_group].is_timeseries |
| 116 | + plots: list[dict] = [] |
| 117 | + |
| 118 | + if is_timeseries_data: |
| 119 | + plots = [ |
| 120 | + { |
| 121 | + "x_axis": x_axis, |
| 122 | + "y_axis": y_axis, |
| 123 | + "chart_type": chart_type, |
| 124 | + **static_fields, |
| 125 | + secondary_category: segment["secondary_field_value"], |
| 126 | + } |
| 127 | + for segment in segments |
| 128 | + ] |
| 129 | + else: |
| 130 | + for primary_field_value in primary_field_values: |
| 131 | + for segment in segments: |
| 132 | + plots.append( |
| 133 | + { |
| 134 | + "x_axis": x_axis, |
| 135 | + "y_axis": y_axis, |
| 136 | + "chart_type": chart_type, |
| 137 | + **static_fields, |
| 138 | + x_axis: primary_field_value, |
| 139 | + secondary_category: segment["secondary_field_value"], |
| 140 | + } |
| 141 | + ) |
| 142 | + |
| 143 | + chart_request = DualCategoryDownloadRequestParams( |
| 144 | + metric_group=metric_group, |
| 145 | + plots=plots, |
| 146 | + file_format=self.data["file_format"], |
| 147 | + chart_height=DEFAULT_CHART_HEIGHT, |
| 148 | + chart_width=DEFAULT_CHART_WIDTH, |
| 149 | + x_axis=x_axis, |
| 150 | + y_axis=y_axis, |
| 151 | + confidence_intervals=False, |
| 152 | + request=request, |
| 153 | + secondary_category=secondary_category, |
| 154 | + segment_secondary_values=segment_secondary_values, |
| 155 | + primary_field_values=primary_field_values, |
| 156 | + ) |
| 157 | + |
| 158 | + if is_timeseries_data: |
| 159 | + for plot in chart_request.plots: |
| 160 | + plot.override_y_axis_choice_to_none = True |
| 161 | + |
| 162 | + return chart_request |
0 commit comments