Module Hierarchy

• aquarium: Welcome to Aquarium!
  • conf: Setup the package search path.
    • AquariumProperties: Document the API for AquariumProperties.
  • database: Setup the package search path.
    • DatabaseAssistant: This class abstracts and assists in database connectivity.
    • mysql: Setup the package search path.
      • Session: This is a MySQL backend for aquarium.session.DatabaseSessionContainer.
    • QuickSwitchDatabaseAssistant: Permit RDBM toggling.
  • filter: Setup the package search path.
    • FilterAPI: Document the API for filter classes.
    • Tidy: Filter the output by running it through HTML Tidy.
  • History: Document the history and influences of Aquarium.
  • layout: Setup the package search path.
    • LayoutAPI: Document the API for layout classes.
  • navigation: Setup the package search path.
    • NavigationAPI: Document the API for navigation classes.
  • PackagePath: Document the package search path.
  • parse: Setup the package search path.
    • AcceptLanguage: Parse the Accept-Language header.
    • Authorization: Parse the Authorization header.
    • Host: Parse the Host header.
    • IfModifiedSince: Parse the If-Modified-Since header.
    • ParseAPI: Document the API for parse modules.
  • screen: Setup the package search path.
    • Controller: This is a mostly empty superclass for controllers.
    • ScreenAPI: Document the API for screen classes.
    • Wizard
    • wizard_review
    • WizardStep
  • session: Setup the package search path.
    • DatabaseSessionContainer: This is a session module which uses a database backend.
    • SessionContainer: This module contains the base classes SessionContainer and Session.
  • Style: Comment on style.
  • urlscheme: Setup the package search path.
    • decorator: Setup the package search path.
      • Backwards: This is an example urlscheme decorator.
      • UrlSchemeDecorator: Subclasses of this class decorate (i.e.
    • EscapingAmpersands: How to escape &'s in URLs.
    • PathInfo: This URL scheme is based on PATH_INFO.
    • QueryParameters: This URL scheme is based on query parameters.
    • RelativeScriptName: Like aquarium.urlscheme.ScriptName, but without the server name.
    • ScriptName: This URL scheme is based on SCRIPT_NAME.
    • UrlSchemeAPI: Document the API for url scheme classes.
  • util: Setup the package search path.
    • ActionResults: Use this if you want more than just a string for actionResults.
    • Aquarium: This class encapsulates the main flow of control for Aquarium.
    • AquariumClass: This is the base class for most Aquarium classes.
    • AquariumTemplate: This is the base class for Cheetah templates used with Aquarium.
    • AutoLoader: This mixin supports autoloading.
    • ContainerClass: This is a trivial class that acts like a container.
    • Context: Each request will have a new context.
    • Curry: This class is a curry (think functional programming).
    • FormDict: Translate a cgi.FieldStorage into a (possibly recursive) dict.
    • FormValid: This module contains classes to help validate user input.
    • HasFriends: This mixin supports autoloading of "friend" methods.
    • HTTPResponses: Create constants for the HTTP responses.
    • InternalLibrary: This is the "standard library" for Aquarium's structure.
    • Ports: These are the standard ports for HTTP and HTTPS, etc.
    • ProtectUTF8: Temporarily convert a UTF-8 string to Unicode to prevent breakage.
    • TryFinally: This is a convenient way to deeply nest try/finally statements.
  • widget: Setup the package search path.
    • FormUtil: This module contains the FormUtil class.
    • formutil: Setup the package search path.
    • ThousandsCommas: Add commas to a number.
    • WidgetAPI: Document the API for widget classes.
  • wsadaptor: Setup the package search path.
    • CGIAdaptor: This subclass of WebServerAdaptor is for CGI environments.
    • FastCGIAdaptor: This subclass of WebServerAdaptor is for FastCGI.
    • GlassAdaptor: This subclass of WebServerAdaptor is for the Glass Web server.
    • ModPythonAdaptor: This subclass of WebServerAdaptor is for mod_python.
    • WebServerAdaptor: This is the base class for wsadaptor classes.
    • WSGIAdaptor: This is a WSGI adaptor for Aquarium.

Class Hierarchy

• Cheetah.Servlet.BaseServlet
  • Cheetah.Servlet.Servlet: This class is an abstract baseclass for Cheetah.Template.Template.
    • Cheetah.Template.Template: The core template engine.
      • aquarium.util.AquariumTemplate.AquariumTemplate: This is the base class for Cheetah templates used with Aquarium.
• Cheetah.SettingsManager._SettingsCollector: An abstract base class that provides the methods SettingsManager uses to collect settings from config files and SettingsContainers.
  • Cheetah.SettingsManager.SettingsManager: A mixin class that provides facilities for managing application settings.
    • Cheetah.Template.Template: The core template engine.
      • aquarium.util.AquariumTemplate.AquariumTemplate: This is the base class for Cheetah templates used with Aquarium.
• Cheetah.Utils.WebInputMixin.WebInputMixin: A mixin class for Cheetah.Template with a method for importing web transaction variables in bulk.
  • Cheetah.Template.Template: The core template engine.
    • aquarium.util.AquariumTemplate.AquariumTemplate: This is the base class for Cheetah templates used with Aquarium.
• ConfigParser.RawConfigParser
  • ConfigParser.ConfigParser
    • Cheetah.SettingsManager.ConfigParserCaseSensitive: A case sensitive version of the standard Python ConfigParser.
• __builtin__.object: The most base type...
  • __builtin__.dict: dict() -> new empty dictionary.
    • aquarium.util.FormDict.FormDict: Translate a cgi.FieldStorage into a (possibly recursive) dict.
    • aquarium.session.SessionContainer.Session: This is a dict-like object for session management.
      • aquarium.session.DatabaseSessionContainer.DatabaseSession: This is the session.
  • __builtin__.type: type(object) -> the object's type...
• aquarium.screen.Wizard.Wizard
• aquarium.screen.WizardStep.WizardStep: Provides convenience methods for wizard steps.
  • aquarium.screen.wizard_review.wizard_review
• aquarium.session.SessionContainer.SessionContainer: This is a container for sessions.
  • aquarium.session.DatabaseSessionContainer.DatabaseSessionContainer: This is the session container.
• aquarium.util.ActionResults.ActionResults: Use this if you want more than just a string for actionResults.
• aquarium.util.Aquarium.Aquarium: This class encapsulates the main flow of control for Aquarium.
• aquarium.util.AquariumClass.AquariumClass: This is the base class for most Aquarium classes.
  • aquarium.util.AquariumTemplate.AquariumTemplate: This is the base class for Cheetah templates used with Aquarium.
  • aquarium.screen.Controller.Controller: This is a mostly empty superclass for controllers.
    • aquarium.screen.wizard_review.wizard_review
  • aquarium.database.DatabaseAssistant.DatabaseAssistant: This class abstracts and assists in database connectivity.
    • aquarium.database.QuickSwitchDatabaseAssistant.QuickSwitchDatabaseAssistant: Permit RDBM toggling.
  • aquarium.session.DatabaseSessionContainer.DatabaseSessionContainer: This is the session container.
  • aquarium.widget.FormUtil.FormUtil: This is a utility to build consistent HTML forms.
  • aquarium.util.InternalLibrary.InternalLibrary: This is the "standard library" for Aquarium's structure.
  • aquarium.urlscheme.QueryParameters.QueryParameters: This URL scheme is based on query parameters.
    • aquarium.urlscheme.PathInfo.PathInfo: This URL scheme is based on PATH_INFO.
    • aquarium.urlscheme.ScriptName.ScriptName: This URL scheme is based on SCRIPT_NAME.
      • aquarium.urlscheme.RelativeScriptName.RelativeScriptName: Like aquarium.urlscheme.ScriptName, but without the server name.
  • aquarium.database.mysql.Session.Session: This is a MySQL backend for aquarium.session.DatabaseSessionContainer.
  • aquarium.widget.ThousandsCommas.ThousandsCommas
  • aquarium.filter.Tidy.Tidy: Filter the output by running it through HTML Tidy.
  • aquarium.urlscheme.decorator.UrlSchemeDecorator.UrlSchemeDecorator: Subclasses of this class decorate (i.e.
    • aquarium.urlscheme.decorator.Backwards.Backwards: This is an example urlscheme decorator.
• aquarium.util.AutoLoader.AutoLoader: This mixin supports autoloading.
  • aquarium.database.DatabaseAssistant.DatabaseAssistant: This class abstracts and assists in database connectivity.
    • aquarium.database.QuickSwitchDatabaseAssistant.QuickSwitchDatabaseAssistant: Permit RDBM toggling.
• aquarium.util.ContainerClass.ContainerClass: This is a trivial class that acts like a container.
  • aquarium.screen.wizard_review.Bean: This bean carries the review strings to the wizard review screen.
• aquarium.util.Context.Context: Each request will have a new context.
• aquarium.util.Context.Request
• aquarium.util.Context.Response
• aquarium.util.Curry.Curry: This class is a curry (think functional programming).
• aquarium.util.FormValid.Field: This class does the majority of the work.
• aquarium.util.FormValid.FieldGroup: This class allows you to group fields together and do validation based on the results of the validation of those fields
• aquarium.util.FormValid.Form: This class uses the member variable "constraints" as a list to store elements of type class Field.
• aquarium.util.HasFriends.HasFriends: This mixin supports autoloading of "friend" methods.
  • aquarium.widget.FormUtil.FormUtil: This is a utility to build consistent HTML forms.
• aquarium.util.InternalLibrary._DescendClassHierarchyImpl: Implement the inverseExtend method.
• aquarium.wsadaptor.WebServerAdaptor.WebServerAdaptor: This is the base class for wsadaptor classes.
  • aquarium.wsadaptor.CGIAdaptor.CGIAdaptor: This subclass of WebServerAdaptor is for CGI environments.
  • aquarium.wsadaptor.FastCGIAdaptor.FastCGIAdaptor: This subclass of WebServerAdaptor is for FastCGI.
  • aquarium.wsadaptor.GlassAdaptor.GlassAdaptor: This subclass of WebServerAdaptor is for the Glass Web server.
  • aquarium.wsadaptor.ModPythonAdaptor.ModPythonAdaptor: This subclass of WebServerAdaptor is for mod_python.
  • aquarium.wsadaptor.WSGIAdaptor.WSGIAdaptor: This is a WSGI adaptor for Aquarium.
• exceptions.Exception: Common base class for all exceptions.
  • aquarium.util.FormValid.FieldInvalid: Raise this when a field does not meet the proper type.
  • aquarium.util.InternalLibrary.Forward: Raise an instance of this class to make Aquarium do a forward.
  • exceptions.StandardError: Base class for all standard Python exceptions.
    • exceptions.LookupError: Base class for lookup errors.
      • aquarium.database.DatabaseAssistant.MissingRecordError: A database record that was expected to exist doesn't actually exist.
    • exceptions.ValueError: Inappropriate argument value (of correct type).
      • aquarium.util.InternalLibrary.FormValueError: Subclass ValueError for form errors that shouldn't occur.
      • aquarium.screen.Wizard.InvalidConfigurationError: A step may raise this if it detects that the current configuration is so broken it cannot run at all.
      • Cheetah.Utils.WebInputMixin.NonNumericInputError
      • aquarium.screen.Wizard.ShouldSkipMe: A step may raise this if it wishes to not be run.