Add Tasks panel showing tasks queued during the request by onxxdatas · Pull Request #2407 · django-commons/django-debug-toolbar

onxxdatas · 2026-07-09T02:13:49Z

Description

Adds a new panel using Django's built-in tasks framework (django.tasks, added in Django 6.0). Shows task name, queue, backend, priority, run_after, status, and arguments for each task queued during the request. On Django < 6.0, the panel explains that upgrading is required instead of showing task data..

Fixes #2204

Checklist:

I have added the relevant tests for this change.
I have added an item to the Pending section of docs/changes.rst.

AI/LLM Usage

This PR includes code generated with the help of an AI/LLM

Adds a new panel using Django's built-in tasks framework (django.tasks, added in Django 6.0). Shows task name, queue, backend, priority, run_after, status, and arguments for each task queued during the request. On Django < 6.0, the panel explains that upgrading is required instead of showing task data. Closes django-commons#2204

matthiask · 2026-07-09T06:30:47Z

Hi @onxxdatas

Thanks for your contribution! Can you post a screenshot of how the panel looks when some tasks have been enqueued? That would be very helpful.

matthiask · 2026-07-09T06:31:38Z

And also, did you see #2235 ? How does this change compare to the panel proposed in the other PR?

github-actions · 2026-07-09T06:37:48Z

Coverage report

Click to see where and how coverage changed

File	Statements	Missing	Coverage	Coverage (new stmts)	Lines missing
debug_toolbar
_compat.py					36
debug_toolbar/panels
tasks.py
Project Total

_{This report was generated by python-coverage-comment-action}

onxxdatas · 2026-07-09T13:25:50Z

@matthiask Here's the panel with tasks enqueued. I also added a small demo page
to the example project (/tasks/) for testing this going forward

Enqueued tasks:

Tasks history:

onxxdatas · 2026-07-09T14:13:58Z

And also, did you see #2235 ? How does this change compare to the panel proposed in the other PR?

I saw two structural differences in #2235 compared to mine. First of all it instruments by monkeypatching Task.enqueue directly on the class (Task.enqueue = wrapped_enqueue). Since the panel is per request and is_async = True, this isn't safe under concurrent&async requests. Two overlapping requests can race on the patch, with disable_instrumentation() potentially restoring the wrong 'original' and leaving tasks misattributed or the method unpatched afterward.

Second one is that on django < 6.0, _tasks_available returns False and instrumentation just no ops silently so the panel still shows up but always displays zero tasks with no indication to the user that it's unsupported on their Django version.

tim-schilling

I think this is a great start! I have a handful of small requests. I'd be happy to have this merged with those addressed (or resolving the conversations through discussion if you disagree).

One thing we probably do want to include eventually is the stacktrace from where the task was queued, the same way we can determine where a cache call or SQL query was ran. I would suggest looking at the CachePanel for inspiration as it should be simpler. If you want to add that in a follow-up PR that's fine too.

tim-schilling · 2026-07-13T23:38:14Z

+    def nav_subtitle(self):
+        if task_enqueued is None:
+            return _("Requires Django 6.0+")
+        tasks = self.get_stats().get("tasks", [])


Suggested change

tasks = self.get_stats().get("tasks", [])

tasks = self.get_stats()["tasks"]

tim-schilling · 2026-07-13T23:42:22Z

+                "run_after": task.run_after,
+                "takes_context": task.takes_context,
+                "args": task_result.args,
+                "kwargs": task_result.kwargs,


Should we use toolbar.utils.sanitize_and_sort_request_vars here?

tim-schilling · 2026-07-13T23:47:51Z

+    task = None
+
+
+if task is not None:


I feel like comparing on the Django version will be easier for us to keep up dated as versions pass rather than checking the imported variable. It may be better to just do one big if statement for tasks_view and example_task as well then.

tim-schilling · 2026-07-13T23:53:28Z

+try:
+    from django.tasks import task
+except ImportError:
+    task = None


Let's extract this into a compat.py file and when it doesn't exist, create a pass-through decorator. That way we can can use skipUnless with the version which is more typical.

tim-schilling · 2026-07-13T23:56:06Z

+        self.assertTrue(stats["tasks_available"])
+        self.assertEqual(len(stats["tasks"]), 1)
+
+        recorded = stats["tasks"][0]
+        self.assertEqual(recorded["name"], f"{__name__}.sample_task")
+        self.assertEqual(list(recorded["args"]), [2])
+        self.assertEqual(dict(recorded["kwargs"]), {"y": 3})
+        self.assertEqual(recorded["queue_name"], "default")
+        self.assertEqual(recorded["backend"], "default")


Nitpick: I think we may want to compare the stats dictionary as a whole. For example self.assertEqual(stats, { ... }) instead of the individual assertions.

tim-schilling · 2026-07-13T23:57:12Z

