Set customizable default errors handler for flask app and blueprints.
You can register error handler for:
api that returns JSON, default response is as API problem specification like (see https://tools.ietf.org/html/rfc7807). Instead you can use your own response implementation passed as argument to ErrorHandler class: it must be a decorator and must take 3 args, a dict response, status code and dict headers.
web that returns html page or api response if request is XHR (for compatibility with old clients)
you can register custom handlers for blueprint or the entire app
This module provide also an abstract ErrorDispatcher class in order to dispatch 404 or 405 error to the correct blueprint because flask Blueprint does not own url_prefix (see https://github.com/pallets/flask/issues/1498).
There are 2 concrete implementation:
SubdomainDispatcher: dispatch the error to the handler associate with blueprint with certain subdomain (if 2 or more Blueprint has the same subdomain the first blueprint handler matched is used)
URLPrefixDispatcher: dispatch the error to the handler associate with blueprint with certain url prefix. This will not work if 2 Blueprint are registered under the same url prefix, for example: Blueprint A registered under /prefix/blueprint, Blueprint B registered under /prefix, this dispatcher executes the handler of B in both case if B is registered after A.
Moreover you can create you own dispatcher by extending ErrorDispatcher class and implementing dispatch method. Only the last ErrorDispatcher registered is executed. This is the best solution I have found, suggestions are welcome.
Notices:
In order to use correctly dispatcher you must set prefix or subdomain in Blueprints constructor, see example below.
If you use dispatcher do not register an handler to app object because it overwrites dispatcher.
When using a dispatcher you should use failure handler on app to catch unhandled exceptions.
QuickStart
Install flask_errors_handler using pip:
$ pip install Flask-ErrorsHandler
Example usage
import flask
from flask_errors_handler import ErrorHandler
app = flask.Flask(__name__)
error = ErrorHandler(app, dispatcher='urlprefix')
api = flask.Blueprint('api', __name__, url_prefix='/api')
web = flask.Blueprint('web', __name__, url_prefix='/web')
custom = flask.Blueprint('custom', __name__, url_prefix='/custom')
error.web_register(web)
error.api_register(api)
error.failure_register(app)
@error.register(custom)
def error_handler(exc):
return str(exc), 500, {'Content-Type': 'text/plain'}
@api.route('/')
def index():
flask.abort(500, 'Error from api blueprint')
@web.route('/')
def index():
flask.abort(500, 'Error from web blueprint')
@custom.route('/')
def index():
flask.abort(500, 'Error from custom blueprint')
@app.route('/')
def index():
raise NameError("test custom")
app.register_blueprint(web)
app.register_blueprint(api)
app.register_blueprint(custom)
app.run()Go to http://127.0.0.1:5000/api and see error message response as a JSON
Go to http://127.0.0.1:5000/web and see error message response as an HTML page
Go to http://127.0.0.1:5000/custom and see error message response as a plain text
Configuration
ERROR_PAGE: (default: error.html) path of html template to use for show error message
ERROR_DEFAULT_MSG: (default: Unhandled Exception) default message for unhandled exceptions
ERROR_XHR_ENABLED: (default: True) enable or disable api response where request is XHR
ERROR_FORCE_CONTENT_TYPE: (True) force response content type to be api problem compliant
ERROR_CONTENT_TYPES: (‘json’, ‘xml’)) list of format types to force api problem content type
ERROR_DISPATCHER: dispatcher to use, one of: default, urlprefix, subdomain
ERROR_HANDLER: global error handler, one of: api, web
License MIT
1 maintainer
Metadata
1 maintainer
Release files for Flask-ErrorsHandler 4.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| Flask-ErrorsHandler-4.0.2.tar.gz | 11.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| Flask_ErrorsHandler-4.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 24.2 kB
Release files / Flask-ErrorsHandler-4.0.2.tar.gz
| Download URL | Flask-ErrorsHandler-4.0.2.tar.gz |
|---|---|
| Size | 11.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
21360fd70bbe88a65e7d49c86a90222a27ef744fe6acbbfe485a748a4ef7fd75
|
|
BLAKE2b-256 checksum How to use checksums |
c3ae404fa9ee5ea0884ab1faff1ae055d2c34e73d34cab8c157ddda22ee28c1d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7
|
Release files / Flask_ErrorsHandler-4.0.2-py3-none-any.whl
| Download URL | Flask_ErrorsHandler-4.0.2-py3-none-any.whl |
|---|---|
| Size | 13.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fe046448afa20fedf55aa09d91321ae133caf749ee7b4d7bcb17ada27213575e
|
|
BLAKE2b-256 checksum How to use checksums |
d49441d4aa9638ac1b0504ce4b353b78d544ddde9c84d98b3b3bab103ca6fc4b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7
|
