-
Notifications
You must be signed in to change notification settings - Fork 75
Expand file tree
/
Copy pathviews.py
More file actions
398 lines (345 loc) · 13.2 KB
/
views.py
File metadata and controls
398 lines (345 loc) · 13.2 KB
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
from collections import defaultdict
from collections.abc import Sequence
from typing import Any
import attrs
from django import http
from django.db.models import QuerySet
from django.urls import reverse
from django.views.generic import RedirectView, TemplateView, View
from cbv.models import Klass, KlassAttribute, Module, ProjectVersion
from cbv.queries import NavBuilder
class RedirectToLatestVersionView(RedirectView):
permanent = False
def get_redirect_url(self, *, url_name: str, **kwargs):
kwargs["version"] = ProjectVersion.objects.get_latest().version_number
self.url = reverse(url_name, kwargs=kwargs)
return super().get_redirect_url(**kwargs)
class KlassDetailView(TemplateView):
template_name = "cbv/klass_detail.html"
@attrs.frozen
class Class:
db_id: int
docs_url: str
docstring: str | None
import_path: str
name: str
source_url: str
url: str
@attrs.frozen
class Ancestor:
name: str
url: str
is_direct: bool
@attrs.frozen
class Child:
name: str
url: str
@attrs.frozen
class Method:
@attrs.frozen
class MethodInstance:
docstring: str
code: str
line_number: int
class_name: str
name: str
kwargs: str
namesakes: Sequence[MethodInstance]
@attrs.frozen
class Attribute:
name: str
value: str
overridden: bool
class_url: str | None
class_name: str
def get_context_data(self, **kwargs):
qs = Klass.objects.filter(
name__iexact=self.kwargs["klass"],
module__name__iexact=self.kwargs["module"],
module__project_version__version_number=self.kwargs["version"],
).select_related("module__project_version")
try:
klass = qs.get()
except Klass.DoesNotExist:
raise http.Http404
canonical_url_path = klass.get_latest_version_url()
best_current_path = klass.get_absolute_url()
if best_current_path != self.request.path:
push_state_url = best_current_path
else:
push_state_url = None
nav_builder = NavBuilder()
version_switcher = nav_builder.make_version_switcher(
klass.module.project_version, klass
)
nav = nav_builder.get_nav_data(
klass.module.project_version, klass.module, klass
)
class_data = self.Class(
db_id=klass.id,
name=klass.name,
docstring=klass.docstring,
docs_url=klass.docs_url,
import_path=klass.import_path,
source_url=klass.get_source_url(),
url=klass.get_absolute_url(),
)
direct_ancestors = list(klass.get_ancestors())
ancestors = [
self.Ancestor(
name=ancestor.name,
url=ancestor.get_absolute_url(),
is_direct=ancestor in direct_ancestors,
)
for ancestor in klass.get_all_ancestors()
]
children = [
self.Child(
name=child.name,
url=child.get_absolute_url(),
)
for child in klass.get_all_children()
]
methods = [
self.Method(
name=method.name,
kwargs=method.kwargs,
namesakes=[
self.Method.MethodInstance(
docstring=method_instance.docstring,
code=method_instance.code,
line_number=method_instance.line_number,
class_name=method_instance.klass.name,
)
for method_instance in self._namesake_methods(klass, method.name)
],
)
for method in klass.get_methods()
]
attributes = [
self.Attribute(
name=attribute.name,
value=attribute.value,
overridden=hasattr(attribute, "overridden"),
class_url=(
attribute.klass.get_absolute_url()
if attribute.klass_id != klass.id
else None
),
class_name=attribute.klass.name,
)
for attribute in self._get_prepared_attributes(klass)
]
return {
"all_ancestors": ancestors,
"all_children": children,
"attributes": attributes,
"canonical_url": self.request.build_absolute_uri(canonical_url_path),
"class": class_data,
"methods": methods,
"nav": nav,
"project": f"Django {klass.module.project_version.version_number}",
"push_state_url": push_state_url,
"version_switcher": version_switcher,
"yuml_url": klass.basic_yuml_url(),
}
def _namesake_methods(self, parent_klass, name):
namesakes = [m for m in parent_klass.get_methods() if m.name == name]
assert namesakes
# Get the methods in order of the klasses
try:
result = [next(m for m in namesakes if m.klass == parent_klass)]
namesakes.pop(namesakes.index(result[0]))
except StopIteration:
result = []
for klass in parent_klass.get_all_ancestors():
# Move the namesakes from the methods to the results
try:
method = next(m for m in namesakes if m.klass == klass)
namesakes.pop(namesakes.index(method))
result.append(method)
except StopIteration:
pass
assert not namesakes
return result
def _get_prepared_attributes(self, klass: Klass) -> QuerySet["KlassAttribute"]:
attributes = klass.get_attributes()
# Make a dictionary of attributes based on name
attribute_names: dict[str, list[KlassAttribute]] = defaultdict(list)
for attr in attributes:
attribute_names[attr.name].append(attr)
ancestors = klass.get_all_ancestors()
# Sort the attributes by ancestors.
def _key(a: KlassAttribute) -> int:
try:
# If ancestor, return the index (>= 0)
return ancestors.index(a.klass)
except ValueError: # Raised by .index if item is not in list.
# else a.klass == klass, so return -1
return -1
# Find overridden attributes
for klass_attributes in attribute_names.values():
# Skip if we have only one attribute.
if len(klass_attributes) == 1:
continue
sorted_attrs = sorted(klass_attributes, key=_key)
# Mark overriden KlassAttributes
for a in sorted_attrs[1:]:
a.overridden = True
return attributes
class LatestKlassRedirectView(RedirectView):
def get_redirect_url(self, **kwargs):
try:
klass = Klass.objects.get_latest_for_name(klass_name=self.kwargs["klass"])
except Klass.DoesNotExist:
raise http.Http404
return klass.get_latest_version_url()
@attrs.frozen
class KlassData:
name: str
url: str
class ModuleDetailView(TemplateView):
template_name = "cbv/module_detail.html"
push_state_url = None
def get_object(self, queryset=None):
try:
obj = self.get_precise_object()
except Module.DoesNotExist:
try:
obj = self.get_fuzzy_object()
except Module.DoesNotExist:
raise http.Http404
self.push_state_url = obj.get_absolute_url()
return obj
def get(self, request, *args, **kwargs):
try:
self.project_version = ProjectVersion.objects.filter(
version_number=kwargs["version"]
).get()
except ProjectVersion.DoesNotExist:
raise http.Http404
return super().get(request, *args, **kwargs)
def get_precise_object(self, queryset=None):
return Module.objects.get(
name=self.kwargs["module"], project_version=self.project_version
)
def get_fuzzy_object(self, queryset=None):
return Module.objects.get(
name__iexact=self.kwargs["module"],
project_version__version_number=self.kwargs["version"],
)
def get_context_data(self, **kwargs):
module = self.get_object()
klasses = Klass.objects.filter(module=module).select_related(
"module__project_version"
)
klass_list = [KlassData(name=k.name, url=k.get_absolute_url()) for k in klasses]
latest_version = (
Module.objects.filter(
name=module.name,
)
.select_related("project_version")
.order_by("-project_version__sortable_version_number")
.first()
)
canonical_url_path = latest_version.get_absolute_url()
nav_builder = NavBuilder()
version_switcher = nav_builder.make_version_switcher(self.project_version)
nav = nav_builder.get_nav_data(self.project_version, module)
return {
"canonical_url": self.request.build_absolute_uri(canonical_url_path),
"klass_list": klass_list,
"module_name": module.name,
"nav": nav,
"project": f"Django {self.project_version.version_number}",
"push_state_url": self.push_state_url,
"version_switcher": version_switcher,
}
@attrs.frozen
class DjangoClassListItem:
docstring: str
is_secondary: bool
name: str
module_long_name: str
module_name: str
module_short_name: str
url: str
class VersionDetailView(TemplateView):
template_name = "cbv/version_detail.html"
def get_context_data(self, **kwargs):
qs = ProjectVersion.objects.filter(version_number=kwargs["version"])
try:
project_version = qs.get()
except ProjectVersion.DoesNotExist:
raise http.Http404
nav_builder = NavBuilder()
version_switcher = nav_builder.make_version_switcher(project_version)
nav = nav_builder.get_nav_data(project_version)
return {
"nav": nav,
"object_list": [
DjangoClassListItem(
docstring=class_.docstring,
is_secondary=class_.is_secondary(),
name=class_.name,
module_long_name=class_.module.long_name,
module_name=class_.module.name,
module_short_name=class_.module.short_name,
url=class_.get_absolute_url(),
)
for class_ in Klass.objects.filter(
module__project_version=project_version
).select_related("module__project_version")
],
"project": f"Django {project_version.version_number}",
"version_switcher": version_switcher,
}
class HomeView(TemplateView):
template_name = "home.html"
def get_context_data(self, **kwargs):
project_version = ProjectVersion.objects.get_latest()
nav_builder = NavBuilder()
version_switcher = nav_builder.make_version_switcher(project_version)
nav = nav_builder.get_nav_data(project_version)
return {
"nav": nav,
"object_list": [
DjangoClassListItem(
docstring=class_.docstring,
is_secondary=class_.is_secondary(),
name=class_.name,
module_long_name=class_.module.long_name,
module_name=class_.module.name,
module_short_name=class_.module.short_name,
url=class_.get_absolute_url(),
)
for class_ in Klass.objects.filter(
module__project_version=project_version
).select_related("module__project_version")
],
"project": f"Django {project_version.version_number}",
"version_switcher": version_switcher,
}
class Sitemap(TemplateView):
content_type = "application/xml"
template_name = "sitemap.xml"
def get_context_data(self, **kwargs: Any) -> dict[str, Any]:
latest_version = ProjectVersion.objects.get_latest()
klasses = Klass.objects.select_related("module__project_version").order_by(
"-module__project_version__sortable_version_number",
"module__name",
"name",
)
urls = [{"location": reverse("home"), "priority": 1.0}]
for klass in klasses:
priority = 0.9 if klass.module.project_version == latest_version else 0.5
urls.append({"location": klass.get_absolute_url(), "priority": priority})
return {"urlset": urls}
class BasicHealthcheck(View):
"""
Minimal "up" healthcheck endpoint. Returns an empty 200 response.
Deliberately doesn't check the state of required services such as the database
so that a misconfigured or down DB doesn't prevent a deploy.
"""
def get(self, request: http.HttpRequest) -> http.HttpResponse:
return http.HttpResponse()