Newer
Older
tconfpy / tconfpy-spec.txt
@tundra tundra on 21 Mar 2004 994 bytes Just an API spec for now.
$Id: tconfpy-spec.txt,v 1.104 2004/03/21 12:36:29 tundra Exp $

                        tconfpy SPECIFICATION
                        =====================



API
===

tconfpy.ParseConfig(FileName, InitialSymTbl, Debug=False, LiteralVars=False)

                 ---> [SymTable, ErrorMsgs, WarningMsgs, DebugMsgs, LiteralLines]


where,

FileName          --->  String

InitialSymbolTbl  --->  Dictionary in {varname:tconfpy.VarDescriptor, ...} format

Debug             --->  Turn on debug output.

LiteralVars       --->  Replace variable references in Literal Lines



RETURN VALUES
-------------


SymTable     --->  {Symbol Name : [Symbol Value, option, option, ...]}

ErrorMsgs    --->  List of Error Messages

WarningMsgs  --->  List of Warning Messages

DebugMsgs    --->  List of Debug Messages (empty if Debug=False)

LiteralLines --->  Lines processed literally - w/vars replaced if LiteralVars=True


------------------------------------------------------------------------------