使用Flask-SQLAlchemy的特定于域的查询语言

时间:2018-10-04 09:32:55

标签: python sqlalchemy flask-sqlalchemy dsl pyparsing

我正在使用Flask和Flask-SQLAlchemy编写应用程序。我希望用户能够使用特定于域的查询语言(例如parent.name = "foo" AND (name = "bar" OR age = 11))来查询数据库。

我已经使用Pyparsing为此语言编写了一个解析器:

import pyparsing as pp

query = 'parent.name = "foo" AND (name = "bar" OR age = 11)'

and_operator = pp.oneOf(['and', '&'], caseless=True)
or_operator = pp.oneOf(['or', '|'], caseless=True)

identifier = pp.Word(pp.alphas + '_', pp.alphas + '_.')
comparison_operator = pp.oneOf(['=','!=','>','>=','<', '<='])

integer = pp.Regex(r'[+-]?\d+').setParseAction(lambda t: int(t[0]))
float_ = pp.Regex(r'[+-]?\d+\.\d*').setParseAction(lambda t: float(t[0]))
string = pp.QuotedString('"')

comparison_operand = string | identifier | float_ | integer
comparison_expr = pp.Group(comparison_operand +
                           comparison_operator +
                           comparison_operand)

grammar = pp.operatorPrecedence(comparison_expr,
                                [
                                    (and_operator, 2, pp.opAssoc.LEFT),
                                    (or_operator, 2, pp.opAssoc.LEFT)
                                ])

result = grammar.parseString(query)
print(result.asList())

这给了我以下输出:

[[['parent.name', '=', 'foo'], 'and', [['name', '=', 'bar'], 'or', ['age', '=', 11]]]]

现在我不知道该怎么办。如何动态生成SQLAlchemy查询?有没有什么图书馆可以帮上忙?生成原始SQL会更容易吗?

1 个答案:

答案 0 :(得分:2)

第一步是编写解析器。从这里开始,我建议您增强您的operatorPrecedence调用(该名称是旧的并且已弃用,现在称为infixNotation),以使pyparsing构建嵌套的节点集,这对应于构建抽象语法树( AST)。当您成功使解析器工作时,我必须告诉您,下一步是相当大的一步。

这个想法是让解析器不仅返回字符串或转换后的int和float值,而且还返回实际的类实例。看起来像这样:

class AndOperation:
    def __init__(self, tokens):
        # tokens will look like [operand1, 'AND', operand2, 'AND', operand3, ...]
        self._operands = tokens[::2]

class OrOperation:
    def __init__(self, tokens):
        # tokens will look like [operand1, 'OR', operand2, 'OR', operand3, ...]
        self._operands = tokens[::2]

class NotOperation:
    def __init__(self, tokens):
        # tokens will look like ['NOT', operand]
        self._operands = tokens[-1]

然后您将它们添加到infixNotation中,如下所示:

AND, OR, TRUE, FALSE = map(pp.Keyword, "AND OR TRUE FALSE".split())
boolean_term = TRUE | FALSE | ~(AND | OR) + pp.pyparsing_common.identifier
boolean_expr = pp.infixNotation(boolean_term,
    [
    ('NOT', 1, pp.opAssoc.RIGHT, NotOperation),
    ('AND', 2, pp.opAssoc.LEFT, AndOperation),
    ('OR', 2, pp.opAssoc.LEFT, OrOperation),
    ])

如果不添加类解析动作,则解析“ P AND NOT Q”将返回:

[['P', 'AND', ['NOT', 'Q']]]

使用添加的类,解析“ P AND NOT Q”将为您提供以下信息:

[AndOperation('P', NotOperation('Q'))]

这时,您可以选择是否要向每个xxxOperation类添加某种形式的evaluate()execute方法以评估表达式,或者如果需要,可以选择render方法只是输出一个SQL WHERE子句。

例如,render用于AndOperation创建SQL WHERE语法如下:

def render(self):
    return ' AND '.join("'" + oper + "'" if isinstance(oper, str) else oper.render()
                                   for oper in self.operands)

(如IljaEverilä在评论中指出的那样,请当心直接在运行运行这样的WHERE子句的SQL注入问题-render()主要用于可视化和调试)

在pyparsing仓库examples目录(https://github.com/pyparsing/pyparsing/tree/master/examples)中有几个示例-搜索infixNotation的用法以查看其用法。