Buildable views¶

Django’s class-based views are used to render HTML pages to flat files. Putting all the pieces together is a little tricky at first, particularly if you haven’t studied the Django source code or lack experience working with Python classes in general. But if you figure it out, we think it’s worth the trouble.

BuildableTemplateView¶

class BuildableTemplateView¶

Renders and builds a simple template as a flat file. Extended from Django’s generic TemplateView.

build_path¶: The target location of the built file in the BUILD_DIR. index.html would place it at the built site’s root. foo/index.html would place it inside a subdirectory. Required.

template_name¶: The name of the template you would like Django to render. Required.

build()¶: Writes the rendered template’s HTML to a flat file. Only override this if you know what you’re doing.

build_method¶: An alias to the build method used by the management commands

Example myapp/views.py

from bakery.views import BuildableTemplateView

class ExampleTemplateView(BuildableTemplateView):
    build_path = 'examples/index.html'
    template_name = 'examples.html'

BuildableListView¶

class BuildableListView¶

Render and builds a page about a list of objects. Extended from Django’s generic ListView.

model¶: A Django database model where the list of objects can be drawn with a Model.objects.all() query. Optional. If you want to provide a more specific list, define the queryset attribute instead.

queryset¶: The list of objects that will be provided to the template. Can be any iterable of items, not just a Django queryset. Optional, but if this attribute is not defined the model attribute must be defined.

build_path¶: The target location of the flat file in the BUILD_DIR. Optional. The default is index.html, would place the flat file at the site’s root. Defining it as foo/index.html would place the flat file inside a subdirectory.

template_name¶: The template you would like Django to render. You need to override this if you don’t want to rely on the Django ListView defaults.

build_method¶: An alias to the build_queryset method used by the management commands

build_queryset()¶: Writes the rendered template’s HTML to a flat file. Only override this if you know what you’re doing.

Example myapp/views.py

from myapp.models import MyModel
from bakery.views import BuildableListView


class ExampleListView(BuildableListView):
    model = MyModel
    template_name = 'mymodel_list.html'


class DifferentExampleListView(BuildableListView):
    build_path = 'mymodel/index.html'
    queryset = MyModel.objects.filter(is_published=True)
    template_name = 'mymodel_list.html'

BuildableDetailView¶

class BuildableDetailView¶

Render and build a “detail” page about an object or a series of pages about a list of objects. Extended from Django’s generic DetailView.

model¶: A Django database model where the list of objects can be drawn with a Model.objects.all() query. Optional. If you want to provide a more specific list, define the queryset attribute instead.

queryset¶: The Django model queryset objects are to be looked up from. Optional, but if this attribute is not defined the model attribute must be defined.

template_name¶: The name of the template you would like Django to render. You need to override this if you don’t want to rely on the default, which is os.path.join(settings.BUILD_DIR, obj.get_absolute_url(), 'index.html').

get_build_path(obj)¶: Used to determine where to build the detail page. Override this if you would like your detail page at a different location. By default it will be built at os.path.join(obj.get_url(), "index.html".

get_html(obj)¶: How to render the output for the provided object’s page. If you choose to render using something other than a Django template, like HttpResponse for instance, you will want to override this. By default it uses the template object’s default render method.

get_url(obj)¶: Returns the build directory, and therefore the URL, where the provided object’s flat file should be placed. By default is it obj.get_absolute_url().

build_method¶: An alias to the build_queryset method used by the management commands

build_object(obj)¶: Writes the rendered HTML for the template and the provided object to the build directory.

build_queryset()¶: Writes the rendered template’s HTML for each object in the queryset or model to a flat file. Only override this if you know what you’re doing.

unbuild_object(obj)¶: Deletes the directory where the provided object’s flat files are stored.

Example myapp/views.py

from myapp.models import MyModel
from bakery.views import BuildableDetailView


class ExampleDetailView(BuildableListView):
    queryset = MyModel.objects.filter(is_published=True)
    template_name = 'mymodel_detail.html'

Buildable404View¶

class Buildable404View¶

Renders and builds a simple 404 error page template as a flat file. Extended from the BuildableTemplateView above.

All it does

from bakery.views import BuildableTemplateView


class Buildable404View(BuildableTemplateView):
    build_path = '404.html'
    template_name = '404.html'