-
Notifications
You must be signed in to change notification settings - Fork 40
/
serializers.py
215 lines (174 loc) · 7.6 KB
/
serializers.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
from __future__ import annotations
from typing import Any
from django.apps import apps
from django.contrib.contenttypes.models import ContentType
from django.core.exceptions import ObjectDoesNotExist
from django.urls import reverse
from django.utils.translation import gettext_lazy as _
from rest_framework import serializers
from salesman.basket.models import BaseBasket, BaseBasketItem
from salesman.conf import app_settings
from salesman.core.serializers import PriceField
from salesman.core.typing import Product
from salesman.core.utils import get_salesman_model
Basket = get_salesman_model("Basket")
BasketItem = get_salesman_model("BasketItem")
class ProductField(serializers.Serializer):
"""
Related product field that uses a serializer based on product type
taken from ``SALESMAN_PRODUCT_TYPES`` setting.
"""
def to_representation(self, product: Product) -> Any:
product_types = app_settings.SALESMAN_PRODUCT_TYPES
serializer_class = product_types[product._meta.label]
return serializer_class(context=self.context).to_representation(product)
class ExtraRowsField(serializers.Serializer):
"""
Field to display a list of ``ExtraRowSerializer`` instances.
"""
def to_representation(
self,
rows: dict[str, ExtraRowSerializer],
) -> list[dict[str, Any]]:
return [dict(row.data, modifier=modifier) for modifier, row in rows.items()]
class ExtraRowSerializer(serializers.Serializer):
"""
Extra row serializer used for adding extra data to ``extra_rows`` dict on
both the basket and basket item model. Mostly used when processing basket modifiers.
"""
label = serializers.CharField(read_only=True, default="")
amount = PriceField(read_only=True, default="0")
extra = serializers.DictField(read_only=True, default={})
class BasketItemSerializer(serializers.ModelSerializer):
"""
Serializer for basket item.
"""
url = serializers.SerializerMethodField()
product_type = serializers.CharField(source="product._meta.label", read_only=True)
product = ProductField(read_only=True)
quantity = serializers.IntegerField(min_value=1)
unit_price = PriceField(read_only=True)
subtotal = PriceField(read_only=True)
extra_rows = ExtraRowsField(read_only=True)
total = PriceField(read_only=True)
extra = serializers.JSONField(
default=dict, help_text=_("Extra is updated and null values are removed.")
)
class Meta:
model = BasketItem
fields = [
"url",
"ref",
"product_type",
"product_id",
"product",
"unit_price",
"quantity",
"subtotal",
"extra_rows",
"total",
"extra",
]
read_only_fields = fields
def get_url(self, obj: BaseBasketItem) -> str:
request = self.context.get("request", None)
url = reverse("salesman-basket-detail", args=[obj.ref])
return str(request.build_absolute_uri(url)) if request else url
def validate(self, attrs: dict[str, Any]) -> dict[str, Any]:
context = self.context.copy()
context["basket_item"] = self.instance
return app_settings.SALESMAN_BASKET_ITEM_VALIDATOR(attrs, context=context)
def validate_extra(self, value: dict[str, Any]) -> dict[str, Any]:
# Update basket `extra` instead of replacing it, remove null values.
extra = self.instance.extra if self.instance else {}
if value:
extra.update(value)
extra = {k: v for k, v in extra.items() if v is not None}
# Validate using extra validator.
context = self.context.copy()
context["basket_item"] = self.instance
return app_settings.SALESMAN_EXTRA_VALIDATOR(extra, context=context)
def to_representation(self, item: BaseBasketItem) -> Any:
basket, request = self.context["basket"], self.context["request"]
basket.update(request)
item = basket.find(item.ref)
return super().to_representation(item)
class BasketItemCreateSerializer(serializers.ModelSerializer):
"""
Serializer used to add a new item to basket.
"""
ref = serializers.SlugField(
required=False, help_text=_("Leave empty to auto-generate from product.")
)
product_type = serializers.ChoiceField(
choices=list(app_settings.SALESMAN_PRODUCT_TYPES)
)
product_id = serializers.IntegerField(min_value=1)
quantity = serializers.IntegerField(default=1, min_value=1)
extra = serializers.JSONField(default=dict, help_text=_("Store extra JSON data."))
class Meta:
model = BasketItem
fields = ["ref", "product_type", "product_id", "quantity", "extra"]
def validate(self, attrs: dict[str, Any]) -> dict[str, Any]:
# Validate and set product from generic relation.
app_label, model_name = attrs["product_type"].split(".")
model = apps.get_model(app_label, model_name)
content_type = ContentType.objects.get_for_model(model)
try:
pid = attrs["product_id"]
attrs["product"] = content_type.get_object_for_this_type(id=pid)
except ObjectDoesNotExist:
msg = _("Product '{product_type}' with id '{product_id}' doesn't exist.")
raise serializers.ValidationError(msg.format(**attrs))
# Validate using basket item validator.
context = self.context.copy()
context["basket_item"] = self.instance
return app_settings.SALESMAN_BASKET_ITEM_VALIDATOR(attrs, context=context)
def validate_extra(self, value: dict[str, Any]) -> dict[str, Any]:
context = self.context.copy()
context["basket_item"] = self.instance
return app_settings.SALESMAN_EXTRA_VALIDATOR(value, context=context)
def create(self, validated_data: dict[str, Any]) -> BaseBasketItem:
basket = self.context["basket"]
item: BaseBasketItem = basket.add(
product=validated_data["product"],
quantity=validated_data["quantity"],
ref=validated_data.get("ref", None),
extra=validated_data.get("extra", None),
)
return item
def to_representation(self, item: BaseBasketItem) -> Any:
return BasketItemSerializer(context=self.context).to_representation(item)
class BasketSerializer(serializers.ModelSerializer):
"""
Serializer for basket.
"""
items = BasketItemSerializer(source="get_items", many=True, read_only=True)
subtotal = PriceField(read_only=True)
extra_rows = ExtraRowsField(read_only=True)
total = PriceField(read_only=True)
extra = serializers.JSONField(read_only=True)
class Meta:
model = Basket
fields = ["id", "items", "subtotal", "extra_rows", "total", "extra"]
def to_representation(self, basket: BaseBasket) -> Any:
basket.update(self.context["request"])
return super().to_representation(basket)
class BasketExtraSerializer(serializers.ModelSerializer):
"""
Serializer for updating basket ``extra`` data.
"""
extra = serializers.JSONField(
help_text=_("Extra is updated and null values are removed.")
)
class Meta:
model = Basket
fields = ["extra"]
def validate_extra(self, value: dict[str, Any]) -> dict[str, Any]:
# Update basket extra instead of replacing it, remove null values.
extra = self.instance.extra if self.instance else {}
if value:
extra.update(value)
extra = {k: v for k, v in extra.items() if v is not None}
# Validate using extra validator.
return app_settings.SALESMAN_EXTRA_VALIDATOR(extra, context=self.context)