Changeset 12

Show
Ignore:
Timestamp:
10/15/06 21:34:34 (11 years ago)
Author:
t
Message:

Moved VolatileSessionStore? over to MemorySessionStore? (MO)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • software/session2/trunk/ChangeLog

    r11 r12  
    112006-10-15  Titus Brown  <t@vallista.idyll.org> 
     2 
     3        * Added epydoc into the Makefile. 
     4 
     5        * Replaced VolatileSessionStore with MemorySessionStore (MO). 
    26 
    37        * Updated DirectorySessionStore.is_multiprocess_safe (MO). 
  • software/session2/trunk/Makefile

    r10 r12  
    1111        $(RST2HTML) README.txt README.html 
    1212        $(RST2HTML) test/README.txt test/README.html 
     13        epydoc --docformat restructuredtext --no-private -n session2 -o ./epydoc-html/ session2 
  • software/session2/trunk/README.html

    r10 r12  
    417417<pre class="literal-block"> 
    418418# create the session store. 
    419 from session2.store.VolatileSessionStore import VolatileSessionStore 
    420 store = VolatileSessionStore() 
     419from session2.store.MemorySessionStore import MemorySessionStore 
     420store = MemorySessionStore() 
    421421 
    422422# create the session manager. 
  • software/session2/trunk/README.txt

    r10 r12  
    102102 
    103103    # create the session store. 
    104     from session2.store.VolatileSessionStore import VolatileSessionStore 
    105     store = VolatileSessionStore() 
     104    from session2.store.MemorySessionStore import MemorySessionStore 
     105    store = MemorySessionStore() 
    106106 
    107107    # create the session manager. 
  • software/session2/trunk/epydoc-html/UserDict.UserDict-class.html

    r9 r12  
    164164<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    165165  <tr> 
    166     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     166    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    167167    <td align="right"><a href="http://epydoc.sourceforge.net" 
    168168                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/help.html

    r9 r12  
    227227<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    228228  <tr> 
    229     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     229    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    230230    <td align="right"><a href="http://epydoc.sourceforge.net" 
    231231                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/indices.html

    r9 r12  
    6060  <tr><td width="15%"><a href="session2.store.DurusSessionStore.DurusSessionStore-class.html#__init__"><code>__init__</code></a></td> 
    6161    <td>Method in class <a href="session2.store.DurusSessionStore.DurusSessionStore-class.html"><code>session2.store.DurusSessionStore.DurusSessionStore</code></a></td></tr> 
     62  <tr><td width="15%"><a href="session2.store.MemorySessionStore.MemorySessionStore-class.html#__init__"><code>__init__</code></a></td> 
     63    <td>Method in class <a href="session2.store.MemorySessionStore.MemorySessionStore-class.html"><code>session2.store.MemorySessionStore.MemorySessionStore</code></a></td></tr> 
    6264  <tr><td width="15%"><a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html#__init__"><code>__init__</code></a></td> 
    6365    <td>Method in class <a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html"><code>session2.store.MySQLSessionStore.MySQLSessionStore</code></a></td></tr> 
     
    6668  <tr><td width="15%"><a href="session2.store.ShelveSessionStore.ShelveSessionStore-class.html#__init__"><code>__init__</code></a></td> 
    6769    <td>Method in class <a href="session2.store.ShelveSessionStore.ShelveSessionStore-class.html"><code>session2.store.ShelveSessionStore.ShelveSessionStore</code></a></td></tr> 
    68   <tr><td width="15%"><a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html#__init__"><code>__init__</code></a></td> 
    69     <td>Method in class <a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html"><code>session2.store.VolatileSessionStore.VolatileSessionStore</code></a></td></tr> 
    7070  <tr><td width="15%"><a href="UserDict.UserDict-class.html#__len__"><code>__len__</code></a></td> 
    7171    <td>Method in class <a href="UserDict.UserDict-class.html"><code>UserDict.UserDict</code></a></td></tr> 
     
    9696  <tr><td width="15%"><a href="session2.store.DirectorySessionStore.DirectorySessionStore-class.html#delete_old_sessions"><code>delete_old_sessions</code></a></td> 
    9797    <td>Method in class <a href="session2.store.DirectorySessionStore.DirectorySessionStore-class.html"><code>session2.store.DirectorySessionStore.DirectorySessionStore</code></a></td></tr> 
     98  <tr><td width="15%"><a href="session2.store.MemorySessionStore.MemorySessionStore-class.html#delete_old_sessions"><code>delete_old_sessions</code></a></td> 
     99    <td>Method in class <a href="session2.store.MemorySessionStore.MemorySessionStore-class.html"><code>session2.store.MemorySessionStore.MemorySessionStore</code></a></td></tr> 
    98100  <tr><td width="15%"><a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html#delete_old_sessions"><code>delete_old_sessions</code></a></td> 
    99101    <td>Method in class <a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html"><code>session2.store.MySQLSessionStore.MySQLSessionStore</code></a></td></tr> 
     
    104106  <tr><td width="15%"><a href="session2.store.DurusSessionStore.DurusSessionStore-class.html#delete_session"><code>delete_session</code></a></td> 
    105107    <td>Method in class <a href="session2.store.DurusSessionStore.DurusSessionStore-class.html"><code>session2.store.DurusSessionStore.DurusSessionStore</code></a></td></tr> 
     108  <tr><td width="15%"><a href="session2.store.MemorySessionStore.MemorySessionStore-class.html#delete_session"><code>delete_session</code></a></td> 
     109    <td>Method in class <a href="session2.store.MemorySessionStore.MemorySessionStore-class.html"><code>session2.store.MemorySessionStore.MemorySessionStore</code></a></td></tr> 
    106110  <tr><td width="15%"><a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html#delete_session"><code>delete_session</code></a></td> 
    107111    <td>Method in class <a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html"><code>session2.store.MySQLSessionStore.MySQLSessionStore</code></a></td></tr> 
     
    112116  <tr><td width="15%"><a href="session2.store.ShelveSessionStore.ShelveSessionStore-class.html#delete_session"><code>delete_session</code></a></td> 
    113117    <td>Method in class <a href="session2.store.ShelveSessionStore.ShelveSessionStore-class.html"><code>session2.store.ShelveSessionStore.ShelveSessionStore</code></a></td></tr> 
    114   <tr><td width="15%"><a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html#delete_session"><code>delete_session</code></a></td> 
    115     <td>Method in class <a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html"><code>session2.store.VolatileSessionStore.VolatileSessionStore</code></a></td></tr> 
    116118  <tr><td width="15%"><a href="session2.DictSession-module.html"><code>DictSession</code></a></td> 
    117119    <td>Module in package <a href="session2-module.html"><code>session2</code></a></td></tr> 
     
    158160  <tr><td width="15%"><a href="session2.SessionManager.SessionManager-class.html#has_session"><code>has_session</code></a></td> 
    159161    <td>Method in class <a href="session2.SessionManager.SessionManager-class.html"><code>session2.SessionManager.SessionManager</code></a></td></tr> 
     162  <tr><td width="15%"><a href="session2.store.MemorySessionStore.MemorySessionStore-class.html#has_session"><code>has_session</code></a></td> 
     163    <td>Method in class <a href="session2.store.MemorySessionStore.MemorySessionStore-class.html"><code>session2.store.MemorySessionStore.MemorySessionStore</code></a></td></tr> 
    160164  <tr><td width="15%"><a href="session2.store.SessionStore.SessionStore-class.html#has_session"><code>has_session</code></a></td> 
    161165    <td>Method in class <a href="session2.store.SessionStore.SessionStore-class.html"><code>session2.store.SessionStore.SessionStore</code></a></td></tr> 
    162   <tr><td width="15%"><a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html#has_session"><code>has_session</code></a></td> 
    163     <td>Method in class <a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html"><code>session2.store.VolatileSessionStore.VolatileSessionStore</code></a></td></tr> 
    164166  <tr><td width="15%"><a href="session2.SessionManager.SessionManager-class.html#has_session_cookie"><code>has_session_cookie</code></a></td> 
    165167    <td>Method in class <a href="session2.SessionManager.SessionManager-class.html"><code>session2.SessionManager.SessionManager</code></a></td></tr> 
     
    168170  <tr><td width="15%"><a href="session2.store.DurusSessionStore.DurusSessionStore-class.html#is_multiprocess_safe"><code>is_multiprocess_safe</code></a></td> 
    169171    <td>Variable in class <a href="session2.store.DurusSessionStore.DurusSessionStore-class.html"><code>session2.store.DurusSessionStore.DurusSessionStore</code></a></td></tr> 
     172  <tr><td width="15%"><a href="session2.store.MemorySessionStore.MemorySessionStore-class.html#is_multiprocess_safe"><code>is_multiprocess_safe</code></a></td> 
     173    <td>Variable in class <a href="session2.store.MemorySessionStore.MemorySessionStore-class.html"><code>session2.store.MemorySessionStore.MemorySessionStore</code></a></td></tr> 
    170174  <tr><td width="15%"><a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html#is_multiprocess_safe"><code>is_multiprocess_safe</code></a></td> 
    171175    <td>Variable in class <a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html"><code>session2.store.MySQLSessionStore.MySQLSessionStore</code></a></td></tr> 
     
    176180  <tr><td width="15%"><a href="session2.store.ShelveSessionStore.ShelveSessionStore-class.html#is_multiprocess_safe"><code>is_multiprocess_safe</code></a></td> 
    177181    <td>Variable in class <a href="session2.store.ShelveSessionStore.ShelveSessionStore-class.html"><code>session2.store.ShelveSessionStore.ShelveSessionStore</code></a></td></tr> 
    178   <tr><td width="15%"><a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html#is_multiprocess_safe"><code>is_multiprocess_safe</code></a></td> 
    179     <td>Variable in class <a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html"><code>session2.store.VolatileSessionStore.VolatileSessionStore</code></a></td></tr> 
    180182  <tr><td width="15%"><a href="session2.store.DirectorySessionStore.DirectorySessionStore-class.html#is_thread_safe"><code>is_thread_safe</code></a></td> 
    181183    <td>Variable in class <a href="session2.store.DirectorySessionStore.DirectorySessionStore-class.html"><code>session2.store.DirectorySessionStore.DirectorySessionStore</code></a></td></tr> 
    182184  <tr><td width="15%"><a href="session2.store.DurusSessionStore.DurusSessionStore-class.html#is_thread_safe"><code>is_thread_safe</code></a></td> 
    183185    <td>Variable in class <a href="session2.store.DurusSessionStore.DurusSessionStore-class.html"><code>session2.store.DurusSessionStore.DurusSessionStore</code></a></td></tr> 
     186  <tr><td width="15%"><a href="session2.store.MemorySessionStore.MemorySessionStore-class.html#is_thread_safe"><code>is_thread_safe</code></a></td> 
     187    <td>Variable in class <a href="session2.store.MemorySessionStore.MemorySessionStore-class.html"><code>session2.store.MemorySessionStore.MemorySessionStore</code></a></td></tr> 
    184188  <tr><td width="15%"><a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html#is_thread_safe"><code>is_thread_safe</code></a></td> 
    185189    <td>Variable in class <a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html"><code>session2.store.MySQLSessionStore.MySQLSessionStore</code></a></td></tr> 
     
    190194  <tr><td width="15%"><a href="session2.store.ShelveSessionStore.ShelveSessionStore-class.html#is_thread_safe"><code>is_thread_safe</code></a></td> 
    191195    <td>Variable in class <a href="session2.store.ShelveSessionStore.ShelveSessionStore-class.html"><code>session2.store.ShelveSessionStore.ShelveSessionStore</code></a></td></tr> 
    192   <tr><td width="15%"><a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html#is_thread_safe"><code>is_thread_safe</code></a></td> 
    193     <td>Variable in class <a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html"><code>session2.store.VolatileSessionStore.VolatileSessionStore</code></a></td></tr> 
    194196  <tr><td width="15%"><a href="UserDict.UserDict-class.html#items"><code>items</code></a></td> 
    195197    <td>Method in class <a href="UserDict.UserDict-class.html"><code>UserDict.UserDict</code></a></td></tr> 
     198  <tr><td width="15%"><a href="session2.store.MemorySessionStore.MemorySessionStore-class.html#iter_sessions"><code>iter_sessions</code></a></td> 
     199    <td>Method in class <a href="session2.store.MemorySessionStore.MemorySessionStore-class.html"><code>session2.store.MemorySessionStore.MemorySessionStore</code></a></td></tr> 
    196200  <tr><td width="15%"><a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html#iter_sessions"><code>iter_sessions</code></a></td> 
    197201    <td>Method in class <a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html"><code>session2.store.MySQLSessionStore.MySQLSessionStore</code></a></td></tr> 
     
    210214  <tr><td width="15%"><a href="session2.store.DurusSessionStore.DurusSessionStore-class.html#load_session"><code>load_session</code></a></td> 
    211215    <td>Method in class <a href="session2.store.DurusSessionStore.DurusSessionStore-class.html"><code>session2.store.DurusSessionStore.DurusSessionStore</code></a></td></tr> 
     216  <tr><td width="15%"><a href="session2.store.MemorySessionStore.MemorySessionStore-class.html#load_session"><code>load_session</code></a></td> 
     217    <td>Method in class <a href="session2.store.MemorySessionStore.MemorySessionStore-class.html"><code>session2.store.MemorySessionStore.MemorySessionStore</code></a></td></tr> 
    212218  <tr><td width="15%"><a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html#load_session"><code>load_session</code></a></td> 
    213219    <td>Method in class <a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html"><code>session2.store.MySQLSessionStore.MySQLSessionStore</code></a></td></tr> 
     
    218224  <tr><td width="15%"><a href="session2.store.ShelveSessionStore.ShelveSessionStore-class.html#load_session"><code>load_session</code></a></td> 
    219225    <td>Method in class <a href="session2.store.ShelveSessionStore.ShelveSessionStore-class.html"><code>session2.store.ShelveSessionStore.ShelveSessionStore</code></a></td></tr> 
    220   <tr><td width="15%"><a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html#load_session"><code>load_session</code></a></td> 
    221     <td>Method in class <a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html"><code>session2.store.VolatileSessionStore.VolatileSessionStore</code></a></td></tr> 
    222226  <tr><td width="15%"><a href="session2.SessionManager.SessionManager-class.html#maintain_session"><code>maintain_session</code></a></td> 
    223227    <td>Method in class <a href="session2.SessionManager.SessionManager-class.html"><code>session2.SessionManager.SessionManager</code></a></td></tr> 
     228  <tr><td width="15%"><a href="session2.store.MemorySessionStore-module.html"><code>MemorySessionStore</code></a></td> 
     229    <td>Module in package <a href="session2.store-module.html"><code>session2.store</code></a></td></tr> 
     230  <tr><td width="15%"><a href="session2.store.MemorySessionStore.MemorySessionStore-class.html"><code>MemorySessionStore</code></a></td> 
     231    <td>Class in module <a href="session2.store.MemorySessionStore-module.html"><code>session2.store.MemorySessionStore</code></a></td></tr> 
    224232  <tr><td width="15%"><a href="session2.store.MySQLSessionStore-module.html"><code>MySQLSessionStore</code></a></td> 
    225233    <td>Module in package <a href="session2.store-module.html"><code>session2.store</code></a></td></tr> 
     
    248256  <tr><td width="15%"><a href="session2.store.DurusSessionStore.DurusSessionStore-class.html#save_session"><code>save_session</code></a></td> 
    249257    <td>Method in class <a href="session2.store.DurusSessionStore.DurusSessionStore-class.html"><code>session2.store.DurusSessionStore.DurusSessionStore</code></a></td></tr> 
     258  <tr><td width="15%"><a href="session2.store.MemorySessionStore.MemorySessionStore-class.html#save_session"><code>save_session</code></a></td> 
     259    <td>Method in class <a href="session2.store.MemorySessionStore.MemorySessionStore-class.html"><code>session2.store.MemorySessionStore.MemorySessionStore</code></a></td></tr> 
    250260  <tr><td width="15%"><a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html#save_session"><code>save_session</code></a></td> 
    251261    <td>Method in class <a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html"><code>session2.store.MySQLSessionStore.MySQLSessionStore</code></a></td></tr> 
     
    256266  <tr><td width="15%"><a href="session2.store.ShelveSessionStore.ShelveSessionStore-class.html#save_session"><code>save_session</code></a></td> 
    257267    <td>Method in class <a href="session2.store.ShelveSessionStore.ShelveSessionStore-class.html"><code>session2.store.ShelveSessionStore.ShelveSessionStore</code></a></td></tr> 
    258   <tr><td width="15%"><a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html#save_session"><code>save_session</code></a></td> 
    259     <td>Method in class <a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html"><code>session2.store.VolatileSessionStore.VolatileSessionStore</code></a></td></tr> 
    260268  <tr><td width="15%"><a href="session2.Session-module.html"><code>Session</code></a></td> 
    261269    <td>Module in package <a href="session2-module.html"><code>session2</code></a></td></tr> 
     
    278286  <tr><td width="15%"><a href="UserDict.UserDict-class.html#setdefault"><code>setdefault</code></a></td> 
    279287    <td>Method in class <a href="UserDict.UserDict-class.html"><code>UserDict.UserDict</code></a></td></tr> 
     288  <tr><td width="15%"><a href="session2.store.MemorySessionStore.MemorySessionStore-class.html#setup"><code>setup</code></a></td> 
     289    <td>Method in class <a href="session2.store.MemorySessionStore.MemorySessionStore-class.html"><code>session2.store.MemorySessionStore.MemorySessionStore</code></a></td></tr> 
    280290  <tr><td width="15%"><a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html#setup"><code>setup</code></a></td> 
    281291    <td>Method in class <a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html"><code>session2.store.MySQLSessionStore.MySQLSessionStore</code></a></td></tr> 
     
    300310  <tr><td width="15%"><a href="UserDict.UserDict-class.html#values"><code>values</code></a></td> 
    301311    <td>Method in class <a href="UserDict.UserDict-class.html"><code>UserDict.UserDict</code></a></td></tr> 
    302   <tr><td width="15%"><a href="session2.store.VolatileSessionStore-module.html"><code>VolatileSessionStore</code></a></td> 
    303     <td>Module in package <a href="session2.store-module.html"><code>session2.store</code></a></td></tr> 
    304   <tr><td width="15%"><a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html"><code>VolatileSessionStore</code></a></td> 
    305     <td>Class in module <a href="session2.store.VolatileSessionStore-module.html"><code>session2.store.VolatileSessionStore</code></a></td></tr> 
    306312</table> 
    307313<br /> 
     
    326332<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    327333  <tr> 
    328     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     334    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    329335    <td align="right"><a href="http://epydoc.sourceforge.net" 
    330336                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2-module.html

    r9 r12  
    4141<h2 class="package">Package session2</h2> 
    4242 
    43 <p>A refactored Quixote 2.x session manager and associated persistent session 
    44 stores.</p> 
    45 <p>Authors: C. Titus Brown and Mike Orr.</p> 
    46 <p>LICENSE: MIT.</p> 
    47 <p>See the <a class="reference" href="../README.html">README.txt</a> distributed with this package for more information, 
    48 or visit <a class="reference" href="http://quixote.idyll.org/session2/">http://quixote.idyll.org/session2/</a>.</p> 
     43<pre class="literalblock"> 
     44A refactored Quixote 2.x session manager and associated persistent session 
     45stores. 
     46 
     47Authors: C. Titus Brown and Mike Orr. 
     48 
     49LICENSE: MIT. 
     50 
     51See the README.txt_ distributed with this package for more information, 
     52or visit http://quixote.idyll.org/session2/. 
     53 
     54.. _README.txt: ../README.html 
     55</pre> 
    4956<hr/> 
    5057 
     
    5764<li> <b><a href="session2.Session-module.html"><code>Session</code></a></b>: <i>Session storage class for Quixote 2.x.</i> 
    5865<li> <b><a href="session2.SessionManager-module.html"><code>SessionManager</code></a></b>: <i>A persistent session manager class for Quixote 2.x.</i> 
    59 <li> <b><a href="session2.store-module.html"><code>store</code></a></b>: <i>Persistent session stores for <a href="session2.SessionManager-module.html" class="link"><code>session2.SessionManager</code></a>.</i> 
     66<li> <b><a href="session2.store-module.html"><code>store</code></a></b>: <i>Persistent session stores for `session2.SessionManager`.</i> 
    6067  <ul> 
    6168    <li> <b><a href="session2.store.DirectorySessionStore-module.html"><code>DirectorySessionStore</code></a></b>: <i>Store sessions in individual files within a directory.</i> 
    6269    <li> <b><a href="session2.store.DurusSessionStore-module.html"><code>DurusSessionStore</code></a></b>: <i>Store sessions in a Durus database.</i> 
     70    <li> <b><a href="session2.store.MemorySessionStore-module.html"><code>MemorySessionStore</code></a></b> 
    6371    <li> <b><a href="session2.store.MySQLSessionStore-module.html"><code>MySQLSessionStore</code></a></b>: <i>Store sessions in a MySQL table.</i> 
    6472    <li> <b><a href="session2.store.PostgresSessionStore-module.html"><code>PostgresSessionStore</code></a></b>: <i>Store sessions in a PostgreSQL table.</i> 
    6573    <li> <b><a href="session2.store.SessionStore-module.html"><code>SessionStore</code></a></b>: <i>Base class for persistent session stores.</i> 
    6674    <li> <b><a href="session2.store.ShelveSessionStore-module.html"><code>ShelveSessionStore</code></a></b>: <i>Store sessions in a 'shelve' database.</i> 
    67     <li> <b><a href="session2.store.VolatileSessionStore-module.html"><code>VolatileSessionStore</code></a></b>: <i>A simple in-memory volatile session store, mimicking the default 
    68 Quixote session management.</i> 
    6975  </ul> 
    7076  </ul></td></tr> 
     
    7783  <th colspan="2">Variable Summary</th></tr> 
    7884<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td> 
    79 <td><b><a href="session2-module.html#__version__"><code>__version__</code></a></b> = <span title="'0.6'"><code><span class="variable-quote">'</span>0.6<span class="variable-quote">'</span>                                      </code> 
     85<td><b><a href="session2-module.html#__version__"><code>__version__</code></a></b> = <span title="'0.6.1'"><code><span class="variable-quote">'</span>0.6.1<span class="variable-quote">'</span>                                    </code> 
    8086</span></td></tr> 
    8187</table><br /> 
     
    99105 
    100106      </dd> 
    101 <span title="'0.6'">      <dt><b>Value:</b></dt> 
     107<span title="'0.6.1'">      <dt><b>Value:</b></dt> 
    102108      <dd><table><tr><td> 
    103109<pre class="variable"> 
    104 <span class="variable-quote">'</span>0.6<span class="variable-quote">'</span>                                                                  </pre> 
     110<span class="variable-quote">'</span>0.6.1<span class="variable-quote">'</span>                                                                </pre> 
    105111        </td></tr></table></dd> 
    106112</span>    </dl> 
     
    129135<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    130136  <tr> 
    131     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     137    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    132138    <td align="right"><a href="http://epydoc.sourceforge.net" 
    133139                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.DictSession-module.html

    r9 r12  
    4242<h2 class="module">Module session2.DictSession</h2> 
    4343 
    44 <p>A session object that also acts like a dictionary.</p> 
     44<pre class="literalblock"> 
     45A session object that also acts like a dictionary. 
     46</pre> 
    4547<hr/> 
    4648 
     
    7476<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    7577  <tr> 
    76     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     78    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    7779    <td align="right"><a href="http://epydoc.sourceforge.net" 
    7880                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.DictSession.DictSession-class.html

    r9 r12  
    5353<hr/> 
    5454 
    55 <p>A session object that also acts like a dictionary.</p> 
    56 <p>Unlike some object/dict hybrids, keys and attributes are distinct and not 
     55<pre class="literalblock"> 
     56A session object that also acts like a dictionary. 
     57 
     58Unlike some object/dict hybrids, keys and attributes are distinct and not 
    5759interchangeable.  Beware of assigning attributes that override dict 
    58 methods.</p> 
     60methods. 
     61</pre> 
    5962<hr/> 
    6063 
     
    196199  <td><code><span class="summary-sig"><a href="session2.Session.Session-class.html#has_info" class="summary-sig-name"><code>has_info</code></a>(<span class=summary-sig-arg>self</span>)</span></code> 
    197200<br /> 
    198 () -&gt; boolean</td></tr> 
     201() -&gt; boolean 
     202 
     203Return true if this session contains any information that must 
     204be saved.</td></tr> 
    199205<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td> 
    200206  <td><code><span class="summary-sig"><a href="session2.Session.Session-class.html#set_user" class="summary-sig-name"><code>set_user</code></a>(<span class=summary-sig-arg>self</span>, 
     
    229235<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    230236  <tr> 
    231     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     237    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    232238    <td align="right"><a href="http://epydoc.sourceforge.net" 
    233239                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.Session-module.html

    r9 r12  
    4242<h2 class="module">Module session2.Session</h2> 
    4343 
    44 <p>Session storage class for Quixote 2.x.</p> 
     44<pre class="literalblock"> 
     45Session storage class for Quixote 2.x. 
     46</pre> 
    4547<hr/> 
    4648 
     
    7476<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    7577  <tr> 
    76     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     78    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    7779    <td align="right"><a href="http://epydoc.sourceforge.net" 
    7880                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.Session.Session-class.html

    r9 r12  
    4949<hr/> 
    5050 
    51 <p>Holds information about the current session.  The only information 
     51<pre class="literalblock"> 
     52Holds information about the current session.  The only information 
    5253that is likely to be useful to applications is the 'user' attribute, 
    53 which applications can use as they please.</p> 
    54 <dl class="docutils"> 
    55 <dt>Instance attributes:</dt> 
    56 <dd><ul class="first last"> 
    57 <li><dl class="first docutils"> 
    58 <dt>id <span class="classifier-delimiter">:</span> <span class="classifier">string</span></dt> 
    59 <dd><p class="first last">the session ID (generated by SessionManager and used as the 
    60 value of the session cookie)</p> 
    61 </dd> 
    62 </dl> 
    63 </li> 
    64 <li><dl class="first docutils"> 
    65 <dt>user <span class="classifier-delimiter">:</span> <span class="classifier">any</span></dt> 
    66 <dd><p class="first last">an object to identify the human being on the other end of the 
    67 line.  It's up to you whether to store just a string in 'user', 
    68 or some more complex data structure or object.</p> 
    69 </dd> 
    70 </dl> 
    71 </li> 
    72 <li><dl class="first docutils"> 
    73 <dt>_remote_address <span class="classifier-delimiter">:</span> <span class="classifier">string</span></dt> 
    74 <dd><p class="first last">IP address of user owning this session (only set when the 
    75 session is created)</p> 
    76 </dd> 
    77 </dl> 
    78 </li> 
    79 <li><p class="first">_creation_time : float</p> 
    80 </li> 
    81 <li><dl class="first docutils"> 
    82 <dt>_access_time <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt> 
    83 <dd><p class="first last">two ways of keeping track of the &quot;age&quot; of the session. 
    84 Note that '__access_time' is maintained by the SessionManager that 
    85 owns this session, using _set_access_time().</p> 
    86 </dd> 
    87 </dl> 
    88 </li> 
    89 </ul> 
    90 </dd> 
    91 </dl> 
    92 <p>Feel free to access 'id' and 'user' directly, but do not modify 
     54which applications can use as they please. 
     55 
     56Instance attributes: 
     57 * id : string 
     58    the session ID (generated by SessionManager and used as the 
     59    value of the session cookie) 
     60 * user : any 
     61    an object to identify the human being on the other end of the 
     62    line.  It's up to you whether to store just a string in 'user', 
     63    or some more complex data structure or object. 
     64 * _remote_address : string 
     65    IP address of user owning this session (only set when the 
     66    session is created) 
     67 * _creation_time : float 
     68 * _access_time : float 
     69    two ways of keeping track of the &quot;age&quot; of the session. 
     70    Note that '__access_time' is maintained by the SessionManager that 
     71    owns this session, using _set_access_time(). 
     72 
     73Feel free to access 'id' and 'user' directly, but do not modify 
    9374'id'.  The preferred way to set 'user' is with the set_user() method 
    94 (which you might want to override for type-checking).</p> 
    95 <p>Note: this class may be split into a SimpleSession superclass and a Session 
    96 subclass in the future.</p> 
     75(which you might want to override for type-checking). 
     76 
     77Note: this class may be split into a SimpleSession superclass and a Session 
     78subclass in the future. 
     79</pre> 
    9780<hr/> 
    9881 
     
    10689          <span class=summary-sig-arg>id</span>)</span></code> 
    10790<br /> 
    108 __init__ -- called only by <a href="session2.SessionManager.SessionManager-class.html" class="link"><code>SessionManager.SessionManager</code></a>.</td></tr> 
     91__init__ -- called only by `SessionManager.SessionManager`.</td></tr> 
    10992<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td> 
    11093  <td><code><a name="__repr__"></a><span class="summary-sig"><span class="summary-sig-name">__repr__</span>(<span class=summary-sig-arg>self</span>)</span></code> 
     
    150133  <td><code><span class="summary-sig"><a href="session2.Session.Session-class.html#has_info" class="summary-sig-name"><code>has_info</code></a>(<span class=summary-sig-arg>self</span>)</span></code> 
    151134<br /> 
    152 () -&gt; boolean</td></tr> 
     135() -&gt; boolean 
     136 
     137Return true if this session contains any information that must 
     138be saved.</td></tr> 
    153139<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td> 
    154140  <td><code><a name="set_user"></a><span class="summary-sig"><span class="summary-sig-name">set_user</span>(<span class=summary-sig-arg>self</span>, 
     
    176162    <br /><i>(Constructor)</i> 
    177163  </h3> 
    178 <p>__init__ -- called only by <a href="session2.SessionManager.SessionManager-class.html" class="link"><code>SessionManager.SessionManager</code></a>.</p> 
     164<pre class="literalblock"> 
     165__init__ -- called only by `SessionManager.SessionManager`. 
     166</pre> 
    179167  <dl><dt></dt><dd> 
    180168  </dd></dl> 
     
    186174          <span class=sig-arg>_now</span>=<span class=sig-default>None</span>)</span> 
    187175  </h3> 
    188 <p>Return the number of seconds since session was last accessed.</p> 
     176<pre class="literalblock"> 
     177Return the number of seconds since session was last accessed. 
     178</pre> 
    189179  <dl><dt></dt><dd> 
    190180  </dd></dl> 
     
    195185  <h3><span class="sig"><span class="sig-name">get_access_time</span>(<span class=sig-arg>self</span>)</span> 
    196186  </h3> 
    197 <p>Return the time that this session was last accessed (seconds 
    198 since epoch).</p> 
     187<pre class="literalblock"> 
     188Return the time that this session was last accessed (seconds 
     189since epoch). 
     190</pre> 
    199191  <dl><dt></dt><dd> 
    200192  </dd></dl> 
     
    206198          <span class=sig-arg>_now</span>=<span class=sig-default>None</span>)</span> 
    207199  </h3> 
    208 <p>Return the number of seconds since session was created.</p> 
     200<pre class="literalblock"> 
     201Return the number of seconds since session was created. 
     202</pre> 
    209203  <dl><dt></dt><dd> 
    210204  </dd></dl> 
     
    215209  <h3><span class="sig"><span class="sig-name">get_creation_time</span>(<span class=sig-arg>self</span>)</span> 
    216210  </h3> 
    217 <p>Return the time that this session was created (seconds 
    218 since epoch).</p> 
     211<pre class="literalblock"> 
     212Return the time that this session was created (seconds 
     213since epoch). 
     214</pre> 
    219215  <dl><dt></dt><dd> 
    220216  </dd></dl> 
     
    225221  <h3><span class="sig"><span class="sig-name">get_remote_address</span>(<span class=sig-arg>self</span>)</span> 
    226222  </h3> 
    227 <p>Return the IP address (dotted-quad string) that made the 
    228 initial request in this session.</p> 
     223<pre class="literalblock"> 
     224Return the IP address (dotted-quad string) that made the 
     225initial request in this session. 
     226</pre> 
    229227  <dl><dt></dt><dd> 
    230228  </dd></dl> 
     
    235233  <h3><span class="sig"><span class="sig-name">has_info</span>(<span class=sig-arg>self</span>)</span> 
    236234  </h3> 
    237 <p>() -&gt; boolean</p> 
    238 <p>Return true if this session contains any information that must 
    239 be saved.</p> 
     235<pre class="literalblock"> 
     236() -&gt; boolean 
     237 
     238Return true if this session contains any information that must 
     239be saved. 
     240</pre> 
    240241  <dl><dt></dt><dd> 
    241242  </dd></dl> 
     
    246247  <h3><span class="sig"><span class="sig-name">start_request</span>(<span class=sig-arg>self</span>)</span> 
    247248  </h3> 
    248 <p>Called near the beginning of each request: after the HTTPRequest 
     249<pre class="literalblock"> 
     250Called near the beginning of each request: after the HTTPRequest 
    249251object has been built, but before we traverse the URL or call the 
    250 callable object found by URL traversal.</p> 
     252callable object found by URL traversal. 
     253</pre> 
    251254  <dl><dt></dt><dd> 
    252255  </dd></dl> 
     
    274277<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    275278  <tr> 
    276     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     279    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    277280    <td align="right"><a href="http://epydoc.sourceforge.net" 
    278281                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.SessionManager-module.html

    r9 r12  
    4242<h2 class="module">Module session2.SessionManager</h2> 
    4343 
    44 <p>A persistent session manager class for Quixote 2.x.</p> 
     44<pre class="literalblock"> 
     45A persistent session manager class for Quixote 2.x. 
     46</pre> 
    4547<hr/> 
    4648 
     
    7476<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    7577  <tr> 
    76     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     78    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    7779    <td align="right"><a href="http://epydoc.sourceforge.net" 
    7880                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.SessionManager.SessionManager-class.html

    r9 r12  
    4545<hr/> 
    4646 
    47 <p>A persistent session manager for Quixote.</p> 
     47<pre class="literalblock"> 
     48A persistent session manager for Quixote. 
     49</pre> 
    4850<hr/> 
    4951 
     
    8385  <td><code><span class="summary-sig"><a href="session2.SessionManager.SessionManager-class.html#get_session" class="summary-sig-name"><code>get_session</code></a>(<span class=summary-sig-arg>self</span>)</span></code> 
    8486<br /> 
    85 () -&gt; Session</td></tr> 
     87() -&gt; Session 
     88 
     89Fetch or create a session object for the current session, and 
     90return it.</td></tr> 
    8691<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td> 
    8792  <td><code><span class="summary-sig"><a href="session2.SessionManager.SessionManager-class.html#has_session" class="summary-sig-name"><code>has_session</code></a>(<span class=summary-sig-arg>self</span>, 
    8893          <span class=summary-sig-arg>session_id</span>)</span></code> 
    8994<br /> 
    90 (session_id : string) -&gt; boolean</td></tr> 
     95(session_id : string) -&gt; boolean 
     96 
     97Return true if a session identified by 'session_id' exists in 
     98the session manager.</td></tr> 
    9199<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td> 
    92100  <td><code><span class="summary-sig"><a href="session2.SessionManager.SessionManager-class.html#has_session_cookie" class="summary-sig-name"><code>has_session_cookie</code></a>(<span class=summary-sig-arg>self</span>, 
    93101          <span class=summary-sig-arg>must_exist</span>)</span></code> 
    94102<br /> 
    95 (must_exist : boolean = false) -&gt; bool</td></tr> 
     103(must_exist : boolean = false) -&gt; bool 
     104 
     105Return true if the request already has a cookie identifying a 
     106session object.</td></tr> 
    96107<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td> 
    97108  <td><code><span class="summary-sig"><a href="session2.SessionManager.SessionManager-class.html#maintain_session" class="summary-sig-name"><code>maintain_session</code></a>(<span class=summary-sig-arg>self</span>, 
    98109          <span class=summary-sig-arg>session</span>)</span></code> 
    99110<br /> 
    100 (session : Session) -&gt; bool</td></tr> 
     111(session : Session) -&gt; bool 
     112 
     113Maintain session information.</td></tr> 
    101114<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td> 
    102115  <td><code><span class="summary-sig"><a href="session2.SessionManager.SessionManager-class.html#new_session" class="summary-sig-name"><code>new_session</code></a>(<span class=summary-sig-arg>self</span>, 
    103116          <span class=summary-sig-arg>id</span>)</span></code> 
    104117<br /> 
    105 (id : string) -&gt; Session</td></tr> 
     118(id : string) -&gt; Session 
     119 
     120Return a new session object, ie.</td></tr> 
    106121<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td> 
    107122  <td><code><span class="summary-sig"><a href="session2.SessionManager.SessionManager-class.html#revoke_session_cookie" class="summary-sig-name"><code>revoke_session_cookie</code></a>(<span class=summary-sig-arg>self</span>)</span></code> 
     
    113128          <span class=summary-sig-arg>session_id</span>)</span></code> 
    114129<br /> 
    115 (session_id : string)</td></tr> 
     130(session_id : string) 
     131 
     132Ensure that a session cookie with value 'session_id' will be 
     133returned to the client via the response object.</td></tr> 
    116134<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td> 
    117135  <td><code><span class="summary-sig"><a href="session2.SessionManager.SessionManager-class.html#start_request" class="summary-sig-name"><code>start_request</code></a>(<span class=summary-sig-arg>self</span>)</span></code> 
     
    142160  <h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>, 
    143161          <span class=sig-arg>store_obj</span>, 
    144           <span class=sig-arg>session_class</span>=<span class=sig-default>&lt;class&nbsp;session2.Session.Session&nbsp;at&nbsp;0x4034b1ac&gt;</span>)</span> 
     162          <span class=sig-arg>session_class</span>=<span class=sig-default>&lt;class&nbsp;session2.Session.Session&nbsp;at&nbsp;0x4030414c&gt;</span>)</span> 
    145163    <br /><i>(Constructor)</i> 
    146164  </h3> 
    147 <p>__init__ takes a session store instance and (optionally) the 
     165<pre class="literalblock"> 
     166__init__ takes a session store instance and (optionally) the 
    148167session class to use for storing session information.  (This 
    149 defaults to <a href="session2.Session.Session-class.html" class="link"><code>Session.Session</code></a>).</p> 
     168defaults to `Session.Session`). 
     169</pre> 
    150170  <dl><dt></dt><dd> 
    151171  </dd></dl> 
     
    157177          <span class=sig-arg>request</span>)</span> 
    158178  </h3> 
    159 <p>Clear any residual session information for this request.</p> 
     179<pre class="literalblock"> 
     180Clear any residual session information for this request. 
     181</pre> 
    160182  <dl><dt></dt><dd> 
    161183  </dd></dl> 
     
    166188  <h3><span class="sig"><span class="sig-name">expire_session</span>(<span class=sig-arg>self</span>)</span> 
    167189  </h3> 
    168 <p>Expire the current session, ie. revoke the session cookie from 
     190<pre class="literalblock"> 
     191Expire the current session, ie. revoke the session cookie from 
    169192the client, remove the session object from the current request, 
    170 and list it for permanent removal.</p> 
     193and list it for permanent removal. 
     194</pre> 
    171195  <dl><dt></dt><dd> 
    172196  </dd></dl> 
     
    177201  <h3><span class="sig"><span class="sig-name">finish_failed_request</span>(<span class=sig-arg>self</span>)</span> 
    178202  </h3> 
    179 <p>Called near the end of a failed request (i.e. a exception that was 
    180 not a PublisherError was raised.</p> 
     203<pre class="literalblock"> 
     204Called near the end of a failed request (i.e. a exception that was 
     205not a PublisherError was raised. 
     206</pre> 
    181207  <dl><dt></dt><dd> 
    182208  </dd></dl> 
     
    187213  <h3><span class="sig"><span class="sig-name">finish_successful_request</span>(<span class=sig-arg>self</span>)</span> 
    188214  </h3> 
    189 <p>Called near the end of each successful request.  Not called if 
    190 there were any errors processing the request.</p> 
     215<pre class="literalblock"> 
     216Called near the end of each successful request.  Not called if 
     217there were any errors processing the request. 
     218</pre> 
    191219  <dl><dt></dt><dd> 
    192220  </dd></dl> 
     
    197225  <h3><span class="sig"><span class="sig-name">get_session</span>(<span class=sig-arg>self</span>)</span> 
    198226  </h3> 
    199 <p>() -&gt; Session</p> 
    200 <p>Fetch or create a session object for the current session, and 
     227<pre class="literalblock"> 
     228() -&gt; Session 
     229 
     230Fetch or create a session object for the current session, and 
    201231return it.  If a session cookie is found in the HTTP request 
    202232object, use it to look up and return an existing session object. 
    203 If no session cookie is found, create a new session.</p> 
    204 <p>Note that this method does <em>not</em> cause the new session to be 
     233If no session cookie is found, create a new session. 
     234 
     235Note that this method does *not* cause the new session to be 
    205236stored in the session manager, nor does it drop a session cookie 
    206237on the user.  Those are both the responsibility of 
    207 finish_successful_request().</p> 
     238finish_successful_request(). 
     239</pre> 
    208240  <dl><dt></dt><dd> 
    209241  </dd></dl> 
     
    215247          <span class=sig-arg>session_id</span>)</span> 
    216248  </h3> 
    217 <p>(session_id : string) -&gt; boolean</p> 
    218 <p>Return true if a session identified by 'session_id' exists in 
    219 the session manager.</p> 
     249<pre class="literalblock"> 
     250(session_id : string) -&gt; boolean 
     251 
     252Return true if a session identified by 'session_id' exists in 
     253the session manager. 
     254</pre> 
    220255  <dl><dt></dt><dd> 
    221256  </dd></dl> 
     
    227262          <span class=sig-arg>must_exist</span>=<span class=sig-default>False</span>)</span> 
    228263  </h3> 
    229 <p>(must_exist : boolean = false) -&gt; bool</p> 
    230 <p>Return true if the request already has a cookie identifying a 
     264<pre class="literalblock"> 
     265(must_exist : boolean = false) -&gt; bool 
     266 
     267Return true if the request already has a cookie identifying a 
    231268session object.  If 'must_exist' is true, the cookie must 
    232269correspond to a currently existing session; otherwise (the 
    233270default), we just check for the existence of the session cookie 
    234 and don't inspect its content at all.</p> 
     271and don't inspect its content at all. 
     272</pre> 
    235273  <dl><dt></dt><dd> 
    236274  </dd></dl> 
     
    242280          <span class=sig-arg>session</span>)</span> 
    243281  </h3> 
    244 <p>(session : Session) -&gt; bool</p> 
    245 <p>Maintain session information.  This method is called after servicing 
     282<pre class="literalblock"> 
     283(session : Session) -&gt; bool 
     284 
     285Maintain session information.  This method is called after servicing 
    246286an HTTP request, just before the response is returned.  If a session 
    247287contains information a cookie is dropped on the client and True is 
    248288returned.  If not, the session is forcibly expired and False is 
    249 returned.</p> 
     289returned. 
     290</pre> 
    250291  <dl><dt></dt><dd> 
    251292  </dd></dl> 
     
    257298          <span class=sig-arg>id</span>)</span> 
    258299  </h3> 
    259 <p>(id : string) -&gt; Session</p> 
    260 <p>Return a new session object, ie. an instance of the session_class 
    261 class passed to the constructor (defaults to Session).</p> 
     300<pre class="literalblock"> 
     301(id : string) -&gt; Session 
     302 
     303Return a new session object, ie. an instance of the session_class 
     304class passed to the constructor (defaults to Session). 
     305</pre> 
    262306  <dl><dt></dt><dd> 
    263307  </dd></dl> 
     
    268312  <h3><span class="sig"><span class="sig-name">revoke_session_cookie</span>(<span class=sig-arg>self</span>)</span> 
    269313  </h3> 
    270 <p>Remove the session cookie from the remote user's session by 
     314<pre class="literalblock"> 
     315Remove the session cookie from the remote user's session by 
    271316resetting the value and maximum age in the response object.  Also 
    272317remove the cookie from the request so that further processing of 
    273 this request does not see the cookie's revoked value.</p> 
     318this request does not see the cookie's revoked value. 
     319</pre> 
    274320  <dl><dt></dt><dd> 
    275321  </dd></dl> 
     
    281327          <span class=sig-arg>session_id</span>)</span> 
    282328  </h3> 
    283 <p>(session_id : string)</p> 
    284 <p>Ensure that a session cookie with value 'session_id' will be 
    285 returned to the client via the response object.</p> 
     329<pre class="literalblock"> 
     330(session_id : string) 
     331 
     332Ensure that a session cookie with value 'session_id' will be 
     333returned to the client via the response object. 
     334</pre> 
    286335  <dl><dt></dt><dd> 
    287336  </dd></dl> 
     
    292341  <h3><span class="sig"><span class="sig-name">start_request</span>(<span class=sig-arg>self</span>)</span> 
    293342  </h3> 
    294 <p>Called near the beginning of each request: after the HTTPRequest 
     343<pre class="literalblock"> 
     344Called near the beginning of each request: after the HTTPRequest 
    295345object has been built, but before we traverse the URL or call the 
    296 callable object found by URL traversal.</p> 
     346callable object found by URL traversal. 
     347</pre> 
    297348  <dl><dt></dt><dd> 
    298349  </dd></dl> 
     
    348399<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    349400  <tr> 
    350     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     401    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    351402    <td align="right"><a href="http://epydoc.sourceforge.net" 
    352403                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.store-module.html

    r9 r12  
    4242<h2 class="package">Package session2.store</h2> 
    4343 
    44 <p>Persistent session stores for <a href="session2.SessionManager-module.html" class="link"><code>session2.SessionManager</code></a>.</p> 
     44<pre class="literalblock"> 
     45Persistent session stores for `session2.SessionManager`. 
     46</pre> 
    4547<hr/> 
    4648 
     
    5254<li> <b><a href="session2.store.DirectorySessionStore-module.html"><code>DirectorySessionStore</code></a></b>: <i>Store sessions in individual files within a directory.</i> 
    5355<li> <b><a href="session2.store.DurusSessionStore-module.html"><code>DurusSessionStore</code></a></b>: <i>Store sessions in a Durus database.</i> 
     56<li> <b><a href="session2.store.MemorySessionStore-module.html"><code>MemorySessionStore</code></a></b> 
    5457<li> <b><a href="session2.store.MySQLSessionStore-module.html"><code>MySQLSessionStore</code></a></b>: <i>Store sessions in a MySQL table.</i> 
    5558<li> <b><a href="session2.store.PostgresSessionStore-module.html"><code>PostgresSessionStore</code></a></b>: <i>Store sessions in a PostgreSQL table.</i> 
    5659<li> <b><a href="session2.store.SessionStore-module.html"><code>SessionStore</code></a></b>: <i>Base class for persistent session stores.</i> 
    5760<li> <b><a href="session2.store.ShelveSessionStore-module.html"><code>ShelveSessionStore</code></a></b>: <i>Store sessions in a 'shelve' database.</i> 
    58 <li> <b><a href="session2.store.VolatileSessionStore-module.html"><code>VolatileSessionStore</code></a></b>: <i>A simple in-memory volatile session store, mimicking the default 
    59 Quixote session management.</i> 
    6061  </ul></td></tr> 
    6162</table><br /> 
     
    8182<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    8283  <tr> 
    83     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     84    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    8485    <td align="right"><a href="http://epydoc.sourceforge.net" 
    8586                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.store.DirectorySessionStore-module.html

    r9 r12  
    4343<h2 class="module">Module session2.store.DirectorySessionStore</h2> 
    4444 
    45 <p>Store sessions in individual files within a directory.</p> 
     45<pre class="literalblock"> 
     46Store sessions in individual files within a directory. 
     47</pre> 
    4648<hr/> 
    4749 
     
    7577<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    7678  <tr> 
    77     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     79    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    7880    <td align="right"><a href="http://epydoc.sourceforge.net" 
    7981                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.store.DirectorySessionStore.DirectorySessionStore-class.html

    r9 r12  
    5252<hr/> 
    5353 
    54 <p>Store sessions in individual files within a directory.</p> 
     54<pre class="literalblock"> 
     55Store sessions in individual files within a directory. 
     56</pre> 
    5557<hr/> 
    5658 
     
    111113  <th colspan="2">Class Variable Summary</th></tr> 
    112114<tr><td align="right" valign="top" width="15%"><font size="-1"><code>bool</code></font></td> 
    113 <td><b><a href="session2.store.DirectorySessionStore.DirectorySessionStore-class.html#is_multiprocess_safe"><code>is_multiprocess_safe</code></a></b> = <span title="False"><code>False                             </code> 
     115<td><b><a href="session2.store.DirectorySessionStore.DirectorySessionStore-class.html#is_multiprocess_safe"><code>is_multiprocess_safe</code></a></b> = <span title="True"><code>True                              </code> 
    114116</span></td></tr> 
    115117<tr><td align="right" valign="top" width="15%"><font size="-1"><code>bool</code></font></td> 
     
    134136    <br /><i>(Constructor)</i> 
    135137  </h3> 
    136 <p>__init__ takes a directory name, with an option to create it if 
    137 it's not already there.</p> 
     138<pre class="literalblock"> 
     139__init__ takes a directory name, with an option to create it if 
     140it's not already there. 
     141</pre> 
    138142  <dl><dt></dt><dd> 
    139143  </dd></dl> 
     
    145149          <span class=sig-arg>minutes</span>)</span> 
    146150  </h3> 
    147 <p>Delete all sessions that have not been modified for N minutes.</p> 
    148 <p>This method is never called by the session manager.  It's for 
    149 your application maintenance program; e.g., a daily cron job.</p> 
    150 <dl class="docutils"> 
    151 <dt>DirectorySessionStore.delete_old_sessions returns a tuple:</dt> 
    152 <dd>(n_deleted, n_remaining)</dd> 
    153 </dl> 
     151<pre class="literalblock"> 
     152Delete all sessions that have not been modified for N minutes. 
     153 
     154This method is never called by the session manager.  It's for 
     155your application maintenance program; e.g., a daily cron job. 
     156 
     157DirectorySessionStore.delete_old_sessions returns a tuple: 
     158   (n_deleted, n_remaining) 
     159</pre> 
    154160  <dl><dt></dt><dd> 
    155161    <dl><dt><b>Overrides:</b></dt> 
     
    164170          <span class=sig-arg>session</span>)</span> 
    165171  </h3> 
    166 <p>Delete the session file.</p> 
     172<pre class="literalblock"> 
     173Delete the session file. 
     174</pre> 
    167175  <dl><dt></dt><dd> 
    168176    <dl><dt><b>Overrides:</b></dt> 
     
    178186          <span class=sig-arg>default</span>=<span class=sig-default>None</span>)</span> 
    179187  </h3> 
    180 <p>Load the pickled session from a file.</p> 
     188<pre class="literalblock"> 
     189Load the pickled session from a file. 
     190</pre> 
    181191  <dl><dt></dt><dd> 
    182192    <dl><dt><b>Overrides:</b></dt> 
     
    191201          <span class=sig-arg>session</span>)</span> 
    192202  </h3> 
    193 <p>Pickle the session and save it into a file.</p> 
     203<pre class="literalblock"> 
     204Pickle the session and save it into a file. 
     205</pre> 
    194206  <dl><dt></dt><dd> 
    195207    <dl><dt><b>Overrides:</b></dt> 
     
    218230 
    219231      </dd> 
    220 <span title="False">      <dt><b>Value:</b></dt> 
     232<span title="True">      <dt><b>Value:</b></dt> 
    221233      <dd><table><tr><td> 
    222234<pre class="variable"> 
    223 False                                                                  </pre> 
     235True                                                                   </pre> 
    224236        </td></tr></table></dd> 
    225237</span>    </dl> 
     
    288300<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    289301  <tr> 
    290     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     302    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    291303    <td align="right"><a href="http://epydoc.sourceforge.net" 
    292304                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.store.DurusSessionStore-module.html

    r9 r12  
    4343<h2 class="module">Module session2.store.DurusSessionStore</h2> 
    4444 
    45 <p>Store sessions in a Durus database.</p> 
     45<pre class="literalblock"> 
     46Store sessions in a Durus database. 
     47</pre> 
    4648<hr/> 
    4749 
     
    7577<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    7678  <tr> 
    77     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     79    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    7880    <td align="right"><a href="http://epydoc.sourceforge.net" 
    7981                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.store.DurusSessionStore.DurusSessionStore-class.html

    r9 r12  
    5252<hr/> 
    5353 
    54 <p>A session store for Durus, a simple object database.</p> 
    55 <p>Unlike the dulcinea Durus session store, session objects 
    56 themselves are <em>not</em> subclasses of Persistent; here they 
    57 are managed by DurusSessionStore directly.</p> 
     54<pre class="literalblock"> 
     55A session store for Durus, a simple object database. 
     56 
     57Unlike the dulcinea Durus session store, session objects 
     58themselves are *not* subclasses of Persistent; here they 
     59are managed by DurusSessionStore directly. 
     60</pre> 
    5861<hr/> 
    5962 
     
    6770          <span class=summary-sig-arg>connection</span>)</span></code> 
    6871<br /> 
    69 __init__ takes a Durus <a href="session2.store.DurusSessionStore.DurusSessionStore-class.html#__init__" class="link"><code>connection</code></a> object.</td></tr> 
     72__init__ takes a Durus `connection` object.</td></tr> 
    7073<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td> 
    7174  <td><code><span class="summary-sig"><a href="session2.store.DurusSessionStore.DurusSessionStore-class.html#delete_session" class="summary-sig-name"><code>delete_session</code></a>(<span class=summary-sig-arg>self</span>, 
     
    132135    <br /><i>(Constructor)</i> 
    133136  </h3> 
    134 <p>__init__ takes a Durus <a href="session2.store.DurusSessionStore.DurusSessionStore-class.html#__init__" class="link"><code>connection</code></a> object.</p> 
     137<pre class="literalblock"> 
     138__init__ takes a Durus `connection` object. 
     139</pre> 
    135140  <dl><dt></dt><dd> 
    136141  </dd></dl> 
     
    142147          <span class=sig-arg>session</span>)</span> 
    143148  </h3> 
    144 <p>Delete the given session from the shelf.</p> 
     149<pre class="literalblock"> 
     150Delete the given session from the shelf. 
     151</pre> 
    145152  <dl><dt></dt><dd> 
    146153    <dl><dt><b>Overrides:</b></dt> 
     
    156163          <span class=sig-arg>default</span>=<span class=sig-default>None</span>)</span> 
    157164  </h3> 
    158 <p>Load the session from the shelf.</p> 
     165<pre class="literalblock"> 
     166Load the session from the shelf. 
     167</pre> 
    159168  <dl><dt></dt><dd> 
    160169    <dl><dt><b>Overrides:</b></dt> 
     
    169178          <span class=sig-arg>session</span>)</span> 
    170179  </h3> 
    171 <p>Save the session to the shelf.</p> 
     180<pre class="literalblock"> 
     181Save the session to the shelf. 
     182</pre> 
    172183  <dl><dt></dt><dd> 
    173184    <dl><dt><b>Overrides:</b></dt> 
     
    246257<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    247258  <tr> 
    248     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     259    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    249260    <td align="right"><a href="http://epydoc.sourceforge.net" 
    250261                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.store.MySQLSessionStore-module.html

    r9 r12  
    4343<h2 class="module">Module session2.store.MySQLSessionStore</h2> 
    4444 
    45 <p>Store sessions in a MySQL table.</p> 
    46 <p>Two extra methods are provided, .create_table and .delete_old_sessions. 
     45<pre class="literalblock"> 
     46Store sessions in a MySQL table. 
     47 
     48Two extra methods are provided, .create_table and .delete_old_sessions. 
    4749These are not called by session2 but may be useful in your programs. 
    4850They use a third column of type TIMESTAMP, which MySQL automatically updates 
    49 whenever the row changes.</p> 
    50 <p>This module assumes the table is non-transactional (no commit or rollback). 
     51whenever the row changes. 
     52 
     53This module assumes the table is non-transactional (no commit or rollback). 
    5154That's the most popular type of MySQL table, and you can't rollback a 
    52 non-transactional table or you'll sometimes get an &quot;incomplete rollback error&quot;.</p> 
    53 <p>Use a separate database connection for sessions than for your other SQL code, 
    54 to avoid incompatible code stomping on each other's transactions.</p> 
     55non-transactional table or you'll sometimes get an &quot;incomplete rollback error&quot;. 
     56 
     57Use a separate database connection for sessions than for your other SQL code, 
     58to avoid incompatible code stomping on each other's transactions. 
     59</pre> 
    5560<hr/> 
    5661 
     
    122127<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    123128  <tr> 
    124     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     129    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    125130    <td align="right"><a href="http://epydoc.sourceforge.net" 
    126131                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.store.MySQLSessionStore.MySQLSessionStore-class.html

    r9 r12  
    131131    <br /><i>(Constructor)</i> 
    132132  </h3> 
    133 <p>__init__ takes a MySQLdb connection object, together with an 
    134 optional 'table' argument containing the name of the table to use.</p> 
     133<pre class="literalblock"> 
     134__init__ takes a MySQLdb connection object, together with an 
     135optional 'table' argument containing the name of the table to use. 
     136</pre> 
    135137  <dl><dt></dt><dd> 
    136138  </dd></dl> 
     
    142144          <span class=sig-arg>minutes</span>)</span> 
    143145  </h3> 
    144 <p>Delete all sessions that have not been modified for N minutes.  The 
     146<pre class="literalblock"> 
     147Delete all sessions that have not been modified for N minutes.  The 
    145148default implementation does nothing, meaning the store cannot delete 
    146 old sessions.</p> 
    147 <p>This method is never called by the session manager.  It's for your 
    148 application maintenance program; e.g., a daily cron job.</p> 
     149old sessions. 
     150 
     151This method is never called by the session manager.  It's for your 
     152application maintenance program; e.g., a daily cron job. 
     153</pre> 
    149154  <dl><dt></dt><dd> 
    150155    <dl><dt><b>Overrides:</b></dt> 
     
    160165          <span class=sig-arg>session</span>)</span> 
    161166  </h3> 
    162 <p>Delete the session in the store.</p> 
     167<pre class="literalblock"> 
     168Delete the session in the store. 
     169</pre> 
    163170  <dl><dt></dt><dd> 
    164171    <dl><dt><b>Overrides:</b></dt> 
     
    173180  <h3><span class="sig"><span class="sig-name">iter_sessions</span>(<span class=sig-arg>self</span>)</span> 
    174181  </h3> 
    175 <p>Return an iterable of (id, session) for all sessions in the store.</p> 
    176 <p>This method is never called by the session manager; it's for admin 
    177 applications that want to browse the sessions.</p> 
     182<pre class="literalblock"> 
     183Return an iterable of (id, session) for all sessions in the store. 
     184 
     185This method is never called by the session manager; it's for admin 
     186applications that want to browse the sessions. 
     187</pre> 
    178188  <dl><dt></dt><dd> 
    179189    <dl><dt><b>Overrides:</b></dt> 
     
    190200          <span class=sig-arg>default</span>=<span class=sig-default>None</span>)</span> 
    191201  </h3> 
    192 <p>Return the session if it exists, else return 'default'.</p> 
     202<pre class="literalblock"> 
     203Return the session if it exists, else return 'default'. 
     204</pre> 
    193205  <dl><dt></dt><dd> 
    194206    <dl><dt><b>Overrides:</b></dt> 
     
    204216          <span class=sig-arg>session</span>)</span> 
    205217  </h3> 
    206 <p>Save the session in the store.</p> 
     218<pre class="literalblock"> 
     219Save the session in the store. 
     220</pre> 
    207221  <dl><dt></dt><dd> 
    208222    <dl><dt><b>Overrides:</b></dt> 
     
    217231  <h3><span class="sig"><span class="sig-name">setup</span>(<span class=sig-arg>self</span>)</span> 
    218232  </h3> 
    219 <p>Initialize the session store; e.g., create required database tables. 
     233<pre class="literalblock"> 
     234Initialize the session store; e.g., create required database tables. 
    220235If a previous store exists, overwrite it or raise an error.  The 
    221 default implmenetation does nothing, meaning no setup is necessary.</p> 
    222 <p>This method is never called by the session manager; it's for your 
    223 application setup program.</p> 
     236default implmenetation does nothing, meaning no setup is necessary. 
     237 
     238This method is never called by the session manager; it's for your 
     239application setup program. 
     240</pre> 
    224241  <dl><dt></dt><dd> 
    225242    <dl><dt><b>Overrides:</b></dt> 
     
    319336<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    320337  <tr> 
    321     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     338    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    322339    <td align="right"><a href="http://epydoc.sourceforge.net" 
    323340                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.store.PostgresSessionStore-module.html

    r9 r12  
    4343<h2 class="module">Module session2.store.PostgresSessionStore</h2> 
    4444 
    45 <p>Store sessions in a PostgreSQL table.</p> 
    46 <p>Two extra methods are provided, .create_table and .delete_old_sessions. 
     45<pre class="literalblock"> 
     46Store sessions in a PostgreSQL table. 
     47 
     48Two extra methods are provided, .create_table and .delete_old_sessions. 
    4749These are not called by session2 but may be useful in your programs. 
    4850They use a third column of type TIMESTAMP, which is updated every time 
    49 the row changes.</p> 
    50 <p>This module assumes the connection is in transaction-mode (the default 
     51the row changes. 
     52 
     53This module assumes the connection is in transaction-mode (the default 
    5154for psycopg).  Use a separate database connection for sessions, or 
    52 else your transactions will become confused.</p> 
     55else your transactions will become confused. 
     56</pre> 
    5357<hr/> 
    5458 
     
    120124<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    121125  <tr> 
    122     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     126    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    123127    <td align="right"><a href="http://epydoc.sourceforge.net" 
    124128                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.store.PostgresSessionStore.PostgresSessionStore-class.html

    r9 r12  
    5252<hr/> 
    5353 
    54 <p>Store pickled sessions in an SQL database.</p> 
    55 <p>See the create() function for the table definition.</p> 
    56 <p>This implementation has been tested with psycopg.  It should work 
     54<pre class="literalblock"> 
     55Store pickled sessions in an SQL database. 
     56 
     57See the create() function for the table definition. 
     58 
     59This implementation has been tested with psycopg.  It should work 
    5760with any DB-API module that supports connection.rollback() and 
    58 &quot;%(var)s&quot; substitution style, e.g. psycopg.</p> 
     61&quot;%(var)s&quot; substitution style, e.g. psycopg. 
     62</pre> 
    5963<hr/> 
    6064 
     
    136140    <br /><i>(Constructor)</i> 
    137141  </h3> 
    138 <p>__init__ takes a psycopg connection to a PostgreSQL database, 
    139 together with an optional table name, 'table'.</p> 
     142<pre class="literalblock"> 
     143__init__ takes a psycopg connection to a PostgreSQL database, 
     144together with an optional table name, 'table'. 
     145</pre> 
    140146  <dl><dt></dt><dd> 
    141147  </dd></dl> 
     
    147153          <span class=sig-arg>session</span>)</span> 
    148154  </h3> 
    149 <p>Delete session from the database.</p> 
     155<pre class="literalblock"> 
     156Delete session from the database. 
     157</pre> 
    150158  <dl><dt></dt><dd> 
    151159    <dl><dt><b>Overrides:</b></dt> 
     
    161169          <span class=sig-arg>default</span>=<span class=sig-default>None</span>)</span> 
    162170  </h3> 
    163 <p>Load a pickled session from the database.</p> 
     171<pre class="literalblock"> 
     172Load a pickled session from the database. 
     173</pre> 
    164174  <dl><dt></dt><dd> 
    165175    <dl><dt><b>Overrides:</b></dt> 
     
    174184          <span class=sig-arg>session</span>)</span> 
    175185  </h3> 
    176 <p>Pickle session &amp; save it into the database.</p> 
     186<pre class="literalblock"> 
     187Pickle session &amp; save it into the database. 
     188</pre> 
    177189  <dl><dt></dt><dd> 
    178190    <dl><dt><b>Overrides:</b></dt> 
     
    186198  <h3><span class="sig"><span class="sig-name">setup</span>(<span class=sig-arg>self</span>)</span> 
    187199  </h3> 
    188 <p>Initialize the session store; e.g., create required database tables. 
     200<pre class="literalblock"> 
     201Initialize the session store; e.g., create required database tables. 
    189202If a previous store exists, overwrite it or raise an error.  The 
    190 default implmenetation does nothing, meaning no setup is necessary.</p> 
    191 <p>This method is never called by the session manager; it's for your 
    192 application setup program.</p> 
     203default implmenetation does nothing, meaning no setup is necessary. 
     204 
     205This method is never called by the session manager; it's for your 
     206application setup program. 
     207</pre> 
    193208  <dl><dt></dt><dd> 
    194209    <dl><dt><b>Overrides:</b></dt> 
     
    268283<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    269284  <tr> 
    270     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     285    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    271286    <td align="right"><a href="http://epydoc.sourceforge.net" 
    272287                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.store.SessionStore-module.html

    r9 r12  
    4343<h2 class="module">Module session2.store.SessionStore</h2> 
    4444 
    45 <p>Base class for persistent session stores.</p> 
     45<pre class="literalblock"> 
     46Base class for persistent session stores. 
     47</pre> 
    4648<hr/> 
    4749 
     
    5254<tr><td width="15%"> 
    5355  <b><a href="session2.store.SessionStore.SessionStore-class.html"><code>SessionStore</code></a></b></td> 
    54   <td>Persistent <a href="session2.Session-module.html" class="link"><code>Session</code></a> storage API for session2's <a href="session2.SessionManager-module.html" class="link"><code>SessionManager</code></a>.</td></tr> 
     56  <td>Persistent `Session` storage API for session2's `SessionManager`.</td></tr> 
    5557</table><br /> 
    5658 
     
    7577<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    7678  <tr> 
    77     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     79    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    7880    <td align="right"><a href="http://epydoc.sourceforge.net" 
    7981                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.store.SessionStore.SessionStore-class.html

    r9 r12  
    4848    <a href="session2.store.DirectorySessionStore.DirectorySessionStore-class.html"><code>DirectorySessionStore</code></a>, 
    4949    <a href="session2.store.DurusSessionStore.DurusSessionStore-class.html"><code>DurusSessionStore</code></a>, 
     50    <a href="session2.store.MemorySessionStore.MemorySessionStore-class.html"><code>MemorySessionStore</code></a>, 
    5051    <a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html"><code>MySQLSessionStore</code></a>, 
    5152    <a href="session2.store.PostgresSessionStore.PostgresSessionStore-class.html"><code>PostgresSessionStore</code></a>, 
    52     <a href="session2.store.ShelveSessionStore.ShelveSessionStore-class.html"><code>ShelveSessionStore</code></a>, 
    53     <a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html"><code>VolatileSessionStore</code></a></dd></dl> 
     53    <a href="session2.store.ShelveSessionStore.ShelveSessionStore-class.html"><code>ShelveSessionStore</code></a></dd></dl> 
    5454 
    5555<hr/> 
    5656 
    57 <p>Persistent <a href="session2.Session-module.html" class="link"><code>Session</code></a> storage API for session2's <a href="session2.SessionManager-module.html" class="link"><code>SessionManager</code></a>.</p> 
    58 <p>Subclass this class &amp; provide implementations of <a href="session2.store.SessionStore.SessionStore-class.html#load_session" class="link"><code>load_session</code></a>, 
    59 <a href="session2.store.SessionStore.SessionStore-class.html#save_session" class="link"><code>save_session</code></a>, and <a href="session2.store.SessionStore.SessionStore-class.html#delete_session" class="link"><code>delete_session</code></a>, and voila, persistent sessions!</p> 
     57<pre class="literalblock"> 
     58Persistent `Session` storage API for session2's `SessionManager`. 
     59 
     60Subclass this class &amp; provide implementations of `load_session`, 
     61`save_session`, and `delete_session`, and voila, persistent sessions! 
     62</pre> 
    6063<hr/> 
    6164 
     
    126129          <span class=sig-arg>minutes</span>)</span> 
    127130  </h3> 
    128 <p>Delete all sessions that have not been modified for N minutes.  The 
     131<pre class="literalblock"> 
     132Delete all sessions that have not been modified for N minutes.  The 
    129133default implementation does nothing, meaning the store cannot delete 
    130 old sessions.</p> 
    131 <p>This method is never called by the session manager.  It's for your 
    132 application maintenance program; e.g., a daily cron job.</p> 
     134old sessions. 
     135 
     136This method is never called by the session manager.  It's for your 
     137application maintenance program; e.g., a daily cron job. 
     138</pre> 
    133139  <dl><dt></dt><dd> 
    134140  </dd></dl> 
     
    140146          <span class=sig-arg>session</span>)</span> 
    141147  </h3> 
    142 <p>Delete the session in the store.</p> 
     148<pre class="literalblock"> 
     149Delete the session in the store. 
     150</pre> 
    143151  <dl><dt></dt><dd> 
    144152  </dd></dl> 
     
    150158          <span class=sig-arg>id</span>)</span> 
    151159  </h3> 
    152 <p>Return true if the session exists in the store, else false.</p> 
     160<pre class="literalblock"> 
     161Return true if the session exists in the store, else false. 
     162</pre> 
    153163  <dl><dt></dt><dd> 
    154164  </dd></dl> 
     
    159169  <h3><span class="sig"><span class="sig-name">iter_sessions</span>(<span class=sig-arg>self</span>)</span> 
    160170  </h3> 
    161 <p>Return an iterable of (id, session) for all sessions in the store.</p> 
    162 <p>This method is never called by the session manager; it's for admin 
    163 applications that want to browse the sessions.</p> 
     171<pre class="literalblock"> 
     172Return an iterable of (id, session) for all sessions in the store. 
     173 
     174This method is never called by the session manager; it's for admin 
     175applications that want to browse the sessions. 
     176</pre> 
    164177  <dl><dt></dt><dd> 
    165178  </dd></dl> 
     
    172185          <span class=sig-arg>default</span>=<span class=sig-default>None</span>)</span> 
    173186  </h3> 
    174 <p>Return the session if it exists, else return 'default'.</p> 
     187<pre class="literalblock"> 
     188Return the session if it exists, else return 'default'. 
     189</pre> 
    175190  <dl><dt></dt><dd> 
    176191  </dd></dl> 
     
    182197          <span class=sig-arg>session</span>)</span> 
    183198  </h3> 
    184 <p>Save the session in the store.</p> 
     199<pre class="literalblock"> 
     200Save the session in the store. 
     201</pre> 
    185202  <dl><dt></dt><dd> 
    186203  </dd></dl> 
     
    191208  <h3><span class="sig"><span class="sig-name">setup</span>(<span class=sig-arg>self</span>)</span> 
    192209  </h3> 
    193 <p>Initialize the session store; e.g., create required database tables. 
     210<pre class="literalblock"> 
     211Initialize the session store; e.g., create required database tables. 
    194212If a previous store exists, overwrite it or raise an error.  The 
    195 default implmenetation does nothing, meaning no setup is necessary.</p> 
    196 <p>This method is never called by the session manager; it's for your 
    197 application setup program.</p> 
     213default implmenetation does nothing, meaning no setup is necessary. 
     214 
     215This method is never called by the session manager; it's for your 
     216application setup program. 
     217</pre> 
    198218  <dl><dt></dt><dd> 
    199219  </dd></dl> 
     
    269289<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    270290  <tr> 
    271     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     291    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    272292    <td align="right"><a href="http://epydoc.sourceforge.net" 
    273293                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.store.ShelveSessionStore-module.html

    r9 r12  
    4343<h2 class="module">Module session2.store.ShelveSessionStore</h2> 
    4444 
    45 <p>Store sessions in a 'shelve' database.</p> 
     45<pre class="literalblock"> 
     46Store sessions in a 'shelve' database. 
     47</pre> 
    4648<hr/> 
    4749 
     
    7678<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    7779  <tr> 
    78     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     80    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    7981    <td align="right"><a href="http://epydoc.sourceforge.net" 
    8082                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/session2.store.ShelveSessionStore.ShelveSessionStore-class.html

    r9 r12  
    5252<hr/> 
    5353 
    54 <p>Open a 'shelve' dictionary with the given filename, and store sessions 
    55 in it.</p> 
    56 <p>Shelve is not thread safe or multiprocess safe.  See the &quot;Restrictions&quot; 
     54<pre class="literalblock"> 
     55Open a 'shelve' dictionary with the given filename, and store sessions 
     56in it. 
     57 
     58Shelve is not thread safe or multiprocess safe.  See the &quot;Restrictions&quot; 
    5759section for the shelve module in the Python Library Reference for  
    58 information about file locking.</p> 
     60information about file locking. 
     61</pre> 
    5962<hr/> 
    6063 
     
    137140    <br /><i>(Constructor)</i> 
    138141  </h3> 
    139 <p>__init__ takes the filename to use as the shelve store.</p> 
     142<pre class="literalblock"> 
     143__init__ takes the filename to use as the shelve store. 
     144</pre> 
    140145  <dl><dt></dt><dd> 
    141146  </dd></dl> 
     
    147152          <span class=sig-arg>session</span>)</span> 
    148153  </h3> 
    149 <p>Delete the given session from the shelf.</p> 
     154<pre class="literalblock"> 
     155Delete the given session from the shelf. 
     156</pre> 
    150157  <dl><dt></dt><dd> 
    151158    <dl><dt><b>Overrides:</b></dt> 
     
    161168          <span class=sig-arg>default</span>=<span class=sig-default>None</span>)</span> 
    162169  </h3> 
    163 <p>Load the session from the shelf.</p> 
     170<pre class="literalblock"> 
     171Load the session from the shelf. 
     172</pre> 
    164173  <dl><dt></dt><dd> 
    165174    <dl><dt><b>Overrides:</b></dt> 
     
    173182  <h3><span class="sig"><span class="sig-name">open</span>(<span class=sig-arg>self</span>)</span> 
    174183  </h3> 
    175 <p>Open the shelve store file.</p> 
     184<pre class="literalblock"> 
     185Open the shelve store file. 
     186</pre> 
    176187  <dl><dt></dt><dd> 
    177188  </dd></dl> 
     
    183194          <span class=sig-arg>session</span>)</span> 
    184195  </h3> 
    185 <p>Save the session to the shelf.</p> 
     196<pre class="literalblock"> 
     197Save the session to the shelf. 
     198</pre> 
    186199  <dl><dt></dt><dd> 
    187200    <dl><dt><b>Overrides:</b></dt> 
     
    260273<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    261274  <tr> 
    262     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     275    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    263276    <td align="right"><a href="http://epydoc.sourceforge.net" 
    264277                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/epydoc-html/toc-everything.html

    r9 r12  
    1919<a target="mainFrame" href="session2.store.DirectorySessionStore.DirectorySessionStore-class.html">session2.store.DirectorySessionStore.DirectorySessionStore</a><br /> 
    2020<a target="mainFrame" href="session2.store.DurusSessionStore.DurusSessionStore-class.html">session2.store.DurusSessionStore.DurusSessionStore</a><br /> 
     21<a target="mainFrame" href="session2.store.MemorySessionStore.MemorySessionStore-class.html">session2.store.MemorySessionStore.MemorySessionStore</a><br /> 
    2122<a target="mainFrame" href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html">session2.store.MySQLSessionStore.MySQLSessionStore</a><br /> 
    2223<a target="mainFrame" href="session2.store.PostgresSessionStore.PostgresSessionStore-class.html">session2.store.PostgresSessionStore.PostgresSessionStore</a><br /> 
    2324<a target="mainFrame" href="session2.store.SessionStore.SessionStore-class.html">session2.store.SessionStore.SessionStore</a><br /> 
    2425<a target="mainFrame" href="session2.store.ShelveSessionStore.ShelveSessionStore-class.html">session2.store.ShelveSessionStore.ShelveSessionStore</a><br /> 
    25 <a target="mainFrame" href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html">session2.store.VolatileSessionStore.VolatileSessionStore</a><br /> 
    2626<br /> 
    2727 
     
    2929<font size="+1"><b>All&nbsp;Variables</b></font><br /> 
    3030<a target="mainFrame" href="session2-module.html#__version__">__version__</a><br /> 
     31<a target="mainFrame" href="session2.store.MySQLSessionStore-module.html#DEFAULT_TABLE">DEFAULT_TABLE</a><br /> 
    3132<a target="mainFrame" href="session2.store.PostgresSessionStore-module.html#DEFAULT_TABLE">DEFAULT_TABLE</a><br /> 
    32 <a target="mainFrame" href="session2.store.MySQLSessionStore-module.html#DEFAULT_TABLE">DEFAULT_TABLE</a><br /> 
    3333<br /> 
    3434 
  • software/session2/trunk/epydoc-html/toc-session2.store-module.html

    r9 r12  
    1616<a target="mainFrame" href="session2.store.DirectorySessionStore-module.html">DirectorySessionStore</a><br /> 
    1717<a target="mainFrame" href="session2.store.DurusSessionStore-module.html">DurusSessionStore</a><br /> 
     18<a target="mainFrame" href="session2.store.MemorySessionStore-module.html">MemorySessionStore</a><br /> 
    1819<a target="mainFrame" href="session2.store.MySQLSessionStore-module.html">MySQLSessionStore</a><br /> 
    1920<a target="mainFrame" href="session2.store.PostgresSessionStore-module.html">PostgresSessionStore</a><br /> 
    2021<a target="mainFrame" href="session2.store.SessionStore-module.html">SessionStore</a><br /> 
    2122<a target="mainFrame" href="session2.store.ShelveSessionStore-module.html">ShelveSessionStore</a><br /> 
    22 <a target="mainFrame" href="session2.store.VolatileSessionStore-module.html">VolatileSessionStore</a><br /> 
    2323<br /> 
    2424 
  • software/session2/trunk/epydoc-html/toc.html

    r9 r12  
    2525<a target="moduleFrame" href="toc-session2.store.DirectorySessionStore-module.html">session2.store.DirectorySessionStore</a><br /> 
    2626<a target="moduleFrame" href="toc-session2.store.DurusSessionStore-module.html">session2.store.DurusSessionStore</a><br /> 
     27<a target="moduleFrame" href="toc-session2.store.MemorySessionStore-module.html">session2.store.MemorySessionStore</a><br /> 
    2728<a target="moduleFrame" href="toc-session2.store.MySQLSessionStore-module.html">session2.store.MySQLSessionStore</a><br /> 
    2829<a target="moduleFrame" href="toc-session2.store.PostgresSessionStore-module.html">session2.store.PostgresSessionStore</a><br /> 
    2930<a target="moduleFrame" href="toc-session2.store.SessionStore-module.html">session2.store.SessionStore</a><br /> 
    3031<a target="moduleFrame" href="toc-session2.store.ShelveSessionStore-module.html">session2.store.ShelveSessionStore</a><br /> 
    31 <a target="moduleFrame" href="toc-session2.store.VolatileSessionStore-module.html">session2.store.VolatileSessionStore</a><br /> 
    3232 
    3333</body> 
  • software/session2/trunk/epydoc-html/trees.html

    r9 r12  
    4444    <li> <b><a href="session2.Session-module.html"><code>Session</code></a></b>: <i>Session storage class for Quixote 2.x.</i> 
    4545    <li> <b><a href="session2.SessionManager-module.html"><code>SessionManager</code></a></b>: <i>A persistent session manager class for Quixote 2.x.</i> 
    46     <li> <b><a href="session2.store-module.html"><code>store</code></a></b>: <i>Persistent session stores for <a href="session2.SessionManager-module.html" class="link"><code>session2.SessionManager</code></a>.</i> 
     46    <li> <b><a href="session2.store-module.html"><code>store</code></a></b>: <i>Persistent session stores for `session2.SessionManager`.</i> 
    4747      <ul> 
    4848        <li> <b><a href="session2.store.DirectorySessionStore-module.html"><code>DirectorySessionStore</code></a></b>: <i>Store sessions in individual files within a directory.</i> 
    4949        <li> <b><a href="session2.store.DurusSessionStore-module.html"><code>DurusSessionStore</code></a></b>: <i>Store sessions in a Durus database.</i> 
     50        <li> <b><a href="session2.store.MemorySessionStore-module.html"><code>MemorySessionStore</code></a></b> 
    5051        <li> <b><a href="session2.store.MySQLSessionStore-module.html"><code>MySQLSessionStore</code></a></b>: <i>Store sessions in a MySQL table.</i> 
    5152        <li> <b><a href="session2.store.PostgresSessionStore-module.html"><code>PostgresSessionStore</code></a></b>: <i>Store sessions in a PostgreSQL table.</i> 
    5253        <li> <b><a href="session2.store.SessionStore-module.html"><code>SessionStore</code></a></b>: <i>Base class for persistent session stores.</i> 
    5354        <li> <b><a href="session2.store.ShelveSessionStore-module.html"><code>ShelveSessionStore</code></a></b>: <i>Store sessions in a 'shelve' database.</i> 
    54         <li> <b><a href="session2.store.VolatileSessionStore-module.html"><code>VolatileSessionStore</code></a></b>: <i>A simple in-memory volatile session store, mimicking the default 
    55 Quixote session management.</i> 
    5655      </ul> 
    5756  </ul> 
     
    7574A persistent session manager for Quixote.</i> 
    7675  <li> <b><a href="session2.store.SessionStore.SessionStore-class.html"><code>session2.store.SessionStore.SessionStore</code></a></b>: <i> 
    77 Persistent <a href="session2.Session-module.html" class="link"><code>Session</code></a> storage API for session2's <a href="session2.SessionManager-module.html" class="link"><code>SessionManager</code></a>.</i> 
     76Persistent `Session` storage API for session2's `SessionManager`.</i> 
    7877    <ul> 
    7978  <li> <b><a href="session2.store.DirectorySessionStore.DirectorySessionStore-class.html"><code>session2.store.DirectorySessionStore.DirectorySessionStore</code></a></b>: <i> 
     
    8180  <li> <b><a href="session2.store.DurusSessionStore.DurusSessionStore-class.html"><code>session2.store.DurusSessionStore.DurusSessionStore</code></a></b>: <i> 
    8281A session store for Durus, a simple object database.</i> 
     82  <li> <b><a href="session2.store.MemorySessionStore.MemorySessionStore-class.html"><code>session2.store.MemorySessionStore.MemorySessionStore</code></a></b>: <i> 
     83Non-persistent memory session storage, useful only for debugging.</i> 
    8384  <li> <b><a href="session2.store.MySQLSessionStore.MySQLSessionStore-class.html"><code>session2.store.MySQLSessionStore.MySQLSessionStore</code></a></b> 
    8485  <li> <b><a href="session2.store.PostgresSessionStore.PostgresSessionStore-class.html"><code>session2.store.PostgresSessionStore.PostgresSessionStore</code></a></b>: <i> 
     
    8788Open a 'shelve' dictionary with the given filename, and store sessions 
    8889in it.</i> 
    89   <li> <b><a href="session2.store.VolatileSessionStore.VolatileSessionStore-class.html"><code>session2.store.VolatileSessionStore.VolatileSessionStore</code></a></b>: <i> 
    90 A simple volatile (non-persistent) session store for session2.</i> 
    9190    </ul> 
    9291</ul> 
     
    111110<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    112111  <tr> 
    113     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Feb  4 16:40:10 2006</font></td> 
     112    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Oct 15 21:33:50 2006</font></td> 
    114113    <td align="right"><a href="http://epydoc.sourceforge.net" 
    115114                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
  • software/session2/trunk/test/test.py

    r9 r12  
    1919    Test basic session handling with the volatile session handler. 
    2020    """ 
    21     utils.setup_wsgi_intercept(test_session2.use_volatile
     21    utils.setup_wsgi_intercept(test_session2.use_memory
    2222 
    2323    try: 
  • software/session2/trunk/test/test_session2.py

    r9 r12  
    3838########################################## 
    3939 
    40 def use_volatile(): 
    41     from session2.store.VolatileSessionStore import VolatileSessionStore 
    42     store = VolatileSessionStore() 
     40def use_memory(): 
     41    from session2.store.MemorySessionStore import MemorySessionStore 
     42    store = MemorySessionStore() 
    4343    return create_publisher(store) 
    4444