Changeset 8254

Timestamp:

08/08/08 17:36:17 (5 months ago)

Author:

jacob

Message:

Fixed #7820: MiddlewareNotUsed? is finally documented somewhere else besides my brain.

Files:

• django/trunk/docs/middleware.txt (modified) (5 diffs)

django/trunk/docs/middleware.txt

@@ -188 +188 @@
-Python class that defines one or more of the following methods:
-
-
-
+
+----
-
-Interface: ``process_request(self, request)``
@@ -203 +203 @@
-``HttpResponse``. Response middleware is always called on every response.
-
-
-
+
+----
-
-Interface: ``process_view(self, request, view_func, view_args, view_kwargs)``
@@ -223 +223 @@
-``HttpResponse``. Response middleware is always called on every response.
-
-
-
+
+----
-
-Interface: ``process_response(self, request, response)``
@@ -235 +235 @@
-``HttpResponse``.
-
-
-
+
+----
-
-Interface: ``process_exception(self, request, exception)``
@@ -248 +248 @@
-to the browser. Otherwise, default exception handling kicks in.
-
+``__init__``
+------------
+
+Most middleware classes won't need an initializer since middleware classes are
+essentially placeholders for the ``process_*`` methods. If you do need some
+global state you may use ``__init__`` to set up. However, keep in mind a couple
+of caveats:
+
+    * Django initializes your middleware without any arguments, so you can't
+      define ``__init__`` as requiring any arguments.
+      
+    * Unlike the ``process_*`` methods which get called once per request,
+      ``__init__`` gets called only *once*, when the web server starts up.
+
+Marking middleware as unused
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+It's sometimes useful to determine at run-time whether a piece of middleware
+should be used. In these cases, your middleware's ``__init__`` method may raise
+``django.core.exceptions.MiddlewareNotUsed``. Django will then remove that piece
+of middleware from the middleware process.
+
-Guidelines
-----------