+        On Django < 6.0, django.tasks doesn't exist, so the panel should
+        explain that instead of showing task data.
+        """
+        with mock.patch("debug_toolbar.panels.tasks.task_enqueued", None):


Rather than patching this, we could do @skipUnless(django.VERSION < (6, 0))

onxxdatas · 2026-07-14T09:49:55Z

@tim-schilling Thanks for the thorough review👍🏼 I've pushed a commit addressing all 6 points.

onxxdatas · 2026-07-15T02:11:58Z

@tim-schilling The failures only happen on the djmain test matrix, on Python 3.13/3.14 & dj52 and dj60 (the two released Django versions) both pass. The cause is django-csp's CSPMiddleware, which still imports MiddlewareMixin from this deprecated location: MiddlewareMixin from django.utils.deprecation. Django's dev branch just started emitting that warning, and since the test runner treats warnings as errors (-b flag), it fails 4 CSP tests.

codingjoe

Nice, I am looking forward to this one 👍

codingjoe · 2026-07-15T12:43:39Z

+
+    # Implement the Panel API
+
+    nav_title = _("Tasks")


Do we cap, single words? I'd usually like to use capfirst or title in templates and keep translation placeholders ambiguous.

I've updated the translation string to _("tasks"). I left the template unchanged since that would affect all panel titles.

codingjoe · 2026-07-15T12:45:22Z

+        if task_enqueued is None:
+            return _("Requires Django 6.0+")


That's an interesting solution. A django.__VERSION__ condition might be easier to find when we remove Django 5.2 support.

Yep, using django.VERSION is preferrable since those blocks can automatically be dropped using django-upgrade later.

updated to use django.VERSION for the compatibility check

Suggested change

if task_enqueued is None:

return _("Requires Django 6.0+")

if django.VERSION < (6, 0):

return _("Requires Django 6.0+")

@onxxdatas this is what they are suggesting.

Yeah-yeah, I just pushed all my changes

codingjoe · 2026-07-15T12:47:10Z

+            {
+                "id": task_result.id,
+                "name": task.module_path,
+                "queue_name": task.queue_name,
+                "priority": task.priority,
+                "backend": task_result.backend,
+                "run_after": task.run_after,
+                "takes_context": task.takes_context,
+                "args": sanitize_and_sort_request_vars(task_result.args),
+                "kwargs": sanitize_and_sort_request_vars(task_result.kwargs),
+                "status": task_result.status,
+            }


Why do we need to come up with our custom data structure here? TaskResult holds all the important information.

It can also fairly easily be JSON serialized, if that is needed.

removed the custom dictionary and now we rely on TaskResult directly.

@codingjoe are you suggesting we shouldn't be appending a custom dictionary to tasks here?

I was suggesting to just pass the TaskResult instance to the template. I don't see why we need this mapping here. In other words:

self.task: lists[TaskResult]

do you have any other change request based on my last commit?

codingjoe · 2026-07-15T12:48:48Z

+                "name": task.module_path,
+                "queue_name": task.queue_name,
+                "priority": task.priority,
+                "backend": task_result.backend,


The actual backend class is probably less interesting. The alias is usually probably the imporant information.

Based on my decision, I updated the template to show backend alias from Tasks

We've had people want to know what the backend is for caches as well. Plus using this in different environments may mean using different backends (Immediate vs DB vs something else)

Good point. I focused on the alias because it identifies the configured task backend, but I agree the actual backend implementation can be valuable when debugging differences between environments. What do you think about showing both alias and backend class at once?

I am just realizing they are one and the same. Poor naming on Django's site.

So task_result.backend is the alias.

codingjoe · 2026-07-15T12:49:41Z

+  <table>
+    <thead>
+      <tr>
+        <th>{% translate "Name" %}</th>


Just a general thought:

Suggested change

<th>{% translate "Name" %}</th>

<th>{% translate "name"|title %}</th>

By the way, I lowercased the other translation strings too

codingjoe · 2026-07-15T12:52:54Z

+* Added a Tasks panel that shows tasks queued during the request via
+  Django's built-in tasks framework (``django.tasks``, Django 6.0+). On
+  older versions of Django, the panel explains that upgrading is required.


Maybe a merge error, but there seems to be duplication.

codingjoe · 2026-07-15T12:54:54Z

+   added in that release. On earlier versions of Django, the panel
+   explains that upgrading is required instead of showing task data.


Maybe a little verbose. Most people will figure out that Django <6.0 doesn't have a task framework. The error message is good, but IMHO it doesn't need to be documented.

Now it just says "Requires Django 6.0+."

matthiask · 2026-07-15T14:28:17Z

@tim-schilling The failures only happen on the djmain test matrix, on Python 3.13/3.14 & dj52 and dj60 (the two released Django versions) both pass. The cause is django-csp's CSPMiddleware, which still imports MiddlewareMixin from this deprecated location: MiddlewareMixin from django.utils.deprecation. Django's dev branch just started emitting that warning, and since the test runner treats warnings as errors (-b flag), it fails 4 CSP tests.

Yep, that's fixed now.

for more information, see https://pre-commit.ci

codingjoe

Almost! Sorry, I found just a few more small things. All nit picks, but when in rome 🤷

codingjoe · 2026-07-16T17:11:18Z

+    <thead>
+      <tr>
+        <th>{% translate "name"|title %}</th>
+        <th>{% translate "queue"|title %}</th>


ambiguous, could be verb to queue

Suggested change

<th>{% translate "queue"|title %}</th>

<th>{% translate "queue"|title context "noun" %}</th>

codingjoe · 2026-07-16T17:11:38Z

+  <table>
+    <thead>
+      <tr>
+        <th>{% translate "name"|title %}</th>


ambiguous, could be verb to name

Suggested change

<th>{% translate "name"|title %}</th>

<th>{% translate "name"|title context "noun" %}</th>

codingjoe · 2026-07-16T17:14:45Z

@@ -0,0 +1,40 @@
+{% load i18n %}
+{% if not tasks_available %}


I'd like to avoid negations. You can do if task .. elif task_available .. else.

That being said, the task_available could be replaced with a Django version check too. Again, easier to remove once Django 5.2 goes the way of the dodo.

codingjoe · 2026-07-16T17:15:33Z

+        super().__init__(*args, **kwargs)
+        self.tasks = []
+
+    # Implement the Panel API


If it doesn't spark joy, it can go. — Marie Kondo

Suggested change

# Implement the Panel API

Removed. Didn't spark joy😄
Also fixed the "name"/"queue" ambiguity and the negation in the template, all pushed.

…able / else) - Disambiguate 'name'/'queue' translations with context 'noun' - Use django.VERSION instead of task_enqueued is None - Drop the 'Implement the Panel API' comment - Keep task stats as a dict mirroring TaskResult's own field names (raw TaskResult isn't JSON-serializable - Task.func breaks the history panel/async request storage round-trip) - Revert nav_title/title to 'Tasks' (capitalized), matching every other panel, since panel_button.html has no capfirst/title filter

codingjoe · 2026-07-20T09:59:35Z

+  <table>
+    <thead>
+      <tr>
+        <th>{% translate "name"|title context "noun" %}</th>


Name may be ambiguous here. Path or Python-path might be more fitting.

onxxdatas mentioned this pull request Jul 9, 2026

Create Tasks panel #2204

Open

i added a tasks demo page to the example project

d43b177

Add changelog entry for Tasks panel

3d0ade3

tim-schilling requested changes Jul 13, 2026

View reviewed changes

Address reviews

907a0e4

codingjoe reviewed Jul 15, 2026

View reviewed changes

Merge branch 'main' into tasks-panel

3fc366f

onxxdatas requested a review from tim-schilling July 15, 2026 16:10

onxxdatas and others added 2 commits July 15, 2026 22:59

Address review feedback for Tasks panel

5d864c9

[pre-commit.ci] auto fixes from pre-commit.com hooks

847ed11

for more information, see https://pre-commit.ci

codingjoe reviewed Jul 16, 2026

View reviewed changes

codingjoe reviewed Jul 20, 2026

View reviewed changes

Using 'python path' instead of 'Name'

45e1bfa

	tasks = self.get_stats().get("tasks", [])
	tasks = self.get_stats()["tasks"]

	<th>{% translate "Name" %}</th>
	<th>{% translate "name"\|title %}</th>

		added in that release. On earlier versions of Django, the panel
		explains that upgrading is required instead of showing task data.

	<th>{% translate "queue"\|title %}</th>
	<th>{% translate "queue"\|title context "noun" %}</th>

	<th>{% translate "name"\|title %}</th>
	<th>{% translate "name"\|title context "noun" %}</th>

Uh oh!

Conversation

onxxdatas commented Jul 9, 2026 • edited by tim-schilling Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist:

AI/LLM Usage

Uh oh!

matthiask commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

matthiask commented Jul 9, 2026

Uh oh!

github-actions Bot commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage report

Uh oh!

onxxdatas commented Jul 9, 2026

Uh oh!

onxxdatas commented Jul 9, 2026

Uh oh!

tim-schilling left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

onxxdatas commented Jul 14, 2026

Uh oh!

onxxdatas commented Jul 15, 2026

Uh oh!

codingjoe left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codingjoe Jul 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

onxxdatas commented Jul 9, 2026 •

edited by tim-schilling

Loading

matthiask commented Jul 9, 2026 •

edited

Loading

github-actions Bot commented Jul 9, 2026 •

edited

Loading

codingjoe Jul 20, 2026 •

edited

Loading

onxxdatas Jul 15, 2026 •

edited

Loading