Bump to 0.15.0 (#251)

We've merged a number of deprecation fixes, let's get them live to our users via a new release.

.github/workflows/tests.yml

@@ -21,12 +21,12 @@ jobs:
           - {name: Linux, python: '3.12', os: ubuntu-latest, tox: py312}
           - {name: Windows, python: '3.12', os: windows-latest, tox: py312}
           - {name: Mac, python: '3.12', os: macos-latest, tox: py312}
+          - {name: Minimal, python: '3.12', os: ubuntu-latest, tox: minimal}
           - {name: '3.11', python: '3.11', os: ubuntu-latest, tox: py311}
           - {name: '3.10', python: '3.10', os: ubuntu-latest, tox: py310}
           - {name: '3.9', python: '3.9', os: ubuntu-latest, tox: py39}
           - {name: '3.8', python: '3.8', os: ubuntu-latest, tox: py38}
           - {name: '3.7', python: '3.7', os: ubuntu-latest, tox: py37}
-          - {name: '3.6', python: '3.6', os: ubuntu-20.04, tox: py36}  # ubuntu-latest doesn't support 3.6
           - {name: Style, python: '3.10', os: ubuntu-latest, tox: stylecheck}
     steps:
       - uses: actions/checkout@v4

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "docs/_themes"]
-	path = docs/_themes
-	url = https://github.com/mitsuhiko/flask-sphinx-themes.git

.readthedocs.yaml

@@ -0,0 +1,37 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-lts-latest
+  tools:
+    python: "latest"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - path: .
+      extra_requirements:
+        - docs

LICENSE

@@ -4,10 +4,10 @@ All rights reserved.
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:
 
-    1. Redistributions of source code must retain the above copyright notice, 
+    1. Redistributions of source code must retain the above copyright notice,
        this list of conditions and the following disclaimer.
-    
-    2. Redistributions in binary form must reproduce the above copyright 
+
+    2. Redistributions in binary form must reproduce the above copyright
        notice, this list of conditions and the following disclaimer in the
        documentation and/or other materials provided with the distribution.
 

docs/conf.py

