Module Hierarchy

• ConfigPersist: Functions for doing data persistence with ConfigObj.
• pythonutils.cgiutils
• pythonutils.configobj
• pythonutils.listquote: Having written modules to handle turning a string representation of a list back into a list (including nested lists) and also a very simple CSV parser, I realised I needed a more solid set of functions for handling lists (comma delimited lines) and quoting/unquoting elements of lists.
• pythonutils.odict: A dict that keeps keys in insertion order
• pythonutils.pathutils: This module contains convenience functions for working with files and paths.
• pythonutils.standout: StandOut - the Flexible Output Object (FOO !) Adds optional logging to a file and setting of verbosity levels to the stdout stream This means that, for the most part, standard print statments can be used throughout your program and StandOut handles the rest.
• pythonutils.urlpath
• pythonutils.validate: The Validator object is used to check that supplied values conform to a specification.

Class Hierarchy

• exceptions.Exception: Common base class for all exceptions.
  • exceptions.StandardError: Base class for all standard Python exceptions.
    • exceptions.SyntaxError: Invalid syntax.
      • pythonutils.configobj.ConfigObjError: This is the base class for all errors that ConfigObj raises.
        • pythonutils.configobj.DuplicateError: The keyword or section specified already exists.
        • pythonutils.configobj.NestingError: This error indicates a level of nesting that doesn't match.
        • pythonutils.configobj.ParseError: This error indicates that a line is badly written.
        • pythonutils.configobj.ConfigspecError: An error occured whilst parsing a configspec.
        • pythonutils.configobj.InterpolationError: Base class for the two interpolation errors.
          • pythonutils.configobj.InterpolationDepthError: Maximum interpolation depth exceeded in string interpolation.
          • pythonutils.configobj.MissingInterpolationOption: A value specified for interpolation was missing.
        • pythonutils.configobj.RepeatSectionError: This error indicates additional sections in a section with a __many__ (repeated) section.
      • pythonutils.listquote.ListQuoteError: Base class for errors raised by the listquote module.
        • pythonutils.listquote.BadLineError: A line is badly built.
          • pythonutils.listquote.CommentError: A line contains a disallowed comment.
        • pythonutils.listquote.CSVError: The CSV File contained errors.
        • pythonutils.listquote.UnQuoteError: The value is badly quoted.
        • pythonutils.listquote.QuoteError: This value can't be quoted.
      • pythonutils.validate.VdtParamError: An incorrect parameter was passed
    • exceptions.EnvironmentError: Base class for I/O related errors.
      • exceptions.IOError: I/O operation failed.
        • pythonutils.pathutils.LockError: The generic error for locking - it is a subclass of IOError.
  • pythonutils.configobj.UnknownType
  • pythonutils.validate.ValidateError: This error indicates that the check failed.
    • pythonutils.validate.VdtMissingValue: No value was supplied to a check that needed one.
    • pythonutils.validate.VdtTypeError: The value supplied was of the wrong type
    • pythonutils.validate.VdtValueError: The value supplied was of the correct type, but was not an allowed value.
      • pythonutils.validate.VdtValueTooBigError: The value supplied was of the correct type, but was too big.
      • pythonutils.validate.VdtValueTooLongError: The value supplied was of the correct type, but was too long.
      • pythonutils.validate.VdtValueTooShortError: The value supplied was of the correct type, but was too short.
      • pythonutils.validate.VdtValueTooSmallError: The value supplied was of the correct type, but was too small.
    • pythonutils.validate.VdtUnknownCheckError: An unknown check function was requested
• object: The most base type
  • dict: dict() -> new empty dictionary.
    • pythonutils.odict.OrderedDict: A class of dictionary that keeps the insertion order of keys.
      • pythonutils.odict.SequenceOrderedDict: Experimental version of OrderedDict that has a custom object for keys, values, and items.
    • pythonutils.configobj.Section: A dictionary-like object that represents a section in a config file.
      • pythonutils.configobj.ConfigObj: An object to read, create, and write config files.
  • pythonutils.listquote.LineParser: An object to parse nested lists from strings.
  • pythonutils.odict._keys: Custom object for accessing the keys of an OrderedDict.
  • pythonutils.odict._values: Custom object for accessing the values of an OrderedDict.
  • pythonutils.configobj.SimpleVal: A simple validator.
  • pythonutils.pathutils.Lock: A simple file lock, compatible with windows and Unixes.
    • pythonutils.pathutils.LockFile: A file like object with an exclusive lock, whilst it is open.
  • pythonutils.odict._items: Custom object for accessing the items of an OrderedDict.
  • pythonutils.validate.Validator: Validator is an object that allows you to register a set of 'checks'.
• pythonutils.configobj.Builder
• pythonutils.standout.StandOut