mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
Code Issues 25 Releases Wiki Activity

Fixed #25434 -- Documented HttpRequest.site and created a section for middleware attributes.

Browse Source 
Thanks Nick Pope for the initial patch.
This commit is contained in:
Tim Graham 2015-10-22 14:26:45 -04:00
parent 81fed5bc33
commit 02ef96c5e5
1 changed files with 36 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
docs/ref/request-response.txt
View File

@ -29,8 +29,7 @@ HttpRequest objects
Attributes
----------
All attributes should be considered read-only, unless stated otherwise below.
``session`` is a notable exception.
All attributes should be considered read-only, unless stated otherwise.
.. attribute:: HttpRequest.scheme
@ -159,30 +158,6 @@ All attributes should be considered read-only, unless stated otherwise below.
underscores in WSGI environment variables. It matches the behavior of
Web servers like Nginx and Apache 2.4+.
.. attribute:: HttpRequest.user
An object of type :setting:`AUTH_USER_MODEL` representing the currently
logged-in user. If the user isn't currently logged in, ``user`` will be set
to an instance of :class:`django.contrib.auth.models.AnonymousUser`. You
can tell them apart with
:meth:`~django.contrib.auth.models.User.is_authenticated`, like so::
if request.user.is_authenticated():
# Do something for logged-in users.
else:
# Do something for anonymous users.
``user`` is only available if your Django installation has the
:class:`~django.contrib.auth.middleware.AuthenticationMiddleware`
activated. For more, see :doc:`/topics/auth/index`.
.. attribute:: HttpRequest.session
A readable-and-writable, dictionary-like object that represents the current
session. This is only available if your Django installation has session
support activated. See the :doc:`session documentation
</topics/http/sessions>` for full details.
.. attribute:: HttpRequest.urlconf
Not defined by Django itself, but will be read if other code (e.g., a custom
@ -212,6 +187,41 @@ All attributes should be considered read-only, unless stated otherwise below.
will use its value as the ``current_app`` argument to
:func:`~django.core.urlresolvers.reverse()`.
Attributes set by middleware
----------------------------
Some of the middleware included in Django's contrib apps set attributes on the
request. If you don't see the attribute on a request, be sure the appropriate
middleware class is listed in :setting:`MIDDLEWARE_CLASSES`.
.. attribute:: HttpRequest.session
From the :class:`~django.contrib.sessions.middleware.SessionMiddleware`: A
readable and writable, dictionary-like object that represents the current
session.
.. attribute:: HttpRequest.site
From the :class:`~django.contrib.sites.middleware.CurrentSiteMiddleware`:
An instance of :class:`~django.contrib.sites.models.Site` or
:class:`~django.contrib.sites.requests.RequestSite` as returned by
:func:`~django.contrib.sites.shortcuts.get_current_site()`
representing the current site.
.. attribute:: HttpRequest.user
From the :class:`~django.contrib.auth.middleware.AuthenticationMiddleware`:
An instance of :setting:`AUTH_USER_MODEL` representing the currently
logged-in user. If the user isn't currently logged in, ``user`` will be set
to an instance of :class:`~django.contrib.auth.models.AnonymousUser`. You
can tell them apart with
:meth:`~django.contrib.auth.models.User.is_authenticated`, like so::
if request.user.is_authenticated():
... # Do something for logged-in users.
else:
... # Do something for anonymous users.
Methods
-------