Hopiu/django-axes
1
0
Fork 0
mirror of https://github.com/jazzband/django-axes.git synced 2026-05-10 16:44:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add public API documentation on the handler class

Browse source 
Signed-off-by: Aleksi Häkli <aleksi.hakli@iki.fi>
This commit is contained in:
Aleksi Häkli 2019-02-26 13:04:35 +02:00
parent 7d9265cd3c
commit 8df219e976
No known key found for this signature in database
GPG key ID: 3E7146964D726BBE
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
axes/handlers/base.py
View file

@ -13,6 +13,17 @@ class AxesBaseHandler: # pylint: disable=unused-argument
"""
Handler API definition for subclassing handlers that can be used with the AxesProxyHandler.
Public API methods for this class are:
- is_allowed
- user_login_failed
- user_logged_in
- user_logged_out
- post_save_access_attempt
- post_delete_access_attempt
Other API methods are considered internal and do not have fixed signatures.
If you wish to implement your own handler class just override the methods you wish to specialize
and define the class to be used with ``settings.AXES_HANDLER = 'dotted.full.path.to.YourClass'``.
"""