Download prof files

debug_toolbar/panels/profiling.py

@@ -1,14 +1,26 @@
 import cProfile
+import logging
 import os
 from colorsys import hsv_to_rgb
 from pstats import Stats
 
+from django import forms
 from django.conf import settings
+from django.contrib.auth.decorators import login_not_required
+from django.http import FileResponse, Http404, HttpResponseBadRequest
+from django.urls import path
+from django.utils import timezone
 from django.utils.html import format_html
 from django.utils.translation import gettext_lazy as _
+from django.views.decorators.http import require_GET
 
 from debug_toolbar import settings as dt_settings
+from debug_toolbar.decorators import render_with_toolbar_language, require_show_toolbar
 from debug_toolbar.panels import Panel
+from debug_toolbar.toolbar import DebugToolbar
+from debug_toolbar.utils import ViewPathMetadata
+
+logger = logging.getLogger(__name__)
 
 
 class FunctionCall:
@@ -131,22 +143,69 @@ def cumtime_per_call(self):
     def indent(self):
         return 16 * self.depth
 
+    def primitive_count(self):
+        return self.stats[0]
+
+    def _func_key(self):
+        # Mirrors pstats.func_std_string to produce the plain-text identifier
+        # used in downloaded .prof files.
+        # https://docs.python.org/3/library/profile.html#pstats.Stats
+        if self.func[:2] == ("~", 0):
+            name = self.func[2]
+            if name.startswith("<") and name.endswith(">"):
+                return f"{{{name[1:-1]}}}"
+            return name
+        return "%s:%d(%s)" % self.func
+
     def serialize(self):
         return {
             "has_subfuncs": self.has_subfuncs,
             "id": self.id,
             "parent_ids": self.parent_ids,
             "is_project_func": self.is_project_func(),
             "indent": self.indent(),
+            "func_key": self._func_key(),
             "func_std_string": self.func_std_string(),
             "cumtime": self.cumtime(),
             "cumtime_per_call": self.cumtime_per_call(),
             "tottime": self.tottime(),
             "tottime_per_call": self.tottime_per_call(),
             "count": self.count(),
+            "primitive_count": self.primitive_count(),
         }
 
 
