Redo: Made fields visible in admin and cleaned up some shared logic

Author: krestenlaust

stregsystem/admin.py

@@ -1,4 +1,5 @@
-from typing import Any
+from typing import Any, Literal, Sequence
+from typing_extensions import override
 from django.contrib import admin
 from django import forms
 from django.contrib.admin.views.autocomplete import AutocompleteJsonView
@@ -41,28 +42,44 @@ class BaseAdmin(admin.ModelAdmin):
     Base admin class to add common attributes.
     Such as created_at and updated_at fields.
     """
+    def _get_fields_to_display(self) -> list[str]:
+        return self._get_fields_to_display_as_readonly()
 
-    def get_readonly_fields(self, request: HttpRequest, obj: Any | None = ...) -> list[str] | tuple[Any, ...]:
-        return list(super().get_readonly_fields(request, obj)) + [
-            'created_at',
-            'updated_at',
+    def _get_fields_to_display_as_readonly(self) -> list[str]:
+        return [
+            "created_at",
+            "updated_at",
         ]
 
+    def get_readonly_fields(
+        self, request: HttpRequest, obj: Any | None = ...
+    ) -> list[str] | tuple[Any, ...]:
+        return (
+            list(super().get_readonly_fields(request, obj))
+            + list(self._get_fields_to_display_as_readonly())
+        )
+
+    def get_list_display(self, request) -> list[str]:
+        return self._get_fields_to_display() + list(super().get_list_display(request))
+
 
 class SaleAdmin(BaseAdmin):
-    list_filter = ('room', 'timestamp')
-    list_display = (
-        'get_username',
-        'get_fullname',
-        'get_product_name',
-        'get_room_name',
-        'timestamp',
-        'get_price_display',
-    )
+    list_filter = ("room", "timestamp")
+
+    def _get_fields_to_display(self):
+        return [
+            "get_username",
+            "get_fullname",
+            "get_product_name",
+            "get_room_name",
+            "timestamp",
+            "get_price_display",
+        ] + super()._get_fields_to_display()
+
     actions = [refund]
-    search_fields = ['^member__username', '=product__id', 'product__name']
-    valid_lookups = 'member'
-    autocomplete_fields = ['member', 'product']
+    search_fields = ["^member__username", "=product__id", "product__name"]
+    valid_lookups = "member"
+    autocomplete_fields = ["member", "product"]
 
     class Media:
         css = {'all': ('stregsystem/select2-stregsystem.css',)}
@@ -125,33 +142,36 @@ def toggle_active_selected_products(modeladmin, request, queryset):
 
 
 class ProductActivatedListFilter(admin.SimpleListFilter):
-    title = 'activated'
-    parameter_name = 'activated'
+    title = "activated"
+    parameter_name = "activated"
 
     def lookups(self, request, model_admin):
         return (
-            ('Yes', 'Yes'),
-            ('No', 'No'),
+            ("Yes", "Yes"),
+            ("No", "No"),
         )
 
     def queryset(self, request, queryset):
-        if self.value() == 'Yes':
+        if self.value() == "Yes":
             return make_active_productlist_query(queryset)
-        elif self.value() == 'No':
+        elif self.value() == "No":
             return make_inactive_productlist_query(queryset)
         else:
             return queryset
 
 
 class ProductAdmin(BaseAdmin):
-    search_fields = ('name', 'price', 'id')
-    list_filter = (ProductActivatedListFilter, 'deactivate_date', 'price')
-    list_display = (
-        'activated',
-        'id',
-        'name',
-        'get_price_display',
-    )
+    search_fields = ("name", "price", "id")
+    list_filter = (ProductActivatedListFilter, "deactivate_date", "price")
+
+    def _get_fields_to_display(self):
+        return [
+            "activated",
+            "id",
+            "name",
+            "get_price_display",
+        ] + super()._get_fields_to_display()
+    
     fields = (
         "name",
         "price",
@@ -163,8 +183,8 @@ class ProductAdmin(BaseAdmin):
         "caffeine_content_mg",
     )
 
-    def get_readonly_fields(self, request: HttpRequest, obj: Any | None = ...) -> list[str] | tuple[Any, ...]:
-        return list(super().get_readonly_fields(request, obj)) + ['get_bought']
+    def _get_fields_to_display_as_readonly(self) -> list[str]:
+        return ["get_bought"] + super()._get_fields_to_display_as_readonly()
 
     actions = [toggle_active_selected_products]
     filter_horizontal = ('categories', 'rooms')
@@ -191,13 +211,16 @@ def activated(self, product):
 
 class NamedProductAdmin(BaseAdmin):
     search_fields = (
-        'name',
-        'product',
-    )
-    list_display = (
-        'name',
-        'product',
+        "name",
+        "product",
     )
+
+    def _get_fields_to_display(self):
+        return [
+            "name",
+            "product",
+        ] + super()._get_fields_to_display()
+    
     fields = (
         'name',
         'product',
@@ -208,7 +231,11 @@ class NamedProductAdmin(BaseAdmin):
 
 
 class CategoryAdmin(BaseAdmin):
-    list_display = ('name', 'items_in_category')
+    def _get_fields_to_display(self):
+        return [
+            "name",
+            "items_in_category",
+        ] + super()._get_fields_to_display()
 
     def items_in_category(self, obj):
         return obj.product_set.count()
@@ -229,9 +256,18 @@ def clean_username(self):
 
 class MemberAdmin(BaseAdmin):
     form = MemberForm
-    list_filter = ('want_spam',)
-    search_fields = ('username', 'firstname', 'lastname', 'email')
-    list_display = ('username', 'firstname', 'lastname', 'balance', 'email', 'notes')
+    list_filter = ("want_spam",)
+    search_fields = ("username", "firstname", "lastname", "email")
+
+    def _get_fields_to_display(self):
+        return [
+            "username",
+            "firstname",
+            "lastname",
+            "balance",
+            "email",
+            "notes",
+        ] + super()._get_fields_to_display()
 
     # fieldsets is like fields, except that they are grouped and with descriptions
     fieldsets = (
@@ -276,10 +312,17 @@ def get_queryset(self):
 
 
 class PaymentAdmin(BaseAdmin):
-    list_display = ('get_username', 'timestamp', 'get_amount_display', 'is_mobilepayment')
-    valid_lookups = 'member'
-    search_fields = ['member__username']
-    autocomplete_fields = ['member']
+    def _get_fields_to_display(self):
+        return [
+            "get_username",
+            "timestamp",
+            "get_amount_display",
+            "is_mobilepayment",
+        ] + super()._get_fields_to_display()
+    
+    valid_lookups = "member"
+    search_fields = ["member__username"]
+    autocomplete_fields = ["member"]
 
     class Media:
         css = {'all': ('stregsystem/select2-stregsystem.css',)}
@@ -305,18 +348,20 @@ def is_mobilepayment(self, obj):
 
 
 class MobilePaymentAdmin(BaseAdmin):
-    list_display = (
-        'payment',
-        'customer_name',
-        'comment',
-        'timestamp',
-        'transaction_id',
-        'get_amount_display',
-        'status',
-    )
-    valid_lookups = 'member'
-    search_fields = ['member__username']
-    autocomplete_fields = ['member', 'payment']
+    def _get_fields_to_display(self):
+        return [
+            "payment",
+            "customer_name",
+            "comment",
+            "timestamp",
+            "transaction_id",
+            "get_amount_display",
+            "status",
+        ] + super()._get_fields_to_display()
+
+    valid_lookups = "member"
+    search_fields = ["member__username"]
+    autocomplete_fields = ["member", "payment"]
 
     class Media:
         css = {'all': ('stregsystem/select2-stregsystem.css',)}
@@ -343,10 +388,20 @@ def really_delete_selected(self, _, queryset):
 
 
 class LogEntryAdmin(BaseAdmin):
-    date_hierarchy = 'action_time'
-    list_filter = ['content_type', 'action_flag']
-    search_fields = ['object_repr', 'change_message', 'user__username']
-    list_display = ['action_time', 'user', 'content_type', 'object_id', 'action_flag', 'change_message', 'object_repr']
+    date_hierarchy = "action_time"
+    list_filter = ["content_type", "action_flag"]
+    search_fields = ["object_repr", "change_message", "user__username"]
+
+    def _get_fields_to_display(self):
+        return [
+            "action_time",
+            "user",
+            "content_type",
+            "object_id",
+            "action_flag",
+            "change_message",
+            "object_repr",
+        ] + super()._get_fields_to_display()
 
     def has_view_permission(self, request, obj=None):
         return request.user.is_superuser
@@ -362,7 +417,16 @@ def has_delete_permission(self, request, obj=None):
 
 
 class ThemeAdmin(BaseAdmin):
-    list_display = ["name", "override", "begin_month", "begin_day", "end_month", "end_day"]
+    def _get_fields_to_display(self):
+        return [
+            "name",
+            "override",
+            "begin_month",
+            "begin_day",
+            "end_month",
+            "end_day",
+        ] + super()._get_fields_to_display()
+    
     search_fields = ["name"]
 
     @admin.action(description="Do not force chosen themes")
@@ -381,11 +445,13 @@ def force_hide(modeladmin, request, queryset):
 
 
 class ProductNoteAdmin(BaseAdmin):
-    search_fields = ('active', 'text')
-    list_display = (
-        'active',
-        'text',
-    )
+    search_fields = ("active", "text")
+
+    def _get_fields_to_display(self):
+        return [
+            "active",
+            "text",
+        ] + super()._get_fields_to_display()
 
     actions = [toggle_active_selected_products]