[1.2.X] Fixed #14785 - fixes to middleware docs - thanks adamv for the patch.

Backport of r14731 from trunk.

git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.2.X@14732 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Timo Graham 2010-11-27 21:59:03 +00:00
parent 82261de2fe
commit 0a0d4884f6
2 changed files with 22 additions and 22 deletions

View File

@ -18,9 +18,9 @@ Cache middleware
.. module:: django.middleware.cache .. module:: django.middleware.cache
:synopsis: Middleware for the site-wide cache. :synopsis: Middleware for the site-wide cache.
.. class:: django.middleware.cache.UpdateCacheMiddleware .. class:: UpdateCacheMiddleware
.. class:: django.middleware.cache.FetchFromCacheMiddleware .. class:: FetchFromCacheMiddleware
Enable the site-wide cache. If these are enabled, each Django-powered page will Enable the site-wide cache. If these are enabled, each Django-powered page will
be cached for as long as the :setting:`CACHE_MIDDLEWARE_SECONDS` setting be cached for as long as the :setting:`CACHE_MIDDLEWARE_SECONDS` setting
@ -32,7 +32,7 @@ defines. See the :doc:`cache documentation </topics/cache>`.
.. module:: django.middleware.common .. module:: django.middleware.common
:synopsis: Middleware adding "common" conveniences for perfectionists. :synopsis: Middleware adding "common" conveniences for perfectionists.
.. class:: django.middleware.common.CommonMiddleware .. class:: CommonMiddleware
Adds a few conveniences for perfectionists: Adds a few conveniences for perfectionists:
@ -80,7 +80,7 @@ View metadata middleware
.. module:: django.middleware.doc .. module:: django.middleware.doc
:synopsis: Middleware to help your app self-document. :synopsis: Middleware to help your app self-document.
.. class:: django.middleware.doc.XViewMiddleware .. class:: XViewMiddleware
Sends custom ``X-View`` HTTP headers to HEAD requests that come from IP Sends custom ``X-View`` HTTP headers to HEAD requests that come from IP
addresses defined in the :setting:`INTERNAL_IPS` setting. This is used by addresses defined in the :setting:`INTERNAL_IPS` setting. This is used by
@ -92,7 +92,7 @@ GZIP middleware
.. module:: django.middleware.gzip .. module:: django.middleware.gzip
:synopsis: Middleware to serve gziped content for performance. :synopsis: Middleware to serve gziped content for performance.
.. class:: django.middleware.gzip.GZipMiddleware .. class:: GZipMiddleware
Compresses content for browsers that understand gzip compression (all modern Compresses content for browsers that understand gzip compression (all modern
browsers). browsers).
@ -109,7 +109,7 @@ Conditional GET middleware
.. module:: django.middleware.http .. module:: django.middleware.http
:synopsis: Middleware handling advanced HTTP features. :synopsis: Middleware handling advanced HTTP features.
.. class:: django.middleware.http.ConditionalGetMiddleware .. class:: ConditionalGetMiddleware
Handles conditional GET operations. If the response has a ``ETag`` or Handles conditional GET operations. If the response has a ``ETag`` or
``Last-Modified`` header, and the request has ``If-None-Match`` or ``Last-Modified`` header, and the request has ``If-None-Match`` or
@ -121,7 +121,7 @@ Also sets the ``Date`` and ``Content-Length`` response-headers.
Reverse proxy middleware Reverse proxy middleware
------------------------ ------------------------
.. class:: django.middleware.http.SetRemoteAddrFromForwardedFor .. class:: SetRemoteAddrFromForwardedFor
.. versionchanged:: 1.1 .. versionchanged:: 1.1
@ -134,7 +134,7 @@ Locale middleware
.. module:: django.middleware.locale .. module:: django.middleware.locale
:synopsis: Middleware to enable language selection based on the request. :synopsis: Middleware to enable language selection based on the request.
.. class:: django.middleware.locale.LocaleMiddleware .. class:: LocaleMiddleware
Enables language selection based on data from the request. It customizes Enables language selection based on data from the request. It customizes
content for each user. See the :doc:`internationalization documentation content for each user. See the :doc:`internationalization documentation
@ -146,7 +146,7 @@ Message middleware
.. module:: django.contrib.messages.middleware .. module:: django.contrib.messages.middleware
:synopsis: Message middleware. :synopsis: Message middleware.
.. class:: django.contrib.messages.middleware.MessageMiddleware .. class:: MessageMiddleware
.. versionadded:: 1.2 .. versionadded:: 1.2
``MessageMiddleware`` was added. ``MessageMiddleware`` was added.
@ -160,7 +160,7 @@ Session middleware
.. module:: django.contrib.sessions.middleware .. module:: django.contrib.sessions.middleware
:synopsis: Session middleware. :synopsis: Session middleware.
.. class:: django.contrib.sessions.middleware.SessionMiddleware .. class:: SessionMiddleware
Enables session support. See the :doc:`session documentation Enables session support. See the :doc:`session documentation
</topics/http/sessions>`. </topics/http/sessions>`.
@ -171,7 +171,7 @@ Authentication middleware
.. module:: django.contrib.auth.middleware .. module:: django.contrib.auth.middleware
:synopsis: Authentication middleware. :synopsis: Authentication middleware.
.. class:: django.contrib.auth.middleware.AuthenticationMiddleware .. class:: AuthenticationMiddleware
Adds the ``user`` attribute, representing the currently-logged-in user, to Adds the ``user`` attribute, representing the currently-logged-in user, to
every incoming ``HttpRequest`` object. See :doc:`Authentication in Web requests every incoming ``HttpRequest`` object. See :doc:`Authentication in Web requests
@ -184,7 +184,7 @@ CSRF protection middleware
:synopsis: Middleware adding protection against Cross Site Request :synopsis: Middleware adding protection against Cross Site Request
Forgeries. Forgeries.
.. class:: django.middleware.csrf.CsrfMiddleware .. class:: CsrfMiddleware
.. versionadded:: 1.0 .. versionadded:: 1.0
@ -198,7 +198,7 @@ Transaction middleware
.. module:: django.middleware.transaction .. module:: django.middleware.transaction
:synopsis: Middleware binding a database transaction to each Web request. :synopsis: Middleware binding a database transaction to each Web request.
.. class:: django.middleware.transaction.TransactionMiddleware .. class:: TransactionMiddleware
Binds commit and rollback to the request/response phase. If a view function Binds commit and rollback to the request/response phase. If a view function
runs successfully, a commit is done. If it fails with an exception, a rollback runs successfully, a commit is done. If it fails with an exception, a rollback

