如何在 Flask-restless 中返回“已经存在”错误？答案

【问题标题】：How to return "already exists" error in Flask-restless?如何在 Flask-restless 中返回“已经存在”错误？
【发布时间】：2015-06-15 08:42:19
【问题描述】：

我想做一些异常处理程序。我在 python 中使用了 Flask-restless 和 SQLAlchemy 的组合。

我的问题：

当我使用数据库中已存在的对象向 api 发送请求时，SQLAlchemy 显示异常：

IntegrityError: (IntegrityError) column <column_name> is not unique u'INSERT INTO ...

所以我尝试将属性validation_exceptions 添加到create_api 方法中：

manager.create_api( ... , validation_exceptions=[IntegrityError])

但响应 json 包含：

{
    "validation_errors": "Could not determine specific validation errors"
}

并且服务器 api 显示异常：

Traceback (most recent call last):
  File "C:\Python27\lib\site-packages\flask_restless\views.py", line 797, in _extract_error_messages
    left, right = str(exception).rsplit(':', 1)
ValueError: need more than 1 value to unpack

Flask-restless 中的异常验证不适用于此类异常 (IntegrityError)

我该怎么办？是否可以为异常创建一些处理程序并在 json 中返回我自己的错误消息？

【问题讨论】：

你有没有想过这个问题？我们遇到了同样的问题。
不，我因为许多其他问题离开了烧瓶。现在我正在使用 Django Rest Framework

标签： python validation exception-handling flask-sqlalchemy flask-restless

【解决方案1】：

documentation（v0.17.0 至此发布日期）声明：

目前，Flask-Restless 期望指定验证错误的实例具有 errors 属性，这是一个将字段名称映射到错误描述的字典（注意：每个字段一个错误）。

所以要更改validation_errors 的内容，您的异常需要一个包含字典的errors 属性。该字典的内容将在服务器响应中显示为validation_errors。

来自flask-restless/tests/test_validation.py：

class TestSimpleValidation(ManagerTestBase):
"""Tests for validation errors raised by the SQLAlchemy's simple built-in
validation.
For more information about this functionality, see the documentation for
:func:`sqlalchemy.orm.validates`.
"""

def setup(self):
    """Create APIs for the validated models."""
    super(TestSimpleValidation, self).setup()

    class Person(self.Base):
        __tablename__ = 'person'
        id = Column(Integer, primary_key=True)
        age = Column(Integer, nullable=False)

        @validates('age')
        def validate_age(self, key, number):
            if not 0 <= number <= 150:
                exception = CoolValidationError()
                exception.errors = dict(age='Must be between 0 and 150')
                raise exception
            return number

        @validates('articles')
        def validate_articles(self, key, article):
            if article.title is not None and len(article.title) == 0:
                exception = CoolValidationError()
                exception.errors = {'articles': 'empty title not allowed'}
                raise exception
            return article

    class Article(self.Base):
        __tablename__ = 'article'
        id = Column(Integer, primary_key=True)
        title = Column(Unicode)
        author_id = Column(Integer, ForeignKey('person.id'))
        author = relationship('Person', backref=backref('articles'))

    self.Article = Article
    self.Person = Person
    self.Base.metadata.create_all()
    self.manager.create_api(Article)
    self.manager.create_api(Person, methods=['POST', 'PATCH'],
                            validation_exceptions=[CoolValidationError])

请求：

data = dict(data=dict(type='person', age=-1))
response = self.app.post('/api/person', data=dumps(data))

回复：

HTTP/1.1 400 Bad Request

{ "validation_errors":
    {
      "age": "Must be between 0 and 150",
    }
}

【讨论】：

【解决方案2】：

您可以使用预处理器来捕获验证错误。

def validation_preprocessor(data, *args, **kwargs):
    # validate data by any of your cool-validation-frameworks
    if errors:
        raise ProcessingException(description='Something went wrong', code=400)

manager.create_api(
    Model,
    methods=['POST'],
    preprocessors=dict(
        POST=[validation_preprocessor]
    )
)

但我不确定这是不是一个好方法。

【讨论】：