Ticket #1586: local_app_templates.diff

django/conf/project_template/settings.py

@@ -53 +53 @@
 # List of callables that know how to import templates from various sources.
 TEMPLATE_LOADERS = (
     'django.template.loaders.filesystem.load_template_source',
+    'django.template.loaders.local_app_templates.load_template_source',
     'django.template.loaders.app_directories.load_template_source',
 #     'django.template.loaders.eggs.load_template_source',
 )

django/conf/global_settings.py

@@ -142 +142 @@
 # documentation.
 TEMPLATE_LOADERS = (
     'django.template.loaders.filesystem.load_template_source',
+    'django.template.loaders.local_app_templates.load_template_source',
     'django.template.loaders.app_directories.load_template_source',
 #     'django.template.loaders.eggs.load_template_source',
 )

django/template/loaders/local_app_templates.py

@@ +1 @@
+"""
+Wrapper for loading templates from "app_templates" directories in INSTALLED_APPS
+packages.
+
+Each "app_templates" directory is loaded as a virtual subdirectory matching the
+app name for which it exists in. For example::
+
+    myapp/app_templates/base.htm == {% extends "myapp/base.htm" %}
+"""
+
+import os
+
+from django.conf import settings
+from django.core.exceptions import ImproperlyConfigured
+from django.template import TemplateDoesNotExist
+from django.utils._os import safe_join
+
+# At compile time, cache the directories to search.
+app_template_dirs = {}
+for app in settings.INSTALLED_APPS:
+    i = app.rfind('.')
+    if i == -1:
+        m, a = app, None
+    else:
+        m, a = app[:i], app[i+1:]
+    try:
+        if a is None:
+            mod = __import__(m, {}, {}, [])
+        else:
+            mod = getattr(__import__(m, {}, {}, [a]), a)
+    except ImportError, e:
+        raise ImproperlyConfigured, 'ImportError %s: %s' % (app, e.args[0])
+    app_dir = os.path.dirname(mod.__file__)
+    template_dir = os.path.join(app_dir, 'app_templates')
+    print template_dir
+    if os.path.isdir(template_dir):
+        app_template_dirs[os.path.basename(app_dir)] = template_dir
+
+def load_template_source(template_name, template_dirs=None):
+    template_bits = os.path.normpath(template_name).split(os.sep, 1)
+    if len(template_bits) == 2:
+        app_name, template_partname = template_bits
+        if app_name in app_template_dirs:
+            filepath = safe_join(app_template_dirs[app_name], template_partname)
+            try:
+                return (open(filepath).read().decode(settings.FILE_CHARSET),
+                        filepath)
+            except IOError:
+                pass
+    raise TemplateDoesNotExist, template_name
+load_template_source.is_usable = True

docs/settings.txt

@@ -930 +930 @@
 TEMPLATE_LOADERS
 ----------------
 
-Default: ``('django.template.loaders.filesystem.load_template_source',)``
+Default::
 
+    ('django.template.loaders.filesystem.load_template_source',
+     'django.template.loaders.local_app_templates.load_template_source',
+     'django.template.loaders.app_directories.load_template_source',)
+
 A tuple of callables (as strings) that know how to import templates from
 various sources. See the `template documentation`_.
 

docs/templates_python.txt

@@ -548 +548 @@
     It caches a list of which ``INSTALLED_APPS`` packages have a ``templates``
     subdirectory.
 
+``django.template.loaders.local_app_templates.load_template_source``
+    Loads templates from Django apps on the filesystem. For each app in
+    ``INSTALLED_APPS``, the loader looks for an ``app_templates`` subdirectory.
+    If the directory exists, Django will look for templates starting with a
+    directory matching the app name in there.
+
+    For example, for this setting::
+
+        INSTALLED_APPS = ('myproject.polls', 'myproject.music')
+
+    ...then ``get_template('polls/foo.html')`` will look for templates in:
+
+        * ``/path/to/myproject/polls/app_templates/foo.html``
+
+    ...or ``get_template('music/foo.html')`` will look for templates in:
+
+        * ``/path/to/myproject/music/app_templates/foo.html``
+
+    This loader has the same distribution advantages of ``app_directories`` but
+    is more efficient, since it only checks for templates in the application
+    directory.
+
+    Note that like to the ``app_directories`` loader, this loader performs a
+    similar optimization when it is first imported, caching a list of which
+    ``INSTALLED_APPS`` packages have an ``app_templates`` subdirectory.
+
 ``django.template.loaders.eggs.load_template_source``
     Just like ``app_directories`` above, but it loads templates from Python
     eggs rather than from the filesystem.