Download prof files by JohananOppongAmoateng · Pull Request #2286 · django-commons/django-debug-toolbar

JohananOppongAmoateng · 2025-12-17T19:46:08Z

Description

This pr is based on the work of @andoriyaprashant which he made to fix #1798. I am continuing his work to get it over the finish line. His pr is this #2146 .

Fixes #1798

Checklist:

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

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

…-toolbar into download-prof-files

github-actions · 2025-12-17T19:55:57Z

Coverage report

Click to see where and how coverage changed

File	Statements	Missing	Coverage	Coverage (new stmts)	Lines missing
debug_toolbar
utils.py
debug_toolbar/panels
__init__.py
profiling.py					157
request.py
Project Total

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

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

Copilot

Pull request overview

This PR adds the ability to download profiling data as .prof files, addressing issue #1798. The feature is disabled by default and requires configuring the PROFILER_PROFILE_ROOT setting to specify where profile files should be saved.

Key changes:

Added PROFILER_PROFILE_ROOT configuration setting to control where profile files are saved
Implemented profile file generation in the profiling panel with signed filenames for security
Created a new download view with URL endpoint to serve the profile files

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
`debug_toolbar/settings.py`	Added `PROFILER_PROFILE_ROOT` default setting (None)
`debug_toolbar/panels/profiling.py`	Modified to generate and save .prof files when PROFILER_PROFILE_ROOT is configured; signs filename for secure download
`debug_toolbar/views.py`	Added `download_prof_file` view to handle file downloads with signature validation
`debug_toolbar/toolbar.py`	Registered new download URL endpoint
`debug_toolbar/urls.py`	Minor whitespace addition
`debug_toolbar/templates/debug_toolbar/panels/profiling.html`	Added download link UI and reformatted indentation
`debug_toolbar/static/debug_toolbar/css/toolbar.css`	Added styling for download control
`tests/panels/test_profiling.py`	Added comprehensive tests for profile file generation and download functionality
`docs/configuration.rst`	Documented the new PROFILER_PROFILE_ROOT setting
`docs/changes.rst`	Added changelog entry for the new feature
`debug_toolbar/panels/sql/tracking.py`	Unrelated changes to handle executemany parameters in SQL tracking

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

JohananOppongAmoateng · 2026-01-12T09:24:00Z

Hello everyone sorry for not finishing this. I have been a bit caught up working on other OSS projects . I promise to push new commits this weekend to fix the reviews co pilot left

…-toolbar into download-prof-files

tim-schilling

Thank you for continuing to work on this 🚀. I've got some questions about the direction of this. If you're confused, or think I may be wrong, please let me know. I'm happy to hop on a call and chat about this too!

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

tim-schilling · 2026-05-09T14:05:19Z

        }


+def _print_stats_from_function_calls(func_list: list[FunctionCall]) -> str:


I'm not sure about this. I could use a second opinion on whether we want to go this approach or not.

pstats.Stats can be printed to any stream-like object. So you can get a io.StringIO and simply call print_stats. I don't believe the is a need to recreate the funcitonality, right?

The challenge is the panel doesn't show the same content.

The profiling panel as a whole needs a bit of a rework. The threshold concept just doesn't seem to work properly. It seems like we should lean more into the actual APIs of the standard library.

Getting this all resolved is on my todo list, but I'd really like to avoid it for this feature.

tim-schilling

So I'm in favor of this, but it's just enough to get it merged. I would appreciate another opinion on this approach. I worry it's overly brittle. I suspect we'll end up redoing a lot of this as a part of integrating Yappi and fixing the profiling panel in general.

I had help from Claude to generate the Stats.print_stats reproduction.

codingjoe

Hi there,

The second opinion arrived; I hope you don't mind.

I like the idea. However, the current implementation adds a pretty high maintenance burden onto this package. If you can make this work with a buffer object, like I described below, the scales might tip for me.

Cheers!
Joe

codingjoe · 2026-05-09T15:35:29Z

        }


+def _print_stats_from_function_calls(func_list: list[FunctionCall]) -> str:


pstats.Stats can be printed to any stream-like object. So you can get a io.StringIO and simply call print_stats. I don't believe the is a need to recreate the funcitonality, right?

codingjoe · 2026-05-09T15:37:06Z

+<form method="get" action="{% url 'djdt:profiling_download' %}" target="_blank">
+    {{ profiling_download_form.as_div }}
+    <button>Download</button>
+</form>


Why use a form and a button for a GET request? Why not use an a-tag with a download attribute.

I did it for consistency with the history panel which was originally done because the form used to inherit from SignedDataForm. I do like that it enforces the data validation more strictly.

codingjoe · 2026-05-09T15:37:22Z

 from debug_toolbar.toolbar import DebugToolbar

 app_name = APP_NAME
+


Unrealted change.

codingjoe · 2026-05-09T15:39:08Z

+@dataclass
+class ViewPathMetadata:


Dataclasses are great class factories but not great datastructure primitives. NamedTuples are based on C-structs and much more suitable for immutable data structures.

