Fixed #20855 -- Added documentation of current_app and extra_context params to django.contrib.auth views

refs #5298 and refs #8342
This commit is contained in:
Justin Michalicek 2013-08-02 14:24:26 -04:00 committed by Tim Graham
parent 59f58bf731
commit 61ecb5f48a
1 changed files with 92 additions and 9 deletions

View File

@ -561,13 +561,33 @@ Most built-in authentication views provide a URL name for easier reference. See
patterns. patterns.
.. function:: login(request, [template_name, redirect_field_name, authentication_form]) .. function:: login(request, [template_name, redirect_field_name, authentication_form, current_app, extra_context])
**URL name:** ``login`` **URL name:** ``login``
See :doc:`the URL documentation </topics/http/urls>` for details on using See :doc:`the URL documentation </topics/http/urls>` for details on using
named URL patterns. named URL patterns.
**Optional arguments:**
* ``template_name``: The name of a template to display for the view used to
log the user in. Defaults to :file:`registration/login.html`.
* ``redirect_field_name``: The name of a ``GET`` field containing the
URL to redirect to after login. Overrides ``next`` if the given
``GET`` parameter is passed.
* ``authentication_form``: A callable (typically just a form class) to
use for authentication. Defaults to
:class:`~django.contrib.auth.forms.AuthenticationForm`.
* ``current_app``: A hint indicating which application contains the current
view. See the :ref:`namespaced URL resolution strategy
<topics-http-reversing-url-namespaces>` for more information.
* ``extra_context``: A dictionary of context data that will be added to the
default context data passed to the template.
Here's what ``django.contrib.auth.views.login`` does: Here's what ``django.contrib.auth.views.login`` does:
* If called via ``GET``, it displays a login form that POSTs to the * If called via ``GET``, it displays a login form that POSTs to the
@ -657,7 +677,7 @@ patterns.
.. _site framework docs: ../sites/ .. _site framework docs: ../sites/
.. function:: logout(request, [next_page, template_name, redirect_field_name]) .. function:: logout(request, [next_page, template_name, redirect_field_name, current_app, extra_context])
Logs a user out. Logs a user out.
@ -675,6 +695,13 @@ patterns.
URL to redirect to after log out. Overrides ``next_page`` if the given URL to redirect to after log out. Overrides ``next_page`` if the given
``GET`` parameter is passed. ``GET`` parameter is passed.
* ``current_app``: A hint indicating which application contains the current
view. See the :ref:`namespaced URL resolution strategy
<topics-http-reversing-url-namespaces>` for more information.
* ``extra_context``: A dictionary of context data that will be added to the
default context data passed to the template.
**Template context:** **Template context:**
* ``title``: The string "Logged out", localized. * ``title``: The string "Logged out", localized.
@ -691,7 +718,14 @@ patterns.
:attr:`request.META['SERVER_NAME'] <django.http.HttpRequest.META>`. :attr:`request.META['SERVER_NAME'] <django.http.HttpRequest.META>`.
For more on sites, see :doc:`/ref/contrib/sites`. For more on sites, see :doc:`/ref/contrib/sites`.
.. function:: logout_then_login(request[, login_url]) * ``current_app``: A hint indicating which application contains the current
view. See the :ref:`namespaced URL resolution strategy
<topics-http-reversing-url-namespaces>` for more information.
* ``extra_context``: A dictionary of context data that will be added to the
default context data passed to the template.
.. function:: logout_then_login(request[, login_url, current_app, extra_context])
Logs a user out, then redirects to the login page. Logs a user out, then redirects to the login page.
@ -702,7 +736,14 @@ patterns.
* ``login_url``: The URL of the login page to redirect to. * ``login_url``: The URL of the login page to redirect to.
Defaults to :setting:`settings.LOGIN_URL <LOGIN_URL>` if not supplied. Defaults to :setting:`settings.LOGIN_URL <LOGIN_URL>` if not supplied.
.. function:: password_change(request[, template_name, post_change_redirect, password_change_form]) * ``current_app``: A hint indicating which application contains the current
view. See the :ref:`namespaced URL resolution strategy
<topics-http-reversing-url-namespaces>` for more information.
* ``extra_context``: A dictionary of context data that will be added to the
default context data passed to the template.
.. function:: password_change(request[, template_name, post_change_redirect, password_change_form, current_app, extra_context])
Allows a user to change their password. Allows a user to change their password.
@ -722,11 +763,18 @@ patterns.
actually changing the user's password. Defaults to actually changing the user's password. Defaults to
:class:`~django.contrib.auth.forms.PasswordChangeForm`. :class:`~django.contrib.auth.forms.PasswordChangeForm`.
* ``current_app``: A hint indicating which application contains the current
view. See the :ref:`namespaced URL resolution strategy
<topics-http-reversing-url-namespaces>` for more information.
* ``extra_context``: A dictionary of context data that will be added to the
default context data passed to the template.
**Template context:** **Template context:**
* ``form``: The password change form (see ``password_change_form`` above). * ``form``: The password change form (see ``password_change_form`` above).
.. function:: password_change_done(request[, template_name]) .. function:: password_change_done(request[, template_name, current_app, extra_context])
The page shown after a user has changed their password. The page shown after a user has changed their password.
@ -738,7 +786,14 @@ patterns.
Defaults to :file:`registration/password_change_done.html` if not Defaults to :file:`registration/password_change_done.html` if not
supplied. supplied.
.. function:: password_reset(request[, is_admin_site, template_name, email_template_name, password_reset_form, token_generator, post_reset_redirect, from_email]) * ``current_app``: A hint indicating which application contains the current
view. See the :ref:`namespaced URL resolution strategy
<topics-http-reversing-url-namespaces>` for more information.
* ``extra_context``: A dictionary of context data that will be added to the
default context data passed to the template.
.. function:: password_reset(request[, is_admin_site, template_name, email_template_name, password_reset_form, token_generator, post_reset_redirect, from_email, current_app, extra_context])
Allows a user to reset their password by generating a one-time use link Allows a user to reset their password by generating a one-time use link
that can be used to reset the password, and sending that link to the that can be used to reset the password, and sending that link to the
@ -794,6 +849,13 @@ patterns.
* ``from_email``: A valid email address. By default Django uses * ``from_email``: A valid email address. By default Django uses
the :setting:`DEFAULT_FROM_EMAIL`. the :setting:`DEFAULT_FROM_EMAIL`.
* ``current_app``: A hint indicating which application contains the current
view. See the :ref:`namespaced URL resolution strategy
<topics-http-reversing-url-namespaces>` for more information.
* ``extra_context``: A dictionary of context data that will be added to the
default context data passed to the template.
**Template context:** **Template context:**
* ``form``: The form (see ``password_reset_form`` above) for resetting * ``form``: The form (see ``password_reset_form`` above) for resetting
@ -838,7 +900,7 @@ patterns.
single line plain text string. single line plain text string.
.. function:: password_reset_done(request[, template_name]) .. function:: password_reset_done(request[, template_name, current_app, extra_context])
The page shown after a user has been emailed a link to reset their The page shown after a user has been emailed a link to reset their
password. This view is called by default if the :func:`password_reset` view password. This view is called by default if the :func:`password_reset` view
@ -852,7 +914,14 @@ patterns.
Defaults to :file:`registration/password_reset_done.html` if not Defaults to :file:`registration/password_reset_done.html` if not
supplied. supplied.
.. function:: password_reset_confirm(request[, uidb64, token, template_name, token_generator, set_password_form, post_reset_redirect]) * ``current_app``: A hint indicating which application contains the current
view. See the :ref:`namespaced URL resolution strategy
<topics-http-reversing-url-namespaces>` for more information.
* ``extra_context``: A dictionary of context data that will be added to the
default context data passed to the template.
.. function:: password_reset_confirm(request[, uidb64, token, template_name, token_generator, set_password_form, post_reset_redirect, current_app, extra_context])
Presents a form for entering a new password. Presents a form for entering a new password.
@ -883,6 +952,13 @@ patterns.
* ``post_reset_redirect``: URL to redirect after the password reset * ``post_reset_redirect``: URL to redirect after the password reset
done. Defaults to ``None``. done. Defaults to ``None``.
* ``current_app``: A hint indicating which application contains the current
view. See the :ref:`namespaced URL resolution strategy
<topics-http-reversing-url-namespaces>` for more information.
* ``extra_context``: A dictionary of context data that will be added to the
default context data passed to the template.
**Template context:** **Template context:**
* ``form``: The form (see ``set_password_form`` above) for setting the * ``form``: The form (see ``set_password_form`` above) for setting the
@ -891,7 +967,7 @@ patterns.
* ``validlink``: Boolean, True if the link (combination of ``uidb64`` and * ``validlink``: Boolean, True if the link (combination of ``uidb64`` and
``token``) is valid or unused yet. ``token``) is valid or unused yet.
.. function:: password_reset_complete(request[,template_name]) .. function:: password_reset_complete(request[,template_name, current_app, extra_context])
Presents a view which informs the user that the password has been Presents a view which informs the user that the password has been
successfully changed. successfully changed.
@ -903,6 +979,13 @@ patterns.
* ``template_name``: The full name of a template to display the view. * ``template_name``: The full name of a template to display the view.
Defaults to :file:`registration/password_reset_complete.html`. Defaults to :file:`registration/password_reset_complete.html`.
* ``current_app``: A hint indicating which application contains the current
view. See the :ref:`namespaced URL resolution strategy
<topics-http-reversing-url-namespaces>` for more information.
* ``extra_context``: A dictionary of context data that will be added to the
default context data passed to the template.
Helper functions Helper functions
---------------- ----------------