vial.blueprints.groups package¶
This file contains pluggable module for Vial application containing features related to user group management. These features include:
general group listing
detailed group view
creating new groups
updating existing groups
deleting existing groups
enabling existing groups
disabling existing groups
adding group members
removing group members
rejecting group membership requests
-
class
vial.blueprints.groups.
AddMemberView
[source]¶ Bases:
vial.view.mixin.HTMLMixin
,vial.view.mixin.SQLAlchemyMixin
,vial.view.ItemObjectRelationView
View for adding group members.
-
authentication
= True¶
Perform access authorization for current user to particular item.
-
classmethod
change_item
(**kwargs)[source]¶ Hook method: Change given item in any desired way.
- Parameters
item – Item to be changed/modified.
-
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.
-
property
dbmodel_other
¶ Hook property. This property must be implemented in each subclass to return reference to appropriate model class for other objects and that is based on SQLAlchemy declarative base.
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
-
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_icon
()[source]¶ Implementation of
vial.view.BaseView.get_view_icon()
.
-
classmethod
get_view_name
()[source]¶ 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)[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', 'POST']¶
-
-
vial.blueprints.groups.
BLUEPRINT_NAME
= 'groups'¶ Name of the blueprint as module global constant.
-
class
vial.blueprints.groups.
CreateView
[source]¶ Bases:
vial.view.mixin.HTMLMixin
,vial.view.mixin.SQLAlchemyMixin
,vial.view.ItemCreateView
View for creating new groups.
-
authentication
= True¶
-
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
vial.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
vial.view.BaseView.get_view_title()
.
-
methods
= ['GET', 'POST']¶
-
-
class
vial.blueprints.groups.
DeleteView
[source]¶ Bases:
vial.view.mixin.HTMLMixin
,vial.view.mixin.SQLAlchemyMixin
,vial.view.ItemDeleteView
View for deleting existing groups.
-
authentication
= True¶
-
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.
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
-
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.
-
methods
= ['GET', 'POST']¶
-
-
class
vial.blueprints.groups.
DisableView
[source]¶ Bases:
vial.view.mixin.HTMLMixin
,vial.view.mixin.SQLAlchemyMixin
,vial.view.ItemDisableView
View for disabling groups.
-
authentication
= True¶
-
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.
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
-
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.
-
methods
= ['GET', 'POST']¶
-
-
class
vial.blueprints.groups.
EnableView
[source]¶ Bases:
vial.view.mixin.HTMLMixin
,vial.view.mixin.SQLAlchemyMixin
,vial.view.ItemEnableView
View for enabling existing groups.
-
authentication
= True¶
-
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.
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
-
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.
-
methods
= ['GET', 'POST']¶
-
-
class
vial.blueprints.groups.
GroupsBlueprint
(name, import_name, **kwargs)[source]¶ Bases:
vial.app.VialBlueprint
Pluggable module - user groups (groups).
-
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.groups.
ListView
[source]¶ Bases:
vial.view.mixin.HTMLMixin
,vial.view.mixin.SQLAlchemyMixin
,vial.view.ItemListView
General group 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.
Get action menu for all listed items.
Get context action menu for particular single item.
-
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.groups.
RejectMemberView
[source]¶ Bases:
vial.view.mixin.HTMLMixin
,vial.view.mixin.SQLAlchemyMixin
,vial.view.ItemObjectRelationView
View for rejecting group membership reuests.
-
authentication
= True¶
Perform access authorization for current user to particular item.
-
classmethod
change_item
(**kwargs)[source]¶ Hook method: Change given item in any desired way.
- Parameters
item – Item to be changed/modified.
-
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.
-
property
dbmodel_other
¶ Hook property. This property must be implemented in each subclass to return reference to appropriate model class for other objects and that is based on SQLAlchemy declarative base.
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
-
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_icon
()[source]¶ Implementation of
vial.view.BaseView.get_view_icon()
.
-
classmethod
get_view_name
()[source]¶ 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)[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', 'POST']¶
-
-
class
vial.blueprints.groups.
RemoveMemberView
[source]¶ Bases:
vial.view.mixin.HTMLMixin
,vial.view.mixin.SQLAlchemyMixin
,vial.view.ItemObjectRelationView
View for removing group members.
-
authentication
= True¶
Perform access authorization for current user to particular item.
-
classmethod
change_item
(**kwargs)[source]¶ Hook method: Change given item in any desired way.
- Parameters
item – Item to be changed/modified.
-
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.
-
property
dbmodel_other
¶ Hook property. This property must be implemented in each subclass to return reference to appropriate model class for other objects and that is based on SQLAlchemy declarative base.
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
-
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_icon
()[source]¶ Implementation of
vial.view.BaseView.get_view_icon()
.
-
classmethod
get_view_name
()[source]¶ 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)[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', 'POST']¶
-
-
class
vial.blueprints.groups.
ShowByNameView
[source]¶ Bases:
vial.blueprints.groups.ShowView
Detailed group view by group name.
-
classmethod
get_view_name
()[source]¶ Implementation of
vial.view.BaseView.get_view_name()
.
-
classmethod
get_view_template
()[source]¶ 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
vial.app.VialBlueprint.register_view_class()
method.- Returns
Jinja2 template file to use to render the view.
- Return type
str
-
property
search_by
¶ Return model`s attribute (column) according to which to search for a single item.
-
classmethod
-
class
vial.blueprints.groups.
ShowView
[source]¶ Bases:
vial.view.mixin.HTMLMixin
,vial.view.mixin.SQLAlchemyMixin
,vial.view.ItemShowView
Detailed group view.
-
authentication
= True¶
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.
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
-
classmethod
get_view_title
(**kwargs)[source]¶ Implementation of
vial.view.BaseView.get_view_title()
.
-
classmethod
get_view_url
(**kwargs)[source]¶ Implementation of
vial.view.BaseView.get_view_url()
.
-
methods
= ['GET']¶
-
-
class
vial.blueprints.groups.
UpdateView
[source]¶ Bases:
vial.view.mixin.HTMLMixin
,vial.view.mixin.SQLAlchemyMixin
,vial.view.ItemUpdateView
View for updating existing groups.
-
authentication
= True¶
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
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()
.
-
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
vial.view.BaseView.get_view_title()
.
-
methods
= ['GET', 'POST']¶
-
-
vial.blueprints.groups.
get_blueprint
()[source]¶ Mandatory interface for
vial.Vial
and factory function. This function must return a valid instance ofvial.app.VialBlueprint
orflask.Blueprint
.