hawat.blueprints.events package

This file contains pluggable module for Hawat web interface containing features related to IDEA events, database searching and viewing event details.

class hawat.blueprints.events.APIDashboardView[source]

Bases: hawat.base.AJAXMixin, hawat.blueprints.events.AbstractDashboardView

View responsible for presenting overall IDEA event statistics dashboard in the form of JSON document.

classmethod get_view_name()[source]

Implementation of hawat.base.BaseView.get_view_name().

class hawat.blueprints.events.APIMetadataView[source]

Bases: hawat.base.AJAXMixin, hawat.base.SimpleView

Application view providing access event metadata information.

authentication = True
authorization = [<Permission needs={Need(method='role', value='maintainer'), Need(method='role', value='developer'), Need(method='role', value='user'), Need(method='role', value='admin')} excludes=set()>]
do_before_response(**kwargs)[source]

Implementation of hawat.base.RenderableView.do_before_response().

classmethod get_view_name()[source]

Implementation of hawat.base.BaseView.get_view_name().

classmethod get_view_title(**kwargs)[source]

Implementation of hawat.base.BaseView.get_menu_title().

class hawat.blueprints.events.APISearchView[source]

Bases: hawat.base.AJAXMixin, hawat.blueprints.events.AbstractSearchView

View responsible for searching the IDEA event database and presenting the results in the form of JSON document.

classmethod get_view_name()[source]

Implementation of hawat.base.BaseView.get_view_name().

methods = ['GET', 'POST']
class hawat.blueprints.events.APIShowView[source]

Bases: hawat.base.AJAXMixin, hawat.blueprints.events.AbstractShowView

Detailed IDEA event view that presents the result as HTML page.

classmethod get_view_name()[source]

Implementation of hawat.base.BaseView.get_view_name().

methods = ['GET', 'POST']
class hawat.blueprints.events.AbstractDashboardView[source]

Bases: hawat.base.SQLAlchemyMixin, hawat.base.BaseSearchView

Base class for presenting overall IDEA event statistics dashboard.

authentication = True
authorization = [<Permission needs={Need(method='role', value='maintainer'), Need(method='role', value='developer'), Need(method='role', value='user'), Need(method='role', value='admin')} excludes=set()>]
static build_query(query, model, form_args)[source]

Interface implementation of hawat.base.SQLAlchemyMixin.build_query().

dbmodel

Implementation of hawat.base.SQLAlchemyMixin.dbmodel().

Interface implementation of hawat.base.SearchView.do_after_search().

do_before_response(**kwargs)[source]

Implementation of hawat.base.RenderableView.do_before_response().

classmethod get_menu_title(**kwargs)[source]

Implementation of hawat.base.BaseView.get_menu_title().

static get_search_form(request_args)[source]

Interface implementation of hawat.base.SearchView.get_search_form().

classmethod get_view_icon()[source]

Implementation of hawat.base.BaseView.get_view_icon().

classmethod get_view_template()[source]

Implementation of hawat.base.RenderableView.get_view_template().

classmethod get_view_title(**kwargs)[source]

Implementation of hawat.base.BaseView.get_view_title().

class hawat.blueprints.events.AbstractSearchView[source]

Bases: hawat.base.PsycopgMixin, hawat.base.BaseSearchView

Base class for all views responsible for searching IDEA event database.

authentication = True
authorization = [<Permission needs={Need(method='role', value='maintainer'), Need(method='role', value='developer'), Need(method='role', value='user'), Need(method='role', value='admin')} excludes=set()>]

Interface implementation of hawat.base.SearchView.do_before_search().

classmethod get_menu_title(**kwargs)[source]

Implementation of hawat.base.BaseView.get_menu_title().

static get_search_form(request_args)[source]

Interface implementation of hawat.base.SearchView.get_search_form().

classmethod get_view_title(**kwargs)[source]

Implementation of hawat.base.BaseView.get_view_title().