Suggested change

@dataclass

class ViewPathMetadata:

class ViewPathMetadata(typing.NamedTuple):

codingjoe · 2026-05-09T15:40:12Z

+    url_name: str
+
+
+def get_view_path_metadata(request: HttpRequest) -> ViewPathMetadata:


This could be a from_request factory class method on the actual ViewPathMetadata class.

codingjoe · 2026-05-09T15:40:32Z

+        url_name = _("<unavailable>")
+
+    return ViewPathMetadata(
+        view_func=get_name_from_obj(func),


If you want to stick with a dataclass, this should probably be part of post_init.

codingjoe · 2026-05-09T15:42:49Z

+        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"])
+        response = HttpResponse(content, content_type="text/plain")


The Content-Disposition header would enable you to propose a filename to the browser.

codingjoe · 2026-05-09T15:46:06Z

+    # 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


I don't want to insinuate anything, but the comments read like AI code. Maybe we don't fan the fire and limit comments to only what can't be easily understood from the code itself.

I called out that I used Claude in the PR.

I think in this case the comments help. There's syntax used in this function that isn't typical in my opinion, so having it explained helps.

andoriyaprashant and others added 4 commits June 18, 2025 15:49

Add .prof File Download Support to Profiling Panel

48ac250

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

49f29eb

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

Merge branch 'main' of https://github.com/django-commons/django-debug…

7ec7f25

…-toolbar into download-prof-files

Refactor profiling panel and add download functionality for .prof files

fe4e305

JohananOppongAmoateng and others added 7 commits December 17, 2025 20:04

Add profiling data download functionality and related settings

5db558d

Add tests for profiling stats generation and download functionality

74ddf5e

fix

5bbb211

fix

a285d82

fix

2bd5cfe

Merge branch 'main' into download-prof-files

e698cde

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

66e2d50

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

JohananOppongAmoateng marked this pull request as ready for review December 17, 2025 20:48

JohananOppongAmoateng requested review from Copilot, matthiask and tim-schilling December 17, 2025 20:56

Copilot started reviewing on behalf of JohananOppongAmoateng December 17, 2025 20:57 View session

Copilot AI reviewed Dec 17, 2025

View reviewed changes

JohananOppongAmoateng added 2 commits February 7, 2026 10:28

Merge branch 'main' of https://github.com/django-commons/django-debug…

3896fe3

…-toolbar into download-prof-files

address problems

09f2ba0

JohananOppongAmoateng force-pushed the download-prof-files branch from e690762 to 09f2ba0 Compare February 7, 2026 12:23

docs

9829c58

tim-schilling requested changes Feb 8, 2026

View reviewed changes

address review concerns

cfc244b

JohananOppongAmoateng requested a review from tim-schilling February 8, 2026 17:57

tim-schilling mentioned this pull request Feb 10, 2026

Add .prof File Download Support to Profiling Panel #2146

Closed

2 tasks

tim-schilling reviewed Feb 10, 2026

View reviewed changes

Comment thread debug_toolbar/panels/profiling.py Outdated

tim-schilling added 2 commits May 7, 2026 16:24

Merge branch 'main' into download-prof-files

df258a2

Clean up PR.

efbd2b9

tim-schilling and others added 5 commits May 7, 2026 17:09

Generate the prof file on the fly.

9cbdf04

Merge branch 'main' into download-prof-files

05a505c

Name the profile file based on the request being made.

34dde67

Remove the mocks from the profiling panel's integration tests.

bdb6bf5

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

776e4ba

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

tim-schilling reviewed May 9, 2026

View reviewed changes

Remove unexpected addition of uv.lock.

25fa939

tim-schilling approved these changes May 9, 2026

View reviewed changes

tim-schilling requested a review from a team May 9, 2026 14:10

codingjoe suggested changes May 9, 2026

View reviewed changes

tim-schilling added 3 commits May 9, 2026 20:17

Switch to a proper FileResponse response.

f1c86c2

Remove extra change.

d03fec3

Convert to a NamedTuple class.

7235ab8

		}


		def _print_stats_from_function_calls(func_list: list[FunctionCall]) -> str:

		from debug_toolbar.toolbar import DebugToolbar

		app_name = APP_NAME

	@dataclass
	class ViewPathMetadata:
	class ViewPathMetadata(typing.NamedTuple):

		url_name: str


		def get_view_path_metadata(request: HttpRequest) -> ViewPathMetadata:

Conversation

JohananOppongAmoateng commented Dec 17, 2025 • edited by tim-schilling Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist:

Uh oh!

github-actions Bot commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JohananOppongAmoateng commented Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tim-schilling left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

tim-schilling left a comment

Choose a reason for hiding this comment

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!

Reviewers

Assignees

Labels

JohananOppongAmoateng commented Dec 17, 2025 •

edited by tim-schilling

Loading

github-actions Bot commented Dec 17, 2025 •

edited

Loading

JohananOppongAmoateng commented Jan 12, 2026 •

edited

Loading