Coverage for /var/srv/projects/api.amasfac.comuna18.com/tmp/venv/lib/python3.9/site-packages/django/contrib/admindocs/views.py: 24%
216 statements
« prev ^ index » next coverage.py v6.4.4, created at 2023-07-17 14:22 -0600
1import inspect
2from importlib import import_module
3from inspect import cleandoc
4from pathlib import Path
6from django.apps import apps
7from django.contrib import admin
8from django.contrib.admin.views.decorators import staff_member_required
9from django.contrib.admindocs import utils
10from django.contrib.admindocs.utils import replace_named_groups, replace_unnamed_groups
11from django.core.exceptions import ImproperlyConfigured, ViewDoesNotExist
12from django.db import models
13from django.http import Http404
14from django.template.engine import Engine
15from django.urls import get_mod_func, get_resolver, get_urlconf
16from django.utils._os import safe_join
17from django.utils.decorators import method_decorator
18from django.utils.functional import cached_property
19from django.utils.inspect import (
20 func_accepts_kwargs,
21 func_accepts_var_args,
22 get_func_full_args,
23 method_has_no_args,
24)
25from django.utils.translation import gettext as _
26from django.views.generic import TemplateView
28from .utils import get_view_name
30# Exclude methods starting with these strings from documentation
31MODEL_METHODS_EXCLUDE = ("_", "add_", "delete", "save", "set_")
34class BaseAdminDocsView(TemplateView):
35 """
36 Base view for admindocs views.
37 """
39 @method_decorator(staff_member_required)
40 def dispatch(self, request, *args, **kwargs):
41 if not utils.docutils_is_available:
42 # Display an error message for people without docutils
43 self.template_name = "admin_doc/missing_docutils.html"
44 return self.render_to_response(admin.site.each_context(request))
45 return super().dispatch(request, *args, **kwargs)
47 def get_context_data(self, **kwargs):
48 return super().get_context_data(
49 **{
50 **kwargs,
51 **admin.site.each_context(self.request),
52 }
53 )
56class BookmarkletsView(BaseAdminDocsView):
57 template_name = "admin_doc/bookmarklets.html"
60class TemplateTagIndexView(BaseAdminDocsView):
61 template_name = "admin_doc/template_tag_index.html"
63 def get_context_data(self, **kwargs):
64 tags = []
65 try:
66 engine = Engine.get_default()
67 except ImproperlyConfigured:
68 # Non-trivial TEMPLATES settings aren't supported (#24125).
69 pass
70 else:
71 app_libs = sorted(engine.template_libraries.items())
72 builtin_libs = [("", lib) for lib in engine.template_builtins]
73 for module_name, library in builtin_libs + app_libs:
74 for tag_name, tag_func in library.tags.items():
75 title, body, metadata = utils.parse_docstring(tag_func.__doc__)
76 title = title and utils.parse_rst(
77 title, "tag", _("tag:") + tag_name
78 )
79 body = body and utils.parse_rst(body, "tag", _("tag:") + tag_name)
80 for key in metadata:
81 metadata[key] = utils.parse_rst(
82 metadata[key], "tag", _("tag:") + tag_name
83 )
84 tag_library = module_name.split(".")[-1]
85 tags.append(
86 {
87 "name": tag_name,
88 "title": title,
89 "body": body,
90 "meta": metadata,
91 "library": tag_library,
92 }
93 )
94 return super().get_context_data(**{**kwargs, "tags": tags})
97class TemplateFilterIndexView(BaseAdminDocsView):
98 template_name = "admin_doc/template_filter_index.html"
100 def get_context_data(self, **kwargs):
101 filters = []
102 try:
103 engine = Engine.get_default()
104 except ImproperlyConfigured:
105 # Non-trivial TEMPLATES settings aren't supported (#24125).
106 pass
107 else:
108 app_libs = sorted(engine.template_libraries.items())
109 builtin_libs = [("", lib) for lib in engine.template_builtins]
110 for module_name, library in builtin_libs + app_libs:
111 for filter_name, filter_func in library.filters.items():
112 title, body, metadata = utils.parse_docstring(filter_func.__doc__)
113 title = title and utils.parse_rst(
114 title, "filter", _("filter:") + filter_name
115 )
116 body = body and utils.parse_rst(
117 body, "filter", _("filter:") + filter_name
118 )
119 for key in metadata:
120 metadata[key] = utils.parse_rst(
121 metadata[key], "filter", _("filter:") + filter_name
122 )
123 tag_library = module_name.split(".")[-1]
124 filters.append(
125 {
126 "name": filter_name,
127 "title": title,
128 "body": body,
129 "meta": metadata,
130 "library": tag_library,
131 }
132 )
133 return super().get_context_data(**{**kwargs, "filters": filters})
136class ViewIndexView(BaseAdminDocsView):
137 template_name = "admin_doc/view_index.html"
139 def get_context_data(self, **kwargs):
140 views = []
141 url_resolver = get_resolver(get_urlconf())
142 try:
143 view_functions = extract_views_from_urlpatterns(url_resolver.url_patterns)
144 except ImproperlyConfigured:
145 view_functions = []
146 for (func, regex, namespace, name) in view_functions:
147 views.append(
148 {
149 "full_name": get_view_name(func),
150 "url": simplify_regex(regex),
151 "url_name": ":".join((namespace or []) + (name and [name] or [])),
152 "namespace": ":".join(namespace or []),
153 "name": name,
154 }
155 )
156 return super().get_context_data(**{**kwargs, "views": views})
159class ViewDetailView(BaseAdminDocsView):
160 template_name = "admin_doc/view_detail.html"
162 @staticmethod
163 def _get_view_func(view):
164 urlconf = get_urlconf()
165 if get_resolver(urlconf)._is_callback(view):
166 mod, func = get_mod_func(view)
167 try:
168 # Separate the module and function, e.g.
169 # 'mymodule.views.myview' -> 'mymodule.views', 'myview').
170 return getattr(import_module(mod), func)
171 except ImportError:
172 # Import may fail because view contains a class name, e.g.
173 # 'mymodule.views.ViewContainer.my_view', so mod takes the form
174 # 'mymodule.views.ViewContainer'. Parse it again to separate
175 # the module and class.
176 mod, klass = get_mod_func(mod)
177 return getattr(getattr(import_module(mod), klass), func)
179 def get_context_data(self, **kwargs):
180 view = self.kwargs["view"]
181 view_func = self._get_view_func(view)
182 if view_func is None:
183 raise Http404
184 title, body, metadata = utils.parse_docstring(view_func.__doc__)
185 title = title and utils.parse_rst(title, "view", _("view:") + view)
186 body = body and utils.parse_rst(body, "view", _("view:") + view)
187 for key in metadata:
188 metadata[key] = utils.parse_rst(metadata[key], "model", _("view:") + view)
189 return super().get_context_data(
190 **{
191 **kwargs,
192 "name": view,
193 "summary": title,
194 "body": body,
195 "meta": metadata,
196 }
197 )
200class ModelIndexView(BaseAdminDocsView):
201 template_name = "admin_doc/model_index.html"
203 def get_context_data(self, **kwargs):
204 m_list = [m._meta for m in apps.get_models()]
205 return super().get_context_data(**{**kwargs, "models": m_list})
208class ModelDetailView(BaseAdminDocsView):
209 template_name = "admin_doc/model_detail.html"
211 def get_context_data(self, **kwargs):
212 model_name = self.kwargs["model_name"]
213 # Get the model class.
214 try:
215 app_config = apps.get_app_config(self.kwargs["app_label"])
216 except LookupError:
217 raise Http404(_("App %(app_label)r not found") % self.kwargs)
218 try:
219 model = app_config.get_model(model_name)
220 except LookupError:
221 raise Http404(
222 _("Model %(model_name)r not found in app %(app_label)r") % self.kwargs
223 )
225 opts = model._meta
227 title, body, metadata = utils.parse_docstring(model.__doc__)
228 title = title and utils.parse_rst(title, "model", _("model:") + model_name)
229 body = body and utils.parse_rst(body, "model", _("model:") + model_name)
231 # Gather fields/field descriptions.
232 fields = []
233 for field in opts.fields:
234 # ForeignKey is a special case since the field will actually be a
235 # descriptor that returns the other object
236 if isinstance(field, models.ForeignKey):
237 data_type = field.remote_field.model.__name__
238 app_label = field.remote_field.model._meta.app_label
239 verbose = utils.parse_rst(
240 (
241 _("the related `%(app_label)s.%(data_type)s` object")
242 % {
243 "app_label": app_label,
244 "data_type": data_type,
245 }
246 ),
247 "model",
248 _("model:") + data_type,
249 )
250 else:
251 data_type = get_readable_field_data_type(field)
252 verbose = field.verbose_name
253 fields.append(
254 {
255 "name": field.name,
256 "data_type": data_type,
257 "verbose": verbose or "",
258 "help_text": field.help_text,
259 }
260 )
262 # Gather many-to-many fields.
263 for field in opts.many_to_many:
264 data_type = field.remote_field.model.__name__
265 app_label = field.remote_field.model._meta.app_label
266 verbose = _("related `%(app_label)s.%(object_name)s` objects") % {
267 "app_label": app_label,
268 "object_name": data_type,
269 }
270 fields.append(
271 {
272 "name": "%s.all" % field.name,
273 "data_type": "List",
274 "verbose": utils.parse_rst(
275 _("all %s") % verbose, "model", _("model:") + opts.model_name
276 ),
277 }
278 )
279 fields.append(
280 {
281 "name": "%s.count" % field.name,
282 "data_type": "Integer",
283 "verbose": utils.parse_rst(
284 _("number of %s") % verbose,
285 "model",
286 _("model:") + opts.model_name,
287 ),
288 }
289 )
291 methods = []
292 # Gather model methods.
293 for func_name, func in model.__dict__.items():
294 if inspect.isfunction(func) or isinstance(
295 func, (cached_property, property)
296 ):
297 try:
298 for exclude in MODEL_METHODS_EXCLUDE:
299 if func_name.startswith(exclude):
300 raise StopIteration
301 except StopIteration:
302 continue
303 verbose = func.__doc__
304 verbose = verbose and (
305 utils.parse_rst(
306 cleandoc(verbose), "model", _("model:") + opts.model_name
307 )
308 )
309 # Show properties, cached_properties, and methods without
310 # arguments as fields. Otherwise, show as a 'method with
311 # arguments'.
312 if isinstance(func, (cached_property, property)):
313 fields.append(
314 {
315 "name": func_name,
316 "data_type": get_return_data_type(func_name),
317 "verbose": verbose or "",
318 }
319 )
320 elif (
321 method_has_no_args(func)
322 and not func_accepts_kwargs(func)
323 and not func_accepts_var_args(func)
324 ):
325 fields.append(
326 {
327 "name": func_name,
328 "data_type": get_return_data_type(func_name),
329 "verbose": verbose or "",
330 }
331 )
332 else:
333 arguments = get_func_full_args(func)
334 # Join arguments with ', ' and in case of default value,
335 # join it with '='. Use repr() so that strings will be
336 # correctly displayed.
337 print_arguments = ", ".join(
338 [
339 "=".join([arg_el[0], *map(repr, arg_el[1:])])
340 for arg_el in arguments
341 ]
342 )
343 methods.append(
344 {
345 "name": func_name,
346 "arguments": print_arguments,
347 "verbose": verbose or "",
348 }
349 )
351 # Gather related objects
352 for rel in opts.related_objects:
353 verbose = _("related `%(app_label)s.%(object_name)s` objects") % {
354 "app_label": rel.related_model._meta.app_label,
355 "object_name": rel.related_model._meta.object_name,
356 }
357 accessor = rel.get_accessor_name()
358 fields.append(
359 {
360 "name": "%s.all" % accessor,
361 "data_type": "List",
362 "verbose": utils.parse_rst(
363 _("all %s") % verbose, "model", _("model:") + opts.model_name
364 ),
365 }
366 )
367 fields.append(
368 {
369 "name": "%s.count" % accessor,
370 "data_type": "Integer",
371 "verbose": utils.parse_rst(
372 _("number of %s") % verbose,
373 "model",
374 _("model:") + opts.model_name,
375 ),
376 }
377 )
378 return super().get_context_data(
379 **{
380 **kwargs,
381 "name": opts.label,
382 "summary": title,
383 "description": body,
384 "fields": fields,
385 "methods": methods,
386 }
387 )
390class TemplateDetailView(BaseAdminDocsView):
391 template_name = "admin_doc/template_detail.html"
393 def get_context_data(self, **kwargs):
394 template = self.kwargs["template"]
395 templates = []
396 try:
397 default_engine = Engine.get_default()
398 except ImproperlyConfigured:
399 # Non-trivial TEMPLATES settings aren't supported (#24125).
400 pass
401 else:
402 # This doesn't account for template loaders (#24128).
403 for index, directory in enumerate(default_engine.dirs):
404 template_file = Path(safe_join(directory, template))
405 if template_file.exists():
406 template_contents = template_file.read_text()
407 else:
408 template_contents = ""
409 templates.append(
410 {
411 "file": template_file,
412 "exists": template_file.exists(),
413 "contents": template_contents,
414 "order": index,
415 }
416 )
417 return super().get_context_data(
418 **{
419 **kwargs,
420 "name": template,
421 "templates": templates,
422 }
423 )
426####################
427# Helper functions #
428####################
431def get_return_data_type(func_name):
432 """Return a somewhat-helpful data type given a function name"""
433 if func_name.startswith("get_"):
434 if func_name.endswith("_list"):
435 return "List"
436 elif func_name.endswith("_count"):
437 return "Integer"
438 return ""
441def get_readable_field_data_type(field):
442 """
443 Return the description for a given field type, if it exists. Fields'
444 descriptions can contain format strings, which will be interpolated with
445 the values of field.__dict__ before being output.
446 """
447 return field.description % field.__dict__
450def extract_views_from_urlpatterns(urlpatterns, base="", namespace=None):
451 """
452 Return a list of views from a list of urlpatterns.
454 Each object in the returned list is a two-tuple: (view_func, regex)
455 """
456 views = []
457 for p in urlpatterns:
458 if hasattr(p, "url_patterns"):
459 try:
460 patterns = p.url_patterns
461 except ImportError:
462 continue
463 views.extend(
464 extract_views_from_urlpatterns(
465 patterns,
466 base + str(p.pattern),
467 (namespace or []) + (p.namespace and [p.namespace] or []),
468 )
469 )
470 elif hasattr(p, "callback"):
471 try:
472 views.append((p.callback, base + str(p.pattern), namespace, p.name))
473 except ViewDoesNotExist:
474 continue
475 else:
476 raise TypeError(_("%s does not appear to be a urlpattern object") % p)
477 return views
480def simplify_regex(pattern):
481 r"""
482 Clean up urlpattern regexes into something more readable by humans. For
483 example, turn "^(?P<sport_slug>\w+)/athletes/(?P<athlete_slug>\w+)/$"
484 into "/<sport_slug>/athletes/<athlete_slug>/".
485 """
486 pattern = replace_named_groups(pattern)
487 pattern = replace_unnamed_groups(pattern)
488 # clean up any outstanding regex-y characters.
489 pattern = pattern.replace("^", "").replace("$", "").replace("?", "")
490 if not pattern.startswith("/"):
491 pattern = "/" + pattern
492 return pattern