root
/
flask
mirror of https://github.com/pallets/flask.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #5066 from pallets/docs-passthrough 

document passthrough_errors
This commit is contained in:
David Lord 2023-04-15 11:57:46 -07:00 committed by GitHub
parent 87698a2d5d 5bba529dfc
commit a1d0eda789
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/debugging.rst
View File

@ -66,9 +66,9 @@ be used to step through code during a request before an error is raised,
or if no error is raised. Some even have a remote mode so you can debug or if no error is raised. Some even have a remote mode so you can debug
code running on another machine. code running on another machine.
When using an external debugger, the app should still be in debug mode, When using an external debugger, the app should still be in debug mode, otherwise Flask
but it can be useful to disable the built-in debugger and reloader, turns unhandled errors into generic 500 error pages. However, the built-in debugger and
which can interfere. reloader should be disabled so they don't interfere with the external debugger.
.. code-block:: text .. code-block:: text
@ -80,8 +80,20 @@ When running from Python:
app.run(debug=True, use_debugger=False, use_reloader=False) app.run(debug=True, use_debugger=False, use_reloader=False)
Disabling these isn't required, an external debugger will continue to Disabling these isn't required, an external debugger will continue to work with the
work with the following caveats. If the built-in debugger is not following caveats.
disabled, it will catch unhandled exceptions before the external
debugger can. If the reloader is not disabled, it could cause an - If the built-in debugger is not disabled, it will catch unhandled exceptions before
unexpected reload if code changes during debugging. the external debugger can.
- If the reloader is not disabled, it could cause an unexpected reload if code changes
during a breakpoint.
- The development server will still catch unhandled exceptions if the built-in
debugger is disabled, otherwise it would crash on any error. If you want that (and
usually you don't) pass ``passthrough_errors=True`` to ``app.run``.
.. code-block:: python
app.run(
debug=True, passthrough_errors=True,
use_debugger=False, use_reloader=False
)