Files
edx-platform/openedx/features/survey_report/admin.py
Alejandro Cardenas 045ae44184 feat: add generate report button in admin (#31429)
* feat: add generate report button in admin
2023-01-25 10:19:59 -05:00

72 lines
2.1 KiB
Python

"""
Django Admin page for SurveyReport.
"""
from django.contrib import admin
from .models import SurveyReport
class SurveyReportAdmin(admin.ModelAdmin):
"""
Admin to manage survey reports.
"""
change_list_template = "survey_report/change_list.html"
readonly_fields = (
'courses_offered', 'learners', 'registered_learners',
'enrollments', 'generated_certificates', 'extra_data',
'created_at', 'state',
)
list_display = (
'id', 'summary', 'created_at', 'state'
)
def summary(self, obj) -> str:
"""
Show a summary of the survey report.
info:
- Courses: Total number of active unique courses.
- Learners: Recently active users with login in some weeks.
- Enrollments: Total number of active enrollments in the platform.
"""
return f"Total Courses: {obj.courses_offered}," \
f"Total Learners: {obj.learners}, Total Enrollments: {obj.enrollments}"
def has_add_permission(self, request):
"""
Removes the "add" button from admin.
"""
return False
def has_delete_permission(self, request, obj=None):
"""
Removes the "delete" options from admin.
"""
return False
def changeform_view(self, request, object_id=None, form_url='', extra_context=None):
"""
Removes the "save" buttons from admin change view.
"""
extra_context = extra_context or {}
extra_context['show_save'] = False
extra_context['show_save_and_continue'] = False
extra_context['show_save_and_add_another'] = False
return super().changeform_view(request, object_id, form_url, extra_context)
def get_actions(self, request):
"""
Removes the default bulk delete option provided by Django,
it doesn't do what we need for this model.
"""
actions = super().get_actions(request)
if 'delete_selected' in actions:
del actions['delete_selected']
return actions
admin.site.register(SurveyReport, SurveyReportAdmin)