Flask-Admin 增加自定义Action

Posted May 12, 2017

默认情况下, Flask Admin提供了两个Row Action, 即delete和edit. 但是大多数情况下, 这些并不能满足有其他快捷操作需求, 好在Flask Admin提供增加这种按钮的接口.

`UserView.py`

这是我原本的Admin ModelView实现, 很明显我没有对row actions做任务的定制.

class UserView(ModelView):
    column_default_sort = ('active', False)
    column_list = ('name', 'email', 'active', 'roles')
    column_filters = ('name', 'active')
    form_create_rules = ('name', 'avatar', 'email', 'active', 'roles')

<\>Python

增加row action按钮

我们可以通过column_extra_row_actions属性增加row action.

from flask_admin.model.template import EndpointLinkRowAction

class UserView(ModelView):
    column_default_sort = ('active', False)
    column_list = ('name', 'email', 'active', 'roles')
    column_filters = ('name', 'active')
    form_create_rules = ('name', 'avatar', 'email', 'active', 'roles')

    column_extra_row_actions = [
        EndpointLinkRowAction(
            'off glyphicon glyphicon-off',
            'user.activate_user_view',
        )
    ]

<\>Python

Flask-admin提供了row action的模版, 其中上面使用的EndpointLinkRowAction, 传入的是一个view(user.activate_user_view). 它是定义在UserView上的一个view方法(请看下面代码). 同时row action也有LinkRowAction类型, 它接受icon class和一个url. 另外它支持更多的类型, 请看这里:Github

增加对应的endpoint

在上面我们增加了一个EndpointLinkRowAction, 但是我们还没有定义动作具体的逻辑. 下面我们定义user.activate_user_view来接收这个动作的参数, 并实现相应的功能.

class UserView(ModelView):
    column_default_sort = ('active', False)
    column_list = ('name', 'email', 'active', 'roles')
    column_filters = ('name', 'active')
    form_create_rules = ('name', 'avatar', 'email', 'active', 'roles')

    column_extra_row_actions = [
        EndpointLinkRowAction(
            'off glyphicon glyphicon-off',
            'user.activate_user_view',
        )
    ]

    @expose('/activate/', methods=('GET',))
    def activate_user_view(self):
        """
            Activate user model view. Only GET method is allowed.
        """
        return_url = get_redirect_target() or self.get_url('.index_view')

        id = request.args["id"]
        model = self.get_one(id)

        if model is None:
            flash(gettext('用户不存在'), 'error')
            return redirect(return_url)

        if model.active:
            flash(gettext('已经激活， 无需重复激活.'), 'warning')
            return redirect(return_url)

        model.active = True
        model.save()

        flash(gettext('已激活'), 'success')
        return redirect(return_url)

<\>Python

到此我们增加一个快速激活用户的方法就完成了.

𝔔