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
|
from operator import itemgetter
from django.contrib.postgres import fields as pgfields
from django.core.validators import MaxValueValidator, MinValueValidator, RegexValidator
from django.db import models
class ModelReprMixin:
"""
Adds a `__repr__` method to the model subclassing this
mixin which will display the model's class name along
with all parameters used to construct the object.
"""
def __repr__(self):
attributes = ' '.join(
f'{attribute}={value!r}'
for attribute, value in sorted(
self.__dict__.items(),
key=itemgetter(0)
)
if not attribute.startswith('_')
)
return f'<{self.__class__.__name__}({attributes})>'
class DocumentationLink(ModelReprMixin, models.Model):
"""A documentation link used by the `!docs` command of the bot."""
package = models.CharField(
primary_key=True,
max_length=50,
help_text="The Python package name that this documentation link belongs to."
)
base_url = models.URLField(
help_text=(
"The base URL from which documentation will be available for this project. "
"Used to generate links to various symbols within this package."
)
)
inventory_url = models.URLField(
help_text="The URL at which the Sphinx inventory is available for this package."
)
def __str__(self):
return f"{self.package} - {self.base_url}"
class OffTopicChannelName(ModelReprMixin, models.Model):
name = models.CharField(
primary_key=True,
max_length=96,
validators=(RegexValidator(regex=r'^[a-z0-9-]+$'),),
help_text="The actual channel name that will be used on our Discord server."
)
def __str__(self):
return self.name
class SnakeName(ModelReprMixin, models.Model):
"""A snake name used by the bot's snake cog."""
name = models.CharField(
primary_key=True,
max_length=100,
help_text="The regular name for this snake, e.g. 'Python'."
)
scientific = models.CharField(
max_length=150,
help_text="The scientific name for this snake, e.g. 'Python bivittatus'."
)
def __str__(self):
return f"{self.name} ({self.scientific})"
class Role(ModelReprMixin, models.Model):
"""A role on our Discord server."""
id = models.BigIntegerField( # noqa
primary_key=True,
validators=(
MinValueValidator(
limit_value=0,
message="Role IDs cannot be negative."
),
),
help_text="The role ID, taken from Discord."
)
name = models.CharField(
max_length=100,
help_text="The role name, taken from Discord."
)
colour = models.IntegerField(
validators=(
MinValueValidator(
limit_value=0,
message="Colour hex cannot be negative."
),
),
help_text="The integer value of the colour of this role from Discord."
)
permissions = models.IntegerField(
validators=(
MinValueValidator(
limit_value=0,
message="Role permissions cannot be negative."
),
MaxValueValidator(
limit_value=2 << 32,
message="Role permission bitset exceeds value of having all permissions"
)
),
help_text="The integer value of the permission bitset of this role from Discord."
)
def __str__(self):
return self.name
class Member(ModelReprMixin, models.Model):
"""A member of our Discord server."""
id = models.BigIntegerField( # noqa
primary_key=True,
validators=(
MinValueValidator(
limit_value=0,
message="User IDs cannot be negative."
),
),
help_text="The ID of this user, taken from Discord."
)
name = models.CharField(
max_length=32,
help_text="The username, taken from Discord."
)
discriminator = models.PositiveSmallIntegerField(
validators=(
MaxValueValidator(
limit_value=9999,
message="Discriminators may not exceed `9999`."
),
),
help_text="The discriminator of this user, taken from Discord."
)
avatar_hash = models.CharField(
max_length=100,
help_text=(
"The user's avatar hash, taken from Discord. "
"Null if the user does not have any custom avatar."
),
null=True
)
roles = models.ManyToManyField(
Role,
help_text="Any roles this user has on our server."
)
def __str__(self):
return f"{self.name}#{self.discriminator}"
class Tag(ModelReprMixin, models.Model):
"""A tag providing (hopefully) useful information."""
title = models.CharField(
max_length=100,
help_text=(
"The title of this tag, shown in searches and providing "
"a quick overview over what this embed contains."
),
primary_key=True
)
embed = pgfields.JSONField(
help_text="The actual embed shown by this tag."
)
|
