hawat.blueprints.settings_reporting package
This pluggable module provides access to group reporting settings management features. These features include:
detailed reporting settings view
creating new reporting settings
updating existing reporting settings
deleting existing reporting settings
- hawat.blueprints.settings_reporting.BLUEPRINT_NAME = 'settings_reporting'
Name of the blueprint as module global constant.
- class hawat.blueprints.settings_reporting.CreateView[source]
Bases:
HTMLMixin
,SQLAlchemyMixin
,ItemCreateView
View for creating new reporting settings.
- 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
.
- classmethod authorize_item_action(**kwargs)[source]
Perform access authorization for current user to particular item.
- 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.
- static get_item_form(item)[source]
Hook method. Must return instance of
flask_wtf.FlaskForm
appropriate for given item class.
Implementation of
hawat.view.BaseView.get_menu_title()
.
- static get_message_cancel(**kwargs)[source]
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)[source]
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)[source]
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.
- classmethod get_view_title(**kwargs)[source]
Implementation of
hawat.view.BaseView.get_view_title()
.
- methods: ClassVar[Optional[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.settings_reporting.SettingsReportingBlueprint(name, import_name, **kwargs)[source]
Bases:
HawatBlueprint
Pluggable module - reporting settings. (settings_reporting)
- class hawat.blueprints.settings_reporting.ShowView[source]
Bases:
HTMLMixin
,SQLAlchemyMixin
,ItemShowView
Detailed reporting settings view.
- 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
.
- classmethod authorize_item_action(**kwargs)[source]
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)[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.
Get action menu for particular item.
Get breadcrumbs menu.
- classmethod get_view_icon()[source]
Implementation of
hawat.view.BaseView.get_view_icon()
.
- classmethod get_view_title(**kwargs)[source]
Implementation of
hawat.view.BaseView.get_view_title()
.
- methods: ClassVar[Optional[Collection[str]]] = ['GET']
The methods this view is registered for. Uses the same default (
["GET", "HEAD", "OPTIONS"]
) asroute
andadd_url_rule
by default.
- class hawat.blueprints.settings_reporting.UpdateView[source]
Bases:
HTMLMixin
,SQLAlchemyMixin
,ItemUpdateView
View for updating existing reporting settings.
- 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
.
- classmethod authorize_item_action(**kwargs)[source]
Perform access authorization for current user to particular item.
- 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.
- static get_item_form(item)[source]
Hook method. Must return instance of
flask_wtf.FlaskForm
appropriate for given item class.
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)[source]
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)[source]
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)[source]
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.
- classmethod get_view_title(**kwargs)[source]
Implementation of
hawat.view.BaseView.get_view_title()
.
- methods: ClassVar[Optional[Collection[str]]] = ['GET', 'POST']
The methods this view is registered for. Uses the same default (
["GET", "HEAD", "OPTIONS"]
) asroute
andadd_url_rule
by default.
- hawat.blueprints.settings_reporting.get_blueprint()[source]
Mandatory interface for
hawat.Hawat
and factory function. This function must return a valid instance ofhawat.app.HawatBlueprint
orflask.Blueprint
.
Submodules
- hawat.blueprints.settings_reporting.forms module
BaseSettingsReportingForm
BaseSettingsReportingForm.cancel
BaseSettingsReportingForm.emails_critical
BaseSettingsReportingForm.emails_high
BaseSettingsReportingForm.emails_low
BaseSettingsReportingForm.emails_medium
BaseSettingsReportingForm.locale
BaseSettingsReportingForm.mode
BaseSettingsReportingForm.redirect
BaseSettingsReportingForm.submit
BaseSettingsReportingForm.timezone
CreateSettingsReportingForm
UpdateSettingsReportingForm
get_available_groups()
get_available_locales()