hawat.blueprints.reports package

This pluggable module provides access to periodical event reports.

class hawat.blueprints.reports.APIDashboardView

Bases: hawat.view.mixin.AJAXMixin, hawat.blueprints.reports.AbstractDashboardView

View responsible for presenting reporting dashboard in the form of JSON document.

classmethod get_view_name()

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

methods: Optional[List[str]] = ['GET', 'POST']

process_response_context()

Perform additional mangling with the response context before generating the response. This method can be useful to delete some context keys, that should not leave the server.

Returns

Possibly updated response context.

Return type

dict

class hawat.blueprints.reports.AbstractDashboardView

Bases: hawat.view.mixin.SQLAlchemyMixin, hawat.view.BaseSearchView

Base class responsible for presenting reporting dashboard.

authentication = True

static build_query(query, model, form_args)

Hook method. Modify given query according to the given arguments.

property dbmodel

This property must be implemented in each subclass to return reference to appropriate model class based on SQLAlchemy declarative base.

do_after_search(items)

This hook method will be called after successfull search.

do_before_response(**kwargs)

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.

classmethod get_menu_title(**kwargs)

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)

Must return instance of flask_wtf.FlaskForm appropriate for searching given type of items.

classmethod get_view_icon()

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

classmethod get_view_template()

Return Jinja2 template file that should be used for rendering the view content. This default implementation works only in case the view class was properly registered into the parent blueprint/module with hawat.app.hawatBlueprint.register_view_class() method.

Returns

Jinja2 template file to use to render the view.

Return type

str

classmethod get_view_title(**kwargs)

Return title for the view, that will be displayed in the title tag of HTML head element and also as the content of page header in h2 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.reports.BLUEPRINT_NAME = 'reports'

Name of the blueprint as module global constant.

class hawat.blueprints.reports.DashboardView

Bases: hawat.view.mixin.HTMLMixin, hawat.blueprints.reports.AbstractDashboardView

View responsible for presenting reporting dashboard in the form of HTML page.

classmethod get_view_name()

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

methods: Optional[List[str]] = ['GET']

class hawat.blueprints.reports.DataView

Bases: hawat.view.FileIdView

View responsible for providing access to report data.

authentication = False

classmethod get_directory_path(fileid, filetype)

This method must return absolute path to the directory, that will be used as a base path for serving files. Parameter fileid may be used internally to further customize the base directory, for example when serving some files places into subdirectories based on some part of the file name (for example to reduce total number of files in base directory).

This method does not have any default implementation and must be overridden by a subclass.

Parameters

• fileid (str) – Identifier of the requested file.

• filetype (str) – Type of the requested file.

Returns

Absolute path to the directory for serving files.

Return type

str

get_filename(fileid, filetype)

This method must return actual name of the file based on given identifier and type.

This method does not have any default implementation and must be overridden by a subclass.

Parameters

• fileid (str) – Identifier of the requested file.

• filetype (str) – Type of the requested file.

Returns

Translated name of the file.

Return type

str

classmethod get_view_name()

Return unique name for the view. Name must be unique in the namespace of parent blueprint/module and should contain only characters [a-z0-9]. It will be used for generating endpoint name for the view.

This method does not have any default implementation and must be overridden by a subclass.

Returns

Name for the view.

Return type

str

classmethod get_view_title(**kwargs)

Return title for the view, that will be displayed in the title tag of HTML head element and also as the content of page header in h2 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

methods: Optional[List[str]] = ['GET']

class hawat.blueprints.reports.DeleteView

Bases: hawat.view.mixin.HTMLMixin, hawat.view.mixin.SQLAlchemyMixin, hawat.view.ItemDeleteView

View for deleting existing user accounts.

authentication = True

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

property dbchlogmodel

This property must be implemented in each subclass to return reference to appropriate model class based on SQLAlchemy declarative base.

property dbmodel

This property must be implemented in each subclass to return reference to appropriate model class based on SQLAlchemy declarative base.

classmethod get_menu_legend(**kwargs)

Return menu entry legend for the view (menu entry hover tooltip).

Default implementation returns the return value of hawat.view.BaseView.get_menu_title() method by default.

Parameters

kwargs (dict) – Optional parameters.

Returns

Menu entry legend for the view.

Return type

str

static get_message_cancel(**kwargs)

Hook method. Must return text for flash message in case of action cancel. The text may contain HTML characters and will be passed to flask.Markup before being used, so to certain extend you may emphasize and customize the output.

static get_message_failure(**kwargs)

Hook method. Must return text for flash message in case of action failure. The text may contain HTML characters and will be passed to flask.Markup before being used, so to certain extend you may emphasize and customize the output.

static get_message_success(**kwargs)

Hook method. Must return text for flash message in case of action success. The text may contain HTML characters and will be passed to flask.Markup before being used, so to certain extend you may emphasize and customize the output.

get_url_next()

Hook method. Must return URL for redirection after action success. In most cases there should be call for flask.url_for() function somewhere in this method.

