-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(forms): rewrite structure / jexl evaluator
The new structure / jexl evaluator works a bit differently: Instead of trying to replace evaluation contexts during recursive evaluation (for example is_hidden checks), we now have a local JEXL runtime for each field. Also, the JEXL expressions (or their results, rather) are heavily cached and should speed things up significantly. Note this is WIP, many tests are still failing, but many are already succeeding as well. We're trying to keep the test cases 100% unchanged - the only modifications currently are some improved assertion messages, so debugging becomes easier.
- Loading branch information
Showing
13 changed files
with
1,372 additions
and
408 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| import weakref | ||
| from collections import ChainMap | ||
| from functools import partial | ||
|
|
||
| from pyjexl.analysis import ValidatingAnalyzer | ||
|
|
||
| from caluma.caluma_form.jexl import QuestionMissing | ||
|
|
||
| from ..caluma_core.jexl import ( | ||
| JEXL, | ||
| ExtractTransformArgumentAnalyzer, | ||
| ExtractTransformSubjectAnalyzer, | ||
| ExtractTransformSubjectAndArgumentsAnalyzer, | ||
| ) | ||
| from .structure import Field | ||
|
|
||
| """ | ||
| Rewrite of the JEXL handling code. | ||
| Design principles: | ||
| * The JEXL classes do not deal with context switching between questions anymore | ||
| * The QuestionJexl class only sets up the "runtime", any context is used from the | ||
| structure2 code | ||
| * We only deal with the *evaluation*, no transform/extraction is happening here - that code | ||
| is mostly fine and doesn't need a rewrite | ||
| * Caching is done by the structure2 code, not here | ||
| * JEXL evaluation happens lazily, but the results are cached. | ||
| """ | ||
|
|
||
|
|
||
| class QuestionValidatingAnalyzer(ValidatingAnalyzer): | ||
| def visit_Transform(self, transform): | ||
| if transform.name == "answer" and not isinstance(transform.subject.value, str): | ||
| yield f"{transform.subject.value} is not a valid question slug." | ||
|
|
||
| yield from super().visit_Transform(transform) | ||
|
|
||
|
|
||
| class QuestionJexl2(JEXL): | ||
| def __init__(self, field, **kwargs): | ||
| super().__init__(**kwargs) | ||
| self.field = weakref.proxy(field) | ||
|
|
||
| self.add_transform("answer", self.answer_transform) | ||
|
|
||
| def answer_transform(self, question_slug, *args): | ||
| field = self.field.get_field(question_slug) | ||
|
|
||
| def _default_or_empty(): | ||
| if len(args): | ||
| return args[0] | ||
| return field.question.empty_value() | ||
|
|
||
| if not field: | ||
| if args: | ||
| return args[0] | ||
| else: | ||
| # No default arg, so we must raise an exception | ||
| raise QuestionMissing( | ||
| f"Question `{question_slug}` could not be found in form {self.field.get_form()}" | ||
| ) | ||
|
|
||
| if field.is_hidden(): | ||
| # Hidden fields *always* return the empty value, even if we have | ||
| # a default | ||
| return field.question.empty_value() | ||
| elif field.is_empty(): | ||
| # not hidden, but empty | ||
| return _default_or_empty() | ||
|
|
||
| return field.get_value() | ||
|
|
||
| def validate(self, expression, **kwargs): | ||
| return super().validate(expression, QuestionValidatingAnalyzer) | ||
|
|
||
| def extract_referenced_questions(self, expr): | ||
| transforms = ["answer"] | ||
| yield from self.analyze( | ||
| expr, partial(ExtractTransformSubjectAnalyzer, transforms=transforms) | ||
| ) | ||
|
|
||
| def extract_referenced_questions_with_arguments(self, expr): | ||
| transforms = ["answer"] | ||
| yield from self.analyze( | ||
| expr, | ||
| partial(ExtractTransformSubjectAndArgumentsAnalyzer, transforms=transforms), | ||
| ) | ||
|
|
||
| def extract_referenced_mapby_questions(self, expr): | ||
| transforms = ["mapby"] | ||
| yield from self.analyze( | ||
| expr, partial(ExtractTransformArgumentAnalyzer, transforms=transforms) | ||
| ) | ||
|
|
||
| def _get_referenced_fields(self, field: Field, expr: str): | ||
| deps = list(self.extract_referenced_questions_with_arguments(expr)) | ||
| referenced_fields = [self._structure.get_field(slug) for slug, _ in deps] | ||
|
|
||
| referenced_slugs = [ref.question.slug for ref in referenced_fields if ref] | ||
|
|
||
| for slug, args in deps: | ||
| required = len(args) == 0 | ||
| if slug not in referenced_slugs and required: | ||
| raise QuestionMissing( | ||
| f"Question `{slug}` could not be found in form {field.form}" | ||
| ) | ||
|
|
||
| return [field for field in referenced_fields if field] | ||
|
|
||
| def evaluate(self, expr, raise_on_error=True): | ||
| try: | ||
| return super().evaluate(expr, ChainMap(self.context)) | ||
| except ( | ||
| TypeError, | ||
| ValueError, | ||
| ZeroDivisionError, | ||
| AttributeError, | ||
| ): | ||
| if raise_on_error: | ||
| raise | ||
| return None |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.