Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Error in printing exception with undefined variable in import statement #1037

jlumpe opened this issue Jul 20, 2019 · 0 comments · Fixed by #1114

Error in printing exception with undefined variable in import statement #1037

jlumpe opened this issue Jul 20, 2019 · 0 comments · Fixed by #1114


Copy link

@jlumpe jlumpe commented Jul 20, 2019

When making the mistake of using the "python syntax" in an import statement and forgetting to enclose the template name in quotes, and when the name corresponds to an undefined variable, a TemplateNotFound exception is raised with Undefined as the template name and prints an uninformative message.

Expected Behavior

Probably checking the type of the template name expression, and if it's not a string report that instead of TemplateNotFound.

Actual Behavior

Exception prints as

jinja2.exceptions.TemplateNotFound: <exception str() failed>

in Python REPL and

<class 'str'>: (<class 'TypeError'>, TypeError('__str__ returned non-string (type Undefined)',))

in IPython.

Template Code

{% from foo import bar %}

Full Traceback

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/Users/student/anaconda/lib/python3.6/site-packages/jinja2/", line 76, in render
    return original_render(self, *args, **kwargs)
  File "/Users/student/anaconda/lib/python3.6/site-packages/jinja2/", line 1008, in render
    return self.environment.handle_exception(exc_info, True)
  File "/Users/student/anaconda/lib/python3.6/site-packages/jinja2/", line 780, in handle_exception
    reraise(exc_type, exc_value, tb)
  File "/Users/student/anaconda/lib/python3.6/site-packages/jinja2/", line 37, in reraise
    raise value.with_traceback(tb)
  File "<template>", line 1, in top-level template code
  File "/Users/student/anaconda/lib/python3.6/site-packages/jinja2/", line 286, in get_source
    raise TemplateNotFound(template)
jinja2.exceptions.TemplateNotFound: <exception str() failed>

In the innermost line raise TemplateNotFound(template), template is Undefined. TemplateNotFound.__str__() just returns self.message, which is also Undefined, so the exact behavior is dependent on what exactly is doing the exception handling/printing.

Granted, this is probably unlikely to happen when loading from actual template files because of the inclusion of a file extension in the name, but I was testing with DictLoader and the keys were just alphanumeric strings. It took a while to figure out what the actual problem was.

Your Environment

  • Python version: 3.6.2
  • Jinja version: 2.10
@davidism davidism added this to the 2.11.0 milestone Dec 5, 2019
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 13, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
None yet
None yet

Successfully merging a pull request may close this issue.

2 participants