View File

@ -89,12 +89,12 @@ dictionary of keyword arguments that will be passed to the view. Neither
(``request``). (``request``).
``process_view()`` is called just before Django calls the view. It should ``process_view()`` is called just before Django calls the view. It should
return either ``None`` or an :class:`~django.http. HttpResponse` object. If it return either ``None`` or an :class:`~django.http.HttpResponse` object. If it
returns ``None``, Django will continue processing this request, executing any returns ``None``, Django will continue processing this request, executing any
other ``process_view()`` middleware and, then, the appropriate view. If it other ``process_view()`` middleware and, then, the appropriate view. If it
returns an :class:`~django.http. HttpResponse` object, Django won't bother returns an :class:`~django.http.HttpResponse` object, Django won't bother
calling ANY other request, view or exception middleware, or the appropriate calling ANY other request, view or exception middleware, or the appropriate
view; it'll return that :class:`~django.http. HttpResponse`. Response view; it'll return that :class:`~django.http.HttpResponse`. Response
middleware is always called on every response. middleware is always called on every response.
.. _response-middleware: .. _response-middleware:
@ -105,16 +105,16 @@ middleware is always called on every response.
.. method:: process_response(self, request, response) .. method:: process_response(self, request, response)
``request`` is an :class:`~django.http.HttpRequest` object. ``response`` is the ``request`` is an :class:`~django.http.HttpRequest` object. ``response`` is the
:class:`~django.http. HttpResponse` object returned by a Django view. :class:`~django.http.HttpResponse` object returned by a Django view.
``process_response()`` must return an :class:`~django.http. HttpResponse` ``process_response()`` must return an :class:`~django.http.HttpResponse`
object. It could alter the given ``response``, or it could create and return a object. It could alter the given ``response``, or it could create and return a
brand-new :class:`~django.http. HttpResponse`. brand-new :class:`~django.http.HttpResponse`.
Unlike the ``process_request()`` and ``process_view()`` methods, the Unlike the ``process_request()`` and ``process_view()`` methods, the
``process_response()`` method is always called, even if the ``process_request()`` ``process_response()`` method is always called, even if the ``process_request()``
and ``process_view()`` methods of the same middleware class were skipped because and ``process_view()`` methods of the same middleware class were skipped because
an earlier middleware method returned an :class:`~django.http. HttpResponse` an earlier middleware method returned an :class:`~django.http.HttpResponse`
(this means that your ``process_response()`` method cannot rely on setup done in (this means that your ``process_response()`` method cannot rely on setup done in
``process_request()``, for example). In addition, during the response phase the ``process_request()``, for example). In addition, during the response phase the
classes are applied in reverse order, from the bottom up. This means classes classes are applied in reverse order, from the bottom up. This means classes
@ -132,8 +132,8 @@ defined at the end of :setting:`MIDDLEWARE_CLASSES` will be run first.
Django calls ``process_exception()`` when a view raises an exception. Django calls ``process_exception()`` when a view raises an exception.
``process_exception()`` should return either ``None`` or an ``process_exception()`` should return either ``None`` or an
:class:`~django.http. HttpResponse` object. If it returns an :class:`~django.http.HttpResponse` object. If it returns an
:class:`~django.http. HttpResponse` object, the response will be returned to :class:`~django.http.HttpResponse` object, the response will be returned to
the browser. Otherwise, default exception handling kicks in. the browser. Otherwise, default exception handling kicks in.
Again, middleware are run in reverse order during the response phase, which Again, middleware are run in reverse order during the response phase, which