methods: Optional[List[str]] = ['GET', 'POST']

class hawat.blueprints.reports.FeedbackView

Bases: hawat.view.mixin.AJAXMixin, hawat.view.RenderableView

View for sending feedback for reports.

authentication = True

dispatch_request(item_id)

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

Feedback for report with label item_id. More specific part like section and ip can be send in POST data.

classmethod get_view_name()

Return unique name for the view. Name must be unique in the namespace of parent blueprint/module and should contain only characters [a-z0-9]. It will be used for generating endpoint name for the view.

This method does not have any default implementation and must be overridden by a subclass.

Returns

Name for the view.

Return type

str

classmethod get_view_title(**kwargs)

Return title for the view, that will be displayed in the title tag of HTML head element and also as the content of page header in h2 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

methods: Optional[List[str]] = ['POST']

class hawat.blueprints.reports.ReportsBlueprint(name, import_name, **kwargs)

Bases: hawat.base.HawatBlueprint

Pluggable module - periodical event reports (reports).

classmethod get_module_title()

Get human readable name for this blueprint/module.

Returns

Name (short summary) of the blueprint/module.

Return type

str

property jinja_loader

The Jinja loader for this package bound object.

New in version 0.5.

name = None

register_app(app)

Hook method: Custom callback, which will be called from hawat.app.Hawat.register_blueprint() method and which can perform additional tweaking of Hawat application object.

Parameters

app (hawat.app.Hawat) – Application object.

class hawat.blueprints.reports.SearchView

Bases: hawat.view.mixin.HTMLMixin, hawat.view.mixin.SQLAlchemyMixin, hawat.view.BaseSearchView

View responsible for searching IDEA event report database and presenting result.

authentication = True

static build_query(query, model, form_args)

Hook method. Modify given query according to the given arguments.

property dbmodel

This property must be implemented in each subclass to return reference to appropriate model class based on SQLAlchemy declarative base.

do_after_search(items)

This hook method will be called after successfull search.

classmethod get_menu_title(**kwargs)

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)

Must return instance of flask_wtf.FlaskForm appropriate for searching given type of items.

classmethod get_view_icon()

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

classmethod get_view_title(**kwargs)

Return title for the view, that will be displayed in the title tag of HTML head element and also as the content of page header in h2 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

methods: Optional[List[str]] = ['GET']

class hawat.blueprints.reports.ShowView

Bases: hawat.view.mixin.HTMLMixin, hawat.view.mixin.SQLAlchemyMixin, hawat.view.ItemShowView

Detailed report view.

authentication = True

classmethod authorize_item_action(**kwargs)

Perform access authorization for current user to particular item.

property dbmodel

This property must be implemented in each subclass to return reference to appropriate model class based on SQLAlchemy declarative base.

do_before_response(**kwargs)

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.

static escape_id(ident)

Escape id for use in bootstrap

static format_datetime(val, tzone)

Static method that take string with isoformat datetime in utc and return string with BABEL_RFC3339_FORMAT formated datetime in tz timezone

static format_datetime_wz(val, format_str, tzone)

Static method that take string with isoformat datetime in utc and return string with BABEL_RFC3339_FORMAT formated datetime in tz timezone

classmethod get_action_menu()

Get action menu for particular item.

classmethod get_breadcrumbs_menu()

Get breadcrumbs menu.

classmethod get_menu_legend(**kwargs)

Return menu entry legend for the view (menu entry hover tooltip).

Default implementation returns the return value of hawat.view.BaseView.get_menu_title() method by default.

Parameters

kwargs (dict) – Optional parameters.

Returns

Menu entry legend for the view.

Return type

str

classmethod get_menu_title(**kwargs)

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

classmethod get_view_title(**kwargs)

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

methods: Optional[List[str]] = ['GET']

class hawat.blueprints.reports.UnauthShowView

Bases: hawat.blueprints.reports.ShowView

Unauthorized access to report detail view.

authentication = False

classmethod authorize_item_action(**kwargs)

Perform access authorization for current user to particular item.

classmethod get_view_name()

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

classmethod get_view_template()

Return Jinja2 template file that should be used for rendering the view content. This default implementation works only in case the view class was properly registered into the parent blueprint/module with hawat.app.hawatBlueprint.register_view_class() method.

Returns

Jinja2 template file to use to render the view.

Return type

str

methods: Optional[List[str]] = ['GET']

property search_by

Return model`s attribute (column) according to which to search for a single item.

hawat.blueprints.reports.adjust_query_for_groups(query, groups)

Adjust given SQLAlchemy query for current user. In case user specified set of groups, perform query filtering. In case no groups were selected, restrict non-administrators only to groups they are member of.

hawat.blueprints.reports.build_related_search_params(item)

Build dictionary containing parameters for searching related report events.

hawat.blueprints.reports.get_blueprint()

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

Subpackages

• hawat.blueprints.reports.test package

Submodules

• hawat.blueprints.reports.forms module