Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support applications using flask.copy_current_request_context #231

Merged
merged 2 commits into from Jan 17, 2024
Merged

Support applications using flask.copy_current_request_context #231

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4a8cc9
Support applications using flask.copy_current_request_context
Jan 9, 2024
765f221
Handle cases when debug toolbar has not been installed
Jan 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 12 additions & 8 deletions src/flask_debugtoolbar/__init__.py
View file
Open in desktop
@@ -1,3 +1,4 @@
import contextvars
import os
import urllib.parse
import warnings
Expand Down Expand Up @@ -57,7 +58,9 @@ class DebugToolbarExtension(object):

def __init__(self, app=None):
self.app = app
self.debug_toolbars = {}
# Support threads running `flask.copy_current_request_context` without
# poping toolbar during `teardown_request`
self.debug_toolbars_var = contextvars.ContextVar('debug_toolbars')
jinja_extensions = ['jinja2.ext.i18n']

if __jinja_version__[0] == '2':
Expand Down Expand Up @@ -167,11 +170,11 @@ def process_request(self):
return

real_request = request._get_current_object()

self.debug_toolbars[real_request] = (
self.debug_toolbars_var.set({})
self.debug_toolbars_var.get()[real_request] = (
DebugToolbar(real_request, self.jinja_env))

for panel in self.debug_toolbars[real_request].panels:
for panel in self.debug_toolbars_var.get()[real_request].panels:
panel.process_request(real_request)

def process_view(self, app, view_func, view_kwargs):
Expand All @@ -180,7 +183,7 @@ def process_view(self, app, view_func, view_kwargs):
"""
real_request = request._get_current_object()
try:
toolbar = self.debug_toolbars[real_request]
toolbar = self.debug_toolbars_var.get({})[real_request]
except KeyError:
return view_func

Expand All @@ -193,7 +196,7 @@ def process_view(self, app, view_func, view_kwargs):

def process_response(self, response):
real_request = request._get_current_object()
if real_request not in self.debug_toolbars:
if real_request not in self.debug_toolbars_var.get():
return response

# Intercept http redirect codes and display an html page with a
Expand Down Expand Up @@ -239,7 +242,7 @@ def process_response(self, response):
' </body> tag not found in response.')
return response

toolbar = self.debug_toolbars[real_request]
toolbar = self.debug_toolbars_var.get()[real_request]

for panel in toolbar.panels:
panel.process_response(real_request, response)
Expand All @@ -256,7 +259,8 @@ def process_response(self, response):
return response

def teardown_request(self, exc):
self.debug_toolbars.pop(request._get_current_object(), None)
# debug_toolbars_var won't be set under `flask.copy_current_request_context`
self.debug_toolbars_var.get({}).pop(request._get_current_object(), None)

def render(self, template_name, context):
template = self.jinja_env.get_template(template_name)
Expand Down