Fork: 0
tundra / tconfpy
Browse code
Clarified/cleaned up input and output parameters.
master
1 parent c333cab commit 1488d6b9dcf19768782f6a86532e0c24ded9bc0b
@tundra tundra authored on 9 Mar 2004
Patch
Unified Split
Showing 1 changed file
View
38
■■■■■
 tconfpy-spec.txt
$Id: tconfpy-spec.txt,v 1.101 2004/03/09 22:50:23 tundra Exp $
$Id: tconfpy-spec.txt,v 1.102 2004/03/09 23:50:16 tundra Exp $
 
tconfpy SPECIFICATION
=====================
 
===
 
tconfpy.ParseConfig(FileName, Options, IgnoreCase=False, Debug=False)
 
---> [SymTable, ErrMsgs, InfoMsgs, DebugMsgs, ParseOK]
---> [SymTable, ErrorrMsgs, WarningMsgs, DebugMsgs, ParseOK]
 
 
where,
 
FileName ---> String
 
Options ---> {"BoolOpts" : [bopt, bopt, ...],
Options ---> {"BoolOpts" : [bopt, bopt, ...], (Optional, Default={})
"NumOpts" : [nopt, nopt, ...],
"StrOpts" : [sopt, sopt, ...]
}
 
restrictions on what string values may be
associated with a particular sopt.
 
 
IgnoreCase ---> Case is ignored throughout config file.
IgnoreCase ---> Case is ignored during parse of config file. (Optional. Default: False)
 
SymTable ---> {Symbol Name : Symbol Value}
Debug ---> Turn on debug output. (Optional. Default: False)
 
ErrList ---> [ParseErr, ParseErr, ...]
 
ParseErr = [File Name, Line Number, Error String]
 
FatalError ---> If True, means parsing failed pathologically, and
pgm should not continue
RETURN VALUES
-------------
 
 
SymTable ---> {Symbol Name : [Symbol Value, option, option, ...]}
 
ErrorMsgs ---> List of Error Messages
 
DebugMsgs ---> List of Debug Messages (empty if Debug=False)
 
WarningMsgs ---> List of Warning Messages
 
ParseOK ---> If True, parsing was successful.
 
 
------------------------------------------------------------------------------