All Documents

• session4
  index.html
  Package
  Package
  PUBLIC
  No package docstring; 2/2 modules, 0/1 package documented
• session4.DirectorySessionStore
  session4.DirectorySessionStore.html
  Module
  Module
  PUBLIC
  Store sessions in individual files within a directory.
• session4.Session4Session
  session4.Session4Session.html
  Module
  Module
  PUBLIC
  This extends Quixote's session class to have auto-detection of added or changed members or values, including lists, etc.
• session4.modified_quix_demo
  session4.modified_quix_demo.html
  Package
  Package
  PUBLIC
  No package docstring; 0/1 function, 2/2 modules documented
• session4.modified_quix_demo.altdemo
  session4.modified_quix_demo.altdemo.html
  Module
  Module
  PUBLIC
  An alternative Quixote demo. This version is contained in a single module and does not use PTL. The easiest way to run this demo is to use the simple HTTP server included with Quixote. For example:
• session4.modified_quix_demo.mini_demo
  session4.modified_quix_demo.mini_demo.html
  Module
  Module
  PUBLIC
  A minimal Quixote demo. If you have the 'quixote' package in your Python path, you can run it like this:
• session4.Session4Session.Session4SessionManager
  session4.Session4Session.Session4SessionManager.html
  Class
  Class
  PUBLIC
  We sub-class the base version because that is missing __getitem__() and has_session() unfortunately. In future these might be added to Quixote's BaseSessionManager. See https://github.com/nascheme/quixote/issues/8...
• session4.Session4Session.Session4SessionManager.__getitem__
  session4.Session4Session.Session4SessionManager.html#__getitem__
  Function
  Method
  PUBLIC
  Undocumented
• session4.Session4Session.Session4SessionManager.has_session
  session4.Session4Session.Session4SessionManager.html#has_session
  Function
  Method
  PUBLIC
  Undocumented
• session4.Session4Session.Session4
  session4.Session4Session.Session4.html
  Class
  Class
  PUBLIC
  This adapts Quixote's own Session class to overwrite is_dirty() so that the session instance automatically detects changes to its values or additions or removals of members.
• session4.Session4Session.Session4.MAX_FORM_TOKENS
  session4.Session4Session.Session4.html#MAX_FORM_TOKENS
  Attribute
  Constant
  PUBLIC
  Undocumented
• session4.Session4Session.Session4._last_values
  session4.Session4Session.Session4.html#_last_values
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• session4.Session4Session.Session4.__init__
  session4.Session4Session.Session4.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• session4.Session4Session.Session4.preserve_current_values
  session4.Session4Session.Session4.html#preserve_current_values
  Function
  Method
  PUBLIC
  Undocumented
• session4.Session4Session.Session4.is_dirty
  session4.Session4Session.Session4.html#is_dirty
  Function
  Method
  PUBLIC
  Undocumented
• session4.DirectorySessionStore.DirectorySessionStore
  session4.DirectorySessionStore.DirectorySessionStore.html
  Class
  Class
  PUBLIC
  Store sessions in individual files within a directory. The noqa in the definitions are because 'id' is a Python keyword (blame Quixote, not me!)
• session4.DirectorySessionStore.DirectorySessionStore.is_multiprocess_safe
  session4.DirectorySessionStore.DirectorySessionStore.html#is_multiprocess_safe
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• session4.DirectorySessionStore.DirectorySessionStore.is_thread_safe
  session4.DirectorySessionStore.DirectorySessionStore.html#is_thread_safe
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• session4.DirectorySessionStore.DirectorySessionStore.SLEEPY_TIME
  session4.DirectorySessionStore.DirectorySessionStore.html#SLEEPY_TIME
  Attribute
  Constant
  PUBLIC
  Undocumented
• session4.DirectorySessionStore.DirectorySessionStore.load_session
  session4.DirectorySessionStore.DirectorySessionStore.html#load_session
  Function
  Method
  PUBLIC
  Load the pickled session from a file if it exists, otherwise return None
• session4.DirectorySessionStore.DirectorySessionStore.save_session
  session4.DirectorySessionStore.DirectorySessionStore.html#save_session
  Function
  Method
  PUBLIC
  Pickle the session and save it into a file.
• session4.DirectorySessionStore.DirectorySessionStore.delete_session
  session4.DirectorySessionStore.DirectorySessionStore.html#delete_session
  Function
  Method
  PUBLIC
  Delete the session file.
• session4.DirectorySessionStore.DirectorySessionStore.has_session
  session4.DirectorySessionStore.DirectorySessionStore.html#has_session
  Function
  Method
  PUBLIC
  Return true if the session exists in the store, else false.
• session4.DirectorySessionStore.DirectorySessionStore.__iter__
  session4.DirectorySessionStore.DirectorySessionStore.html#__iter__
  Function
  Method
  PUBLIC
  Return an iterator of all session IDs in the storage. In our case, the session id is just the file-name
• session4.DirectorySessionStore.DirectorySessionStore.transaction_start
  session4.DirectorySessionStore.DirectorySessionStore.html#transaction_start
  Function
  Method
  PUBLIC
  Called near the beginning of each request: after the HTTPRequest object has been built, but before we traverse the URL or call the callable object found by URL traversal.
