This repository has been archived by the owner on Feb 23, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
models.py
571 lines (436 loc) · 16 KB
/
models.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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
import string
import typing
import mptt
from django.db import models
from django.urls import reverse
from django.utils.text import slugify
from django.utils.translation import ugettext_lazy as _
from unidecode import unidecode
import catalog
import ecommerce
import pages
class Order(ecommerce.models.Order):
company = models.CharField(max_length=255, verbose_name='company')
address = models.TextField(default='', blank=True, verbose_name='address')
comment = models.TextField(default='', blank=True, verbose_name='comment')
def set_positions(self, cart):
self.save()
for id_, position in cart:
self.positions.create(
order=self,
product_id=id_,
name=position['name'],
price=position['price'],
quantity=position['quantity'],
code=position['code'],
catalog_name=position['catalog_name'],
url=position['url'],
)
return self
# @todo #rf169 Fix model.Manager inheritance problem
# Category model ignores parent's manager.
# ```
# In [1]: from stroyprombeton.models import Category
#
# In [2]: type(Category.objects)
# Out[2]: mptt.managers.TreeManager
# ```
# Should be `catalog.models.CategoryManager`
#
# Then use model.Manager.active() filter everywhere in this project (rf#169).
class Category(catalog.models.AbstractCategory, pages.models.PageMixin):
# @todo #483:30m Explore `Category.specification` field purpose.
# Then document or rename it.
specification = models.TextField(
default='',
blank=True,
verbose_name=_('specification'),
)
@property
def catalog_name(self):
return self.name
@classmethod
def get_default_parent(cls):
return pages.models.CustomPage.objects.filter(slug='gbi').first()
def get_absolute_url(self):
"""Return url for model."""
return reverse('category', args=(self.id,))
def get_series(self) -> models.QuerySet:
return (
Series.objects
.prefetch_related('options')
.filter(
options__in=models.Subquery(
Option.objects
.select_related('product')
.select_related('product__category')
.filter(
product__in=Product.objects.filter_descendants(self)
).values('id')
)
).distinct()
.order_by('name')
)
def recursive_products(self) -> 'ProductQuerySet':
return Product.objects.filter_descendants(self)
def get_min_price(self) -> float:
"""Helper for templates."""
return self.recursive_products().options().min_price()
class SeriesQuerySet(models.QuerySet):
def bind_fields(self):
"""Prefetch or select typical related fields to reduce sql queries count."""
return self.select_related('page') # Ignore CPDBear
def active(self) -> 'SeriesQuerySet':
return self.filter(page__is_active=True)
def exclude_empty(self) -> 'SeriesQuerySet':
return (
self.active()
.filter(options__product__page__is_active=True)
.distinct()
)
class SeriesManager(models.Manager.from_queryset(SeriesQuerySet)):
"""Get all products of given category by Category's id or instance."""
def active(self):
return self.get_queryset().active()
class Series(pages.models.PageMixin):
"""
Series is another way to organize products.
It's like Category, but has no hierarchy.
"""
objects = SeriesManager()
SLUG_HASH_SIZE = 5
SLUG_MAX_LENGTH = 50
class Meta:
verbose_name = _('Series')
verbose_name_plural = _('Series') # Ignore CPDBear
name = models.CharField(
max_length=1000, db_index=True, unique=True, verbose_name=_('name')
)
@property
def url(self):
return self.get_absolute_url()
def get_absolute_url(self):
"""Url path to the related page."""
return reverse('series', args=(self.slug,)) # Ignore CPDBear
# @todo #669:60m Remove `Series.slug` field.
# Series page already contains it.
slug = models.SlugField(
blank=False, unique=True, max_length=SLUG_MAX_LENGTH,
)
# @todo #569:120m Design unified slug autogenerating mech.
# Now it's doubled here and in several places at catalog.models.
def _get_slug(self) -> str:
# Translate all punctuation chars to "_".
# It doesn't conflict with `slugify`, which translate spaces to "-"
# and punctuation chars to "".
slug = slugify(unidecode(self.name.translate(
{ord(p): '_' for p in string.punctuation}
)))
# Keep the slug length less then SLUG_MAX_LENGTH
if len(slug) < self.SLUG_MAX_LENGTH:
return slug
slug_length = self.SLUG_MAX_LENGTH - self.SLUG_HASH_SIZE - 1
return catalog.models.randomize_slug(
slug=slug[:slug_length],
hash_size=self.SLUG_HASH_SIZE
)
def get_min_price(self) -> float:
"""Helper for templates."""
return self.options.min_price()
def save(self, *args, **kwargs):
if not self.slug:
self.slug = self._get_slug()
super().save(*args, **kwargs)
class SectionQuerySet(models.QuerySet):
def bind_fields(self):
"""Prefetch or select typical related fields to reduce sql queries count."""
return (
self.select_related('page')
.prefetch_related('products')
)
def active(self) -> 'SeriesQuerySet':
return self.filter(page__is_active=True)
def exclude_empty(self) -> 'SeriesQuerySet':
return (
self.active()
.filter(products__page__is_active=True)
.distinct()
)
class SectionManager(models.Manager.from_queryset(SeriesQuerySet)):
"""Get all products of given category by Category's id or instance."""
def active(self):
return self.get_queryset().active()
# @todo #669:30m Add Sections to the admin panel.
# @todo #669:30m Get rid of Category-Series-Section models code doubling.
class Section(pages.models.PageMixin):
"""
Group of products created by product type principle.
See doc/section.md for details.
"""
# @todo #669:30m Doc section concept.
# What problem it solves, who required it.
# Why we solved problem in this way.
objects = SeriesManager()
SLUG_HASH_SIZE = 5
SLUG_MAX_LENGTH = 50
class Meta:
verbose_name = _('Section')
verbose_name_plural = _('Sections')
name = models.CharField(
max_length=1000, db_index=True, unique=True, verbose_name=_('name')
)
@property
def url(self):
return self.get_absolute_url()
def get_absolute_url(self):
"""Url path to the related page."""
return reverse('section', args=(self.page.slug,))
def get_min_price(self) -> float:
"""Helper for templates."""
return self.products.options().min_price()
class OptionQuerySet(models.QuerySet):
def active(self):
return self.filter(product__isnull=False, product__page__is_active=True)
def bind_fields(self):
"""Prefetch or select typical related fields to reduce sql queries count."""
return (
self.select_related('product')
.select_related('series')
.prefetch_related('tags')
)
def filter_descendants(self, category: models.Model) -> models.QuerySet:
return self.filter(product__category__in=category.get_descendants(True))
def tagged(self, tags: 'TagQuerySet'):
# Distinct because a relation of tags and products is M2M.
# We do not specify the args for `distinct` to avoid dependencies
# between `order_by` and `distinct` methods.
# Postgres has `SELECT DISTINCT ON`, that depends on `ORDER BY`.
# See docs for details:
# https://www.postgresql.org/docs/10/static/sql-select.html#SQL-DISTINCT
# https://docs.djangoproject.com/en/2.1/ref/models/querysets/#django.db.models.query.QuerySet.distinct
return self.filter(tags__in=tags).distinct()
def tagged_or_all(self, tags: 'TagQuerySet'):
return (
self.tagged(tags)
if tags.exists()
else self
)
def min_price(self) -> float:
min_price = self.aggregate(min_price=models.Min('price'))['min_price']
return min_price or 0.0
class OptionManager(models.Manager.from_queryset(OptionQuerySet)):
"""Get all products of given category by Category's id or instance."""
class Option(catalog.models.AbstractOption):
"""This doc page describes what is option: https://goo.gl/S4U9PG."""
class Meta:
# Product and Option has the same verbose names
# in case of "ЖБИ" domain area.
verbose_name = _('Product')
verbose_name_plural = _('Products')
objects = OptionManager()
@property
def name(self):
return self.product.name
@property
def page(self):
return self.product.page
def get_absolute_url(self):
return self.product.url
@property
def url(self):
return self.product.url
code = models.BigIntegerField(null=True, blank=True, verbose_name=_('code')) # Ignore CPDBear
mark = models.CharField(default='', max_length=500, blank=True, verbose_name=_('mark'))
tags = models.ManyToManyField(
'Tag',
related_name='options',
blank=True,
verbose_name=_('tags'),
)
product = models.ForeignKey(
'Product',
on_delete=models.CASCADE,
related_name='options',
verbose_name=_('product'),
)
series = models.ForeignKey(
Series,
on_delete=models.CASCADE,
related_name='options',
verbose_name=_('series'),
null=True,
)
date_price_updated = models.DateField(auto_now_add=True, verbose_name=_('date price updated'))
price = models.FloatField(
blank=True,
default=0,
db_index=True,
verbose_name=_('price'),
)
in_stock = models.PositiveIntegerField(
default=0,
db_index=True,
verbose_name=_('in stock'),
)
is_popular = models.BooleanField(
default=False,
db_index=True,
verbose_name=_('is popular'),
)
@property
def catalog_name(self) -> str:
return f'{self.name} {self.mark}'
def __str__(self):
return self.mark # Ignore CPDBear
class ProductQuerySet(catalog.models.ProductQuerySet):
# @todo #597:60m Implement `ProductQuerySet.get_series` method.
# Then reuse it at existing `Product.get_series` method.
# Use this ProductQuerySet class as Product queryset.
def get_series(self):
pass
def options(self) -> OptionQuerySet:
return Option.objects.filter(product__in=self).distinct()
class ProductManager(models.Manager.from_queryset(ProductQuerySet)):
"""Get all products of given category by Category's id or instance."""
def filter_descendants(self, category: Category) -> ProductQuerySet:
return self.get_queryset().filter_descendants(category)
def active(self):
return self.get_queryset().active()
def tagged(self, tags: typing.Iterable['Tag']):
return self.get_queryset().tagged(tags)
# not inherited from `catalog.models.AbstractProduct`, because
# AbstractProduct's set of fields is shared between Product and Option models.
class Product(catalog.models.AbstractProduct, pages.models.PageMixin):
objects = ProductManager()
name = models.CharField(max_length=255, db_index=True, verbose_name=_('name'))
category = models.ForeignKey(
Category,
on_delete=models.CASCADE,
related_name='products',
verbose_name=_('category'),
)
section = models.ForeignKey(
Section,
on_delete=models.CASCADE,
related_name='products',
verbose_name=_('section'),
null=True,
)
def __str__(self):
return self.name
@property
def url(self):
return self.get_absolute_url()
@property
def parent(self):
return self.category or None
def get_absolute_url(self):
return reverse('product', args=(self.id,))
def get_admin_tree_title(self):
return f'[{self.id}] {self.name}]'
def get_root_category(self):
return self.category.get_root()
def get_siblings(self, offset):
return (
self.__class__.objects
.active()
.filter(category=self.category)
.exclude(id=self.id)
.prefetch_related('category')
.select_related('page')[:offset]
)
def get_series(self) -> models.QuerySet:
"""
Use it only for a single product.
It'll produce N queries for a batch QuerySet with N products.
Use ProductQS.
"""
product = Product.objects.prefetch_related('options').get(id=self.id)
return (
Series.objects
.filter(options__in=product.options.active())
.distinct()
)
# @todo #597:30m Remove Product.price field
# we'll remove this field
# after integration admin to Options feature at #433
price = models.FloatField(
blank=True,
default=0,
db_index=True,
verbose_name=_('price'),
)
class CategoryPage(pages.models.ModelPage):
"""Proxy model for Admin."""
class Meta(pages.models.ModelPage.Meta):
proxy = True
verbose_name = _('category')
verbose_name_plural = _('categories')
objects = pages.models.ModelPage.create_model_page_managers(Category)
class ProductPage(pages.models.ModelPage):
"""Proxy model for Admin."""
class Meta(pages.models.ModelPage.Meta):
proxy = True
verbose_name = _('product')
verbose_name_plural = _('products')
objects = pages.models.ModelPage.create_model_page_managers(Product)
class SeriesPage(pages.models.ModelPage):
"""Proxy model for Admin."""
class Meta(pages.models.ModelPage.Meta):
proxy = True
verbose_name = _('serie')
verbose_name_plural = _('series')
objects = pages.models.ModelPage.create_model_page_managers(Series)
def get_manager(parent_slug):
class FlatPageTypeManager(mptt.models.TreeManager):
def get_queryset(self):
return (
super(FlatPageTypeManager, self)
.get_queryset()
.filter(parent__slug=parent_slug)
)
return FlatPageTypeManager()
# @todo #172:60m Set "news" parent-page by default.
# At stb#172 PO had problems with creating news.
# Then dev should do 1h research to reinvent
# manually adding "news" parent-page rule.
class NewsForAdmin(pages.models.Page):
class Meta:
proxy = True
verbose_name = _('News')
verbose_name_plural = _('News')
objects = get_manager('news')
class RegionsForAdmin(pages.models.Page):
class Meta:
proxy = True
verbose_name = _('Regions')
verbose_name_plural = _('Regions')
objects = get_manager('regions')
class ClientFeedbacksForAdmin(pages.models.Page):
class Meta:
proxy = True
verbose_name = _('Client feedbacks')
verbose_name_plural = _('Client feedbacks')
objects = get_manager('client-feedbacks')
class TagGroup(catalog.models.TagGroup):
pass
class TagQuerySet(catalog.models.TagQuerySet):
def filter_by_options(self, options: typing.Iterable[Option]):
return (
self
.filter(options__in=options)
.distinct()
)
def exclude_by_options(self, options: typing.Iterable[Option]):
return (
self
.exclude(options__in=options)
.distinct()
)
class TagManager(models.Manager.from_queryset(TagQuerySet)):
pass
class Tag(catalog.models.Tag):
objects = TagManager()
group = models.ForeignKey(
TagGroup, on_delete=models.CASCADE, null=True, related_name='tags',
)