vial.blueprints.changelogs package¶
This pluggable module provides access to item changelogs.
-
vial.blueprints.changelogs.
BLUEPRINT_NAME
= 'changelogs'¶ Name of the blueprint as module global constant.
-
class
vial.blueprints.changelogs.
ItemChangeLogsBlueprint
(name, import_name, **kwargs)[source]¶ Bases:
vial.app.VialBlueprint
Pluggable module - item changelog record management (changelogs).
-
classmethod
get_module_title
()[source]¶ Get human readable name for this blueprint/module.
- Returns
Name (short summary) of the blueprint/module.
- Return type
str
-
register_app
(app)[source]¶ Hook method: Custom callback, which will be called from
vial.app.Vial.register_blueprint()
method and which can perform additional tweaking of Vial application object.- Parameters
app (vial.app.Vial) – Application object.
-
classmethod
-
class
vial.blueprints.changelogs.
SearchView
[source]¶ Bases:
vial.view.mixin.HTMLMixin
,vial.view.mixin.SQLAlchemyMixin
,vial.view.BaseSearchView
General item changelog record listing.
-
authentication
= True¶
-
static
build_query
(query, model, form_args)[source]¶ 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.
Implementation of
vial.view.ItemListView.get_context_action_menu()
.
Return menu entry title for the view.
Default implementation returns the return value of
vial.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
vial.view.BaseView.get_menu_title()
method by default.- Parameters
kwargs (dict) – Optional parameters.
- Returns
Title for the view.
- Return type
str
-
methods
= ['GET']¶
-
-
class
vial.blueprints.changelogs.
ShowView
[source]¶ Bases:
vial.view.mixin.HTMLMixin
,vial.view.mixin.SQLAlchemyMixin
,vial.view.ItemShowView
Detailed network record view.
-
authentication
= True¶
-
property
dbmodel
¶ This property must be implemented in each subclass to return reference to appropriate model class based on SQLAlchemy declarative base.
Get breadcrumbs menu.
Return menu entry legend for the view (menu entry hover tooltip).
Default implementation returns the return value of
vial.view.BaseView.get_menu_title()
method by default.- Parameters
kwargs (dict) – Optional parameters.
- Returns
Menu entry legend for the view.
- Return type
str
Implementation of
vial.view.BaseView.get_menu_title()
.
-
classmethod
get_view_title
(**kwargs)[source]¶ Implementation of
vial.view.BaseView.get_view_title()
.
-
methods
= ['GET']¶
-
-
vial.blueprints.changelogs.
get_blueprint
()[source]¶ Mandatory interface for
vial.Vial
and factory function. This function must return a valid instance ofvial.app.VialBlueprint
orflask.Blueprint
.