>问题上下文
在使用 flask-restx 生成 api 文档时，我在使用MarshallingError时遇到了一些意外的行为。我有一个自定义的烧瓶-restx字段定义，如下所示。
class EnumField(StringMixin, Raw):
def __init__(self, enum_type, *args, **kwargs):
super().__init__(*args, **kwargs)
self.enum_type = enum_type
def format(self, value):
try:
return self.enum_type(value)
except ValueError as e:
raise MarshallingError(e)
def output(self, key, obj, **kwargs):
return self.format(obj[key]).value
其中enum_type很简单，例如
class DemoEnum(Enum):
a = 'a'
b = 'b'
c = 'c'
然后将其打包在 restxapi.model中，如下所示。
model = api.model('Demo', {"name": EnumField(enum_type=DemoEnum, required=True)})
问题
当我在name中输入一个整数时，正如预期的那样，我遇到了如下所示的漂亮错误。
{
"errors": {
"name": "1 is not of type 'string'"
},
"message": "Input payload validation failed"
}
但是，当我输入一个不在我的枚举中的值(例如"d"(时，错误似乎在我的format定义中捕获，但是，MarshallingError并没有像预期的那样隐藏所有内部错误。下面是输出内容的简短片段。
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>MarshallingError: 'string' is not a valid DemoEnum // Werkzeug Debugger</title>
...
静态
- 这是预期行为吗？
- 是否可以返回更干净的错误，如上所示？我的理解是，我对
format的定义应该达到这个目的吗？
完整的测试应用程序
from flask_restx import Api, Resource
from flask_restx.fields import Raw, StringMixin, MarshallingError
from flask import Flask
from werkzeug.middleware.proxy_fix import ProxyFix
from enum import Enum
# =============================================================================
# Custom EnumField and Enum
# =============================================================================
class EnumField(StringMixin, Raw):
def __init__(self, enum_type, *args, **kwargs):
super().__init__(*args, **kwargs)
self.enum_type = enum_type
def format(self, value):
try:
return self.enum_type(value)
except ValueError as e:
raise MarshallingError(e)
def output(self, key, obj, **kwargs):
return self.format(obj[key]).value
class DemoEnum(Enum):
a = 'a'
b = 'b'
c = 'c'
# =============================================================================
# Demo restx model
# =============================================================================
app = Flask(__name__)
app.wsgi_app = ProxyFix(app.wsgi_app)
api = Api(app, version='1.0', title='Test API', validate=True)
ns = api.namespace('demo')
model = api.model('Demo', {
"name": EnumField(enum_type=DemoEnum, required=True)
})
# =============================================================================
# Api endpoint
# =============================================================================
@ns.route('/')
class Demo(Resource):
@ns.doc('create_demo')
@ns.expect(model, validate=True) # validate checks the input is provided
@ns.marshal_with(model, code=201)
def post(self):
'''Create demo'''
return api.payload
if __name__ == '__main__':
app.run(debug=True)
- 这是预期行为吗？
是的，因为您的函数未正确中止或返回任何内容。
- 是否可以返回一个更干净的错误，如上所示？我的理解是，我对格式的定义应该达到这个目的吗？
是的，您可以像以前一样挽救错误，然后返回您自己的消息并确保它使用 Flask 的abort正确中止
试试这个：
from flask import Flask, abort
def output(self, key, obj, **kwargs):
try:
return self.format(obj[key])
except (ValueError, MarshallingError) as e:
return abort(400, f'Unable to marshal field. errors: [{key}: {str(e)}]')
此示例的输出将是格式化的 400 错误：
{
"message": "Unable to marshal field. errors: [name: 'd' is not a valid DemoEnum]"
}
这不会影响来自expect装饰器的错误消息，即。 如果为名称字段输入 1，您将收到与以前相同的消息。