[Solved]-Django: efficient template/string separation and override

by

2👍

✅

You can either inherit TemplateView or add ContextMixin to your view, and then override the get_context_data function like this:

from django.views.generic import TemplateView

class BaseView(TemplateView):
    template_name = "common.html"

class SubView(BaseView):
    def get_context_data(self, **kwargs):
        context = super(SubView, self).get_context_data(**kwargs)
        context['content'] = "Some sub view text"
        return context

Update: Use template overriding

If you want to separate the text out, this is the better way to go
To allow easily and DRY override template across apps, you might need to install this package (Some other detail here)

We define it similarly as above, but change the template_name instead: 

from django.views.generic import TemplateView

    class BaseView(TemplateView):
        template_name = "main.html"

    # on another app
    class SubView(BaseView):
        template_name = "sub_view.html"

Then the magic is you can extends and override block of the BaseView template like this:

base_app/templates/main.html

<p>I'm Common Text</p>
{% block main %}
  <p>I'm Base View</p>
{% endblock %}

sub_app/templates/sub_view.html

{% extends "base_app:main.html" %}
{% block main %}
  <p>I'm Sub View</p>
{% endblock %}

The result would be:

<p>I'm Common Text</p>
<p>I'm Sub View</p>
👤Nathan Do

0👍

Afaik you covered the options pretty well. My example is probably just a variant of the the template strings but maybe it helps anyway…

class DefaultStringProvider():
    TITLE = 'Hello'
    DESCRIPTION = 'Original description'
    CATEGORY = 'Stuff'

class MyTemplateBaseView(TemplateView):
    def get_context_data(self, **kwargs):
        return super(MyTemplateBaseView, self).get_context_data(
            provider=self.get_string_provider(), **kwargs)

    def get_string_provider(self):
        return DefaultStringProvider()

class OtherView(MyTemplateBaseView):
    template_name = 'welcome.html'

    def get_string_provider(self):
        p = DefaultStringProvider()
        p.TITLE = 'Hello'
        p.DESCRIPTION = 'New description'
        return p

The idea is to have a default string provider and the base view populates the context with it through get_string_provider().

It will at least be quite clear which strings can be overridden for a user extending the base class and it will not interfere with translations.

👤Daniel Backman

Leave a comment