File: panels.rst

package info (click to toggle)
flask-debugtoolbar 0.16.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,088 kB
  • sloc: python: 1,388; javascript: 856; makefile: 17; sh: 14
file content (110 lines) | stat: -rw-r--r-- 2,815 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
Built-In Panels
===============

Versions
--------
    flask_debugtoolbar.panels.versions.VersionDebugPanel

Shows the installed Flask version. The expanded view displays all installed packages and their versions as detected by ``setuptools``.


Time
----

    flask_debugtoolbar.panels.timer.TimerDebugPanel

Shows the time taken to process the current request. The expanded view includes the breakdown of CPU time, by user and system, wall clock time, and context switches.

.. image:: _static/screenshot-time-panel.png


HTTP Headers
------------

    flask_debugtoolbar.panels.headers.HeaderDebugPanel

Displays the HTTP headers for the current request.

.. image:: _static/screenshot-headers-panel.png


Request Vars
------------

    flask_debugtoolbar.panels.request_vars.RequestVarsDebugPanel

Displays details of the Flask request-related variables, including the view function parameters, cookies, session variables, and GET and POST variables.

.. image:: _static/screenshot-request-vars-panel.png


Config
------

    flask_debugtoolbar.panels.config_vars.ConfigVarsDebugPanel

Shows the contents of the Flask application's config dict ``app.config``.

.. image:: _static/screenshot-config-panel.png


Templates
---------

    flask_debugtoolbar.panels.template.TemplateDebugPanel

Shows information about the templates rendered for this request, and the value of the template parameters provided.

.. image:: _static/screenshot-template-panel.png


SQLAlchemy
----------

    flask_debugtoolbar.panels.sqlalchemy.SQLAlchemyDebugPanel

Shows SQL queries run during the current request.

.. note:: This panel requires using the `Flask-SQLAlchemy`_ extension in order
   to record the queries. See the Flask-SQLAlchemy
   :ref:`flasksqlalchemy:quickstart` section to configure it.

   For additional details on query recording see the
   :py:func:`~flask_sqlalchemy.get_debug_queries` documentation.

.. note:: SQL syntax highlighting requires `Pygments`_ to be installed.

.. image:: _static/screenshot-sqlalchemy-panel.png

.. _Flask-SQLAlchemy: https://flask-sqlalchemy.palletsprojects.com/

.. _Pygments: https://pygments.org/


Logging
-------

    flask_debugtoolbar.panels.logger.LoggingPanel

Displays log messages recorded during the current request.

.. image:: _static/screenshot-logger-panel.png


Route List
----------

    flask_debugtoolbar.panels.route_list.RouteListDebugPanel


Displays the Flask URL routing rules.


Profiler
--------

    flask_debugtoolbar.panels.profiler.ProfilerDebugPanel

Reports profiling data for the current request. Due to the performance overhead, profiling is disabled by default. Click the checkmark to toggle profiling on or off. After enabling the profiler, refresh the page to re-run it with profiling.

.. image:: _static/screenshot-profiler-panel.png