分析部分响应的URL参数中的分隔和嵌套字段名

Question

在基于Flask-RESTful的API中，我希望允许客户端通过?fields=...参数检索部分的JSON响应。它列出了字段名(JSON对象的键(，这些字段名将用于构造较大原始对象的部分表示。

这可能是一个最简单的逗号分隔列表：

GET /v1/foobar?fields=name,id,date

这可以通过webargs的DelimitedList模式字段轻松完成，对我来说没有任何麻烦

---

但是，为了允许嵌套对象的键被表示，分隔字段列表可以包括任意嵌套的键，这些键被括在匹配的括号中：

GET /v1/foobar?fields=name,id,another(name,id),date
{
"name": "",
"id": "",
"another": {
"name": "",
"id": ""
},
"date": ""
}

GET /v1/foobar?fields=id,one(id,two(id,three(id),date)),date
{
"id": "",
"one": {
"id: "",
"two": {
"id": "",
"three": {
"id": ""
},
"date": ""
}
},
"date": ""
}

GET /v1/foobar?fields=just(me)
{
"just": {
"me: ""
}
}

---

我的问题有两个：

1. 有没有一种方法可以用webargs和marshmallow本机进行验证和反序列化？

2. 如果没有，我将如何使用pyparsing这样的解析框架来实现这一点？任何关于BNF语法应该是什么样子的提示都将受到高度赞赏。

Answer 1

Pyparsing有几个有用的内置组件，delimitedList和nestedExpr。下面是一个带注释的片段，它为您的值构建了一个解析器。(我还提供了一个例子，其中您的列表元素可能不仅仅是简单的字母单词(：

import pyparsing as pp
# placeholder element that will be used recursively
item = pp.Forward()
# your basic item type - expand as needed to include other characters or types
word = pp.Word(pp.alphas + '_')
list_element = word
# for instance, add support for numeric values
list_element = word | pp.pyparsing_common.number
# retain x(y, z, etc.) groupings using Group
grouped_item = pp.Group(word + pp.nestedExpr(content=pp.delimitedList(item)))
# define content for placeholder; must use '<<=' operator here, not '='
item <<= grouped_item | list_element
# create parser
parser = pp.Suppress("GET /v1/foobar?fields=") + pp.delimitedList(item)

您可以使用runTests:测试任何pyparsing表达式

parser.runTests("""
GET /v1/foobar?fields=name,id,date
GET /v1/foobar?fields=name,id,another(name,id),date
GET /v1/foobar?fields=id,one(id,two(id,three(id),date)),date
GET /v1/foobar?fields=just(me)
GET /v1/foobar?fields=numbers(1,2,3.7,-26e10)    
""",  fullDump=False)

提供：

GET /v1/foobar?fields=name,id,date
['name', 'id', 'date']
GET /v1/foobar?fields=name,id,another(name,id),date
['name', 'id', ['another', ['name', 'id']], 'date']
GET /v1/foobar?fields=id,one(id,two(id,three(id),date)),date
['id', ['one', ['id', ['two', ['id', ['three', ['id']], 'date']]]], 'date']
GET /v1/foobar?fields=just(me)
[['just', ['me']]]
GET /v1/foobar?fields=numbers(1,2,3.7,-26e10)
[['numbers', [1, 2, 3.7, -260000000000.0]]]