Python Flask 中为何以及如何处理异常

该函数很简单。它构造一个 URL，向 Threat Stack 发出请求，并返回响应的 JSON 内容。那么可能出什么问题呢？在这三个语句中，有两个很容易出错。在向 Threat Stack 发出请求时，可能会发生导致失败的通信错误。如果您确实收到了响应，您希望解析 JSON 文档。如果响应中没有 JSON 文档怎么办？

如果失败，这将使您可以执行您认为必要的任何其他操作。如果您正在使用数据库，您可能需要回滚事务。您可能还想记录错误以供以后分析。（如果您已经为此应用程序编写了日志记录组件，您可能会这样做。）请注意，您正在指定要捕获的异常类型。不要 blanket 捕获所有异常。您可能会为了节省时间而这样做，但这可能会使您以后的生活更加艰难，因为您会发现自己无法理解为什么您的应用程序会失败。现在花时间了解您的应用程序可能因何种原因而失败。

有了 Exception 类，您可以捕获并重新引发异常

try:
    resp = requests.get(
      alerts_url,
      headers={'Authorization': THREATSTACK_API_KEY}
    )

except requests.exceptions.RequestException as e:
    exc_info = sys.exc_info()
    raise ThreatStackRequestError, ThreatStackRequestError(e), exc_info[2]

捕获异常后会发生什么？为什么您不这样做呢？

except requests.exceptions.RequestException as e:
   raise ThreatStackRequestError(e.args)

当人们捕获并重新引发异常时，这个错误非常常见。如果您执行了上述操作，您将丢失应用程序回溯。检查回溯会显示您进入了 get_alert_by_id()，然后您引发了错误。您看不到 request.get() 失败的更深层次的上下文。前面的示例是在 Python 2 中捕获并重新引发错误的正确方法。 您的代码将抛出一个以您知道的类命名的异常，它将为您提供导致异常的代码跟踪，以便您可以更好地调试它。

这里可能会出什么问题？首先，响应可能不是 JSON 正文，这将导致您在尝试解析它时抛出异常。API 始终应该返回 JSON，即使在错误时也是如此，但仍然有可能发生意外错误。也许应用程序问题会在错误时像您的应用程序现在所做的那样喷出回溯。也许负载均衡器有问题并返回带有“服务不可用”页面的 503 错误。API 故障也可能发生。您可能被发回了一个 JSON 响应，该响应完全可以解析，只是告诉您您的请求因某种原因而失败。例如，当您尝试检索不存在的警报时。简而言之，您需要确保您的请求返回了成功的响应。如果您没有获得成功的响应，您将引发错误。您可能会收到通信错误或 API 错误，因此根据您收到的内容，您将引发 ThreatStackRequestError 或 ThreatStackAPIError

   if not resp.ok:
        if 'application/json' in resp.headers.get('Content-Type'):
            raise ThreatStackAPIError(resp.reason,
                                      resp.status_code,
                                      resp.json()
                                      )
        else:
            raise ThreatStackRequestError(resp.reason, resp.status_code)

    return resp.json()

如果请求成功，resp.ok 将为 True。如果不是，那么您将尝试确定发生了哪种类型的故障：通信故障还是 API 故障？您将使用一种非常简单的方法来区分差异。如果响应标头指示 JSON，则假设您能够与 API 通信并且 API 向您发送了错误。否则，假设沿途发生了其他错误，您从未到达 Threat Stack API，并且它是通信错误。

当您的服务尝试与 Threat Stack 通信并且发生意外情况时，您会引发这些异常。这些可以被认为是 500 级别的服务器错误。（注意：您可以提出一个论点，即传递给 get_alert_by_id() 的无效警报 ID 会引发 ThreatStackAPIError 异常，实际上应该是 400 Bad Request，但我不太关心。我自己的偏好是简单地将模型级别的异常视为 500 级别，并将视图级别的异常视为 400 级别。）还记得我建议创建基类 ThreatStackError 吗？这是您第一次使用它

class ThreatStackError(Exception):
    '''Base Threat Stack error.'''
    status_code = 500

class ThreatStackRequestError(ThreatStackError):
    '''Threat Stack request error.'''

class ThreatStackAPIError(ThreatStackError):
    '''Threat API Stack error.'''

对在 app.models.s3 和 app.views.s3 中添加 status_codes 重复此过程。

@s3.route('/status', methods=['GET'])
def is_available():
    # <SNIP>

@s3.errorhandler(Exception)
def handle_error(error):
    # <SNIP>

这对于较大的应用程序来说非常棒，这些应用程序可能需要更多的组织和不同的视图，这些视图需要它们自己的错误处理，但让我们保持您的代码更简单一些。相反，您将添加一个用于处理错误的单个 Flask 蓝图，它将处理所有应用程序异常

'''Application error handlers.'''
from flask import Blueprint, jsonify

errors = Blueprint('errors', __name__)

@errors.app_errorhandler(Exception)
def handle_error(error):
    message = [str(x) for x in error.args]
    status_code = error.status_code
    success = False
    response = {
        'success': success,
        'error': {
            'type': error.__class__.__name__,
            'message': message
        }
    }

    return jsonify(response), status_code

这是一个好的开始，但您将进行额外的调整。我们假设所有 Exception 对象都有一个 status_code 属性，但这根本不是真的。我们希望认为我们已准备好捕获代码中每个可能的异常情况，但人会犯错。出于这个原因，您将有两个错误处理函数。一个将处理您知道的错误类（这是我们的基类异常），另一个将用于意外错误。

'''Application error handlers.'''
from app.models.s3 import S3ClientError
from app.models.threatstack import ThreatStackError
from flask import Blueprint, jsonify

errors = Blueprint('errors', __name__)

@errors.app_errorhandler(S3ClientError)
@errors.app_errorhandler(ThreatStackError)
def handle_error(error):
    message = [str(x) for x in error.args]
    status_code = 500
    success = False
    response = {
        'success': success,
        'error': {
            'type': error.__class__.__name__,
            'message': message
        }
    }

    return jsonify(response), status_code

@errors.app_errorhandler(Exception)
def handle_unexpected_error(error):
    status_code = 500
    success = False
    response = {
        'success': success,
        'error': {
            'type': 'UnexpectedException',
            'message': 'An unexpected error has occurred.'
        }
    }

    return jsonify(response), status_code

最后，您将在 app 模块中将此蓝图连接到应用程序。您添加了一个名为 _initialize_errorhandler() 的附加函数，它将导入蓝图并将其添加到您的应用程序

def _initialize_errorhandlers(application):
    '''
    Initialize error handlers
    '''
    from app.errors import errors
    application.register_blueprint(errors)

def create_app():
    '''
    Create an app by initializing components.
    '''
    application = Flask(__name__)

    _initialize_errorhandlers(application)
    _initialize_blueprints(application)

    # Do it!
    return application 

现在，当应用程序抛出异常时，您有了功能性的错误处理，因此该应用程序不会抛出回溯并泄露代码以及可能返回敏感信息，而是返回一个描述错误的 JSON 文档。