class hawat.blueprints.events.AbstractShowView[source]

Bases: hawat.base.PsycopgMixin, hawat.base.ItemShowView

Base class responsible for fetching and presenting single IDEA event.

authentication = True
authorization = [<Permission needs={Need(method='role', value='maintainer'), Need(method='role', value='developer'), Need(method='role', value='user'), Need(method='role', value='admin')} excludes=set()>]
classmethod get_menu_legend(**kwargs)[source]

Interface implementation of hawat.base.BaseView.get_menu_legend().

classmethod get_menu_title(**kwargs)[source]

Implementation of hawat.base.BaseView.get_menu_title().

classmethod get_view_title(**kwargs)[source]

Implementation of hawat.base.BaseView.get_menu_title().

hawat.blueprints.events.BLUEPRINT_NAME = 'events'

Name of the blueprint as module global constant.

class hawat.blueprints.events.DashboardView[source]

Bases: hawat.base.HTMLMixin, hawat.blueprints.events.AbstractDashboardView

View responsible for presenting overall IDEA event statistics dashboard in the form of HTML page.

classmethod get_view_name()[source]

Implementation of hawat.base.BaseView.get_view_name().

class hawat.blueprints.events.DownloadView[source]

Bases: hawat.base.PsycopgMixin, hawat.base.BaseView

Download IDEA event as JSON file.

authentication = True
authorization = [<Permission needs={Need(method='role', value='maintainer'), Need(method='role', value='developer'), Need(method='role', value='user'), Need(method='role', value='admin')} excludes=set()>]
dispatch_request(item_id)[source]

Mandatory interface required by the flask.views.View.dispatch_request(). Will be called by the Flask framework to service the request.

Single item with given unique identifier will be retrieved from database and injected into template to be displayed to the user.

classmethod get_menu_legend(**kwargs)[source]

Interface implementation of hawat.base.BaseView.get_menu_legend().

classmethod get_menu_title(**kwargs)[source]

Implementation of hawat.base.BaseView.get_menu_title().

classmethod get_view_name()[source]

Implementation of hawat.base.BaseView.get_view_name().

classmethod get_view_title(**kwargs)[source]

Implementation of hawat.base.BaseView.get_menu_title().

classmethod get_view_url(**kwargs)[source]

Implementation of hawat.base.BaseView.get_view_url().

methods = ['GET']
class hawat.blueprints.events.EventsBlueprint(name, import_name, **kwargs)[source]

Bases: hawat.base.HawatBlueprint

Hawat pluggable module - IDEA event database (events).

classmethod get_module_title()[source]

Implementation of hawat.base.HawatBlueprint.get_module_title().

register_app(app)[source]

Callback method. Will be called from hawat.base.HawatApp.register_blueprint() method and can be used to customize the Flask application object. Possible use cases:

  • application menu customization

Parameters

app (hawat.base.HawatApp) – Flask application to be customize.

class hawat.blueprints.events.SearchView[source]

Bases: hawat.base.HTMLMixin, hawat.blueprints.events.AbstractSearchView

View responsible for searching the IDEA event database and presenting the results in the form of HTML page.

classmethod get_breadcrumbs_menu()[source]

Interface implementation of hawat.base.SearchView.get_breadcrumbs_menu().

classmethod get_context_action_menu()[source]

Interface implementation of hawat.base.SearchView.get_context_action_menu().

has_help = True
methods = ['GET']
class hawat.blueprints.events.ShowView[source]

Bases: hawat.base.HTMLMixin, hawat.blueprints.events.AbstractShowView

Detailed IDEA event view that presents the result as HTML page.

classmethod get_action_menu()[source]

Interface implementation of hawat.base.SearchView.get_action_menu().

has_help = True
methods = ['GET']
hawat.blueprints.events.get_blueprint()[source]

Mandatory interface and factory function. This function must return a valid instance of hawat.base.HawatBlueprint or flask.Blueprint.