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
|
from __future__ import annotations
from django.contrib.contenttypes.fields import GenericForeignKey
from django.contrib.contenttypes.models import ContentType
from django.db import models
from sphinxcontrib_django.docstrings.config import CHOICES_LIMIT
try:
from phonenumber_field.modelfields import PhoneNumberField
PHONENUMBER = True
except ModuleNotFoundError:
# In case phonenumber is not used, pass
PHONENUMBER = False
class SimpleModelManager(models.Manager):
pass
class FileModel(models.Model):
upload = models.FileField()
class SimpleModel(models.Model):
#: Docstring of foreign key
file = models.ForeignKey(
"FileModel", related_name="simple_models", on_delete=models.CASCADE
)
#: Docstring of one to one field
childA = models.OneToOneField(
"ChildModelA", related_name="simple_model", on_delete=models.CASCADE
)
childrenB = models.ManyToManyField("ChildModelB", related_name="simple_models")
"""
Docstring of many to many field
.. note::
This syntax is also supported.
"""
#: Docstring of char field
#:
#: .. warning::
#:
#: Inline directives should be preserved.
dummy_field = models.CharField(
max_length=3,
help_text="This should help you",
verbose_name="Very verbose name of dummy field",
)
#: Custom model manager
custom_objects = SimpleModelManager()
# Mock get_..._display method of Django models
def get_dummy_field_display(self):
pass
# Mock common get_next_by_ method
def get_next_by_dummy_field(self):
pass
# Mock common get_previous_by_ method
def get_previous_by_dummy_field(self):
pass
class AbstractModel(models.Model):
simple_model = models.ForeignKey("SimpleModel", on_delete=models.CASCADE)
user = models.ForeignKey("auth.User", related_name="+", on_delete=models.CASCADE)
foreignkey_self = models.ForeignKey("self", on_delete=models.CASCADE)
class Meta:
abstract = True
class ChildModelA(AbstractModel):
pass
class ChildModelB(AbstractModel):
pass
class ChoiceModel(models.Model):
choice_limit_below = models.IntegerField(
choices=[(i, i) for i in range(CHOICES_LIMIT - 1)]
)
choice_limit_exact = models.IntegerField(
choices=[(i, i) for i in range(CHOICES_LIMIT + 1)]
)
choice_limit_above = models.IntegerField(
choices=[(i, i) for i in range(CHOICES_LIMIT + 2)]
)
choice_with_empty = models.CharField(
choices=[("", "Empty"), ("Something", "Not empty")]
)
class TaggedItem(models.Model):
# Test model taken from:
# https://docs.djangoproject.com/en/stable/ref/contrib/contenttypes/#generic-relations
tag = models.SlugField()
content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
object_id = models.PositiveIntegerField()
content_object = GenericForeignKey("content_type", "object_id")
def __str__(self) -> str:
return self.tag
if PHONENUMBER:
class PhoneNumberModel(models.Model):
phone_number = PhoneNumberField()
class MonkeyPatched(models.Model):
pass
|
