mirror of
https://github.com/mealie-recipes/mealie.git
synced 2026-04-18 10:55:36 -04:00
feat: Query relative dates (#6984)
This commit is contained in:
0
mealie/services/query_filter/__init__.py
Normal file
0
mealie/services/query_filter/__init__.py
Normal file
589
mealie/services/query_filter/builder.py
Normal file
589
mealie/services/query_filter/builder.py
Normal file
@@ -0,0 +1,589 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import re
|
||||
from collections import deque
|
||||
from typing import Any, cast
|
||||
from uuid import UUID
|
||||
|
||||
import sqlalchemy as sa
|
||||
from dateutil import parser as date_parser
|
||||
from dateutil.parser import ParserError
|
||||
from humps import decamelize
|
||||
from sqlalchemy.ext.associationproxy import AssociationProxyInstance
|
||||
from sqlalchemy.orm import InstrumentedAttribute, Mapper
|
||||
from sqlalchemy.sql import sqltypes
|
||||
|
||||
from mealie.db.models._model_base import SqlAlchemyBase
|
||||
from mealie.db.models._model_utils.datetime import NaiveDateTime
|
||||
from mealie.db.models._model_utils.guid import GUID
|
||||
from mealie.schema._mealie.mealie_model import MealieModel
|
||||
|
||||
from .keywords import PlaceholderKeyword, RelationalKeyword
|
||||
from .operators import LogicalOperator, RelationalOperator
|
||||
|
||||
|
||||
class QueryFilterJSONPart(MealieModel):
|
||||
left_parenthesis: str | None = None
|
||||
right_parenthesis: str | None = None
|
||||
logical_operator: LogicalOperator | None = None
|
||||
|
||||
attribute_name: str | None = None
|
||||
relational_operator: RelationalKeyword | RelationalOperator | None = None
|
||||
value: str | list[str] | None = None
|
||||
|
||||
|
||||
class QueryFilterJSON(MealieModel):
|
||||
parts: list[QueryFilterJSONPart] = []
|
||||
|
||||
|
||||
class QueryFilterBuilderComponent:
|
||||
"""A single relational statement"""
|
||||
|
||||
@staticmethod
|
||||
def strip_quotes_from_string(val: str) -> str:
|
||||
if len(val) > 2 and val[0] == '"' and val[-1] == '"':
|
||||
return val[1:-1]
|
||||
else:
|
||||
return val
|
||||
|
||||
def __init__(
|
||||
self, attribute_name: str, relationship: RelationalKeyword | RelationalOperator, value: str | list[str]
|
||||
) -> None:
|
||||
self.attribute_name = decamelize(attribute_name)
|
||||
self.relationship = relationship
|
||||
|
||||
# remove encasing quotes
|
||||
if isinstance(value, str):
|
||||
value = self.strip_quotes_from_string(value)
|
||||
|
||||
elif isinstance(value, list):
|
||||
value = [self.strip_quotes_from_string(v) for v in value]
|
||||
|
||||
# validate relationship/value pairs
|
||||
if relationship in [
|
||||
RelationalKeyword.IN,
|
||||
RelationalKeyword.NOT_IN,
|
||||
RelationalKeyword.CONTAINS_ALL,
|
||||
] and not isinstance(value, list):
|
||||
raise ValueError(
|
||||
f"invalid query string: {relationship.value} must be given a list of values"
|
||||
f"enclosed by {QueryFilterBuilder.l_list_sep} and {QueryFilterBuilder.r_list_sep}"
|
||||
)
|
||||
|
||||
if relationship is RelationalKeyword.IS or relationship is RelationalKeyword.IS_NOT:
|
||||
if not isinstance(value, str) or value.lower() not in ["null", "none"]:
|
||||
raise ValueError(
|
||||
f'invalid query string: "{relationship.value}" can only be used with "NULL", not "{value}"'
|
||||
)
|
||||
|
||||
self.value = None
|
||||
else:
|
||||
self.value = value
|
||||
|
||||
# process placeholder keywords
|
||||
self.value = PlaceholderKeyword.parse_value(self.value)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return f"[{self.attribute_name} {self.relationship.value} {self.value}]"
|
||||
|
||||
def validate(self, model_attr_type: Any) -> Any:
|
||||
"""Validate value against an model attribute's type and return a validated value, or raise a ValueError"""
|
||||
|
||||
sanitized_values: list[Any]
|
||||
if not isinstance(self.value, list):
|
||||
sanitized_values = [self.value]
|
||||
else:
|
||||
sanitized_values = list(self.value)
|
||||
|
||||
for i, v in enumerate(sanitized_values):
|
||||
# always allow querying for null values
|
||||
if v is None:
|
||||
continue
|
||||
|
||||
if isinstance(model_attr_type, sqltypes.String):
|
||||
sanitized_values[i] = v.lower()
|
||||
|
||||
if self.relationship is RelationalKeyword.LIKE or self.relationship is RelationalKeyword.NOT_LIKE:
|
||||
if not isinstance(model_attr_type, sqltypes.String):
|
||||
raise ValueError(
|
||||
f'invalid query string: "{self.relationship.value}" can only be used with string columns'
|
||||
)
|
||||
|
||||
if isinstance(model_attr_type, (GUID)):
|
||||
try:
|
||||
# we don't set value since a UUID is functionally identical to a string here
|
||||
UUID(v)
|
||||
except ValueError as e:
|
||||
raise ValueError(f"invalid query string: invalid UUID '{v}'") from e
|
||||
|
||||
if isinstance(model_attr_type, sqltypes.Date | sqltypes.DateTime | NaiveDateTime):
|
||||
try:
|
||||
dt = date_parser.parse(v)
|
||||
sanitized_values[i] = dt.date() if isinstance(model_attr_type, sqltypes.Date) else dt
|
||||
except ParserError as e:
|
||||
raise ValueError(f"invalid query string: unknown date or datetime format '{v}'") from e
|
||||
|
||||
if isinstance(model_attr_type, sqltypes.Boolean):
|
||||
try:
|
||||
sanitized_values[i] = v.lower()[0] in ["t", "y"] or v == "1"
|
||||
except IndexError as e:
|
||||
raise ValueError("invalid query string") from e
|
||||
|
||||
return sanitized_values if isinstance(self.value, list) else sanitized_values[0]
|
||||
|
||||
def as_json_model(self) -> QueryFilterJSONPart:
|
||||
return QueryFilterJSONPart(
|
||||
left_parenthesis=None,
|
||||
right_parenthesis=None,
|
||||
logical_operator=None,
|
||||
attribute_name=self.attribute_name,
|
||||
relational_operator=self.relationship,
|
||||
value=self.value,
|
||||
)
|
||||
|
||||
|
||||
class QueryFilterBuilder:
|
||||
l_group_sep: str = "("
|
||||
r_group_sep: str = ")"
|
||||
group_seps: set[str] = {l_group_sep, r_group_sep}
|
||||
|
||||
l_list_sep: str = "["
|
||||
r_list_sep: str = "]"
|
||||
list_item_sep: str = ","
|
||||
|
||||
def __init__(self, filter_string: str) -> None:
|
||||
# parse filter string
|
||||
components = QueryFilterBuilder._break_filter_string_into_components(filter_string)
|
||||
base_components = QueryFilterBuilder._break_components_into_base_components(components)
|
||||
if base_components.count(QueryFilterBuilder.l_group_sep) != base_components.count(
|
||||
QueryFilterBuilder.r_group_sep
|
||||
):
|
||||
raise ValueError("invalid query string: parenthesis are unbalanced")
|
||||
|
||||
# parse base components into a filter group
|
||||
self.filter_components = QueryFilterBuilder._parse_base_components_into_filter_components(base_components)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
joined = " ".join(
|
||||
[
|
||||
str(component.value if isinstance(component, LogicalOperator) else component)
|
||||
for component in self.filter_components
|
||||
],
|
||||
)
|
||||
|
||||
return f"<<{joined}>>"
|
||||
|
||||
@classmethod
|
||||
def _consolidate_group(
|
||||
cls, group: list[sa.ColumnElement], logical_operators: deque[LogicalOperator]
|
||||
) -> sa.ColumnElement:
|
||||
consolidated_group_builder: sa.ColumnElement | None = None
|
||||
for i, element in enumerate(reversed(group)):
|
||||
if not i:
|
||||
consolidated_group_builder = element
|
||||
else:
|
||||
operator = logical_operators.pop()
|
||||
if operator is LogicalOperator.AND:
|
||||
consolidated_group_builder = sa.and_(consolidated_group_builder, element)
|
||||
elif operator is LogicalOperator.OR:
|
||||
consolidated_group_builder = sa.or_(consolidated_group_builder, element)
|
||||
else:
|
||||
raise ValueError(f"invalid logical operator {operator}")
|
||||
|
||||
if i == len(group) - 1:
|
||||
return consolidated_group_builder.self_group()
|
||||
|
||||
@classmethod
|
||||
def get_model_and_model_attr_from_attr_string[Model: SqlAlchemyBase](
|
||||
cls, attr_string: str, model: type[Model], *, query: sa.Select | None = None
|
||||
) -> tuple[SqlAlchemyBase, InstrumentedAttribute, sa.Select | None]:
|
||||
"""
|
||||
Take an attribute string and traverse a database model and its relationships to get the desired
|
||||
model and model attribute. Optionally provide a query to apply the necessary table joins.
|
||||
|
||||
If the attribute string is invalid, raises a `ValueError`.
|
||||
|
||||
For instance, the attribute string "user.name" on `RecipeModel`
|
||||
will return the `User` model's `name` attribute.
|
||||
|
||||
Works with shallow attributes (e.g. "slug" from `RecipeModel`)
|
||||
and arbitrarily deep ones (e.g. "recipe.group.preferences" on `RecipeTimelineEvent`).
|
||||
"""
|
||||
mapper: Mapper
|
||||
model_attr: InstrumentedAttribute | None = None
|
||||
|
||||
attribute_chain = decamelize(attr_string).split(".")
|
||||
if not attribute_chain:
|
||||
raise ValueError("invalid query string: attribute name cannot be empty")
|
||||
|
||||
current_model: SqlAlchemyBase = model # type: ignore
|
||||
for i, attribute_link in enumerate(attribute_chain):
|
||||
try:
|
||||
model_attr = getattr(current_model, attribute_link)
|
||||
|
||||
# proxied attributes can't be joined to the query directly, so we need to inspect the proxy
|
||||
# and get the actual model and its attribute
|
||||
if isinstance(model_attr, AssociationProxyInstance):
|
||||
proxied_attribute_link = model_attr.target_collection
|
||||
next_attribute_link = model_attr.value_attr
|
||||
model_attr = getattr(current_model, proxied_attribute_link)
|
||||
|
||||
if query is not None:
|
||||
query = query.join(model_attr, isouter=True)
|
||||
|
||||
mapper = sa.inspect(current_model)
|
||||
relationship = mapper.relationships[proxied_attribute_link]
|
||||
current_model = relationship.mapper.class_
|
||||
model_attr = getattr(current_model, next_attribute_link)
|
||||
|
||||
# at the end of the chain there are no more relationships to inspect
|
||||
if i == len(attribute_chain) - 1:
|
||||
break
|
||||
|
||||
if query is not None:
|
||||
query = query.join(model_attr, isouter=True)
|
||||
|
||||
mapper = sa.inspect(current_model)
|
||||
relationship = mapper.relationships[attribute_link]
|
||||
current_model = relationship.mapper.class_
|
||||
|
||||
except (AttributeError, KeyError) as e:
|
||||
raise ValueError(f"invalid attribute string: '{attr_string}' does not exist on this schema") from e
|
||||
|
||||
if model_attr is None:
|
||||
raise ValueError(f"invalid attribute string: '{attr_string}'")
|
||||
|
||||
return current_model, model_attr, query
|
||||
|
||||
@classmethod
|
||||
def _transform_model_attr(cls, model_attr: InstrumentedAttribute, model_attr_type: Any) -> InstrumentedAttribute:
|
||||
if isinstance(model_attr_type, sqltypes.String):
|
||||
model_attr = sa.func.lower(model_attr)
|
||||
|
||||
return model_attr
|
||||
|
||||
@classmethod
|
||||
def _get_filter_element[Model: SqlAlchemyBase](
|
||||
cls,
|
||||
query: sa.Select,
|
||||
component: QueryFilterBuilderComponent,
|
||||
model: type[Model],
|
||||
model_attr: InstrumentedAttribute,
|
||||
model_attr_type: Any,
|
||||
) -> sa.ColumnElement:
|
||||
original_model_attr = model_attr
|
||||
model_attr = cls._transform_model_attr(model_attr, model_attr_type)
|
||||
value = component.validate(model_attr_type)
|
||||
|
||||
# Keywords
|
||||
if component.relationship is RelationalKeyword.IS:
|
||||
element = model_attr.is_(value)
|
||||
elif component.relationship is RelationalKeyword.IS_NOT:
|
||||
element = model_attr.is_not(value)
|
||||
elif component.relationship is RelationalKeyword.IN:
|
||||
element = model_attr.in_(value)
|
||||
elif component.relationship is RelationalKeyword.NOT_IN:
|
||||
if original_model_attr.parent.entity != model:
|
||||
subq = query.with_only_columns(model.id).where(model_attr.in_(value))
|
||||
element = sa.not_(model.id.in_(subq))
|
||||
else:
|
||||
element = sa.not_(model_attr.in_(value))
|
||||
|
||||
elif component.relationship is RelationalKeyword.CONTAINS_ALL:
|
||||
if len(value) == 1:
|
||||
element = model_attr.in_(value)
|
||||
else:
|
||||
primary_model_attr: InstrumentedAttribute = getattr(model, component.attribute_name.split(".")[0])
|
||||
element = sa.and_(*(primary_model_attr.any(model_attr == v) for v in value))
|
||||
elif component.relationship is RelationalKeyword.LIKE:
|
||||
element = model_attr.ilike(value)
|
||||
elif component.relationship is RelationalKeyword.NOT_LIKE:
|
||||
element = model_attr.not_ilike(value)
|
||||
|
||||
# Operators
|
||||
elif component.relationship is RelationalOperator.EQ:
|
||||
element = model_attr == value
|
||||
elif component.relationship is RelationalOperator.NOTEQ:
|
||||
element = model_attr != value
|
||||
elif component.relationship is RelationalOperator.GT:
|
||||
element = model_attr > value
|
||||
elif component.relationship is RelationalOperator.LT:
|
||||
element = model_attr < value
|
||||
elif component.relationship is RelationalOperator.GTE:
|
||||
element = model_attr >= value
|
||||
elif component.relationship is RelationalOperator.LTE:
|
||||
element = model_attr <= value
|
||||
else:
|
||||
raise ValueError(f"invalid relationship {component.relationship}")
|
||||
|
||||
return element
|
||||
|
||||
def filter_query[Model: SqlAlchemyBase](
|
||||
self, query: sa.Select, model: type[Model], column_aliases: dict[str, sa.ColumnElement] | None = None
|
||||
) -> sa.Select:
|
||||
"""
|
||||
Filters a query based on the parsed filter string.
|
||||
If you need to filter on a custom column expression (e.g. a computed property), you can supply column aliases
|
||||
"""
|
||||
column_aliases = column_aliases or {}
|
||||
|
||||
# join tables and build model chain
|
||||
attr_model_map: dict[int, Any] = {}
|
||||
model_attr: InstrumentedAttribute
|
||||
for i, component in enumerate(self.filter_components):
|
||||
if not isinstance(component, QueryFilterBuilderComponent):
|
||||
continue
|
||||
|
||||
nested_model, model_attr, query = self.get_model_and_model_attr_from_attr_string(
|
||||
component.attribute_name, model, query=query
|
||||
)
|
||||
attr_model_map[i] = nested_model
|
||||
|
||||
# build query filter
|
||||
partial_group: list[sa.ColumnElement] = []
|
||||
partial_group_stack: deque[list[sa.ColumnElement]] = deque()
|
||||
logical_operator_stack: deque[LogicalOperator] = deque()
|
||||
for i, component in enumerate(self.filter_components):
|
||||
if component == self.l_group_sep:
|
||||
partial_group_stack.append(partial_group)
|
||||
partial_group = []
|
||||
|
||||
elif component == self.r_group_sep:
|
||||
if partial_group:
|
||||
complete_group = self._consolidate_group(partial_group, logical_operator_stack)
|
||||
partial_group = partial_group_stack.pop()
|
||||
partial_group.append(complete_group)
|
||||
else:
|
||||
partial_group = partial_group_stack.pop()
|
||||
|
||||
elif isinstance(component, LogicalOperator):
|
||||
logical_operator_stack.append(component)
|
||||
|
||||
else:
|
||||
component = cast(QueryFilterBuilderComponent, component)
|
||||
base_attribute_name = component.attribute_name.split(".")[-1]
|
||||
model_attr = getattr(attr_model_map[i], base_attribute_name)
|
||||
|
||||
if (column_alias := column_aliases.get(base_attribute_name)) is not None:
|
||||
model_attr = column_alias
|
||||
|
||||
element = self._get_filter_element(query, component, model, model_attr, model_attr.type)
|
||||
partial_group.append(element)
|
||||
|
||||
# combine the completed groups into one filter
|
||||
while True:
|
||||
consolidated_group = self._consolidate_group(partial_group, logical_operator_stack)
|
||||
if not partial_group_stack:
|
||||
return query.filter(consolidated_group)
|
||||
else:
|
||||
partial_group = partial_group_stack.pop()
|
||||
partial_group.append(consolidated_group)
|
||||
|
||||
@staticmethod
|
||||
def _break_filter_string_into_components(filter_string: str) -> list[str]:
|
||||
"""Recursively break filter string into components based on parenthesis groupings"""
|
||||
components = [filter_string]
|
||||
in_quotes = False
|
||||
while True:
|
||||
subcomponents = []
|
||||
for component in components:
|
||||
# don't parse components comprised of only a separator
|
||||
if component in QueryFilterBuilder.group_seps:
|
||||
subcomponents.append(component)
|
||||
continue
|
||||
|
||||
# construct a component until it hits the right separator
|
||||
new_component = ""
|
||||
for c in component:
|
||||
# ignore characters in-between quotes
|
||||
if c == '"':
|
||||
in_quotes = not in_quotes
|
||||
|
||||
if c in QueryFilterBuilder.group_seps and not in_quotes:
|
||||
if new_component:
|
||||
subcomponents.append(new_component)
|
||||
|
||||
subcomponents.append(c)
|
||||
new_component = ""
|
||||
continue
|
||||
|
||||
new_component += c
|
||||
|
||||
if new_component:
|
||||
subcomponents.append(new_component.strip())
|
||||
|
||||
if components == subcomponents:
|
||||
break
|
||||
|
||||
components = subcomponents
|
||||
|
||||
return components
|
||||
|
||||
@staticmethod
|
||||
def _break_components_into_base_components(components: list[str]) -> list[str | list[str]]:
|
||||
"""Further break down components by splitting at relational and logical operators"""
|
||||
pattern = "|".join([f"\\b{operator.value}\\b" for operator in LogicalOperator])
|
||||
logical_operators = re.compile(f"({pattern})", flags=re.IGNORECASE)
|
||||
|
||||
in_list = False
|
||||
base_components: list[str | list] = []
|
||||
list_value_components = []
|
||||
for component in components:
|
||||
# parse out lists as their own singular sub component
|
||||
subcomponents = component.split(QueryFilterBuilder.l_list_sep)
|
||||
for i, subcomponent in enumerate(subcomponents):
|
||||
if not i:
|
||||
continue
|
||||
|
||||
for j, list_value_string in enumerate(subcomponent.split(QueryFilterBuilder.r_list_sep)):
|
||||
if j % 2:
|
||||
continue
|
||||
|
||||
list_value_components.append(
|
||||
[val.strip() for val in list_value_string.split(QueryFilterBuilder.list_item_sep)]
|
||||
)
|
||||
|
||||
quote_offset = 0
|
||||
subcomponents = component.split('"')
|
||||
for i, subcomponent in enumerate(subcomponents):
|
||||
# we are in a list subcomponent, which is already handled
|
||||
if in_list:
|
||||
if QueryFilterBuilder.r_list_sep in subcomponent:
|
||||
# filter out the remainder of the list subcomponent and continue parsing
|
||||
base_components.append(list_value_components.pop(0))
|
||||
subcomponent = subcomponent.split(QueryFilterBuilder.r_list_sep, maxsplit=1)[-1].strip()
|
||||
in_list = False
|
||||
else:
|
||||
continue
|
||||
|
||||
# don't parse components comprised of only a separator
|
||||
if subcomponent in QueryFilterBuilder.group_seps:
|
||||
quote_offset += 1
|
||||
base_components.append(subcomponent)
|
||||
continue
|
||||
|
||||
# this subcomponent was surrounded in quotes, so we keep it as-is
|
||||
if (i + quote_offset) % 2:
|
||||
base_components.append(f'"{subcomponent.strip()}"')
|
||||
continue
|
||||
|
||||
# if the final subcomponent has quotes, it creates an extra empty subcomponent at the end
|
||||
if not subcomponent:
|
||||
continue
|
||||
|
||||
# continue parsing this subcomponent up to the list, then skip over subsequent subcomponents
|
||||
if not in_list and QueryFilterBuilder.l_list_sep in subcomponent:
|
||||
subcomponent, _new_sub_component = subcomponent.split(QueryFilterBuilder.l_list_sep, maxsplit=1)
|
||||
subcomponent = subcomponent.strip()
|
||||
subcomponents.insert(i + 1, _new_sub_component)
|
||||
quote_offset += 1
|
||||
in_list = True
|
||||
|
||||
# parse out logical operators
|
||||
new_components = [
|
||||
base_component.strip() for base_component in logical_operators.split(subcomponent) if base_component
|
||||
]
|
||||
|
||||
# parse out relational keywords and operators
|
||||
# each base_subcomponent has exactly zero or one keyword or operator
|
||||
for component in new_components:
|
||||
if not component:
|
||||
continue
|
||||
|
||||
# we try relational operators first since they aren't required to be surrounded by spaces
|
||||
parsed_component = RelationalOperator.parse_component(component)
|
||||
if parsed_component is not None:
|
||||
base_components.extend(parsed_component)
|
||||
continue
|
||||
|
||||
parsed_component = RelationalKeyword.parse_component(component)
|
||||
if parsed_component is not None:
|
||||
base_components.extend(parsed_component)
|
||||
continue
|
||||
|
||||
# this component does not have any keywords or operators, so we just add it as-is
|
||||
base_components.append(component)
|
||||
|
||||
return base_components
|
||||
|
||||
@staticmethod
|
||||
def _parse_base_components_into_filter_components(
|
||||
base_components: list[str | list[str]],
|
||||
) -> list[str | QueryFilterBuilderComponent | LogicalOperator]:
|
||||
"""Walk through base components and construct filter collections"""
|
||||
relational_keywords = [kw.value for kw in RelationalKeyword]
|
||||
relational_operators = [op.value for op in RelationalOperator]
|
||||
logical_operators = [op.value for op in LogicalOperator]
|
||||
|
||||
# parse QueryFilterComponents and logical operators
|
||||
components: list[str | QueryFilterBuilderComponent | LogicalOperator] = []
|
||||
for i, base_component in enumerate(base_components):
|
||||
if isinstance(base_component, list):
|
||||
continue
|
||||
|
||||
if base_component in QueryFilterBuilder.group_seps:
|
||||
components.append(base_component)
|
||||
|
||||
elif base_component in relational_keywords or base_component in relational_operators:
|
||||
relationship: RelationalKeyword | RelationalOperator
|
||||
if base_component in relational_keywords:
|
||||
relationship = RelationalKeyword(base_components[i])
|
||||
else:
|
||||
relationship = RelationalOperator(base_components[i])
|
||||
|
||||
components.append(
|
||||
QueryFilterBuilderComponent(
|
||||
attribute_name=base_components[i - 1], # type: ignore
|
||||
relationship=relationship,
|
||||
value=base_components[i + 1],
|
||||
)
|
||||
)
|
||||
|
||||
elif base_component.upper() in logical_operators:
|
||||
components.append(LogicalOperator(base_component.upper()))
|
||||
|
||||
return components
|
||||
|
||||
def as_json_model(self) -> QueryFilterJSON:
|
||||
parts: list[QueryFilterJSONPart] = []
|
||||
|
||||
current_part: QueryFilterJSONPart | None = None
|
||||
left_parens: list[str] = []
|
||||
right_parens: list[str] = []
|
||||
last_logical_operator: LogicalOperator | None = None
|
||||
|
||||
def add_part():
|
||||
nonlocal current_part, left_parens, right_parens, last_logical_operator
|
||||
if not current_part:
|
||||
return
|
||||
|
||||
current_part.left_parenthesis = "".join(left_parens) or None
|
||||
current_part.right_parenthesis = "".join(right_parens) or None
|
||||
current_part.logical_operator = last_logical_operator
|
||||
|
||||
parts.append(current_part)
|
||||
current_part = None
|
||||
left_parens.clear()
|
||||
right_parens.clear()
|
||||
last_logical_operator = None
|
||||
|
||||
for component in self.filter_components:
|
||||
if isinstance(component, QueryFilterBuilderComponent):
|
||||
if current_part:
|
||||
add_part()
|
||||
current_part = component.as_json_model()
|
||||
|
||||
elif isinstance(component, LogicalOperator):
|
||||
if current_part:
|
||||
add_part()
|
||||
last_logical_operator = component
|
||||
|
||||
elif isinstance(component, str):
|
||||
if component == QueryFilterBuilder.l_group_sep:
|
||||
left_parens.append(component)
|
||||
elif component == QueryFilterBuilder.r_group_sep:
|
||||
right_parens.append(component)
|
||||
|
||||
# add last part, if any
|
||||
add_part()
|
||||
return QueryFilterJSON(parts=parts)
|
||||
154
mealie/services/query_filter/keywords.py
Normal file
154
mealie/services/query_filter/keywords.py
Normal file
@@ -0,0 +1,154 @@
|
||||
from datetime import datetime
|
||||
from enum import Enum
|
||||
from typing import overload
|
||||
|
||||
from dateutil.relativedelta import relativedelta
|
||||
|
||||
|
||||
class PlaceholderKeyword(Enum):
|
||||
NOW = "$NOW"
|
||||
|
||||
@classmethod
|
||||
def _parse_now(cls, value: str) -> str:
|
||||
"""
|
||||
Parses a NOW value, with optional math using an int or float.
|
||||
|
||||
Operation:
|
||||
- '+'
|
||||
- '-'
|
||||
|
||||
Unit:
|
||||
- 'y' (year)
|
||||
- 'm' (month)
|
||||
- 'd' (day)
|
||||
- 'H' (hour)
|
||||
- 'M' (minute)
|
||||
- 'S' (second)
|
||||
|
||||
Examples:
|
||||
- '$NOW'
|
||||
- '$NOW+30d'
|
||||
- '$NOW-5M'
|
||||
"""
|
||||
|
||||
if not value.startswith(cls.NOW.value):
|
||||
return value
|
||||
|
||||
now = datetime.now(tz=None) # noqa: DTZ005
|
||||
remainder = value[len(cls.NOW.value) :]
|
||||
|
||||
if remainder:
|
||||
if len(remainder) < 3:
|
||||
raise ValueError(f"Invalid remainder in NOW string ({value})")
|
||||
|
||||
op = remainder[0]
|
||||
amount_str = remainder[1:-1]
|
||||
unit = remainder[-1]
|
||||
|
||||
try:
|
||||
amount = int(amount_str)
|
||||
except Exception as e:
|
||||
raise ValueError(f"Invalid amount in NOW string ({value})") from e
|
||||
|
||||
if op == "-":
|
||||
amount = -amount
|
||||
elif op != "+":
|
||||
raise ValueError(f"Invalid operator in NOW string ({value})")
|
||||
|
||||
if unit == "y":
|
||||
delta = relativedelta(years=amount)
|
||||
elif unit == "m":
|
||||
delta = relativedelta(months=amount)
|
||||
elif unit == "d":
|
||||
delta = relativedelta(days=amount)
|
||||
elif unit == "H":
|
||||
delta = relativedelta(hours=amount)
|
||||
elif unit == "M":
|
||||
delta = relativedelta(minutes=amount)
|
||||
elif unit == "S":
|
||||
delta = relativedelta(seconds=amount)
|
||||
else:
|
||||
raise ValueError(f"Invalid time unit in NOW string ({value})")
|
||||
|
||||
dt = now + delta
|
||||
|
||||
else:
|
||||
dt = now
|
||||
|
||||
return dt.isoformat()
|
||||
|
||||
@overload
|
||||
@classmethod
|
||||
def parse_value(cls, value: str) -> str: ...
|
||||
|
||||
@overload
|
||||
@classmethod
|
||||
def parse_value(cls, value: list[str]) -> list[str]: ...
|
||||
|
||||
@overload
|
||||
@classmethod
|
||||
def parse_value(cls, value: None) -> None: ...
|
||||
|
||||
@classmethod
|
||||
def parse_value(cls, value: str | list[str] | None) -> str | list[str] | None:
|
||||
if not value:
|
||||
return value
|
||||
|
||||
if isinstance(value, list):
|
||||
return [cls.parse_value(v) for v in value]
|
||||
|
||||
if value.startswith(PlaceholderKeyword.NOW.value):
|
||||
return cls._parse_now(value)
|
||||
|
||||
return value
|
||||
|
||||
|
||||
class RelationalKeyword(Enum):
|
||||
IS = "IS"
|
||||
IS_NOT = "IS NOT"
|
||||
IN = "IN"
|
||||
NOT_IN = "NOT IN"
|
||||
CONTAINS_ALL = "CONTAINS ALL"
|
||||
LIKE = "LIKE"
|
||||
NOT_LIKE = "NOT LIKE"
|
||||
|
||||
@classmethod
|
||||
def parse_component(cls, component: str) -> list[str] | None:
|
||||
"""
|
||||
Try to parse a component using a relational keyword
|
||||
|
||||
If no matching keyword is found, returns None
|
||||
"""
|
||||
|
||||
# extract the attribute name from the component
|
||||
parsed_component = component.split(maxsplit=1)
|
||||
if len(parsed_component) < 2:
|
||||
return None
|
||||
|
||||
# assume the component has already filtered out the value and try to match a keyword
|
||||
# if we try to filter out the value without checking first, keywords with spaces won't parse correctly
|
||||
possible_keyword = parsed_component[1].strip().lower()
|
||||
for rel_kw in sorted([keyword.value for keyword in cls], key=len, reverse=True):
|
||||
if rel_kw.lower() != possible_keyword:
|
||||
continue
|
||||
|
||||
parsed_component[1] = rel_kw
|
||||
return parsed_component
|
||||
|
||||
# there was no match, so the component may still have the value in it
|
||||
try:
|
||||
_possible_keyword, _value = parsed_component[-1].rsplit(maxsplit=1)
|
||||
parsed_component = [parsed_component[0], _possible_keyword, _value]
|
||||
except ValueError:
|
||||
# the component has no value to filter out
|
||||
return None
|
||||
|
||||
possible_keyword = parsed_component[1].strip().lower()
|
||||
for rel_kw in sorted([keyword.value for keyword in cls], key=len, reverse=True):
|
||||
if rel_kw.lower() != possible_keyword:
|
||||
continue
|
||||
|
||||
parsed_component[1] = rel_kw
|
||||
return parsed_component
|
||||
|
||||
return None
|
||||
33
mealie/services/query_filter/operators.py
Normal file
33
mealie/services/query_filter/operators.py
Normal file
@@ -0,0 +1,33 @@
|
||||
from enum import Enum
|
||||
|
||||
|
||||
class LogicalOperator(Enum):
|
||||
AND = "AND"
|
||||
OR = "OR"
|
||||
|
||||
|
||||
class RelationalOperator(Enum):
|
||||
EQ = "="
|
||||
NOTEQ = "<>"
|
||||
GT = ">"
|
||||
LT = "<"
|
||||
GTE = ">="
|
||||
LTE = "<="
|
||||
|
||||
@classmethod
|
||||
def parse_component(cls, component: str) -> list[str] | None:
|
||||
"""
|
||||
Try to parse a component using a relational operator
|
||||
|
||||
If no matching operator is found, returns None
|
||||
"""
|
||||
|
||||
for rel_op in sorted([operator.value for operator in cls], key=len, reverse=True):
|
||||
if rel_op not in component:
|
||||
continue
|
||||
|
||||
parsed_component = [base_component.strip() for base_component in component.split(rel_op) if base_component]
|
||||
parsed_component.insert(1, rel_op)
|
||||
return parsed_component
|
||||
|
||||
return None
|
||||
Reference in New Issue
Block a user