flask_velox.admin.mixins.sqla.delete

Provides mixin classes to delete SQLAlchemy objects from within a Flask-Admin interface.

Note

The following packages must be installed:

  • Flask-SQLAlchemy
  • Flask-Admin
class flask_velox.admin.mixins.sqla.delete.AdminDeleteBaseMixin

Bases: object

Base mixin class to be used inconjunction with other mixin classes.

cancel_url(**kwargs)

Returns the url to a cancel endpoint, this is used to render a link in forms to exit:

<a href="{{ cancel_url() }}">Cancel</a>

The cancel_url_rule must be defined.

Parameters:**kwargs – Arbitrary keyword arguments passed to Flask.url_for
Returns:Generated url
Return type:str or None
get_cancel_url_rule()

Returns the cancel_url_rule or if not defined returns default value of .index.

Returns:Defined cancel_url_rule
Return type:str
get_redirect_url_rule()

Returns raw redirect url rule to be used in url_for. If the redirect_url_rule is not defined then .index will be returned.

Returns:Raw flask url endpoint
Return type:str
redirect_url(**kwargs)

Returns the url to a redirect endpoint, when the form is valid and the callback is called.

Parameters:**kwargs – Arbitrary keyword arguments passed to Flask.url_for
Returns:Generated url
Return type:str or None
set_context()

Adds extra context variables to be used in delete view templates.

See also

  • from flask_velox.mixins.context.ContextMixin.set_context()

Note

Adds the following context variables:

  • object: The object to be deleted
  • cancel_url: Function for retrieving cancel url in template
class flask_velox.admin.mixins.sqla.delete.AdminDeleteObjectMixin(*args, **kwargs)

Bases: flask_velox.admin.mixins.sqla.delete.AdminDeleteBaseMixin, flask_velox.mixins.sqla.delete.DeleteObjectMixin, flask_velox.admin.mixins.template.AdminTemplateMixin

Mixin provides object deletion support from within a Flask-Admin system.

redirect_url_rule str, optional

Raw flask url to send users on success, defaults to .index

cancel_url_rule str, optional

Raw flask url to send users on cancel, defaults to .index

class flask_velox.admin.mixins.sqla.delete.AdminMultiDeleteObjectMixin(*args, **kwargs)

Bases: flask_velox.admin.mixins.sqla.delete.AdminDeleteBaseMixin, flask_velox.mixins.sqla.delete.MultiDeleteObjectMixin, flask_velox.admin.mixins.template.AdminTemplateMixin

Mixin provides multi object deletion support from within a Flask-Admin system.

redirect_url_rule str, optional

Raw flask url to send users on success, defaults to .index

cancel_url_rule str, optional

Raw flask url to send users on cancel, defaults to .index

post(admin, *args, **kwargs)

Overrides post method in order to capture admin view for rendering within admin system.

http://thisissoon.com

Related Topics

This Page