1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
|
#
# mongodb_conditional_expression.py
#
# Pyparsing parser and wrapper method to parse infix arithmetic and boolean
# expressions and transform them to MongoDB's nested dict queries with
# associated operator tags.
#
# Example:
# mongo_query = transform_query("100 < a <= 200")
# print(mongo_query)
#
# Prints:
# {'$and': [{'a': {'$gt': 100}}, {'a': {'$lte': 200}}]}
#
# Copyright 2024, Paul McGuire
#
from functools import reduce
from operator import or_
from typing import Union, Dict
import pyparsing as pp
pp.ParserElement.enable_packrat()
ppc = pp.common
__all__ = [
"query_condition_expr",
"query_condition_expr_with_comment",
"transform_query",
]
class InvalidExpressionException(pp.ParseFatalException):
pass
def key_phrase(expr: Union[str, pp.ParserElement]) -> pp.ParserElement:
if isinstance(expr, str):
expr = pp.And(pp.CaselessKeyword.using_each(expr.split()))
return pp.Combine(expr, adjacent=False, join_string=" ")
ident = ppc.identifier()
integer = ppc.integer()
num = ppc.number()
LBRACK, RBRACK = pp.Suppress.using_each("[]")
operand = ident | (pp.QuotedString('"') | pp.QuotedString("'")).set_name("quoted_string") | num
operand.set_name("operand")
operand_list = pp.Group(LBRACK + pp.DelimitedList(operand) + RBRACK, aslist=True)
AND, OR, NOT, IN, CONTAINS, ALL, NONE = pp.CaselessKeyword.using_each(
"and or not in contains all none".split()
)
NOT_IN = key_phrase(NOT + IN)
CONTAINS_ALL = key_phrase(CONTAINS + ALL)
CONTAINS_NONE = key_phrase(CONTAINS + NONE)
def binary_eq_neq(s, l, tokens):
a, op, b = tokens[0]
try:
{a: None}
except TypeError as te:
raise InvalidExpressionException(
s, l, f"Could not create query expression using field {a!r}"
) from te
if op in ("=", "=="):
return {a: b}
return { a: { "$ne": b } }
def binary_comparison_op(s, l, tokens):
tokens = tokens[0]
binary_map = {
"<": "$lt",
">": "$gt",
"<=": "$lte",
">=": "$gte",
"!=": "$ne",
"in": "$in",
"not in": "$nin",
"contains all": "$all",
# add Unicode operators, because we can
"≤": "$lte",
"≥": "$gte",
"≠": "$ne",
"⊇": "$all",
"∈": "$in",
"∉": "$nin",
}
inequality_inv_map = {
"<": "$gt",
">": "$lt",
"<=": "$gte",
">=": "$lte",
"≤": "$gte",
"≥": "$lte",
}
operator_compatibility_map = {
"<": {"<", "<=", "≤"},
">": {">", ">=", "≥"},
"<=": {"<", "<=", "≤"},
">=": {">", ">=", "≥"},
"≤": {"<", "<=", "≤"},
"≥": {">", ">=", "≥"},
}
try:
field, op, value = tokens
except ValueError:
# special handling for 'x < field < y'
if len(tokens) == 5:
a, op1, field, op2, b = tokens
for op_ in (op1, op2):
if op_ not in inequality_inv_map:
raise InvalidExpressionException(
s, l, f"{op_} cannot be used in a chained expression"
)
if op2 not in operator_compatibility_map[op1]:
raise InvalidExpressionException(
s, l, f"cannot chain {op1!r} and {op2!r} in the same expression"
)
op1 = inequality_inv_map[op1]
op2 = binary_map[op2]
return binary_multi_op(
[
[{field: {op1: a}}, "and", {field: {op2: b}}]
]
)
raise InvalidExpressionException(
s, l,
f"{tokens[1]!r} comparison operator may not be chained with more than 2 terms"
)
if op == "contains none":
return {
"$nor": [
{field: {"$elemMatch": {"$eq": v}}}
for v in value
]
}
return {field: {binary_map[op]: value}}
def binary_multi_op(tokens):
tokens = tokens[0]
oper_map = {
"and": "$and",
"or": "$or",
"not": "$not",
}
op = oper_map[tokens[1]]
values = tokens[::2]
# detect 'and' with all equality checks, collapse to single dict
if (
op == "$and"
and not any(
isinstance(v, (dict, list))
for dd in values
for v in dd.values()
)
):
try:
ret = reduce(or_, values)
except TypeError:
# compatibility for pre-Python 3.9 versions
ret = {}
for v in values:
ret = {**ret, **v}
return ret
return {op: values}
def unary_op(tokens):
tokens = tokens[0]
oper_map = {
"not": "$not",
}
op, value = tokens
# detect 'not not'
k, v = next(iter(value.items()))
if k == "$not":
return v
return {oper_map[op]: value}
comparison_expr = pp.infix_notation(
operand | operand_list,
[
(pp.one_of("<= >= < > ≤ ≥"), 2, pp.OpAssoc.LEFT, binary_comparison_op),
(pp.one_of("= == != ≠"), 2, pp.OpAssoc.LEFT, binary_eq_neq),
(IN | NOT_IN | CONTAINS_ALL | CONTAINS_NONE | pp.one_of("⊇ ∈ ∉"), 2, pp.OpAssoc.LEFT, binary_comparison_op),
]
)
# "not" operator only matches if not followed by "in"
NOT_OP = NOT + ~IN
AND_OP = AND | pp.Literal("∧").add_parse_action(pp.replace_with("and"))
OR_OP = OR | pp.Literal("∨").add_parse_action(pp.replace_with("or"))
query_condition_expr = pp.infix_notation(
comparison_expr | ident,
[
(NOT_OP, 1, pp.OpAssoc.RIGHT, unary_op),
(AND_OP, 2, pp.OpAssoc.LEFT, binary_multi_op),
(OR_OP, 2, pp.OpAssoc.LEFT, binary_multi_op),
]
)
# add $comment containing the original expression string
query_condition_expr_with_comment = pp.And([query_condition_expr])
query_condition_expr_with_comment.add_parse_action(
lambda s, l, t: t[0].__setitem__("$comment", s)
)
def transform_query(query_string: str, include_comment: bool = False) -> Dict:
"""
Parse a query string using boolean and arithmetic comparison operations,
and convert it to a dict for the expression equivalent using MongoDB query
expression structure.
Examples:
a = 100 and b = 200
{'a': 100, 'b': 200}
a==100 and b>=200
{'$and': [{'a': 100}, {'b': {'$gte': 200}}]}
a==100 and not (b>=200 or c<200)
{'$and': [{'a': 100}, {'$not': {'$or': [{'b': {'$gte': 200}}, {'c': {'$lt': 200}}]}}]}
name in ["Alice", "Bob"]
{'name': {'$in': ['Alice', 'Bob']}}
Also supported:
- chained inequalities
100 < a < 200
{'$and': [{'a': {'$gt': 100}}, {'a': {'$lt': 200}}]}
- `in` and `not in`
name in ["Alice", "Bob"]
{'name': {'$in': ['Alice', 'Bob']}}
- `contains all`
names contains all ["Alice", "Bob"]
{'names': {'$all': ['Alice', 'Bob']}}
- Unicode operators
100 < a ≤ 200 and 300 > b ≥ 200 or c ≠ -1
100 < a ≤ 200 ∧ 300 > b ≥ 200 ∨ c ≠ -1
name ∈ ["Alice", "Bob"]
name ∉ ["Alice", "Bob"]
names ⊇ ["Alice", "Bob"]
"""
generator_expr = (
query_condition_expr_with_comment
if include_comment
else query_condition_expr
)
return generator_expr.parse_string(query_string)[0]
def main():
from textwrap import dedent
for test in dedent("""\
a = 100
a = 100 and b = 200
a > b
a==100 and b>=200
a==100 and b>=200 or c<200
a==100 and (b>=200 or c<200)
a==100 and not (b>=200 or c<200)
xyz < 2000 and abc > 32
xyz < 2000 and abc > 32 and def == 100
xyz == 2000 and abc == 32 and def == 100
xyz == 2000 or abc == '32' or def == "foo"
100 < a < 200
a==100 and not (100 < b <= 200)
1900 < "wine vintage" < 2000
name > "M"
100 < a ≤ 200 or 300 > b ≥ 200 or c ≠ -1
100 < a ≤ 200 ∧ 300 > b ≥ 200 ∧ c ≠ -1
100 < a ≤ 200 ∨ 300 > b ≥ 200 ∨ c ≠ -1
a==100 and not not (a > 100)
a==100 and not not not (a > 100)
a==100 and not not not not (a > 100)
name in ["Alice", "Bob"]
name ∈ ["Alice", "Bob"]
name not in ["Alice", "Bob"]
name ∉ ["Alice", "Bob"]
names contains all ["Alice", "Bob"]
names ⊇ ["Alice", "Bob"]
names contains none ["Alice", "Bob"]
""").splitlines():
print(test)
print(transform_query(test))
print()
if __name__ == '__main__':
main()
|