forked from saleor/saleor
-
Notifications
You must be signed in to change notification settings - Fork 0
/
utils.py
366 lines (291 loc) · 12.6 KB
/
utils.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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
from collections import defaultdict, namedtuple
from urllib.parse import urlencode
from django.conf import settings
from django.contrib.auth.models import AnonymousUser
from django.utils.encoding import smart_text
from django_prices.templatetags import prices_i18n
from prices import Price, PriceRange
from . import ProductAvailabilityStatus, VariantAvailabilityStatus
from ..cart.utils import get_cart_from_request, get_or_create_cart_from_request
from ..core.utils import to_local_currency
from .forms import ProductForm
def products_visible_to_user(user):
from .models import Product
if user.is_authenticated and user.is_active and user.is_staff:
return Product.objects.all()
else:
return Product.objects.get_available_products()
def products_with_details(user):
products = products_visible_to_user(user)
products = products.prefetch_related(
'categories', 'images', 'variants__stock',
'variants__variant_images__image', 'attributes__values',
'product_class__variant_attributes__values',
'product_class__product_attributes__values')
return products
def products_for_homepage():
user = AnonymousUser()
products = products_with_details(user)
products = products.filter(is_featured=True)
return products
def get_product_images(product):
"""
Returns list of product images that will be placed in product gallery
"""
return list(product.images.all())
def products_with_availability(products, discounts, local_currency):
for product in products:
yield product, get_availability(product, discounts, local_currency)
ProductAvailability = namedtuple(
'ProductAvailability', (
'available', 'price_range', 'price_range_undiscounted', 'discount',
'price_range_local_currency', 'discount_local_currency'))
def get_availability(product, discounts=None, local_currency=None):
# In default currency
price_range = product.get_price_range(discounts=discounts)
undiscounted = product.get_price_range()
if undiscounted.min_price > price_range.min_price:
discount = undiscounted.min_price - price_range.min_price
else:
discount = None
# Local currency
if local_currency:
price_range_local = to_local_currency(
price_range, local_currency)
undiscounted_local = to_local_currency(
undiscounted, local_currency)
if (undiscounted_local and
undiscounted_local.min_price > price_range_local.min_price):
discount_local_currency = (
undiscounted_local.min_price - price_range_local.min_price)
else:
discount_local_currency = None
else:
price_range_local = None
discount_local_currency = None
is_available = product.is_in_stock() and product.is_available()
return ProductAvailability(
available=is_available,
price_range=price_range,
price_range_undiscounted=undiscounted,
discount=discount,
price_range_local_currency=price_range_local,
discount_local_currency=discount_local_currency)
def handle_cart_form(request, product, create_cart=False):
if create_cart:
cart = get_or_create_cart_from_request(request)
else:
cart = get_cart_from_request(request)
form = ProductForm(
cart=cart, product=product, data=request.POST or None,
discounts=request.discounts)
return form, cart
def products_for_cart(user):
products = products_visible_to_user(user)
products = products.prefetch_related('variants__variant_images__image')
return products
def product_json_ld(product, availability=None, attributes=None):
# type: (saleor.product.models.Product, saleor.product.utils.ProductAvailability, dict) -> dict # noqa
"""Generates JSON-LD data for product"""
data = {'@context': 'http://schema.org/',
'@type': 'Product',
'name': smart_text(product),
'image': smart_text(product.get_first_image()),
'description': product.description,
'offers': {'@type': 'Offer',
'itemCondition': 'http://schema.org/NewCondition'}}
if availability is not None:
if availability.price_range:
data['offers']['priceCurrency'] = settings.DEFAULT_CURRENCY
data['offers']['price'] = availability.price_range.min_price.net
if availability.available:
data['offers']['availability'] = 'http://schema.org/InStock'
else:
data['offers']['availability'] = 'http://schema.org/OutOfStock'
if attributes is not None:
brand = ''
for key in attributes:
if key.name == 'brand':
brand = attributes[key].name
break
elif key.name == 'publisher':
brand = attributes[key].name
if brand:
data['brand'] = {'@type': 'Thing', 'name': brand}
return data
def get_variant_picker_data(product, discounts=None, local_currency=None):
availability = get_availability(product, discounts, local_currency)
variants = product.variants.all()
data = {'variantAttributes': [], 'variants': []}
variant_attributes = product.product_class.variant_attributes.all()
# Collect only available variants
filter_available_variants = defaultdict(list)
for variant in variants:
price = variant.get_price_per_item(discounts)
price_undiscounted = variant.get_price_per_item()
if local_currency:
price_local_currency = to_local_currency(price, local_currency)
else:
price_local_currency = None
schema_data = {'@type': 'Offer',
'itemCondition': 'http://schema.org/NewCondition',
'priceCurrency': price.currency,
'price': price.net}
if variant.is_in_stock():
schema_data['availability'] = 'http://schema.org/InStock'
else:
schema_data['availability'] = 'http://schema.org/OutOfStock'
variant_data = {
'id': variant.id,
'price': price_as_dict(price),
'priceUndiscounted': price_as_dict(price_undiscounted),
'attributes': variant.attributes,
'priceLocalCurrency': price_as_dict(price_local_currency),
'schemaData': schema_data}
data['variants'].append(variant_data)
for variant_key, variant_value in variant.attributes.items():
filter_available_variants[int(variant_key)].append(
int(variant_value))
for attribute in variant_attributes:
available_variants = filter_available_variants.get(attribute.pk, None)
if available_variants:
data['variantAttributes'].append({
'pk': attribute.pk,
'name': attribute.name,
'slug': attribute.slug,
'values': [
{'pk': value.pk, 'name': value.name, 'slug': value.slug}
for value in attribute.values.filter(
pk__in=available_variants)]})
data['availability'] = {
'discount': price_as_dict(availability.discount),
'priceRange': price_range_as_dict(availability.price_range),
'priceRangeUndiscounted': price_range_as_dict(
availability.price_range_undiscounted),
'priceRangeLocalCurrency': price_range_as_dict(
availability.price_range_local_currency)}
return data
def get_product_attributes_data(product):
attributes = product.product_class.product_attributes.all()
attributes_map = {attribute.pk: attribute for attribute in attributes}
values_map = get_attributes_display_map(product, attributes)
return {attributes_map.get(attr_pk): value_obj
for (attr_pk, value_obj) in values_map.items()}
def price_as_dict(price):
if not price:
return None
return {'currency': price.currency,
'gross': price.gross,
'grossLocalized': prices_i18n.gross(price),
'net': price.net,
'netLocalized': prices_i18n.net(price)}
def price_range_as_dict(price_range):
if not price_range:
return None
return {'maxPrice': price_as_dict(price_range.max_price),
'minPrice': price_as_dict(price_range.min_price)}
def get_variant_url_from_product(product, attributes):
return '%s?%s' % (product.get_absolute_url(), urlencode(attributes))
def get_variant_url(variant):
attributes = {}
values = {}
for attribute in variant.product.product_class.variant_attributes.all():
attributes[str(attribute.pk)] = attribute
for value in attribute.values.all():
values[str(value.pk)] = value
return get_variant_url_from_product(variant.product, attributes)
def get_attributes_display_map(obj, attributes):
display_map = {}
for attribute in attributes:
value = obj.attributes.get(smart_text(attribute.pk))
if value:
choices = {smart_text(a.pk): a for a in attribute.values.all()}
choice_obj = choices.get(value)
if choice_obj:
display_map[attribute.pk] = choice_obj
else:
display_map[attribute.pk] = value
return display_map
def get_product_availability_status(product):
from .models import Stock
is_available = product.is_available()
has_stock_records = Stock.objects.filter(variant__product=product)
are_all_variants_in_stock = all(
variant.is_in_stock() for variant in product.variants.all())
is_in_stock = any(
variant.is_in_stock() for variant in product.variants.all())
requires_variants = product.product_class.has_variants
if not product.is_published:
return ProductAvailabilityStatus.NOT_PUBLISHED
elif requires_variants and not product.variants.exists():
# We check the requires_variants flag here in order to not show this
# status with product classes that don't require variants, as in that
# case variants are hidden from the UI and user doesn't manage them.
return ProductAvailabilityStatus.VARIANTS_MISSSING
elif not has_stock_records:
return ProductAvailabilityStatus.NOT_CARRIED
elif not is_in_stock:
return ProductAvailabilityStatus.OUT_OF_STOCK
elif not are_all_variants_in_stock:
return ProductAvailabilityStatus.LOW_STOCK
elif not is_available and product.available_on is not None:
return ProductAvailabilityStatus.NOT_YET_AVAILABLE
else:
return ProductAvailabilityStatus.READY_FOR_PURCHASE
def get_variant_availability_status(variant):
has_stock_records = variant.stock.exists()
if not has_stock_records:
return VariantAvailabilityStatus.NOT_CARRIED
elif not variant.is_in_stock():
return VariantAvailabilityStatus.OUT_OF_STOCK
else:
return VariantAvailabilityStatus.AVAILABLE
def get_product_costs_data(product):
zero_price = Price(0, 0, currency=settings.DEFAULT_CURRENCY)
zero_price_range = PriceRange(zero_price, zero_price)
purchase_costs_range = zero_price_range
gross_margin = (0, 0)
if not product.variants.exists():
return purchase_costs_range, gross_margin
variants = product.variants.all()
costs, margins = get_cost_data_from_variants(variants)
if costs:
purchase_costs_range = PriceRange(min(costs), max(costs))
if margins:
gross_margin = (margins[0], margins[-1])
return purchase_costs_range, gross_margin
def sort_cost_data(costs, margins):
costs = sorted(costs, key=lambda x: x.gross)
margins = sorted(margins)
return costs, margins
def get_cost_data_from_variants(variants):
costs = []
margins = []
for variant in variants:
costs_data = get_variant_costs_data(variant)
costs += costs_data['costs']
margins += costs_data['margins']
return sort_cost_data(costs, margins)
def get_variant_costs_data(variant):
costs = []
margins = []
for stock in variant.stock.all():
costs.append(get_cost_price(stock))
margin = get_margin_for_variant(stock)
if margin:
margins.append(margin)
costs = sorted(costs, key=lambda x: x.gross)
margins = sorted(margins)
return {'costs': costs, 'margins': margins}
def get_cost_price(stock):
zero_price = Price(0, 0, currency=settings.DEFAULT_CURRENCY)
if not stock.cost_price:
return zero_price
return stock.cost_price
def get_margin_for_variant(stock):
if not stock.cost_price:
return None
price = stock.variant.get_price_per_item()
margin = price - stock.cost_price
percent = round((margin.gross / price.gross) * 100, 0)
return percent