jinja2: improve error context information #4842
Merged
Conversation
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
hjoliver
reviewed
May 2, 2022
oliver-sanders
force-pushed
the
jinja2-error-context
branch
3 times, most recently
from
1105aa4
to
6f5b8e6
Compare
* When `{% include %}` statements are involved, the error context we
extract highlights the include statement as the error *not* the actual
line where the error happened.
* This expands the context extraction to pull out the relevant lines
from include files where this happens.
oliver-sanders
force-pushed
the
jinja2-error-context
branch
from
6f5b8e6
to
a5d6c03
Compare
oliver-sanders
commented
May 5, 2022
| @@ -80,7 +111,7 @@ def __init__(self, reason, index=None, line=None, lines=None, | |||
| self.fpath = fpath | |||
| self.help_lines = help_lines or [] | |||
|
|
|||
| def __str__(self): | |||
| def __str__(self) -> str: | |||
There was a problem hiding this comment.
Obvious but mypy needs this to work.
MetRonnie
approved these changes
May 10, 2022
There was a problem hiding this comment.
Tested out. Before:
Jinja2Error: Jinja2 Error: some error
Context lines:
# line before include
{% include "foo.cylc" %} <-- Exception
After:
Jinja2Error: Jinja2 Error: some error
File ~/cylc-run/GAH/foo.cylc
# line before error
{{ raise('some error') }}
# line after error <-- Exception
File ~/cylc-run/GAH/flow.cylc
#!Jinja2
# line before include
{% include "foo.cylc" %} <-- Exception
Minor niggle is that the traceback is reversed compared to what you would expect i.e. foo.cylc comes before flow.cylc
hjoliver
approved these changes
May 12, 2022
MetRonnie
approved these changes
May 12, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Our Jinja2 error context reporting gets stuck on include statements.
A couple of our Cylc 8 trialers have hit Python 2->3 issues (e.g.
dict.keys()) that have been obscured by this. I suspect a few more will run into similar issues. It's quite hard to debug these issues when all you see isTypeErrorand the line the{% includestatement is on.Took a look, seems an easy fix.
Example
Should validate with Cylc 7 but fail with Cylc 8 due to Python the 2->3 change in
dict.keysreturn type:(flow.cylc)
(foo.cylc)
Before this change only the
{% includeline would be highlighted, after this change the real error should also appear in the error.Requirements check-list
CONTRIBUTING.mdand added my name as a Code Contributor.setup.cfgandconda-environment.yml.