Почему мой обработчик ошибок Flask не вызывается? - PullRequest
1 голос
/ 09 мая 2019

Я пытаюсь создать собственный обработчик ошибок в Flask 1.0.2 и Flask-RESTful 0.3.7, используя рекомендации на странице " Внедрение исключений API ".(Flask-RESTful имеет свой собственный способ создания пользовательских сообщений об ошибках , но, поскольку кажется, что у него нет способа принять настроенное сообщение об ошибке во время исключения, я пытаюсь использоватьвместо этого ванильный метод Flask.)

from flask import Flask, jsonify
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

#########################################

class MyGenericException(Exception):
    status_code = 500
    def __init__(self, message, status_code=None, payload=None):
        Exception.__init__(self)
        self.message = message
        if status_code is not None:
            self.status_code = status_code
        self.payload = payload
    def to_dict(self):
        rv = dict(self.payload or ())
        rv['message'] = self.message
        return rv

@app.errorhandler(MyGenericException)
def handle_generic_error(error):
    response = jsonify(error.to_dict())
    response.status_code = error.status_code
    return response

#########################################

class TestMe(Resource):
    def get(self):
        raise MyGenericException('A generic error', status_code=501)
api.add_resource(TestMe, '/testme', endpoint='TestMe')

#########################################

if __name__ == '__main__':
    app.run(debug=False)

Вызов http://127.0.0.1:5000/testme возвращает только общее сообщение «500 Internal Server Error», но не ошибка 501 с моим пользовательским текстом ошибки.Похоже, что MyGenericException правильно вызывается, но Flask, похоже, игнорирует его.

[2019-05-08 17:09:18,409] ERROR in app: Exception on /testme [GET]
Traceback (most recent call last):
  File "C:\Users\testuser\Envs\testenv\lib\site-packages\flask\app.py", line 1813, in full_dispatch_request
    rv = self.dispatch_request()
  File "C:\Users\testuser\Envs\testenv\lib\site-packages\flask\app.py", line 1799, in dispatch_request
    return self.view_functions[rule.endpoint](**req.view_args)
  File "C:\Users\testuser\Envs\testenv\lib\site-packages\flask_restful\__init__.py", line 458, in wrapper
    resp = resource(*args, **kwargs)
  File "C:\Users\testuser\Envs\testenv\lib\site-packages\flask\views.py", line 88, in view
    return self.dispatch_request(*args, **kwargs)
  File "C:\Users\testuser\Envs\testenv\lib\site-packages\flask_restful\__init__.py", line 573, in dispatch_request
    resp = meth(*args, **kwargs)
  File "C:/Users/testuser/Documents/PyCharm Projects/TestApp/testapp.py", line 32, in get
    raise MyGenericException('A generic error', status_code=505)
MyGenericException

Декоратор @app.errorhandler, похоже, правильно настроен для пользовательского исключения MyGenericException.Почему это не обрабатывается Flask?

Спасибо всем, кто может помочь.

Ответы [ 2 ]

1 голос
/ 10 мая 2019

В ответ на ответ @ dylanj.nz, этот метод обработки ошибок Vanilla-Flask и этот пример переопределения API Flask-RESTful , вот метод, на котором я остановился.Это позволяет Flask-RESTful обрабатывать HTTPException типы исключений, но передает все остальное в обработчик по умолчанию (Flask), где можно указывать пользовательские сообщения об ошибках (весь объект JSON записей ключа / значения, если хотите) ввремя исключения.

from flask_restful import Resource, Api as _Api, HTTPException
app = Flask(__name__)

# This new Exception will accept a message, a status code, and a
# payload of other values to be displayed as a JSON object
class FlaskGenericException(Exception):
    status_code = 500   # default unless overridden
    def __init__(self, message, status_code=None, payload=None):
        Exception.__init__(self)
        self.message = message
        if status_code is not None:
            self.status_code = status_code
        self.payload = payload
    def to_dict(self):
        rv = dict(self.payload or ())
        rv['message'] = self.message
        return rv

@app.errorhandler(FlaskGenericException)
def handle_flask_generic_error(error):
    response = jsonify(error.to_dict())
    response.status_code = error.status_code
    return response

# This overridden Flask-RESTful API class will keep Flask-RESTful
# from handling errors other than HTTPException ones.
class Api(_Api):
    def error_router(self, original_handler, e):
        # Override original error_router to only handle HTTPExceptions.
        if self._has_fr_route() and isinstance(e, HTTPException):
            try:
                # Use Flask-RESTful's error handling method
                return self.handle_error(e) 
            except Exception:
                # Fall through to original handler (i.e. Flask)
                pass
        return original_handler(e)

api = Api(app)

class TestMe(Resource):
    def get(self):
        try:
            ldapc = ldap.connection
        except:
            # message = first parameter.  Other parameters come in as "payload"
            raise FlaskGenericException('A generic error', status_code=505, payload={'user': 'John Doe', 'company': 'Foobar Corp.'})

api.add_resource(TestMe, '/testme', endpoint='TestMe')
0 голосов
/ 10 мая 2019

Обращаясь как к этому вопросу , так и к документам , ключевая информация, которую я получил от обоих, заключается в том, является ли ваш маршрут Flask-RESTful, который у вас есть, онбудет обрабатываться handle_error(), и единственный способ предотвратить или настроить это - реализовать собственный класс API и переопределить handle_error().

...