handle errors that can be reported to the web client
Project description
=====================
Flask-ReportableError
=====================
Introduction
------------
Flask-ReportableError is a Flask extension for handling errors that can
be reported to the web client.
Documentation
-------------
In order to use Flask-ReportableError, you must include the following
statement in you application start script::
from flask import Flask
import flask_reportable_error
app = Flask(__name__)
app.config.from_envvar('FLASK_SETTINGS', silent=True)
flask_reportable_error.init(app)
API
---
- ``flask_reportable_error.init()``:
context initializer, it must receive the application as parameter.
- ``flask_reportable_error.mixin``:
class decorator that declares the decorated class as mixin with
reportable exceptions.
- ``flask_reportable_error.reportable()``:
factory to create reportable exception classes. For example::
raise reportable(ValueError)('invalid data received')
- ``flask_reportable_error.ReportableErrorMixin``:
mixin for reportable exception classes.
- ``report()``:
method that returns the reportable string – can be overridden.
- ``status_code``:
property representing the numeric status code – can be set at
instance level.
- ``template``:
attribute refering to custom template name.
- ``headers``:
attribute refering to custom headers.
Settings
--------
The Flask settings may contain the key ``REPORTABLE_ERROR``, that’s a
dictionary with the following keys:
- ``LOGLEVEL``:
the logging level. If not supplied, Flask-ReportableError uses
``logging.ERROR``.
- ``DEFAULT_STATUS_CODE``:
the default numeric status code for reportable exception classes. By
default it’s 500.
- ``TEMPLATE``:
the name of a template to be used instead of none. The context of the
template will contain the exception as value of the ``exc`` key.
- ``HEADERS``:
a dictionary to be used as default headers instead of ``{}``.
Flask-ReportableError
=====================
Introduction
------------
Flask-ReportableError is a Flask extension for handling errors that can
be reported to the web client.
Documentation
-------------
In order to use Flask-ReportableError, you must include the following
statement in you application start script::
from flask import Flask
import flask_reportable_error
app = Flask(__name__)
app.config.from_envvar('FLASK_SETTINGS', silent=True)
flask_reportable_error.init(app)
API
---
- ``flask_reportable_error.init()``:
context initializer, it must receive the application as parameter.
- ``flask_reportable_error.mixin``:
class decorator that declares the decorated class as mixin with
reportable exceptions.
- ``flask_reportable_error.reportable()``:
factory to create reportable exception classes. For example::
raise reportable(ValueError)('invalid data received')
- ``flask_reportable_error.ReportableErrorMixin``:
mixin for reportable exception classes.
- ``report()``:
method that returns the reportable string – can be overridden.
- ``status_code``:
property representing the numeric status code – can be set at
instance level.
- ``template``:
attribute refering to custom template name.
- ``headers``:
attribute refering to custom headers.
Settings
--------
The Flask settings may contain the key ``REPORTABLE_ERROR``, that’s a
dictionary with the following keys:
- ``LOGLEVEL``:
the logging level. If not supplied, Flask-ReportableError uses
``logging.ERROR``.
- ``DEFAULT_STATUS_CODE``:
the default numeric status code for reportable exception classes. By
default it’s 500.
- ``TEMPLATE``:
the name of a template to be used instead of none. The context of the
template will contain the exception as value of the ``exc`` key.
- ``HEADERS``:
a dictionary to be used as default headers instead of ``{}``.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for Flask-ReportableError-0.4.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f75a45e890ae992c07347d9f2a955c1b24547b233bc97db1d9a36520d495eb2e |
|
MD5 | 77cb38a2541ffa8151813948cb071666 |
|
BLAKE2b-256 | 5710a11ded3bf0617caab71c83cfc23e8ecd0b48555bfd8fd69e3d620b10ede2 |