fix: respect PYINSTRUMENT_SHOW_CALLBACK when PYINSTRUMENT_PROFILE_DIR is set

[Sanjays2402]

Closes #342

The Django middleware's condition was (show_pyinstrument(request) and url_argument in request.GET) or profile_dir, so as soon as PYINSTRUMENT_PROFILE_DIR was set every request was profiled and PYINSTRUMENT_SHOW_CALLBACK was ignored. The callback now gates both branches, so it can be used to select which requests get written to the profile directory. Regression test fails on main (assert not hasattr(request, "profiler")) and passes with the fix.

[joerick]

Looks good. Thanks.

I really like how the test is written. If you had time to make a few more tests like this for Django and check it was all run in CI that would be great!

[Copilot]

Pull request overview

This PR fixes the Django ProfilerMiddleware gating logic so PYINSTRUMENT_SHOW_CALLBACK is respected even when PYINSTRUMENT_PROFILE_DIR is set, allowing users to selectively record requests to disk.

Changes:

• Update Django middleware condition so PYINSTRUMENT_SHOW_CALLBACK gates both URL-argument profiling and profile-dir recording.
• Add regression tests covering callback behavior when PYINSTRUMENT_PROFILE_DIR is configured.
• Document that PYINSTRUMENT_SHOW_CALLBACK also applies to profile-dir output.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
pyinstrument/middleware.py	Fix conditional so the show callback controls profiling even with PYINSTRUMENT_PROFILE_DIR.
test/test_django_middleware.py	Add regression tests to ensure callback is respected with profile-dir profiling enabled.
docs/guide.md	Clarify documentation about callback behavior when profile-dir output is enabled.

Comments suppressed due to low confidence (1)

test/test_django_middleware.py:48

• Same portability/flake issue here: using a shared hard-coded /tmp/... path can break on non-POSIX platforms and when tests run concurrently. Prefer tmp_path to get an isolated directory for this test.

def test_profile_dir_still_profiles_when_callback_allows():
    from django.test import override_settings

    with override_settings(
        PYINSTRUMENT_PROFILE_DIR="/tmp/pyinstrument-test-profiles",
        PYINSTRUMENT_SHOW_CALLBACK=lambda request: True,
    ):

---

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

[joerick]

+1 to the copilot comment and once the formatter is happy we can get it in.

[Sanjays2402]

Both done in a2e224d.

Switched the two tests to pytest's tmp_path (passed to override_settings as str(tmp_path)) instead of the hard-coded /tmp/pyinstrument-test-profiles, so they're isolated per-test and work on Windows.

The formatter complaint was black wanting the process_request condition on one line rather than split across two — ran black and isort over the touched files.

$ python -m pytest test/test_django_middleware.py -q
..                                                                       [100%]
2 passed in 3.34s

$ black --check test/test_django_middleware.py pyinstrument/middleware.py
All done! 2 files would be left unchanged.

Note test_cmdline.py and test_ipython_magic.py are also flagged by the current black version, but they're untouched by this PR so I left them alone.

[joerick]

thanks!