List of scheduled tasks in dhango admin

[abadger1]

Would be good if there was a static page within django admin that listed all the scheduled tasks - these are held in code with decorators, so easy for developers to see - but not easy for administrators to see that access django admin.

[abadger1]

[abadger1]

Set if AI generated files i used to create this...

https://chatgpt.com/share/68c02655-2a68-8005-8648-d4a2cf2d76d7

tasks_registry.py

from dataclasses import dataclass, field

@DataClass(frozen=True)
class PeriodicSchedule:
task_name: str
cron: str
periodic_id: str | None
queue: str | None
task_kwargs: dict = field(default_factory=dict)

REGISTRY: list[PeriodicSchedule] = []

def register_periodic(app, *, cron, periodic_id=None, queue=None, task_kwargs=None, **periodic_kwargs):
"""
Wraps app.periodic to both register and decorate the task.
"""
def decorator(func):
# Register for the static list
REGISTRY.append(
PeriodicSchedule(
task_name=f"{func.module}.{func.name}",
cron=cron,
periodic_id=periodic_id,
queue=queue,
task_kwargs=task_kwargs or {},
)
)
# Apply Procrastinate’s periodic decorator
return app.periodic(cron=cron, periodic_id=periodic_id, queue=queue,
task_kwargs=task_kwargs, **periodic_kwargs)(func)
return decorator

myapp/tasks.py

import procrastinate
from .tasks_registry import register_periodic

app = procrastinate.App(...) # your configured App

@register_periodic(app, cron="0 * * * *", periodic_id="hourly_maintenance", queue="maintenance")
@app.task
def hourly_maintenance(timestamp: int):
...

admin.py

from django.contrib import admin
from django.urls import path
from django.utils.html import format_html
from django.shortcuts import render
from croniter import croniter
from datetime import datetime, timezone

from .tasks_registry import REGISTRY

class SchedulesAdminSite(admin.AdminSite):
site_header = "Backoffice"

def get_urls(self):
    return [
        path("periodic-schedules/", self.admin_view(self.periodic_schedules_view),
             name="periodic_schedules"),
    ] + super().get_urls()

def periodic_schedules_view(self, request):
    now = datetime.now(timezone.utc)
    rows = []
    for s in REGISTRY:
        itr = croniter(s.cron, now)
        next_run = itr.get_next(datetime)
        rows.append({
            "task_name": s.task_name,
            "periodic_id": s.periodic_id or "",
            "cron": s.cron,
            "queue": s.queue or "",
            "task_kwargs": s.task_kwargs,
            "next_run": next_run,
        })
    context = dict(self.each_context(request), rows=rows, title="Periodic Schedules")
    return render(request, "admin/periodic_schedules.html", context)

admin_site = SchedulesAdminSite()

(Optional) also register the built-in read-only models here if you use a custom AdminSite.

{# templates/admin/periodic_schedules.html #}
{% extends "admin/base_site.html" %}
{% block content %}

{{ title }}

{% for r in rows %} {% endfor %}

Task	Periodic ID	Cron	Queue	Task kwargs	Next run (UTC)
{{ r.task_name }}	{{ r.periodic_id }}	{{ r.cron }}	{{ r.queue }}	{{ r.task_kwargs }}	{{ r.next_run }}

{% endblock %}