+def _print_stats_from_function_calls(func_list: list[FunctionCall]) -> str:
+    """
+    Create a string that is matches what pstats.Stats.print_stats would
+    print out.
+    """
+    # Column layout matches pstats output: ncalls right-justified in 9
+    # chars, each time value formatted as f8 ("%8.3f"). The 3-space indent
+    # on the header and ordering lines is part of the pstats format.
+    # https://docs.python.org/3/library/profile.html#pstats.Stats.print_stats
+    lines = ["   Ordered by: cumulative time", ""]
+    lines.append(
+        "   ncalls  tottime  percall  cumtime  percall filename:lineno(function)"
+    )
+    for func in func_list:
+        nc = func["count"]
+        cc = func["primitive_count"]
+        # pstats shows nc/cc when they differ (recursive calls inflate nc)
+        ncalls_str = f"{nc}/{cc}" if nc != cc else str(nc)
+        # pstats prints 8 spaces instead of a percall value when the
+        # divisor is zero, preserving column alignment
+        tt_per = f"{func['tottime_per_call']:8.3f}" if nc else " " * 8
+        ct_per = f"{func['cumtime_per_call']:8.3f}" if cc else " " * 8
+        lines.append(
+            f"{ncalls_str:>9} {func['tottime']:8.3f} {tt_per}"
+            f" {func['cumtime']:8.3f} {ct_per} {func['func_key']}"
+        )
+    # pstats ends output with two blank lines
+    lines.extend(["", ""])
+    return "\n".join(lines)
+
+
 class ProfilingPanel(Panel):
     """
     Panel that displays profiling information.
@@ -184,7 +243,6 @@ def generate_stats(self, request, response):
         self.stats.calc_callees()
 
         root_func = cProfile.label(super().process_request.__code__)
-
         if root_func in self.stats.stats:
             root = FunctionCall(self.stats, root_func, depth=0)
             func_list = []
@@ -197,4 +255,67 @@ def generate_stats(self, request, response):
                 dt_settings.get_config()["PROFILER_MAX_DEPTH"],
                 cum_time_threshold,
             )
-            self.record_stats({"func_list": [func.serialize() for func in func_list]})
+            try:
+                url_name = ViewPathMetadata.from_request(request).url_name
+            except Http404:
+                url_name = _("<unavailable>")
+            self.record_stats(
+                {
+                    "func_list": [func.serialize() for func in func_list],
+                    "profile_name": f"{url_name}-{timezone.now().isoformat()}",
+                }
+            )
+
+    def get_stats(self):
+        """
+        Access data stored by the panel. Returns a :class:`dict`.
+        """
+        stats = super().get_stats()
+        # This isn't a stat, but is used in the context in the
+        # ProfilingPanel.content property when rendering the template.
+        stats["profiling_download_form"] = ProfilingDownloadForm(
+            initial={"request_id": self.toolbar.request_id}
+        )
+        return stats
+
+    @classmethod
+    def get_urls(cls):
+        return [
+            path("profiling_download/", profiling_download, name="profiling_download")
+        ]
+
+
+class ProfilingDownloadForm(forms.Form):
+    """
+    Validate params
+
+        request_id: The key for the store instance to be fetched.
+    """
+
+    request_id = forms.CharField(widget=forms.HiddenInput())
+
+
+@require_GET
+@login_not_required
+@require_show_toolbar
+@render_with_toolbar_language
+def profiling_download(request):
+    form = ProfilingDownloadForm(request.GET)
+
+    if form.is_valid():
+        request_id: str = form.cleaned_data["request_id"]
+        toolbar: DebugToolbar | None = DebugToolbar.fetch(request_id)
+        if toolbar is None:
+            return HttpResponseBadRequest("Request is no longer available.")
+        panel = toolbar.get_panel_by_id(ProfilingPanel.panel_id)
+        panel_stats = panel.get_stats()
+        if "func_list" not in panel_stats:
+            return HttpResponseBadRequest("No profiling data exists for this request.")
+        content = _print_stats_from_function_calls(panel_stats["func_list"])
+        return FileResponse(
+            content,
+            as_attachment=True,
+            filename=f"{panel_stats['profile_name']}.prof",
+            content_type="text/plain",
+        )
+    return HttpResponseBadRequest(f"Form errors: {form.errors}")

debug_toolbar/panels/request.py

@@ -1,9 +1,11 @@
 from django.http import Http404
-from django.urls import resolve
 from django.utils.translation import gettext_lazy as _
 
 from debug_toolbar.panels import Panel
-from debug_toolbar.utils import get_name_from_obj, sanitize_and_sort_request_vars
+from debug_toolbar.utils import (
+    ViewPathMetadata,
+    sanitize_and_sort_request_vars,
+)
 
 
 class RequestPanel(Panel):
@@ -32,30 +34,22 @@ def generate_stats(self, request, response):
             }
         )
 
-        view_info = {
-            "view_func": _("<no view>"),
-            "view_args": "None",
-            "view_kwargs": "None",
-            "view_urlname": "None",
-        }
         try:
-            match = resolve(request.path_info)
-            func, args, kwargs = match
-            view_info["view_func"] = get_name_from_obj(func)
-            view_info["view_args"] = args
-            view_info["view_kwargs"] = kwargs
-
-            if getattr(match, "url_name", False):
-                url_name = match.url_name
-                if match.namespaces:
-                    url_name = ":".join([*match.namespaces, url_name])
-            else:
-                url_name = _("<unavailable>")
-
-            view_info["view_urlname"] = url_name
-
+            view_metadata = ViewPathMetadata.from_request(request)
         except Http404:
-            pass
+            view_info = {
+                "view_func": _("<no view>"),
+                "view_args": "None",
+                "view_kwargs": "None",
+                "view_urlname": "None",
+            }
+        else:
+            view_info = {
+                "view_func": view_metadata.view_func,
+                "view_args": view_metadata.view_args,
+                "view_kwargs": view_metadata.view_kwargs,
+                "view_urlname": view_metadata.url_name,
+            }
         self.record_stats(view_info)
 
         if hasattr(request, "session"):

debug_toolbar/templates/debug_toolbar/panels/profiling.html

@@ -1,4 +1,10 @@
 {% load i18n %}
+
+<form method="get" action="{% url 'djdt:profiling_download' %}" target="_blank">
+    {{ profiling_download_form.as_div }}
+    <button>Download</button>
+</form>
+
 <table>
   <thead>
     <tr>
@@ -13,22 +19,22 @@
   <tbody>
     {% for call in func_list %}
       <tr class="djdt-profile-row {% if call.is_project_func %}djdt-highlighted {% endif %} {% for parent_id in call.parent_ids %} djToggleDetails_{{ parent_id }}{% endfor %}" id="profilingMain_{{ call.id }}">
-        <td>
-          <div data-djdt-styles="paddingLeft:{{ call.indent }}px">
-            {% if call.has_subfuncs %}
+      <td>
+        <div data-djdt-styles="paddingLeft:{{ call.indent }}px">
+          {% if call.has_subfuncs %}
               <button type="button" class="djProfileToggleDetails djToggleSwitch" data-toggle-name="profilingMain" data-toggle-id="{{ call.id }}">-</button>
-            {% else %}
-              <span class="djNoToggleSwitch"></span>
-            {% endif %}
-            <span class="djdt-stack">{{ call.func_std_string|safe }}</span>
-          </div>
-        </td>
-        <td>{{ call.cumtime|floatformat:3 }}</td>
-        <td>{{ call.cumtime_per_call|floatformat:3 }}</td>
-        <td>{{ call.tottime|floatformat:3 }}</td>
-        <td>{{ call.tottime_per_call|floatformat:3 }}</td>
-        <td>{{ call.count }}</td>
-      </tr>
+          {% else %}
+          <span class="djNoToggleSwitch"></span>
+          {% endif %}
+          <span class="djdt-stack">{{ call.func_std_string|safe }}</span>
+        </div>
+      </td>
+      <td>{{ call.cumtime|floatformat:3 }}</td>
+      <td>{{ call.cumtime_per_call|floatformat:3 }}</td>
+      <td>{{ call.tottime|floatformat:3 }}</td>
+      <td>{{ call.tottime_per_call|floatformat:3 }}</td>
+      <td>{{ call.count }}</td>
+    </tr>
     {% endfor %}
   </tbody>
 </table>

debug_toolbar/utils.py

@@ -4,16 +4,19 @@
 import linecache
 import os.path
 import sys
+import typing
 import warnings
 from collections.abc import Sequence
 from pprint import PrettyPrinter, pformat
 from typing import Any
 
 from asgiref.local import Local
-from django.http import QueryDict
+from django.http import HttpRequest, QueryDict
 from django.template import Node
+from django.urls import resolve
 from django.utils.html import format_html
 from django.utils.safestring import SafeString, mark_safe
+from django.utils.translation import gettext_lazy as _
 from django.views.debug import get_default_exception_reporter_filter
 
 from debug_toolbar import _compat as compat, _stubs as stubs, settings as dt_settings
@@ -415,3 +418,37 @@ def get_csp_nonce(request) -> str | None:
         return csp_nonce
     # Django's built-in CSP support uses get_nonce(request)
     return compat.get_nonce(request)
+
+
+class ViewPathMetadata(typing.NamedTuple):
+    """
+    Helpers class containing the routing metadata for a request being
+    routed through a particular path to the view.
+    """
+
+    view_func: str
+    view_args: tuple[Any]
+    view_kwargs: dict[str, Any]
+    url_name: str
+
+    @classmethod
+    def from_request(cls, request: HttpRequest) -> ViewPathMetadata:
+        """
+        Create an instance of the ViewPathMetadata from a request.
+        """
+        match = resolve(request.path_info)
+        func, args, kwargs = match
+
+        if getattr(match, "url_name", False):
+            url_name = match.url_name
+            if match.namespaces:
+                url_name = ":".join([*match.namespaces, url_name])
+        else:
+            url_name = _("<unavailable>")
+
+        return ViewPathMetadata(
+            view_func=get_name_from_obj(func),
+            view_args=args,
+            view_kwargs=kwargs,
+            url_name=url_name,
+        )

docs/changes.rst

@@ -25,6 +25,8 @@ Pending
   ``esupgrade``.
 * Updated tox configuration to treat ``DeprecationWarning``,
   ``ResourceWarning``, and ``PendingDeprecationWarning`` as errors.
+* Added the ability to download the profiling data as a file.
+
 
 6.3.0 (2026-04-01)
 ------------------