Skip to content

Commit

Permalink
support admin chart
Browse files Browse the repository at this point in the history
  • Loading branch information
@cuongnb14
cuongnb14 committed Sep 12, 2024
1 parent 22b4104 commit 76cff18
Show file tree
Hide file tree
Showing 8 changed files with 605 additions and 1 deletion.
2 changes: 2 additions & 0 deletions admin_extended/admin/__init__.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
from .bookmark import BookmarkAdmin
from .chart import TimeSeriesChartAdmin
2 changes: 1 addition & 1 deletion admin_extended/admin.py → admin_extended/admin/bookmark.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from django.utils.decorators import method_decorator
from django.views.decorators.csrf import csrf_exempt

from . import models
from .. import models


@admin.register(models.Bookmark)
Expand Down
184 changes: 184 additions & 0 deletions admin_extended/admin/chart.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
from collections import defaultdict
from datetime import timedelta

from django import forms
from django.contrib import admin
from django.db.models.functions import TruncDay, TruncWeek, TruncMonth, TruncHour
from django.http import JsonResponse
from django.shortcuts import render
from django.urls import path
from django.utils import timezone
from django.utils.html import format_html

from ..models import TimeSeriesChart

SCALE_MAPPING = {
'HOUR': TruncHour,
'DAY': TruncDay,
'WEEK': TruncWeek,
'MONTH': TruncMonth,
}


class ChartStandardForm(forms.Form):
time_range = forms.CharField(widget=forms.Select(choices=TimeSeriesChart.TimeRange.choices), required=False)
scale = forms.CharField(widget=forms.Select(choices=TimeSeriesChart.Scale.choices), required=False)


class ChartFilterForm(forms.Form):
time_range = forms.CharField(widget=forms.Select(choices=TimeSeriesChart.TimeRange.choices), required=False)
scale = forms.CharField(widget=forms.Select(choices=TimeSeriesChart.Scale.choices), required=False)
filters = forms.ChoiceField(required=False)


@admin.register(TimeSeriesChart)
class TimeSeriesChartAdmin(admin.ModelAdmin):
list_display = ('display_chart_url', 'name', 'chart_type', 'app_label', 'model_name')
list_display_links = ('name',)
search_fields = ('name',)
fieldsets = (
(
None,
{
'fields': (
'name', 'description',
('chart_type', 'stacked')
)
},
),
(
'Target model',
{
'fields': (
('app_label', 'model_name', 'time_field'),
('aggregate', 'aggregate_field', 'aggregate_label'),
('split_field', 'filter_field', 'filters')
)
}
),
(
'Time options',
{
'fields': (
'default_time_range',
'default_scale',
)
}
),
)

def get_urls(self):
urls = super().get_urls()
my_urls = [
path('<int:chart_id>/chart/', self.admin_site.admin_view(self.chart_view), name='admin_chart_chart'),
path('<int:chart_id>/metrics/', self.admin_site.admin_view(self.metrics_api), name='admin_chart_metrics'),
]
return my_urls + urls

def metrics_api(self, request, chart_id):
chart = TimeSeriesChart.objects.get(id=chart_id)
data = {
'time_range': request.GET.get('time_range', chart.default_time_range),
'scale': request.GET.get('scale', chart.default_scale),
'filters': request.GET.get('filters', None)
}

if chart.filter_field:
form = ChartFilterForm(data)
StatsModel = chart.get_stats_model()
choices = StatsModel.objects.values_list(chart.filter_field, flat=True).distinct()
choices = [(x, x) for x in choices]
form.fields['filters'].choices = choices
else:
form = ChartStandardForm(data)

if form.is_valid():
time_range = int(form.cleaned_data.get('time_range'))
scale = form.cleaned_data.get('scale')
filter_value = form.cleaned_data.get('filters', None)
else:
raise Exception('filter is invalid')

if scale == TimeSeriesChart.Scale.HOUR:
date_format = '%Y-%m-%d %H:%M'
else:
date_format = '%Y-%m-%d'

if time_range:
start_time = timezone.now() - timedelta(days=time_range)
else:
start_time = None
stats = chart.get_queryset(start_time, scale, filter_value)

labels = []

