Debian Codegraph @

tests/models.py

raw
1 from __future__ import annotations
2
3 from typing import Any, ClassVar, TypeVar, overload
4
5 from django.db import models
6 from django.db.models import Manager
7 from django.db.models.query import QuerySet
8 from django.db.models.query_utils import DeferredAttribute
9 from django.utils.translation import gettext_lazy as _
10
11 from model_utils import Choices
12 from model_utils.fields import MonitorField, SplitField, StatusField, UUIDField
13 from model_utils.managers import (
14 InheritanceManager,
15 JoinQueryset,
16 QueryManager,
17 SoftDeletableManager,
18 SoftDeletableQuerySet,
19 )
20 from model_utils.models import (
21 SoftDeletableModel,
22 StatusModel,
23 TimeFramedModel,
24 TimeStampedModel,
25 UUIDModel,
26 )
27 from model_utils.tracker import FieldTracker, ModelTracker
28 from tests.fields import MutableField
29
30 ModelT = TypeVar('ModelT', bound=models.Model, covariant=True)
31
32
33 class InheritanceManagerTestRelated(models.Model):
34 pass
35
36
37 class InheritanceManagerTestParent(models.Model):
38 # FileField is just a handy descriptor-using field. Refs #6.
39 non_related_field_using_descriptor = models.FileField(upload_to="test")
40 related = models.ForeignKey(
41 InheritanceManagerTestRelated, related_name="imtests", null=True,
42 on_delete=models.CASCADE)
43 normal_field = models.TextField()
44 related_self = models.OneToOneField(
45 "self", related_name="imtests_self", null=True,
46 on_delete=models.CASCADE)
47 objects: ClassVar[InheritanceManager[InheritanceManagerTestParent]] = InheritanceManager()
48
49 def __str__(self) -> str:
50 return "{}({})".format(
51 self.__class__.__name__[len('InheritanceManagerTest'):],
52 self.pk,
53 )
54
55
56 class InheritanceManagerTestChild1(InheritanceManagerTestParent):
57 non_related_field_using_descriptor_2 = models.FileField(upload_to="test")
58 normal_field_2 = models.TextField()
59 objects: ClassVar[InheritanceManager[InheritanceManagerTestParent]] = InheritanceManager()
60
61
62 class InheritanceManagerTestGrandChild1(InheritanceManagerTestChild1):
63 text_field = models.TextField()
64
65
66 class InheritanceManagerTestGrandChild1_2(InheritanceManagerTestChild1):
67 text_field = models.TextField()
68
69
70 class InheritanceManagerTestChild2(InheritanceManagerTestParent):
71 non_related_field_using_descriptor_2 = models.FileField(upload_to="test")
72 normal_field_2 = models.TextField()
73
74
75 class InheritanceManagerTestChild3(InheritanceManagerTestParent):
76 parent_ptr = models.OneToOneField(
77 InheritanceManagerTestParent, related_name='manual_onetoone',
78 parent_link=True, on_delete=models.CASCADE)
79
80
81 class InheritanceManagerTestChild3_1(InheritanceManagerTestParent):
82 parent_ptr = models.OneToOneField(
83 InheritanceManagerTestParent, db_column="custom_parent_ptr",
84 parent_link=True, on_delete=models.CASCADE)
85
86
87 class InheritanceManagerTestChild4(InheritanceManagerTestParent):
88 other_onetoone = models.OneToOneField(
89 InheritanceManagerTestParent, related_name='non_inheritance_relation',
90 parent_link=False, on_delete=models.CASCADE)
91 # The following is needed because of that Django bug:
92 # https://code.djangoproject.com/ticket/29998
93 parent_ptr = models.OneToOneField(
94 InheritanceManagerTestParent, related_name='child4_onetoone',
95 parent_link=True, on_delete=models.CASCADE)
96
97
98 class TimeStamp(TimeStampedModel):
99 test_field = models.PositiveSmallIntegerField(default=0)
100
101
102 class TimeFrame(TimeFramedModel):
103 pass
104
105
106 class TimeFrameManagerAdded(TimeFramedModel):
107 pass
108
109
110 class Monitored(models.Model):
111 name = models.CharField(max_length=25)
112 name_changed = MonitorField(monitor="name")
113 name_changed_nullable = MonitorField(monitor="name", null=True)
114
115
116 class MonitorWhen(models.Model):
117 name = models.CharField(max_length=25)
118 name_changed = MonitorField(monitor="name", when=["Jose", "Maria"])
119
120
121 class MonitorWhenEmpty(models.Model):
122 name = models.CharField(max_length=25)
123 name_changed = MonitorField(monitor="name", when=[])
124
125
126 class DoubleMonitored(models.Model):
127 name = models.CharField(max_length=25)
128 name_changed = MonitorField(monitor="name")
129 name2 = models.CharField(max_length=25)
130 name_changed2 = MonitorField(monitor="name2")
131
132
133 class Status(StatusModel):
134 STATUS: Choices[str] = Choices(
135 ("active", _("active")),
136 ("deleted", _("deleted")),
137 ("on_hold", _("on hold")),
138 )
139
140
141 class StatusPlainTuple(StatusModel):
142 STATUS = (
143 ("active", _("active")),
144 ("deleted", _("deleted")),
145 ("on_hold", _("on hold")),
146 )
147
148
149 class StatusManagerAdded(StatusModel):
150 STATUS = (
151 ("active", _("active")),
152 ("deleted", _("deleted")),
153 ("on_hold", _("on hold")),
154 )
155
156
157 class StatusCustomManager(Manager):
158 pass
159
160
161 class AbstractCustomManagerStatusModel(StatusModel):
162 """An abstract status model with a custom manager."""
163
164 STATUS = Choices(
165 ("first_choice", _("First choice")),
166 ("second_choice", _("Second choice")),
167 )
168
169 objects = StatusCustomManager()
170
171 class Meta:
172 abstract = True
173
174
175 class CustomManagerStatusModel(AbstractCustomManagerStatusModel):
176 """A concrete status model with a custom manager."""
177
178 title = models.CharField(max_length=50)
179
180
181 class Post(models.Model):
182 published = models.BooleanField(default=False)
183 confirmed = models.BooleanField(default=False)
184 order = models.IntegerField()
185
186 objects = models.Manager()
187 public: ClassVar[QueryManager[Post]] = QueryManager(published=True)
188 public_confirmed: ClassVar[QueryManager[Post]] = QueryManager(
189 models.Q(published=True) & models.Q(confirmed=True))
190 public_reversed: ClassVar[QueryManager[Post]] = QueryManager(
191 published=True).order_by("-order")
192
193 class Meta:
194 ordering = ("order",)
195
196
197 class Article(models.Model):
198 title = models.CharField(max_length=50)
199 body = SplitField()
200
201
202 class SplitFieldAbstractParent(models.Model):
203 content = SplitField()
204
205 class Meta:
206 abstract = True
207
208
209 class AbstractTracked(models.Model):
210
211 class Meta:
212 abstract = True
213
214
215 class Tracked(models.Model):
216 name = models.CharField(max_length=20)
217 number = models.IntegerField()
218 mutable = MutableField(default=None)
219
220 tracker = FieldTracker()
221
222 def save(self, *args: Any, **kwargs: Any) -> None:
223 """ No-op save() to ensure that FieldTracker.patch_save() works. """
224 super().save(*args, **kwargs)
225
226
227 class TrackerTimeStamped(TimeStampedModel):
228 name = models.CharField(max_length=20)
229 number = models.IntegerField()
230 mutable = MutableField(default=None)
231
232 tracker = FieldTracker()
233
234 def save(self, *args: Any, **kwargs: Any) -> None:
235 """ Automatically add "modified" to update_fields."""
236 update_fields = kwargs.get('update_fields')
237 if update_fields is not None:
238 kwargs['update_fields'] = set(update_fields) | {'modified'}
239 super().save(*args, **kwargs)
240
241
242 class TrackedFK(models.Model):
243 fk = models.ForeignKey('Tracked', on_delete=models.CASCADE)
244
245 tracker = FieldTracker()
246 custom_tracker = FieldTracker(fields=['fk_id'])
247 custom_tracker_without_id = FieldTracker(fields=['fk'])
248
249
250 class TrackedAbstract(AbstractTracked):
251 name = models.CharField(max_length=20)
252 number = models.IntegerField()
253 mutable = MutableField(default=None)
254
255 tracker = ModelTracker()
256
257
258 class TrackedNotDefault(models.Model):
259 name = models.CharField(max_length=20)
260 number = models.IntegerField()
261
262 name_tracker = FieldTracker(fields=['name'])
263
264
265 class TrackedNonFieldAttr(models.Model):
266 number = models.FloatField()
267
268 @property
269 def rounded(self) -> int | None:
270 return round(self.number) if self.number is not None else None
271
272 tracker = FieldTracker(fields=['rounded'])
273
274
275 class TrackedMultiple(models.Model):
276 name = models.CharField(max_length=20)
277 number = models.IntegerField()
278
279 name_tracker = FieldTracker(fields=['name'])
280 number_tracker = FieldTracker(fields=['number'])
281
282
283 class TrackedFileField(models.Model):
284 some_file = models.FileField(upload_to='test_location')
285
286 tracker = FieldTracker()
287
288
289 class InheritedTracked(Tracked):
290 name2 = models.CharField(max_length=20)
291
292
293 class InheritedTrackedFK(TrackedFK):
294 custom_tracker = FieldTracker(fields=['fk_id'])
295 custom_tracker_without_id = FieldTracker(fields=['fk'])
296
297
298 class ModelTracked(models.Model):
299 name = models.CharField(max_length=20)
300 number = models.IntegerField()
301 mutable = MutableField(default=None)
302
303 tracker = ModelTracker()
304
305
306 class ModelTrackedFK(models.Model):
307 fk = models.ForeignKey('ModelTracked', on_delete=models.CASCADE)
308
309 tracker = ModelTracker()
310 custom_tracker = ModelTracker(fields=['fk_id'])
311 custom_tracker_without_id = ModelTracker(fields=['fk'])
312
313
314 class ModelTrackedNotDefault(models.Model):
315 name = models.CharField(max_length=20)
316 number = models.IntegerField()
317
318 name_tracker = ModelTracker(fields=['name'])
319
320
321 class ModelTrackedMultiple(models.Model):
322 name = models.CharField(max_length=20)
323 number = models.IntegerField()
324
325 name_tracker = ModelTracker(fields=['name'])
326 number_tracker = ModelTracker(fields=['number'])
327
328
329 class InheritedModelTracked(ModelTracked):
330 name2 = models.CharField(max_length=20)
331
332
333 class StatusFieldDefaultFilled(models.Model):
334 STATUS = Choices((0, "no", "No"), (1, "yes", "Yes"))
335 status = StatusField(default=STATUS.yes)
336
337
338 class StatusFieldDefaultNotFilled(models.Model):
339 STATUS = Choices((0, "no", "No"), (1, "yes", "Yes"))
340 status = StatusField()
341
342
343 class StatusFieldChoicesName(models.Model):
344 NAMED_STATUS = Choices((0, "no", "No"), (1, "yes", "Yes"))
345 status = StatusField(choices_name='NAMED_STATUS')
346
347
348 class SoftDeletable(SoftDeletableModel):
349 """
350 Test model with additional manager for full access to model
351 instances.
352 """
353 name = models.CharField(max_length=20)
354
355 all_objects: ClassVar[Manager[SoftDeletable]] = models.Manager()
356
357
358 class CustomSoftDeleteQuerySet(SoftDeletableQuerySet[ModelT]):
359 def only_read(self) -> QuerySet[ModelT]:
360 return self.filter(is_read=True)
361
362
363 class CustomSoftDelete(SoftDeletableModel):
364 is_read = models.BooleanField(default=False)
365
366 available_objects = SoftDeletableManager.from_queryset(CustomSoftDeleteQuerySet)()
367
368
369 class StringyDescriptor:
370 """
371 Descriptor that returns a string version of the underlying integer value.
372 """
373 def __init__(self, name: str):
374 self.name = name
375
376 @overload
377 def __get__(self, obj: None, cls: type[models.Model] | None = None) -> StringyDescriptor:
378 ...
379
380 @overload
381 def __get__(self, obj: models.Model, cls: type[models.Model]) -> str:
382 ...
383
384 def __get__(self, obj: models.Model | None, cls: type[models.Model] | None = None) -> StringyDescriptor | str:
385 if obj is None:
386 return self
387 if self.name in obj.get_deferred_fields():
388 # This queries the database, and sets the value on the instance.
389 assert cls is not None
390 fields_map = {f.name: f for f in cls._meta.fields}
391 field = fields_map[self.name]
392 DeferredAttribute(field=field).__get__(obj, cls)
393 return str(obj.__dict__[self.name])
394
395 def __set__(self, obj: object, value: str) -> None:
396 obj.__dict__[self.name] = int(value)
397
398 def __delete__(self, obj: object) -> None:
399 del obj.__dict__[self.name]
400
401
402 class CustomDescriptorField(models.IntegerField):
403 def contribute_to_class(self, cls: type[models.Model], name: str, *args: Any, **kwargs: Any) -> None:
404 super().contribute_to_class(cls, name, *args, **kwargs)
405 setattr(cls, name, StringyDescriptor(name))
406
407
408 class ModelWithCustomDescriptor(models.Model):
409 custom_field = CustomDescriptorField()
410 tracked_custom_field = CustomDescriptorField()
411 regular_field = models.IntegerField()
412 tracked_regular_field = models.IntegerField()
413
414 tracker = FieldTracker(fields=['tracked_custom_field', 'tracked_regular_field'])
415
416
417 class BoxJoinModel(models.Model):
418 name = models.CharField(max_length=32)
419 objects = JoinQueryset.as_manager()
420
421
422 class JoinItemForeignKey(models.Model):
423 weight = models.IntegerField()
424 belonging = models.ForeignKey(
425 BoxJoinModel,
426 null=True,
427 on_delete=models.CASCADE
428 )
429 objects = JoinQueryset.as_manager()
430
431
432 class CustomUUIDModel(UUIDModel):
433 pass
434
435
436 class CustomNotPrimaryUUIDModel(models.Model):
437 uuid = UUIDField(primary_key=False)
438
439
440 class TimeStampWithStatusModel(TimeStampedModel, StatusModel):
441 STATUS = Choices(
442 ("active", _("active")),
443 ("deleted", _("deleted")),
444 ("on_hold", _("on hold")),
445 )
446
447 test_field = models.PositiveSmallIntegerField(default=0)