• session4.DirectorySessionStore.DirectorySessionStore.transaction_commit
  session4.DirectorySessionStore.DirectorySessionStore.html#transaction_commit
  Function
  Method
  PUBLIC
  Called near the end of each successful request. Not called if there were any errors processing the request.
• session4.DirectorySessionStore.DirectorySessionStore.transaction_abort
  session4.DirectorySessionStore.DirectorySessionStore.html#transaction_abort
  Function
  Method
  PUBLIC
  Called near the end of a failed request (i.e. a exception that was not a PublisherError was raised.
• session4.DirectorySessionStore.DirectorySessionStore.__init__
  session4.DirectorySessionStore.DirectorySessionStore.html#__init__
  Function
  Method
  PUBLIC
  `__init__` takes a directory name, with an option to create it if it's not already there.
• session4.DirectorySessionStore.DirectorySessionStore.directory
  session4.DirectorySessionStore.DirectorySessionStore.html#directory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• session4.DirectorySessionStore.DirectorySessionStore._make_filename
  session4.DirectorySessionStore.DirectorySessionStore.html#_make_filename
  Function
  Method
  PRIVATE
  Build the filename from the session ID.
• session4.DirectorySessionStore.DirectorySessionStore.delete_old_sessions
  session4.DirectorySessionStore.DirectorySessionStore.html#delete_old_sessions
  Function
  Method
  PUBLIC
  Delete all sessions that have not been modified for N minutes.
• session4.DirectorySessionStore.DirectorySessionStore.setup
  session4.DirectorySessionStore.DirectorySessionStore.html#setup
  Function
  Method
  PUBLIC
  Nothing to do here: but a directory could be created, etc.
• session4.modified_quix_demo.create_publisher
  session4.modified_quix_demo.html#create_publisher
  Function
  Function
  PUBLIC
  Undocumented
• session4.modified_quix_demo.altdemo.SESSIONS_DIRECTORY
  session4.modified_quix_demo.altdemo.html#SESSIONS_DIRECTORY
  Attribute
  Constant
  PUBLIC
  Undocumented
• session4.modified_quix_demo.altdemo.format_page
  session4.modified_quix_demo.altdemo.html#format_page
  Function
  Function
  PUBLIC
  Undocumented
• session4.modified_quix_demo.altdemo.format_request
  session4.modified_quix_demo.altdemo.html#format_request
  Function
  Function
  PUBLIC
  Undocumented
• session4.modified_quix_demo.altdemo.format_link_list
  session4.modified_quix_demo.altdemo.html#format_link_list
  Function
  Function
  PUBLIC
  Undocumented
• session4.modified_quix_demo.altdemo.RootDirectory
  session4.modified_quix_demo.altdemo.RootDirectory.html
  Class
  Class
  PUBLIC
  Undocumented
• session4.modified_quix_demo.altdemo.RootDirectory._q_exports
  session4.modified_quix_demo.altdemo.RootDirectory.html#_q_exports
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• session4.modified_quix_demo.altdemo.RootDirectory._q_index
  session4.modified_quix_demo.altdemo.RootDirectory.html#_q_index
  Function
  Method
  PRIVATE
  Undocumented
• session4.modified_quix_demo.altdemo.RootDirectory.login
  session4.modified_quix_demo.altdemo.RootDirectory.html#login
  Function
  Method
  PUBLIC
  Undocumented
• session4.modified_quix_demo.altdemo.RootDirectory.logout
  session4.modified_quix_demo.altdemo.RootDirectory.html#logout
  Function
  Method
  PUBLIC
  Undocumented
• session4.modified_quix_demo.altdemo.DemoSession
  session4.modified_quix_demo.altdemo.DemoSession.html
  Class
  Class
  PUBLIC
  No class docstring; 0/1 instance variable, 1/2 method documented
• session4.modified_quix_demo.altdemo.DemoSession.num_requests
  session4.modified_quix_demo.altdemo.DemoSession.html#num_requests
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• session4.modified_quix_demo.altdemo.DemoSession.__init__
  session4.modified_quix_demo.altdemo.DemoSession.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• session4.modified_quix_demo.altdemo.DemoSession.start_request
  session4.modified_quix_demo.altdemo.DemoSession.html#start_request
  Function
  Method
  PUBLIC
  This is called from the main object publishing loop whenever we start processing a new request. Obviously, this is a good place to track the number of requests made. (If we were interested in the number of *successful* requests made, then we could override finish_request(), which is called by the publisher at the end of each successful request...
• session4.modified_quix_demo.altdemo.create_publisher
  session4.modified_quix_demo.altdemo.html#create_publisher
  Function
  Function
  PUBLIC
  Undocumented
• session4.modified_quix_demo.mini_demo.RootDirectory
  session4.modified_quix_demo.mini_demo.RootDirectory.html
  Class
  Class
  PUBLIC
  Undocumented
• session4.modified_quix_demo.mini_demo.RootDirectory.index
  session4.modified_quix_demo.mini_demo.RootDirectory.html#index
  Function
  Method
  PUBLIC
  Undocumented
• session4.modified_quix_demo.mini_demo.RootDirectory.hello
  session4.modified_quix_demo.mini_demo.RootDirectory.html#hello
  Function
  Method
  PUBLIC
  Undocumented
• session4.modified_quix_demo.mini_demo.create_publisher
  session4.modified_quix_demo.mini_demo.html#create_publisher
  Function
  Function
  PUBLIC
  Undocumented