diff options
| author | Anton Samarchyan <anton.samarchyan@savoirfairelinux.com> | 2017-01-24 15:37:33 -0500 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2017-03-04 10:02:06 -0500 |
| commit | 86de930f413e0ad902e11d78ac988e6743202ea6 (patch) | |
| tree | 790dcc4c38125b619ffee76b5531155d0d8232f4 /django/middleware/csrf.py | |
| parent | 6ae1b04fb584db0fdb22b8e287784c4ed3ac62ac (diff) | |
Refs #27656 -- Updated remaining docstring verbs according to PEP 257.
Diffstat (limited to 'django/middleware/csrf.py')
| -rw-r--r-- | django/middleware/csrf.py | 17 |
1 files changed, 7 insertions, 10 deletions
diff --git a/django/middleware/csrf.py b/django/middleware/csrf.py index 44fe892229..027d0d0b29 100644 --- a/django/middleware/csrf.py +++ b/django/middleware/csrf.py @@ -33,9 +33,7 @@ CSRF_SESSION_KEY = '_csrftoken' def _get_failure_view(): - """ - Returns the view to be used for CSRF rejections - """ + """Return the view to be used for CSRF rejections.""" return get_callable(settings.CSRF_FAILURE_VIEW) @@ -75,7 +73,7 @@ def _get_new_csrf_token(): def get_token(request): """ - Returns the CSRF token required for a POST form. The token is an + Return the CSRF token required for a POST form. The token is an alphanumeric value. A new token is created if one is not already set. A side effect of calling this function is to make the csrf_protect @@ -94,7 +92,7 @@ def get_token(request): def rotate_token(request): """ - Changes the CSRF token in use for a request - should be done on login + Change the CSRF token in use for a request - should be done on login for security purposes. """ request.META.update({ @@ -132,12 +130,11 @@ def _compare_salted_tokens(request_csrf_token, csrf_token): class CsrfViewMiddleware(MiddlewareMixin): """ - Middleware that requires a present and correct csrfmiddlewaretoken - for POST requests that have a CSRF cookie, and sets an outgoing - CSRF cookie. + Require a present and correct csrfmiddlewaretoken for POST requests that + have a CSRF cookie, and set an outgoing CSRF cookie. - This middleware should be used in conjunction with the csrf_token template - tag. + This middleware should be used in conjunction with the {% csrf_token %} + template tag. """ # The _accept and _reject methods currently only exist for the sake of the # requires_csrf_token decorator. |
