File names jinja2.py cannot import jinja2

[Daniel Greenfeld]

On ​https://docs.djangoproject.com/en/1.8/topics/templates/ it says to create a file at myproject/jinja2.py which includes import jinja2 , which breaks on the fact that you can't import a module into something named the same as the module.

[Nick Pope]

I presume that you are using Python 2? Try:

from __future__ import absolute_import
import jinja2
# ...

This should probably be documented...

[Daniel Greenfeld]

Probably. ;)

My entire history of documentation contributions can be summed up as, "If readers copy/paste the code examples and they don't work, then the documentation is broken."

[Simon Charette]

Here's ​an example of someone who had this exact issue.

[Tim Graham]

Good?

diff --git a/docs/topics/templates.txt b/docs/topics/templates.txt
index 9f0048b..d3b951a 100644
--- a/docs/topics/templates.txt
+++ b/docs/topics/templates.txt
@@ -415,6 +415,8 @@ APIs, you must configure them into the environment.
 
 For example, you can create ``myproject/jinja2.py`` with this content::
 
+    from __future__ import absolute_import  # Python 2 only
+
     from django.contrib.staticfiles.storage import staticfiles_storage
     from django.core.urlresolvers import reverse
 

[Aymeric Augustin]

Yes, you can ship that. Thanks!

[Tim Graham <timograham@…>]

In d974c89:

Fixed #24646 -- Fixed jinja2 example on Python 2.

[Tim Graham <timograham@…>]

In 9e5e491:

[1.8.x] Fixed #24646 -- Fixed jinja2 example on Python 2.

Backport of d974c89ebb8a59d91f664035d98d42dbb5cdd592 from master

[taigit]

The previous fix still has the same problem and causes a django error.
see: ​http://stackoverflow.com/questions/40873096/error-when-using-jinja2-as-django-template-engine-cannot-import-name-environme/40873097#40873097

A fix that will get rid of the problem:
change: myproject/jinja2.py
to myproject/jinja2_bridge.py

in the documentation.

[Tim Graham]

I can't reproduce a problem unless I remove the from __future__ import absolute_import that the commit for this ticket added. Could you please provide a sample project that reproduces the problem? Ideally, you would use our support channnels rather than this ticket tracker. Thanks.

[Aymeric Augustin]

The point is almost moot as the next version of Django will drop support for Python 2, and this problem can't happen on Python 3.