Download Install Tutorial Docs FAQ Tools Wiki ∇ License Team IRC Planet Involvement Shop Book

Changeset 1009

Show
Ignore:
Timestamp:
03/15/06 22:19:17
Author:
dowski
Message:

Updated wsgiappfilter section of the book.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/docs/book/xml/builtinfilters.xml

    r1006 r1009  
    135135        <title>wsgiappfilter</title> 
    136136        <para>The wsgiappfilter allows the application developer or deployer to mount 
    137         WSGI compatible applications and middleware to locations on the CherryPy 
     137        WSGI-compatible applications and middleware to locations on the CherryPy 
    138138        object tree.</para> 
    139         <para>Applications can be added to the tree in the config file or by using the 
    140             wsgiappfilter.WSGIApp convenience class to directly mount applications to the 
    141             CherryPy tree.  You can also instantiate the filter in a class's _cp_filters 
    142             special attribute. 
     139        <para>Applications can be added to the tree by using the 
     140            cherrypy.lib.cptools.WSGIApp convenience class to directly mount applications to the 
     141            CherryPy tree.  You can also add an instance of the filter to a class's _cp_filters 
     142            list. 
    143143        </para> 
    144         <para>The wsgiappfilter.WSGIApp and WSGIAppFilter class contsructors takes the  
     144        <para>The cherrypy.lib.cptools.WSGIApp and WSGIAppFilter class contsructors takes the  
    145145            following parameters: 
    146146        </para> 
    147147        <itemizedlist> 
    148148            <listitem> 
    149                 <para>wsgi_app - the WSGI application callable.</para> 
     149                <para>wsgi_app (required) - the WSGI application callable.</para> 
    150150            </listitem> 
    151151            <listitem> 
    152                 <para>env_update - a dictionary of parameters to update the WSGI environment with.</para> 
    153             </listitem> 
    154         </itemizedlist> 
    155         <para>If you are controlling wsgiappfilter through the config system, use the following 
    156             configuration options:</para> 
    157         <itemizedlist> 
    158             <listitem> 
    159                 <para>wsgiapp_filter.on - Default is False.  Set to True to enable the filter.</para> 
    160             </listitem> 
    161             <listitem> 
    162                 <para>wsgiapp_filter.app - WSGI application callable or string 'package,module.attr' 
    163                     that references a WSGI application callable. 
    164                 </para> 
    165             </listitem> 
    166             <listitem> 
    167                 <para>wsgiapp_filter.env_update - a dictionary of parameters to update the WSGI 
    168                     environment with. 
    169                 </para> 
     152                <para>env_update - a optional dictionary of parameters used to update the WSGI environment.</para> 
    170153            </listitem> 
    171154        </itemizedlist> 

Hosted by WebFaction

Log in as guest/cpguest to create tickets