Source code for hawat.blueprints.skeleton

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# -------------------------------------------------------------------------------
# This file is part of Mentat system (
# Copyright (C) since 2011 CESNET, z.s.p.o (
# Use of this source is governed by the MIT license, see LICENSE file.
# -------------------------------------------------------------------------------

This pluggable module is a highly commented skeleton and an example implementation.

__author__ = "Jan Mach <>"
__credits__ = "Pavel Kácha <>, Andrea Kropáčová <>"

import flask_login
from flask_babel import lazy_gettext

from hawat.base import HawatBlueprint
from hawat.view import SimpleView
from hawat.view.mixin import HTMLMixin

BLUEPRINT_NAME = 'skeleton'
"""Name of the blueprint as module global constant."""

[docs]class ExampleView(HTMLMixin, SimpleView): """ Example simple view. """ decorators = [flask_login.login_required] methods = ['GET']
[docs] @classmethod def get_view_name(cls): return 'example'
[docs] @classmethod def get_view_icon(cls): return 'example'
[docs] @classmethod def get_menu_title(cls, **kwargs): return 'Example view'
[docs] @classmethod def get_view_title(cls, **kwargs): return 'Example view'
[docs] @classmethod def get_view_template(cls): return '{}/example.html'.format(BLUEPRINT_NAME)
[docs] def do_before_response(self, **kwargs): pass
# -------------------------------------------------------------------------------
[docs]class SkeletonBlueprint(HawatBlueprint): """Pluggable module - skeleton (*skeleton*)."""
[docs] @classmethod def get_module_title(cls): return lazy_gettext('Skeleton module')
[docs] def register_app(self, app): app.menu_main.add_entry( 'view', 'more.{}'.format(BLUEPRINT_NAME), position=1000, view=ExampleView )
# -------------------------------------------------------------------------------
[docs]def get_blueprint(): """ Mandatory interface for :py:mod:`hawat.Hawat` and factory function. This function must return a valid instance of :py:class:`` or :py:class:`flask.Blueprint`. """ hbp = SkeletonBlueprint( BLUEPRINT_NAME, __name__, template_folder='templates', url_prefix='/{}'.format(BLUEPRINT_NAME) ) hbp.register_view_class(ExampleView, '/example') return hbp