if not chart.split_field:
data = []
for item in stats:
labels.append(item['time'].strftime(date_format))
data.append(str(item['total'] if item['total'] is not None else 0))
datasets = [
{
'label': chart.aggregate_label,
'data': data
}
]
else:
labels = []
last_labels = None
data = defaultdict(dict)
for item in stats:
label = item['time'].strftime(date_format)
if item['time'] != last_labels:
labels.append(label)
last_labels = item['time']
data[item['split']][label] = item['total']

split_names = data.keys()
datasets = defaultdict(list)

for label in labels:
for name in split_names:
datasets[name].append(data[name].get(label, 0))

datasets = [{'label': k, 'data': v} for k, v in datasets.items()]

return JsonResponse({
'chart_type': chart.chart_type,
'stacked': chart.stacked,
'labels': labels,
'datasets': datasets
})

def chart_view(self, request, chart_id):
context = {
**admin.site.each_context(request),
}

chart = TimeSeriesChart.objects.get(id=chart_id)

data = {
'time_range': request.GET.get('time_range', chart.default_time_range),
'scale': request.GET.get('scale', chart.default_scale),
}

if chart.filter_field:
form = ChartFilterForm(data)
StatsModel = chart.get_stats_model()
choices = StatsModel.objects.values_list(chart.filter_field, flat=True).distinct()
choices = [(x, x) for x in choices]
choices = [('', 'All')] + choices
form.fields['filters'].choices = choices
form.fields['filters'].label = chart.filter_field.title()
else:
form = ChartStandardForm(data)

context["chart"] = chart
context["chart_title"] = chart.name
context["form"] = form

return render(request, 'admin/chart.html', context)

@admin.display(description='View Chart')
def display_chart_url(self, obj):
return format_html('<a href="/admin/admin_extended/timeserieschart/{}/chart/">View Chart</a>', obj.id)
108 changes: 108 additions & 0 deletions admin_extended/migrations/0002_timeserieschart.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
# Generated by Django 5.1 on 2024-09-12 09:59

from django.db import migrations, models


class Migration(migrations.Migration):

dependencies = [
("admin_extended", "0001_initial"),
]

operations = [
migrations.CreateModel(
name="TimeSeriesChart",
fields=[
(
"id",
models.BigAutoField(
auto_created=True,
primary_key=True,
serialize=False,
verbose_name="ID",
),
),
("name", models.CharField(max_length=255)),
(
"description",
models.CharField(
blank=True, default=None, max_length=1000, null=True
),
),
(
"chart_type",
models.CharField(
choices=[("BAR", "Bar"), ("LINE", "Line")],
default="BAR",
max_length=55,
),
),
("stacked", models.BooleanField(default=False)),
(
"default_time_range",
models.IntegerField(
choices=[
(7, "Last 7 days"),
(30, "Last 30 days"),
(365, "Last 1 year"),
(0, "All time"),
],
default=30,
),
),
(
"default_scale",
models.CharField(
choices=[
("HOUR", "Hour"),
("DAY", "Day"),
("WEEK", "Week"),
("MONTH", "Month"),
],
default="DAY",
max_length=45,
),
),
("app_label", models.CharField(max_length=255)),
("model_name", models.CharField(max_length=255)),
("time_field", models.CharField(max_length=255)),
(
"aggregate",
models.CharField(
choices=[
("COUNT", "COUNT"),
("SUM", "SUM"),
("AVG", "AVG"),
("MIN", "MIN"),
("MAX", "MAX"),
],
max_length=45,
),
),
("aggregate_field", models.CharField(default="*", max_length=255)),
("aggregate_label", models.CharField(max_length=255)),
(
"split_field",
models.CharField(
blank=True, default=None, max_length=255, null=True
),
),
(
"filter_field",
models.CharField(
blank=True, default=None, max_length=255, null=True
),
),
(
"filters",
models.CharField(
blank=True,
default=None,
help_text="Filters for query. Example value: status=1&cate=3",
max_length=1000,
null=True,
),
),
],
),
]
2 changes: 2 additions & 0 deletions admin_extended/models/__init__.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
from .bookmark import Bookmark
from .chart import TimeSeriesChart
0 admin_extended/models.py → admin_extended/models/bookmark.py
View file
File renamed without changes.
Loading

0 comments on commit 76cff18

Please sign in to comment.