Debian Codegraph @

tests/admin_views/admin.py

raw
1 import datetime
2 from io import StringIO
3 from wsgiref.util import FileWrapper
4
5 from django import forms
6 from django.contrib import admin
7 from django.contrib.admin import BooleanFieldListFilter
8 from django.contrib.admin.views.main import ChangeList
9 from django.contrib.auth.admin import GroupAdmin, UserAdmin
10 from django.contrib.auth.models import Group, User
11 from django.core.exceptions import ValidationError
12 from django.core.mail import EmailMessage
13 from django.db import models
14 from django.forms.models import BaseModelFormSet
15 from django.http import HttpResponse, JsonResponse, StreamingHttpResponse
16 from django.urls import path
17 from django.utils.html import format_html
18 from django.utils.safestring import mark_safe
19 from django.views.decorators.common import no_append_slash
20
21 from .forms import MediaActionForm
22 from .models import (
23 Actor,
24 AdminOrderedAdminMethod,
25 AdminOrderedCallable,
26 AdminOrderedField,
27 AdminOrderedModelMethod,
28 Album,
29 Answer,
30 Answer2,
31 Article,
32 BarAccount,
33 Book,
34 Bookmark,
35 Box,
36 CamelCaseModel,
37 CamelCaseRelatedModel,
38 Category,
39 Chapter,
40 ChapterXtra1,
41 Child,
42 ChildOfReferer,
43 Choice,
44 City,
45 Collector,
46 Color,
47 Color2,
48 ComplexSortedPerson,
49 Country,
50 CoverLetter,
51 CustomArticle,
52 CyclicOne,
53 CyclicTwo,
54 DependentChild,
55 DooHickey,
56 EmptyModel,
57 EmptyModelHidden,
58 EmptyModelMixin,
59 EmptyModelVisible,
60 ExplicitlyProvidedPK,
61 ExternalSubscriber,
62 Fabric,
63 FancyDoodad,
64 FieldOverridePost,
65 FilteredManager,
66 FooAccount,
67 FoodDelivery,
68 FunkyTag,
69 Gadget,
70 Gallery,
71 GenRelReference,
72 Grommet,
73 ImplicitlyGeneratedPK,
74 Ingredient,
75 InlineReference,
76 InlineReferer,
77 Inquisition,
78 Language,
79 Link,
80 MainPrepopulated,
81 ModelWithStringPrimaryKey,
82 NotReferenced,
83 OldSubscriber,
84 OtherStory,
85 Paper,
86 Parent,
87 ParentWithDependentChildren,
88 ParentWithUUIDPK,
89 Person,
90 Persona,
91 Picture,
92 Pizza,
93 Plot,
94 PlotDetails,
95 PlotProxy,
96 PluggableSearchPerson,
97 Podcast,
98 Post,
99 PrePopulatedPost,
100 PrePopulatedPostLargeSlug,
101 PrePopulatedSubPost,
102 Promo,
103 Question,
104 ReadablePizza,
105 ReadOnlyPizza,
106 ReadOnlyRelatedField,
107 Recipe,
108 Recommendation,
109 Recommender,
110 ReferencedByGenRel,
111 ReferencedByInline,
112 ReferencedByParent,
113 RelatedPrepopulated,
114 RelatedWithUUIDPKModel,
115 Report,
116 Reservation,
117 Restaurant,
118 RowLevelChangePermissionModel,
119 Section,
120 ShortMessage,
121 Simple,
122 Sketch,
123 Song,
124 Square,
125 State,
126 Story,
127 StumpJoke,
128 Subscriber,
129 SuperVillain,
130 Telegram,
131 Thing,
132 Topping,
133 Traveler,
134 UnchangeableObject,
135 UndeletableObject,
136 UnorderedObject,
137 UserMessenger,
138 UserProxy,
139 Villain,
140 Vodcast,
141 Whatsit,
142 Widget,
143 Worker,
144 WorkHour,
145 )
146
147
148 @admin.display(ordering="date")
149 def callable_year(dt_value):
150 try:
151 return dt_value.year
152 except AttributeError:
153 return None
154
155
156 class ArticleInline(admin.TabularInline):
157 model = Article
158 fk_name = "section"
159 prepopulated_fields = {"title": ("content",)}
160 fieldsets = (
161 ("Some fields", {"classes": ("collapse",), "fields": ("title", "content")}),
162 ("Some other fields", {"classes": ("wide",), "fields": ("date", "section")}),
163 )
164
165
166 class ChapterInline(admin.TabularInline):
167 model = Chapter
168
169
170 class ChapterXtra1Admin(admin.ModelAdmin):
171 list_filter = (
172 "chap",
173 "chap__title",
174 "chap__book",
175 "chap__book__name",
176 "chap__book__promo",
177 "chap__book__promo__name",
178 "guest_author__promo__book",
179 )
180
181
182 class ArticleForm(forms.ModelForm):
183 extra_form_field = forms.BooleanField(required=False)
184
185 class Meta:
186 fields = "__all__"
187 model = Article
188
189
190 class ArticleAdminWithExtraUrl(admin.ModelAdmin):
191 def get_urls(self):
192 urlpatterns = super().get_urls()
193 urlpatterns.append(
194 path(
195 "extra.json",
196 self.admin_site.admin_view(self.extra_json),
197 name="article_extra_json",
198 )
199 )
200 return urlpatterns
201
202 def extra_json(self, request):
203 return JsonResponse({})
204
205
206 class ArticleAdmin(ArticleAdminWithExtraUrl):
207 list_display = (
208 "content",
209 "date",
210 callable_year,
211 "model_year",
212 "modeladmin_year",
213 "model_year_reversed",
214 "section",
215 lambda obj: obj.title,
216 "order_by_expression",
217 "model_property_year",
218 "model_month",
219 "order_by_f_expression",
220 "order_by_orderby_expression",
221 "model_property_is_from_past",
222 )
223 list_editable = ("section",)
224 list_filter = ("date", "section")
225 autocomplete_fields = ("section",)
226 view_on_site = False
227 form = ArticleForm
228 fieldsets = (
229 (
230 "Some fields",
231 {
232 "classes": ("collapse",),
233 "fields": ("title", "content", "extra_form_field"),
234 },
235 ),
236 (
237 "Some other fields",
238 {"classes": ("wide",), "fields": ("date", "section", "sub_section")},
239 ),
240 ("이름", {"fields": ("another_section",)}),
241 )
242
243 # These orderings aren't particularly useful but show that expressions can
244 # be used for admin_order_field.
245 @admin.display(ordering=models.F("date") + datetime.timedelta(days=3))
246 def order_by_expression(self, obj):
247 return obj.model_year
248
249 @admin.display(ordering=models.F("date"))
250 def order_by_f_expression(self, obj):
251 return obj.model_year
252
253 @admin.display(ordering=models.F("date").asc(nulls_last=True))
254 def order_by_orderby_expression(self, obj):
255 return obj.model_year
256
257 def changelist_view(self, request):
258 return super().changelist_view(request, extra_context={"extra_var": "Hello!"})
259
260 @admin.display(ordering="date", description=None)
261 def modeladmin_year(self, obj):
262 return obj.date.year
263
264 def delete_model(self, request, obj):
265 EmailMessage(
266 "Greetings from a deleted object",
267 "I hereby inform you that some user deleted me",
268 "[email protected]",
269 ["[email protected]"],
270 ).send()
271 return super().delete_model(request, obj)
272
273 def save_model(self, request, obj, form, change=True):
274 EmailMessage(
275 "Greetings from a created object",
276 "I hereby inform you that some user created me",
277 "[email protected]",
278 ["[email protected]"],
279 ).send()
280 return super().save_model(request, obj, form, change)
281
282
283 class ArticleAdmin2(admin.ModelAdmin):
284 def has_module_permission(self, request):
285 return False
286
287
288 class RowLevelChangePermissionModelAdmin(admin.ModelAdmin):
289 def has_change_permission(self, request, obj=None):
290 """Only allow changing objects with even id number"""
291 return request.user.is_staff and (obj is not None) and (obj.id % 2 == 0)
292
293 def has_view_permission(self, request, obj=None):
294 """Only allow viewing objects if id is a multiple of 3."""
295 return request.user.is_staff and obj is not None and obj.id % 3 == 0
296
297
298 class CustomArticleAdmin(admin.ModelAdmin):
299 """
300 Tests various hooks for using custom templates and contexts.
301 """
302
303 change_list_template = "custom_admin/change_list.html"
304 change_form_template = "custom_admin/change_form.html"
305 add_form_template = "custom_admin/add_form.html"
306 object_history_template = "custom_admin/object_history.html"
307 delete_confirmation_template = "custom_admin/delete_confirmation.html"
308 delete_selected_confirmation_template = (
309 "custom_admin/delete_selected_confirmation.html"
310 )
311 popup_response_template = "custom_admin/popup_response.html"
312
313 def changelist_view(self, request):
314 return super().changelist_view(request, extra_context={"extra_var": "Hello!"})
315
316
317 class ThingAdmin(admin.ModelAdmin):
318 list_filter = ("color", "color__warm", "color__value", "pub_date")
319
320
321 class InquisitionAdmin(admin.ModelAdmin):
322 list_display = ("leader", "country", "expected", "sketch")
323
324 @admin.display
325 def sketch(self, obj):
326 # A method with the same name as a reverse accessor.
327 return "list-display-sketch"
328
329
330 class SketchAdmin(admin.ModelAdmin):
331 raw_id_fields = ("inquisition", "defendant0", "defendant1")
332
333
334 class FabricAdmin(admin.ModelAdmin):
335 list_display = ("surface",)
336 list_filter = ("surface",)
337
338
339 class BasePersonModelFormSet(BaseModelFormSet):
340 def clean(self):
341 for person_dict in self.cleaned_data:
342 person = person_dict.get("id")
343 alive = person_dict.get("alive")
344 if person and alive and person.name == "Grace Hopper":
345 raise ValidationError("Grace is not a Zombie")
346
347
348 class PersonAdmin(admin.ModelAdmin):
349 list_display = ("name", "gender", "alive")
350 list_editable = ("gender", "alive")
351 list_filter = ("gender",)
352 search_fields = ("^name",)
353 save_as = True
354
355 def get_changelist_formset(self, request, **kwargs):
356 return super().get_changelist_formset(
357 request, formset=BasePersonModelFormSet, **kwargs
358 )
359
360 def get_queryset(self, request):
361 # Order by a field that isn't in list display, to be able to test
362 # whether ordering is preserved.
363 return super().get_queryset(request).order_by("age")
364
365
366 class ParentWithUUIDPKNoAddAdmin(admin.ModelAdmin):
367 list_display = ("id", "title")
368 list_editable = ("title",)
369
370 def has_add_permission(self, request):
371 return False
372
373
374 class FooAccountAdmin(admin.StackedInline):
375 model = FooAccount
376 extra = 1
377
378
379 class BarAccountAdmin(admin.StackedInline):
380 model = BarAccount
381 extra = 1
382
383
384 class PersonaAdmin(admin.ModelAdmin):
385 inlines = (FooAccountAdmin, BarAccountAdmin)
386
387
388 class SubscriberAdmin(admin.ModelAdmin):
389 actions = ["mail_admin"]
390 action_form = MediaActionForm
391
392 def delete_queryset(self, request, queryset):
393 SubscriberAdmin.overridden = True
394 super().delete_queryset(request, queryset)
395
396 @admin.action
397 def mail_admin(self, request, selected):
398 EmailMessage(
399 "Greetings from a ModelAdmin action",
400 "This is the test email from an admin action",
401 "[email protected]",
402 ["[email protected]"],
403 ).send()
404
405
406 @admin.action(description="External mail (Another awesome action)")
407 def external_mail(modeladmin, request, selected):
408 EmailMessage(
409 "Greetings from a function action",
410 "This is the test email from a function action",
411 "[email protected]",
412 ["[email protected]"],
413 ).send()
414
415
416 @admin.action(description="Redirect to (Awesome action)")
417 def redirect_to(modeladmin, request, selected):
418 from django.http import HttpResponseRedirect
419
420 return HttpResponseRedirect("/some-where-else/")
421
422
423 @admin.action(description="Download subscription")
424 def download(modeladmin, request, selected):
425 buf = StringIO("This is the content of the file")
426 return StreamingHttpResponse(FileWrapper(buf))
427
428
429 @admin.action(description="No permission to run")
430 def no_perm(modeladmin, request, selected):
431 return HttpResponse(content="No permission to perform this action", status=403)
432
433
434 class ExternalSubscriberAdmin(admin.ModelAdmin):
435 actions = [redirect_to, external_mail, download, no_perm]
436
437
438 class PodcastAdmin(admin.ModelAdmin):
439 list_display = ("name", "release_date")
440 list_editable = ("release_date",)
441 date_hierarchy = "release_date"
442 ordering = ("name",)
443
444
445 class VodcastAdmin(admin.ModelAdmin):
446 list_display = ("name", "released")
447 list_editable = ("released",)
448
449 ordering = ("name",)
450
451
452 class ChildInline(admin.StackedInline):
453 model = Child
454
455
456 class ParentAdmin(admin.ModelAdmin):
457 model = Parent
458 inlines = [ChildInline]
459 save_as = True
460 list_display = (
461 "id",
462 "name",
463 )
464 list_display_links = ("id",)
465 list_editable = ("name",)
466
467 def save_related(self, request, form, formsets, change):
468 super().save_related(request, form, formsets, change)
469 first_name, last_name = form.instance.name.split()
470 for child in form.instance.child_set.all():
471 if len(child.name.split()) < 2:
472 child.name = child.name + " " + last_name
473 child.save()
474
475
476 class EmptyModelAdmin(admin.ModelAdmin):
477 def get_queryset(self, request):
478 return super().get_queryset(request).filter(pk__gt=1)
479
480
481 class OldSubscriberAdmin(admin.ModelAdmin):
482 actions = None
483
484
485 class PictureInline(admin.TabularInline):
486 model = Picture
487 extra = 1
488
489
490 class GalleryAdmin(admin.ModelAdmin):
491 inlines = [PictureInline]
492
493
494 class PictureAdmin(admin.ModelAdmin):
495 pass
496
497
498 class LanguageAdmin(admin.ModelAdmin):
499 list_display = ["iso", "shortlist", "english_name", "name"]
500 list_editable = ["shortlist"]
501
502
503 class RecommendationAdmin(admin.ModelAdmin):
504 show_full_result_count = False
505 search_fields = (
506 "=titletranslation__text",
507 "=the_recommender__titletranslation__text",
508 )
509
510
511 class WidgetInline(admin.StackedInline):
512 model = Widget
513
514
515 class DooHickeyInline(admin.StackedInline):
516 model = DooHickey
517
518
519 class GrommetInline(admin.StackedInline):
520 model = Grommet
521
522
523 class WhatsitInline(admin.StackedInline):
524 model = Whatsit
525
526
527 class FancyDoodadInline(admin.StackedInline):
528 model = FancyDoodad
529
530
531 class CategoryAdmin(admin.ModelAdmin):
532 list_display = ("id", "collector", "order")
533 list_editable = ("order",)
534
535
536 class CategoryInline(admin.StackedInline):
537 model = Category
538
539
540 class CollectorAdmin(admin.ModelAdmin):
541 inlines = [
542 WidgetInline,
543 DooHickeyInline,
544 GrommetInline,
545 WhatsitInline,
546 FancyDoodadInline,
547 CategoryInline,
548 ]
549
550
551 class LinkInline(admin.TabularInline):
552 model = Link
553 extra = 1
554
555 readonly_fields = ("posted", "multiline", "readonly_link_content")
556
557 @admin.display
558 def multiline(self, instance):
559 return "InlineMultiline\ntest\nstring"
560
561
562 class SubPostInline(admin.TabularInline):
563 model = PrePopulatedSubPost
564
565 prepopulated_fields = {"subslug": ("subtitle",)}
566
567 def get_readonly_fields(self, request, obj=None):
568 if obj and obj.published:
569 return ("subslug",)
570 return self.readonly_fields
571
572 def get_prepopulated_fields(self, request, obj=None):
573 if obj and obj.published:
574 return {}
575 return self.prepopulated_fields
576
577
578 class PrePopulatedPostAdmin(admin.ModelAdmin):
579 list_display = ["title", "slug"]
580 prepopulated_fields = {"slug": ("title",)}
581
582 inlines = [SubPostInline]
583
584 def get_readonly_fields(self, request, obj=None):
585 if obj and obj.published:
586 return ("slug",)
587 return self.readonly_fields
588
589 def get_prepopulated_fields(self, request, obj=None):
590 if obj and obj.published:
591 return {}
592 return self.prepopulated_fields
593
594
595 class PrePopulatedPostReadOnlyAdmin(admin.ModelAdmin):
596 prepopulated_fields = {"slug": ("title",)}
597
598 def has_change_permission(self, *args, **kwargs):
599 return False
600
601
602 class PostAdmin(admin.ModelAdmin):
603 list_display = ["title", "public"]
604 readonly_fields = (
605 "posted",
606 "awesomeness_level",
607 "coolness",
608 "value",
609 "multiline",
610 "multiline_html",
611 lambda obj: "foo",
612 "readonly_content",
613 )
614
615 inlines = [LinkInline]
616
617 @admin.display
618 def coolness(self, instance):
619 if instance.pk:
620 return "%d amount of cool." % instance.pk
621 else:
622 return "Unknown coolness."
623
624 @admin.display(description="Value in $US")
625 def value(self, instance):
626 return 1000
627
628 @admin.display
629 def multiline(self, instance):
630 return "Multiline\ntest\nstring"
631
632 @admin.display
633 def multiline_html(self, instance):
634 return mark_safe("Multiline<br>\nhtml<br>\ncontent")
635
636
637 class FieldOverridePostForm(forms.ModelForm):
638 model = FieldOverridePost
639
640 class Meta:
641 help_texts = {
642 "posted": "Overridden help text for the date",
643 }
644 labels = {
645 "public": "Overridden public label",
646 }
647
648
649 class FieldOverridePostAdmin(PostAdmin):
650 form = FieldOverridePostForm
651
652
653 class CustomChangeList(ChangeList):
654 def get_queryset(self, request):
655 return self.root_queryset.order_by("pk").filter(pk=9999) # Doesn't exist
656
657
658 class GadgetAdmin(admin.ModelAdmin):
659 def get_changelist(self, request, **kwargs):
660 return CustomChangeList
661
662
663 class ToppingAdmin(admin.ModelAdmin):
664 readonly_fields = ("pizzas",)
665
666
667 class PizzaAdmin(admin.ModelAdmin):
668 readonly_fields = ("toppings",)
669
670
671 class ReadOnlyRelatedFieldAdmin(admin.ModelAdmin):
672 readonly_fields = ("chapter", "language", "user")
673
674
675 class StudentAdmin(admin.ModelAdmin):
676 search_fields = ("name",)
677
678
679 class ReadOnlyPizzaAdmin(admin.ModelAdmin):
680 readonly_fields = ("name", "toppings")
681
682 def has_add_permission(self, request):
683 return False
684
685 def has_change_permission(self, request, obj=None):
686 return True
687
688 def has_delete_permission(self, request, obj=None):
689 return True
690
691
692 class WorkHourAdmin(admin.ModelAdmin):
693 list_display = ("datum", "employee")
694 list_filter = ("employee",)
695 show_facets = admin.ShowFacets.ALWAYS
696
697
698 class FoodDeliveryAdmin(admin.ModelAdmin):
699 list_display = ("reference", "driver", "restaurant")
700 list_editable = ("driver", "restaurant")
701 show_facets = admin.ShowFacets.NEVER
702
703
704 class CoverLetterAdmin(admin.ModelAdmin):
705 """
706 A ModelAdmin with a custom get_queryset() method that uses defer(), to test
707 verbose_name display in messages shown after adding/editing CoverLetter
708 instances. Note that the CoverLetter model defines a __str__ method.
709 For testing fix for ticket #14529.
710 """
711
712 def get_queryset(self, request):
713 return super().get_queryset(request).defer("date_written")
714
715
716 class PaperAdmin(admin.ModelAdmin):
717 """
718 A ModelAdmin with a custom get_queryset() method that uses only(), to test
719 verbose_name display in messages shown after adding/editing Paper
720 instances.
721 For testing fix for ticket #14529.
722 """
723
724 def get_queryset(self, request):
725 return super().get_queryset(request).only("title")
726
727
728 class ShortMessageAdmin(admin.ModelAdmin):
729 """
730 A ModelAdmin with a custom get_queryset() method that uses defer(), to test
731 verbose_name display in messages shown after adding/editing ShortMessage
732 instances.
733 For testing fix for ticket #14529.
734 """
735
736 def get_queryset(self, request):
737 return super().get_queryset(request).defer("timestamp")
738
739
740 class TelegramAdmin(admin.ModelAdmin):
741 """
742 A ModelAdmin with a custom get_queryset() method that uses only(), to test
743 verbose_name display in messages shown after adding/editing Telegram
744 instances. Note that the Telegram model defines a __str__ method.
745 For testing fix for ticket #14529.
746 """
747
748 def get_queryset(self, request):
749 return super().get_queryset(request).only("title")
750
751
752 class StoryForm(forms.ModelForm):
753 class Meta:
754 widgets = {"title": forms.HiddenInput}
755
756
757 class StoryAdmin(admin.ModelAdmin):
758 list_display = ("id", "title", "content")
759 list_display_links = ("title",) # 'id' not in list_display_links
760 list_editable = ("content",)
761 form = StoryForm
762 ordering = ["-id"]
763
764
765 class OtherStoryAdmin(admin.ModelAdmin):
766 list_display = ("id", "title", "content")
767 list_display_links = ("title", "id") # 'id' in list_display_links
768 list_editable = ("content",)
769 ordering = ["-id"]
770
771
772 class ComplexSortedPersonAdmin(admin.ModelAdmin):
773 list_display = ("name", "age", "is_employee", "colored_name")
774 ordering = ("name",)
775
776 @admin.display(ordering="name")
777 def colored_name(self, obj):
778 return format_html('<span style="color: #ff00ff;">{}</span>', obj.name)
779
780
781 class PluggableSearchPersonAdmin(admin.ModelAdmin):
782 list_display = ("name", "age")
783 search_fields = ("name",)
784
785 def get_search_results(self, request, queryset, search_term):
786 queryset, may_have_duplicates = super().get_search_results(
787 request,
788 queryset,
789 search_term,
790 )
791 try:
792 search_term_as_int = int(search_term)
793 except ValueError:
794 pass
795 else:
796 queryset |= self.model.objects.filter(age=search_term_as_int)
797 return queryset, may_have_duplicates
798
799
800 class AlbumAdmin(admin.ModelAdmin):
801 list_filter = ["title"]
802
803
804 class QuestionAdmin(admin.ModelAdmin):
805 ordering = ["-posted"]
806 search_fields = ["question"]
807 autocomplete_fields = ["related_questions"]
808
809
810 class AnswerAdmin(admin.ModelAdmin):
811 autocomplete_fields = ["question"]
812
813
814 class PrePopulatedPostLargeSlugAdmin(admin.ModelAdmin):
815 prepopulated_fields = {"slug": ("title",)}
816
817
818 class AdminOrderedFieldAdmin(admin.ModelAdmin):
819 ordering = ("order",)
820 list_display = ("stuff", "order")
821
822
823 class AdminOrderedModelMethodAdmin(admin.ModelAdmin):
824 ordering = ("order",)
825 list_display = ("stuff", "some_order")
826
827
828 class AdminOrderedAdminMethodAdmin(admin.ModelAdmin):
829 @admin.display(ordering="order")
830 def some_admin_order(self, obj):
831 return obj.order
832
833 ordering = ("order",)
834 list_display = ("stuff", "some_admin_order")
835
836
837 @admin.display(ordering="order")
838 def admin_ordered_callable(obj):
839 return obj.order
840
841
842 class AdminOrderedCallableAdmin(admin.ModelAdmin):
843 ordering = ("order",)
844 list_display = ("stuff", admin_ordered_callable)
845
846
847 class ReportAdmin(admin.ModelAdmin):
848 def extra(self, request):
849 return HttpResponse()
850
851 def get_urls(self):
852 # Corner case: Don't call parent implementation
853 return [path("extra/", self.extra, name="cable_extra")]
854
855
856 class CustomTemplateBooleanFieldListFilter(BooleanFieldListFilter):
857 template = "custom_filter_template.html"
858
859
860 class CustomTemplateFilterColorAdmin(admin.ModelAdmin):
861 list_filter = (("warm", CustomTemplateBooleanFieldListFilter),)
862
863
864 # For Selenium Prepopulated tests -------------------------------------
865 class RelatedPrepopulatedInline1(admin.StackedInline):
866 fieldsets = (
867 (
868 None,
869 {
870 "fields": (
871 ("fk", "m2m"),
872 ("pubdate", "status"),
873 (
874 "name",
875 "slug1",
876 "slug2",
877 ),
878 ),
879 },
880 ),
881 )
882 formfield_overrides = {models.CharField: {"strip": False}}
883 model = RelatedPrepopulated
884 extra = 1
885 autocomplete_fields = ["fk", "m2m"]
886 prepopulated_fields = {
887 "slug1": ["name", "pubdate"],
888 "slug2": ["status", "name"],
889 }
890
891
892 class RelatedPrepopulatedInline2(admin.TabularInline):
893 model = RelatedPrepopulated
894 extra = 1
895 autocomplete_fields = ["fk", "m2m"]
896 prepopulated_fields = {
897 "slug1": ["name", "pubdate"],
898 "slug2": ["status", "name"],
899 }
900
901
902 class RelatedPrepopulatedInline3(admin.TabularInline):
903 model = RelatedPrepopulated
904 extra = 0
905 autocomplete_fields = ["fk", "m2m"]
906
907
908 class RelatedPrepopulatedStackedInlineNoFieldsets(admin.StackedInline):
909 model = RelatedPrepopulated
910 extra = 1
911 prepopulated_fields = {
912 "slug1": ["name", "pubdate"],
913 "slug2": ["status"],
914 }
915
916
917 class MainPrepopulatedAdmin(admin.ModelAdmin):
918 inlines = [
919 RelatedPrepopulatedInline1,
920 RelatedPrepopulatedInline2,
921 RelatedPrepopulatedInline3,
922 RelatedPrepopulatedStackedInlineNoFieldsets,
923 ]
924 fieldsets = (
925 (
926 None,
927 {"fields": (("pubdate", "status"), ("name", "slug1", "slug2", "slug3"))},
928 ),
929 )
930 formfield_overrides = {models.CharField: {"strip": False}}
931 prepopulated_fields = {
932 "slug1": ["name", "pubdate"],
933 "slug2": ["status", "name"],
934 "slug3": ["name"],
935 }
936
937
938 class UnorderedObjectAdmin(admin.ModelAdmin):
939 list_display = ["id", "name"]
940 list_display_links = ["id"]
941 list_editable = ["name"]
942 list_per_page = 2
943
944
945 class UndeletableObjectAdmin(admin.ModelAdmin):
946 def change_view(self, *args, **kwargs):
947 kwargs["extra_context"] = {"show_delete": False}
948 return super().change_view(*args, **kwargs)
949
950
951 class UnchangeableObjectAdmin(admin.ModelAdmin):
952 def get_urls(self):
953 # Disable change_view, but leave other urls untouched
954 urlpatterns = super().get_urls()
955 return [p for p in urlpatterns if p.name and not p.name.endswith("_change")]
956
957
958 @admin.display
959 def callable_on_unknown(obj):
960 return obj.unknown
961
962
963 class AttributeErrorRaisingAdmin(admin.ModelAdmin):
964 list_display = [callable_on_unknown]
965
966
967 class CustomManagerAdmin(admin.ModelAdmin):
968 def get_queryset(self, request):
969 return FilteredManager.objects
970
971
972 class MessageTestingAdmin(admin.ModelAdmin):
973 actions = [
974 "message_debug",
975 "message_info",
976 "message_success",
977 "message_warning",
978 "message_error",
979 "message_extra_tags",
980 ]
981
982 @admin.action
983 def message_debug(self, request, selected):
984 self.message_user(request, "Test debug", level="debug")
985
986 @admin.action
987 def message_info(self, request, selected):
988 self.message_user(request, "Test info", level="info")
989
990 @admin.action
991 def message_success(self, request, selected):
992 self.message_user(request, "Test success", level="success")
993
994 @admin.action
995 def message_warning(self, request, selected):
996 self.message_user(request, "Test warning", level="warning")
997
998 @admin.action
999 def message_error(self, request, selected):
1000 self.message_user(request, "Test error", level="error")
1001
1002 @admin.action
1003 def message_extra_tags(self, request, selected):
1004 self.message_user(request, "Test tags", extra_tags="extra_tag")
1005
1006
1007 class ChoiceList(admin.ModelAdmin):
1008 list_display = ["choice"]
1009 readonly_fields = ["choice"]
1010 fields = ["choice"]
1011
1012
1013 class DependentChildAdminForm(forms.ModelForm):
1014 """
1015 Issue #20522
1016 Form to test child dependency on parent object's validation
1017 """
1018
1019 def clean(self):
1020 parent = self.cleaned_data.get("parent")
1021 if parent.family_name and parent.family_name != self.cleaned_data.get(
1022 "family_name"
1023 ):
1024 raise ValidationError(
1025 "Children must share a family name with their parents "
1026 + "in this contrived test case"
1027 )
1028 return super().clean()
1029
1030
1031 class DependentChildInline(admin.TabularInline):
1032 model = DependentChild
1033 form = DependentChildAdminForm
1034
1035
1036 class ParentWithDependentChildrenAdmin(admin.ModelAdmin):
1037 inlines = [DependentChildInline]
1038
1039
1040 # Tests for ticket 11277 ----------------------------------
1041
1042
1043 class FormWithoutHiddenField(forms.ModelForm):
1044 first = forms.CharField()
1045 second = forms.CharField()
1046
1047
1048 class FormWithoutVisibleField(forms.ModelForm):
1049 first = forms.CharField(widget=forms.HiddenInput)
1050 second = forms.CharField(widget=forms.HiddenInput)
1051
1052
1053 class FormWithVisibleAndHiddenField(forms.ModelForm):
1054 first = forms.CharField(widget=forms.HiddenInput)
1055 second = forms.CharField()
1056
1057
1058 class EmptyModelVisibleAdmin(admin.ModelAdmin):
1059 form = FormWithoutHiddenField
1060 fieldsets = (
1061 (
1062 None,
1063 {
1064 "fields": (("first", "second"),),
1065 },
1066 ),
1067 )
1068
1069
1070 class EmptyModelHiddenAdmin(admin.ModelAdmin):
1071 form = FormWithoutVisibleField
1072 fieldsets = EmptyModelVisibleAdmin.fieldsets
1073
1074
1075 class EmptyModelMixinAdmin(admin.ModelAdmin):
1076 form = FormWithVisibleAndHiddenField
1077 fieldsets = EmptyModelVisibleAdmin.fieldsets
1078
1079
1080 class CityInlineAdmin(admin.TabularInline):
1081 model = City
1082 view_on_site = False
1083
1084
1085 class StateAdminForm(forms.ModelForm):
1086 nolabel_form_field = forms.BooleanField(required=False)
1087
1088 class Meta:
1089 model = State
1090 fields = "__all__"
1091 labels = {"name": "State name (from form’s Meta.labels)"}
1092
1093 @property
1094 def changed_data(self):
1095 data = super().changed_data
1096 if data:
1097 # Add arbitrary name to changed_data to test
1098 # change message construction.
1099 return data + ["not_a_form_field"]
1100 return data
1101
1102
1103 class StateAdmin(admin.ModelAdmin):
1104 inlines = [CityInlineAdmin]
1105 form = StateAdminForm
1106
1107
1108 class RestaurantInlineAdmin(admin.TabularInline):
1109 model = Restaurant
1110 view_on_site = True
1111
1112
1113 class CityAdmin(admin.ModelAdmin):
1114 inlines = [RestaurantInlineAdmin]
1115 view_on_site = True
1116
1117 def get_formset_kwargs(self, request, obj, inline, prefix):
1118 return {
1119 **super().get_formset_kwargs(request, obj, inline, prefix),
1120 "form_kwargs": {"initial": {"name": "overridden_name"}},
1121 }
1122
1123
1124 class WorkerAdmin(admin.ModelAdmin):
1125 def view_on_site(self, obj):
1126 return "/worker/%s/%s/" % (obj.surname, obj.name)
1127
1128
1129 class WorkerInlineAdmin(admin.TabularInline):
1130 model = Worker
1131
1132 def view_on_site(self, obj):
1133 return "/worker_inline/%s/%s/" % (obj.surname, obj.name)
1134
1135
1136 class RestaurantAdmin(admin.ModelAdmin):
1137 inlines = [WorkerInlineAdmin]
1138 view_on_site = False
1139
1140 def get_changeform_initial_data(self, request):
1141 return {"name": "overridden_value"}
1142
1143
1144 class FunkyTagAdmin(admin.ModelAdmin):
1145 list_display = ("name", "content_object")
1146
1147
1148 class InlineReferenceInline(admin.TabularInline):
1149 model = InlineReference
1150
1151
1152 class InlineRefererAdmin(admin.ModelAdmin):
1153 inlines = [InlineReferenceInline]
1154
1155
1156 class PlotReadonlyAdmin(admin.ModelAdmin):
1157 readonly_fields = ("plotdetails",)
1158
1159
1160 class GetFormsetsArgumentCheckingAdmin(admin.ModelAdmin):
1161 fields = ["name"]
1162
1163 def add_view(self, request, *args, **kwargs):
1164 request.is_add_view = True
1165 return super().add_view(request, *args, **kwargs)
1166
1167 def change_view(self, request, *args, **kwargs):
1168 request.is_add_view = False
1169 return super().change_view(request, *args, **kwargs)
1170
1171 def get_formsets_with_inlines(self, request, obj=None):
1172 if request.is_add_view and obj is not None:
1173 raise Exception(
1174 "'obj' passed to get_formsets_with_inlines wasn't None during add_view"
1175 )
1176 if not request.is_add_view and obj is None:
1177 raise Exception(
1178 "'obj' passed to get_formsets_with_inlines was None during change_view"
1179 )
1180 return super().get_formsets_with_inlines(request, obj)
1181
1182
1183 class CountryAdmin(admin.ModelAdmin):
1184 search_fields = ["name"]
1185
1186
1187 class TravelerAdmin(admin.ModelAdmin):
1188 autocomplete_fields = ["living_country"]
1189
1190
1191 class SquareAdmin(admin.ModelAdmin):
1192 readonly_fields = ("area",)
1193
1194
1195 class CamelCaseAdmin(admin.ModelAdmin):
1196 filter_horizontal = ["m2m"]
1197
1198
1199 site = admin.AdminSite(name="admin")
1200 site.site_url = "/my-site-url/"
1201 site.register(Article, ArticleAdmin)
1202 site.register(CustomArticle, CustomArticleAdmin)
1203 site.register(
1204 Section,
1205 save_as=True,
1206 inlines=[ArticleInline],
1207 readonly_fields=["name_property"],
1208 search_fields=["name"],
1209 )
1210 site.register(ModelWithStringPrimaryKey)
1211 site.register(Color)
1212 site.register(Thing, ThingAdmin)
1213 site.register(Actor)
1214 site.register(Inquisition, InquisitionAdmin)
1215 site.register(Sketch, SketchAdmin)
1216 site.register(Person, PersonAdmin)
1217 site.register(Persona, PersonaAdmin)
1218 site.register(Subscriber, SubscriberAdmin)
1219 site.register(ExternalSubscriber, ExternalSubscriberAdmin)
1220 site.register(OldSubscriber, OldSubscriberAdmin)
1221 site.register(Podcast, PodcastAdmin)
1222 site.register(Vodcast, VodcastAdmin)
1223 site.register(Parent, ParentAdmin)
1224 site.register(EmptyModel, EmptyModelAdmin)
1225 site.register(Fabric, FabricAdmin)
1226 site.register(Gallery, GalleryAdmin)
1227 site.register(Picture, PictureAdmin)
1228 site.register(Language, LanguageAdmin)
1229 site.register(Recommendation, RecommendationAdmin)
1230 site.register(Recommender)
1231 site.register(Collector, CollectorAdmin)
1232 site.register(Category, CategoryAdmin)
1233 site.register(Post, PostAdmin)
1234 site.register(FieldOverridePost, FieldOverridePostAdmin)
1235 site.register(Gadget, GadgetAdmin)
1236 site.register(Villain)
1237 site.register(SuperVillain)
1238 site.register(Plot)
1239 site.register(PlotDetails)
1240 site.register(PlotProxy, PlotReadonlyAdmin)
1241 site.register(Bookmark)
1242 site.register(CyclicOne)
1243 site.register(CyclicTwo)
1244 site.register(WorkHour, WorkHourAdmin)
1245 site.register(Reservation)
1246 site.register(FoodDelivery, FoodDeliveryAdmin)
1247 site.register(RowLevelChangePermissionModel, RowLevelChangePermissionModelAdmin)
1248 site.register(Paper, PaperAdmin)
1249 site.register(CoverLetter, CoverLetterAdmin)
1250 site.register(ShortMessage, ShortMessageAdmin)
1251 site.register(Telegram, TelegramAdmin)
1252 site.register(Story, StoryAdmin)
1253 site.register(OtherStory, OtherStoryAdmin)
1254 site.register(Report, ReportAdmin)
1255 site.register(MainPrepopulated, MainPrepopulatedAdmin)
1256 site.register(UnorderedObject, UnorderedObjectAdmin)
1257 site.register(UndeletableObject, UndeletableObjectAdmin)
1258 site.register(UnchangeableObject, UnchangeableObjectAdmin)
1259 site.register(State, StateAdmin)
1260 site.register(City, CityAdmin)
1261 site.register(Restaurant, RestaurantAdmin)
1262 site.register(Worker, WorkerAdmin)
1263 site.register(FunkyTag, FunkyTagAdmin)
1264 site.register(ReferencedByParent)
1265 site.register(ChildOfReferer)
1266 site.register(ReferencedByInline)
1267 site.register(InlineReferer, InlineRefererAdmin)
1268 site.register(ReferencedByGenRel)
1269 site.register(GenRelReference)
1270 site.register(ParentWithUUIDPK)
1271 site.register(RelatedPrepopulated, search_fields=["name"])
1272 site.register(RelatedWithUUIDPKModel)
1273 site.register(ReadOnlyRelatedField, ReadOnlyRelatedFieldAdmin)
1274
1275 # We intentionally register Promo and ChapterXtra1 but not Chapter nor ChapterXtra2.
1276 # That way we cover all four cases:
1277 # related ForeignKey object registered in admin
1278 # related ForeignKey object not registered in admin
1279 # related OneToOne object registered in admin
1280 # related OneToOne object not registered in admin
1281 # when deleting Book so as exercise all four paths through
1282 # contrib.admin.utils's get_deleted_objects function.
1283 site.register(Book, inlines=[ChapterInline])
1284 site.register(Promo)
1285 site.register(ChapterXtra1, ChapterXtra1Admin)
1286 site.register(Pizza, PizzaAdmin)
1287 site.register(ReadOnlyPizza, ReadOnlyPizzaAdmin)
1288 site.register(ReadablePizza)
1289 site.register(Topping, ToppingAdmin)
1290 site.register(Album, AlbumAdmin)
1291 site.register(Song)
1292 site.register(Question, QuestionAdmin)
1293 site.register(Answer, AnswerAdmin, date_hierarchy="question__posted")
1294 site.register(Answer2, date_hierarchy="question__expires")
1295 site.register(PrePopulatedPost, PrePopulatedPostAdmin)
1296 site.register(ComplexSortedPerson, ComplexSortedPersonAdmin)
1297 site.register(FilteredManager, CustomManagerAdmin)
1298 site.register(PluggableSearchPerson, PluggableSearchPersonAdmin)
1299 site.register(PrePopulatedPostLargeSlug, PrePopulatedPostLargeSlugAdmin)
1300 site.register(AdminOrderedField, AdminOrderedFieldAdmin)
1301 site.register(AdminOrderedModelMethod, AdminOrderedModelMethodAdmin)
1302 site.register(AdminOrderedAdminMethod, AdminOrderedAdminMethodAdmin)
1303 site.register(AdminOrderedCallable, AdminOrderedCallableAdmin)
1304 site.register(Color2, CustomTemplateFilterColorAdmin)
1305 site.register(Simple, AttributeErrorRaisingAdmin)
1306 site.register(UserMessenger, MessageTestingAdmin)
1307 site.register(Choice, ChoiceList)
1308 site.register(ParentWithDependentChildren, ParentWithDependentChildrenAdmin)
1309 site.register(EmptyModelHidden, EmptyModelHiddenAdmin)
1310 site.register(EmptyModelVisible, EmptyModelVisibleAdmin)
1311 site.register(EmptyModelMixin, EmptyModelMixinAdmin)
1312 site.register(StumpJoke)
1313 site.register(Recipe)
1314 site.register(Ingredient)
1315 site.register(NotReferenced)
1316 site.register(ExplicitlyProvidedPK, GetFormsetsArgumentCheckingAdmin)
1317 site.register(ImplicitlyGeneratedPK, GetFormsetsArgumentCheckingAdmin)
1318 site.register(UserProxy)
1319 site.register(Box)
1320 site.register(Country, CountryAdmin)
1321 site.register(Traveler, TravelerAdmin)
1322 site.register(Square, SquareAdmin)
1323 site.register(CamelCaseModel)
1324 site.register(CamelCaseRelatedModel, CamelCaseAdmin)
1325
1326 # Register core models we need in our tests
1327 site.register(User, UserAdmin)
1328 site.register(Group, GroupAdmin)
1329
1330 # Used to test URL namespaces
1331 site2 = admin.AdminSite(name="namespaced_admin")
1332 site2.register(User, UserAdmin)
1333 site2.register(Group, GroupAdmin)
1334 site2.register(ParentWithUUIDPK)
1335 site2.register(
1336 RelatedWithUUIDPKModel,
1337 list_display=["pk", "parent"],
1338 list_editable=["parent"],
1339 raw_id_fields=["parent"],
1340 )
1341 site2.register(Person, save_as_continue=False)
1342 site2.register(ReadOnlyRelatedField, ReadOnlyRelatedFieldAdmin)
1343 site2.register(Language)
1344
1345 site7 = admin.AdminSite(name="admin7")
1346 site7.register(Article, ArticleAdmin2)
1347 site7.register(Section)
1348 site7.register(ParentWithUUIDPK, ParentWithUUIDPKNoAddAdmin)
1349 site7.register(PrePopulatedPost, PrePopulatedPostReadOnlyAdmin)
1350 site7.register(
1351 Pizza,
1352 filter_horizontal=["toppings"],
1353 fieldsets=(
1354 (
1355 "Collapsible",
1356 {
1357 "classes": ["collapse"],
1358 "fields": ["toppings"],
1359 },
1360 ),
1361 ),
1362 )
1363 site7.register(
1364 Question,
1365 filter_horizontal=["related_questions"],
1366 fieldsets=(
1367 (
1368 "Not collapsible",
1369 {
1370 "fields": ["related_questions"],
1371 },
1372 ),
1373 ),
1374 )
1375
1376
1377 # Used to test ModelAdmin.sortable_by and get_sortable_by().
1378 class ArticleAdmin6(admin.ModelAdmin):
1379 list_display = (
1380 "content",
1381 "date",
1382 callable_year,
1383 "model_year",
1384 "modeladmin_year",
1385 "model_year_reversed",
1386 "section",
1387 )
1388 sortable_by = ("date", callable_year)
1389
1390 @admin.display(ordering="date")
1391 def modeladmin_year(self, obj):
1392 return obj.date.year
1393
1394
1395 class ActorAdmin6(admin.ModelAdmin):
1396 list_display = ("name", "age")
1397 sortable_by = ("name",)
1398
1399 def get_sortable_by(self, request):
1400 return ("age",)
1401
1402
1403 class ChapterAdmin6(admin.ModelAdmin):
1404 list_display = ("title", "book")
1405 sortable_by = ()
1406
1407
1408 class ColorAdmin6(admin.ModelAdmin):
1409 list_display = ("value",)
1410
1411 def get_sortable_by(self, request):
1412 return ()
1413
1414
1415 site6 = admin.AdminSite(name="admin6")
1416 site6.register(Article, ArticleAdmin6)
1417 site6.register(Actor, ActorAdmin6)
1418 site6.register(Chapter, ChapterAdmin6)
1419 site6.register(Color, ColorAdmin6)
1420
1421
1422 class ArticleAdmin9(admin.ModelAdmin):
1423 def has_change_permission(self, request, obj=None):
1424 # Simulate that the user can't change a specific object.
1425 return obj is None
1426
1427
1428 class ActorAdmin9(admin.ModelAdmin):
1429 def get_urls(self):
1430 # Opt-out of append slash for single model.
1431 urls = super().get_urls()
1432 for pattern in urls:
1433 pattern.callback = no_append_slash(pattern.callback)
1434 return urls
1435
1436
1437 site9 = admin.AdminSite(name="admin9")
1438 site9.register(Article, ArticleAdmin9)
1439 site9.register(Actor, ActorAdmin9)
1440
1441 site10 = admin.AdminSite(name="admin10")
1442 site10.final_catch_all_view = False
1443 site10.register(Article, ArticleAdminWithExtraUrl)