Skip to main content

Template loader allowing you to both extend and override a template at the same time.

Project description

Build Status - develop branch Coverage of the code

Provides a template loader that allows you to load a template from a specific application. This allows you to both extend and override a template at the same time.

The default Django loaders require you to copy the entire template you want to override, even if you only want to override one small block.

This is the issue that this package tries to resolve.

Examples:

You want to change the titles of the admin site, you would originally created this template:

$ cat my-project/templates/admin/base_site.html
{% extends "admin/base.html" %}
{% load i18n %}

{% block title %}{{ title }} | My Project{% endblock %}

{% block branding %}
<h1 id="site-name">My Project</h1>
{% endblock %}

{% block nav-global %}{% endblock %}

Extend and override version with a namespace:

$ cat my-project/templates/admin/base_site.html
{% extends "admin:admin/base_site.html" %}

{% block title %}{{ title }} - My Project{% endblock %}

{% block branding %}
<h1 id="site-name">My Project</h1>
{% endblock %}

Note that in this version the block nav-global does not have to be present because of the inheritance.

Shorter version without namespace:

$ cat my-project/templates/admin/base_site.html
{% extends ":admin/base_site.html" %}

{% block title %}{{ title }} - My Project{% endblock %}

{% block branding %}
<h1 id="site-name">My Project</h1>
{% endblock %}

If we do not specify the application namespace, the first matching template will be used. This is useful when several applications provide the same templates but with different features.

Example of multiple empty namespaces:

$ cat my-project/application/templates/application/template.html
{% block content%}
<p>Application</p>
{% endblock content%}

$ cat my-project/application_extension/templates/application/template.html
{% extends ":application/template.html" %}
{% block content%}
{{ block.super }}
<p>Application extension</p>
{% endblock content%}

$ cat my-project/templates/application/template.html
{% extends ":application/template.html" %}
{% block content%}
{{ block.super }}
<p>Application project</p>
{% endblock content%}

Will render:

<p>Application</p>
<p>Application extension</p>
<p>Application project</p>

Installation

Add app_namespace.Loader to the TEMPLATE_LOADERS setting of your project.

TEMPLATE_LOADERS = [
  'app_namespace.Loader',
  ... # Other template loaders
]

Known limitations

app_namespace.Loader can not work properly if you use it in conjunction with django.template.loaders.cached.Loader and inheritance based on empty namespaces.

Notes

Based originally on: http://djangosnippets.org/snippets/1376/

Requires: Django >= 1.4

Tested with Python 2.6, 2.7, 3.2, 3.3.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

django_app_namespace_template_loader-0.2-py2.py3-none-any.whl (13.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-app-namespace-template-loader-0.2.tar.gz.

File metadata

File hashes

Hashes for django-app-namespace-template-loader-0.2.tar.gz
Algorithm Hash digest
SHA256 ca4691253d2cf429f01ac44b420b55a6750dbf54ce64f613b4de735c3bc24c7b
MD5 8724cd16c1a4c3a9dc9995c9373e2b84
BLAKE2b-256 831ff13cc63eeba65fbe5c218748499a640545175fa9abaccddffe94137eb530

See more details on using hashes here.

File details

Details for the file django_app_namespace_template_loader-0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_app_namespace_template_loader-0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 27d5414438d460563ce44941a5f99d9ea624faae20729c23df20351580d2f931
MD5 200d87c42a21ba47dd66b9dd7445c37a
BLAKE2b-256 56643e6c42500811ffebb17925c599a88590463f0b699586a5b64bc73c9f12c6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page