98 | 99 | Exception example 100 |
101 | 102 | 103 | """ 104 | # install jinja2 templates 105 | loader = jinja2.DictLoader({'index.html': template}) 106 | aiohttp_jinja2.setup(app, loader=loader) 107 | 108 | # init routes for index page, and page with error 109 | app.router.add_route('GET', '/', basic_handler, name='index') 110 | app.router.add_route('GET', '/exc', exception_handler, 111 | name='exc_example') 112 | return app 113 | 114 | 115 | loop = asyncio.get_event_loop() 116 | app = loop.run_until_complete(init(loop)) 117 | web.run_app(app, host='127.0.0.1', port=9000) 118 | 119 | Settings 120 | -------- 121 | .. code:: python 122 | 123 | aiohttp_debugtoolbar.setup(app, hosts=['172.19.0.1', ]) 124 | 125 | Supported options 126 | 127 | 128 | - enabled: The debugtoolbar is disabled if False. By default is set to True. 129 | - intercept_redirects: If True, intercept redirect and display an intermediate page with a link to the redirect page. By default is set to True. 130 | - hosts: The list of allow hosts. By default is set to ['127.0.0.1', '::1']. 131 | - exclude_prefixes: The list of forbidden hosts. By default is set to []. 132 | - check_host: If False, disable the host check and display debugtoolbar for any host. By default is set to True. 133 | - max_request_history: The max value for storing requests. By default is set to 100. 134 | - max_visible_requests: The max value of display requests. By default is set to 10. 135 | - path_prefix: The prefix of path to debugtoolbar. By default is set to '/_debugtoolbar'. 136 | 137 | 138 | Thanks! 139 | ------- 140 | 141 | I've borrowed a lot of code from following projects. I highly 142 | recommend to check them out: 143 | 144 | * pyramid_debugtoolbar_ 145 | * django-debug-toolbar_ 146 | * flask-debugtoolbar_ 147 | 148 | Play With Demo 149 | -------------- 150 | 151 | https://github.com/aio-libs/aiohttp_debugtoolbar/tree/master/demo 152 | 153 | Requirements 154 | ------------ 155 | 156 | * aiohttp_ 157 | * aiohttp_jinja2_ 158 | 159 | 160 | .. _Python: https://www.python.org 161 | .. _asyncio: http://docs.python.org/3/library/asyncio.html 162 | .. _aiohttp: https://github.com/KeepSafe/aiohttp 163 | .. _aiopg: https://github.com/aio-libs/aiopg 164 | .. _aiomysql: https://github.com/aio-libs/aiomysql 165 | .. _aiohttp_jinja2: https://github.com/aio-libs/aiohttp_jinja2 166 | .. _pyramid_debugtoolbar: https://github.com/Pylons/pyramid_debugtoolbar 167 | .. _django-debug-toolbar: https://github.com/django-debug-toolbar/django-debug-toolbar 168 | .. _flask-debugtoolbar: https://github.com/mgood/flask-debugtoolbar 169 | -------------------------------------------------------------------------------- /aiohttp_debugtoolbar/__init__.py: -------------------------------------------------------------------------------- 1 | from .main import setup 2 | from .middlewares import middleware 3 | from .utils import APP_KEY 4 | 5 | __version__ = "0.6.1" 6 | 7 | __all__ = ("setup", "middleware", "APP_KEY") 8 | -------------------------------------------------------------------------------- /aiohttp_debugtoolbar/main.py: -------------------------------------------------------------------------------- 1 | import secrets 2 | from pathlib import Path 3 | from typing import Iterable, Literal, Sequence, Type, TypedDict, Union 4 | 5 | import aiohttp_jinja2 6 | import jinja2 7 | from aiohttp import web 8 | 9 | from . import panels, views 10 | from .middlewares import middleware 11 | from .panels.base import DebugPanel 12 | from .utils import ( 13 | APP_KEY, 14 | AppState, 15 | ExceptionHistory, 16 | STATIC_ROUTE_NAME, 17 | TEMPLATE_KEY, 18 | ToolbarStorage, 19 | _Config, 20 | ) 21 | from .views import ExceptionDebugView 22 | 23 | default_panel_names = ( 24 | panels.HeaderDebugPanel, 25 | panels.PerformanceDebugPanel, 26 | panels.RequestVarsDebugPanel, 27 | panels.TracebackPanel, 28 | panels.LoggingPanel, 29 | ) 30 | 31 | 32 | default_global_panel_names = ( 33 | panels.RoutesDebugPanel, 34 | panels.SettingsDebugPanel, 35 | panels.MiddlewaresDebugPanel, 36 | panels.VersionDebugPanel, 37 | ) 38 | 39 | 40 | class _AppDetails(TypedDict): 41 | exc_history: ExceptionHistory 42 | pdtb_token: str 43 | request_history: ToolbarStorage 44 | settings: _Config 45 | 46 | 47 | def setup( 48 | app: web.Application, 49 | *, 50 | enabled: bool = True, 51 | intercept_exc: Literal["debug", "display", False] = "debug", 52 | intercept_redirects: bool = True, 53 | panels: Iterable[Type[DebugPanel]] = default_panel_names, 54 | extra_panels: Iterable[Type[DebugPanel]] = (), 55 | extra_templates: Union[str, Path, Iterable[Union[str, Path]]] = (), 56 | global_panels: Iterable[Type[DebugPanel]] = default_global_panel_names, 57 | hosts: Sequence[str] = ("127.0.0.1", "::1"), 58 | exclude_prefixes: Iterable[str] = (), 59 | check_host: bool = True, # disable host check 60 | button_style: str = "", 61 | max_request_history: int = 100, 62 | max_visible_requests: int = 10, 63 | path_prefix: str = "/_debugtoolbar", 64 | ) -> None: 65 | config = _Config( 66 | enabled=enabled, 67 | intercept_exc=intercept_exc, 68 | intercept_redirects=intercept_redirects, 69 | panels=tuple(panels), 70 | extra_panels=tuple(extra_panels), 71 | global_panels=tuple(global_panels), 72 | hosts=hosts, 73 | exclude_prefixes=tuple(exclude_prefixes), 74 | check_host=check_host, 75 | button_style=button_style, 76 | max_visible_requests=max_visible_requests, 77 | path_prefix=path_prefix, 78 | ) 79 | 80 | if middleware not in app.middlewares: 81 | app.middlewares.append(middleware) 82 | 83 | APP_ROOT = Path(__file__).parent 84 | templates_app = APP_ROOT / "templates" 85 | templates_panels = APP_ROOT / "panels/templates" 86 | 87 | if isinstance(extra_templates, (str, Path)): 88 | templ: Iterable[Union[str, Path]] = (extra_templates,) 89 | else: 90 | templ = extra_templates 91 | loader = jinja2.FileSystemLoader((templates_app, templates_panels, *templ)) 92 | aiohttp_jinja2.setup(app, loader=loader, app_key=TEMPLATE_KEY) 93 | 94 | static_location = APP_ROOT / "static" 95 | 96 | exc_handlers = ExceptionDebugView() 97 | 98 | app.router.add_static( 99 | path_prefix + "/static", static_location, name=STATIC_ROUTE_NAME 100 | ) 101 | 102 | app.router.add_route( 103 | "GET", path_prefix + "/source", exc_handlers.source, name="debugtoolbar.source" 104 | ) 105 | app.router.add_route( 106 | "GET", 107 | path_prefix + "/execute", 108 | exc_handlers.execute, 109 | name="debugtoolbar.execute", 110 | ) 111 | # app.router.add_route('GET', path_prefix + '/console', 112 | # exc_handlers.console, 113 | # name='debugtoolbar.console') 114 | app.router.add_route( 115 | "GET", 116 | path_prefix + "/exception", 117 | exc_handlers.exception, 118 | name="debugtoolbar.exception", 119 | ) 120 | # TODO: fix when sql will be ported 121 | # app.router.add_route('GET', path_prefix + '/sqlalchemy/sql_select', 122 | # name='debugtoolbar.sql_select') 123 | # app.router.add_route('GET', path_prefix + '/sqlalchemy/sql_explain', 124 | # name='debugtoolbar.sql_explain') 125 | 126 | app.router.add_route( 127 | "GET", path_prefix + "/sse", views.sse, name="debugtoolbar.sse" 128 | ) 129 | 130 | app.router.add_route( 131 | "GET", 132 | path_prefix + "/{request_id}", 133 | views.request_view, 134 | name="debugtoolbar.request", 135 | ) 136 | app.router.add_route( 137 | "GET", path_prefix, views.request_view, name="debugtoolbar.main" 138 | ) 139 | 140 | app[APP_KEY] = AppState( 141 | { 142 | "exc_history": ExceptionHistory(), 143 | "pdtb_token": secrets.token_hex(10), 144 | "request_history": ToolbarStorage(max_request_history), 145 | "settings": config, 146 | } 147 | ) 148 | if intercept_exc: 149 | app[APP_KEY]["exc_history"].eval_exc = intercept_exc == "debug" 150 | -------------------------------------------------------------------------------- /aiohttp_debugtoolbar/middlewares.py: -------------------------------------------------------------------------------- 1 | import sys 2 | 3 | import aiohttp_jinja2 4 | from aiohttp import web 5 | from aiohttp.typedefs import Handler 6 | from aiohttp.web_exceptions import HTTPMove 7 | 8 | from .tbtools.tbtools import get_traceback 9 | from .toolbar import DebugToolbar 10 | from .utils import ( 11 | APP_KEY, 12 | ContextSwitcher, 13 | REDIRECT_CODES, 14 | TEMPLATE_KEY, 15 | addr_in, 16 | hexlify, 17 | ) 18 | 19 | __all__ = ("middleware",) 20 | HTML_TYPES = ("text/html", "application/xhtml+xml") 21 | 22 | 23 | @web.middleware 24 | async def middleware(request: web.Request, handler: Handler) -> web.StreamResponse: 25 | app = request.app 26 | 27 | if APP_KEY not in app: 28 | raise RuntimeError( 29 | "Please setup debug toolbar with " "aiohttp_debugtoolbar.setup method" 30 | ) 31 | 32 | # just create namespace for handler 33 | settings = app[APP_KEY]["settings"] 34 | request_history = app[APP_KEY]["request_history"] 35 | exc_history = app[APP_KEY]["exc_history"] 36 | intercept_exc = app[APP_KEY]["settings"]["intercept_exc"] 37 | 38 | if not app[APP_KEY]["settings"]["enabled"]: 39 | return await handler(request) 40 | 41 | # request['exc_history'] = exc_history 42 | panel_classes = settings.get("panels", ()) + settings.get("extra_panels", ()) 43 | global_panel_classes = settings.get("global_panels", ()) 44 | hosts = settings.get("hosts", []) 45 | 46 | show_on_exc_only = settings.get("show_on_exc_only") 47 | intercept_redirects = settings["intercept_redirects"] 48 | 49 | root_url = app.router["debugtoolbar.main"].url_for().raw_path 50 | exclude_prefixes = settings.get("exclude_prefixes", ()) 51 | exclude = (root_url,) + exclude_prefixes 52 | 53 | p = request.raw_path 54 | starts_with_excluded = list(filter(None, map(p.startswith, exclude))) 55 | 56 | # FIXME: error when run trough unixsocket 57 | if request.transport: 58 | peername = request.transport.get_extra_info("peername") 59 | last_proxy_addr = peername[0] 60 | else: 61 | last_proxy_addr = "" 62 | 63 | # TODO: rethink access policy by host 64 | if settings.get("check_host"): 65 | if starts_with_excluded or not addr_in(last_proxy_addr, hosts): 66 | return await handler(request) 67 | 68 | toolbar = DebugToolbar(request, panel_classes, global_panel_classes) 69 | _handler = handler 70 | 71 | context_switcher = ContextSwitcher() 72 | for panel in toolbar.panels: 73 | _handler = panel.wrap_handler(_handler, context_switcher) 74 | 75 | try: 76 | response = await context_switcher(_handler(request)) 77 | except HTTPMove as exc: 78 | if not intercept_redirects: 79 | raise 80 | # Intercept http redirect codes and display an html page with a 81 | # link to the target. 82 | if not getattr(exc, "location", None): 83 | raise 84 | response = web.Response( 85 | status=exc.status, reason=exc.reason, text=exc.text, headers=exc.headers 86 | ) 87 | 88 | context = {"redirect_to": exc.location, "redirect_code": exc.status} 89 | 90 | _response = aiohttp_jinja2.render_template( 91 | "redirect.jinja2", request, context, app_key=TEMPLATE_KEY 92 | ) 93 | response = _response 94 | except web.HTTPException: 95 | raise 96 | except Exception as e: 97 | if intercept_exc: 98 | tb = get_traceback( 99 | info=sys.exc_info(), 100 | skip=1, 101 | show_hidden_frames=False, 102 | ignore_system_exceptions=True, 103 | exc=e, 104 | app=request.app, 105 | ) 106 | for frame in tb.frames: 107 | exc_history.frames[frame.id] = frame 108 | exc_history.tracebacks[tb.id] = tb 109 | request["pdbt_tb"] = tb 110 | 111 | # TODO: find out how to port following to aiohttp 112 | # or just remove it 113 | # token = request.app[APP_KEY]['pdtb_token'] 114 | # qs = {'token': token, 'tb': str(tb.id)} 115 | # msg = 'Exception at %s\ntraceback url: %s' 116 | # 117 | # exc_url = request.app.router['debugtoolbar.exception']\ 118 | # .url(query=qs) 119 | # assert exc_url, msg 120 | # exc_msg = msg % (request.path, exc_url) 121 | # logger.exception(exc_msg) 122 | 123 | # subenviron = request.environ.copy() 124 | # del subenviron['PATH_INFO'] 125 | # del subenviron['QUERY_STRING'] 126 | # subrequest = type(request).blank(exc_url, subenviron) 127 | # subrequest.script_name = request.script_name 128 | # subrequest.path_info = \ 129 | # subrequest.path_info[len(request.script_name):] 130 | # 131 | # response = request.invoke_subrequest(subrequest) 132 | body = tb.render_full(request).encode("utf-8", "replace") 133 | response = web.Response(body=body, status=500, content_type="text/html") 134 | 135 | await toolbar.process_response(request, response) 136 | 137 | request["id"] = str(id(request)) 138 | toolbar.status = response.status 139 | 140 | request_history.put(request["id"], toolbar) 141 | toolbar.inject(request, response) 142 | return response 143 | else: 144 | # logger.exception('Exception at %s' % request.path) 145 | raise e 146 | toolbar.status = response.status 147 | if intercept_redirects: 148 | # Intercept http redirect codes and display an html page with a 149 | # link to the target. 150 | if response.status in REDIRECT_CODES and getattr(response, "location", None): 151 | context = { 152 | "redirect_to": response.location, 153 | "redirect_code": response.status, 154 | } 155 | 156 | _response = aiohttp_jinja2.render_template( 157 | "redirect.jinja2", request, context, app_key=TEMPLATE_KEY 158 | ) 159 | response = _response 160 | 161 | await toolbar.process_response(request, response) 162 | request["id"] = hexlify(id(request)) 163 | 164 | # Don't store the favicon.ico request 165 | # it's requested by the browser automatically 166 | # Also ignore requests for debugtoolbar itself. 167 | tb_request = request.path.startswith(settings["path_prefix"]) 168 | if not tb_request and request.path != "/favicon.ico": 169 | request_history.put(request["id"], toolbar) 170 | 171 | if not show_on_exc_only and response.content_type in HTML_TYPES: 172 | toolbar.inject(request, response) 173 | 174 | return response 175 | 176 | 177 | toolbar_html_template = """\ 178 | 185 | 186 || Key | 10 |Value | 11 |
|---|---|
| {{ key }} | 17 |{{ value }} | 18 |
| Key | 32 |Value | 33 |
|---|---|
| {{ key }} | 39 |{{ value }} | 40 |
| Level | 6 |Time | 7 |Message | 8 |Location | 9 |
|---|---|---|---|
| {{ record['level'] }} | 15 |{{ record['time'] }} | 16 |{{ record['message'] }} | 17 |{{record['file']}}:{{record['line']}} | 18 |
No messages logged.
24 | {% endif %} 25 | -------------------------------------------------------------------------------- /aiohttp_debugtoolbar/panels/templates/middlewares.jinja2: -------------------------------------------------------------------------------- 1 || Order (from server to application) | 5 |Middleware | 6 |
|---|---|
| {{ i }} | 12 |{{ middleware }} | 13 |
| Resource | 10 |Value | 11 |
|---|---|
| {{ key }} | 17 |{{ value }} | 18 |
Resource statistics have been disabled. This is because the 'resource' 24 | module could not be found. This module is not supported under Windows.
25 | {% endif %} 26 | 27 |Times in milliseconds
30 || Calls | 34 |Total | 35 |Percall | 36 |Cumu | 37 |CumuPer | 38 |Func | 39 |
|---|---|---|---|---|---|
| {{ row['ncalls'] }} | 45 |{{ '%.4f' % row['tottime'] }} | 46 |{{ '%.4f' % row['percall'] }} | 47 |{{ '%.4f' % row['cumtime'] }} | 48 |{{ '%.4f' % row['percall_cum'] }} | 49 |{{ row['filename']|e }} | 50 |
The profiler is not activated. Activate the checkbox in the toolbar to use it.
56 | {% endif %} 57 | -------------------------------------------------------------------------------- /aiohttp_debugtoolbar/panels/templates/request_vars.jinja2: -------------------------------------------------------------------------------- 1 || Variable | 11 |Value | 12 |
|---|---|
| {{ key }} | 18 |{{ value }} | 19 |
No cookie data
25 | {% endif %} 26 | 27 || Variable | 37 |Value | 38 |
|---|---|
| {{ key }} | 44 |{{ value }} | 45 |
No session data
51 | {% endif %} 52 | 53 || Variable | 63 |Value | 64 |
|---|---|
| {{ key }} | 70 |{{ ', '.join(value) }} | 71 |
No GET data
77 | {% endif %} 78 | 79 || Variable | 89 |Value | 90 |
|---|---|
| {{ key }} | 96 |{{ value }} | 97 |
No POST data
103 | {% endif %} 104 | 105 || Attribute | 115 |Value | 116 |
|---|---|
| {{ key }} | 122 |{{ value }} | 123 |
No request attributes
129 | {% endif %} 130 | -------------------------------------------------------------------------------- /aiohttp_debugtoolbar/panels/templates/routes.jinja2: -------------------------------------------------------------------------------- 1 || Route Name | 5 |Method | 6 |Route Info | 7 |View Callable | 8 |
|---|---|---|---|
| {{ route_info['name'] }} | 14 |{{ route_info['method'] }} | 15 |
16 |
|
22 |
23 |
24 |
35 | {{ route_info['handler']|e }}
25 |
26 |
33 |
34 |
36 |
38 | |
39 |
| Key | 5 |Value | 6 |
|---|---|
| {{ key }} | 12 |{{ value|e }} | 13 |
| {{ h.upper() }} | 24 | {% endfor %} 25 |
|---|
| {{ column.replace(' ', ' ') }} | 32 | {% endfor %} 33 |
| {{ h.upper() }} | 25 | {% endfor %} 26 |
|---|
| {{ column }} | 33 | {% endfor %} 34 |
Empty set
40 | {% endif %] 41 |{{ exception }}
6 | 11 | 12 | This is the Copy/Paste friendly version of the traceback. 13 |
14 | 16 |20 | Warning: this feature should not be enabled on production 21 | systems. 22 |
23 | 24 | {% if evalex %} 25 |26 | 27 | Hover over any gray area in the traceback and click on the 28 | 31 | button on the right hand side of that gray area to show an interactive 32 | console for the associated frame. Type arbitrary Python into the 33 | console; it will be evaluated in the context of the associated frame. In 34 | the interactive console there are helpers available for introspection: 35 | 36 |
dump() shows all variables in the frame
38 | dump(obj) dumps all that's known about the object
39 | 44 | Hover over any gray area in the traceback and click on 45 | 48 | on the right hand side of that gray area to show the source of the file 49 | associated with the frame. 50 |
51 | 52 |53 | Click on the traceback header to switch back and forth between the 54 | rendered version of the traceback and a plaintext copy-paste-friendly 55 | version of the traceback. 56 |
57 | 58 |59 | URL to recover this traceback page: {{ url }} 60 |
61 || Package Name | 12 |Version | 13 |Dependencies | 14 |
|---|---|---|
| {{ package['name'] }} | 20 |{{ package['version'] }} | 21 |22 | {{ package['dependencies']|join(', ') }} 23 | | 24 |
'
77 | + data.source + 'To switch between the interactive traceback and the plaintext ' + 112 | 'one, you can click on the "Traceback" headline. From the text ' + 113 | 'traceback you can also create a paste of it. ' + (!window.EVALEX ? '' : 114 | 'For code execution mouse-over the frame you want to debug and ' + 115 | 'click on the console icon on the right side.' + 116 | '
You can execute arbitrary Python code in the stack frames and ' + 117 | 'there are some extra helpers available for introspection:' + 118 | '
dump() shows all variables in the frame' +
119 | 'dump(obj) dumps all that\'s known about the object').text(plainTraceback.text()));
151 |
152 | /**
153 | * Helper function for shell initialization
154 | */
155 | function openShell(consoleNode, target, frameID) {
156 | if (consoleNode)
157 | return consoleNode.slideToggle('fast');
158 | consoleNode = $('')
159 | .appendTo(target.parent())
160 | .hide()
161 | var historyPos = 0, history = [''];
162 | var output = $('[console ready]')
163 | .appendTo(consoleNode);
164 | var form = $('')
165 | .submit(function() {
166 | var cmd = command.val();
167 | $.get(window.DEBUG_TOOLBAR_ROOT_PATH + '/execute', {
168 | cmd: cmd, frm: frameID, token:window.DEBUGGER_TOKEN}, function(data) {
169 | var tmp = $('{{ exception }}
31 | 36 | 37 | This is the Copy/Paste friendly version of the traceback. 38 |
39 | 41 |{{ exception }}
45 | 49 | Warning: this feature should not be enabled on production 50 | systems. 51 |
52 | 53 | {% if evalex %} 54 |55 | 56 | Hover over any gray area in the traceback and click on the 57 | 60 | button on the right hand side of that gray area to show an interactive 61 | console for the associated frame. Type arbitrary Python into the 62 | console; it will be evaluated in the context of the associated frame. In 63 | the interactive console there are helpers available for introspection: 64 | 65 |
dump() shows all variables in the frame
67 | dump(obj) dumps all that's known about the object
68 | 73 | Hover over any gray area in the traceback and click on 74 | 77 | on the right hand side of that gray area to show the source of the file 78 | associated with the frame. 79 |
80 | 81 |82 | Click on the traceback header to switch back and forth between the 83 | rendered version of the traceback and a plaintext copy-paste-friendly 84 | version of the traceback. 85 |
86 | 87 |88 | URL to recover this traceback page: {{ url }} 89 |
90 |Location: {{ redirect_to }}
8 |
9 |
10 | The Debug Toolbar has intercepted a redirect to the above URL for
11 | debug viewing purposes. You can click the above link to continue
12 | with the redirect as normal. If you'd like to disable this
13 | feature, you can set the settings
14 | variable debugtoolbar.intercept_redirects
15 | to False.
16 |
17 |
Some aiohttp debug toolbar panels can be activated (this enables additional features)
8 | 9 | {% for panel in panels %} 10 | {% if panel.user_activate %} 11 |
37 | Aiohttp DebugToolbar
38 |