Metadata-Version: 1.1
Name: Flask-ErrorsHandler
Version: 0.0.1
Summary: Default errors handler for flask application and blueprints
Home-page: https://github.com/cs91chris/flask-errors_handler
Author: cs91chris
Author-email: cs91chris@voidbrain.me
License: MIT
Description: Flask-ErrorsHandler
        ===================
        
        Set default errors handler for flask app and blueprints.
        
        You can register handler for api that returns JSON or
        you can register handler for web that returns html pageor JSON if request is XHR.
        
        
        Quickstart
        ~~~~~~~~~~
        
        Install ``flask_errors_handler`` using ``pip``:
        
        ::
        
           $ pip install Flask-ErrorsHandler
        
        .. _section-1:
        
        Example usage
        ^^^^^^^^^^^^^
        
        .. code:: python
        
            from flask import Flask
            from flask import abort
            from flask import Blueprint
        
            from flask_errors_handler import ErrorHandler
        
        
            app = Flask(__name__)
            app.config['JSON_ADD_STATUS'] = False
            app.config['ERROR_PAGE'] = 'error.html'
        
            error = ErrorHandler()
            error.init_app(app)
            error.api_register(app)
        
            web = Blueprint('web', __name__)
            error.web_register(web)
        
        
            @app.route('/api')
            def index():
                abort(500, 'Error from app')
        
        
            @web.route('/web')
            def index():
                abort(500, 'Error from web blueprint')
        
        
            app.register_blueprint(web)
            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
        
        .. _section-2:
        
        Configuration
        ^^^^^^^^^^^^^
        
        1. ``ERROR_PAGE``: *(default: None)* path of html template to use for show error message
        2. ``ERROR_DEFAULT_MSG``: *(default: Unhandled Exception)* default message for unhandled exceptions
        
        License MIT
        
Platform: any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
