hawat.blueprints.hosts package
This file contains pluggable module for Hawat web interface containing features related to real time dashboard calculations for IDEA events. This module is currently experimental, because the searching and statistical calculations can be very performance demanding.
- class hawat.blueprints.hosts.APISearchView[source]
Bases:
AJAXMixin
,AbstractSearchView
View responsible for querying IDEA event database and presenting the results in the form of JSON document.
- classmethod get_view_name()[source]
Implementation of
hawat.view.BaseView.get_view_name()
.
- methods: t.ClassVar[t.Optional[t.Collection[str]]] = ['GET', 'POST']
The methods this view is registered for. Uses the same default (
["GET", "HEAD", "OPTIONS"]
) asroute
andadd_url_rule
by default.
- class hawat.blueprints.hosts.AbstractSearchView[source]
Bases:
PsycopgMixin
,BaseSearchView
Base class for view responsible for searching…
- authentication = True
Similar to the
decorators
mechanism in Flask pluggable views, you may use this class variable to specify, that the view is protected by authentication. During the process of registering the view into the blueprint inhawat.app.hawatBlueprint.register_view_class()
the view will be automatically decorated withflask_login.login_required()
decorator.The advantage of using this in favor of
decorators
is that the application menu can automatically hide/show items inaccessible to current user.This is a scalar variable that must contain boolean
True
orFalse
.
- authorization = [<Permission needs={Need(method='role', value='maintainer'), Need(method='role', value='admin')} excludes=set()>]
Similar to the
decorators
mechanism in Flask pluggable views, you may use this class variable to specify, that the view is protected by authorization. During the process of registering the view into the blueprint inhawat.app.hawatBlueprint.register_view_class()
the view will be automatically decorated with given authorization decorators.The advantage of using this in favor of
decorators
is that the application menu can automatically hide/show items inaccessible to current user.This is a list variable that must contain list of desired decorators.
- do_before_response(**kwargs)[source]
This method will be called just before generating the response. By providing some meaningfull implementation you can use it for some simple item and response context mangling tasks.
- Parameters
kwargs – Custom additional arguments.
Return menu entry title for the view.
Default implementation returns the return value of
hawat.view.BaseView.get_view_title()
method by default.- Parameters
kwargs (dict) – Optional parameters.
- Returns
Menu entry title for the view.
- Return type
str
- static get_search_form(request_args)[source]
Must return instance of
flask_wtf.FlaskForm
appropriate for searching given type of items.
- classmethod get_view_title(**kwargs)[source]
Return title for the view, that will be displayed in the
title
tag of HTMLhead
element and also as the content of page header inh2
tag.Default implementation returns the return value of
hawat.view.BaseView.get_menu_title()
method by default.- Parameters
kwargs (dict) – Optional parameters.
- Returns
Title for the view.
- Return type
str
- hawat.blueprints.hosts.BLUEPRINT_NAME = 'hosts'
Name of the blueprint as module global constant.
- class hawat.blueprints.hosts.HostsBlueprint(name, import_name, **kwargs)[source]
Bases:
HawatBlueprint
Pluggable module - Host overview (hosts).
- class hawat.blueprints.hosts.SearchView[source]
Bases:
HTMLMixin
,AbstractSearchView
View responsible for querying IDEA event database and presenting the results in the form of HTML page.
Get breadcrumbs menu.
- methods: t.ClassVar[t.Optional[t.Collection[str]]] = ['GET']
The methods this view is registered for. Uses the same default (
["GET", "HEAD", "OPTIONS"]
) asroute
andadd_url_rule
by default.
- hawat.blueprints.hosts.get_blueprint()[source]
Mandatory interface for
hawat.Hawat
and factory function. This function must return a valid instance ofhawat.app.HawatBlueprint
orflask.Blueprint
.