@@ -37,6 +37,7 @@ BUILD_DATE = datetime.datetime.utcfromtimestamp(int(os.environ.get('SOURCE_DATE_
 extensions = [
     'sphinx.ext.viewcode',
     'sphinx.ext.intersphinx',
+    'pallets_sphinx_themes',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -112,9 +113,7 @@ html_theme = 'flask'
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-html_theme_options = {
-    'index_logo': None,
-}
+html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
 sys.path.append(os.path.abspath('_themes'))

docs/index.rst

@@ -59,6 +59,8 @@ Name                                  Description                             De
 ``DEBUG_TB_PANELS``                   List of module/class names of panels    enable all built-in panels
 ``DEBUG_TB_PROFILER_ENABLED``         Enable the profiler on all requests     ``False``, user-enabled
 ``DEBUG_TB_TEMPLATE_EDITOR_ENABLED``  Enable the template editor              ``False``
+``DEBUG_TB_PROFILER_DUMP_FILENAME``   Filename of the profiler stats dump,    ``None``, no dump will be written
+                                      can be a ``str`` or a ``callable``
 ====================================  =====================================   ==========================
 
 To change one of the config options, set it in the Flask app's config like::

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = Flask-DebugToolbar
-version = 0.14.1
+version = 0.15.0
 author = Michael van Tellingen
 author_email = michaelvantellingen@gmail.com
 maintainer = Matt Good
@@ -30,7 +30,7 @@ package_dir =
 
 packages = find:
 include_package_data = True
-python_requires = >=2.7
+python_requires = >=3.7
 
 [options.packages.find]
 where = src

setup.py

@@ -4,11 +4,17 @@ from setuptools import setup
 setup(
     name="Flask-DebugToolbar",
     install_requires=[
-        'Flask>=0.8',
+        'Flask>=2.2.0',
         'Blinker',
         'itsdangerous',
         'werkzeug',
         'MarkupSafe',
         'packaging',
     ],
+     extras_require={
+        "docs": [
+            'Sphinx>=1.2.2',
+            'Pallets-Sphinx-Themes',
+        ],
+     }
 )

src/flask_debugtoolbar/__init__.py

@@ -1,17 +1,11 @@
+import contextvars
 import os
 import urllib.parse
 import warnings
 
 import flask
-from packaging import version as version_builder
 from flask import Blueprint, current_app, request, g, send_from_directory, url_for
-
-
-if version_builder.parse(flask.__version__) >= version_builder.parse("2.2.0"):
-    from flask.globals import request_ctx
-else:
-    from flask.globals import _request_ctx_stack
-
+from flask.globals import request_ctx
 
 from jinja2 import __version__ as __jinja_version__
 from jinja2 import Environment, PackageLoader
@@ -64,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':
@@ -132,11 +128,7 @@ class DebugToolbarExtension(object):
 
     def dispatch_request(self):
         """Modified version of Flask.dispatch_request to call process_view."""
-        if version_builder.parse(flask.__version__) >= version_builder.parse("2.2.0"):
-            req = request_ctx.request
-        else:
-            req = _request_ctx_stack.top.request
-
+        req = request_ctx.request
         app = current_app
 
         if req.routing_exception is not None:
@@ -178,11 +170,11 @@ class DebugToolbarExtension(object):
             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):
@@ -191,7 +183,7 @@ class DebugToolbarExtension(object):
         """
         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
 
@@ -204,7 +196,7 @@ class DebugToolbarExtension(object):
 
     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
@@ -250,7 +242,7 @@ class DebugToolbarExtension(object):
                           ' </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)
@@ -267,7 +259,8 @@ class DebugToolbarExtension(object):
         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)

src/flask_debugtoolbar/panels/__init__.py

@@ -25,6 +25,29 @@ class DebugPanel(object):
         # If the client enabled the panel
         self.is_active = False
 
+    @classmethod
+    def init_app(cls, app):
+        """Method that can be overridden by child classes.
+        Can be used for setting up additional URL-rules/routes.
+
+        Example::
+
+            class UMLDiagramPanel(DebugPanel):
+
+                @classmethod
+                def init_app(cls, app):
+                    app.add_url_rule(
+                        '/_flask_debugtoolbar_umldiagram/<path:filename>',
+                        '_flask_debugtoolbar_umldiagram.serve_generated_image',
+                        cls.serve_generated_image
+                    )
+
+                @classmethod
+                def serve_generated_image(cls, app):
+                    return Response(...)
+        """
+        pass
+
     def render(self, template_name, context):
         template = self.jinja_env.get_template(template_name)
         return template.render(**context)

src/flask_debugtoolbar/panels/profiler.py

@@ -14,6 +14,7 @@ class ProfilerDebugPanel(DebugPanel):
     """
     Panel that displays the time a response took with cProfile output.
     """
+
     name = 'Profiler'
 
     user_activate = True
@@ -22,6 +23,9 @@ class ProfilerDebugPanel(DebugPanel):
         DebugPanel.__init__(self, jinja_env, context=context)
         if current_app.config.get('DEBUG_TB_PROFILER_ENABLED'):
             self.is_active = True
+            self.dump_filename = current_app.config.get(
+                "DEBUG_TB_PROFILER_DUMP_FILENAME"
+            )
 
     def has_content(self):
         return bool(self.profiler)
@@ -88,7 +92,14 @@ class ProfilerDebugPanel(DebugPanel):
 
             self.stats = stats
             self.function_calls = function_calls
-            # destroy the profiler just in case
+
+            if self.dump_filename:
+                if callable(self.dump_filename):
+                    filename = self.dump_filename()
+                else:
+                    filename = self.dump_filename
+                self.profiler.dump_stats(filename)
+
         return response
 
     def title(self):

src/flask_debugtoolbar/panels/sqlalchemy.py

@@ -6,10 +6,15 @@ except ImportError:
 else:
     try:
         from flask_sqlalchemy.record_queries import get_recorded_queries
+        debug_enables_record_queries = False
     except ImportError:
         # For flask_sqlalchemy < 3.0.0
         from flask_sqlalchemy import get_debug_queries as get_recorded_queries
 
+        # flask_sqlalchemy < 3.0.0 automatically enabled
+        # SQLALCHEMY_RECORD_QUERIES in debug or test mode
+        debug_enables_record_queries = True
+
         location_property = 'context'
     else:
         location_property = 'location'
@@ -62,7 +67,10 @@ def extension_used():
 
 
 def recording_enabled():
-    return (current_app.debug or current_app.config.get('SQLALCHEMY_RECORD_QUERIES'))
+    return (
+        (debug_enables_record_queries and current_app.debug) or
+        current_app.config.get('SQLALCHEMY_RECORD_QUERIES')
+    )
 
 
 def is_available():

src/flask_debugtoolbar/panels/versions.py

@@ -1,22 +1,22 @@
 import os
-from distutils.sysconfig import get_python_lib
+from sysconfig import get_path
 
-from flask import __version__ as flask_version
 from flask_debugtoolbar.panels import DebugPanel
 
+try:
+    # Python 3.8+
+    from importlib.metadata import version
+
+    flask_version = version('flask')
+
+except ImportError:
+    import pkg_resources
+
+    flask_version = pkg_resources.get_distribution('flask').version
+
 _ = lambda x: x
 
 
-def relpath(location, python_lib):
-    location = os.path.normpath(location)
-    relative = os.path.relpath(location, python_lib)
-    if relative == os.path.curdir:
-        return ''
-    elif relative.startswith(os.path.pardir):
-        return location
-    return relative
-
-
 class VersionDebugPanel(DebugPanel):
     """
     Panel that displays the Flask version.
@@ -38,15 +38,14 @@ class VersionDebugPanel(DebugPanel):
 
     def content(self):
         try:
-            import pkg_resources
+            import importlib.metadata
         except ImportError:
             packages = []
         else:
-            packages = sorted(pkg_resources.working_set,
-                              key=lambda p: p.project_name.lower())
+            packages_metadata = [p.metadata for p in importlib.metadata.distributions()]
+            packages = sorted(packages_metadata, key=lambda p: p['Name'].lower())
 
         return self.render('panels/versions.html', {
             'packages': packages,
-            'python_lib': os.path.normpath(get_python_lib()),
-            'relpath': relpath,
+            'python_lib_dir': os.path.normpath(get_path('platlib')),
         })

src/flask_debugtoolbar/static/js/toolbar.js

@@ -7,7 +7,7 @@
     init: function() {
       $('#flDebug').show();
       var current = null;
-      $('#flDebugPanelList li a').click(function() {
+      $('#flDebugPanelList li a').on('click', function() {
         if (!this.className) {
           return false;
         }
@@ -23,7 +23,7 @@
         }
         return false;
       });
-      $('#flDebugPanelList li .flDebugSwitch').click(function() {
+      $('#flDebugPanelList li .flDebugSwitch').on('click', function() {
         var $panel = $(this).parent();
         var $this = $(this);
         var dom_id = $panel.attr('id');
@@ -52,12 +52,12 @@
           });
         }
       });
-      $('#flDebug a.flDebugClose').click(function() {
+      $('#flDebug a.flDebugClose').on('click', function() {
         $(document).trigger('close.flDebug');
         $('#flDebugToolbar li').removeClass('flDebugActive');
         return false;
       });
-      $('#flDebug a.flDebugRemoteCall').click(function() {
+      $('#flDebug a.flDebugRemoteCall').on('click', function() {
         $('#flDebugWindow').load(this.href, {}, function() {
           $('#flDebugWindow a.flDebugBack').click(function() {
             $(this).parent().parent().hide();
@@ -67,24 +67,24 @@
         $('#flDebugWindow').show();
         return false;
       });
-      $('#flDebugTemplatePanel a.flDebugTemplateShowContext').click(function() {
+      $('#flDebugTemplatePanel a.flDebugTemplateShowContext').on('click', function() {
         fldt.toggle_arrow($(this).children('.flDebugToggleArrow'))
         fldt.toggle_content($(this).parent().next());
         return false;
       });
-      $('#flDebugSQLPanel a.flDebugShowStacktrace').click(function() {
+      $('#flDebugSQLPanel a.flDebugShowStacktrace').on('click', function() {
         fldt.toggle_content($('.flDebugHideStacktraceDiv', $(this).parents('tr')));
         return false;
       });
-      $('#flDebugHideToolBarButton').click(function() {
+      $('#flDebugHideToolBarButton').on('click', function() {
         fldt.hide_toolbar(true);
         return false;
       });
-      $('#flDebugShowToolBarButton').click(function() {
+      $('#flDebugShowToolBarButton').on('click', function() {
         fldt.show_toolbar();
         return false;
       });
-      $(document).bind('close.flDebug', function() {
+      $(document).on('close.flDebug', function() {
         // If a sub-panel is open, close that
         if ($('#flDebugWindow').is(':visible')) {
           $('#flDebugWindow').hide();
@@ -153,7 +153,7 @@
     },
     show_toolbar: function(animate) {
       // Set up keybindings
-      $(document).bind('keydown.flDebug', function(e) {
+      $(document).on('keydown.flDebug', function(e) {
         if (e.keyCode == 27) {
           fldt.close();
         }

src/flask_debugtoolbar/templates/base.html

@@ -1,6 +1,8 @@
 <div id="flDebug" style="display:none;" role="navigation">
   <script type="text/javascript">var DEBUG_TOOLBAR_STATIC_PATH = '{{ static_path }}'</script>
   <script type="text/javascript" src="{{ static_path }}js/jquery.js"></script>
+  <!-- Temporarily adding jquery-migrate during the Jquery upgrade process, this can be removed post-upgrade -->
+  <script src="{{ static_path }}js/jquery-migrate.js"></script>
   <script type="text/javascript" src="{{ static_path }}js/jquery.tablesorter.js"></script>
   <script type="text/javascript" src="{{ static_path }}js/toolbar.js"></script>
 

src/flask_debugtoolbar/templates/panels/config_vars.html

@@ -13,4 +13,4 @@
             </tr>
         {% endfor %}
     </tbody>
-</table>
+</table>

src/flask_debugtoolbar/templates/panels/logger.html

@@ -22,5 +22,3 @@
 {% else %}
   <p>No messages logged.</p>
 {% endif %}
-
-

src/flask_debugtoolbar/templates/panels/profiler.html

@@ -21,4 +21,4 @@
       </tr>
     {% endfor %}
   </tbody>
-</table>
+</table>

src/flask_debugtoolbar/templates/panels/template_editor.html

@@ -10,6 +10,8 @@
   <meta name="viewport" content="width=device-width,initial-scale=1">
   <title>Editing {{ templates[0].name }}</title>
   <script src="{{ static_path }}js/jquery.js"></script>
+  <!-- Temporarily adding jquery-migrate during the Jquery upgrade process, this can be removed post-upgrade -->
+  <script src="{{ static_path }}js/jquery-migrate.js"></script>
   <link rel="stylesheet" href="{{ static_path }}codemirror/codemirror.css">
   <link rel="stylesheet" href="{{ static_path }}codemirror/theme/rubyblue.css">
   <link rel="stylesheet" href="{{ static_path }}codemirror/theme/lesser-dark.css">
@@ -116,7 +118,7 @@
         delay = setTimeout(updatePreview, 300);
       }
     });
-    
+
     var previewFrame = document.getElementById('flDebugPreview');
     var preview = previewFrame.contentDocument || previewFrame.contentWindow.document;
     var errorLine = null;

src/flask_debugtoolbar/templates/panels/timer.html

@@ -18,4 +18,3 @@
     {% endfor %}
   </tbody>
 </table>
-

src/flask_debugtoolbar/templates/panels/versions.html

@@ -1,10 +1,10 @@
 <h4>Installed Packages</h4>
 
 <p>
-  Installation paths relative to:
+  Current Site Packages Directory:
 </p>
 <pre>
-{{ python_lib }}
+{{ python_lib_dir }}
 </pre>
 
 <table>
@@ -12,21 +12,23 @@
     <tr>
       <th>Package</th>
       <th>Version</th>
-      <th>Installed Path</th>
+      <th>Homepage</th>
+      <th>Summary</th>
     </tr>
   </thead>
   <tbody>
     {% for package in packages %}
       <tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
-        <td>{{ package.project_name }}</td>
-        <td>{{ package.version }}</td>
-        <td>{{ relpath(package.location, python_lib) }}</td>
+        <td>{{ package.get('Name') }}</td>
+        <td>{{ package.get('Version') }}</td>
+        <td>{{ package.get('Home-page') }}</td>
+        <td>{{ package.get('Summary') }}</td>
       </tr>
     {% else %}
       <tr>
-        <td>setuptools</td>
+        <td>Python 3.8</td>
         <td>NOT INSTALLED</td>
-        <td>Install setuptools to display installed packages and version information</td>
+        <td>This panel requires Python >= 3.8 in order to display installed packages and version information.</td>
       </tr>
     {% endfor %}
   </tbody>

src/flask_debugtoolbar/toolbar.py

@@ -48,8 +48,8 @@ class DebugToolbar(object):
     @classmethod
     def load_panels(cls, app):
         for panel_class in cls._iter_panels(app):
-            # just loop to make sure they've been loaded
-            pass
+            # Call `.init_app()` on panels
+            panel_class.init_app(app)
 
     @classmethod
     def _iter_panels(cls, app):

test/templates/basic_app.html

@@ -1,4 +1,4 @@
 <!doctype html>
 <html>
   <body>Hello world</body>
-</html>
+</html>

test/test_toolbar.py

@@ -1,7 +1,5 @@
 import sys
 
-import pytest
-
 from flask_debugtoolbar import _printable
 
 
@@ -16,26 +14,3 @@ def test_basic_app():
     index = app.get('/')
     assert index.status_code == 200
     assert b'<div id="flDebug"' in index.data
-
-
-@pytest.mark.skipif(sys.version_info >= (3,),
-                    reason='test only applies to Python 2')
-def test_printable_unicode():
-    class UnicodeRepr(object):
-        def __repr__(self):
-            return u'\uffff'
-
-    printable = _printable(UnicodeRepr())
-    assert "raised UnicodeEncodeError: 'ascii' codec" in printable
-
-
-@pytest.mark.skipif(sys.version_info >= (3,),
-                    reason='test only applies to Python 2')
-def test_printable_non_ascii():
-    class NonAsciiRepr(object):
-        def __repr__(self):
-            return 'a\xffb'
-
-    printable = u'%s' % _printable(NonAsciiRepr())
-    # should replace \xff with the unicode ? character
-    assert printable == u'a\ufffdb'

tox.ini

@@ -1,8 +1,8 @@
 [tox]
 envlist =
-    py27
-    py3{12,11,10,9,8,7,6}
+    py3{12,11,10,9,8,7}
     stylecheck
+    minimal
 skip_missing_interpreters = True
 
 [testenv]
@@ -13,6 +13,12 @@ deps =
 commands =
     pytest
 
+[testenv:minimal]
+deps =
+    .
+commands =
+    python -c "from flask_debugtoolbar import DebugToolbarExtension"
+
 [testenv:stylecheck]
 deps =
     pycodestyle